From 05f49ce799c1f9cc696d53eea89699d80f59f833 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 16 Jun 2019 07:01:14 -0600 Subject: [PATCH 0001/1753] Initial commit --- .gitattributes | 63 ++++ .gitignore | 349 +++++++++++++++++++++++ .vscode/extensions.json | 18 ++ CONTRIBUTING.md | 24 ++ LICENSE | 21 ++ README.md | 31 ++ azure-pipelines.yml | 58 ++++ azure-pipelines/collect-deployables.yml | 15 + azure-pipelines/collect-logs.yml | 9 + azure-pipelines/dotnet.yml | 64 +++++ azure-pipelines/install-dependencies.yml | 25 ++ global.json | 5 + nuget.config | 8 + src/.editorconfig | 157 ++++++++++ src/Directory.Build.props | 35 +++ src/Directory.Build.targets | 8 + src/Library.Tests/CalculatorTests.cs | 28 ++ src/Library.Tests/Library.Tests.csproj | 29 ++ src/Library.Tests/app.config | 5 + src/Library/Calculator.cs | 29 ++ src/Library/Library.csproj | 10 + src/lib.template.sln | 28 ++ src/shipping.ruleset | 74 +++++ src/strongname.snk | Bin 0 -> 596 bytes src/stylecop.json | 15 + src/tests.ruleset | 83 ++++++ version.json | 8 + 27 files changed, 1199 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 azure-pipelines.yml create mode 100644 azure-pipelines/collect-deployables.yml create mode 100644 azure-pipelines/collect-logs.yml create mode 100644 azure-pipelines/dotnet.yml create mode 100644 azure-pipelines/install-dependencies.yml create mode 100644 global.json create mode 100644 nuget.config create mode 100644 src/.editorconfig create mode 100644 src/Directory.Build.props create mode 100644 src/Directory.Build.targets create mode 100644 src/Library.Tests/CalculatorTests.cs create mode 100644 src/Library.Tests/Library.Tests.csproj create mode 100644 src/Library.Tests/app.config create mode 100644 src/Library/Calculator.cs create mode 100644 src/Library/Library.csproj create mode 100644 src/lib.template.sln create mode 100644 src/shipping.ruleset create mode 100644 src/strongname.snk create mode 100644 src/stylecop.json create mode 100644 src/tests.ruleset create mode 100644 version.json diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..1ff0c4230 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..846c8c0a3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,349 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..f910c6876 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,18 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. + // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp + + // List of extensions which should be recommended for users of this workspace. + "recommendations": [ + "ms-azure-devops.azure-pipelines", + "ms-vscode.csharp", + "k--kato.docomment", + "editorconfig.editorconfig", + "pflannery.vscode-versionlens", + "davidanson.vscode-markdownlint" + ], + // List of extensions recommended by VS Code that should not be recommended for users of this workspace. + "unwantedRecommendations": [ + + ] +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..2f36ba668 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +This project has adopted the [Microsoft Open Source Code of +Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct +FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) +with any additional questions or comments. + +## Prerequisites + +The only prerequisite for building, testing, and deploying from this repository +is the [.NET SDK](https://get.dot.net/). +You should install the version specified in `global.json` or a later version within +the same major.minor.Bxx "hundreds" band. +For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.310 +while the 2.2.400 version would not be considered compatible by .NET SDK. +See [.NET Core Versioning](https://docs.microsoft.com/en-us/dotnet/core/versions/) for more information. + +This repository can be built on Windows, Linux, and OSX. + +## Building + +Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..3bb6360cc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) PLACEHOLDER + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 000000000..e99ca933e --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Your Library + +***An awesome template for your awesome library*** + +![NuGet package](https://img.shields.io/badge/nuget-your--package--here-yellow.svg) +[![Build Status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/AArnott.Library.Template?branchName=master)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=29&branchName=master) +[![codecov](https://codecov.io/gh/aarnott/library.template/branch/master/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) + +## Features + +* Follow the best and simplest patterns of build, pack and test with dotnet CLI. +* Static analyzers: [FxCop](https://docs.microsoft.com/en-us/visualstudio/code-quality/fxcop-analyzers?view=vs-2019) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) +* Read-only source tree (builds to top-level bin/obj folders) +* Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/aarnott/nerdbank.gitversioning)) +* Azure Pipeline via YAML with all dependencies declared for long-term serviceability. +* Testing on .NET Framework, multiple .NET Core versions +* Testing on Windows, Linux and OSX +* Code coverage published to Azure Pipelines +* Code coverage published to codecov.io so GitHub PRs get code coverage results added as a PR comment + +## Consumption + +Once you've expanded this template for your own use, you should: + +1. Verify the license is suitable for your goal as it appears in the LICENSE and stylecop.json files + and the Directory.Build.props file's `PackageLicenseExpression` property. +1. Search the repo for all `PLACEHOLDER` occurrences and replace them. +1. Regenerate `src\strongname.snk` file: `sn -k src\strongname.snk` +1. Rename project files, directories, namespaces, and update sln file to match. +1. Reset or remove the `codecov_token` variable in `azure-pipelines.yml` +1. Reset or replace the badges at the top of this file. diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 000000000..6d7cf7691 --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,58 @@ +trigger: + branches: + include: + - master + - validate/* + paths: + exclude: + - doc/ + - '*.md' + - .vscode/ + +variables: + TreatWarningsAsErrors: true + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BuildConfiguration: Release + BuildPlatform: Any CPU + codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # PLACEHOLDER - Get a new one from https://codecov.io/ + +jobs: +- job: Windows + pool: Hosted Windows 2019 with VS2019 + steps: + - template: azure-pipelines/install-dependencies.yml + + - powershell: | + dotnet tool install --tool-path .. nbgv + ../nbgv cloud + displayName: Set build number + workingDirectory: src + + - template: azure-pipelines/dotnet.yml + - template: azure-pipelines/collect-deployables.yml + - template: azure-pipelines/collect-logs.yml + + - task: NuGetCommand@2 + displayName: Push packages to CI feed + inputs: + command: push + packagesToPush: $(Build.ArtifactStagingDirectory)/deployables/*.nupkg;$(Build.ArtifactStagingDirectory)/deployables/*.snupkg + nuGetFeedType: internal + publishVstsFeed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # PLACEHOLDER + allowPackageConflicts: true + +- job: Linux + pool: + vmImage: Ubuntu 16.04 + steps: + - template: azure-pipelines/install-dependencies.yml + - template: azure-pipelines/dotnet.yml + - template: azure-pipelines/collect-logs.yml + +- job: macOS + pool: + vmImage: macOS 10.13 + steps: + - template: azure-pipelines/install-dependencies.yml + - template: azure-pipelines/dotnet.yml + - template: azure-pipelines/collect-logs.yml diff --git a/azure-pipelines/collect-deployables.yml b/azure-pipelines/collect-deployables.yml new file mode 100644 index 000000000..5d77acfca --- /dev/null +++ b/azure-pipelines/collect-deployables.yml @@ -0,0 +1,15 @@ +steps: +- task: CopyFiles@1 + inputs: + Contents: | + bin/Packages/$(BuildConfiguration)/* + TargetFolder: $(Build.ArtifactStagingDirectory)/deployables + flattenFolders: true + displayName: Collecting deployable artifacts + +- task: PublishBuildArtifacts@1 + inputs: + PathtoPublish: $(Build.ArtifactStagingDirectory)/deployables + ArtifactName: deployables + ArtifactType: Container + displayName: Publish deployables artifacts diff --git a/azure-pipelines/collect-logs.yml b/azure-pipelines/collect-logs.yml new file mode 100644 index 000000000..ab39d91f0 --- /dev/null +++ b/azure-pipelines/collect-logs.yml @@ -0,0 +1,9 @@ +steps: + +- task: PublishBuildArtifacts@1 + inputs: + PathtoPublish: $(Build.ArtifactStagingDirectory)/build_logs + ArtifactName: build_logs-$(Agent.JobName) + ArtifactType: Container + displayName: Publish build_logs artifacts + condition: succeededOrFailed() diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml new file mode 100644 index 000000000..f53bc8030 --- /dev/null +++ b/azure-pipelines/dotnet.yml @@ -0,0 +1,64 @@ +steps: +- script: dotnet restore /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/restore.binlog" + displayName: dotnet restore + workingDirectory: src + +- script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" + displayName: dotnet build + workingDirectory: src + +- script: dotnet pack --no-build -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/pack.binlog" + displayName: dotnet pack + workingDirectory: src + +- script: dotnet test --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/net472.trx" /p:CollectCoverage=true + displayName: dotnet test -f net472 + workingDirectory: src + condition: eq(variables['Agent.OS'], 'Windows_NT') + +- script: dotnet test --no-build -c $(BuildConfiguration) -f netcoreapp2.0 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/netcoreapp2.0.trx" /p:CollectCoverage=true + displayName: dotnet test -f netcoreapp2.0 + workingDirectory: src + +- script: dotnet test --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/netcoreapp2.1.trx" /p:CollectCoverage=true + displayName: dotnet test -f netcoreapp2.1 + workingDirectory: src + +- script: dotnet test --no-build -c $(BuildConfiguration) -f netcoreapp2.2 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/netcoreapp2.2.trx" /p:CollectCoverage=true + displayName: dotnet test -f netcoreapp2.2 + workingDirectory: src + +- task: PublishTestResults@2 + displayName: Publish test results + inputs: + testRunner: VSTest + #mergeTestResults: true + testResultsFormat: trx + testResultsFiles: $(Build.ArtifactStagingDirectory)/testlogs/*.trx + failTaskOnFailedTests: true + +- task: PublishCodeCoverageResults@1 + displayName: Publish code coverage results to Azure DevOps + inputs: + codeCoverageTool: cobertura + summaryFileLocation: '**/coverage.cobertura.xml' + +- bash: bash <(curl -s https://codecov.io/bash) + displayName: Publish code coverage results to codecov.io + condition: ne(variables['codecov_token'], '') + +- task: CopyFiles@1 + inputs: + Contents: | + obj/**/project.assets.json + TargetFolder: $(Build.ArtifactStagingDirectory)/projectAssetsJson + displayName: Collecting project.assets.json artifacts + condition: succeededOrFailed() + +- task: PublishBuildArtifacts@1 + inputs: + PathtoPublish: $(Build.ArtifactStagingDirectory)/projectAssetsJson + ArtifactName: projectAssetsJson-$(Agent.JobName) + ArtifactType: Container + displayName: Publish projectAssetsJson artifacts + condition: succeededOrFailed() diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml new file mode 100644 index 000000000..80830cc7f --- /dev/null +++ b/azure-pipelines/install-dependencies.yml @@ -0,0 +1,25 @@ +steps: +- script: dotnet --info + displayName: .NET Core SDK/runtimes (on host) + workingDirectory: $(Agent.HomeDirectory) + +- task: UseDotNet@2 + displayName: Install .NET Core SDK 2.2.300 + inputs: + packageType: sdk + version: 2.2.300 + +- task: UseDotNet@2 + displayName: Install .NET Core runtime 2.0.x + inputs: + packageType: runtime + version: 2.0.x + +- task: UseDotNet@2 + displayName: Install .NET Core runtime 2.1.x + inputs: + packageType: runtime + version: 2.1.x + +- script: dotnet --info + displayName: .NET Core SDK/runtimes (explicitly installed) diff --git a/global.json b/global.json new file mode 100644 index 000000000..932387844 --- /dev/null +++ b/global.json @@ -0,0 +1,5 @@ +{ + "sdk": { + "version": "2.2.300" + } +} \ No newline at end of file diff --git a/nuget.config b/nuget.config new file mode 100644 index 000000000..4941d22b8 --- /dev/null +++ b/nuget.config @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/src/.editorconfig b/src/.editorconfig new file mode 100644 index 000000000..94cda0d5f --- /dev/null +++ b/src/.editorconfig @@ -0,0 +1,157 @@ +# EditorConfig is awesome:http://EditorConfig.org + +# top-most EditorConfig file +root = true + +# Don't use tabs for indentation. +[*] +indent_style = space + +# (Please don't specify an indent_size here; that has too many unintended consequences.) + +# Code files +[*.{cs,csx,vb,vbx,h,cpp,idl}] +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + +# Xml project files +[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}] +indent_size = 2 + +# Xml config files +[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}] +indent_size = 2 + +# JSON files +[*.json] +indent_size = 2 + +# Dotnet code style settings: +[*.{cs,vb}] +# Sort using and Import directives with System.* appearing first +dotnet_sort_system_directives_first = true +dotnet_style_qualification_for_field = true:warning +dotnet_style_qualification_for_property = true:warning +dotnet_style_qualification_for_method = true:warning +dotnet_style_qualification_for_event = true:warning + +# Use language keywords instead of framework type names for type references +dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion +dotnet_style_predefined_type_for_member_access = true:suggestion + +# Suggest more modern language features when available +dotnet_style_object_initializer = true:suggestion +dotnet_style_collection_initializer = true:suggestion +dotnet_style_coalesce_expression = true:suggestion +dotnet_style_null_propagation = true:suggestion +dotnet_style_explicit_tuple_names = true:suggestion + +# Non-private static fields are PascalCase +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style + +dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field +dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected +dotnet_naming_symbols.non_private_static_fields.required_modifiers = static + +dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case + +# Constants are PascalCase +dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants +dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style + +dotnet_naming_symbols.constants.applicable_kinds = field, local +dotnet_naming_symbols.constants.required_modifiers = const + +dotnet_naming_style.constant_style.capitalization = pascal_case + +# Static fields are camelCase +dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion +dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields +dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style + +dotnet_naming_symbols.static_fields.applicable_kinds = field +dotnet_naming_symbols.static_fields.required_modifiers = static + +dotnet_naming_style.static_field_style.capitalization = camel_case + +# Instance fields are camelCase +dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion +dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields +dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style + +dotnet_naming_symbols.instance_fields.applicable_kinds = field + +dotnet_naming_style.instance_field_style.capitalization = camel_case + +# Locals and parameters are camelCase +dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion +dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters +dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style + +dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local + +dotnet_naming_style.camel_case_style.capitalization = camel_case + +# Local functions are PascalCase +dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions +dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style + +dotnet_naming_symbols.local_functions.applicable_kinds = local_function + +dotnet_naming_style.local_function_style.capitalization = pascal_case + +# By default, name items with PascalCase +dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members +dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style + +dotnet_naming_symbols.all_members.applicable_kinds = * + +dotnet_naming_style.pascal_case_style.capitalization = pascal_case + +# CSharp code style settings: +[*.cs] +# Indentation preferences +csharp_indent_block_contents = true +csharp_indent_braces = false +csharp_indent_case_contents = true +csharp_indent_switch_labels = true +csharp_indent_labels = flush_left + +# Prefer "var" everywhere +csharp_style_var_for_built_in_types = true:suggestion +csharp_style_var_when_type_is_apparent = true:suggestion +csharp_style_var_elsewhere = true:suggestion + +# Prefer method-like constructs to have a block body +csharp_style_expression_bodied_methods = false:none +csharp_style_expression_bodied_constructors = false:none +csharp_style_expression_bodied_operators = false:none + +# Prefer property-like constructs to have an expression-body +csharp_style_expression_bodied_properties = true:none +csharp_style_expression_bodied_indexers = true:none +csharp_style_expression_bodied_accessors = true:none + +# Suggest more modern language features when available +csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion +csharp_style_pattern_matching_over_as_with_null_check = true:suggestion +csharp_style_inlined_variable_declaration = true:suggestion +csharp_style_throw_expression = true:suggestion +csharp_style_conditional_delegate_call = true:suggestion + +# Newline settings +csharp_new_line_before_open_brace = all +csharp_new_line_before_else = true +csharp_new_line_before_catch = true +csharp_new_line_before_finally = true +csharp_new_line_before_members_in_object_initializers = true +csharp_new_line_before_members_in_anonymous_types = true + +# Blocks are allowed +csharp_prefer_braces = true:silent diff --git a/src/Directory.Build.props b/src/Directory.Build.props new file mode 100644 index 000000000..c3f28530e --- /dev/null +++ b/src/Directory.Build.props @@ -0,0 +1,35 @@ + + + + Debug + $(MSBuildThisFileDirectory)..\obj\$(MSBuildProjectName)\ + $(MSBuildThisFileDirectory)..\bin\$(MSBuildProjectName)\ + $(MSBuildThisFileDirectory)..\bin\Packages\$(Configuration)\ + 7.3 + true + + true + $(MSBuildThisFileDirectory)\strongname.snk + + PLACEHOLDER + PLACEHOLDER + MIT + true + true + true + snupkg + $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets new file mode 100644 index 000000000..1ddcba6f4 --- /dev/null +++ b/src/Directory.Build.targets @@ -0,0 +1,8 @@ + + + cobertura + [xunit.*]* + + $(OutputPath)/ + + diff --git a/src/Library.Tests/CalculatorTests.cs b/src/Library.Tests/CalculatorTests.cs new file mode 100644 index 000000000..506ca1b8e --- /dev/null +++ b/src/Library.Tests/CalculatorTests.cs @@ -0,0 +1,28 @@ +// Copyright (c) PLACEHOLDER. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using Library; +using Xunit; +using Xunit.Abstractions; + +public class CalculatorTests +{ + private readonly ITestOutputHelper logger; + + public CalculatorTests(ITestOutputHelper logger) + { + this.logger = logger; + } + + [Fact] + public void AddOrSubtract() + { + // This tests aggregation of code coverage. +#if NETCOREAPP2_0 + Assert.Equal(3, Calculator.Add(1, 2)); +#else + Assert.Equal(-1, Calculator.Subtract(1, 2)); +#endif + } +} diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj new file mode 100644 index 000000000..fc8854183 --- /dev/null +++ b/src/Library.Tests/Library.Tests.csproj @@ -0,0 +1,29 @@ + + + + net472;netcoreapp2.0;netcoreapp2.1;netcoreapp2.2 + false + $(NoWarn);CS1591 + true + ..\tests.ruleset + + + + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + diff --git a/src/Library.Tests/app.config b/src/Library.Tests/app.config new file mode 100644 index 000000000..61890f055 --- /dev/null +++ b/src/Library.Tests/app.config @@ -0,0 +1,5 @@ + + + + + diff --git a/src/Library/Calculator.cs b/src/Library/Calculator.cs new file mode 100644 index 000000000..826790509 --- /dev/null +++ b/src/Library/Calculator.cs @@ -0,0 +1,29 @@ +// Copyright (c) PLACEHOLDER. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Library +{ + using System; + + /// + /// My first class. + /// + public static class Calculator + { + /// + /// Adds two integers. + /// + /// The first integer. + /// The second integer. + /// The sum of the two integers. + public static int Add(int a, int b) => a + b; + + /// + /// Subtracts one integer from another. + /// + /// The original integer. + /// The integer to subtract. + /// The difference between the two integers. + public static int Subtract(int a, int b) => a - b; + } +} diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj new file mode 100644 index 000000000..aa8cf2c62 --- /dev/null +++ b/src/Library/Library.csproj @@ -0,0 +1,10 @@ + + + + netstandard2.0 + ..\shipping.ruleset + + PLACEHOLDER + + + diff --git a/src/lib.template.sln b/src/lib.template.sln new file mode 100644 index 000000000..17645391b --- /dev/null +++ b/src/lib.template.sln @@ -0,0 +1,28 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26124.0 +MinimumVisualStudioVersion = 15.0.26124.0 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Library", "Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Library.Tests", "Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {C06D702E-6FC7-453B-BDDF-608F825EC003}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C06D702E-6FC7-453B-BDDF-608F825EC003}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C06D702E-6FC7-453B-BDDF-608F825EC003}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C06D702E-6FC7-453B-BDDF-608F825EC003}.Release|Any CPU.Build.0 = Release|Any CPU + {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Release|Any CPU.ActiveCfg = Release|Any CPU + {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/src/shipping.ruleset b/src/shipping.ruleset new file mode 100644 index 000000000..729035460 --- /dev/null +++ b/src/shipping.ruleset @@ -0,0 +1,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/strongname.snk b/src/strongname.snk new file mode 100644 index 0000000000000000000000000000000000000000..a4d0a2ce39df5f7c284340b4a2c4690385c44208 GIT binary patch literal 596 zcmV-a0;~N80ssI2Bme+XQ$aES1ONa50097Td7B6KsP|cl#<{bONo_!&t)QUG9wW^j zM1zvNAOI=XF}potSO>54lS%MGl8tv)xYTSw?~K<1McvNlJ;DITeY__C?><|;F`bgX zj;&2ME}KBWPb0zVSK+iW?{2`tzZR-#x0K_|t&0FhD+3urA!lNmCH;&b|?g|_AC39ox-0 zcV%KJis3}%`RVWSXN58fc}#LF$A#kcB2VWh=MH0zs+k7{ zQT<5V>NGhWzC7Jnt4A?n%Kk`fPt&FR4k~q{TSW%@D{plIpotzop}i+x`~C))*Vr-i zrW2)aE17f*=wCRa_#bHkYlQko_Jh)wN@;?yML9mYk)XZ`l6IQ*D7xZmmL=m(T|zMG i={(T>StYQl!YSPV literal 0 HcmV?d00001 diff --git a/src/stylecop.json b/src/stylecop.json new file mode 100644 index 000000000..f1d8168cb --- /dev/null +++ b/src/stylecop.json @@ -0,0 +1,15 @@ +{ + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "settings": { + "documentationRules": { + "companyName": "PLACEHOLDER", + "copyrightText": "Copyright (c) {companyName}. All rights reserved.\nLicensed under the {licenseName} license. See {licenseFile} file in the project root for full license information.", + "variables": { + "licenseName": "MIT", + "licenseFile": "LICENSE" + }, + "fileNamingConvention": "metadata", + "xmlHeader": false + } + } +} \ No newline at end of file diff --git a/src/tests.ruleset b/src/tests.ruleset new file mode 100644 index 000000000..c74c6ed34 --- /dev/null +++ b/src/tests.ruleset @@ -0,0 +1,83 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/version.json b/version.json new file mode 100644 index 000000000..38da1662c --- /dev/null +++ b/version.json @@ -0,0 +1,8 @@ +{ + "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", + "version": "0.1-beta", + "publicReleaseRefSpec": [ + "^refs/heads/master$", + "^refs/heads/v\\d+(?:\\.\\d+)?$" + ] +} \ No newline at end of file From 9a6c1df41cb75c41b7b5039aaddbe59456a93366 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 16 Jun 2019 21:32:09 -0600 Subject: [PATCH 0002/1753] Add VS Code whitespace settings --- .vscode/settings.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 000000000..f0cafc05f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "files.trimTrailingWhitespace": true, + "files.insertFinalNewline": true, + "files.trimFinalNewlines": true +} From 26696c117d5f65dbcdf91209ae0b0816593cec4d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 16 Jun 2019 22:24:54 -0600 Subject: [PATCH 0003/1753] Add script for proper expansion Closes #3 --- Expand-Template.ps1 | 148 ++++++++++++++++++++++++++ LICENSE | 2 +- README.md | 13 +-- azure-pipelines.yml | 11 +- azure-pipelines/expand-template.yml | 10 ++ src/Directory.Build.props | 6 +- src/Library.Tests/CalculatorTests.cs | 2 +- src/{lib.template.sln => Library.sln} | 0 src/Library/Calculator.cs | 2 +- src/Library/Library.csproj | 2 - src/stylecop.json | 4 +- 11 files changed, 179 insertions(+), 21 deletions(-) create mode 100644 Expand-Template.ps1 create mode 100644 azure-pipelines/expand-template.yml rename src/{lib.template.sln => Library.sln} (100%) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 new file mode 100644 index 000000000..edde82a0f --- /dev/null +++ b/Expand-Template.ps1 @@ -0,0 +1,148 @@ +<# +.SYNOPSIS +Expands this template into an actual project, taking values for placeholders +.PARAMETER Name +The name of the library +#> +[CmdletBinding()] +Param( + [Parameter(Mandatory=$true)] + [string]$LibraryName, + [Parameter(Mandatory=$true)] + [string]$Author, + [Parameter()] + [string]$CodeCovToken, + [Parameter()] + [string]$CIFeed +) + +function Replace-Placeholders { + [CmdletBinding()] + param( + [Parameter(Mandatory=$true)] + [string]$Path, + [Parameter(Mandatory=$true)] + $Replacements + ) + + $Path = Resolve-Path $Path + Write-Host "Replacing tokens in `"$Path`"" + $content = Get-Content -Path $Path | Out-String + $Replacements.GetEnumerator() |% { + $modifiedContent = $content -replace $_.Key,$_.Value + if ($modifiedContent -eq $content) { + Write-Error "No $($_.Key) token found to replace." + } + $content = $modifiedContent + } + $content = $content.TrimEnd(("`r","`n")) + [System.IO.File]::WriteAllLines($Path, $content) # Don't use Set-Content because that adds a UTF8 BOM + git add $Path +} + +# Try to find sn.exe if it isn't on the PATH +$sn = Get-Command sn -ErrorAction SilentlyContinue +if (-not $sn) { + $snExes = Get-ChildItem -Recurse "${env:ProgramFiles(x86)}\Microsoft SDKs\Windows\sn.exe" + if ($snExes) { + $sn = Get-Command $snExes[0].FullName + } else { + Write-Error "sn command not found on PATH and SDK could not be found." + exit(1) + } +} + +# Verify all commands we use are on the PATH +('git','dotnet') |% { + if (-not (Get-Command $_ -ErrorAction SilentlyContinue)) { + Write-Error "$_ command not found on PATH." + exit(1) + } +} + +Push-Location $PSScriptRoot +try { + # Rename project directories and solution + Set-Location src + git mv Library.sln "$LibraryName.sln" + git mv Library/Library.csproj "Library/$LibraryName.csproj" + git mv Library "$LibraryName" + git mv Library.Tests/Library.Tests.csproj "Library.Tests/$LibraryName.Tests.csproj" + git mv Library.Tests "$LibraryName.Tests" + + # Refresh solution file both to update paths and give the projects unique GUIDs + dotnet sln remove Library/Library.csproj + dotnet sln remove Library.Tests/Library.Tests.csproj + dotnet sln add "$LibraryName" + dotnet sln add "$LibraryName.Tests" + git add "$LibraryName.sln" + + # Update project reference in test project. Add before removal to keep the same ItemGroup in place. + dotnet add "$LibraryName.Tests" reference "$LibraryName" + dotnet remove "$LibraryName.Tests" reference Library/Library.csproj + git add "$LibraryName.Tests/$LibraryName.Tests.csproj" + + # Establish a new strong-name key + & $sn.Path -k 2048 strongname.snk + git add strongname.snk + + Set-Location .. + + # Replace placeholders in source files + Replace-Placeholders -Path "src/$LibraryName/Calculator.cs" -Replacements @{ + 'Library'=$LibraryName + 'COMPANY-PLACEHOLDER'=$Author + } + Replace-Placeholders -Path "src/$LibraryName.Tests/CalculatorTests.cs" -Replacements @{ + 'Library'=$LibraryName + 'COMPANY-PLACEHOLDER'=$Author + } + Replace-Placeholders -Path "LICENSE" -Replacements @{ + 'COMPANY-PLACEHOLDER'=$Author + } + Replace-Placeholders -Path "src/stylecop.json" -Replacements @{ + 'COMPANY-PLACEHOLDER'=$Author + } + Replace-Placeholders -Path "src/Directory.Build.props" -Replacements @{ + 'COMPANY-PLACEHOLDER'=$Author + } + Replace-Placeholders -Path "README.md" -Replacements @{ + "(?m)^.*\[NuGet package\][^`r`n]*"="[![NuGet package](https://img.shields.io/nuget/v/$LibraryName.svg)](https://nuget.org/packages/$LibraryName)" + "(?m)^.*\[Build Status\].*`r?`n"="" + "(?m)^.*\[codecov\].*`r?`n"="" + } + + # Specially handle azure-pipelines.yml edits + $YmlReplacements = @{ + "(?m).*expand-template\.yml(?:\r)?\n" = "" + } + if ($CodeCovToken) { + $YmlReplacements['(codecov_token: ).*(#.*)'] = "`$1$CodeCovToken" + } else { + $YmlReplacements['(codecov_token: ).*(#.*)'] = "#`$1`$2" + } + if ($CIFeed) { + $YmlReplacements['(ci_feed: ).*(#.*)'] = "`$1$CIFeed" + } else { + $YmlReplacements['(ci_feed: ).*(#.*)'] = "#`$1`$2" + } + Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements + + # Self destruct + $Invocation = (Get-Variable MyInvocation -Scope 1).Value + git rm Expand-Template.ps1 + git rm :/azure-pipelines/expand-template.yml + + # Self-integrity check + Get-ChildItem -Recurse -File -Exclude bin,obj,README.md,Expand-Template.ps1 |? { -not $_.FullName.Contains("obj") } |% { + $PLACEHOLDERS = Get-Content -Path $_.FullName |? { $_.Contains('PLACEHOLDER') } + if ($PLACEHOLDERS) { + Write-Error "PLACEHOLDER discovered in $($_.FullName)" + } + } +} finally { + Pop-Location +} + +# When testing this script, all the changes can be quickly reverted with this command: +# git reset HEAD :/README.md :/LICENSE :/azure-pipelines.yml :/src :/azure-pipelines; git co -- :/README.md :/LICENSE :/azure-pipelines.yml :/src :/azure-pipelines; git clean -fd :/src diff --git a/LICENSE b/LICENSE index 3bb6360cc..44122ac6e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) PLACEHOLDER +Copyright (c) COMPANY-PLACEHOLDER Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index e99ca933e..d05ac0d72 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,9 @@ ## Consumption -Once you've expanded this template for your own use, you should: - -1. Verify the license is suitable for your goal as it appears in the LICENSE and stylecop.json files - and the Directory.Build.props file's `PackageLicenseExpression` property. -1. Search the repo for all `PLACEHOLDER` occurrences and replace them. -1. Regenerate `src\strongname.snk` file: `sn -k src\strongname.snk` -1. Rename project files, directories, namespaces, and update sln file to match. -1. Reset or remove the `codecov_token` variable in `azure-pipelines.yml` +Once you've expanded this template for your own use, you should **run the `Expand-Template.ps1` script** to customize the template for your own project. + +Further customize your repo by: + +1. Verify the license is suitable for your goal as it appears in the LICENSE and stylecop.json files and the Directory.Build.props file's `PackageLicenseExpression` property. 1. Reset or replace the badges at the top of this file. diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 6d7cf7691..a670bbef0 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -8,13 +8,14 @@ trigger: - doc/ - '*.md' - .vscode/ - + variables: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release BuildPlatform: Any CPU - codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # PLACEHOLDER - Get a new one from https://codecov.io/ + codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ + ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed jobs: - job: Windows @@ -31,6 +32,7 @@ jobs: - template: azure-pipelines/dotnet.yml - template: azure-pipelines/collect-deployables.yml - template: azure-pipelines/collect-logs.yml + - template: azure-pipelines/expand-template.yml - task: NuGetCommand@2 displayName: Push packages to CI feed @@ -38,8 +40,9 @@ jobs: command: push packagesToPush: $(Build.ArtifactStagingDirectory)/deployables/*.nupkg;$(Build.ArtifactStagingDirectory)/deployables/*.snupkg nuGetFeedType: internal - publishVstsFeed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # PLACEHOLDER + publishVstsFeed: $(ci_feed) allowPackageConflicts: true + condition: ne(variables['ci_feed'], '') - job: Linux pool: @@ -48,6 +51,7 @@ jobs: - template: azure-pipelines/install-dependencies.yml - template: azure-pipelines/dotnet.yml - template: azure-pipelines/collect-logs.yml + - template: azure-pipelines/expand-template.yml - job: macOS pool: @@ -56,3 +60,4 @@ jobs: - template: azure-pipelines/install-dependencies.yml - template: azure-pipelines/dotnet.yml - template: azure-pipelines/collect-logs.yml + - template: azure-pipelines/expand-template.yml diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml new file mode 100644 index 000000000..74960e566 --- /dev/null +++ b/azure-pipelines/expand-template.yml @@ -0,0 +1,10 @@ +steps: +- script: git clean -fdx + displayName: Cleaning repo for template expansion +- powershell: ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" + displayName: Expanding template + failOnStderr: true +# TODO: Verify that all changes are staged to the git index +- script: dotnet build + workingDirectory: src + displayName: dotnet build (expanded template) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index c3f28530e..7b354beb7 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -11,8 +11,8 @@ true $(MSBuildThisFileDirectory)\strongname.snk - PLACEHOLDER - PLACEHOLDER + COMPANY-PLACEHOLDER + COMPANY-PLACEHOLDER MIT true true @@ -32,4 +32,4 @@ - \ No newline at end of file + diff --git a/src/Library.Tests/CalculatorTests.cs b/src/Library.Tests/CalculatorTests.cs index 506ca1b8e..2166fb1fb 100644 --- a/src/Library.Tests/CalculatorTests.cs +++ b/src/Library.Tests/CalculatorTests.cs @@ -1,4 +1,4 @@ -// Copyright (c) PLACEHOLDER. All rights reserved. +// Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; diff --git a/src/lib.template.sln b/src/Library.sln similarity index 100% rename from src/lib.template.sln rename to src/Library.sln diff --git a/src/Library/Calculator.cs b/src/Library/Calculator.cs index 826790509..9156a1a34 100644 --- a/src/Library/Calculator.cs +++ b/src/Library/Calculator.cs @@ -1,4 +1,4 @@ -// Copyright (c) PLACEHOLDER. All rights reserved. +// Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. namespace Library diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index aa8cf2c62..ae6eca97c 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -3,8 +3,6 @@ netstandard2.0 ..\shipping.ruleset - - PLACEHOLDER diff --git a/src/stylecop.json b/src/stylecop.json index f1d8168cb..379189493 100644 --- a/src/stylecop.json +++ b/src/stylecop.json @@ -2,7 +2,7 @@ "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "settings": { "documentationRules": { - "companyName": "PLACEHOLDER", + "companyName": "COMPANY-PLACEHOLDER", "copyrightText": "Copyright (c) {companyName}. All rights reserved.\nLicensed under the {licenseName} license. See {licenseFile} file in the project root for full license information.", "variables": { "licenseName": "MIT", @@ -12,4 +12,4 @@ "xmlHeader": false } } -} \ No newline at end of file +} From 159d180e61350798bbbc3fc94845ac0242a8fc11 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 18 Jun 2019 07:08:34 -0600 Subject: [PATCH 0004/1753] Fix test run names --- azure-pipelines/dotnet.yml | 42 +++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index f53bc8030..3e294f0b6 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -11,37 +11,45 @@ steps: displayName: dotnet pack workingDirectory: src -- script: dotnet test --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/net472.trx" /p:CollectCoverage=true +- task: DotNetCoreCLI@2 displayName: dotnet test -f net472 - workingDirectory: src + inputs: + command: test + arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + testRunTitle: net472-$(Agent.JobName) + workingDirectory: src condition: eq(variables['Agent.OS'], 'Windows_NT') -- script: dotnet test --no-build -c $(BuildConfiguration) -f netcoreapp2.0 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/netcoreapp2.0.trx" /p:CollectCoverage=true +- task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp2.0 - workingDirectory: src + inputs: + command: test + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + testRunTitle: netcoreapp2.0-$(Agent.JobName) + workingDirectory: src -- script: dotnet test --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/netcoreapp2.1.trx" /p:CollectCoverage=true +- task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp2.1 - workingDirectory: src - -- script: dotnet test --no-build -c $(BuildConfiguration) -f netcoreapp2.2 --filter "TestCategory!=FailsInCloudTest" -v n -l "trx;LogFileName=$(Build.ArtifactStagingDirectory)/testlogs/netcoreapp2.2.trx" /p:CollectCoverage=true + inputs: + command: test + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + testRunTitle: netcoreapp2.1-$(Agent.JobName) + workingDirectory: src + +- task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp2.2 - workingDirectory: src - -- task: PublishTestResults@2 - displayName: Publish test results inputs: - testRunner: VSTest - #mergeTestResults: true - testResultsFormat: trx - testResultsFiles: $(Build.ArtifactStagingDirectory)/testlogs/*.trx - failTaskOnFailedTests: true + command: test + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.2 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + testRunTitle: netcoreapp2.2-$(Agent.JobName) + workingDirectory: src - task: PublishCodeCoverageResults@1 displayName: Publish code coverage results to Azure DevOps inputs: codeCoverageTool: cobertura summaryFileLocation: '**/coverage.cobertura.xml' + failIfCoverageEmpty: true - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io From 42d3ae5b22f73214c17035277317bf324a430eeb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 20 Jun 2019 15:25:57 -0600 Subject: [PATCH 0005/1753] Fill in missing parameter docs in the ps1 script --- Expand-Template.ps1 | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index edde82a0f..c1447d4c9 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -1,8 +1,15 @@ <# .SYNOPSIS Expands this template into an actual project, taking values for placeholders -.PARAMETER Name -The name of the library +.PARAMETER LibraryName +The name of the library. Should consist only of alphanumeric characters and periods. +.PARAMETER Author +The name to use in copyright and owner notices. +.PARAMETER CodeCovToken +A token obtained from codecov.io for your repo. If not specified, code coverage results will not be published to codecov.io, +but can be added later by editing the Azure Pipelines YAML file. +.PARAMETER CIFeed +The `/{guid}` path to the Azure Pipelines artifact feed to push your nuget package to as part of your CI. #> [CmdletBinding()] Param( From 0f19c143cae80dbcf9079d18d6aba4592abbbd10 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Jun 2019 07:32:46 -0600 Subject: [PATCH 0006/1753] Publish merged code coverage from all test runs on Windows agent Merge code coverage from all test runs on each agent. Although we capture that merged result from each agent as its own build artifact, we have to pick just one agent's merged result to publish to ADO as the summary file. --- azure-pipelines/dotnet.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 3e294f0b6..b86e4bd3f 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -44,12 +44,27 @@ steps: testRunTitle: netcoreapp2.2-$(Agent.JobName) workingDirectory: src +- powershell: | + dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool + $Inputs = [string]::join(';', (Get-ChildItem bin/coverage.cobertura.xml -Recurse |% { Resolve-Path -Relative $_ })) + obj/reportgenerator -reports:"$Inputs" -targetdir:"$(Build.ArtifactStagingDirectory)/coverageResults" -reporttypes:Cobertura + displayName: Merge code coverage results + +- task: PublishBuildArtifacts@1 + inputs: + PathtoPublish: $(Build.ArtifactStagingDirectory)/coverageResults + ArtifactName: coverageResults-$(Agent.JobName) + ArtifactType: Container + displayName: Publish coverageResults artifacts + condition: succeededOrFailed() + - task: PublishCodeCoverageResults@1 displayName: Publish code coverage results to Azure DevOps inputs: codeCoverageTool: cobertura - summaryFileLocation: '**/coverage.cobertura.xml' + summaryFileLocation: $(Build.ArtifactStagingDirectory)/coverageResults/Cobertura.xml failIfCoverageEmpty: true + condition: eq(variables['Agent.OS'], 'Windows_NT') # We have to pick just one agent to publish the code coverage summary file (https://github.com/tonerdo/coverlet/issues/474#issuecomment-504446150) - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io From fc34ef4c21bed5c1c06c5df75800f74db297d03a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Jun 2019 11:57:51 -0600 Subject: [PATCH 0007/1753] Merge code coverage from all test runs and agents (#9) --- azure-pipelines.yml | 11 ++++++++ azure-pipelines/dotnet.yml | 28 ++++++++++--------- azure-pipelines/publish-codecoverage.yml | 34 ++++++++++++++++++++++++ 3 files changed, 61 insertions(+), 12 deletions(-) create mode 100644 azure-pipelines/publish-codecoverage.yml diff --git a/azure-pipelines.yml b/azure-pipelines.yml index a670bbef0..a41bc3369 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -61,3 +61,14 @@ jobs: - template: azure-pipelines/dotnet.yml - template: azure-pipelines/collect-logs.yml - template: azure-pipelines/expand-template.yml + +- job: MergeCoverage + dependsOn: + - Windows + - Linux + - macOS + pool: + vmImage: Ubuntu 16.04 + steps: + - template: azure-pipelines/install-dependencies.yml + - template: azure-pipelines/publish-codecoverage.yml diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index b86e4bd3f..72f3b5a24 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -44,11 +44,23 @@ steps: testRunTitle: netcoreapp2.2-$(Agent.JobName) workingDirectory: src +- task: CopyFiles@1 + inputs: + Contents: | + bin/**/coverage.cobertura.xml + obj/**/*.cs + TargetFolder: $(Build.ArtifactStagingDirectory)/coverageResults + displayName: Collecting coverage.cobertura.xml artifacts + condition: succeededOrFailed() + - powershell: | - dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool - $Inputs = [string]::join(';', (Get-ChildItem bin/coverage.cobertura.xml -Recurse |% { Resolve-Path -Relative $_ })) - obj/reportgenerator -reports:"$Inputs" -targetdir:"$(Build.ArtifactStagingDirectory)/coverageResults" -reporttypes:Cobertura - displayName: Merge code coverage results + Write-Host "Substituting $(System.DefaultWorkingDirectory) with {reporoot}" + $reports = Get-ChildItem "$(Build.ArtifactStagingDirectory)/coverageResults/coverage.cobertura.xml" -Recurse + $reports |% { + $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape("$(System.DefaultWorkingDirectory)"), "{reporoot}" } + Set-Content -Path $_ -Value $content -Encoding UTF8 + } + displayName: Preparing code coverage reports for merging on another machine - task: PublishBuildArtifacts@1 inputs: @@ -58,14 +70,6 @@ steps: displayName: Publish coverageResults artifacts condition: succeededOrFailed() -- task: PublishCodeCoverageResults@1 - displayName: Publish code coverage results to Azure DevOps - inputs: - codeCoverageTool: cobertura - summaryFileLocation: $(Build.ArtifactStagingDirectory)/coverageResults/Cobertura.xml - failIfCoverageEmpty: true - condition: eq(variables['Agent.OS'], 'Windows_NT') # We have to pick just one agent to publish the code coverage summary file (https://github.com/tonerdo/coverlet/issues/474#issuecomment-504446150) - - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml new file mode 100644 index 000000000..fc5307817 --- /dev/null +++ b/azure-pipelines/publish-codecoverage.yml @@ -0,0 +1,34 @@ +steps: +- task: DownloadBuildArtifacts@0 + displayName: Download Windows code coverage results + inputs: + artifactName: coverageResults-Windows + downloadPath: $(System.DefaultWorkingDirectory)/bin +- task: DownloadBuildArtifacts@0 + displayName: Download Linux code coverage results + inputs: + artifactName: coverageResults-Linux + downloadPath: $(System.DefaultWorkingDirectory)/bin +- task: DownloadBuildArtifacts@0 + displayName: Download macOS code coverage results + inputs: + artifactName: coverageResults-macOS + downloadPath: $(System.DefaultWorkingDirectory)/bin +- powershell: | + dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 + Copy-Item -Recurse $(System.DefaultWorkingDirectory)/bin/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj + Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" + $reports = Get-ChildItem -Recurse "$(System.DefaultWorkingDirectory)/bin/coverage.cobertura.xml" + $reports |% { + $content = Get-Content -Path $_ |% { $_.Replace("{reporoot}", "$(System.DefaultWorkingDirectory)") } + Set-Content -Path $_ -Value $content -Encoding UTF8 + } + $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_ })) + obj/reportgenerator -reports:"$Inputs" -targetdir:coveragereport -reporttypes:Cobertura + displayName: Merge coverage +- task: PublishCodeCoverageResults@1 + displayName: Publish code coverage results to Azure DevOps + inputs: + codeCoverageTool: cobertura + summaryFileLocation: 'coveragereport/Cobertura.xml' + failIfCoverageEmpty: true From 753dd46974212dafd30b4e60d16f545a84ca695c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 24 Jun 2019 10:33:03 -0600 Subject: [PATCH 0008/1753] Avoid `var` when type is not apparent --- src/.editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/.editorconfig b/src/.editorconfig index 94cda0d5f..03c2bcf34 100644 --- a/src/.editorconfig +++ b/src/.editorconfig @@ -126,7 +126,7 @@ csharp_indent_labels = flush_left # Prefer "var" everywhere csharp_style_var_for_built_in_types = true:suggestion csharp_style_var_when_type_is_apparent = true:suggestion -csharp_style_var_elsewhere = true:suggestion +csharp_style_var_elsewhere = false:warning # Prefer method-like constructs to have a block body csharp_style_expression_bodied_methods = false:none From e1d68f227cc93a873a8903bb25a78c58b979b2cf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 07:10:13 -0600 Subject: [PATCH 0009/1753] Update packages (#14) And a few path manipulating msbuild properties --- src/Directory.Build.props | 13 +++++++------ src/Library.Tests/Library.Tests.csproj | 12 +++--------- 2 files changed, 10 insertions(+), 15 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 7b354beb7..f4ef32972 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -2,9 +2,10 @@ Debug - $(MSBuildThisFileDirectory)..\obj\$(MSBuildProjectName)\ - $(MSBuildThisFileDirectory)..\bin\$(MSBuildProjectName)\ - $(MSBuildThisFileDirectory)..\bin\Packages\$(Configuration)\ + $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)..\')) + $(RepoRootPath)obj\$(MSBuildProjectName)\ + $(RepoRootPath)bin\$(MSBuildProjectName)\ + $(RepoRootPath)bin\Packages\$(Configuration)\ 7.3 true @@ -22,11 +23,11 @@ - - - + + + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index fc8854183..b5f05f5fe 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -14,16 +14,10 @@ - - runtime; build; native; contentfiles; analyzers; buildtransitive - all - - + + - - runtime; build; native; contentfiles; analyzers; buildtransitive - all - + From 835ffb69827c68498e96caf0e27640eb939a48b2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 07:34:44 -0600 Subject: [PATCH 0010/1753] Drop .NET Core 2.0 targeting in test project (#13) Microsoft's long-term support for .NET Core 1.x and 2.0 [are over][LTS]. Customers targeting these versions are in a really bad place due to no security patches being offered and thus there are likely few to none out there. [LTS]: https://github.com/dotnet/core/blob/e2f22a7106860c0e5dc98bb36dc648a779944ad5/microsoft-support.md#net-core-releases --- azure-pipelines/dotnet.yml | 8 -------- src/Library.Tests/CalculatorTests.cs | 4 ++-- src/Library.Tests/Library.Tests.csproj | 2 +- 3 files changed, 3 insertions(+), 11 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 72f3b5a24..fe055ef7a 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -20,14 +20,6 @@ steps: workingDirectory: src condition: eq(variables['Agent.OS'], 'Windows_NT') -- task: DotNetCoreCLI@2 - displayName: dotnet test -f netcoreapp2.0 - inputs: - command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true - testRunTitle: netcoreapp2.0-$(Agent.JobName) - workingDirectory: src - - task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp2.1 inputs: diff --git a/src/Library.Tests/CalculatorTests.cs b/src/Library.Tests/CalculatorTests.cs index 2166fb1fb..84fe9a97c 100644 --- a/src/Library.Tests/CalculatorTests.cs +++ b/src/Library.Tests/CalculatorTests.cs @@ -18,8 +18,8 @@ public CalculatorTests(ITestOutputHelper logger) [Fact] public void AddOrSubtract() { - // This tests aggregation of code coverage. -#if NETCOREAPP2_0 + // This tests aggregation of code coverage across test runs. +#if NETCOREAPP2_1 Assert.Equal(3, Calculator.Add(1, 2)); #else Assert.Equal(-1, Calculator.Subtract(1, 2)); diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index b5f05f5fe..7323c8d96 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -1,7 +1,7 @@ - net472;netcoreapp2.0;netcoreapp2.1;netcoreapp2.2 + net472;netcoreapp2.1;netcoreapp2.2 false $(NoWarn);CS1591 true From 720653e55004b99971cf095cac2ade5748f41fed Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 08:35:27 -0600 Subject: [PATCH 0011/1753] Merge test results even on build/test failure --- azure-pipelines.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index a41bc3369..79cc4269d 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -69,6 +69,7 @@ jobs: - macOS pool: vmImage: Ubuntu 16.04 + condition: succeededOrFailed() steps: - template: azure-pipelines/install-dependencies.yml - template: azure-pipelines/publish-codecoverage.yml From 5806251694796175fbfa806406d27e8018c64eed Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 08:39:17 -0600 Subject: [PATCH 0012/1753] dotnet tool install resilience against authenticated feeds --- azure-pipelines.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 79cc4269d..5d87afbe6 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -24,7 +24,7 @@ jobs: - template: azure-pipelines/install-dependencies.yml - powershell: | - dotnet tool install --tool-path .. nbgv + dotnet tool install --tool-path .. nbgv --ignore-failed-sources ../nbgv cloud displayName: Set build number workingDirectory: src From 3367e54100fa8ba0b58c7d394fa3b5c1dca03d3c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 17:37:37 -0600 Subject: [PATCH 0013/1753] Switch artifact collection and some variables to ps1 scripts --- .gitignore | 7 +-- azure-pipelines.yml | 6 +-- azure-pipelines/artifacts/Variables.ps1 | 40 ++++++++++++++ azure-pipelines/artifacts/_all.ps1 | 45 ++++++++++++++++ azure-pipelines/artifacts/_pipelines.ps1 | 52 +++++++++++++++++++ azure-pipelines/artifacts/build_logs.ps1 | 10 ++++ azure-pipelines/artifacts/coverageResults.ps1 | 20 +++++++ azure-pipelines/artifacts/deployables.ps1 | 11 ++++ .../artifacts/projectAssetsJson.ps1 | 7 +++ azure-pipelines/collect-deployables.yml | 15 ------ azure-pipelines/collect-logs.yml | 9 ---- azure-pipelines/dotnet.yml | 44 +++------------- azure-pipelines/install-dependencies.yml | 10 +++- .../variables/DotNetSdkVersion.ps1 | 2 + azure-pipelines/variables/_all.ps1 | 10 ++++ azure-pipelines/variables/_pipelines.ps1 | 15 ++++++ 16 files changed, 230 insertions(+), 73 deletions(-) create mode 100644 azure-pipelines/artifacts/Variables.ps1 create mode 100644 azure-pipelines/artifacts/_all.ps1 create mode 100644 azure-pipelines/artifacts/_pipelines.ps1 create mode 100644 azure-pipelines/artifacts/build_logs.ps1 create mode 100644 azure-pipelines/artifacts/coverageResults.ps1 create mode 100644 azure-pipelines/artifacts/deployables.ps1 create mode 100644 azure-pipelines/artifacts/projectAssetsJson.ps1 delete mode 100644 azure-pipelines/collect-deployables.yml delete mode 100644 azure-pipelines/collect-logs.yml create mode 100644 azure-pipelines/variables/DotNetSdkVersion.ps1 create mode 100644 azure-pipelines/variables/_all.ps1 create mode 100644 azure-pipelines/variables/_pipelines.ps1 diff --git a/.gitignore b/.gitignore index 846c8c0a3..fc1d26fa8 100644 --- a/.gitignore +++ b/.gitignore @@ -55,11 +55,6 @@ dlldata.c # Benchmark Results BenchmarkDotNet.Artifacts/ -# .NET Core -project.lock.json -project.fragment.lock.json -artifacts/ - # StyleCop StyleCopReport.xml @@ -346,4 +341,4 @@ ASALocalRun/ healthchecksdb # Backup folder for Package Reference Convert tool in Visual Studio 2017 -MigrationBackup/ \ No newline at end of file +MigrationBackup/ diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 5d87afbe6..52451bc17 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -30,15 +30,13 @@ jobs: workingDirectory: src - template: azure-pipelines/dotnet.yml - - template: azure-pipelines/collect-deployables.yml - - template: azure-pipelines/collect-logs.yml - template: azure-pipelines/expand-template.yml - task: NuGetCommand@2 displayName: Push packages to CI feed inputs: command: push - packagesToPush: $(Build.ArtifactStagingDirectory)/deployables/*.nupkg;$(Build.ArtifactStagingDirectory)/deployables/*.snupkg + packagesToPush: $(Build.ArtifactStagingDirectory)/deployables-Windows/*.nupkg;$(Build.ArtifactStagingDirectory)/deployables-Windows/*.snupkg nuGetFeedType: internal publishVstsFeed: $(ci_feed) allowPackageConflicts: true @@ -50,7 +48,6 @@ jobs: steps: - template: azure-pipelines/install-dependencies.yml - template: azure-pipelines/dotnet.yml - - template: azure-pipelines/collect-logs.yml - template: azure-pipelines/expand-template.yml - job: macOS @@ -59,7 +56,6 @@ jobs: steps: - template: azure-pipelines/install-dependencies.yml - template: azure-pipelines/dotnet.yml - - template: azure-pipelines/collect-logs.yml - template: azure-pipelines/expand-template.yml - job: MergeCoverage diff --git a/azure-pipelines/artifacts/Variables.ps1 b/azure-pipelines/artifacts/Variables.ps1 new file mode 100644 index 000000000..cfcb7df52 --- /dev/null +++ b/azure-pipelines/artifacts/Variables.ps1 @@ -0,0 +1,40 @@ +# This artifact captures all variables defined in the ..\variables folder. +# It "snaps" the values of these variables where we can compute them during the build, +# and otherwise captures the scripts to run later during an Azure Pipelines environment release. + +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +$ArtifactBasePath = "$RepoRoot\obj\_artifacts" +$VariablesArtifactPath = "$ArtifactBasePath\variables" +if (-not (Test-Path $VariablesArtifactPath)) { New-Item -ItemType Directory -Path $VariablesArtifactPath | Out-Null } + +# Copy variables, either by value if the value is calculable now, or by script +Get-ChildItem -Path "$PSScriptRoot\..\variables" |% { + $value = $null + if (-not $_.BaseName.StartsWith('_')) { # Skip trying to interpret special scripts + # First check the environment variables in case the variable was set in a queued build + if (Test-Path env:$($_.BaseName)) { + $value = Get-Content "env:$($_.BaseName)" + } + + # If that didn't give us anything, try executing the script right now from its original position + if (-not $value) { + $value = & $_.FullName + } + + if ($value) { + # We got something, so wrap it with quotes so it's treated like a literal value. + $value = "'$value'" + } + } + + # If that didn't get us anything, just copy the script itself + if (-not $value) { + $value = Get-Content -Path $_.FullName + } + + Set-Content -Path "$VariablesArtifactPath\$($_.Name)" -Value $value +} + +@{ + "$VariablesArtifactPath" = (Get-ChildItem $VariablesArtifactPath -Recurse); +} diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 new file mode 100644 index 000000000..bd5e9d34c --- /dev/null +++ b/azure-pipelines/artifacts/_all.ps1 @@ -0,0 +1,45 @@ +# This script returns all the artifacts that should be collected after a build. +# +# Each powershell artifact is expressed as an object with these properties: +# Source - the full path to the source file +# ArtifactName - the name of the artifact to upload to +# ContainerFolder - the relative path within the artifact in which the file should appear +# +# Each artifact aggregating .ps1 script should return a hashtable: +# Key = path to the directory from which relative paths within the artifact should be calculated +# Value = an array of paths (absolute or relative to the BaseDirectory) to files to include in the artifact. +# FileInfo objects are also allowed. + +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") + +Function EnsureTrailingSlash($path) { + if ($path.length -gt 0 -and !$path.EndsWith('\') -and !$path.EndsWith('/')) { + $path = $path + [IO.Path]::DirectorySeparatorChar + } + + $path.Replace('\', [IO.Path]::DirectorySeparatorChar) +} + +Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse |% { + $ArtifactName = $_.BaseName + + (& $_).GetEnumerator() |% { + $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key), [UriKind]::Absolute) + $_.Value |% { + if ($_.GetType() -eq [IO.FileInfo] -or $_.GetType() -eq [IO.DirectoryInfo]) { + $_ = $_.FullName + } + + $artifact = New-Object -TypeName PSObject + Add-Member -InputObject $artifact -MemberType NoteProperty -Name ArtifactName -Value $ArtifactName + + $SourceFullPath = New-Object Uri ($BaseDirectory, $_) + Add-Member -InputObject $artifact -MemberType NoteProperty -Name Source -Value $SourceFullPath.LocalPath + + $RelativePath = [Uri]::UnescapeDataString($BaseDirectory.MakeRelative($SourceFullPath)) + Add-Member -InputObject $artifact -MemberType NoteProperty -Name ContainerFolder -Value (Split-Path $RelativePath) + + Write-Output $artifact + } + } +} diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 new file mode 100644 index 000000000..59dd2cf20 --- /dev/null +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -0,0 +1,52 @@ +# This script translates all the artifacts described by _all.ps1 +# into commands that instruct VSTS to actually collect those artifacts. + +param ( + [string]$ArtifactNameSuffix +) + +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +if (!$env:BUILDCONFIGURATION) { throw "BUILDCONFIGURATION environment variable must be set." } +if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { + $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY +} else { + $ArtifactStagingFolder = "$RepoRoot\obj\_artifacts" + if (Test-Path $ArtifactStagingFolder) { + Remove-Item $ArtifactStagingFolder -Recurse -Force + } +} + +function Create-SymbolicLink { + param ( + $Link, + $Target + ) + + if ($Link -eq $Target) { + return + } + + if (Test-Path $Link) { Remove-Item $Link } + $LinkContainer = Split-Path $Link -Parent + if (!(Test-Path $LinkContainer)) { mkdir $LinkContainer } + Write-Verbose "Linking $Link to $Target" + ln $Target $Link +} + +# Stage all artifacts +$Artifacts = & "$PSScriptRoot\_all.ps1" +$Artifacts |% { + $DestinationFolder = (Join-Path (Join-Path $ArtifactStagingFolder "$($_.ArtifactName)$ArtifactNameSuffix") $_.ContainerFolder).TrimEnd('\') + $Name = "$(Split-Path $_.Source -Leaf)" + + #Write-Host "$($_.Source) -> $($_.ArtifactName)\$($_.ContainerFolder)" -ForegroundColor Yellow + + if (-not (Test-Path $DestinationFolder)) { New-Item -ItemType Directory -Path $DestinationFolder | Out-Null } + if (Test-Path -PathType Leaf $_.Source) { # skip folders + Create-SymbolicLink -Link "$DestinationFolder\$Name" -Target $_.Source + } +} + +$Artifacts |% { $_.ArtifactName } | Get-Unique |% { + Write-Host "##vso[artifact.upload containerfolder=$_$ArtifactNameSuffix;artifactname=$_$ArtifactNameSuffix;]$ArtifactStagingFolder/$_$ArtifactNameSuffix" +} diff --git a/azure-pipelines/artifacts/build_logs.ps1 b/azure-pipelines/artifacts/build_logs.ps1 new file mode 100644 index 000000000..5ba801c5f --- /dev/null +++ b/azure-pipelines/artifacts/build_logs.ps1 @@ -0,0 +1,10 @@ +if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { + $artifactsRoot = $env:BUILD_ARTIFACTSTAGINGDIRECTORY +} else { + $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") + $artifactsRoot = "$RepoRoot\bin" +} + +@{ + "$artifactsRoot/build_logs" = (Get-ChildItem -Recurse "$artifactsRoot/build_logs") +} diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 new file mode 100644 index 000000000..36189f334 --- /dev/null +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -0,0 +1,20 @@ +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") + +# Prepare code coverage reports for merging on another machine +if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { + Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`"" + $reports = Get-ChildItem "$RepoRoot/bin/coverage.cobertura.xml" -Recurse + $reports |% { + $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } + Set-Content -Path $_ -Value $content -Encoding UTF8 + } +} else { + Write-Warning "Azure Pipelines not detected. Machine-neutral token replacement skipped." +} + +@{ + $RepoRoot = ( + (Get-ChildItem "$RepoRoot\bin\coverage.cobertura.xml" -Recurse) + + (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse) + ); +} diff --git a/azure-pipelines/artifacts/deployables.ps1 b/azure-pipelines/artifacts/deployables.ps1 new file mode 100644 index 000000000..893df6dd0 --- /dev/null +++ b/azure-pipelines/artifacts/deployables.ps1 @@ -0,0 +1,11 @@ +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +$BuildConfiguration = $env:BUILDCONFIGURATION +if (!$BuildConfiguration) { + $BuildConfiguration = 'Debug' +} + +$PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration" + +@{ + "$PackagesRoot" = (Get-ChildItem $PackagesRoot -Recurse) +} diff --git a/azure-pipelines/artifacts/projectAssetsJson.ps1 b/azure-pipelines/artifacts/projectAssetsJson.ps1 new file mode 100644 index 000000000..5e9217bde --- /dev/null +++ b/azure-pipelines/artifacts/projectAssetsJson.ps1 @@ -0,0 +1,7 @@ +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") + +@{ + "$RepoRoot\obj" = ( + (Get-ChildItem "$RepoRoot\obj\project.assets.json" -Recurse) + ); +} diff --git a/azure-pipelines/collect-deployables.yml b/azure-pipelines/collect-deployables.yml deleted file mode 100644 index 5d77acfca..000000000 --- a/azure-pipelines/collect-deployables.yml +++ /dev/null @@ -1,15 +0,0 @@ -steps: -- task: CopyFiles@1 - inputs: - Contents: | - bin/Packages/$(BuildConfiguration)/* - TargetFolder: $(Build.ArtifactStagingDirectory)/deployables - flattenFolders: true - displayName: Collecting deployable artifacts - -- task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/deployables - ArtifactName: deployables - ArtifactType: Container - displayName: Publish deployables artifacts diff --git a/azure-pipelines/collect-logs.yml b/azure-pipelines/collect-logs.yml deleted file mode 100644 index ab39d91f0..000000000 --- a/azure-pipelines/collect-logs.yml +++ /dev/null @@ -1,9 +0,0 @@ -steps: - -- task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/build_logs - ArtifactName: build_logs-$(Agent.JobName) - ArtifactType: Container - displayName: Publish build_logs artifacts - condition: succeededOrFailed() diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index fe055ef7a..668083e76 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -36,48 +36,20 @@ steps: testRunTitle: netcoreapp2.2-$(Agent.JobName) workingDirectory: src -- task: CopyFiles@1 +- task: PowerShell@2 inputs: - Contents: | - bin/**/coverage.cobertura.xml - obj/**/*.cs - TargetFolder: $(Build.ArtifactStagingDirectory)/coverageResults - displayName: Collecting coverage.cobertura.xml artifacts + filePath: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true + displayName: Update pipeline variables based on build outputs condition: succeededOrFailed() -- powershell: | - Write-Host "Substituting $(System.DefaultWorkingDirectory) with {reporoot}" - $reports = Get-ChildItem "$(Build.ArtifactStagingDirectory)/coverageResults/coverage.cobertura.xml" -Recurse - $reports |% { - $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape("$(System.DefaultWorkingDirectory)"), "{reporoot}" } - Set-Content -Path $_ -Value $content -Encoding UTF8 - } - displayName: Preparing code coverage reports for merging on another machine - -- task: PublishBuildArtifacts@1 +- task: PowerShell@2 inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/coverageResults - ArtifactName: coverageResults-$(Agent.JobName) - ArtifactType: Container - displayName: Publish coverageResults artifacts + filePath: azure-pipelines/artifacts/_pipelines.ps1 + arguments: -ArtifactNameSuffix "-$(Agent.JobName)" + displayName: Publish artifacts condition: succeededOrFailed() - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') - -- task: CopyFiles@1 - inputs: - Contents: | - obj/**/project.assets.json - TargetFolder: $(Build.ArtifactStagingDirectory)/projectAssetsJson - displayName: Collecting project.assets.json artifacts - condition: succeededOrFailed() - -- task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/projectAssetsJson - ArtifactName: projectAssetsJson-$(Agent.JobName) - ArtifactType: Container - displayName: Publish projectAssetsJson artifacts - condition: succeededOrFailed() diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 80830cc7f..5b0b8c3af 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -1,13 +1,19 @@ steps: +- task: PowerShell@2 + inputs: + filePath: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true + displayName: Set pipeline variables based on source + - script: dotnet --info displayName: .NET Core SDK/runtimes (on host) workingDirectory: $(Agent.HomeDirectory) - task: UseDotNet@2 - displayName: Install .NET Core SDK 2.2.300 + displayName: Install .NET Core SDK inputs: packageType: sdk - version: 2.2.300 + version: $(DotNetSdkVersion) - task: UseDotNet@2 displayName: Install .NET Core runtime 2.0.x diff --git a/azure-pipelines/variables/DotNetSdkVersion.ps1 b/azure-pipelines/variables/DotNetSdkVersion.ps1 new file mode 100644 index 000000000..b213fbc27 --- /dev/null +++ b/azure-pipelines/variables/DotNetSdkVersion.ps1 @@ -0,0 +1,2 @@ +$globalJson = Get-Content -Path "$PSScriptRoot\..\..\global.json" | ConvertFrom-Json +$globalJson.sdk.version diff --git a/azure-pipelines/variables/_all.ps1 b/azure-pipelines/variables/_all.ps1 new file mode 100644 index 000000000..680a3398e --- /dev/null +++ b/azure-pipelines/variables/_all.ps1 @@ -0,0 +1,10 @@ +# This script returns a hashtable of build variables that should be set +# at the start of a build or release definition's execution. + +$vars = @{} + +Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" |% { + $vars[$_.BaseName] = & $_ +} + +$vars diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 new file mode 100644 index 000000000..b3fde25da --- /dev/null +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -0,0 +1,15 @@ +# This script translates the variables returned by the _all.ps1 script +# into commands that instruct VSTS to actually set those variables for other VSTS tasks to consume. + +# The build or release definition may have set these variables to override +# what the build would do. So only set them if they have not already been set. + +(& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { + if (Test-Path -Path "env:$($_.Key.ToUpper())") { + Write-Host "Skipping setting $($_.Key) because variable is already set." -ForegroundColor Cyan + } else { + Write-Host "$($_.Key)=$($_.Value)" -ForegroundColor Yellow + Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" + Set-Item -Path "env:$($_.Key)" -Value $_.Value + } +} From baea971aa13cdb2d7e56ae7ab643b96613972894 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 23:01:20 -0600 Subject: [PATCH 0014/1753] Publish merged code coverage even when some inputs fail --- azure-pipelines/publish-codecoverage.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index fc5307817..b9b7b72af 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -4,16 +4,19 @@ steps: inputs: artifactName: coverageResults-Windows downloadPath: $(System.DefaultWorkingDirectory)/bin + continueOnError: true - task: DownloadBuildArtifacts@0 displayName: Download Linux code coverage results inputs: artifactName: coverageResults-Linux downloadPath: $(System.DefaultWorkingDirectory)/bin + continueOnError: true - task: DownloadBuildArtifacts@0 displayName: Download macOS code coverage results inputs: artifactName: coverageResults-macOS downloadPath: $(System.DefaultWorkingDirectory)/bin + continueOnError: true - powershell: | dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 Copy-Item -Recurse $(System.DefaultWorkingDirectory)/bin/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj From 70c8febd704082f5f235a36d112ca4b78f082804 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 23:01:47 -0600 Subject: [PATCH 0015/1753] Push nuget package to CI only if all agents succeed --- azure-pipelines.yml | 13 ++----------- azure-pipelines/publish-deployables.yml | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 azure-pipelines/publish-deployables.yml diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 52451bc17..8bff4e894 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -32,16 +32,6 @@ jobs: - template: azure-pipelines/dotnet.yml - template: azure-pipelines/expand-template.yml - - task: NuGetCommand@2 - displayName: Push packages to CI feed - inputs: - command: push - packagesToPush: $(Build.ArtifactStagingDirectory)/deployables-Windows/*.nupkg;$(Build.ArtifactStagingDirectory)/deployables-Windows/*.snupkg - nuGetFeedType: internal - publishVstsFeed: $(ci_feed) - allowPackageConflicts: true - condition: ne(variables['ci_feed'], '') - - job: Linux pool: vmImage: Ubuntu 16.04 @@ -58,7 +48,7 @@ jobs: - template: azure-pipelines/dotnet.yml - template: azure-pipelines/expand-template.yml -- job: MergeCoverage +- job: WrapUp dependsOn: - Windows - Linux @@ -69,3 +59,4 @@ jobs: steps: - template: azure-pipelines/install-dependencies.yml - template: azure-pipelines/publish-codecoverage.yml + - template: azure-pipelines/publish-deployables.yml diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml new file mode 100644 index 000000000..85c76e7b5 --- /dev/null +++ b/azure-pipelines/publish-deployables.yml @@ -0,0 +1,15 @@ +steps: +- task: DownloadBuildArtifacts@0 + displayName: Download deployables + inputs: + artifactName: deployables-Windows + downloadPath: $(System.DefaultWorkingDirectory)/bin +- task: DotNetCoreCLI@2 + displayName: Push packages to CI feed + inputs: + command: push + packagesToPush: $(System.DefaultWorkingDirectory)/bin/deployables-Windows/*.nupkg + nuGetFeedType: internal + publishVstsFeed: $(ci_feed) + allowPackageConflicts: true + condition: and(succeeded(), ne(variables['ci_feed'], '')) From e4cbe719a90f11a3b7545ffe90a56607322e8771 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Jul 2019 21:42:35 -0600 Subject: [PATCH 0016/1753] Add init.ps1 and Install-DotNetSdk.ps1 scripts Closes #12 --- .gitattributes | 3 +++ CONTRIBUTING.md | 5 ++++ init.ps1 | 9 +++++++ tools/Install-DotNetSdk.ps1 | 54 +++++++++++++++++++++++++++++++++++++ 4 files changed, 71 insertions(+) create mode 100644 init.ps1 create mode 100644 tools/Install-DotNetSdk.ps1 diff --git a/.gitattributes b/.gitattributes index 1ff0c4230..9b6ea6248 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,6 +3,9 @@ ############################################################################### * text=auto +# Ensure bash shell scripts use LF line endings +*.sh eol=lf + ############################################################################### # Set default behavior for command prompt diff. # diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f36ba668..4834cebfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,8 +17,13 @@ For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.31 while the 2.2.400 version would not be considered compatible by .NET SDK. See [.NET Core Versioning](https://docs.microsoft.com/en-us/dotnet/core/versions/) for more information. +All dependencies can be installed by running the `init.ps1` script at the root of the repository +using Windows PowerShell or [PowerShell Core][pwsh] (on any OS). + This repository can be built on Windows, Linux, and OSX. ## Building Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). + +[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-6 diff --git a/init.ps1 b/init.ps1 new file mode 100644 index 000000000..6f0a07761 --- /dev/null +++ b/init.ps1 @@ -0,0 +1,9 @@ +<# +.SYNOPSIS +Installs dependencies required to build and test the projects in this repository. +#> +[CmdletBinding(SupportsShouldProcess=$true)] +Param ( +) + +& "$PSScriptRoot\tools\Install-DotNetSdk.ps1" diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 new file mode 100644 index 000000000..ca73cb760 --- /dev/null +++ b/tools/Install-DotNetSdk.ps1 @@ -0,0 +1,54 @@ +<# +.SYNOPSIS +Installs the .NET SDK specified in the global.json file at the root of this repository, +along with supporting .NET Core runtimes used for testing. +#> +[CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] +Param ( +) + +$DotNetInstallScriptRoot = Resolve-Path $PSScriptRoot\..\obj +$sdkVersion = & "$PSScriptRoot\..\azure-pipelines\variables\DotNetSdkVersion.ps1" + +if ($IsMacOS -or $IsLinux) { + $DownloadUri = "https://dot.net/v1/dotnet-install.sh" + $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" +} else { + $DownloadUri = "https://dot.net/v1/dotnet-install.ps1" + $DotNetInstallScriptPath = "$DotNetInstallScriptRoot\dotnet-install.ps1" +} + +if (-not (Test-Path $DotNetInstallScriptPath)) { + Invoke-WebRequest -Uri $DownloadUri -OutFile $DotNetInstallScriptPath + chmod +x $DotNetInstallScriptPath +} + +if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + & $DotNetInstallScriptPath -Version $sdkVersion -Architecture x64 +} else { + & $DotNetInstallScriptPath -Version $sdkVersion -Architecture x64 -DryRun +} + +# Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. +$runtimeVersions = @() +Get-ChildItem "$PSScriptRoot\..\src\*.*proj" -Recurse |% { + $projXml = [xml](Get-Content -Path $_) + $targetFrameworks = $projXml.Project.PropertyGroup.TargetFramework + if (!$targetFrameworks) { + $targetFrameworks = $projXml.Project.PropertyGroup.TargetFrameworks + if ($targetFrameworks) { + $targetFrameworks = $targetFrameworks.Split(';') + } + } + $targetFrameworks |? { $_ -match 'netcoreapp(\d+\.\d+)' } |% { + $runtimeVersions += $Matches[1] + } +} + +$runtimeVersions | Get-Unique |% { + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + & $DotNetInstallScriptPath -Channel $_ -Runtime dotnet -Architecture x64 + } else { + & $DotNetInstallScriptPath -Channel $_ -Runtime dotnet -Architecture x64 -DryRun + } +} From 45cb59eadbda46815ca7ee052c5d8a113d9560fc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Jul 2019 08:50:38 -0600 Subject: [PATCH 0017/1753] install-dependencies.yml now shares init.ps1 script --- CONTRIBUTING.md | 5 ++ azure-pipelines/expand-template.yml | 4 +- azure-pipelines/install-dependencies.yml | 26 +------- init.ps1 | 12 +++- tools/Install-DotNetSdk.ps1 | 82 +++++++++++++++++++++--- 5 files changed, 95 insertions(+), 34 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4834cebfe..f2f4a8ca5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,11 @@ FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +## Best practices + +* Use Windows PowerShell or [PowerShell Core][pwsh] (including on Linux/OSX) to run .ps1 scripts. + Some scripts set environment variables to help you, but they are only retained if you use PowerShell as your shell. + ## Prerequisites The only prerequisite for building, testing, and deploying from this repository diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index 74960e566..708534d5d 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -1,5 +1,7 @@ steps: -- script: git clean -fdx +- script: | + dotnet build-server shutdown + git clean -fdx displayName: Cleaning repo for template expansion - powershell: ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" displayName: Expanding template diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 5b0b8c3af..38fa5c08e 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -5,27 +5,5 @@ steps: failOnStderr: true displayName: Set pipeline variables based on source -- script: dotnet --info - displayName: .NET Core SDK/runtimes (on host) - workingDirectory: $(Agent.HomeDirectory) - -- task: UseDotNet@2 - displayName: Install .NET Core SDK - inputs: - packageType: sdk - version: $(DotNetSdkVersion) - -- task: UseDotNet@2 - displayName: Install .NET Core runtime 2.0.x - inputs: - packageType: runtime - version: 2.0.x - -- task: UseDotNet@2 - displayName: Install .NET Core runtime 2.1.x - inputs: - packageType: runtime - version: 2.1.x - -- script: dotnet --info - displayName: .NET Core SDK/runtimes (explicitly installed) +- powershell: .\init.ps1 + displayName: Install prerequisites diff --git a/init.ps1 b/init.ps1 index 6f0a07761..41e5556bc 100644 --- a/init.ps1 +++ b/init.ps1 @@ -1,9 +1,19 @@ <# .SYNOPSIS Installs dependencies required to build and test the projects in this repository. +.DESCRIPTION +This does not require elevation, as the dependencies are installed in per-user locations. +.PARAMETER InstallLocality +A value indicating whether dependencies should be installed locally to the repo or at a per-user location. +Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. +Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. +When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. +Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. #> [CmdletBinding(SupportsShouldProcess=$true)] Param ( + [ValidateSet('repo','user')] + [string]$InstallLocality='user' ) -& "$PSScriptRoot\tools\Install-DotNetSdk.ps1" +& "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index ca73cb760..9db8558f2 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -2,20 +2,56 @@ .SYNOPSIS Installs the .NET SDK specified in the global.json file at the root of this repository, along with supporting .NET Core runtimes used for testing. +.DESCRIPTION +This does not require elevation, as the SDK and runtimes are installed locally to this repo location. +.PARAMETER InstallLocality +A value indicating whether dependencies should be installed locally to the repo or at a per-user location. +Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. +Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. +When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. +Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( + [ValidateSet('repo','user')] + [string]$InstallLocality='user' ) -$DotNetInstallScriptRoot = Resolve-Path $PSScriptRoot\..\obj -$sdkVersion = & "$PSScriptRoot\..\azure-pipelines\variables\DotNetSdkVersion.ps1" +$DotNetInstallScriptRoot = "$PSScriptRoot/../obj" +if (!(Test-Path $DotNetInstallScriptRoot)) { mkdir $DotNetInstallScriptRoot | Out-Null } + +$switches = @( + '-Architecture','x64' +) +$envVars = @{ + # For locally installed dotnet, skip first time experience which takes a long time + 'DOTNET_SKIP_FIRST_TIME_EXPERIENCE' = 'true'; +} + +$DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot +if ($InstallLocality -eq 'repo') { + $DotNetInstallDir = "$DotNetInstallScriptRoot/.dotnet" +} elseif ($env:AGENT_TOOLSDIRECTORY) { + $DotNetInstallDir = "$env:AGENT_TOOLSDIRECTORY/dotnet" +} else { + $DotNetInstallDir = Join-Path $HOME .dotnet +} + +Write-Host "Installing .NET Core SDK and runtimes to $DotNetInstallDir" -ForegroundColor Blue + +if ($DotNetInstallDir) { + $switches += '-InstallDir',$DotNetInstallDir + $envVars['DOTNET_MULTILEVEL_LOOKUP'] = '0' + $envVars['DOTNET_ROOT'] = $DotNetInstallDir +} +$sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" if ($IsMacOS -or $IsLinux) { $DownloadUri = "https://dot.net/v1/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { $DownloadUri = "https://dot.net/v1/dotnet-install.ps1" - $DotNetInstallScriptPath = "$DotNetInstallScriptRoot\dotnet-install.ps1" + $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } if (-not (Test-Path $DotNetInstallScriptPath)) { @@ -24,9 +60,9 @@ if (-not (Test-Path $DotNetInstallScriptPath)) { } if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - & $DotNetInstallScriptPath -Version $sdkVersion -Architecture x64 + Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" } else { - & $DotNetInstallScriptPath -Version $sdkVersion -Architecture x64 -DryRun + Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" } # Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. @@ -37,7 +73,7 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj" -Recurse |% { if (!$targetFrameworks) { $targetFrameworks = $projXml.Project.PropertyGroup.TargetFrameworks if ($targetFrameworks) { - $targetFrameworks = $targetFrameworks.Split(';') + $targetFrameworks = $targetFrameworks -Split ';' } } $targetFrameworks |? { $_ -match 'netcoreapp(\d+\.\d+)' } |% { @@ -45,10 +81,40 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj" -Recurse |% { } } +$switches += '-Runtime','dotnet' + $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - & $DotNetInstallScriptPath -Channel $_ -Runtime dotnet -Architecture x64 + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" } else { - & $DotNetInstallScriptPath -Channel $_ -Runtime dotnet -Architecture x64 -DryRun + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" + } +} + +Write-Host "Environment variables to be set:" -ForegroundColor Blue +$envVars + +if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these installed runtimes?")) { + if ($env:TF_BUILD) { + Write-Host "Azure Pipelines detected. Logging commands will be used to propagate environment variables and prepend path." + } + + $envVars.GetEnumerator() |% { + Set-Item -Path env:$($_.Key) -Value $_.Value + + # If we're running in Azure Pipelines, set these environment variables + if ($env:TF_BUILD) { + Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" + } + } + + if ($IsMacOS -or $IsLinux) { + $env:PATH = "${DotNetInstallDir}:$env:PATH" + } else { + $env:PATH = "$DotNetInstallDir;$env:PATH" + } + + if ($env:TF_BUILD) { + Write-Host "##vso[task.prependpath]$DotNetInstallDir" } } From e4753b7b235a6969dc2be8d6b1d8bda7fafb8adc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 9 Jul 2019 21:45:34 -0600 Subject: [PATCH 0018/1753] Add -Squash switch to Expand-Template.ps1 --- Expand-Template.ps1 | 14 +++++++++++++- azure-pipelines/expand-template.yml | 5 ++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index c1447d4c9..7558ca51a 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -10,6 +10,8 @@ A token obtained from codecov.io for your repo. If not specified, code coverage but can be added later by editing the Azure Pipelines YAML file. .PARAMETER CIFeed The `/{guid}` path to the Azure Pipelines artifact feed to push your nuget package to as part of your CI. +.PARAMETER Squash +A switch that causes all of git history to be squashed to just one initial commit for the template, and one for its expansion. #> [CmdletBinding()] Param( @@ -20,7 +22,9 @@ Param( [Parameter()] [string]$CodeCovToken, [Parameter()] - [string]$CIFeed + [string]$CIFeed, + [Parameter()] + [switch]$Squash ) function Replace-Placeholders { @@ -69,6 +73,11 @@ if (-not $sn) { Push-Location $PSScriptRoot try { + if ($Squash) { + git reset --soft $(git rev-list --max-parents=0 HEAD) + git commit --amend -qm "Initial template from https://github.com/AArnott/Library.Template" + } + # Rename project directories and solution Set-Location src git mv Library.sln "$LibraryName.sln" @@ -147,6 +156,9 @@ try { Write-Error "PLACEHOLDER discovered in $($_.FullName)" } } + + # Commit the changes + git commit -qm "Expanded template for $LibraryName" -m "This expansion done by the (now removed) Expand-Template.ps1 script." } finally { Pop-Location } diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index 708534d5d..2d9ea7b30 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -3,7 +3,10 @@ steps: dotnet build-server shutdown git clean -fdx displayName: Cleaning repo for template expansion -- powershell: ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" +- powershell: | + git config user.name "test user" + git config user.email "andrewarnott@gmail.com" + ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" displayName: Expanding template failOnStderr: true # TODO: Verify that all changes are staged to the git index From 18164cfa4ecefc40d937a652c98dda68ff22ddc8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Jul 2019 15:25:10 -0600 Subject: [PATCH 0019/1753] Add timeout to codecov publish step I saw this hang for a long time once, presumably when codecov.io was down. --- azure-pipelines/dotnet.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 668083e76..1ca019a08 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -53,3 +53,4 @@ steps: - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') + timeoutInMinutes: 3 From f4b75c2ffb7394ee4661f333c565d7446b70ffb5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 09:39:31 -0600 Subject: [PATCH 0020/1753] Tests ruleset inherits from shipping one --- src/tests.ruleset | 72 ++--------------------------------------------- 1 file changed, 2 insertions(+), 70 deletions(-) diff --git a/src/tests.ruleset b/src/tests.ruleset index c74c6ed34..4b4708a12 100644 --- a/src/tests.ruleset +++ b/src/tests.ruleset @@ -1,75 +1,7 @@  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - @@ -80,4 +12,4 @@ - \ No newline at end of file + From 26871ccaeafb1ce4d0c26ee08137bf39883c47ff Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 13:17:52 -0600 Subject: [PATCH 0021/1753] Move jobs into build.yml --- Expand-Template.ps1 | 6 +++-- azure-pipelines.yml | 43 +----------------------------------- azure-pipelines/build.yml | 46 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 44 deletions(-) create mode 100644 azure-pipelines/build.yml diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 7558ca51a..c050aba3f 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -128,10 +128,12 @@ try { "(?m)^.*\[codecov\].*`r?`n"="" } - # Specially handle azure-pipelines.yml edits - $YmlReplacements = @{ + # Specially handle azure-pipelines .yml edits + Replace-Placeholders -Path "azure-pipelines/build.yml" -Replacements @{ "(?m).*expand-template\.yml(?:\r)?\n" = "" } + + $YmlReplacements = @{} if ($CodeCovToken) { $YmlReplacements['(codecov_token: ).*(#.*)'] = "`$1$CodeCovToken" } else { diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 8bff4e894..f158ff523 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -18,45 +18,4 @@ variables: ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed jobs: -- job: Windows - pool: Hosted Windows 2019 with VS2019 - steps: - - template: azure-pipelines/install-dependencies.yml - - - powershell: | - dotnet tool install --tool-path .. nbgv --ignore-failed-sources - ../nbgv cloud - displayName: Set build number - workingDirectory: src - - - template: azure-pipelines/dotnet.yml - - template: azure-pipelines/expand-template.yml - -- job: Linux - pool: - vmImage: Ubuntu 16.04 - steps: - - template: azure-pipelines/install-dependencies.yml - - template: azure-pipelines/dotnet.yml - - template: azure-pipelines/expand-template.yml - -- job: macOS - pool: - vmImage: macOS 10.13 - steps: - - template: azure-pipelines/install-dependencies.yml - - template: azure-pipelines/dotnet.yml - - template: azure-pipelines/expand-template.yml - -- job: WrapUp - dependsOn: - - Windows - - Linux - - macOS - pool: - vmImage: Ubuntu 16.04 - condition: succeededOrFailed() - steps: - - template: azure-pipelines/install-dependencies.yml - - template: azure-pipelines/publish-codecoverage.yml - - template: azure-pipelines/publish-deployables.yml +- template: azure-pipelines/build.yml diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml new file mode 100644 index 000000000..75b7e0c3c --- /dev/null +++ b/azure-pipelines/build.yml @@ -0,0 +1,46 @@ +parameters: + windowsPool: Hosted Windows 2019 with VS2019 + +jobs: +- job: Windows + pool: ${{ parameters.windowsPool }} + steps: + - template: install-dependencies.yml + + - powershell: | + dotnet tool install --tool-path .. nbgv --ignore-failed-sources + ../nbgv cloud + displayName: Set build number + workingDirectory: src + + - template: dotnet.yml + - template: expand-template.yml + +- job: Linux + pool: + vmImage: Ubuntu 16.04 + steps: + - template: install-dependencies.yml + - template: dotnet.yml + - template: expand-template.yml + +- job: macOS + pool: + vmImage: macOS 10.13 + steps: + - template: install-dependencies.yml + - template: dotnet.yml + - template: expand-template.yml + +- job: WrapUp + dependsOn: + - Windows + - Linux + - macOS + pool: + vmImage: Ubuntu 16.04 + condition: succeededOrFailed() + steps: + - template: install-dependencies.yml + - template: publish-codecoverage.yml + - template: publish-deployables.yml From 1263ef34db6d2d749f4cdd33696f1bae4ec27fb6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 13:32:27 -0600 Subject: [PATCH 0022/1753] Move nbgv installation in azp outside the src dir The Agent.ToolsDirectory is a popular place to put versioned tools like this. --- .gitignore | 3 +++ azure-pipelines/build.yml | 5 ++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index fc1d26fa8..e353101db 100644 --- a/.gitignore +++ b/.gitignore @@ -342,3 +342,6 @@ healthchecksdb # Backup folder for Package Reference Convert tool in Visual Studio 2017 MigrationBackup/ + +# dotnet tool local install directory +.store/ diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 75b7e0c3c..3ee5b0b9d 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -8,10 +8,9 @@ jobs: - template: install-dependencies.yml - powershell: | - dotnet tool install --tool-path .. nbgv --ignore-failed-sources - ../nbgv cloud + dotnet tool install --tool-path $(Agent.ToolsDirectory) nbgv --ignore-failed-sources + $(Agent.ToolsDirectory)/nbgv cloud displayName: Set build number - workingDirectory: src - template: dotnet.yml - template: expand-template.yml From ecb32a2ad6a0625bcaebec9bfcf44945cc63258d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 13:33:09 -0600 Subject: [PATCH 0023/1753] Don't deploy packages to CI feed on PR builds --- azure-pipelines/publish-deployables.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index 85c76e7b5..cdd852920 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -4,6 +4,7 @@ steps: inputs: artifactName: deployables-Windows downloadPath: $(System.DefaultWorkingDirectory)/bin + - task: DotNetCoreCLI@2 displayName: Push packages to CI feed inputs: @@ -12,4 +13,4 @@ steps: nuGetFeedType: internal publishVstsFeed: $(ci_feed) allowPackageConflicts: true - condition: and(succeeded(), ne(variables['ci_feed'], '')) + condition: and(succeeded(), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) From 13ab120e7f6f448092bffbff7d5ffc39b475ef70 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 13:33:44 -0600 Subject: [PATCH 0024/1753] Make azp/artifacts only warn when they can't find files --- azure-pipelines/artifacts/_all.ps1 | 37 +++++++++++-------- azure-pipelines/artifacts/build_logs.ps1 | 2 + azure-pipelines/artifacts/coverageResults.ps1 | 4 +- azure-pipelines/artifacts/deployables.ps1 | 2 + .../artifacts/projectAssetsJson.ps1 | 8 ++-- 5 files changed, 33 insertions(+), 20 deletions(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index bd5e9d34c..6f62be5c3 100644 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -23,23 +23,28 @@ Function EnsureTrailingSlash($path) { Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse |% { $ArtifactName = $_.BaseName - (& $_).GetEnumerator() |% { - $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key), [UriKind]::Absolute) - $_.Value |% { - if ($_.GetType() -eq [IO.FileInfo] -or $_.GetType() -eq [IO.DirectoryInfo]) { - $_ = $_.FullName + $fileGroups = & $_ + if (!$fileGroups -or $fileGroups.Count -eq 0) { + Write-Warning "No files found for the `"$ArtifactName`" artifact." + } else { + $fileGroups.GetEnumerator() | % { + $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key), [UriKind]::Absolute) + $_.Value | % { + if ($_.GetType() -eq [IO.FileInfo] -or $_.GetType() -eq [IO.DirectoryInfo]) { + $_ = $_.FullName + } + + $artifact = New-Object -TypeName PSObject + Add-Member -InputObject $artifact -MemberType NoteProperty -Name ArtifactName -Value $ArtifactName + + $SourceFullPath = New-Object Uri ($BaseDirectory, $_) + Add-Member -InputObject $artifact -MemberType NoteProperty -Name Source -Value $SourceFullPath.LocalPath + + $RelativePath = [Uri]::UnescapeDataString($BaseDirectory.MakeRelative($SourceFullPath)) + Add-Member -InputObject $artifact -MemberType NoteProperty -Name ContainerFolder -Value (Split-Path $RelativePath) + + Write-Output $artifact } - - $artifact = New-Object -TypeName PSObject - Add-Member -InputObject $artifact -MemberType NoteProperty -Name ArtifactName -Value $ArtifactName - - $SourceFullPath = New-Object Uri ($BaseDirectory, $_) - Add-Member -InputObject $artifact -MemberType NoteProperty -Name Source -Value $SourceFullPath.LocalPath - - $RelativePath = [Uri]::UnescapeDataString($BaseDirectory.MakeRelative($SourceFullPath)) - Add-Member -InputObject $artifact -MemberType NoteProperty -Name ContainerFolder -Value (Split-Path $RelativePath) - - Write-Output $artifact } } } diff --git a/azure-pipelines/artifacts/build_logs.ps1 b/azure-pipelines/artifacts/build_logs.ps1 index 5ba801c5f..b55ba48f3 100644 --- a/azure-pipelines/artifacts/build_logs.ps1 +++ b/azure-pipelines/artifacts/build_logs.ps1 @@ -5,6 +5,8 @@ if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { $artifactsRoot = "$RepoRoot\bin" } +if (!(Test-Path $artifactsRoot/build_logs)) { return } + @{ "$artifactsRoot/build_logs" = (Get-ChildItem -Recurse "$artifactsRoot/build_logs") } diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index 36189f334..619ac0f3a 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -9,9 +9,11 @@ if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { Set-Content -Path $_ -Value $content -Encoding UTF8 } } else { - Write-Warning "Azure Pipelines not detected. Machine-neutral token replacement skipped." + Write-Warning "coverageResults: Azure Pipelines not detected. Machine-neutral token replacement skipped." } +if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } + @{ $RepoRoot = ( (Get-ChildItem "$RepoRoot\bin\coverage.cobertura.xml" -Recurse) + diff --git a/azure-pipelines/artifacts/deployables.ps1 b/azure-pipelines/artifacts/deployables.ps1 index 893df6dd0..94c48cdd9 100644 --- a/azure-pipelines/artifacts/deployables.ps1 +++ b/azure-pipelines/artifacts/deployables.ps1 @@ -6,6 +6,8 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration" +if (!(Test-Path $PackagesRoot)) { return } + @{ "$PackagesRoot" = (Get-ChildItem $PackagesRoot -Recurse) } diff --git a/azure-pipelines/artifacts/projectAssetsJson.ps1 b/azure-pipelines/artifacts/projectAssetsJson.ps1 index 5e9217bde..d2e85ffbe 100644 --- a/azure-pipelines/artifacts/projectAssetsJson.ps1 +++ b/azure-pipelines/artifacts/projectAssetsJson.ps1 @@ -1,7 +1,9 @@ -$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +$ObjRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\obj") + +if (!(Test-Path $ObjRoot)) { return } @{ - "$RepoRoot\obj" = ( - (Get-ChildItem "$RepoRoot\obj\project.assets.json" -Recurse) + "$ObjRoot" = ( + (Get-ChildItem "$ObjRoot\project.assets.json" -Recurse) ); } From 3731857e1e4baa0782fedcd803fc7b5424598f9b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 13:58:00 -0600 Subject: [PATCH 0025/1753] Collect symbols artifact and publish to ADO --- azure-pipelines/Convert-PDB.ps1 | 37 ++++++++++++++++ azure-pipelines/Get-NuGetTool.ps1 | 21 +++++++++ azure-pipelines/artifacts/symbols.ps1 | 64 +++++++++++++++++++++++++++ azure-pipelines/dotnet.yml | 9 ++++ 4 files changed, 131 insertions(+) create mode 100644 azure-pipelines/Convert-PDB.ps1 create mode 100644 azure-pipelines/Get-NuGetTool.ps1 create mode 100644 azure-pipelines/artifacts/symbols.ps1 diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 new file mode 100644 index 000000000..00549f713 --- /dev/null +++ b/azure-pipelines/Convert-PDB.ps1 @@ -0,0 +1,37 @@ +<# +.SYNOPSIS + Builds all projects in this repo. +.PARAMETER DllPath + The path to the DLL whose PDB is to be converted. +.PARAMETER PdbPath + The path to the PDB to convert. May be omitted if the DLL was compiled on this machine and the PDB is still at its original path. +.PARAMETER OutputPath + The path of the output PDB to write. +#> +#Function Convert-PortableToWindowsPDB() { + Param( + [Parameter(Mandatory=$true,Position=0)] + [string]$DllPath, + [Parameter()] + [string]$PdbPath, + [Parameter(Mandatory=$true,Position=1)] + [string]$OutputPath + ) + + $version = '1.1.0-beta1-64128-01' + $baseDir = "$PSScriptRoot\..\obj\tools" + $pdb2pdbpath = "$baseDir\pdb2pdb.$version\tools\Pdb2Pdb.exe" + if (-not (Test-Path $pdb2pdbpath)) { + if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } + $baseDir = (Resolve-Path $baseDir).Path # Normalize it + & (& $PSScriptRoot\Get-NuGetTool.ps1) install pdb2pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://dotnet.myget.org/F/symreader-converter/api/v3/index.json | Out-Null + } + + $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' + if ($PdbPath) { + $args += '/pdb',$PdbPath + } + + Write-Verbose "$pdb2pdbpath $args" + & $pdb2pdbpath $args +#} diff --git a/azure-pipelines/Get-NuGetTool.ps1 b/azure-pipelines/Get-NuGetTool.ps1 new file mode 100644 index 000000000..59d6187a6 --- /dev/null +++ b/azure-pipelines/Get-NuGetTool.ps1 @@ -0,0 +1,21 @@ +<# +.SYNOPSIS + Downloads the NuGet.exe tool and returns the path to it. +.PARAMETER NuGetVersion + The version of the NuGet tool to acquire. +#> +Param( + [Parameter()] + [string]$NuGetVersion='5.0.2' +) + +$binaryToolsPath = "$PSScriptRoot\..\obj\tools\nuget.$NuGetVersion" +if (!(Test-Path $binaryToolsPath)) { $null = New-Item -Type Directory -Path $binaryToolsPath } +$nugetPath = "$binaryToolsPath\nuget.exe" + +if (!(Test-Path $nugetPath)) { + Write-Host "Downloading nuget.exe $NuGetVersion..." -ForegroundColor Yellow + Invoke-WebRequest -Uri "https://dist.nuget.org/win-x86-commandline/v$NuGetVersion/NuGet.exe" -OutFile $nugetPath | Out-Null +} + +Write-Output (Resolve-Path $nugetPath).Path diff --git a/azure-pipelines/artifacts/symbols.ps1 b/azure-pipelines/artifacts/symbols.ps1 new file mode 100644 index 000000000..504913689 --- /dev/null +++ b/azure-pipelines/artifacts/symbols.ps1 @@ -0,0 +1,64 @@ +Function Get-SymbolFiles { + [CmdletBinding()] + param ( + [parameter(Mandatory=$true)] + [string]$Path + ) + + $WindowsPdbSubDirName = "symstore" + + $ActivityName = "Collecting symbols from $Path" + Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" + $PDBs = Get-ChildItem -rec "$Path\*.pdb" |? { $_.FullName -notmatch "unittest|tests|\W$WindowsPdbSubDirName\W" } + Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" + $PDBsByHash = @{} + $i = 0 + $PDBs |% { + Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" -PercentComplete (100 * $i / $PDBs.Length) + $hash = Get-FileHash $_ + $i++ + Add-Member -InputObject $_ -MemberType NoteProperty -Name Hash -Value $hash.Hash + Write-Output $_ + } | Sort-Object CreationTime |% { + # De-dupe based on hash. Prefer the first match so we take the first built copy. + if (-not $PDBsByHash.ContainsKey($_.Hash)) { + $PDBsByHash.Add($_.Hash, $_.FullName) + Write-Output $_ + } + } |% { + # Collect the DLLs/EXEs as well. + $dllPath = "$($_.Directory)\$($_.BaseName).dll" + $exePath = "$($_.Directory)\$($_.BaseName).exe" + if (Test-Path $dllPath) { + $BinaryImagePath = $dllPath + } elseif (Test-Path $exePath) { + $BinaryImagePath = $exePath + } + + Write-Output $BinaryImagePath + + # Convert the PDB to legacy Windows PDBs + Write-Host "Converting PDB for $_" -ForegroundColor DarkGray + $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" + if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } + & "$PSScriptRoot\..\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath "$WindowsPdbDir\$($_.BaseName).pdb" + if ($LASTEXITCODE -ne 0) { + Write-Warning "PDB conversion of `"$_`" failed." + } + + Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" + } +} + +# This doesn't work off Windows, nor do we need to convert symbols on multiple OS agents +if ($IsMacOS -or $IsLinux) { + return; +} + +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") +if (!(Test-Path $BinPath)) { return } +$symbolfiles = Get-SymbolFiles -Path $BinPath | Get-Unique + +@{ + "$BinPath" = $SymbolFiles; +} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 1ca019a08..e14c1bbbf 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -50,6 +50,15 @@ steps: displayName: Publish artifacts condition: succeededOrFailed() +- task: PublishSymbols@2 + inputs: + SymbolsFolder: $(Build.ArtifactStagingDirectory)/symbols-Windows + SearchPattern: '**/*.pdb' + IndexSources: false + SymbolServerType: TeamServices + displayName: Publish symbols to symbol server + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'), eq(variables['Agent.OS'], 'Windows_NT')) + - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') From 46d8abc111c18c3ffba75a3ab8e4f379eda2cef2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 22:03:09 -0600 Subject: [PATCH 0026/1753] Don't fail build when codecov.io is down --- azure-pipelines/dotnet.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index e14c1bbbf..6641ebb9f 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -63,3 +63,4 @@ steps: displayName: Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') timeoutInMinutes: 3 + continueOnError: true From 1ae312b50b3247ef07ae48a9b98f0c897b40ef2b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 13 Jul 2019 01:25:59 -0600 Subject: [PATCH 0027/1753] Stop calling chmod on Windows Not all custom Windows agents have this available. --- tools/Install-DotNetSdk.ps1 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 9db8558f2..3061edf8c 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -56,7 +56,9 @@ if ($IsMacOS -or $IsLinux) { if (-not (Test-Path $DotNetInstallScriptPath)) { Invoke-WebRequest -Uri $DownloadUri -OutFile $DotNetInstallScriptPath - chmod +x $DotNetInstallScriptPath + if ($IsMacOS -or $IsLinux) { + chmod +x $DotNetInstallScriptPath + } } if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { From 8bd008e9cef9a7499a767bb30c9fd14f78f97f73 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 13 Jul 2019 01:42:22 -0600 Subject: [PATCH 0028/1753] Avoid ln on Windows Some custom Windows agents don't have this --- azure-pipelines/artifacts/_pipelines.ps1 | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 59dd2cf20..dce2d5a82 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -30,7 +30,11 @@ function Create-SymbolicLink { $LinkContainer = Split-Path $Link -Parent if (!(Test-Path $LinkContainer)) { mkdir $LinkContainer } Write-Verbose "Linking $Link to $Target" - ln $Target $Link + if ($IsMacOS -or $IsLinux) { + ln $Target $Link + } else { + cmd /c mklink $Link $Target + } } # Stage all artifacts From 354c7db5d602f3e7e6436b3b8cd28e00193e1685 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 13 Jul 2019 01:46:28 -0600 Subject: [PATCH 0029/1753] Install nbgv to Agent.TempDirectory Avoids errors when nbgv is already installed on a custom agent --- azure-pipelines/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 3ee5b0b9d..7e18277e8 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -8,8 +8,8 @@ jobs: - template: install-dependencies.yml - powershell: | - dotnet tool install --tool-path $(Agent.ToolsDirectory) nbgv --ignore-failed-sources - $(Agent.ToolsDirectory)/nbgv cloud + dotnet tool install --tool-path $(Agent.TempDirectory) nbgv --ignore-failed-sources + $(Agent.TempDirectory)/nbgv cloud displayName: Set build number - template: dotnet.yml From 2da189df18af52ab540789cd9f1a0430feb87d4a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 13 Jul 2019 01:49:37 -0600 Subject: [PATCH 0030/1753] Display dotnet --info after prereq installation --- azure-pipelines/install-dependencies.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 38fa5c08e..2e6a32346 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -5,5 +5,7 @@ steps: failOnStderr: true displayName: Set pipeline variables based on source -- powershell: .\init.ps1 +- powershell: | + .\init.ps1 + dotnet --info displayName: Install prerequisites From fd0a7b25ccf030bbd16880cca6efe009d5b1fffc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2019 22:29:54 -0600 Subject: [PATCH 0031/1753] Add MicroBuild specific files and traits --- Expand-Template.ps1 | 10 ++++----- azure-pipelines.yml | 3 +-- azure-pipelines/build.yml | 8 +++++++ azure-pipelines/clear-packagecaches.yml | 7 +++++++ azure-pipelines/microbuild.after.yml | 8 +++++++ azure-pipelines/microbuild.before.yml | 6 ++++++ azure-pipelines/microbuild.yml | 21 +++++++++++++++++++ azure-pipelines/publish-deployables.yml | 2 +- .../variables/InsertConfigValues.ps1 | 14 +++++++++++++ .../variables/InsertTargetBranch.ps1 | 2 ++ .../variables/InsertVersionsValues.ps1 | 9 ++++++++ azure-pipelines/variables/SignType.ps1 | 3 +++ azure-pipelines/variables/TeamName.ps1 | 1 + azure-pipelines/variables/ci_feed.ps1 | 5 +++++ src/Directory.Build.props | 5 +++-- 15 files changed, 94 insertions(+), 10 deletions(-) create mode 100644 azure-pipelines/clear-packagecaches.yml create mode 100644 azure-pipelines/microbuild.after.yml create mode 100644 azure-pipelines/microbuild.before.yml create mode 100644 azure-pipelines/microbuild.yml create mode 100644 azure-pipelines/variables/InsertConfigValues.ps1 create mode 100644 azure-pipelines/variables/InsertTargetBranch.ps1 create mode 100644 azure-pipelines/variables/InsertVersionsValues.ps1 create mode 100644 azure-pipelines/variables/SignType.ps1 create mode 100644 azure-pipelines/variables/TeamName.ps1 create mode 100644 azure-pipelines/variables/ci_feed.ps1 diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index c050aba3f..31597948c 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -139,13 +139,13 @@ try { } else { $YmlReplacements['(codecov_token: ).*(#.*)'] = "#`$1`$2" } - if ($CIFeed) { - $YmlReplacements['(ci_feed: ).*(#.*)'] = "`$1$CIFeed" - } else { - $YmlReplacements['(ci_feed: ).*(#.*)'] = "#`$1`$2" - } Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements + Replace-Placeholders -Path "azure-pipelines/variables/InsertVersionsValues.ps1" -Replacements @{ + 'LibraryName' = $LibraryName; + 'LibraryNoDots' = $LibraryName.Replace('.',''); + } + # Self destruct $Invocation = (Get-Variable MyInvocation -Scope 1).Value git rm Expand-Template.ps1 diff --git a/azure-pipelines.yml b/azure-pipelines.yml index f158ff523..39db18806 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -14,8 +14,7 @@ variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release BuildPlatform: Any CPU - codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed + # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ jobs: - template: azure-pipelines/build.yml diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 7e18277e8..a291a46ad 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -5,6 +5,7 @@ jobs: - job: Windows pool: ${{ parameters.windowsPool }} steps: + - template: clear-packagecaches.yml - template: install-dependencies.yml - powershell: | @@ -12,7 +13,14 @@ jobs: $(Agent.TempDirectory)/nbgv cloud displayName: Set build number + - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + - template: microbuild.before.yml + - template: dotnet.yml + + - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + - template: microbuild.after.yml + - template: expand-template.yml - job: Linux diff --git a/azure-pipelines/clear-packagecaches.yml b/azure-pipelines/clear-packagecaches.yml new file mode 100644 index 000000000..86c327ec0 --- /dev/null +++ b/azure-pipelines/clear-packagecaches.yml @@ -0,0 +1,7 @@ +steps: +- powershell: | + "$env:userprofile\.nuget\packages", "$env:LocalAppData\NuGet\Cache", "$env:AppData\tsd-cache" |% { + if (Test-Path $_) { Remove-Item $_ -Recurse -Force } + } + displayName: Purge package caches + condition: eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml new file mode 100644 index 000000000..8601dfaa0 --- /dev/null +++ b/azure-pipelines/microbuild.after.yml @@ -0,0 +1,8 @@ +steps: +- task: MicroBuildCleanup@1 + condition: succeededOrFailed() + displayName: MicroBuild Cleanup + +- task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0 + displayName: Component Detection + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml new file mode 100644 index 000000000..310b559eb --- /dev/null +++ b/azure-pipelines/microbuild.before.yml @@ -0,0 +1,6 @@ +steps: +- task: MicroBuildSigningPlugin@1 + inputs: + signType: $(SignType) + zipSources: false + displayName: Install MicroBuild Signing Plugin diff --git a/azure-pipelines/microbuild.yml b/azure-pipelines/microbuild.yml new file mode 100644 index 000000000..6e259858e --- /dev/null +++ b/azure-pipelines/microbuild.yml @@ -0,0 +1,21 @@ +trigger: + branches: + include: + - master + - validate/* + paths: + exclude: + - doc/ + - '*.md' + - .vscode/ + +variables: + TreatWarningsAsErrors: true + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BuildConfiguration: Release + BuildPlatform: Any CPU + +jobs: +- template: build.yml + parameters: + windowsPool: VSEng-MicroBuildVS2019 diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index cdd852920..facc50af9 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -9,7 +9,7 @@ steps: displayName: Push packages to CI feed inputs: command: push - packagesToPush: $(System.DefaultWorkingDirectory)/bin/deployables-Windows/*.nupkg + packagesToPush: $(System.DefaultWorkingDirectory)/bin/deployables-Windows/NuGet/*.nupkg nuGetFeedType: internal publishVstsFeed: $(ci_feed) allowPackageConflicts: true diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 new file mode 100644 index 000000000..bd53ae8d3 --- /dev/null +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -0,0 +1,14 @@ +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BuildConfiguration") + +$icv=@() +if (Test-Path "$BinPath") { + Get-ChildItem -Path "$BinPath\*.nupkg" -rec |% { + if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + $id = $Matches[1] + $version = $Matches[2] + $icv += "$id=$version" + } + } +} + +Write-Output ([string]::join(',',$icv)) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 new file mode 100644 index 000000000..67462ece9 --- /dev/null +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -0,0 +1,2 @@ +# This is the default branch of the VS repo that we will use to insert into VS. +'master' diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 new file mode 100644 index 000000000..73e54f26d --- /dev/null +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -0,0 +1,9 @@ +# When you need binding redirects in the VS repo updated to match +# assemblies that you build here, remove the "return" statement +# and update the hashtable below with the T4 macro you'll use for +# your libraries as defined in the src\ProductData\AssemblyVersions.tt file. +return + +[string]::join(',',(@{ + ('LibraryNoDotsVersion') = & { (nbgv get-version --project "$PSScriptRoot\..\..\src\LibraryName" --format json | ConvertFrom-Json).AssemblyVersion }; +}.GetEnumerator() |% { "$($_.key)=$($_.value)" })) diff --git a/azure-pipelines/variables/SignType.ps1 b/azure-pipelines/variables/SignType.ps1 new file mode 100644 index 000000000..7d3a4729a --- /dev/null +++ b/azure-pipelines/variables/SignType.ps1 @@ -0,0 +1,3 @@ +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9') { + 'test' +} diff --git a/azure-pipelines/variables/TeamName.ps1 b/azure-pipelines/variables/TeamName.ps1 new file mode 100644 index 000000000..871749a58 --- /dev/null +++ b/azure-pipelines/variables/TeamName.ps1 @@ -0,0 +1 @@ +'VS IDE' diff --git a/azure-pipelines/variables/ci_feed.ps1 b/azure-pipelines/variables/ci_feed.ps1 new file mode 100644 index 000000000..2d6ef8e6c --- /dev/null +++ b/azure-pipelines/variables/ci_feed.ps1 @@ -0,0 +1,5 @@ +if ($env:SignType -eq 'Real') { + '09d8d03c-1ac8-456e-9274-4d2364527d99' # VSIDE-RealSigned-Release +} else { + 'da484c78-f942-44ef-b197-99e2a1bef53c' # VSIDE-TestSigned-Release +} diff --git a/src/Directory.Build.props b/src/Directory.Build.props index f4ef32972..77f290291 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -5,7 +5,7 @@ $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)..\')) $(RepoRootPath)obj\$(MSBuildProjectName)\ $(RepoRootPath)bin\$(MSBuildProjectName)\ - $(RepoRootPath)bin\Packages\$(Configuration)\ + $(RepoRootPath)bin\Packages\$(Configuration)\NuGet\ 7.3 true @@ -25,7 +25,8 @@ - + + From 00bcb28bfc4095207bab694ca2ae8a71810733be Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jul 2019 10:35:04 -0600 Subject: [PATCH 0032/1753] Add init.cmd, nbgv tool improvements, etc. --- azure-pipelines/Get-nbgv.ps1 | 29 +++++++++++++++++++++++ azure-pipelines/artifacts/_pipelines.ps1 | 1 - azure-pipelines/build.yml | 10 +++++--- azure-pipelines/install-dependencies.yml | 11 +++++---- azure-pipelines/nbgv.nuget.config | 7 ++++++ azure-pipelines/variables/_all.ps1 | 1 + init.cmd | 3 +++ tools/Install-DotNetSdk.ps1 | 30 +++++++++++++++++------- 8 files changed, 74 insertions(+), 18 deletions(-) create mode 100644 azure-pipelines/Get-nbgv.ps1 create mode 100644 azure-pipelines/nbgv.nuget.config create mode 100644 init.cmd diff --git a/azure-pipelines/Get-nbgv.ps1 b/azure-pipelines/Get-nbgv.ps1 new file mode 100644 index 000000000..bc9c11c88 --- /dev/null +++ b/azure-pipelines/Get-nbgv.ps1 @@ -0,0 +1,29 @@ +<# +.SYNOPSIS + Gets the path to the nbgv CLI tool, installing it if necessary. +#> +Param( +) + +$existingTool = Get-Command "nbgv" -ErrorAction SilentlyContinue +if ($existingTool) { + return $existingTool.Path +} + +if ($env:AGENT_TEMPDIRECTORY) { + $toolInstallDir = "$env:AGENT_TEMPDIRECTORY/$env:BUILD_BUILDID" +} else { + $toolInstallDir = "$PSScriptRoot/obj/tools" +} + +$toolPath = "$toolInstallDir/nbgv" +if (!(Test-Path $toolPath)) { New-Item -Path $toolPath -ItemType Directory | Out-Null } +$toolPath = (Resolve-Path $toolPath).Path + +if (!(Get-Command $toolPath -ErrorAction SilentlyContinue)) { + Write-Host "Installing nbgv to $toolInstallDir" + dotnet tool install --tool-path "$toolInstallDir" nbgv --configfile "$PSScriptRoot\nbgv.nuget.config" | Out-Null +} + +# Normalize the path on the way out. +return (Get-Command $toolPath).Path diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index dce2d5a82..270a96043 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -6,7 +6,6 @@ param ( ) $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") -if (!$env:BUILDCONFIGURATION) { throw "BUILDCONFIGURATION environment variable must be set." } if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY } else { diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 7e18277e8..6eeca905f 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -5,11 +5,11 @@ jobs: - job: Windows pool: ${{ parameters.windowsPool }} steps: + - checkout: self + clean: true # "all" doesn't work, but "true" does, despite YAML docs - template: install-dependencies.yml - - powershell: | - dotnet tool install --tool-path $(Agent.TempDirectory) nbgv --ignore-failed-sources - $(Agent.TempDirectory)/nbgv cloud + - powershell: '& (azure-pipelines\Get-nbgv.ps1) cloud' displayName: Set build number - template: dotnet.yml @@ -19,6 +19,8 @@ jobs: pool: vmImage: Ubuntu 16.04 steps: + - checkout: self + clean: true # "all" doesn't work, but "true" does, despite YAML docs - template: install-dependencies.yml - template: dotnet.yml - template: expand-template.yml @@ -40,6 +42,8 @@ jobs: vmImage: Ubuntu 16.04 condition: succeededOrFailed() steps: + - checkout: self + clean: true # "all" doesn't work, but "true" does, despite YAML docs - template: install-dependencies.yml - template: publish-codecoverage.yml - template: publish-deployables.yml diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 2e6a32346..beacc44d9 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -1,11 +1,12 @@ steps: -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true - displayName: Set pipeline variables based on source - powershell: | .\init.ps1 dotnet --info displayName: Install prerequisites + +- task: PowerShell@2 + inputs: + filePath: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true + displayName: Set pipeline variables based on source diff --git a/azure-pipelines/nbgv.nuget.config b/azure-pipelines/nbgv.nuget.config new file mode 100644 index 000000000..765346e53 --- /dev/null +++ b/azure-pipelines/nbgv.nuget.config @@ -0,0 +1,7 @@ + + + + + + + diff --git a/azure-pipelines/variables/_all.ps1 b/azure-pipelines/variables/_all.ps1 index 680a3398e..ed0997922 100644 --- a/azure-pipelines/variables/_all.ps1 +++ b/azure-pipelines/variables/_all.ps1 @@ -4,6 +4,7 @@ $vars = @{} Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" |% { + Write-Host "Computing $($_.BaseName) variable" $vars[$_.BaseName] = & $_ } diff --git a/init.cmd b/init.cmd new file mode 100644 index 000000000..5bef08da3 --- /dev/null +++ b/init.cmd @@ -0,0 +1,3 @@ +@set PS1UnderCmd=1 +powershell.exe -ExecutionPolicy bypass -Command "& '%~dpn0.ps1'" %* +@set PS1UnderCmd= diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 3061edf8c..2eccce41f 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -93,14 +93,17 @@ $runtimeVersions | Get-Unique |% { } } -Write-Host "Environment variables to be set:" -ForegroundColor Blue -$envVars - if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these installed runtimes?")) { if ($env:TF_BUILD) { Write-Host "Azure Pipelines detected. Logging commands will be used to propagate environment variables and prepend path." } + if ($IsMacOS -or $IsLinux) { + $envVars['PATH'] = "${DotNetInstallDir}:$env:PATH" + } else { + $envVars['PATH'] = "$DotNetInstallDir;$env:PATH" + } + $envVars.GetEnumerator() |% { Set-Item -Path env:$($_.Key) -Value $_.Value @@ -110,13 +113,22 @@ if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these } } - if ($IsMacOS -or $IsLinux) { - $env:PATH = "${DotNetInstallDir}:$env:PATH" - } else { - $env:PATH = "$DotNetInstallDir;$env:PATH" - } - if ($env:TF_BUILD) { Write-Host "##vso[task.prependpath]$DotNetInstallDir" } } + +if ($env:PS1UnderCmd -eq '1') { + Write-Warning "Environment variable changes will be lost because you're running under cmd.exe. Run these commands manually:" + $envVars.GetEnumerator() |% { + if ($_.Key -eq 'PATH') { + # Special case this one for readability + Write-Host "SET PATH=$DotNetInstallDir;%PATH%" + } else { + Write-Host "SET $($_.Key)=$($_.Value)" + } + } +} else { + Write-Host "Environment variables set:" -ForegroundColor Blue + $envVars +} From 186195f0397bbcf9d93584dd70689b5c88d76946 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jul 2019 10:35:14 -0600 Subject: [PATCH 0033/1753] Get nbgv from install location --- azure-pipelines/variables/InsertVersionsValues.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index 73e54f26d..515e05716 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -4,6 +4,7 @@ # your libraries as defined in the src\ProductData\AssemblyVersions.tt file. return +$nbgv = & "$PSScriptRoot\..\Get-nbgv.ps1" [string]::join(',',(@{ - ('LibraryNoDotsVersion') = & { (nbgv get-version --project "$PSScriptRoot\..\..\src\LibraryName" --format json | ConvertFrom-Json).AssemblyVersion }; + ('LibraryNoDotsVersion') = & { (& $nbgv get-version --project "$PSScriptRoot\..\..\src\LibraryName" --format json | ConvertFrom-Json).AssemblyVersion }; }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) From 1d1e056056c52e52b219643b7051463190c7d752 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jul 2019 10:59:01 -0600 Subject: [PATCH 0034/1753] Avoid double push of package to CI When both microbuild.yml and azure-pipelines.yml are building, we don't want to push packages from both to the CI package feed. --- azure-pipelines/microbuild.yml | 1 + azure-pipelines/publish-deployables.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.yml b/azure-pipelines/microbuild.yml index 6e259858e..0254a9e25 100644 --- a/azure-pipelines/microbuild.yml +++ b/azure-pipelines/microbuild.yml @@ -14,6 +14,7 @@ variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release BuildPlatform: Any CPU + push_to_ci: true jobs: - template: build.yml diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index facc50af9..fee648e1a 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -13,4 +13,4 @@ steps: nuGetFeedType: internal publishVstsFeed: $(ci_feed) allowPackageConflicts: true - condition: and(succeeded(), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) + condition: and(succeeded(), eq(variables['push_to_ci'], 'true'), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) From 0691c8d0a1fda51e45e6d21bb9e73eefe74b3e0c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 16 Jul 2019 12:32:54 -0600 Subject: [PATCH 0035/1753] Avoid error when exactly one coverage.cobertura.xml file is found --- azure-pipelines/artifacts/coverageResults.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index 619ac0f3a..7d1e9a35f 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -16,7 +16,7 @@ if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } @{ $RepoRoot = ( - (Get-ChildItem "$RepoRoot\bin\coverage.cobertura.xml" -Recurse) + + @(Get-ChildItem "$RepoRoot\bin\coverage.cobertura.xml" -Recurse) + (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse) ); } From 5e96a0b15c66226b05727ae79b1595936ff30f04 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 16 Jul 2019 14:51:24 -0600 Subject: [PATCH 0036/1753] Fix feed auth failure when merging reports It's important to always explicitly specify a nuget.config file when using dotnet tool install so that if a nuget.config file is present with feeds that require authentication, they are not tried. --- azure-pipelines/Get-nbgv.ps1 | 2 +- .../{nbgv.nuget.config => justnugetorg.nuget.config} | 0 azure-pipelines/publish-codecoverage.yml | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename azure-pipelines/{nbgv.nuget.config => justnugetorg.nuget.config} (100%) diff --git a/azure-pipelines/Get-nbgv.ps1 b/azure-pipelines/Get-nbgv.ps1 index bc9c11c88..8459995f5 100644 --- a/azure-pipelines/Get-nbgv.ps1 +++ b/azure-pipelines/Get-nbgv.ps1 @@ -22,7 +22,7 @@ $toolPath = (Resolve-Path $toolPath).Path if (!(Get-Command $toolPath -ErrorAction SilentlyContinue)) { Write-Host "Installing nbgv to $toolInstallDir" - dotnet tool install --tool-path "$toolInstallDir" nbgv --configfile "$PSScriptRoot\nbgv.nuget.config" | Out-Null + dotnet tool install --tool-path "$toolInstallDir" nbgv --configfile "$PSScriptRoot\justnugetorg.nuget.config" | Out-Null } # Normalize the path on the way out. diff --git a/azure-pipelines/nbgv.nuget.config b/azure-pipelines/justnugetorg.nuget.config similarity index 100% rename from azure-pipelines/nbgv.nuget.config rename to azure-pipelines/justnugetorg.nuget.config diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index b9b7b72af..5d987c83e 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -18,7 +18,7 @@ steps: downloadPath: $(System.DefaultWorkingDirectory)/bin continueOnError: true - powershell: | - dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 + dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(System.DefaultWorkingDirectory)/bin/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" $reports = Get-ChildItem -Recurse "$(System.DefaultWorkingDirectory)/bin/coverage.cobertura.xml" From 14f9967ebff169310e80eefcc3d96d809807b217 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jul 2019 09:22:25 -0600 Subject: [PATCH 0037/1753] Stop generating a proprietary strong name key --- Expand-Template.ps1 | 4 ---- src/Directory.Build.props | 1 - src/strongname.snk | Bin 596 -> 0 bytes 3 files changed, 5 deletions(-) delete mode 100644 src/strongname.snk diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 31597948c..b32c35037 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -98,10 +98,6 @@ try { dotnet remove "$LibraryName.Tests" reference Library/Library.csproj git add "$LibraryName.Tests/$LibraryName.Tests.csproj" - # Establish a new strong-name key - & $sn.Path -k 2048 strongname.snk - git add strongname.snk - Set-Location .. # Replace placeholders in source files diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 77f290291..ca8edba3a 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -10,7 +10,6 @@ true true - $(MSBuildThisFileDirectory)\strongname.snk COMPANY-PLACEHOLDER COMPANY-PLACEHOLDER diff --git a/src/strongname.snk b/src/strongname.snk deleted file mode 100644 index a4d0a2ce39df5f7c284340b4a2c4690385c44208..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 596 zcmV-a0;~N80ssI2Bme+XQ$aES1ONa50097Td7B6KsP|cl#<{bONo_!&t)QUG9wW^j zM1zvNAOI=XF}potSO>54lS%MGl8tv)xYTSw?~K<1McvNlJ;DITeY__C?><|;F`bgX zj;&2ME}KBWPb0zVSK+iW?{2`tzZR-#x0K_|t&0FhD+3urA!lNmCH;&b|?g|_AC39ox-0 zcV%KJis3}%`RVWSXN58fc}#LF$A#kcB2VWh=MH0zs+k7{ zQT<5V>NGhWzC7Jnt4A?n%Kk`fPt&FR4k~q{TSW%@D{plIpotzop}i+x`~C))*Vr-i zrW2)aE17f*=wCRa_#bHkYlQko_Jh)wN@;?yML9mYk)XZ`l6IQ*D7xZmmL=m(T|zMG i={(T>StYQl!YSPV From 5ee62bfe3556f392e9e1bfddcf2b25fd640e2b9e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jul 2019 09:48:42 -0600 Subject: [PATCH 0038/1753] Add support for Azure Artifact authenticated feeds --- CONTRIBUTING.md | 6 +++ azure-pipelines/Get-NuGetTool.ps1 | 9 ++-- azure-pipelines/Get-TempToolsPath.ps1 | 13 +++++ azure-pipelines/Set-EnvVars.ps1 | 39 +++++++++++++++ azure-pipelines/build.yml | 2 + azure-pipelines/dotnet.yml | 3 -- azure-pipelines/install-dependencies.yml | 5 +- init.ps1 | 39 ++++++++++++++- nuget.config | 2 +- tools/Install-NuGetCredProvider.ps1 | 62 ++++++++++++++++++++++++ 10 files changed, 169 insertions(+), 11 deletions(-) create mode 100644 azure-pipelines/Get-TempToolsPath.ps1 create mode 100644 azure-pipelines/Set-EnvVars.ps1 create mode 100644 tools/Install-NuGetCredProvider.ps1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f2f4a8ca5..0893b308e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,12 @@ using Windows PowerShell or [PowerShell Core][pwsh] (on any OS). This repository can be built on Windows, Linux, and OSX. +## Package restore + +The easiest way to restore packages may be to run `init.ps1` which automatically authenticates +to the feeds that packages for this repo come from, if any. +`dotnet restore` or `nuget restore` also work but may require extra steps to authenticate to any applicable feeds. + ## Building Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). diff --git a/azure-pipelines/Get-NuGetTool.ps1 b/azure-pipelines/Get-NuGetTool.ps1 index 59d6187a6..fdf3ed55e 100644 --- a/azure-pipelines/Get-NuGetTool.ps1 +++ b/azure-pipelines/Get-NuGetTool.ps1 @@ -9,13 +9,14 @@ Param( [string]$NuGetVersion='5.0.2' ) -$binaryToolsPath = "$PSScriptRoot\..\obj\tools\nuget.$NuGetVersion" -if (!(Test-Path $binaryToolsPath)) { $null = New-Item -Type Directory -Path $binaryToolsPath } -$nugetPath = "$binaryToolsPath\nuget.exe" +$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" +$binaryToolsPath = Join-Path $toolsPath $NuGetVersion +if (!(Test-Path $binaryToolsPath)) { $null = mkdir $binaryToolsPath } +$nugetPath = Join-Path $binaryToolsPath nuget.exe if (!(Test-Path $nugetPath)) { Write-Host "Downloading nuget.exe $NuGetVersion..." -ForegroundColor Yellow Invoke-WebRequest -Uri "https://dist.nuget.org/win-x86-commandline/v$NuGetVersion/NuGet.exe" -OutFile $nugetPath | Out-Null } -Write-Output (Resolve-Path $nugetPath).Path +return (Resolve-Path $nugetPath).Path diff --git a/azure-pipelines/Get-TempToolsPath.ps1 b/azure-pipelines/Get-TempToolsPath.ps1 new file mode 100644 index 000000000..97c552c06 --- /dev/null +++ b/azure-pipelines/Get-TempToolsPath.ps1 @@ -0,0 +1,13 @@ +if ($env:AGENT_TOOLSDIRECTORY) { + $path = "$env:AGENT_TOOLSDIRECTORY\vs-platform\tools" +} elseif ($env:localappdata) { + $path = "$env:localappdata\vs-platform\tools" +} else { + $path = "$PSScriptRoot\..\obj\tools" +} + +if (!(Test-Path $path)) { + New-Item -ItemType Directory -Path $Path | Out-Null +} + +(Resolve-Path $path).Path diff --git a/azure-pipelines/Set-EnvVars.ps1 b/azure-pipelines/Set-EnvVars.ps1 new file mode 100644 index 000000000..313cecff1 --- /dev/null +++ b/azure-pipelines/Set-EnvVars.ps1 @@ -0,0 +1,39 @@ +<# +.SYNOPSIS + Set environment variables in the environment. + Azure Pipeline and CMD environments are considered. +.PARAMETER Variables + A hashtable of variables to be set. +.OUTPUTS + A boolean indicating whether the environment variables can be expected to propagate to the caller's environment. +#> +[CmdletBinding(SupportsShouldProcess=$true)] +Param( + [Parameter(Mandatory=$true, Position=1)] + $Variables +) + +if ($Variables.Count -eq 0) { + return $true +} + +$cmdInstructions = !$env:TF_BUILD -and $env:PS1UnderCmd -eq '1' +if ($cmdInstructions) { + Write-Warning "Environment variables have been set that will be lost because you're running under cmd.exe" + Write-Host "Environment variables that must be set manually:" -ForegroundColor Blue +} + +$Variables.GetEnumerator() |% { + Set-Item -Path env:$($_.Key) -Value $_.Value + + # If we're running in Azure Pipelines, set these environment variables + if ($env:TF_BUILD) { + Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" + } + + if ($cmdInstructions) { + Write-Host "SET $($_.Key)=$($_.Value)" + } +} + +return !$cmdInstructions diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 6eeca905f..f81d7f14d 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -45,5 +45,7 @@ jobs: - checkout: self clean: true # "all" doesn't work, but "true" does, despite YAML docs - template: install-dependencies.yml + parameters: + initArgs: -NoRestore - template: publish-codecoverage.yml - template: publish-deployables.yml diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 6641ebb9f..96569224a 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,7 +1,4 @@ steps: -- script: dotnet restore /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/restore.binlog" - displayName: dotnet restore - workingDirectory: src - script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index beacc44d9..8da07957b 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -1,7 +1,10 @@ +parameters: + initArgs: + steps: - powershell: | - .\init.ps1 + .\init.ps1 -AccessToken '$(System.AccessToken)' ${{ parameters['initArgs'] }} dotnet --info displayName: Install prerequisites diff --git a/init.ps1 b/init.ps1 index 41e5556bc..17389cbc6 100644 --- a/init.ps1 +++ b/init.ps1 @@ -9,11 +9,46 @@ Per-user allows sharing the installed dependencies across repositories and allow Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. +.PARAMETER NoPrerequisites +Skips the installation of prerequisite software (e.g. SDKs, tools). +.PARAMETER NoRestore +Skips the package restore step. +.PARAMETER AccessToken +An optional access token for authenticating to Azure Artifacts authenticated feeds. #> [CmdletBinding(SupportsShouldProcess=$true)] Param ( [ValidateSet('repo','user')] - [string]$InstallLocality='user' + [string]$InstallLocality='user', + [Parameter()] + [switch]$NoPrerequisites, + [Parameter()] + [switch]$NoRestore, + [Parameter()] + [string]$AccessToken ) -& "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality +if (!$NoPrerequisites) { + & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken + & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality +} + +Push-Location $PSScriptRoot +try { + $HeaderColor = 'Green' + + if (!$NoRestore) { + Write-Host "Restoring NuGet packages" -ForegroundColor $HeaderColor + dotnet restore src + if ($lastexitcode -ne 0) { + throw "Failure while restoring packages." + } + } +} +catch { + Write-Error $error[0] + exit $lastexitcode +} +finally { + Pop-Location +} diff --git a/nuget.config b/nuget.config index 4941d22b8..d068efcf6 100644 --- a/nuget.config +++ b/nuget.config @@ -3,6 +3,6 @@ - + diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 new file mode 100644 index 000000000..df450dc79 --- /dev/null +++ b/tools/Install-NuGetCredProvider.ps1 @@ -0,0 +1,62 @@ +<# +.SYNOPSIS + Downloads and installs the Microsoft Artifacts Credential Provider + from https://github.com/microsoft/artifacts-credprovider + to assist in authenticating to Azure Artifact feeds in interactive development + or unattended build agents. +.PARAMETER AccessToken + An optional access token for authenticating to Azure Artifacts authenticated feeds. +#> +[CmdletBinding()] +Param ( + [Parameter()] + [string]$AccessToken +) + +$toolsPath = & "$PSScriptRoot\..\azure-pipelines\Get-TempToolsPath.ps1" + +if ($IsMacOS -or $IsLinux) { + $installerScript = "installcredprovider.sh" + $sourceUrl = "https://raw.githubusercontent.com/microsoft/artifacts-credprovider/master/helpers/installcredprovider.sh" +} else { + $installerScript = "installcredprovider.ps1" + $sourceUrl = "https://raw.githubusercontent.com/microsoft/artifacts-credprovider/master/helpers/installcredprovider.ps1" +} + +$installerScript = Join-Path $toolsPath $installerScript + +if (!(Test-Path $installerScript)) { + Invoke-WebRequest $sourceUrl -OutFile $installerScript +} + +$installerScript = (Resolve-Path $installerScript).Path + +if ($IsMacOS -or $IsLinux) { + chmod u+x $installerScript +} + +& $installerScript + +if ($AccessToken) { + $endpoints = @() + + $nugetConfig = [xml](Get-Content -Path "$PSScriptRoot\..\nuget.config") + + $nugetConfig.configuration.packageSources.add |? { $_.value -match '^https://pkgs\.dev\.azure\.com/' } |% { + $endpoint = New-Object -TypeName PSObject + Add-Member -InputObject $endpoint -MemberType NoteProperty -Name endpoint -Value $_.value + Add-Member -InputObject $endpoint -MemberType NoteProperty -Name username -Value ado + Add-Member -InputObject $endpoint -MemberType NoteProperty -Name password -Value $AccessToken + $endpoints += $endpoint + } + + $auth = New-Object -TypeName PSObject + Add-Member -InputObject $auth -MemberType NoteProperty -Name endpointCredentials -Value $endpoints + + $authJson = ConvertTo-Json -InputObject $auth + $envVars = @{ + 'VSS_NUGET_EXTERNAL_FEED_ENDPOINTS'=$authJson; + } + + & "$PSScriptRoot\..\azure-pipelines\Set-EnvVars.ps1" -Variables $envVars | Out-Null +} From 4ec792f492d29bcf0bb76021178028e140fc6ed5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jul 2019 09:49:54 -0600 Subject: [PATCH 0039/1753] Add MicroBuild packages to enable signing and more --- README.md | 2 + azure-pipelines/Install-NuGetPackage.ps1 | 50 +++++++++++++++++++++ azure-pipelines/dotnet.yml | 10 +++++ azure-pipelines/expand-template.yml | 15 ++++++- init.ps1 | 56 ++++++++++++++++++++++++ nuget.config | 5 +++ src/Directory.Build.props | 1 + src/Library.Tests/Library.Tests.csproj | 1 + 8 files changed, 139 insertions(+), 1 deletion(-) create mode 100644 azure-pipelines/Install-NuGetPackage.ps1 diff --git a/README.md b/README.md index d05ac0d72..92cd829b8 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ ## Features * Follow the best and simplest patterns of build, pack and test with dotnet CLI. +* MicroBuild signing built-in, with several more MicroBuild plugins' use streamlined for local installation. +* Insertions to VS streamlined and automated with all inputs computed during the build and saved for the release pipeline. * Static analyzers: [FxCop](https://docs.microsoft.com/en-us/visualstudio/code-quality/fxcop-analyzers?view=vs-2019) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) * Read-only source tree (builds to top-level bin/obj folders) * Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/aarnott/nerdbank.gitversioning)) diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/azure-pipelines/Install-NuGetPackage.ps1 new file mode 100644 index 000000000..0bf057104 --- /dev/null +++ b/azure-pipelines/Install-NuGetPackage.ps1 @@ -0,0 +1,50 @@ +<# +.SYNOPSIS + Installs a NuGet package. +.PARAMETER PackageID + The Package ID to install. +.PARAMETER Version + The version of the package to install. If unspecified, the latest stable release is installed. +.PARAMETER Source + The package source feed to find the package to install from. +.PARAMETER PackagesDir + The directory to install the package to. By default, it uses the Packages folder at the root of the repo. +.PARAMETER ConfigFile + The nuget.config file to use. By default, it uses :/nuget.config. +#> +[CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Low')] +Param( + [Parameter(Position=1,Mandatory=$true)] + [string]$PackageId, + [Parameter()] + [string]$Version, + [Parameter()] + [string]$Source, + [Parameter()] + [switch]$Prerelease, + [Parameter()] + [string]$PackagesDir="$PSScriptRoot\..\packages", + [Parameter()] + [string]$ConfigFile="$PSScriptRoot\..\nuget.config", + [Parameter()] + [ValidateSet('Quiet','Normal','Detailed')] + [string]$Verbosity='normal' +) + +$nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" + +try { + Write-Verbose "Installing $PackageId..." + $nugetArgs = "Install",$PackageId,"-OutputDirectory",$PackagesDir,'-ConfigFile',$ConfigFile + if ($Version) { $nugetArgs += "-Version",$Version } + if ($Source) { $nugetArgs += "-FallbackSource",$Source } + if ($Prerelease) { $nugetArgs += "-Prerelease" } + $nugetArgs += '-Verbosity',$Verbosity + + if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { + $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru + if ($p.ExitCode -ne 0) { throw } + } +} finally { + Pop-Location +} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 96569224a..c2c16db2f 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,12 +1,22 @@ steps: +# We use VSBuild instead of "dotnet build" on Windows where MicroBuild tasks have to run (since they don't support MSBuild Core yet). +- task: VSBuild@1 + displayName: Build Visual Studio solution + inputs: + msbuildArgs: /t:build,pack /m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog" + platform: Any CPU + configuration: $(BuildConfiguration) + condition: eq(variables['Agent.OS'], 'Windows_NT') - script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build workingDirectory: src + condition: ne(variables['Agent.OS'], 'Windows_NT') - script: dotnet pack --no-build -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/pack.binlog" displayName: dotnet pack workingDirectory: src + condition: ne(variables['Agent.OS'], 'Windows_NT') - task: DotNetCoreCLI@2 displayName: dotnet test -f net472 diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index 2d9ea7b30..a8591c649 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -10,6 +10,19 @@ steps: displayName: Expanding template failOnStderr: true # TODO: Verify that all changes are staged to the git index + +- powershell: .\init.ps1 + displayName: Install prereqs and restore packages + +- task: VSBuild@1 + displayName: Build Visual Studio solution (expanded template) + inputs: + msbuildArgs: /t:build,pack /m + platform: Any CPU + configuration: $(BuildConfiguration) + condition: eq(variables['Agent.OS'], 'Windows_NT') + - script: dotnet build - workingDirectory: src displayName: dotnet build (expanded template) + workingDirectory: src + condition: ne(variables['Agent.OS'], 'Windows_NT') diff --git a/init.ps1 b/init.ps1 index 17389cbc6..a92799385 100644 --- a/init.ps1 +++ b/init.ps1 @@ -13,6 +13,17 @@ Per-repo can lead to file locking issues when dotnet.exe is left running as a bu Skips the installation of prerequisite software (e.g. SDKs, tools). .PARAMETER NoRestore Skips the package restore step. +.PARAMETER Signing +Install the MicroBuild signing plugin for building test-signed builds on desktop machines. +.PARAMETER Localization +Install the MicroBuild localization plugin for building loc builds on desktop machines. +The environment is configured to build pseudo-loc for JPN only, but may be used to build +all languages with shipping-style loc by using the `/p:loctype=full,loclanguages=vs` +when building. +.PARAMETER Setup +Install the MicroBuild setup plugin for building VSIXv3 packages. +.PARAMETER OptProf +Install the MicroBuild OptProf plugin for building optimized assemblies on desktop machines. .PARAMETER AccessToken An optional access token for authenticating to Azure Artifacts authenticated feeds. #> @@ -25,6 +36,14 @@ Param ( [Parameter()] [switch]$NoRestore, [Parameter()] + [switch]$Signing, + [Parameter()] + [switch]$Localization, + [Parameter()] + [switch]$Setup, + [Parameter()] + [switch]$OptProf, + [Parameter()] [string]$AccessToken ) @@ -44,6 +63,43 @@ try { throw "Failure while restoring packages." } } + + $EnvVars = @{} + $InstallNuGetPkgScriptPath = ".\azure-pipelines\Install-NuGetPackage.ps1" + $nugetVerbosity = 'quiet' + if ($Verbose) { $nugetVerbosity = 'normal' } + $MicroBuildPackageSource = 'https://devdiv.pkgs.visualstudio.com/DefaultCollection/_packaging/MicroBuildToolset/nuget/v3/index.json' + if ($Signing) { + Write-Host "Installing MicroBuild signing plugin" -ForegroundColor $HeaderColor + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Signing -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $EnvVars['SignType'] = "Test" + } + + if ($Setup) { + Write-Host "Installing MicroBuild SwixBuild plugin..." -ForegroundColor $HeaderColor + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.SwixBuild -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + } + + if ($OptProf) { + Write-Host "Installing MicroBuild OptProf plugin" -ForegroundColor $HeaderColor + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.OptProf -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $EnvVars['OptProfEnabled'] = '1' + } + + if ($Localization) { + Write-Host "Installing MicroBuild localization plugin" -ForegroundColor $HeaderColor + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Localization -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $EnvVars['LocType'] = "Pseudo" + $EnvVars['LocLanguages'] = "JPN" + } + + if ($FxCop) { + Write-Host "Installing MicroBuild FxCop plugin" -ForegroundColor $HeaderColor + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.FxCop -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $EnvVars['MicroBuild_FXCop'] = "true" + } + + & ".\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars } catch { Write-Error $error[0] diff --git a/nuget.config b/nuget.config index d068efcf6..4ab034afe 100644 --- a/nuget.config +++ b/nuget.config @@ -4,5 +4,10 @@ + + + + + diff --git a/src/Directory.Build.props b/src/Directory.Build.props index ca8edba3a..2d75e3def 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -22,6 +22,7 @@ + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index 7323c8d96..1f6a764c7 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -14,6 +14,7 @@ + From 6e8af3aeaf5e31a0288dd08edc7b8cbc8e406e9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jul 2019 10:57:28 -0600 Subject: [PATCH 0040/1753] Build microbuild branch in CI --- Expand-Template.ps1 | 5 ++++- azure-pipelines.yml | 1 + azure-pipelines/microbuild.yml | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index b32c35037..f325d898e 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -129,7 +129,10 @@ try { "(?m).*expand-template\.yml(?:\r)?\n" = "" } - $YmlReplacements = @{} + $YmlReplacements = @{ + "(?m)^\s+- microbuild`r?`n"="" + } + Replace-Placeholders -Path "azure-pipelines\microbuild.yml" -Replacements $YmlReplacements if ($CodeCovToken) { $YmlReplacements['(codecov_token: ).*(#.*)'] = "`$1$CodeCovToken" } else { diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 39db18806..ab38b43b9 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -2,6 +2,7 @@ trigger: branches: include: - master + - microbuild - validate/* paths: exclude: diff --git a/azure-pipelines/microbuild.yml b/azure-pipelines/microbuild.yml index 0254a9e25..28240eed5 100644 --- a/azure-pipelines/microbuild.yml +++ b/azure-pipelines/microbuild.yml @@ -2,6 +2,7 @@ trigger: branches: include: - master + - microbuild - validate/* paths: exclude: From a92a9fe10107c5a8b8c8e81551a723613f47ba85 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jul 2019 11:10:42 -0600 Subject: [PATCH 0041/1753] Fix SourceLink pkg ref to work on GitHub repos --- src/Directory.Build.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 2d75e3def..bdf4b5a5f 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -25,8 +25,8 @@ - - + + From 0056b1255414f598b539ced20c95fad630a120e2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jul 2019 11:19:52 -0600 Subject: [PATCH 0042/1753] Remove private vs-impl feed --- nuget.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuget.config b/nuget.config index 4ab034afe..cd0eec1da 100644 --- a/nuget.config +++ b/nuget.config @@ -4,7 +4,7 @@ - + From a7959d73f580b59b62b49b5fb526e1d4d0bc0115 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 28 Jul 2019 17:07:53 -0600 Subject: [PATCH 0043/1753] Add option to install SDKs machine-wide --- init.ps1 | 7 ++- tools/Install-DotNetSdk.ps1 | 106 ++++++++++++++++++++++++++++-------- 2 files changed, 89 insertions(+), 24 deletions(-) diff --git a/init.ps1 b/init.ps1 index 17389cbc6..599cfb47b 100644 --- a/init.ps1 +++ b/init.ps1 @@ -2,13 +2,16 @@ .SYNOPSIS Installs dependencies required to build and test the projects in this repository. .DESCRIPTION -This does not require elevation, as the dependencies are installed in per-user locations. +This MAY not require elevation, as the SDK and runtimes are installed locally to this repo location, +unless `-InstallLocality machine` is specified. .PARAMETER InstallLocality A value indicating whether dependencies should be installed locally to the repo or at a per-user location. Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. +Visual Studio will only notice and use these SDKs/runtimes if VS is launched from the environment that runs this script. Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. +Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. .PARAMETER NoPrerequisites Skips the installation of prerequisite software (e.g. SDKs, tools). .PARAMETER NoRestore @@ -18,7 +21,7 @@ An optional access token for authenticating to Azure Artifacts authenticated fee #> [CmdletBinding(SupportsShouldProcess=$true)] Param ( - [ValidateSet('repo','user')] + [ValidateSet('repo','user','machine')] [string]$InstallLocality='user', [Parameter()] [switch]$NoPrerequisites, diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 2eccce41f..a5d52eedf 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -3,22 +3,102 @@ Installs the .NET SDK specified in the global.json file at the root of this repository, along with supporting .NET Core runtimes used for testing. .DESCRIPTION -This does not require elevation, as the SDK and runtimes are installed locally to this repo location. +This MAY not require elevation, as the SDK and runtimes are installed locally to this repo location, +unless `-InstallLocality machine` is specified. .PARAMETER InstallLocality A value indicating whether dependencies should be installed locally to the repo or at a per-user location. Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. +Visual Studio will only notice and use these SDKs/runtimes if VS is launched from the environment that runs this script. Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. +Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( - [ValidateSet('repo','user')] + [ValidateSet('repo','user','machine')] [string]$InstallLocality='user' ) -$DotNetInstallScriptRoot = "$PSScriptRoot/../obj" -if (!(Test-Path $DotNetInstallScriptRoot)) { mkdir $DotNetInstallScriptRoot | Out-Null } +$DotNetInstallScriptRoot = "$PSScriptRoot/../obj/tools" +if (!(Test-Path $DotNetInstallScriptRoot)) { New-Item -ItemType Directory -Path $DotNetInstallScriptRoot | Out-Null } +$DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot + +# Look up actual required .NET Core SDK version from global.json +$sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" + +# Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. +$runtimeVersions = @() +Get-ChildItem "$PSScriptRoot\..\src\*.*proj" -Recurse |% { + $projXml = [xml](Get-Content -Path $_) + $targetFrameworks = $projXml.Project.PropertyGroup.TargetFramework + if (!$targetFrameworks) { + $targetFrameworks = $projXml.Project.PropertyGroup.TargetFrameworks + if ($targetFrameworks) { + $targetFrameworks = $targetFrameworks -Split ';' + } + } + $targetFrameworks |? { $_ -match 'netcoreapp(\d+\.\d+)' } |% { + $runtimeVersions += $Matches[1] + } +} + +Function Get-FileFromWeb([Uri]$Uri, $OutDir) { + $OutFile = Join-Path $OutDir $Uri.Segments[-1] + if (!(Test-Path $OutFile)) { + Write-Verbose "Downloading $Uri..." + try { + (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) + } finally { + # This try/finally causes the script to abort + } + } + + $OutFile +} + +Function Get-InstallerExe($Version, [switch]$Runtime) { + $sdkOrRuntime = 'Sdk' + if ($Runtime) { $sdkOrRuntime = 'Runtime' } + + # Get the latest/actual version for the specified one + if (([Version]$Version).Build -eq -1) { + $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/latest.version") + $Version = $versionInfo[-1] + } + + Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/dotnet-$($sdkOrRuntime.ToLowerInvariant())-$Version-win-x64.exe" -OutDir "$DotNetInstallScriptRoot" +} + +Function Install-DotNet($Version, [switch]$Runtime) { + if ($Runtime) { $sdkSubstring = '' } else { $sdkSubstring = 'SDK ' } + Write-Host "Downloading .NET Core $sdkSubstring$Version..." + $Installer = Get-InstallerExe -Version $Version -Runtime:$Runtime + Write-Host "Installing .NET Core $sdkSubstring$Version..." + cmd /c start /wait $Installer /install /quiet + if ($LASTEXITCODE -ne 0) { + throw "Failure to install .NET Core SDK" + } +} + +if ($InstallLocality -eq 'machine') { + if ($IsMacOS -or $IsLinux) { + Write-Error "Installing the .NET Core SDK or runtime at a machine-wide location is only supported by this script on Windows." + exit 1 + } + + if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + Install-DotNet -Version $sdkVersion + } + + $runtimeVersions |% { + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + Install-DotNet -Version $_ -Runtime + } + } + + return +} $switches = @( '-Architecture','x64' @@ -28,7 +108,6 @@ $envVars = @{ 'DOTNET_SKIP_FIRST_TIME_EXPERIENCE' = 'true'; } -$DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot if ($InstallLocality -eq 'repo') { $DotNetInstallDir = "$DotNetInstallScriptRoot/.dotnet" } elseif ($env:AGENT_TOOLSDIRECTORY) { @@ -44,7 +123,6 @@ if ($DotNetInstallDir) { $envVars['DOTNET_MULTILEVEL_LOOKUP'] = '0' $envVars['DOTNET_ROOT'] = $DotNetInstallDir } -$sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" if ($IsMacOS -or $IsLinux) { $DownloadUri = "https://dot.net/v1/dotnet-install.sh" @@ -67,22 +145,6 @@ if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" } -# Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. -$runtimeVersions = @() -Get-ChildItem "$PSScriptRoot\..\src\*.*proj" -Recurse |% { - $projXml = [xml](Get-Content -Path $_) - $targetFrameworks = $projXml.Project.PropertyGroup.TargetFramework - if (!$targetFrameworks) { - $targetFrameworks = $projXml.Project.PropertyGroup.TargetFrameworks - if ($targetFrameworks) { - $targetFrameworks = $targetFrameworks -Split ';' - } - } - $targetFrameworks |? { $_ -match 'netcoreapp(\d+\.\d+)' } |% { - $runtimeVersions += $Matches[1] - } -} - $switches += '-Runtime','dotnet' $runtimeVersions | Get-Unique |% { From 3ce68babff89107f16755b99e6ef05f96685af15 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 28 Jul 2019 21:07:54 -0600 Subject: [PATCH 0044/1753] Fix Get-nbgv.ps1 on Mac/Linux --- azure-pipelines/Get-nbgv.ps1 | 7 +++---- azure-pipelines/build.yml | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/Get-nbgv.ps1 b/azure-pipelines/Get-nbgv.ps1 index 8459995f5..925eecddb 100644 --- a/azure-pipelines/Get-nbgv.ps1 +++ b/azure-pipelines/Get-nbgv.ps1 @@ -13,16 +13,15 @@ if ($existingTool) { if ($env:AGENT_TEMPDIRECTORY) { $toolInstallDir = "$env:AGENT_TEMPDIRECTORY/$env:BUILD_BUILDID" } else { - $toolInstallDir = "$PSScriptRoot/obj/tools" + $toolInstallDir = "$PSScriptRoot/../obj/tools" } $toolPath = "$toolInstallDir/nbgv" -if (!(Test-Path $toolPath)) { New-Item -Path $toolPath -ItemType Directory | Out-Null } -$toolPath = (Resolve-Path $toolPath).Path +if (!(Test-Path $toolInstallDir)) { New-Item -Path $toolInstallDir -ItemType Directory | Out-Null } if (!(Get-Command $toolPath -ErrorAction SilentlyContinue)) { Write-Host "Installing nbgv to $toolInstallDir" - dotnet tool install --tool-path "$toolInstallDir" nbgv --configfile "$PSScriptRoot\justnugetorg.nuget.config" | Out-Null + dotnet tool install --tool-path "$toolInstallDir" nbgv --configfile "$PSScriptRoot/justnugetorg.nuget.config" | Out-Null } # Normalize the path on the way out. diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index f81d7f14d..bc7facfa2 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -9,7 +9,7 @@ jobs: clean: true # "all" doesn't work, but "true" does, despite YAML docs - template: install-dependencies.yml - - powershell: '& (azure-pipelines\Get-nbgv.ps1) cloud' + - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' displayName: Set build number - template: dotnet.yml From 109cb712d6d68aad3bcaf26209c7ed26b8abc50c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 29 Jul 2019 07:01:49 -0600 Subject: [PATCH 0045/1753] Clean on mac agent too --- azure-pipelines/build.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index bc7facfa2..05e32a18e 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -6,7 +6,7 @@ jobs: pool: ${{ parameters.windowsPool }} steps: - checkout: self - clean: true # "all" doesn't work, but "true" does, despite YAML docs + clean: true - template: install-dependencies.yml - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' @@ -20,7 +20,7 @@ jobs: vmImage: Ubuntu 16.04 steps: - checkout: self - clean: true # "all" doesn't work, but "true" does, despite YAML docs + clean: true - template: install-dependencies.yml - template: dotnet.yml - template: expand-template.yml @@ -29,6 +29,8 @@ jobs: pool: vmImage: macOS 10.13 steps: + - checkout: self + clean: true - template: install-dependencies.yml - template: dotnet.yml - template: expand-template.yml @@ -43,7 +45,7 @@ jobs: condition: succeededOrFailed() steps: - checkout: self - clean: true # "all" doesn't work, but "true" does, despite YAML docs + clean: true - template: install-dependencies.yml parameters: initArgs: -NoRestore From bea56a3333705f9c8cd8dd5d0f6e439ea398662d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 29 Jul 2019 08:46:14 -0600 Subject: [PATCH 0046/1753] Add nuget package copyright metadata --- src/Directory.Build.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index f4ef32972..475d57b8a 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,5 +1,4 @@ - - + Debug $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)..\')) @@ -14,6 +13,7 @@ COMPANY-PLACEHOLDER COMPANY-PLACEHOLDER + © COMPANY-PLACEHOLDER. All rights reserved. MIT true true From 0ce29683fc09edd1644d62ce523ebd6ab424cbaf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 29 Jul 2019 08:09:20 -0600 Subject: [PATCH 0047/1753] Rename MicroBuild.yml to official.yml This may be a step backwards, but as all existing repos use the official.yml naming, it will make migration to the latest of this pattern easier. --- Expand-Template.ps1 | 2 +- azure-pipelines/{microbuild.yml => official.yml} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename azure-pipelines/{microbuild.yml => official.yml} (100%) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index f325d898e..4f0097d37 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -132,7 +132,7 @@ try { $YmlReplacements = @{ "(?m)^\s+- microbuild`r?`n"="" } - Replace-Placeholders -Path "azure-pipelines\microbuild.yml" -Replacements $YmlReplacements + Replace-Placeholders -Path "azure-pipelines\official.yml" -Replacements $YmlReplacements if ($CodeCovToken) { $YmlReplacements['(codecov_token: ).*(#.*)'] = "`$1$CodeCovToken" } else { diff --git a/azure-pipelines/microbuild.yml b/azure-pipelines/official.yml similarity index 100% rename from azure-pipelines/microbuild.yml rename to azure-pipelines/official.yml From 2bbbf08ee728b4e72a4224ff94f9854a2150d315 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 29 Jul 2019 08:54:24 -0600 Subject: [PATCH 0048/1753] Switch to 'download' syntax --- azure-pipelines/publish-codecoverage.yml | 22 ++++++++-------------- azure-pipelines/publish-deployables.yml | 8 +++----- 2 files changed, 11 insertions(+), 19 deletions(-) diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 5d987c83e..6d367de96 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -1,27 +1,21 @@ steps: -- task: DownloadBuildArtifacts@0 +- download: current + artifact: coverageResults-Windows displayName: Download Windows code coverage results - inputs: - artifactName: coverageResults-Windows - downloadPath: $(System.DefaultWorkingDirectory)/bin continueOnError: true -- task: DownloadBuildArtifacts@0 +- download: current + artifact: coverageResults-Linux displayName: Download Linux code coverage results - inputs: - artifactName: coverageResults-Linux - downloadPath: $(System.DefaultWorkingDirectory)/bin continueOnError: true -- task: DownloadBuildArtifacts@0 +- download: current + artifact: coverageResults-macOS displayName: Download macOS code coverage results - inputs: - artifactName: coverageResults-macOS - downloadPath: $(System.DefaultWorkingDirectory)/bin continueOnError: true - powershell: | dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config - Copy-Item -Recurse $(System.DefaultWorkingDirectory)/bin/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj + Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" - $reports = Get-ChildItem -Recurse "$(System.DefaultWorkingDirectory)/bin/coverage.cobertura.xml" + $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.cobertura.xml" $reports |% { $content = Get-Content -Path $_ |% { $_.Replace("{reporoot}", "$(System.DefaultWorkingDirectory)") } Set-Content -Path $_ -Value $content -Encoding UTF8 diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index cdd852920..3f6bb9da5 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -1,15 +1,13 @@ steps: -- task: DownloadBuildArtifacts@0 +- download: current displayName: Download deployables - inputs: - artifactName: deployables-Windows - downloadPath: $(System.DefaultWorkingDirectory)/bin + artifact: deployables-Windows - task: DotNetCoreCLI@2 displayName: Push packages to CI feed inputs: command: push - packagesToPush: $(System.DefaultWorkingDirectory)/bin/deployables-Windows/*.nupkg + packagesToPush: $(Pipeline.Workspace)/deployables-Windows/*.nupkg nuGetFeedType: internal publishVstsFeed: $(ci_feed) allowPackageConflicts: true From 74edab08d3ad400e7f0c3c7bcf1b8278544f24dc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Aug 2019 12:53:47 -0600 Subject: [PATCH 0049/1753] Update package refs, fix env vars on *nix agents More detail: 1. Use capitalized env names so they work on *nix agents 2. Remove unused fxcop plugin installer 3. Update and sort package refs --- azure-pipelines/variables/InsertConfigValues.ps1 | 2 +- azure-pipelines/variables/ci_feed.ps1 | 2 +- init.ps1 | 6 ------ src/Directory.Build.props | 6 ++---- src/Library.Tests/Library.Tests.csproj | 4 ++-- 5 files changed, 6 insertions(+), 14 deletions(-) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index bd53ae8d3..1455a5b74 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -1,4 +1,4 @@ -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BuildConfiguration") +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BUILDCONFIGURATION") $icv=@() if (Test-Path "$BinPath") { diff --git a/azure-pipelines/variables/ci_feed.ps1 b/azure-pipelines/variables/ci_feed.ps1 index 2d6ef8e6c..b5530b3f1 100644 --- a/azure-pipelines/variables/ci_feed.ps1 +++ b/azure-pipelines/variables/ci_feed.ps1 @@ -1,4 +1,4 @@ -if ($env:SignType -eq 'Real') { +if ($env:SIGNTYPE -eq 'Real') { '09d8d03c-1ac8-456e-9274-4d2364527d99' # VSIDE-RealSigned-Release } else { 'da484c78-f942-44ef-b197-99e2a1bef53c' # VSIDE-TestSigned-Release diff --git a/init.ps1 b/init.ps1 index 51363419f..83a9e17e9 100644 --- a/init.ps1 +++ b/init.ps1 @@ -96,12 +96,6 @@ try { $EnvVars['LocLanguages'] = "JPN" } - if ($FxCop) { - Write-Host "Installing MicroBuild FxCop plugin" -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath MicroBuild.Plugins.FxCop -source $MicroBuildPackageSource -Verbosity $nugetVerbosity - $EnvVars['MicroBuild_FXCop'] = "true" - } - & ".\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars } catch { diff --git a/src/Directory.Build.props b/src/Directory.Build.props index fd3bbb510..d1db1b3f2 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -8,8 +8,6 @@ 7.3 true - true - COMPANY-PLACEHOLDER COMPANY-PLACEHOLDER © COMPANY-PLACEHOLDER. All rights reserved. @@ -23,9 +21,9 @@ - + - + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index 1f6a764c7..af9c6e3c0 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -14,11 +14,11 @@ - + - + From c52d5ff380c256be1362a3e7d6da209cf1d80f57 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Aug 2019 12:55:23 -0600 Subject: [PATCH 0050/1753] Update package references --- src/Directory.Build.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 475d57b8a..8f62479f7 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -23,9 +23,9 @@ - + - + From 461021a273a9b62bdace711a1ea99a3db6dd32dd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Aug 2019 15:58:19 -0600 Subject: [PATCH 0051/1753] Suppress "True" in build log --- init.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.ps1 b/init.ps1 index 83a9e17e9..76d29782f 100644 --- a/init.ps1 +++ b/init.ps1 @@ -96,7 +96,7 @@ try { $EnvVars['LocLanguages'] = "JPN" } - & ".\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars + & ".\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars | Out-Null } catch { Write-Error $error[0] From a66b8ad7f5034766b8d876348d550680e9fda596 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Aug 2019 16:06:04 -0600 Subject: [PATCH 0052/1753] Don't break build when package conflicts happen in CI DotNetCliTool doesn't support the allowPackageConflicts parameter. --- azure-pipelines/publish-deployables.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index 3f6bb9da5..a89f389fd 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -3,7 +3,7 @@ steps: displayName: Download deployables artifact: deployables-Windows -- task: DotNetCoreCLI@2 +- task: NuGetCommand@2 displayName: Push packages to CI feed inputs: command: push From 747490e372cd36a440bcf0c83a0a8bf75d493e1e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Aug 2019 17:18:50 -0600 Subject: [PATCH 0053/1753] Fix up VSTS references to Azure Pipelines --- azure-pipelines/artifacts/_pipelines.ps1 | 2 +- azure-pipelines/variables/_pipelines.ps1 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 270a96043..7451ab111 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -1,5 +1,5 @@ # This script translates all the artifacts described by _all.ps1 -# into commands that instruct VSTS to actually collect those artifacts. +# into commands that instruct Azure Pipelines to actually collect those artifacts. param ( [string]$ArtifactNameSuffix diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index b3fde25da..9fa0c16b7 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -1,5 +1,5 @@ # This script translates the variables returned by the _all.ps1 script -# into commands that instruct VSTS to actually set those variables for other VSTS tasks to consume. +# into commands that instruct Azure Pipelines to actually set those variables for other pipeline tasks to consume. # The build or release definition may have set these variables to override # what the build would do. So only set them if they have not already been set. From 4ed1fa825f5f77ee04a11fab2bef44607b8205ce Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 4 Aug 2019 06:30:58 -0600 Subject: [PATCH 0054/1753] Add support for nuget feeds using old style URLs --- tools/Install-NuGetCredProvider.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index df450dc79..ba70f2bd8 100644 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -42,7 +42,7 @@ if ($AccessToken) { $nugetConfig = [xml](Get-Content -Path "$PSScriptRoot\..\nuget.config") - $nugetConfig.configuration.packageSources.add |? { $_.value -match '^https://pkgs\.dev\.azure\.com/' } |% { + $nugetConfig.configuration.packageSources.add |? { ($_.value -match '^https://pkgs\.dev\.azure\.com/') -or ($_.value -match '^https://[\w\-]+\.pkgs\.visualstudio\.com/') } |% { $endpoint = New-Object -TypeName PSObject Add-Member -InputObject $endpoint -MemberType NoteProperty -Name endpoint -Value $_.value Add-Member -InputObject $endpoint -MemberType NoteProperty -Name username -Value ado From 02c4f0bb21a0fa9b57e8321f86118a5f234f35c8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Aug 2019 09:26:04 -0600 Subject: [PATCH 0055/1753] Skip net472 tests after a build failure --- azure-pipelines/dotnet.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 96569224a..21b189f2f 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -15,7 +15,7 @@ steps: arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true testRunTitle: net472-$(Agent.JobName) workingDirectory: src - condition: eq(variables['Agent.OS'], 'Windows_NT') + condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp2.1 From 4dc1a87609a869e2f0fb01939f3334b251c3f6a2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Aug 2019 09:26:57 -0600 Subject: [PATCH 0056/1753] Skip steps when build failure is certain --- azure-pipelines/clear-packagecaches.yml | 2 +- azure-pipelines/dotnet.yml | 6 +++--- azure-pipelines/expand-template.yml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/azure-pipelines/clear-packagecaches.yml b/azure-pipelines/clear-packagecaches.yml index 86c327ec0..2492623a4 100644 --- a/azure-pipelines/clear-packagecaches.yml +++ b/azure-pipelines/clear-packagecaches.yml @@ -4,4 +4,4 @@ steps: if (Test-Path $_) { Remove-Item $_ -Recurse -Force } } displayName: Purge package caches - condition: eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') + condition: and(succeeded(), eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9')) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 35863626d..c33e9210d 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -6,17 +6,17 @@ steps: msbuildArgs: /t:build,pack /m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog" platform: Any CPU configuration: $(BuildConfiguration) - condition: eq(variables['Agent.OS'], 'Windows_NT') + condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build workingDirectory: src - condition: ne(variables['Agent.OS'], 'Windows_NT') + condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) - script: dotnet pack --no-build -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/pack.binlog" displayName: dotnet pack workingDirectory: src - condition: ne(variables['Agent.OS'], 'Windows_NT') + condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) - task: DotNetCoreCLI@2 displayName: dotnet test -f net472 diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index a8591c649..e8ece7212 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -20,9 +20,9 @@ steps: msbuildArgs: /t:build,pack /m platform: Any CPU configuration: $(BuildConfiguration) - condition: eq(variables['Agent.OS'], 'Windows_NT') + condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - script: dotnet build displayName: dotnet build (expanded template) workingDirectory: src - condition: ne(variables['Agent.OS'], 'Windows_NT') + condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) From 6957e47ebdb45d635db0721353870d49032ef992 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Aug 2019 12:42:53 -0600 Subject: [PATCH 0057/1753] Update .NET Core SDK to 2.2.401 --- global.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/global.json b/global.json index 932387844..3d26ee658 100644 --- a/global.json +++ b/global.json @@ -1,5 +1,5 @@ { "sdk": { - "version": "2.2.300" + "version": "2.2.401" } -} \ No newline at end of file +} From fe7fee63e1c044ea141b04418dae57ae7cc847b6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Aug 2019 09:13:36 -0600 Subject: [PATCH 0058/1753] Fix formatting of xml and json files --- src/.editorconfig => .editorconfig | 0 .vscode/extensions.json | 32 ++++++++++++++---------------- nuget.config | 4 ++-- 3 files changed, 17 insertions(+), 19 deletions(-) rename src/.editorconfig => .editorconfig (100%) diff --git a/src/.editorconfig b/.editorconfig similarity index 100% rename from src/.editorconfig rename to .editorconfig diff --git a/.vscode/extensions.json b/.vscode/extensions.json index f910c6876..8b1c54d64 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,18 +1,16 @@ { - // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. - // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp - - // List of extensions which should be recommended for users of this workspace. - "recommendations": [ - "ms-azure-devops.azure-pipelines", - "ms-vscode.csharp", - "k--kato.docomment", - "editorconfig.editorconfig", - "pflannery.vscode-versionlens", - "davidanson.vscode-markdownlint" - ], - // List of extensions recommended by VS Code that should not be recommended for users of this workspace. - "unwantedRecommendations": [ - - ] -} \ No newline at end of file + // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. + // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp + // List of extensions which should be recommended for users of this workspace. + "recommendations": [ + "ms-azure-devops.azure-pipelines", + "ms-vscode.csharp", + "k--kato.docomment", + "editorconfig.editorconfig", + "pflannery.vscode-versionlens", + "davidanson.vscode-markdownlint", + "dotjoshjohnson.xml" + ], + // List of extensions recommended by VS Code that should not be recommended for users of this workspace. + "unwantedRecommendations": [] +} diff --git a/nuget.config b/nuget.config index d068efcf6..1ee7a2bc9 100644 --- a/nuget.config +++ b/nuget.config @@ -1,8 +1,8 @@ - + - + From 297a72516e3f287018f6de0ec883e64e87a82bf0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Aug 2019 09:13:47 -0600 Subject: [PATCH 0059/1753] Centralize MicroBuild package version --- src/Directory.Build.props | 4 +++- src/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index d1db1b3f2..6db75f28a 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -17,10 +17,12 @@ true snupkg $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + + 2.0.55 - + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index af9c6e3c0..14b579003 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -15,7 +15,7 @@ - + From 8f108fe64a258c923ab3322fe802c3c50651390b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Aug 2019 10:15:03 -0600 Subject: [PATCH 0060/1753] Update NB.GV to 3.0.25 --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 8f62479f7..8c3372758 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -26,7 +26,7 @@ - + From 5847f0ae57e1277afff053774a11f7b64bb2b678 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Aug 2019 13:51:24 -0600 Subject: [PATCH 0061/1753] Use a local package cache This ensures that restore always uses the sources in nuget.config rather than a cache that happens to be on the local box. It helps avoid bugs that are not caught till a build suddenly fails on some machine somewhere because it didn't happen to have a package cached locally from some other source. It also mitigates the risk on private build agents that a package cache is "poisoned" by some build already done on that agent with other package sources where the id/version of a package collides but the contents are not actually identical. --- nuget.config | 3 +++ 1 file changed, 3 insertions(+) diff --git a/nuget.config b/nuget.config index 1ee7a2bc9..4949867c4 100644 --- a/nuget.config +++ b/nuget.config @@ -1,5 +1,8 @@ + + + From 68b3a76367dc334c375b4079bed109d3c920af1c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 11 Aug 2019 22:29:34 -0600 Subject: [PATCH 0062/1753] Add Codex indexing of source --- azure-pipelines/microbuild.after.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 8601dfaa0..14340d5e5 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -6,3 +6,16 @@ steps: - task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0 displayName: Component Detection condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) + +- task: Ref12.ref12-analyze-task.ref12-analyze-task.Ref12Analyze@0 + displayName: Ref12 (Codex) Analyze + inputs: + codexoutputroot: $(Build.ArtifactStagingDirectory)\Codex + workflowArguments: | + /sourcesDirectory:$(Build.SourcesDirectory) + /codexRepoUrl:$(Build.Repository.Uri) + /repoName:$(Build.Repository.Name) + /additionalCodexArguments:-bld + /additionalCodexArguments:$(Build.ArtifactStagingDirectory)/build_logs + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) + continueOnError: true From 7f19eaa4f759424f7ae8e05931f10d11dfcd5bfd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 11 Aug 2019 22:34:26 -0600 Subject: [PATCH 0063/1753] Stop clearing package cache on private agent Instead, we just divert the package cache to another location that is always cleared anyway. --- azure-pipelines/build.yml | 3 ++- azure-pipelines/clear-packagecaches.yml | 7 ------- 2 files changed, 2 insertions(+), 8 deletions(-) delete mode 100644 azure-pipelines/clear-packagecaches.yml diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index eb70c94f7..64584f99b 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -4,10 +4,11 @@ parameters: jobs: - job: Windows pool: ${{ parameters.windowsPool }} + variables: + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages steps: - checkout: self clean: true - - template: clear-packagecaches.yml - template: install-dependencies.yml - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' diff --git a/azure-pipelines/clear-packagecaches.yml b/azure-pipelines/clear-packagecaches.yml deleted file mode 100644 index 2492623a4..000000000 --- a/azure-pipelines/clear-packagecaches.yml +++ /dev/null @@ -1,7 +0,0 @@ -steps: -- powershell: | - "$env:userprofile\.nuget\packages", "$env:LocalAppData\NuGet\Cache", "$env:AppData\tsd-cache" |% { - if (Test-Path $_) { Remove-Item $_ -Recurse -Force } - } - displayName: Purge package caches - condition: and(succeeded(), eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9')) From 364dfe9f316b1ed9fb950bdb8dc51c361bb83a99 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 11 Aug 2019 23:15:23 -0600 Subject: [PATCH 0064/1753] When squashing, record the original commit ID --- Expand-Template.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index c050aba3f..89614a2d4 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -74,8 +74,9 @@ if (-not $sn) { Push-Location $PSScriptRoot try { if ($Squash) { + $originalCommitId = git rev-parse HEAD git reset --soft $(git rev-list --max-parents=0 HEAD) - git commit --amend -qm "Initial template from https://github.com/AArnott/Library.Template" + git commit --amend -qm "Initial template from https://github.com/AArnott/Library.Template" -m "Original commit from template $originalCommitId" } # Rename project directories and solution From 87b92ebed468b033b081beca8110365daf7fb77e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Aug 2019 11:56:02 -0600 Subject: [PATCH 0065/1753] Add verify signed files step --- azure-pipelines/microbuild.after.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 8601dfaa0..a37c60cbf 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,4 +1,10 @@ steps: +- task: ms-vseng.MicroBuildShipTasks.7c429315-71ba-4cb3-94bb-f829c95f7915.MicroBuildCodesignVerify@2 + displayName: Verify Signed Files + inputs: + TargetFolders: | + $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet + - task: MicroBuildCleanup@1 condition: succeededOrFailed() displayName: MicroBuild Cleanup From b17ceb8734b05238ee8020734441d1ae2b656953 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Aug 2019 12:25:05 -0600 Subject: [PATCH 0066/1753] Sign xml doc comment files --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 1d2d3c0d5..60a88b1b3 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -18,7 +18,7 @@ snupkg $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 2.0.55 + 2.0.57 From 4705734f048b74f2dedb26799b157dcb7d74571e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Aug 2019 16:48:54 -0600 Subject: [PATCH 0067/1753] Fix nuget install Get packages into a subdirectory and use nuget.exe 5.2.0 so it works with the credential provider. --- azure-pipelines/Get-NuGetTool.ps1 | 2 +- nuget.config | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/Get-NuGetTool.ps1 b/azure-pipelines/Get-NuGetTool.ps1 index fdf3ed55e..623bb6f02 100644 --- a/azure-pipelines/Get-NuGetTool.ps1 +++ b/azure-pipelines/Get-NuGetTool.ps1 @@ -6,7 +6,7 @@ #> Param( [Parameter()] - [string]$NuGetVersion='5.0.2' + [string]$NuGetVersion='5.2.0' ) $toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" diff --git a/nuget.config b/nuget.config index 4949867c4..385887117 100644 --- a/nuget.config +++ b/nuget.config @@ -2,6 +2,7 @@ + From 4ecab1957dd720fb5110f882475090d8a540aad3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Aug 2019 16:54:28 -0600 Subject: [PATCH 0068/1753] Redirect Only divert global package cache in Azure Pipelines On local machines, file locks on the global package cache can cause `git clean -fdx` to fail. It also causes package restore times to be longer on local boxes after cleaning. The extra protection afforded by a diverted package cache is good, but is probably sufficient to provide only in Azure Pipelines, or explicitly by the user when they want it. --- azure-pipelines.yml | 1 + nuget.config | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index f158ff523..539df93ae 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -16,6 +16,7 @@ variables: BuildPlatform: Any CPU codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages jobs: - template: azure-pipelines/build.yml diff --git a/nuget.config b/nuget.config index 385887117..c0173d1ba 100644 --- a/nuget.config +++ b/nuget.config @@ -1,7 +1,6 @@ - From 8931dfb7818bb7e5173cbdd991d8af2c2a6699ca Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Aug 2019 17:03:52 -0600 Subject: [PATCH 0069/1753] Download nuget.exe much more quickly Invoke-WebRequest is a terribly slow way to download files. --- azure-pipelines/Get-NuGetTool.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Get-NuGetTool.ps1 b/azure-pipelines/Get-NuGetTool.ps1 index 623bb6f02..4431adb91 100644 --- a/azure-pipelines/Get-NuGetTool.ps1 +++ b/azure-pipelines/Get-NuGetTool.ps1 @@ -16,7 +16,7 @@ $nugetPath = Join-Path $binaryToolsPath nuget.exe if (!(Test-Path $nugetPath)) { Write-Host "Downloading nuget.exe $NuGetVersion..." -ForegroundColor Yellow - Invoke-WebRequest -Uri "https://dist.nuget.org/win-x86-commandline/v$NuGetVersion/NuGet.exe" -OutFile $nugetPath | Out-Null + (New-Object System.Net.WebClient).DownloadFile("https://dist.nuget.org/win-x86-commandline/v$NuGetVersion/NuGet.exe", $nugetPath) } return (Resolve-Path $nugetPath).Path From cc78e3cce898d44dbbd6b139f23ad46c50944f7b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Aug 2019 17:40:21 -0600 Subject: [PATCH 0070/1753] Update to MicroBuild 2.0.58 to sign published files --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 60a88b1b3..60be6d8a3 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -18,7 +18,7 @@ snupkg $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 2.0.57 + 2.0.58 From 10adace490b792a7053a97bbed92716475cc99ba Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Aug 2019 11:43:01 -0600 Subject: [PATCH 0071/1753] Add SymbolsFeatureName variable --- Expand-Template.ps1 | 4 ++++ azure-pipelines/variables/SymbolsFeatureName.ps1 | 1 + 2 files changed, 5 insertions(+) create mode 100644 azure-pipelines/variables/SymbolsFeatureName.ps1 diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 6c18d2e64..d6b82cb52 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -146,6 +146,10 @@ try { 'LibraryNoDots' = $LibraryName.Replace('.',''); } + Replace-Placeholders -Path "azure-pipelines/variables/SymbolsFeatureName.ps1" -Replacements @{ + 'LibraryName' = $LibraryName; + } + # Self destruct $Invocation = (Get-Variable MyInvocation -Scope 1).Value git rm Expand-Template.ps1 diff --git a/azure-pipelines/variables/SymbolsFeatureName.ps1 b/azure-pipelines/variables/SymbolsFeatureName.ps1 new file mode 100644 index 000000000..d6c133eb7 --- /dev/null +++ b/azure-pipelines/variables/SymbolsFeatureName.ps1 @@ -0,0 +1 @@ +'LibraryName' From b340b5f5147f07f8553f21c35615c536db49de4d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Aug 2019 11:44:14 -0600 Subject: [PATCH 0072/1753] Specify default for Author in Expand-Template --- Expand-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index d6b82cb52..3ac78c898 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -18,7 +18,7 @@ Param( [Parameter(Mandatory=$true)] [string]$LibraryName, [Parameter(Mandatory=$true)] - [string]$Author, + [string]$Author = "Microsoft Corporation", [Parameter()] [string]$CodeCovToken, [Parameter()] From fa7265ccbac9ca8c3dc4c3c9c1f512482b6304ec Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Aug 2019 12:32:02 -0600 Subject: [PATCH 0073/1753] Remove unused CIFeed parameter --- Expand-Template.ps1 | 4 ---- 1 file changed, 4 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 3ac78c898..64ca150f8 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -8,8 +8,6 @@ The name to use in copyright and owner notices. .PARAMETER CodeCovToken A token obtained from codecov.io for your repo. If not specified, code coverage results will not be published to codecov.io, but can be added later by editing the Azure Pipelines YAML file. -.PARAMETER CIFeed -The `/{guid}` path to the Azure Pipelines artifact feed to push your nuget package to as part of your CI. .PARAMETER Squash A switch that causes all of git history to be squashed to just one initial commit for the template, and one for its expansion. #> @@ -22,8 +20,6 @@ Param( [Parameter()] [string]$CodeCovToken, [Parameter()] - [string]$CIFeed, - [Parameter()] [switch]$Squash ) From 5a8b75a11464440dac5a22a056e209213b4aa37d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Aug 2019 09:21:04 -0600 Subject: [PATCH 0074/1753] Remove working direction assumption from init.ps1 --- init.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.ps1 b/init.ps1 index 76d29782f..9e34fed69 100644 --- a/init.ps1 +++ b/init.ps1 @@ -96,7 +96,7 @@ try { $EnvVars['LocLanguages'] = "JPN" } - & ".\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars | Out-Null + & "$PSScriptRoot\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars | Out-Null } catch { Write-Error $error[0] From 5cc44c4f2bbfd483104621a636e924a2e0544dc4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 10 Sep 2019 17:19:48 -0600 Subject: [PATCH 0075/1753] Improve Azure Pipelines build reliability This works around a bug that causes our Windows agent to very frequently fail in the nuget credential provider. --- init.ps1 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/init.ps1 b/init.ps1 index 599cfb47b..e01f3aed5 100644 --- a/init.ps1 +++ b/init.ps1 @@ -36,6 +36,10 @@ if (!$NoPrerequisites) { & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality } +# Workaround nuget credential provider bug that causes very unreliable package restores on Azure Pipelines +$env:NUGET_PLUGIN_HANDSHAKE_TIMEOUT_IN_SECONDS=20 +$env:NUGET_PLUGIN_REQUEST_TIMEOUT_IN_SECONDS=20 + Push-Location $PSScriptRoot try { $HeaderColor = 'Green' From 70dcacac07c281ebe1e60ce5acbb5a22e1449df7 Mon Sep 17 00:00:00 2001 From: Eilon Lipton Date: Tue, 17 Sep 2019 15:22:46 -0700 Subject: [PATCH 0076/1753] Use HTTPS URLs wherever possible --- .vscode/extensions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 8b1c54d64..c5b615df4 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,5 +1,5 @@ { - // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. + // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations. // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp // List of extensions which should be recommended for users of this workspace. "recommendations": [ From 4641b826b0717b388f241a7eeda281f344d7042a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 21 Sep 2019 21:53:35 -0600 Subject: [PATCH 0077/1753] Fix auto-build of validate/* branches --- azure-pipelines.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 539df93ae..c4c3f607c 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -2,7 +2,7 @@ trigger: branches: include: - master - - validate/* + - 'validate/*' paths: exclude: - doc/ From a77d264bbc72eb0f201c2fc14db40525746417d9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Sep 2019 06:26:38 -0600 Subject: [PATCH 0078/1753] Suppress an unreasonable static analysis rule for tests --- src/tests.ruleset | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/tests.ruleset b/src/tests.ruleset index 4b4708a12..a13659760 100644 --- a/src/tests.ruleset +++ b/src/tests.ruleset @@ -12,4 +12,7 @@ + + + From dfc7dea7c1e5b534a59206b8e9ab5996313c7cd3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Sep 2019 06:26:43 -0600 Subject: [PATCH 0079/1753] Add a bunch of useful solution items --- src/Library.sln | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/src/Library.sln b/src/Library.sln index 17645391b..09dfb1fe6 100644 --- a/src/Library.sln +++ b/src/Library.sln @@ -1,20 +1,30 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 15 -VisualStudioVersion = 15.0.26124.0 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29322.22 MinimumVisualStudioVersion = 15.0.26124.0 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Library", "Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library", "Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Library.Tests", "Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library.Tests", "Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1CE9670B-D5FF-46A7-9D00-24E70E6ED48B}" + ProjectSection(SolutionItems) = preProject + ..\.editorconfig = ..\.editorconfig + Directory.Build.props = Directory.Build.props + Directory.Build.targets = Directory.Build.targets + ..\global.json = ..\global.json + ..\nuget.config = ..\nuget.config + shipping.ruleset = shipping.ruleset + stylecop.json = stylecop.json + tests.ruleset = tests.ruleset + ..\version.json = ..\version.json + EndProjectSection EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Release|Any CPU = Release|Any CPU EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {C06D702E-6FC7-453B-BDDF-608F825EC003}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {C06D702E-6FC7-453B-BDDF-608F825EC003}.Debug|Any CPU.Build.0 = Debug|Any CPU @@ -25,4 +35,10 @@ Global {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Release|Any CPU.ActiveCfg = Release|Any CPU {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {E3944F6A-384B-4B0F-B93F-3BD513DC57BD} + EndGlobalSection EndGlobal From 3c52f6060a928ea6a5297bcabdaf927bdc921cf3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Sep 2019 06:26:06 -0600 Subject: [PATCH 0080/1753] Enable C# 8 nullable features Also update to 3.0 .NET Core SDK as required for the nullable feature. --- global.json | 2 +- src/Directory.Build.props | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/global.json b/global.json index 3d26ee658..79422f0cc 100644 --- a/global.json +++ b/global.json @@ -1,5 +1,5 @@ { "sdk": { - "version": "2.2.401" + "version": "3.0.100" } } diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 8c3372758..9c875502c 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -5,7 +5,8 @@ $(RepoRootPath)obj\$(MSBuildProjectName)\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - 7.3 + 8.0 + enable true true From fb5b061b2979cbb6116628ce342902e05061ca52 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Sep 2019 06:31:53 -0600 Subject: [PATCH 0081/1753] Fix CI trigger for validate/* branches --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index dab6c2e34..d002dbb34 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -3,7 +3,7 @@ trigger: include: - master - microbuild - - validate/* + - 'validate/*' paths: exclude: - doc/ From a2556bf66ce72ef84c33077b94a9c83100d88e37 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Oct 2019 08:35:23 -0600 Subject: [PATCH 0082/1753] Fix Install-DotNetSdk on machines without IE configured --- tools/Install-DotNetSdk.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index a5d52eedf..50687706e 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -63,7 +63,7 @@ Function Get-InstallerExe($Version, [switch]$Runtime) { # Get the latest/actual version for the specified one if (([Version]$Version).Build -eq -1) { - $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/latest.version") + $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/latest.version" -UseBasicParsing) $Version = $versionInfo[-1] } @@ -133,7 +133,7 @@ if ($IsMacOS -or $IsLinux) { } if (-not (Test-Path $DotNetInstallScriptPath)) { - Invoke-WebRequest -Uri $DownloadUri -OutFile $DotNetInstallScriptPath + Invoke-WebRequest -Uri $DownloadUri -OutFile $DotNetInstallScriptPath -UseBasicParsing if ($IsMacOS -or $IsLinux) { chmod +x $DotNetInstallScriptPath } From f78ee0462a078f4190fa7e811e3a86105f545d61 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Nov 2019 21:43:54 -0700 Subject: [PATCH 0083/1753] Capture exit codes within init.cmd from ps1 script --- init.cmd | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/init.cmd b/init.cmd index 5bef08da3..970285c2f 100644 --- a/init.cmd +++ b/init.cmd @@ -1,3 +1,4 @@ -@set PS1UnderCmd=1 -powershell.exe -ExecutionPolicy bypass -Command "& '%~dpn0.ps1'" %* -@set PS1UnderCmd= +@echo off +SETLOCAL +set PS1UnderCmd=1 +powershell.exe -NoProfile -NoLogo -ExecutionPolicy bypass -Command "try { & '%~dpn0.ps1' %*; exit $LASTEXITCODE } catch { write-host $_; exit 1 }" From 7248b76f71de8ba2afa097d129367d784c371159 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Nov 2019 21:44:06 -0700 Subject: [PATCH 0084/1753] Add Expand-Template.cmd stub --- Expand-Template.cmd | 4 ++++ Expand-Template.ps1 | 13 +++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 Expand-Template.cmd diff --git a/Expand-Template.cmd b/Expand-Template.cmd new file mode 100644 index 000000000..970285c2f --- /dev/null +++ b/Expand-Template.cmd @@ -0,0 +1,4 @@ +@echo off +SETLOCAL +set PS1UnderCmd=1 +powershell.exe -NoProfile -NoLogo -ExecutionPolicy bypass -Command "try { & '%~dpn0.ps1' %*; exit $LASTEXITCODE } catch { write-host $_; exit 1 }" diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 89614a2d4..5225f8785 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -149,11 +149,11 @@ try { # Self destruct $Invocation = (Get-Variable MyInvocation -Scope 1).Value - git rm Expand-Template.ps1 + git rm Expand-Template.* git rm :/azure-pipelines/expand-template.yml # Self-integrity check - Get-ChildItem -Recurse -File -Exclude bin,obj,README.md,Expand-Template.ps1 |? { -not $_.FullName.Contains("obj") } |% { + Get-ChildItem -Recurse -File -Exclude bin,obj,README.md,Expand-Template.* |? { -not $_.FullName.Contains("obj") } |% { $PLACEHOLDERS = Get-Content -Path $_.FullName |? { $_.Contains('PLACEHOLDER') } if ($PLACEHOLDERS) { Write-Error "PLACEHOLDER discovered in $($_.FullName)" @@ -162,6 +162,15 @@ try { # Commit the changes git commit -qm "Expanded template for $LibraryName" -m "This expansion done by the (now removed) Expand-Template.ps1 script." + + Write-Host -ForegroundColor Green "Template successfully expanded." + + if ($env:PS1UnderCmd) { + # We're running under the Expand-Template.cmd script. + # Since we just deleted it from disk cmd.exe will complain. Just advise the user it's OK. + Write-Host -ForegroundColor Green 'Disregard an error you may see: "The batch file cannot be found." We just cleaned up after ourselves.' + } + } finally { Pop-Location } From 65c7a0b46f10e72cf2f73e169956da9b15170e4c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Nov 2019 22:01:51 -0700 Subject: [PATCH 0085/1753] Fix synopsis of Convert-PDB.ps1 script Fixes #24 --- azure-pipelines/Convert-PDB.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 index 00549f713..a3212213b 100644 --- a/azure-pipelines/Convert-PDB.ps1 +++ b/azure-pipelines/Convert-PDB.ps1 @@ -1,6 +1,6 @@ <# .SYNOPSIS - Builds all projects in this repo. + Converts between Windows PDB and Portable PDB formats. .PARAMETER DllPath The path to the DLL whose PDB is to be converted. .PARAMETER PdbPath From d6fe2405533b5f5da639dfb65e1ef5e8dfabf4ee Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Nov 2019 22:03:46 -0700 Subject: [PATCH 0086/1753] Add comment explaining where to get the guid from Fixes #28 --- azure-pipelines.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index c4c3f607c..2dbb2cbbd 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -15,7 +15,7 @@ variables: BuildConfiguration: Release BuildPlatform: Any CPU codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed + ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed. Learn more at https://github.com/AArnott/Library.Template/issues/28 NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages jobs: From 51d643cbab57eb43bc15d294e153c7ce40b76e9f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 Nov 2019 09:02:44 -0700 Subject: [PATCH 0087/1753] Avoid restoring packages under -whatif --- init.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.ps1 b/init.ps1 index e01f3aed5..f8ca00a5d 100644 --- a/init.ps1 +++ b/init.ps1 @@ -44,7 +44,7 @@ Push-Location $PSScriptRoot try { $HeaderColor = 'Green' - if (!$NoRestore) { + if (!$NoRestore -and $PSCmdlet.ShouldProcess("NuGet packages", "Restore")) { Write-Host "Restoring NuGet packages" -ForegroundColor $HeaderColor dotnet restore src if ($lastexitcode -ne 0) { From 5a6c63701f386823b6e12d4a0052d3ced73ae332 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Dec 2019 13:03:21 -0700 Subject: [PATCH 0088/1753] Fix and add to the init.ps1 description docs --- init.ps1 | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/init.ps1 b/init.ps1 index f8ca00a5d..9dfb6afb9 100644 --- a/init.ps1 +++ b/init.ps1 @@ -2,8 +2,9 @@ .SYNOPSIS Installs dependencies required to build and test the projects in this repository. .DESCRIPTION -This MAY not require elevation, as the SDK and runtimes are installed locally to this repo location, -unless `-InstallLocality machine` is specified. +This MAY not require elevation, as the SDK and runtimes are installed to a per-user location, +unless the `-InstallLocality` switch is specified directing to a per-repo or per-machine location. +See detailed help on that switch for more information. .PARAMETER InstallLocality A value indicating whether dependencies should be installed locally to the repo or at a per-user location. Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. From b79e0301b39153cbd09dca06767c7264178e274e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Dec 2019 17:13:57 -0700 Subject: [PATCH 0089/1753] Use AGENT_TEMPDIRECTORY for tools AGENT_TOOLSDIRECTORY may not be cleaned between each build, so AGENT_TEMPDIRECTORY which certainly is cleaned is a better place to put files that might need newer versions downloaded and/or installed each time. --- azure-pipelines/Get-TempToolsPath.ps1 | 6 +++--- azure-pipelines/Get-nbgv.ps1 | 6 +----- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/Get-TempToolsPath.ps1 b/azure-pipelines/Get-TempToolsPath.ps1 index 97c552c06..bb3da8e33 100644 --- a/azure-pipelines/Get-TempToolsPath.ps1 +++ b/azure-pipelines/Get-TempToolsPath.ps1 @@ -1,7 +1,7 @@ -if ($env:AGENT_TOOLSDIRECTORY) { - $path = "$env:AGENT_TOOLSDIRECTORY\vs-platform\tools" +if ($env:AGENT_TEMPDIRECTORY) { + $path = "$env:AGENT_TEMPDIRECTORY\$env:BUILD_BUILDID" } elseif ($env:localappdata) { - $path = "$env:localappdata\vs-platform\tools" + $path = "$env:localappdata\gitrepos\tools" } else { $path = "$PSScriptRoot\..\obj\tools" } diff --git a/azure-pipelines/Get-nbgv.ps1 b/azure-pipelines/Get-nbgv.ps1 index 925eecddb..a5be2cf7c 100644 --- a/azure-pipelines/Get-nbgv.ps1 +++ b/azure-pipelines/Get-nbgv.ps1 @@ -10,11 +10,7 @@ if ($existingTool) { return $existingTool.Path } -if ($env:AGENT_TEMPDIRECTORY) { - $toolInstallDir = "$env:AGENT_TEMPDIRECTORY/$env:BUILD_BUILDID" -} else { - $toolInstallDir = "$PSScriptRoot/../obj/tools" -} +$toolInstallDir = & "$PSScriptRoot/Get-TempToolsPath.ps1" $toolPath = "$toolInstallDir/nbgv" if (!(Test-Path $toolInstallDir)) { New-Item -Path $toolInstallDir -ItemType Directory | Out-Null } From 153cd7d1aaa4738c163e1ad2ee813075183890b0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Dec 2019 17:31:06 -0700 Subject: [PATCH 0090/1753] Upgrade NuGet credprovider in Azure Pipelines On private agents where it may exist from a prior build, it's important that we update it to whatever the latest version is. --- azure-pipelines/install-dependencies.yml | 2 +- init.ps1 | 7 ++++++- tools/Install-NuGetCredProvider.ps1 | 6 +++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 8da07957b..9257db852 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -4,7 +4,7 @@ parameters: steps: - powershell: | - .\init.ps1 -AccessToken '$(System.AccessToken)' ${{ parameters['initArgs'] }} + .\init.ps1 -AccessToken '$(System.AccessToken)' ${{ parameters['initArgs'] }} -UpgradePrerequisites dotnet --info displayName: Install prerequisites diff --git a/init.ps1 b/init.ps1 index 9dfb6afb9..ae4ce9a69 100644 --- a/init.ps1 +++ b/init.ps1 @@ -15,6 +15,9 @@ Per-repo can lead to file locking issues when dotnet.exe is left running as a bu Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. .PARAMETER NoPrerequisites Skips the installation of prerequisite software (e.g. SDKs, tools). +.PARAMETER UpgradePrerequisites +Takes time to install prerequisites even if they are already present in case they need to be upgraded. +No effect if -NoPrerequisites is specified. .PARAMETER NoRestore Skips the package restore step. .PARAMETER AccessToken @@ -27,13 +30,15 @@ Param ( [Parameter()] [switch]$NoPrerequisites, [Parameter()] + [switch]$UpgradePrerequisites, + [Parameter()] [switch]$NoRestore, [Parameter()] [string]$AccessToken ) if (!$NoPrerequisites) { - & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken + & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken -Force:$UpgradePrerequisites & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality } diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index ba70f2bd8..0a8d77f62 100644 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -4,11 +4,15 @@ from https://github.com/microsoft/artifacts-credprovider to assist in authenticating to Azure Artifact feeds in interactive development or unattended build agents. +.PARAMETER Force + Forces install of the CredProvider plugin even if one already exists. This is useful to upgrade an older version. .PARAMETER AccessToken An optional access token for authenticating to Azure Artifacts authenticated feeds. #> [CmdletBinding()] Param ( + [Parameter()] + [switch]$Force, [Parameter()] [string]$AccessToken ) @@ -35,7 +39,7 @@ if ($IsMacOS -or $IsLinux) { chmod u+x $installerScript } -& $installerScript +& $installerScript -Force:$Force if ($AccessToken) { $endpoints = @() From be9bbd097fb0410325e1d896f9d3a55f2280e64b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 18 Dec 2019 13:50:18 -0700 Subject: [PATCH 0091/1753] Update package refs Also stop packing pdb in main nupkg --- src/Directory.Build.props | 9 ++++----- src/Library.Tests/Library.Tests.csproj | 4 ++-- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 9c875502c..f6d3c9ce6 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -20,14 +20,13 @@ true true snupkg - $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - - - - + + + + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index 7323c8d96..08f74be77 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -14,8 +14,8 @@ - - + + From e888eb54024e259c801b9b37d363d08ef3eb3f1c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2019 13:23:35 -0700 Subject: [PATCH 0092/1753] Bump SDK version to 3.1 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 79422f0cc..e9aac8c22 100644 --- a/global.json +++ b/global.json @@ -1,5 +1,5 @@ { "sdk": { - "version": "3.0.100" + "version": "3.1.100" } } From 35bf0941b3900c248c745588f62d711a3bf6860c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2019 13:36:35 -0700 Subject: [PATCH 0093/1753] Test on .NET Core 3.1 .NET Core 2.2 is no longer supported. Testing on 2.1 and 3.1 focus testing on LTS releases of .NET Core. --- azure-pipelines/dotnet.yml | 6 +++--- src/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 21b189f2f..9d910d2dc 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -26,11 +26,11 @@ steps: workingDirectory: src - task: DotNetCoreCLI@2 - displayName: dotnet test -f netcoreapp2.2 + displayName: dotnet test -f netcoreapp3.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.2 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true - testRunTitle: netcoreapp2.2-$(Agent.JobName) + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + testRunTitle: netcoreapp3.1-$(Agent.JobName) workingDirectory: src - task: PowerShell@2 diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index 08f74be77..78ebcfd4d 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -1,7 +1,7 @@ - net472;netcoreapp2.1;netcoreapp2.2 + net472;netcoreapp2.1;netcoreapp3.1 false $(NoWarn);CS1591 true From 56ab8cb586bb555875acdfe597465ef75aec5dcb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2019 14:35:30 -0700 Subject: [PATCH 0094/1753] Use latest StyleCop As necessary for nullable ref type syntax to not flag as warnings in StyleCop --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index f6d3c9ce6..ddd8ae606 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -27,7 +27,7 @@ - + From f863ad7bbd658e596534b9e60628cafa4538dca3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 3 Jan 2020 12:22:23 -0700 Subject: [PATCH 0095/1753] Upgrade signing plugin --- azure-pipelines/microbuild.before.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 310b559eb..b1efae6e9 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,5 +1,5 @@ steps: -- task: MicroBuildSigningPlugin@1 +- task: MicroBuildSigningPlugin@2 inputs: signType: $(SignType) zipSources: false From 366d5df26c31eb212dc49c970ec77597874b5fc3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2020 14:59:28 -0700 Subject: [PATCH 0096/1753] Start with GitHub Actions (#34) --- .github/workflows/build.yml | 99 ++++++++++++++++++++++++ Expand-Template.ps1 | 3 +- README.md | 4 +- azure-pipelines.yml | 1 - azure-pipelines/Set-EnvVars.ps1 | 46 ++++++++++- azure-pipelines/artifacts/Variables.ps1 | 10 +-- azure-pipelines/artifacts/_pipelines.ps1 | 49 +----------- azure-pipelines/artifacts/_stage_all.ps1 | 59 ++++++++++++++ azure-pipelines/build.yml | 4 +- azure-pipelines/variables/_pipelines.ps1 | 8 +- tools/Install-DotNetSdk.ps1 | 38 +-------- 11 files changed, 222 insertions(+), 99 deletions(-) create mode 100644 .github/workflows/build.yml create mode 100644 azure-pipelines/artifacts/_stage_all.ps1 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..4e9918733 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,99 @@ +name: CI + +on: + push: + branches: + - master + - microbuild + - validate/* + pull_request: + +env: + TreatWarningsAsErrors: true + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BUILDCONFIGURATION: Release + codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ + ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed. Learn more at https://github.com/AArnott/Library.Template/issues/28 +# NUGET_PACKAGES: ${{ env.GITHUB_WORKSPACE }}/.nuget/packages + +jobs: + build: + + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: + - ubuntu-18.04 + - macos-latest + - windows-latest + + steps: + - uses: actions/checkout@v2 + - name: Deep clone + run: git fetch --prune --unshallow origin HEAD + - name: Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites + dotnet --info + shell: pwsh + - name: Set pipeline variables based on source + run: azure-pipelines/variables/_pipelines.ps1 + shell: pwsh + - name: build + run: dotnet build src --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/build.binlog" + - name: pack + run: dotnet pack src --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" + - name: test + run: dotnet test src --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + - name: Update pipeline variables based on build outputs + run: azure-pipelines/variables/_pipelines.ps1 + shell: pwsh + - name: Collect artifacts + run: azure-pipelines/artifacts/_stage_all.ps1 + shell: pwsh + - name: Upload project.assets.json files + if: always() + uses: actions/upload-artifact@v1 + with: + name: projectAssetsJson-${{ runner.os }} + path: obj/_artifacts/projectAssetsJson + continue-on-error: true + - name: Upload variables + uses: actions/upload-artifact@v1 + with: + name: variables + path: obj/_artifacts/variables + if: runner.os == 'Windows' + continue-on-error: true + - name: Upload build_logs + if: always() + uses: actions/upload-artifact@v1 + with: + name: build_logs-${{ runner.os }} + path: obj/_artifacts/build_logs + continue-on-error: true + - name: Upload coverageResults + if: always() + uses: actions/upload-artifact@v1 + with: + name: coverageResults-${{ runner.os }} + path: obj/_artifacts/coverageResults + continue-on-error: true + - name: Upload symbols + uses: actions/upload-artifact@v1 + with: + name: symbols + path: obj/_artifacts/symbols + if: runner.os == 'Windows' + continue-on-error: true + - name: Upload deployables + uses: actions/upload-artifact@v1 + with: + name: deployables + path: obj/_artifacts/deployables + if: runner.os == 'Windows' + - name: Publish code coverage results to codecov.io + run: bash <(curl -s https://codecov.io/bash) + shell: bash + timeout-minutes: 3 + continue-on-error: true diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 5225f8785..aa4f5ec25 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -125,7 +125,8 @@ try { } Replace-Placeholders -Path "README.md" -Replacements @{ "(?m)^.*\[NuGet package\][^`r`n]*"="[![NuGet package](https://img.shields.io/nuget/v/$LibraryName.svg)](https://nuget.org/packages/$LibraryName)" - "(?m)^.*\[Build Status\].*`r?`n"="" + "(?m)^.*\[Azure Pipelines status\].*`r?`n"="" + "(?m)^.*\[GitHub Actions status\].*`r?`n"="" "(?m)^.*\[codecov\].*`r?`n"="" } diff --git a/README.md b/README.md index d05ac0d72..0c3bcf59e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ ***An awesome template for your awesome library*** ![NuGet package](https://img.shields.io/badge/nuget-your--package--here-yellow.svg) -[![Build Status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/AArnott.Library.Template?branchName=master)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=29&branchName=master) + +[![Azure Pipelines status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/AArnott.Library.Template?branchName=master)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=29&branchName=master) +![GitHub Actions status](https://github.com/aarnott/Library.Template/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/aarnott/library.template/branch/master/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) ## Features diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 2dbb2cbbd..c6eeb7b66 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -13,7 +13,6 @@ variables: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release - BuildPlatform: Any CPU codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed. Learn more at https://github.com/AArnott/Library.Template/issues/28 NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages diff --git a/azure-pipelines/Set-EnvVars.ps1 b/azure-pipelines/Set-EnvVars.ps1 index 313cecff1..907659a7b 100644 --- a/azure-pipelines/Set-EnvVars.ps1 +++ b/azure-pipelines/Set-EnvVars.ps1 @@ -10,30 +10,70 @@ [CmdletBinding(SupportsShouldProcess=$true)] Param( [Parameter(Mandatory=$true, Position=1)] - $Variables + $Variables, + [string[]]$PrependPath ) if ($Variables.Count -eq 0) { return $true } -$cmdInstructions = !$env:TF_BUILD -and $env:PS1UnderCmd -eq '1' +$cmdInstructions = !$env:TF_BUILD -and !$env:GITHUB_ACTIONS -and $env:PS1UnderCmd -eq '1' if ($cmdInstructions) { Write-Warning "Environment variables have been set that will be lost because you're running under cmd.exe" Write-Host "Environment variables that must be set manually:" -ForegroundColor Blue +} else { + Write-Host "Environment variables set:" -ForegroundColor Blue + $envVars + if ($PrependPath) { + Write-Host "Paths prepended to PATH: $PrependPath" + } +} + +if ($env:TF_BUILD) { + Write-Host "Azure Pipelines detected. Logging commands will be used to propagate environment variables and prepend path." +} + +if ($env:GITHUB_ACTIONS) { + Write-Host "GitHub Actions detected. Logging commands will be used to propagate environment variables and prepend path." } $Variables.GetEnumerator() |% { Set-Item -Path env:$($_.Key) -Value $_.Value - # If we're running in Azure Pipelines, set these environment variables + # If we're running in a cloud CI, set these environment variables so they propagate. if ($env:TF_BUILD) { Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" } + if ($env:GITHUB_ACTIONS) { + Write-Host "::set-env name=$($_.Key)::$($_.Value)" + } if ($cmdInstructions) { Write-Host "SET $($_.Key)=$($_.Value)" } } +$pathDelimiter = ';' +if ($IsMacOS -or $IsLinux) { + $pathDelimiter = ':' +} + +if ($PrependPath) { + $PrependPath |% { + $newPathValue = "$_$pathDelimiter$env:PATH" + Set-Item -Path env:PATH -Value $newPathValue + if ($cmdInstructions) { + Write-Host "SET PATH=$newPathValue" + } + + if ($env:TF_BUILD) { + Write-Host "##vso[task.prependpath]$_" + } + if ($env:GITHUB_ACTIONS) { + Write-Host "::add-path::$_" + } + } +} + return !$cmdInstructions diff --git a/azure-pipelines/artifacts/Variables.ps1 b/azure-pipelines/artifacts/Variables.ps1 index cfcb7df52..2ee09d42f 100644 --- a/azure-pipelines/artifacts/Variables.ps1 +++ b/azure-pipelines/artifacts/Variables.ps1 @@ -2,13 +2,13 @@ # It "snaps" the values of these variables where we can compute them during the build, # and otherwise captures the scripts to run later during an Azure Pipelines environment release. -$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") -$ArtifactBasePath = "$RepoRoot\obj\_artifacts" -$VariablesArtifactPath = "$ArtifactBasePath\variables" +$RepoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot (Join-Path .. ..))) +$ArtifactBasePath = Join-Path $RepoRoot (Join-Path obj _artifacts) +$VariablesArtifactPath = Join-Path $ArtifactBasePath variables if (-not (Test-Path $VariablesArtifactPath)) { New-Item -ItemType Directory -Path $VariablesArtifactPath | Out-Null } # Copy variables, either by value if the value is calculable now, or by script -Get-ChildItem -Path "$PSScriptRoot\..\variables" |% { +Get-ChildItem -Path (Join-Path $PSScriptRoot (Join-Path .. variables)) |% { $value = $null if (-not $_.BaseName.StartsWith('_')) { # Skip trying to interpret special scripts # First check the environment variables in case the variable was set in a queued build @@ -32,7 +32,7 @@ Get-ChildItem -Path "$PSScriptRoot\..\variables" |% { $value = Get-Content -Path $_.FullName } - Set-Content -Path "$VariablesArtifactPath\$($_.Name)" -Value $value + Set-Content -Path (Join-Path $VariablesArtifactPath $_.Name) -Value $value } @{ diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 7451ab111..5bca7c6c1 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -5,51 +5,6 @@ param ( [string]$ArtifactNameSuffix ) -$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") -if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { - $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY -} else { - $ArtifactStagingFolder = "$RepoRoot\obj\_artifacts" - if (Test-Path $ArtifactStagingFolder) { - Remove-Item $ArtifactStagingFolder -Recurse -Force - } -} - -function Create-SymbolicLink { - param ( - $Link, - $Target - ) - - if ($Link -eq $Target) { - return - } - - if (Test-Path $Link) { Remove-Item $Link } - $LinkContainer = Split-Path $Link -Parent - if (!(Test-Path $LinkContainer)) { mkdir $LinkContainer } - Write-Verbose "Linking $Link to $Target" - if ($IsMacOS -or $IsLinux) { - ln $Target $Link - } else { - cmd /c mklink $Link $Target - } -} - -# Stage all artifacts -$Artifacts = & "$PSScriptRoot\_all.ps1" -$Artifacts |% { - $DestinationFolder = (Join-Path (Join-Path $ArtifactStagingFolder "$($_.ArtifactName)$ArtifactNameSuffix") $_.ContainerFolder).TrimEnd('\') - $Name = "$(Split-Path $_.Source -Leaf)" - - #Write-Host "$($_.Source) -> $($_.ArtifactName)\$($_.ContainerFolder)" -ForegroundColor Yellow - - if (-not (Test-Path $DestinationFolder)) { New-Item -ItemType Directory -Path $DestinationFolder | Out-Null } - if (Test-Path -PathType Leaf $_.Source) { # skip folders - Create-SymbolicLink -Link "$DestinationFolder\$Name" -Target $_.Source - } -} - -$Artifacts |% { $_.ArtifactName } | Get-Unique |% { - Write-Host "##vso[artifact.upload containerfolder=$_$ArtifactNameSuffix;artifactname=$_$ArtifactNameSuffix;]$ArtifactStagingFolder/$_$ArtifactNameSuffix" +& "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix |% { + Write-Host "##vso[artifact.upload containerfolder=$($_.Name);artifactname=$($_.Name);]$($_.Path)" } diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 new file mode 100644 index 000000000..a05db5292 --- /dev/null +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -0,0 +1,59 @@ +# This script links all the artifacts described by _all.ps1 +# into a staging directory, reading for uploading to a cloud build artifact store. +# It returns a sequence of objects with Name and Path properties. + +param ( + [string]$ArtifactNameSuffix +) + +$RepoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot (Join-Path .. ..))) +if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { + $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY +} else { + $ArtifactStagingFolder = Join-Path $RepoRoot (Join-Path obj _artifacts) + if (Test-Path $ArtifactStagingFolder) { + Remove-Item $ArtifactStagingFolder -Recurse -Force + } +} + +function Create-SymbolicLink { + param ( + $Link, + $Target + ) + + if ($Link -eq $Target) { + return + } + + if (Test-Path $Link) { Remove-Item $Link } + $LinkContainer = Split-Path $Link -Parent + if (!(Test-Path $LinkContainer)) { mkdir $LinkContainer } + Write-Verbose "Linking $Link to $Target" + if ($IsMacOS -or $IsLinux) { + ln $Target $Link | Out-Null + } else { + cmd /c mklink $Link $Target | Out-Null + } +} + +# Stage all artifacts +$Artifacts = & "$PSScriptRoot\_all.ps1" +$Artifacts |% { + $DestinationFolder = (Join-Path (Join-Path $ArtifactStagingFolder "$($_.ArtifactName)$ArtifactNameSuffix") $_.ContainerFolder).TrimEnd('\') + $Name = "$(Split-Path $_.Source -Leaf)" + + #Write-Host "$($_.Source) -> $($_.ArtifactName)\$($_.ContainerFolder)" -ForegroundColor Yellow + + if (-not (Test-Path $DestinationFolder)) { New-Item -ItemType Directory -Path $DestinationFolder | Out-Null } + if (Test-Path -PathType Leaf $_.Source) { # skip folders + Create-SymbolicLink -Link (Join-Path $DestinationFolder $Name) -Target $_.Source + } +} + +$Artifacts |% { "$($_.ArtifactName)$ArtifactNameSuffix" } | Get-Unique |% { + $artifact = New-Object -TypeName PSObject + Add-Member -InputObject $artifact -MemberType NoteProperty -Name Name -Value $_ + Add-Member -InputObject $artifact -MemberType NoteProperty -Name Path -Value (Join-Path $ArtifactStagingFolder $_) + Write-Output $artifact +} diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 05e32a18e..e1a73d4dc 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -17,7 +17,7 @@ jobs: - job: Linux pool: - vmImage: Ubuntu 16.04 + vmImage: Ubuntu 18.04 steps: - checkout: self clean: true @@ -41,7 +41,7 @@ jobs: - Linux - macOS pool: - vmImage: Ubuntu 16.04 + vmImage: Ubuntu 18.04 condition: succeededOrFailed() steps: - checkout: self diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 9fa0c16b7..28230b817 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -5,11 +5,15 @@ # what the build would do. So only set them if they have not already been set. (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { - if (Test-Path -Path "env:$($_.Key.ToUpper())") { + if (Test-Path -Path "env:$($_.Key)") { Write-Host "Skipping setting $($_.Key) because variable is already set." -ForegroundColor Cyan } else { Write-Host "$($_.Key)=$($_.Value)" -ForegroundColor Yellow - Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" + if ($env:TF_BUILD) { + Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" + } elseif ($env:GITHUB_ACTIONS) { + Write-Host "::set-env name=$($_.Key)::$($_.Value)" + } Set-Item -Path "env:$($_.Key)" -Value $_.Value } } diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 50687706e..f29cb0a62 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -156,41 +156,5 @@ $runtimeVersions | Get-Unique |% { } if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these installed runtimes?")) { - if ($env:TF_BUILD) { - Write-Host "Azure Pipelines detected. Logging commands will be used to propagate environment variables and prepend path." - } - - if ($IsMacOS -or $IsLinux) { - $envVars['PATH'] = "${DotNetInstallDir}:$env:PATH" - } else { - $envVars['PATH'] = "$DotNetInstallDir;$env:PATH" - } - - $envVars.GetEnumerator() |% { - Set-Item -Path env:$($_.Key) -Value $_.Value - - # If we're running in Azure Pipelines, set these environment variables - if ($env:TF_BUILD) { - Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" - } - } - - if ($env:TF_BUILD) { - Write-Host "##vso[task.prependpath]$DotNetInstallDir" - } -} - -if ($env:PS1UnderCmd -eq '1') { - Write-Warning "Environment variable changes will be lost because you're running under cmd.exe. Run these commands manually:" - $envVars.GetEnumerator() |% { - if ($_.Key -eq 'PATH') { - # Special case this one for readability - Write-Host "SET PATH=$DotNetInstallDir;%PATH%" - } else { - Write-Host "SET $($_.Key)=$($_.Value)" - } - } -} else { - Write-Host "Environment variables set:" -ForegroundColor Blue - $envVars + & "$PSScriptRoot/../azure-pipelines/Set-EnvVars.ps1" -Variables $envVars -PrependPath $DotNetInstallDir | Out-Null } From ad12e4a7f4af5563a6132015340e888cd068a714 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2020 20:22:47 -0700 Subject: [PATCH 0097/1753] Simpler way to avoid shallow clone --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4e9918733..4e178096c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,8 +29,8 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Deep clone - run: git fetch --prune --unshallow origin HEAD + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: Install prerequisites run: | ./init.ps1 -UpgradePrerequisites From 2e0c3eb6f0273c6f2350eb5d4a01016dccced6a8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Jan 2020 13:49:59 -0700 Subject: [PATCH 0098/1753] Pin the compiler version Although we already pin the SDK which includes compilers, when we use msbuild.exe (including VS) to build we still get whatever compilers are on the box. Pinning the compilers has many of the same merits as pinning the SDK. --- src/Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index ddd8ae606..03a6a1c34 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -27,6 +27,7 @@ + From 45818306689ea5709b30f398e86908cf02eb1ab9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 Jan 2020 07:29:10 -0700 Subject: [PATCH 0099/1753] Set NUGET_PACKAGES in CI workflow --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4e178096c..2d71d97a8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -14,7 +14,7 @@ env: BUILDCONFIGURATION: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed. Learn more at https://github.com/AArnott/Library.Template/issues/28 -# NUGET_PACKAGES: ${{ env.GITHUB_WORKSPACE }}/.nuget/packages + NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages jobs: build: From f2a16d29d53c6bc953aeb4e4e55812de80b27697 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 21 Jan 2020 21:34:09 -0700 Subject: [PATCH 0100/1753] Update Azure Repos SourceLink reference --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 9cea46c78..86226016e 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -26,7 +26,7 @@ - + From aa77109d0aaada2d6e53b3035a9a57e4249ea35e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Feb 2020 13:45:54 -0700 Subject: [PATCH 0101/1753] Update coverlet.msbuild to 2.8.0 --- azure-pipelines/artifacts/coverageResults.ps1 | 4 ++-- azure-pipelines/publish-codecoverage.yml | 2 +- src/Library.Tests/Library.Tests.csproj | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index 7d1e9a35f..addbf85c2 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -3,7 +3,7 @@ $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") # Prepare code coverage reports for merging on another machine if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`"" - $reports = Get-ChildItem "$RepoRoot/bin/coverage.cobertura.xml" -Recurse + $reports = Get-ChildItem "$RepoRoot/bin/coverage.*.cobertura.xml" -Recurse $reports |% { $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } Set-Content -Path $_ -Value $content -Encoding UTF8 @@ -16,7 +16,7 @@ if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } @{ $RepoRoot = ( - @(Get-ChildItem "$RepoRoot\bin\coverage.cobertura.xml" -Recurse) + + @(Get-ChildItem "$RepoRoot\bin\coverage.*.cobertura.xml" -Recurse) + (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse) ); } diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 6d367de96..976f0781b 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -15,7 +15,7 @@ steps: dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" - $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.cobertura.xml" + $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.*.cobertura.xml" $reports |% { $content = Get-Content -Path $_ |% { $_.Replace("{reporoot}", "$(System.DefaultWorkingDirectory)") } Set-Content -Path $_ -Value $content -Encoding UTF8 diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index 78ebcfd4d..1cf1c1b00 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -14,7 +14,7 @@ - + From ca0811eb720026e8510a4f83813eb15019ac476c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Feb 2020 13:48:09 -0700 Subject: [PATCH 0102/1753] Update SDK package references --- src/Directory.Build.props | 2 +- src/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 03a6a1c34..9b2087273 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -26,7 +26,7 @@ - + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj index 1cf1c1b00..8018f97da 100644 --- a/src/Library.Tests/Library.Tests.csproj +++ b/src/Library.Tests/Library.Tests.csproj @@ -15,7 +15,7 @@ - + From fc25f7a1665fccf4c1cc4d574f18e22894955387 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Jan 2020 13:05:05 -0700 Subject: [PATCH 0103/1753] Remove unused ci_feed from GitHub workflow --- .github/workflows/build.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2d71d97a8..86c351641 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,6 @@ env: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BUILDCONFIGURATION: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed. Learn more at https://github.com/AArnott/Library.Template/issues/28 NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages jobs: From 5fbad730e20884725a8930a733f2490ac919c07f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 3 Feb 2020 15:53:59 -0700 Subject: [PATCH 0104/1753] Always collect artifacts, even on build failures --- .github/workflows/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 86c351641..f3e10f53a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -50,6 +50,7 @@ jobs: - name: Collect artifacts run: azure-pipelines/artifacts/_stage_all.ps1 shell: pwsh + if: always() - name: Upload project.assets.json files if: always() uses: actions/upload-artifact@v1 From ba764031a80c365dbf0182c67fda295fd89aaa5b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 25 Feb 2020 13:33:55 -0700 Subject: [PATCH 0105/1753] Use macOS-10.15 macOS 10.13 is about to be decommissioned on Azure Pipelines --- azure-pipelines/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index e1a73d4dc..186438a1b 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -27,7 +27,7 @@ jobs: - job: macOS pool: - vmImage: macOS 10.13 + vmImage: macOS-10.15 steps: - checkout: self clean: true From d54e43ed8c74c7bc243eee86717fd1fdff9f9bfb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 27 Feb 2020 23:18:59 -0700 Subject: [PATCH 0106/1753] More assuredly pin the .NET Core SDK version There's talk that the .NET SDK may change the default value for rollForward from "patch" to "latestMajor", effectively turning our "version" property to a minimum instead of a 'pin'. Setting rollForward explicitly guards against this. --- global.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/global.json b/global.json index e9aac8c22..5c8032d35 100644 --- a/global.json +++ b/global.json @@ -1,5 +1,7 @@ { "sdk": { - "version": "3.1.100" + "version": "3.1.100", + "rollForward": "latestPatch", + "allowPrerelease": false } } From e0365203f8562571e344bfeb54418ca65af08fb5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 29 Feb 2020 07:06:03 -0700 Subject: [PATCH 0107/1753] Generate msbuild properties for every restored package --- src/Directory.Build.props | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 9b2087273..5e0395b59 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,4 +1,5 @@ - + Debug $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)..\')) @@ -34,4 +35,9 @@ + + + + + From c608bf061aaa56fd21b6c2af0b950f61e5132d05 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Mar 2020 09:33:08 -0700 Subject: [PATCH 0108/1753] Only install .NET Core runtimes once per version --- tools/Install-DotNetSdk.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index f29cb0a62..0bd4082ff 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -91,7 +91,7 @@ if ($InstallLocality -eq 'machine') { Install-DotNet -Version $sdkVersion } - $runtimeVersions |% { + $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { Install-DotNet -Version $_ -Runtime } From abf3830bc939537776c45be9d437cb4b89471baf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Mar 2020 09:50:03 -0700 Subject: [PATCH 0109/1753] Add Directory.Build.rsp file --- .gitignore | 1 + Directory.Build.rsp | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 Directory.Build.rsp diff --git a/.gitignore b/.gitignore index e353101db..d060a300b 100644 --- a/.gitignore +++ b/.gitignore @@ -72,6 +72,7 @@ StyleCopReport.xml *.pgc *.pgd *.rsp +!Directory.Build.rsp *.sbr *.tlb *.tli diff --git a/Directory.Build.rsp b/Directory.Build.rsp new file mode 100644 index 000000000..9a833a034 --- /dev/null +++ b/Directory.Build.rsp @@ -0,0 +1,16 @@ +#------------------------------------------------------------------------------ +# This file contains command-line options that MSBuild will process as part of +# every build, unless the "/noautoresponse" switch is specified. +# +# MSBuild processes the options in this file first, before processing the +# options on the command line. As a result, options on the command line can +# override the options in this file. However, depending on the options being +# set, the overriding can also result in conflicts. +# +# NOTE: The "/noautoresponse" switch cannot be specified in this file, nor in +# any response file that is referenced by this file. +#------------------------------------------------------------------------------ +/nr:false +/m +/verbosity:minimal +/clp:Summary;ForceNoAlign From d3613f0e0680faa5ddcc90386a1c310d8d076b96 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2020 12:35:23 -0700 Subject: [PATCH 0110/1753] Fix ci_feed to allow for SignType.ps1 influence --- azure-pipelines/variables/ci_feed.ps1 | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/variables/ci_feed.ps1 b/azure-pipelines/variables/ci_feed.ps1 index b5530b3f1..82bad79da 100644 --- a/azure-pipelines/variables/ci_feed.ps1 +++ b/azure-pipelines/variables/ci_feed.ps1 @@ -1,4 +1,7 @@ -if ($env:SIGNTYPE -eq 'Real') { +$signType = $env:SIGNTYPE +if (!$signType) { $signType = & "$PSScriptRoot/SignType.ps1" } + +if ($signType -eq 'Real') { '09d8d03c-1ac8-456e-9274-4d2364527d99' # VSIDE-RealSigned-Release } else { 'da484c78-f942-44ef-b197-99e2a1bef53c' # VSIDE-TestSigned-Release From 3d164a2c0cfdd219930cd84db2db38051483da6d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2020 13:07:24 -0700 Subject: [PATCH 0111/1753] Fix _pipelines.ps1 to check env vars in all caps --- azure-pipelines/variables/_pipelines.ps1 | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 28230b817..14d6ffc28 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -5,15 +5,17 @@ # what the build would do. So only set them if they have not already been set. (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { - if (Test-Path -Path "env:$($_.Key)") { - Write-Host "Skipping setting $($_.Key) because variable is already set." -ForegroundColor Cyan + # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. + $keyCaps = $_.Key.ToUpper() + if (Test-Path -Path "env:$keyCaps") { + Write-Host "Skipping setting $keyCaps because variable is already set." -ForegroundColor Cyan } else { - Write-Host "$($_.Key)=$($_.Value)" -ForegroundColor Yellow + Write-Host "$keyCaps=$($_.Value)" -ForegroundColor Yellow if ($env:TF_BUILD) { - Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" + Write-Host "##vso[task.setvariable variable=$keyCaps;]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { - Write-Host "::set-env name=$($_.Key)::$($_.Value)" + Write-Host "::set-env name=$keyCaps::$($_.Value)" } - Set-Item -Path "env:$($_.Key)" -Value $_.Value + Set-Item -Path "env:$keyCaps" -Value $_.Value } } From 43d492bdd13912fca8e600824e702b527ee7c2d1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2020 13:12:28 -0700 Subject: [PATCH 0112/1753] Fix artifacts/variables.ps1 to check env vars in all caps --- azure-pipelines/artifacts/Variables.ps1 | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/artifacts/Variables.ps1 b/azure-pipelines/artifacts/Variables.ps1 index 2ee09d42f..c6330cd38 100644 --- a/azure-pipelines/artifacts/Variables.ps1 +++ b/azure-pipelines/artifacts/Variables.ps1 @@ -12,8 +12,11 @@ Get-ChildItem -Path (Join-Path $PSScriptRoot (Join-Path .. variables)) |% { $value = $null if (-not $_.BaseName.StartsWith('_')) { # Skip trying to interpret special scripts # First check the environment variables in case the variable was set in a queued build - if (Test-Path env:$($_.BaseName)) { - $value = Get-Content "env:$($_.BaseName)" + # Always use all caps for env var access because Azure Pipelines converts variables to upper-case for env vars, + # and on non-Windows env vars are case sensitive. + $envVarName = $_.BaseName.ToUpper() + if (Test-Path env:$envVarName) { + $value = Get-Content "env:$envVarName" } # If that didn't give us anything, try executing the script right now from its original position From 53448b3d6825a478d98c90af5b8fbf444ee8870a Mon Sep 17 00:00:00 2001 From: Tina Chen <43013310+xuachen@users.noreply.github.com> Date: Wed, 25 Mar 2020 15:36:12 -0700 Subject: [PATCH 0113/1753] Use agent jobname for for symbols folder --- azure-pipelines/dotnet.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 9d910d2dc..9b5a2e883 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -49,7 +49,7 @@ steps: - task: PublishSymbols@2 inputs: - SymbolsFolder: $(Build.ArtifactStagingDirectory)/symbols-Windows + SymbolsFolder: $(Build.ArtifactStagingDirectory)/symbols-$(Agent.JobName) SearchPattern: '**/*.pdb' IndexSources: false SymbolServerType: TeamServices From bdd6849d9956088b9163d771a926e1dc0a5f0b08 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 10:05:42 -0600 Subject: [PATCH 0114/1753] Update to global.json 3.1.201 --- global.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/global.json b/global.json index 5c8032d35..0275fa5c9 100644 --- a/global.json +++ b/global.json @@ -1,7 +1,7 @@ { "sdk": { - "version": "3.1.100", - "rollForward": "latestPatch", + "version": "3.1.201", + "rollForward": "patch", "allowPrerelease": false } } From 8c4c16154cf2df279e716f6921fe9cb6cd7edffb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 10:11:57 -0600 Subject: [PATCH 0115/1753] Consider test .runsettings files to be xml --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 03c2bcf34..3a833bdbb 100644 --- a/.editorconfig +++ b/.editorconfig @@ -16,7 +16,7 @@ insert_final_newline = true trim_trailing_whitespace = true # Xml project files -[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}] +[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,runsettings}] indent_size = 2 # Xml config files From 917c0492532ac0669bad1696df2b151926562d9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 10:12:41 -0600 Subject: [PATCH 0116/1753] Accommodate PathInfo as keys from artifact scripts --- azure-pipelines/artifacts/_all.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index 6f62be5c3..171b55b8f 100644 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -28,7 +28,7 @@ Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse |% { Write-Warning "No files found for the `"$ArtifactName`" artifact." } else { $fileGroups.GetEnumerator() | % { - $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key), [UriKind]::Absolute) + $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key.ToString()), [UriKind]::Absolute) $_.Value | % { if ($_.GetType() -eq [IO.FileInfo] -or $_.GetType() -eq [IO.DirectoryInfo]) { $_ = $_.FullName From 70a1f50d261b02bde5f121957c317a7cf8dbef3e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 10:29:44 -0600 Subject: [PATCH 0117/1753] Collect dumps and sequence.xml files on test hangs and crashes This makes diagnosing test runner crashes and hangs on Azure Pipelines possible. After such a failure, a testResults artifact is collected that includes the `Sequence_*.xml` and `testhost.*.dmp` files collected at the timeout or crash. These files can then be downloaded from the Azure Pipeline artifacts for study. --- azure-pipelines/Darwin.runsettings | 1 + azure-pipelines/Linux.runsettings | 1 + azure-pipelines/Windows_NT.runsettings | 14 ++++++++++++++ azure-pipelines/artifacts/testResults.ps1 | 12 ++++++++++++ azure-pipelines/dotnet.yml | 6 +++--- azure-pipelines/install-dependencies.yml | 7 +++++++ 6 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 azure-pipelines/Darwin.runsettings create mode 100644 azure-pipelines/Linux.runsettings create mode 100644 azure-pipelines/Windows_NT.runsettings create mode 100644 azure-pipelines/artifacts/testResults.ps1 diff --git a/azure-pipelines/Darwin.runsettings b/azure-pipelines/Darwin.runsettings new file mode 100644 index 000000000..b444e8196 --- /dev/null +++ b/azure-pipelines/Darwin.runsettings @@ -0,0 +1 @@ + diff --git a/azure-pipelines/Linux.runsettings b/azure-pipelines/Linux.runsettings new file mode 100644 index 000000000..b444e8196 --- /dev/null +++ b/azure-pipelines/Linux.runsettings @@ -0,0 +1 @@ + diff --git a/azure-pipelines/Windows_NT.runsettings b/azure-pipelines/Windows_NT.runsettings new file mode 100644 index 000000000..0b43ecb09 --- /dev/null +++ b/azure-pipelines/Windows_NT.runsettings @@ -0,0 +1,14 @@ + + + + + + + + + %BUILD_ARTIFACTSTAGINGDIRECTORY% + + + + + diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 new file mode 100644 index 000000000..1c9d3572d --- /dev/null +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -0,0 +1,12 @@ +if ($env:AGENT_TEMPDIRECTORY) { + # The DotNetCoreCLI uses an alternate location to publish these files + $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' + @{ + $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\testhost.*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); + } +} else { + $srcRoot = Resolve-Path "$PSScriptRoot\..\..\src" + @{ + $srcRoot = (Get-ChildItem "$srcRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File); + } +} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 9b5a2e883..0d837acbb 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -12,7 +12,7 @@ steps: displayName: dotnet test -f net472 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: net472-$(Agent.JobName) workingDirectory: src condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) @@ -21,7 +21,7 @@ steps: displayName: dotnet test -f netcoreapp2.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: netcoreapp2.1-$(Agent.JobName) workingDirectory: src @@ -29,7 +29,7 @@ steps: displayName: dotnet test -f netcoreapp3.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: netcoreapp3.1-$(Agent.JobName) workingDirectory: src diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 9257db852..a778022a0 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -8,6 +8,13 @@ steps: dotnet --info displayName: Install prerequisites +# The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. +- powershell: | + choco install procdump + Write-Host "##vso[task.setvariable variable=PROCDUMP_PATH;]$env:ProgramData\chocolatey\bin\" + displayName: Install procdump + condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) + - task: PowerShell@2 inputs: filePath: azure-pipelines/variables/_pipelines.ps1 From 941448de1f90a8abebfd487fbcfb9230f5bcdbb7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 14:51:27 -0600 Subject: [PATCH 0118/1753] Collect crash/hang dumps on GitHub Actions --- .github/workflows/Linux.runsettings | 1 + .github/workflows/Windows.runsettings | 14 ++++++++++++++ .github/workflows/build.yml | 13 ++++++++++++- .github/workflows/macOS.runsettings | 1 + 4 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/Linux.runsettings create mode 100644 .github/workflows/Windows.runsettings create mode 100644 .github/workflows/macOS.runsettings diff --git a/.github/workflows/Linux.runsettings b/.github/workflows/Linux.runsettings new file mode 100644 index 000000000..b444e8196 --- /dev/null +++ b/.github/workflows/Linux.runsettings @@ -0,0 +1 @@ + diff --git a/.github/workflows/Windows.runsettings b/.github/workflows/Windows.runsettings new file mode 100644 index 000000000..5e2244a02 --- /dev/null +++ b/.github/workflows/Windows.runsettings @@ -0,0 +1,14 @@ + + + + + + + + + %GITHUB_WORKSPACE% + + + + + diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f3e10f53a..b167b51ff 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,6 +34,10 @@ jobs: run: | ./init.ps1 -UpgradePrerequisites dotnet --info + if ($env:RUNNER_OS -eq "Windows") { + choco install procdump + Write-Host "##[set-env name=PROCDUMP_PATH;]$env:PROGRAMDATA\chocolatey\bin\" + } shell: pwsh - name: Set pipeline variables based on source run: azure-pipelines/variables/_pipelines.ps1 @@ -43,7 +47,7 @@ jobs: - name: pack run: dotnet pack src --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" - name: test - run: dotnet test src --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true + run: dotnet test src --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --settings "${{ github.workspace }}/.github/workflows/${{ runner.os }}.runsettings" - name: Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh @@ -72,6 +76,13 @@ jobs: name: build_logs-${{ runner.os }} path: obj/_artifacts/build_logs continue-on-error: true + - name: Upload testResults + if: always() + uses: actions/upload-artifact@v1 + with: + name: testResults-${{ runner.os }} + path: obj/_artifacts/testResults + continue-on-error: true - name: Upload coverageResults if: always() uses: actions/upload-artifact@v1 diff --git a/.github/workflows/macOS.runsettings b/.github/workflows/macOS.runsettings new file mode 100644 index 000000000..b444e8196 --- /dev/null +++ b/.github/workflows/macOS.runsettings @@ -0,0 +1 @@ + From 8a3f6cd5d471bc588b5eb1cf54446a297e4cd3f5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 14:58:41 -0600 Subject: [PATCH 0119/1753] Collect deployables on GitHub Actions even for failing jobs --- .github/workflows/build.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f3e10f53a..b50c56050 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -20,6 +20,7 @@ jobs: runs-on: ${{ matrix.os }} strategy: + fail-fast: false matrix: os: - ubuntu-18.04 @@ -91,7 +92,7 @@ jobs: with: name: deployables path: obj/_artifacts/deployables - if: runner.os == 'Windows' + if: always() && runner.os == 'Windows' - name: Publish code coverage results to codecov.io run: bash <(curl -s https://codecov.io/bash) shell: bash From c5581d16fedaaaf95549f1f8105a8f6a7171534d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Mar 2020 15:39:20 -0600 Subject: [PATCH 0120/1753] Fix dmp collection on Azure Pipelines --- azure-pipelines/artifacts/testResults.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index 1c9d3572d..bc9e0467e 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -2,7 +2,7 @@ if ($env:AGENT_TEMPDIRECTORY) { # The DotNetCoreCLI uses an alternate location to publish these files $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' @{ - $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\testhost.*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); + $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); } } else { $srcRoot = Resolve-Path "$PSScriptRoot\..\..\src" From ce7cd13abbdfd6b7cd0fe95c196bc82e36e7bddb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 28 Mar 2020 13:03:09 -0600 Subject: [PATCH 0121/1753] Recommend C# extension in VS Code by its new name --- .vscode/extensions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index c5b615df4..ecda668ec 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -4,7 +4,7 @@ // List of extensions which should be recommended for users of this workspace. "recommendations": [ "ms-azure-devops.azure-pipelines", - "ms-vscode.csharp", + "ms-dotnettools.csharp", "k--kato.docomment", "editorconfig.editorconfig", "pflannery.vscode-versionlens", From 426a7bd79f81f9c5dabf5e7f48fc24251e0e5577 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 28 Mar 2020 16:15:06 -0600 Subject: [PATCH 0122/1753] Update package references --- src/Directory.Build.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 5e0395b59..bdfdc2b2c 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -27,9 +27,9 @@ - - - + + + From f0b174a54640be9482a14dea28cd19c9b1cd481b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 29 Mar 2020 07:35:13 -0600 Subject: [PATCH 0123/1753] Update NB.GV This gets Omnisharp on Linux to work. --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index bdfdc2b2c..ce9c31949 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -27,7 +27,7 @@ - + From ae335995e9c2dd914b642a64084e4be0090901e6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 29 Mar 2020 19:35:18 -0600 Subject: [PATCH 0124/1753] Make ps1 scripts directly executable from linux --- azure-pipelines/artifacts/_all.ps1 | 2 ++ azure-pipelines/variables/_all.ps1 | 2 ++ init.ps1 | 2 ++ tools/Install-DotNetSdk.ps1 | 2 ++ tools/Install-NuGetCredProvider.ps1 | 2 ++ 5 files changed, 10 insertions(+) mode change 100644 => 100755 azure-pipelines/artifacts/_all.ps1 mode change 100644 => 100755 azure-pipelines/variables/_all.ps1 mode change 100644 => 100755 init.ps1 mode change 100644 => 100755 tools/Install-DotNetSdk.ps1 mode change 100644 => 100755 tools/Install-NuGetCredProvider.ps1 diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 old mode 100644 new mode 100755 index 171b55b8f..4b5442369 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/pwsh + # This script returns all the artifacts that should be collected after a build. # # Each powershell artifact is expressed as an object with these properties: diff --git a/azure-pipelines/variables/_all.ps1 b/azure-pipelines/variables/_all.ps1 old mode 100644 new mode 100755 index ed0997922..269425b56 --- a/azure-pipelines/variables/_all.ps1 +++ b/azure-pipelines/variables/_all.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/pwsh + # This script returns a hashtable of build variables that should be set # at the start of a build or release definition's execution. diff --git a/init.ps1 b/init.ps1 old mode 100644 new mode 100755 index ae4ce9a69..ac980028a --- a/init.ps1 +++ b/init.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/pwsh + <# .SYNOPSIS Installs dependencies required to build and test the projects in this repository. diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 old mode 100644 new mode 100755 index 0bd4082ff..a830dd408 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/pwsh + <# .SYNOPSIS Installs the .NET SDK specified in the global.json file at the root of this repository, diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 old mode 100644 new mode 100755 index 0a8d77f62..9e0e2fce2 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/pwsh + <# .SYNOPSIS Downloads and installs the Microsoft Artifacts Credential Provider From c2c2ec18581074f1ab53333bc97e0b2d9e9e9d51 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 29 Mar 2020 20:26:44 -0600 Subject: [PATCH 0125/1753] Use more portable #! for ps1 --- azure-pipelines/artifacts/_all.ps1 | 2 +- azure-pipelines/variables/_all.ps1 | 2 +- init.ps1 | 2 +- tools/Install-DotNetSdk.ps1 | 2 +- tools/Install-NuGetCredProvider.ps1 | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index 4b5442369..efd6bdb3e 100755 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -1,4 +1,4 @@ -#!/usr/bin/pwsh +#!/usr/bin/env pwsh # This script returns all the artifacts that should be collected after a build. # diff --git a/azure-pipelines/variables/_all.ps1 b/azure-pipelines/variables/_all.ps1 index 269425b56..0407d307e 100755 --- a/azure-pipelines/variables/_all.ps1 +++ b/azure-pipelines/variables/_all.ps1 @@ -1,4 +1,4 @@ -#!/usr/bin/pwsh +#!/usr/bin/env pwsh # This script returns a hashtable of build variables that should be set # at the start of a build or release definition's execution. diff --git a/init.ps1 b/init.ps1 index ac980028a..6701e7254 100755 --- a/init.ps1 +++ b/init.ps1 @@ -1,4 +1,4 @@ -#!/usr/bin/pwsh +#!/usr/bin/env pwsh <# .SYNOPSIS diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index a830dd408..2a444134f 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -1,4 +1,4 @@ -#!/usr/bin/pwsh +#!/usr/bin/env pwsh <# .SYNOPSIS diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index 9e0e2fce2..496dcd96a 100755 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -1,4 +1,4 @@ -#!/usr/bin/pwsh +#!/usr/bin/env pwsh <# .SYNOPSIS From cbb60159af1bd4bbe336ba677e277152bd8b050b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 30 Mar 2020 10:16:19 -0600 Subject: [PATCH 0126/1753] Add machine-wide .NET install support off Windows --- tools/Install-DotNetSdk.ps1 | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 2a444134f..101b68fe8 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -83,25 +83,6 @@ Function Install-DotNet($Version, [switch]$Runtime) { } } -if ($InstallLocality -eq 'machine') { - if ($IsMacOS -or $IsLinux) { - Write-Error "Installing the .NET Core SDK or runtime at a machine-wide location is only supported by this script on Windows." - exit 1 - } - - if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - Install-DotNet -Version $sdkVersion - } - - $runtimeVersions | Get-Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - Install-DotNet -Version $_ -Runtime - } - } - - return -} - $switches = @( '-Architecture','x64' ) @@ -110,7 +91,23 @@ $envVars = @{ 'DOTNET_SKIP_FIRST_TIME_EXPERIENCE' = 'true'; } -if ($InstallLocality -eq 'repo') { +if ($InstallLocality -eq 'machine') { + if ($IsWindows) { + if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + Install-DotNet -Version $sdkVersion + } + + $runtimeVersions | Get-Unique |% { + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + Install-DotNet -Version $_ -Runtime + } + } + + return + } else { + $DotNetInstallDir = '/usr/share/dotnet' + } +} elseif ($InstallLocality -eq 'repo') { $DotNetInstallDir = "$DotNetInstallScriptRoot/.dotnet" } elseif ($env:AGENT_TOOLSDIRECTORY) { $DotNetInstallDir = "$env:AGENT_TOOLSDIRECTORY/dotnet" From ef30ea448e502db518bbe3d245dd6b185e084ad0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Apr 2020 17:22:02 -0600 Subject: [PATCH 0127/1753] Use PowerShell Core in Azure Pipelines --- azure-pipelines/build.yml | 2 +- azure-pipelines/dotnet.yml | 12 ++++-------- azure-pipelines/expand-template.yml | 2 +- azure-pipelines/install-dependencies.yml | 10 ++++------ azure-pipelines/publish-codecoverage.yml | 2 +- 5 files changed, 11 insertions(+), 17 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 186438a1b..218e1c3d3 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -9,7 +9,7 @@ jobs: clean: true - template: install-dependencies.yml - - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' + - pwsh: '& (./azure-pipelines/Get-nbgv.ps1) cloud' displayName: Set build number - template: dotnet.yml diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 0d837acbb..0b6e3cc5b 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -33,17 +33,13 @@ steps: testRunTitle: netcoreapp3.1-$(Agent.JobName) workingDirectory: src -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true +- pwsh: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true displayName: Update pipeline variables based on build outputs condition: succeededOrFailed() -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/artifacts/_pipelines.ps1 - arguments: -ArtifactNameSuffix "-$(Agent.JobName)" +- pwsh: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" + failOnStderr: true displayName: Publish artifacts condition: succeededOrFailed() diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index 2d9ea7b30..a66a11573 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -3,7 +3,7 @@ steps: dotnet build-server shutdown git clean -fdx displayName: Cleaning repo for template expansion -- powershell: | +- pwsh: | git config user.name "test user" git config user.email "andrewarnott@gmail.com" ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index a778022a0..af97093bd 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -3,20 +3,18 @@ parameters: steps: -- powershell: | +- pwsh: | .\init.ps1 -AccessToken '$(System.AccessToken)' ${{ parameters['initArgs'] }} -UpgradePrerequisites dotnet --info displayName: Install prerequisites # The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. -- powershell: | +- pwsh: | choco install procdump Write-Host "##vso[task.setvariable variable=PROCDUMP_PATH;]$env:ProgramData\chocolatey\bin\" displayName: Install procdump condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true +- pwsh: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true displayName: Set pipeline variables based on source diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 976f0781b..080a0f60b 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -11,7 +11,7 @@ steps: artifact: coverageResults-macOS displayName: Download macOS code coverage results continueOnError: true -- powershell: | +- pwsh: | dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" From cae9277ee0851c093aac955ca82e6cb94bfe7408 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Apr 2020 18:56:36 -0600 Subject: [PATCH 0128/1753] Revert "Use PowerShell Core in Azure Pipelines" This reverts commit ef30ea448e502db518bbe3d245dd6b185e084ad0. --- azure-pipelines/build.yml | 2 +- azure-pipelines/dotnet.yml | 12 ++++++++---- azure-pipelines/expand-template.yml | 2 +- azure-pipelines/install-dependencies.yml | 10 ++++++---- azure-pipelines/publish-codecoverage.yml | 2 +- 5 files changed, 17 insertions(+), 11 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 218e1c3d3..186438a1b 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -9,7 +9,7 @@ jobs: clean: true - template: install-dependencies.yml - - pwsh: '& (./azure-pipelines/Get-nbgv.ps1) cloud' + - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' displayName: Set build number - template: dotnet.yml diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 0b6e3cc5b..0d837acbb 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -33,13 +33,17 @@ steps: testRunTitle: netcoreapp3.1-$(Agent.JobName) workingDirectory: src -- pwsh: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true +- task: PowerShell@2 + inputs: + filePath: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true displayName: Update pipeline variables based on build outputs condition: succeededOrFailed() -- pwsh: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" - failOnStderr: true +- task: PowerShell@2 + inputs: + filePath: azure-pipelines/artifacts/_pipelines.ps1 + arguments: -ArtifactNameSuffix "-$(Agent.JobName)" displayName: Publish artifacts condition: succeededOrFailed() diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index a66a11573..2d9ea7b30 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -3,7 +3,7 @@ steps: dotnet build-server shutdown git clean -fdx displayName: Cleaning repo for template expansion -- pwsh: | +- powershell: | git config user.name "test user" git config user.email "andrewarnott@gmail.com" ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index af97093bd..a778022a0 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -3,18 +3,20 @@ parameters: steps: -- pwsh: | +- powershell: | .\init.ps1 -AccessToken '$(System.AccessToken)' ${{ parameters['initArgs'] }} -UpgradePrerequisites dotnet --info displayName: Install prerequisites # The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. -- pwsh: | +- powershell: | choco install procdump Write-Host "##vso[task.setvariable variable=PROCDUMP_PATH;]$env:ProgramData\chocolatey\bin\" displayName: Install procdump condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- pwsh: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true +- task: PowerShell@2 + inputs: + filePath: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true displayName: Set pipeline variables based on source diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 080a0f60b..976f0781b 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -11,7 +11,7 @@ steps: artifact: coverageResults-macOS displayName: Download macOS code coverage results continueOnError: true -- pwsh: | +- powershell: | dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" From fbca91fdfbdbc4cced5d8a7eb2193710e3eb27e5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Apr 2020 18:57:50 -0600 Subject: [PATCH 0129/1753] Simplify syntax of Powershell tasks --- azure-pipelines/dotnet.yml | 12 ++++-------- azure-pipelines/install-dependencies.yml | 6 ++---- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 0d837acbb..71bd42e13 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -33,17 +33,13 @@ steps: testRunTitle: netcoreapp3.1-$(Agent.JobName) workingDirectory: src -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true +- powershell: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true displayName: Update pipeline variables based on build outputs condition: succeededOrFailed() -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/artifacts/_pipelines.ps1 - arguments: -ArtifactNameSuffix "-$(Agent.JobName)" +- powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" + failOnStderr: true displayName: Publish artifacts condition: succeededOrFailed() diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index a778022a0..ec9c3f56a 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -15,8 +15,6 @@ steps: displayName: Install procdump condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- task: PowerShell@2 - inputs: - filePath: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true +- powershell: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true displayName: Set pipeline variables based on source From 8441b31c2d4509873d92a28896d12955e2917f7f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Apr 2020 07:27:52 -0600 Subject: [PATCH 0130/1753] Specify nuget version to use This shields us against default version changes and service outages such as the one we just experienced. --- azure-pipelines/publish-deployables.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index a89f389fd..a4f8e593f 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -3,6 +3,11 @@ steps: displayName: Download deployables artifact: deployables-Windows +- task: NuGetToolInstaller@1 + displayName: Use NuGet 5.x + inputs: + versionSpec: 5.x + - task: NuGetCommand@2 displayName: Push packages to CI feed inputs: From 606547170822ba211cb097dcdf5e8da44f4f90e6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Apr 2020 21:34:11 -0600 Subject: [PATCH 0131/1753] Move sln file to repo root --- .github/workflows/build.yml | 6 +++--- Expand-Template.ps1 | 29 +++++++++++++---------------- src/Library.sln => Library.sln | 22 +++++++++++----------- azure-pipelines/dotnet.yml | 5 ----- azure-pipelines/expand-template.yml | 1 - init.ps1 | 2 +- 6 files changed, 28 insertions(+), 37 deletions(-) rename src/Library.sln => Library.sln (75%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8d8d7655f..55575add1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -44,11 +44,11 @@ jobs: run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - name: build - run: dotnet build src --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/build.binlog" + run: dotnet build --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/build.binlog" - name: pack - run: dotnet pack src --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" + run: dotnet pack --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" - name: test - run: dotnet test src --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --settings "${{ github.workspace }}/.github/workflows/${{ runner.os }}.runsettings" + run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --settings "${{ github.workspace }}/.github/workflows/${{ runner.os }}.runsettings" - name: Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index aa4f5ec25..6a030fc13 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -80,30 +80,27 @@ try { } # Rename project directories and solution - Set-Location src git mv Library.sln "$LibraryName.sln" - git mv Library/Library.csproj "Library/$LibraryName.csproj" - git mv Library "$LibraryName" - git mv Library.Tests/Library.Tests.csproj "Library.Tests/$LibraryName.Tests.csproj" - git mv Library.Tests "$LibraryName.Tests" + git mv src/Library/Library.csproj "src/Library/$LibraryName.csproj" + git mv src/Library "src/$LibraryName" + git mv src/Library.Tests/Library.Tests.csproj "src/Library.Tests/$LibraryName.Tests.csproj" + git mv src/Library.Tests "src/$LibraryName.Tests" # Refresh solution file both to update paths and give the projects unique GUIDs - dotnet sln remove Library/Library.csproj - dotnet sln remove Library.Tests/Library.Tests.csproj - dotnet sln add "$LibraryName" - dotnet sln add "$LibraryName.Tests" + dotnet sln remove src/Library/Library.csproj + dotnet sln remove src/Library.Tests/Library.Tests.csproj + dotnet sln add "src/$LibraryName" + dotnet sln add "src/$LibraryName.Tests" git add "$LibraryName.sln" # Update project reference in test project. Add before removal to keep the same ItemGroup in place. - dotnet add "$LibraryName.Tests" reference "$LibraryName" - dotnet remove "$LibraryName.Tests" reference Library/Library.csproj - git add "$LibraryName.Tests/$LibraryName.Tests.csproj" + dotnet add "src/$LibraryName.Tests" reference "src/$LibraryName" + dotnet remove "src/$LibraryName.Tests" reference src/Library/Library.csproj + git add "src/$LibraryName.Tests/$LibraryName.Tests.csproj" # Establish a new strong-name key - & $sn.Path -k 2048 strongname.snk - git add strongname.snk - - Set-Location .. + & $sn.Path -k 2048 src/strongname.snk + git add src/strongname.snk # Replace placeholders in source files Replace-Placeholders -Path "src/$LibraryName/Calculator.cs" -Replacements @{ diff --git a/src/Library.sln b/Library.sln similarity index 75% rename from src/Library.sln rename to Library.sln index 09dfb1fe6..d034f5b2d 100644 --- a/src/Library.sln +++ b/Library.sln @@ -3,21 +3,21 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.0.29322.22 MinimumVisualStudioVersion = 15.0.26124.0 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library", "Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library", "src\Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library.Tests", "Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library.Tests", "src\Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1CE9670B-D5FF-46A7-9D00-24E70E6ED48B}" ProjectSection(SolutionItems) = preProject - ..\.editorconfig = ..\.editorconfig - Directory.Build.props = Directory.Build.props - Directory.Build.targets = Directory.Build.targets - ..\global.json = ..\global.json - ..\nuget.config = ..\nuget.config - shipping.ruleset = shipping.ruleset - stylecop.json = stylecop.json - tests.ruleset = tests.ruleset - ..\version.json = ..\version.json + .editorconfig = .editorconfig + src\Directory.Build.props = src\Directory.Build.props + src\Directory.Build.targets = src\Directory.Build.targets + global.json = global.json + nuget.config = nuget.config + src\shipping.ruleset = src\shipping.ruleset + src\stylecop.json = src\stylecop.json + src\tests.ruleset = src\tests.ruleset + version.json = version.json EndProjectSection EndProject Global diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 71bd42e13..6764e6ecc 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -2,11 +2,9 @@ steps: - script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build - workingDirectory: src - script: dotnet pack --no-build -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/pack.binlog" displayName: dotnet pack - workingDirectory: src - task: DotNetCoreCLI@2 displayName: dotnet test -f net472 @@ -14,7 +12,6 @@ steps: command: test arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: net472-$(Agent.JobName) - workingDirectory: src condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - task: DotNetCoreCLI@2 @@ -23,7 +20,6 @@ steps: command: test arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: netcoreapp2.1-$(Agent.JobName) - workingDirectory: src - task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp3.1 @@ -31,7 +27,6 @@ steps: command: test arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: netcoreapp3.1-$(Agent.JobName) - workingDirectory: src - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index 2d9ea7b30..ed510de3e 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -11,5 +11,4 @@ steps: failOnStderr: true # TODO: Verify that all changes are staged to the git index - script: dotnet build - workingDirectory: src displayName: dotnet build (expanded template) diff --git a/init.ps1 b/init.ps1 index 6701e7254..a0c9961f3 100755 --- a/init.ps1 +++ b/init.ps1 @@ -54,7 +54,7 @@ try { if (!$NoRestore -and $PSCmdlet.ShouldProcess("NuGet packages", "Restore")) { Write-Host "Restoring NuGet packages" -ForegroundColor $HeaderColor - dotnet restore src + dotnet restore if ($lastexitcode -ne 0) { throw "Failure while restoring packages." } From 234e1da8eb8a1b077214b6e4d8dfc64edcab21b1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Apr 2020 23:06:03 -0600 Subject: [PATCH 0132/1753] Fix Install-DotNetSdk script under -WhatIf --- tools/Install-DotNetSdk.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 101b68fe8..8d77a9fe7 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -23,7 +23,7 @@ Param ( ) $DotNetInstallScriptRoot = "$PSScriptRoot/../obj/tools" -if (!(Test-Path $DotNetInstallScriptRoot)) { New-Item -ItemType Directory -Path $DotNetInstallScriptRoot | Out-Null } +if (!(Test-Path $DotNetInstallScriptRoot)) { New-Item -ItemType Directory -Path $DotNetInstallScriptRoot -WhatIf:$false | Out-Null } $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot # Look up actual required .NET Core SDK version from global.json From e9107462f142ba4c25289ef1d609378e0c2bb270 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Apr 2020 23:23:30 -0600 Subject: [PATCH 0133/1753] Avoid building on Azure Pipelines for .github folder changes --- azure-pipelines.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index c6eeb7b66..fc1b06e36 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -8,6 +8,7 @@ trigger: - doc/ - '*.md' - .vscode/ + - .github/ variables: TreatWarningsAsErrors: true From 18676a3d915d6be387f2b76e19a492c623b9930c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Apr 2020 23:14:23 -0600 Subject: [PATCH 0134/1753] Lose guid in favor of feed name Closes #28 --- azure-pipelines.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index fc1b06e36..22f8b5530 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -15,7 +15,7 @@ variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - ci_feed: /a5a3bad0-e566-4c53-be83-6458be8d1653 # find guid used by Azure DevOps Artifacts for the feed. Learn more at https://github.com/AArnott/Library.Template/issues/28 + ci_feed: CI # Azure Artifacts feed name NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages jobs: From 9c3b3fe1534bf2b05aa1b7163699590d5027b06b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Apr 2020 23:30:24 -0600 Subject: [PATCH 0135/1753] Fix build of WPF projects Fixes #22 --- src/Directory.Build.targets | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 1ddcba6f4..8f529fae9 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,4 +1,8 @@ + + + false + cobertura [xunit.*]* From 3c0c7dae0fe407097af6455adbfb4d6e8b8ba600 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Apr 2020 22:36:49 -0600 Subject: [PATCH 0136/1753] Use top-level test folder --- .editorconfig | 8 ++ Directory.Build.props | 43 ++++++++++ Directory.Build.targets | 8 ++ Expand-Template.ps1 | 22 +++--- Library.sln | 28 +++++-- azure-pipelines/artifacts/testResults.ps1 | 4 +- src/.editorconfig | 0 src/Directory.Build.props | 44 +---------- src/Directory.Build.targets | 8 +- src/Library.Tests/Library.Tests.csproj | 23 ------ src/Library/Library.csproj | 5 -- src/shipping.ruleset | 74 ------------------ src/tests.ruleset | 18 ----- src/strongname.snk => strongname.snk | Bin src/stylecop.json => stylecop.json | 0 test/.editorconfig | 28 +++++++ test/Directory.Build.props | 11 +++ test/Directory.Build.targets | 3 + .../Library.Tests/CalculatorTests.cs | 0 test/Library.Tests/Library.Tests.csproj | 14 ++++ {src => test}/Library.Tests/app.config | 0 tools/Install-DotNetSdk.ps1 | 2 +- 22 files changed, 157 insertions(+), 186 deletions(-) create mode 100644 Directory.Build.props create mode 100644 Directory.Build.targets create mode 100644 src/.editorconfig delete mode 100644 src/Library.Tests/Library.Tests.csproj delete mode 100644 src/shipping.ruleset delete mode 100644 src/tests.ruleset rename src/strongname.snk => strongname.snk (100%) rename src/stylecop.json => stylecop.json (100%) create mode 100644 test/.editorconfig create mode 100644 test/Directory.Build.props create mode 100644 test/Directory.Build.targets rename {src => test}/Library.Tests/CalculatorTests.cs (100%) create mode 100644 test/Library.Tests/Library.Tests.csproj rename {src => test}/Library.Tests/app.config (100%) diff --git a/.editorconfig b/.editorconfig index 3a833bdbb..979d170a0 100644 --- a/.editorconfig +++ b/.editorconfig @@ -155,3 +155,11 @@ csharp_new_line_before_members_in_anonymous_types = true # Blocks are allowed csharp_prefer_braces = true:silent + +[*.cs] + +# SA1130: Use lambda syntax +dotnet_diagnostic.SA1130.severity = silent + +[*.sln] +indent_style = tab diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 000000000..7a97368fc --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,43 @@ + + + Debug + $(MSBuildThisFileDirectory) + $(RepoRootPath)obj\$(MSBuildProjectName)\ + $(RepoRootPath)bin\$(MSBuildProjectName)\ + $(RepoRootPath)bin\Packages\$(Configuration)\ + 8.0 + enable + true + + true + $(MSBuildThisFileDirectory)\strongname.snk + + COMPANY-PLACEHOLDER + COMPANY-PLACEHOLDER + © COMPANY-PLACEHOLDER. All rights reserved. + MIT + true + true + true + snupkg + + + + + + + + + + + + + + + + + + + + diff --git a/Directory.Build.targets b/Directory.Build.targets new file mode 100644 index 000000000..1ddcba6f4 --- /dev/null +++ b/Directory.Build.targets @@ -0,0 +1,8 @@ + + + cobertura + [xunit.*]* + + $(OutputPath)/ + + diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 6a030fc13..9a05ececc 100644 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -83,20 +83,20 @@ try { git mv Library.sln "$LibraryName.sln" git mv src/Library/Library.csproj "src/Library/$LibraryName.csproj" git mv src/Library "src/$LibraryName" - git mv src/Library.Tests/Library.Tests.csproj "src/Library.Tests/$LibraryName.Tests.csproj" - git mv src/Library.Tests "src/$LibraryName.Tests" + git mv test/Library.Tests/Library.Tests.csproj "test/Library.Tests/$LibraryName.Tests.csproj" + git mv test/Library.Tests "test/$LibraryName.Tests" # Refresh solution file both to update paths and give the projects unique GUIDs dotnet sln remove src/Library/Library.csproj - dotnet sln remove src/Library.Tests/Library.Tests.csproj + dotnet sln remove test/Library.Tests/Library.Tests.csproj dotnet sln add "src/$LibraryName" - dotnet sln add "src/$LibraryName.Tests" + dotnet sln add "test/$LibraryName.Tests" git add "$LibraryName.sln" # Update project reference in test project. Add before removal to keep the same ItemGroup in place. - dotnet add "src/$LibraryName.Tests" reference "src/$LibraryName" - dotnet remove "src/$LibraryName.Tests" reference src/Library/Library.csproj - git add "src/$LibraryName.Tests/$LibraryName.Tests.csproj" + dotnet add "test/$LibraryName.Tests" reference "src/$LibraryName" + dotnet remove "test/$LibraryName.Tests" reference src/Library/Library.csproj + git add "test/$LibraryName.Tests/$LibraryName.Tests.csproj" # Establish a new strong-name key & $sn.Path -k 2048 src/strongname.snk @@ -107,17 +107,17 @@ try { 'Library'=$LibraryName 'COMPANY-PLACEHOLDER'=$Author } - Replace-Placeholders -Path "src/$LibraryName.Tests/CalculatorTests.cs" -Replacements @{ + Replace-Placeholders -Path "test/$LibraryName.Tests/CalculatorTests.cs" -Replacements @{ 'Library'=$LibraryName 'COMPANY-PLACEHOLDER'=$Author } Replace-Placeholders -Path "LICENSE" -Replacements @{ 'COMPANY-PLACEHOLDER'=$Author } - Replace-Placeholders -Path "src/stylecop.json" -Replacements @{ + Replace-Placeholders -Path "stylecop.json" -Replacements @{ 'COMPANY-PLACEHOLDER'=$Author } - Replace-Placeholders -Path "src/Directory.Build.props" -Replacements @{ + Replace-Placeholders -Path "Directory.Build.props" -Replacements @{ 'COMPANY-PLACEHOLDER'=$Author } Replace-Placeholders -Path "README.md" -Replacements @{ @@ -174,4 +174,4 @@ try { } # When testing this script, all the changes can be quickly reverted with this command: -# git reset HEAD :/README.md :/LICENSE :/azure-pipelines.yml :/src :/azure-pipelines; git co -- :/README.md :/LICENSE :/azure-pipelines.yml :/src :/azure-pipelines; git clean -fd :/src +# git reset HEAD :/README.md :/LICENSE :/azure-pipelines.yml :/src :/test :/azure-pipelines; git co -- :/README.md :/LICENSE :/azure-pipelines.yml :/src :/azure-pipelines; git clean -fd :/src :/test diff --git a/Library.sln b/Library.sln index d034f5b2d..85b8939d8 100644 --- a/Library.sln +++ b/Library.sln @@ -5,21 +5,33 @@ VisualStudioVersion = 16.0.29322.22 MinimumVisualStudioVersion = 15.0.26124.0 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library", "src\Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library.Tests", "src\Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library.Tests", "test\Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1CE9670B-D5FF-46A7-9D00-24E70E6ED48B}" ProjectSection(SolutionItems) = preProject .editorconfig = .editorconfig - src\Directory.Build.props = src\Directory.Build.props - src\Directory.Build.targets = src\Directory.Build.targets + Directory.Build.props = Directory.Build.props + Directory.Build.targets = Directory.Build.targets global.json = global.json nuget.config = nuget.config - src\shipping.ruleset = src\shipping.ruleset - src\stylecop.json = src\stylecop.json - src\tests.ruleset = src\tests.ruleset + stylecop.json = stylecop.json version.json = version.json EndProjectSection EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{9E154A29-1796-4B85-BD81-B6A385D8FF71}" + ProjectSection(SolutionItems) = preProject + src\.editorconfig = src\.editorconfig + src\Directory.Build.props = src\Directory.Build.props + src\Directory.Build.targets = src\Directory.Build.targets + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{36CCE840-6FE5-4DB9-A8D5-8CF3CB6D342A}" + ProjectSection(SolutionItems) = preProject + test\.editorconfig = test\.editorconfig + test\Directory.Build.props = test\Directory.Build.props + test\Directory.Build.targets = test\Directory.Build.targets + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -38,6 +50,10 @@ Global GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {9E154A29-1796-4B85-BD81-B6A385D8FF71} = {1CE9670B-D5FF-46A7-9D00-24E70E6ED48B} + {36CCE840-6FE5-4DB9-A8D5-8CF3CB6D342A} = {1CE9670B-D5FF-46A7-9D00-24E70E6ED48B} + EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {E3944F6A-384B-4B0F-B93F-3BD513DC57BD} EndGlobalSection diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index bc9e0467e..1e4c4c4e2 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -5,8 +5,8 @@ if ($env:AGENT_TEMPDIRECTORY) { $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); } } else { - $srcRoot = Resolve-Path "$PSScriptRoot\..\..\src" + $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" @{ - $srcRoot = (Get-ChildItem "$srcRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File); + $testRoot = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File); } } diff --git a/src/.editorconfig b/src/.editorconfig new file mode 100644 index 000000000..e69de29bb diff --git a/src/Directory.Build.props b/src/Directory.Build.props index ce9c31949..50b6409ef 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,43 +1,7 @@ - - - Debug - $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)..\')) - $(RepoRootPath)obj\$(MSBuildProjectName)\ - $(RepoRootPath)bin\$(MSBuildProjectName)\ - $(RepoRootPath)bin\Packages\$(Configuration)\ - 8.0 - enable - true - - true - $(MSBuildThisFileDirectory)\strongname.snk + + - COMPANY-PLACEHOLDER - COMPANY-PLACEHOLDER - © COMPANY-PLACEHOLDER. All rights reserved. - MIT - true - true - true - snupkg + + netstandard2.0 - - - - - - - - - - - - - - - - - - diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 8f529fae9..ada766550 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -3,10 +3,6 @@ false - - cobertura - [xunit.*]* - - $(OutputPath)/ - + + diff --git a/src/Library.Tests/Library.Tests.csproj b/src/Library.Tests/Library.Tests.csproj deleted file mode 100644 index 8018f97da..000000000 --- a/src/Library.Tests/Library.Tests.csproj +++ /dev/null @@ -1,23 +0,0 @@ - - - - net472;netcoreapp2.1;netcoreapp3.1 - false - $(NoWarn);CS1591 - true - ..\tests.ruleset - - - - - - - - - - - - - - - diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index ae6eca97c..61718a1f8 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,8 +1,3 @@ - - netstandard2.0 - ..\shipping.ruleset - - diff --git a/src/shipping.ruleset b/src/shipping.ruleset deleted file mode 100644 index 729035460..000000000 --- a/src/shipping.ruleset +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/src/tests.ruleset b/src/tests.ruleset deleted file mode 100644 index a13659760..000000000 --- a/src/tests.ruleset +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/src/strongname.snk b/strongname.snk similarity index 100% rename from src/strongname.snk rename to strongname.snk diff --git a/src/stylecop.json b/stylecop.json similarity index 100% rename from src/stylecop.json rename to stylecop.json diff --git a/test/.editorconfig b/test/.editorconfig new file mode 100644 index 000000000..eac6d8ae5 --- /dev/null +++ b/test/.editorconfig @@ -0,0 +1,28 @@ +[*.cs] + +# SA1600: Elements should be documented +dotnet_diagnostic.SA1600.severity = silent + +# SA1601: Partial elements should be documented +dotnet_diagnostic.SA1601.severity = silent + +# SA1602: Enumeration items should be documented +dotnet_diagnostic.SA1602.severity = silent + +# SA1615: Element return value should be documented +dotnet_diagnostic.SA1615.severity = silent + +# VSTHRD103: Call async methods when in an async method +dotnet_diagnostic.VSTHRD103.severity = silent + +# VSTHRD111: Use .ConfigureAwait(bool) +dotnet_diagnostic.VSTHRD111.severity = none + +# VSTHRD200: Use Async suffix for async methods +dotnet_diagnostic.VSTHRD200.severity = silent + +# CA1303: Do not pass literals as localized parameters +dotnet_diagnostic.CA1303.severity = none + +# CS1591: Missing XML comment for publicly visible type or member +dotnet_diagnostic.CS1591.severity = silent diff --git a/test/Directory.Build.props b/test/Directory.Build.props new file mode 100644 index 000000000..66b41d56b --- /dev/null +++ b/test/Directory.Build.props @@ -0,0 +1,11 @@ + + + + + net472;netcoreapp2.1;netcoreapp3.1 + false + true + + + + diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets new file mode 100644 index 000000000..6a5a72c2d --- /dev/null +++ b/test/Directory.Build.targets @@ -0,0 +1,3 @@ + + + diff --git a/src/Library.Tests/CalculatorTests.cs b/test/Library.Tests/CalculatorTests.cs similarity index 100% rename from src/Library.Tests/CalculatorTests.cs rename to test/Library.Tests/CalculatorTests.cs diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj new file mode 100644 index 000000000..6113925a2 --- /dev/null +++ b/test/Library.Tests/Library.Tests.csproj @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/src/Library.Tests/app.config b/test/Library.Tests/app.config similarity index 100% rename from src/Library.Tests/app.config rename to test/Library.Tests/app.config diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 8d77a9fe7..7f9bf6cdc 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -31,7 +31,7 @@ $sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1 # Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() -Get-ChildItem "$PSScriptRoot\..\src\*.*proj" -Recurse |% { +Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { $projXml = [xml](Get-Content -Path $_) $targetFrameworks = $projXml.Project.PropertyGroup.TargetFramework if (!$targetFrameworks) { From acda37b47951338b6c06a579a49e6215ce5bc586 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 10 Apr 2020 09:14:13 -0600 Subject: [PATCH 0137/1753] Add -y switch to choco install Fixes #47 --- .github/workflows/build.yml | 2 +- azure-pipelines/install-dependencies.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 55575add1..4ea0df364 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -36,7 +36,7 @@ jobs: ./init.ps1 -UpgradePrerequisites dotnet --info if ($env:RUNNER_OS -eq "Windows") { - choco install procdump + choco install procdump -y Write-Host "##[set-env name=PROCDUMP_PATH;]$env:PROGRAMDATA\chocolatey\bin\" } shell: pwsh diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index ec9c3f56a..d48048666 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -10,7 +10,7 @@ steps: # The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. - powershell: | - choco install procdump + choco install procdump -y Write-Host "##vso[task.setvariable variable=PROCDUMP_PATH;]$env:ProgramData\chocolatey\bin\" displayName: Install procdump condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) From fd029d44e16358417a3e30cacc159f2efb9f5da0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Apr 2020 07:50:02 -0600 Subject: [PATCH 0138/1753] Stop passing $(System.AccessToken) as an arg in AzP Fixes #49 --- azure-pipelines/install-dependencies.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index d48048666..96917c4f3 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -4,7 +4,7 @@ parameters: steps: - powershell: | - .\init.ps1 -AccessToken '$(System.AccessToken)' ${{ parameters['initArgs'] }} -UpgradePrerequisites + .\init.ps1 ${{ parameters['initArgs'] }} -UpgradePrerequisites dotnet --info displayName: Install prerequisites From f45370dbf3dc173e09d8738e462a81431bd7c70b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Apr 2020 09:42:24 -0600 Subject: [PATCH 0139/1753] Fix Set-EnvVars to print vars to console When run in the context of init.ps1, they were just swallowed up. Also we should only return a boolean. Outputing more than that will cause callers to malfunction. --- azure-pipelines/Set-EnvVars.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Set-EnvVars.ps1 b/azure-pipelines/Set-EnvVars.ps1 index 907659a7b..9d14d9aa0 100644 --- a/azure-pipelines/Set-EnvVars.ps1 +++ b/azure-pipelines/Set-EnvVars.ps1 @@ -24,7 +24,7 @@ if ($cmdInstructions) { Write-Host "Environment variables that must be set manually:" -ForegroundColor Blue } else { Write-Host "Environment variables set:" -ForegroundColor Blue - $envVars + Write-Host ($Variables | Out-String) if ($PrependPath) { Write-Host "Paths prepended to PATH: $PrependPath" } From e9dcc410b3a0cc01d48927253a66e9e3e8eb0a21 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Apr 2020 09:44:37 -0600 Subject: [PATCH 0140/1753] Acquire procdump via nuget Just using nuget instead of choco makes it take less than 1 second instead of nearly a minute. It also removes the requirement for chocolatey to be installed on AzP agents, which helps compatibility with custom/private agents. Also move it to init.ps1 so it doesn't require a special AzP or GitHub Actions task and it canl run on local dev boxes. --- .github/workflows/build.yml | 4 ---- azure-pipelines/Get-ProcDump.ps1 | 14 ++++++++++++++ azure-pipelines/install-dependencies.yml | 7 ------- init.ps1 | 10 ++++++++++ 4 files changed, 24 insertions(+), 11 deletions(-) create mode 100644 azure-pipelines/Get-ProcDump.ps1 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4ea0df364..91040d811 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -35,10 +35,6 @@ jobs: run: | ./init.ps1 -UpgradePrerequisites dotnet --info - if ($env:RUNNER_OS -eq "Windows") { - choco install procdump -y - Write-Host "##[set-env name=PROCDUMP_PATH;]$env:PROGRAMDATA\chocolatey\bin\" - } shell: pwsh - name: Set pipeline variables based on source run: azure-pipelines/variables/_pipelines.ps1 diff --git a/azure-pipelines/Get-ProcDump.ps1 b/azure-pipelines/Get-ProcDump.ps1 new file mode 100644 index 000000000..1493fe4b2 --- /dev/null +++ b/azure-pipelines/Get-ProcDump.ps1 @@ -0,0 +1,14 @@ +<# +.SYNOPSIS +Downloads 32-bit and 64-bit procdump executables and returns the path to where they were installed. +#> +$version = '0.0.1' +$baseDir = "$PSScriptRoot\..\obj\tools" +$procDumpToolPath = "$baseDir\procdump.$version\bin" +if (-not (Test-Path $procDumpToolPath)) { + if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } + $baseDir = (Resolve-Path $baseDir).Path # Normalize it + & (& $PSScriptRoot\Get-NuGetTool.ps1) install procdump -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://api.nuget.org/v3/index.json | Out-Null +} + +(Resolve-Path $procDumpToolPath).Path diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 96917c4f3..51cf839d4 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -8,13 +8,6 @@ steps: dotnet --info displayName: Install prerequisites -# The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. -- powershell: | - choco install procdump -y - Write-Host "##vso[task.setvariable variable=PROCDUMP_PATH;]$env:ProgramData\chocolatey\bin\" - displayName: Install procdump - condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: Set pipeline variables based on source diff --git a/init.ps1 b/init.ps1 index a0c9961f3..ca0d718a3 100755 --- a/init.ps1 +++ b/init.ps1 @@ -39,9 +39,17 @@ Param ( [string]$AccessToken ) +$EnvVars = @{} + if (!$NoPrerequisites) { & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken -Force:$UpgradePrerequisites & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality + + # The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. + # But it only works on Windows. + if ($env:OS -eq 'Windows_NT') { + $EnvVars['PROCDUMP_PATH'] = & "$PSScriptRoot\azure-pipelines\Get-ProcDump.ps1" + } } # Workaround nuget credential provider bug that causes very unreliable package restores on Azure Pipelines @@ -59,6 +67,8 @@ try { throw "Failure while restoring packages." } } + + & "$PSScriptRoot\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars | Out-Null } catch { Write-Error $error[0] From e5347ab78aada5c9401f35fe6d16b3b5569b0cc6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Apr 2020 11:54:51 -0600 Subject: [PATCH 0141/1753] Update README file --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0c3bcf59e..32a67820a 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,22 @@ ## Features * Follow the best and simplest patterns of build, pack and test with dotnet CLI. +* Init script that installs prerequisites and auth helpers, supporting both non-elevation and elevation modes. * Static analyzers: [FxCop](https://docs.microsoft.com/en-us/visualstudio/code-quality/fxcop-analyzers?view=vs-2019) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) * Read-only source tree (builds to top-level bin/obj folders) * Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/aarnott/nerdbank.gitversioning)) -* Azure Pipeline via YAML with all dependencies declared for long-term serviceability. -* Testing on .NET Framework, multiple .NET Core versions -* Testing on Windows, Linux and OSX -* Code coverage published to Azure Pipelines -* Code coverage published to codecov.io so GitHub PRs get code coverage results added as a PR comment +* Builds with a "pinned" .NET Core SDK to ensure reproducible builds across machines and across time. +* Automatically pack the library and publish it as an artifact, and even push it to some NuGet feed for consumption. +* Testing + * Testing on .NET Framework, multiple .NET Core versions + * Testing on Windows, Linux and OSX + * Tests that crash or hang in Azure Pipelines automatically collect dumps and publish as a pipeline artifact for later investigation. +* Cloud build support: + * YAML based build for long-term serviceability, and PR review opportunities for any changes. + * Azure Pipelines and GitHub Action support + * Emphasis on PowerShell scripts over reliance on tasks for a more locally reproducible build. + * Code coverage published to Azure Pipelines + * Code coverage published to codecov.io so GitHub PRs get code coverage results added as a PR comment ## Consumption From b38ffc731de6cd80b20e1f5f612bb5c2b8ce1055 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Apr 2020 11:56:47 -0600 Subject: [PATCH 0142/1753] touchup readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32a67820a..e235ca648 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ * Testing on .NET Framework, multiple .NET Core versions * Testing on Windows, Linux and OSX * Tests that crash or hang in Azure Pipelines automatically collect dumps and publish as a pipeline artifact for later investigation. -* Cloud build support: +* Cloud build support * YAML based build for long-term serviceability, and PR review opportunities for any changes. * Azure Pipelines and GitHub Action support * Emphasis on PowerShell scripts over reliance on tasks for a more locally reproducible build. From 091601252d2dfefb66e63da77295dbc853013e79 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Apr 2020 12:02:32 -0600 Subject: [PATCH 0143/1753] Bring back access tokens for AzP feed access Fixes #49 (properly) --- azure-pipelines/install-dependencies.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 51cf839d4..5b1ac4afd 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -4,7 +4,8 @@ parameters: steps: - powershell: | - .\init.ps1 ${{ parameters['initArgs'] }} -UpgradePrerequisites + $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors + .\init.ps1 -AccessToken $AccessToken ${{ parameters['initArgs'] }} -UpgradePrerequisites dotnet --info displayName: Install prerequisites From ce6f1d1170dfff88bc1f6f44095442f75bd94e2d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 Apr 2020 12:10:46 -0600 Subject: [PATCH 0144/1753] Update link to NB.GV --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e235ca648..5424ff0a0 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ * Init script that installs prerequisites and auth helpers, supporting both non-elevation and elevation modes. * Static analyzers: [FxCop](https://docs.microsoft.com/en-us/visualstudio/code-quality/fxcop-analyzers?view=vs-2019) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) * Read-only source tree (builds to top-level bin/obj folders) -* Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/aarnott/nerdbank.gitversioning)) +* Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/dotnet/nerdbank.gitversioning)) * Builds with a "pinned" .NET Core SDK to ensure reproducible builds across machines and across time. * Automatically pack the library and publish it as an artifact, and even push it to some NuGet feed for consumption. * Testing From fa4481025d591efbcc7635fa36e990c7cef07596 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 Apr 2020 22:44:25 -0600 Subject: [PATCH 0145/1753] Use SignType parameter instead of variable --- azure-pipelines.yml | 2 ++ azure-pipelines/build.yml | 7 ++++++- azure-pipelines/microbuild.before.yml | 5 ++++- azure-pipelines/official.yml | 9 +++++++++ azure-pipelines/variables/SignType.ps1 | 3 --- azure-pipelines/variables/ci_feed.ps1 | 5 +---- 6 files changed, 22 insertions(+), 9 deletions(-) delete mode 100644 azure-pipelines/variables/SignType.ps1 diff --git a/azure-pipelines.yml b/azure-pipelines.yml index e590031a6..a8a143bbd 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -20,3 +20,5 @@ variables: jobs: - template: azure-pipelines/build.yml + parameters: + SignType: diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index b327a94e6..12298dfe3 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -1,5 +1,8 @@ parameters: - windowsPool: Hosted Windows 2019 with VS2019 +- name: windowsPool + type: string + default: Hosted Windows 2019 with VS2019 +- name: SignType jobs: - job: Windows @@ -14,6 +17,8 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.before.yml + parameters: + SignType: ${{ parameters.SignType }} - template: dotnet.yml diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index b1efae6e9..07fadebfd 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,6 +1,9 @@ +parameters: +- name: SignType + steps: - task: MicroBuildSigningPlugin@2 inputs: - signType: $(SignType) + signType: ${{ parameters.SignType }} zipSources: false displayName: Install MicroBuild Signing Plugin diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index d002dbb34..3126dc971 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -10,6 +10,13 @@ trigger: - '*.md' - .vscode/ +parameters: +- name: SignType + displayName: Sign type + type: string + default: Test + values: [ 'Test', 'Real' ] + variables: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true @@ -17,8 +24,10 @@ variables: BuildPlatform: Any CPU push_to_ci: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + SignType: ${{ parameters.SignType }} jobs: - template: build.yml parameters: windowsPool: VSEng-MicroBuildVS2019 + SignType: ${{ parameters.SignType }} diff --git a/azure-pipelines/variables/SignType.ps1 b/azure-pipelines/variables/SignType.ps1 deleted file mode 100644 index 7d3a4729a..000000000 --- a/azure-pipelines/variables/SignType.ps1 +++ /dev/null @@ -1,3 +0,0 @@ -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9') { - 'test' -} diff --git a/azure-pipelines/variables/ci_feed.ps1 b/azure-pipelines/variables/ci_feed.ps1 index 82bad79da..b5530b3f1 100644 --- a/azure-pipelines/variables/ci_feed.ps1 +++ b/azure-pipelines/variables/ci_feed.ps1 @@ -1,7 +1,4 @@ -$signType = $env:SIGNTYPE -if (!$signType) { $signType = & "$PSScriptRoot/SignType.ps1" } - -if ($signType -eq 'Real') { +if ($env:SIGNTYPE -eq 'Real') { '09d8d03c-1ac8-456e-9274-4d2364527d99' # VSIDE-RealSigned-Release } else { 'da484c78-f942-44ef-b197-99e2a1bef53c' # VSIDE-TestSigned-Release From ebb0cb39f8ba823761693db82e7e0e509e080df2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 19 Apr 2020 10:10:43 -0600 Subject: [PATCH 0146/1753] Make Expand-Template.ps1 executable on linux --- Expand-Template.ps1 | 2 ++ 1 file changed, 2 insertions(+) mode change 100644 => 100755 Expand-Template.ps1 diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 old mode 100644 new mode 100755 index 9a05ececc..84b96680e --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/env pwsh + <# .SYNOPSIS Expands this template into an actual project, taking values for placeholders From 7688576a6aa2badce32e092a66708b0a4f452875 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 19 Apr 2020 10:13:23 -0600 Subject: [PATCH 0147/1753] Remove line that doesn't work on pwsh --- Expand-Template.ps1 | 1 - 1 file changed, 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 84b96680e..dc53d1c15 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -148,7 +148,6 @@ try { Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements # Self destruct - $Invocation = (Get-Variable MyInvocation -Scope 1).Value git rm Expand-Template.* git rm :/azure-pipelines/expand-template.yml From 35cd5a2502d02cf0ba3e0141b7156403bf0b49e0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 19 Apr 2020 10:34:22 -0600 Subject: [PATCH 0148/1753] Move test project authoring into test folder --- Directory.Build.targets | 6 ------ test/Directory.Build.targets | 7 +++++++ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/Directory.Build.targets b/Directory.Build.targets index 1ddcba6f4..8c119d541 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -1,8 +1,2 @@ - - cobertura - [xunit.*]* - - $(OutputPath)/ - diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index 6a5a72c2d..c48559e72 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,3 +1,10 @@ + + cobertura + [xunit.*]* + + $(OutputPath)/ + + From 498b5e6a34037dca15b629a07ef0d05908fc6782 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 Apr 2020 12:19:03 -0600 Subject: [PATCH 0149/1753] Authorize feeds in all nuget.config files throughout the repo --- tools/Install-NuGetCredProvider.ps1 | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index 496dcd96a..2b3fb6fb4 100755 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -46,14 +46,20 @@ if ($IsMacOS -or $IsLinux) { if ($AccessToken) { $endpoints = @() - $nugetConfig = [xml](Get-Content -Path "$PSScriptRoot\..\nuget.config") + $endpointURIs = @() + Get-ChildItem "$PSScriptRoot\..\nuget.config" -Recurse |% { + $nugetConfig = [xml](Get-Content -Path $_) - $nugetConfig.configuration.packageSources.add |? { ($_.value -match '^https://pkgs\.dev\.azure\.com/') -or ($_.value -match '^https://[\w\-]+\.pkgs\.visualstudio\.com/') } |% { - $endpoint = New-Object -TypeName PSObject - Add-Member -InputObject $endpoint -MemberType NoteProperty -Name endpoint -Value $_.value - Add-Member -InputObject $endpoint -MemberType NoteProperty -Name username -Value ado - Add-Member -InputObject $endpoint -MemberType NoteProperty -Name password -Value $AccessToken - $endpoints += $endpoint + $nugetConfig.configuration.packageSources.add |? { ($_.value -match '^https://pkgs\.dev\.azure\.com/') -or ($_.value -match '^https://[\w\-]+\.pkgs\.visualstudio\.com/') } |% { + if ($endpointURIs -notcontains $_.Value) { + $endpointURIs += $_.Value + $endpoint = New-Object -TypeName PSObject + Add-Member -InputObject $endpoint -MemberType NoteProperty -Name endpoint -Value $_.value + Add-Member -InputObject $endpoint -MemberType NoteProperty -Name username -Value ado + Add-Member -InputObject $endpoint -MemberType NoteProperty -Name password -Value $AccessToken + $endpoints += $endpoint + } + } } $auth = New-Object -TypeName PSObject From ddccc9105d88680362b8d59de699dfec0ce94bce Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Apr 2020 09:36:52 -0600 Subject: [PATCH 0150/1753] Fix conditional imports so they skip import on linux --- src/Directory.Build.props | 2 +- src/Directory.Build.targets | 2 +- test/Directory.Build.props | 2 +- test/Directory.Build.targets | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 50b6409ef..165d2ddd4 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,5 +1,5 @@ - + netstandard2.0 diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index ada766550..c1ce36344 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -4,5 +4,5 @@ false - + diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 66b41d56b..b48b5d81a 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -1,5 +1,5 @@ - + net472;netcoreapp2.1;netcoreapp3.1 diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index c48559e72..2faab3754 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -6,5 +6,5 @@ $(OutputPath)/ - + From a67e84559d64cf88a38e01c95e7f59a41104787d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Apr 2020 09:38:05 -0600 Subject: [PATCH 0151/1753] Reorder the docs to make more sense --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0893b308e..2102ba9b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,9 @@ with any additional questions or comments. ## Prerequisites +All dependencies can be installed by running the `init.ps1` script at the root of the repository +using Windows PowerShell or [PowerShell Core][pwsh] (on any OS). + The only prerequisite for building, testing, and deploying from this repository is the [.NET SDK](https://get.dot.net/). You should install the version specified in `global.json` or a later version within @@ -22,11 +25,6 @@ For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.31 while the 2.2.400 version would not be considered compatible by .NET SDK. See [.NET Core Versioning](https://docs.microsoft.com/en-us/dotnet/core/versions/) for more information. -All dependencies can be installed by running the `init.ps1` script at the root of the repository -using Windows PowerShell or [PowerShell Core][pwsh] (on any OS). - -This repository can be built on Windows, Linux, and OSX. - ## Package restore The easiest way to restore packages may be to run `init.ps1` which automatically authenticates @@ -35,6 +33,8 @@ to the feeds that packages for this repo come from, if any. ## Building +This repository can be built on Windows, Linux, and OSX. + Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). [pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-6 From e649d82e01088d680a1182a49697e5dfa892a553 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Apr 2020 09:38:25 -0600 Subject: [PATCH 0152/1753] Update dependencies --- test/Library.Tests/Library.Tests.csproj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 6113925a2..28433bf5c 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -5,8 +5,8 @@ - - + + From 8c54c69baede3744b4e8f8ed3d72b7115bdffc3b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 May 2020 09:40:52 -0600 Subject: [PATCH 0153/1753] Reduce certain rule severities in test projects --- test/.editorconfig | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/test/.editorconfig b/test/.editorconfig index eac6d8ae5..89195ddae 100644 --- a/test/.editorconfig +++ b/test/.editorconfig @@ -26,3 +26,15 @@ dotnet_diagnostic.CA1303.severity = none # CS1591: Missing XML comment for publicly visible type or member dotnet_diagnostic.CS1591.severity = silent + +# CA1707: Identifiers should not contain underscores +dotnet_diagnostic.CA1707.severity = silent + +# CA1062: Validate arguments of public methods +dotnet_diagnostic.CA1062.severity = suggestion + +# CA1063: Implement IDisposable Correctly +dotnet_diagnostic.CA1063.severity = silent + +# CA1816: Dispose methods should call SuppressFinalize +dotnet_diagnostic.CA1816.severity = silent From 76eadc7926fc96ebc71e61988d2ee4516b34d73a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 May 2020 09:40:59 -0600 Subject: [PATCH 0154/1753] Add README as solution item --- Library.sln | 1 + 1 file changed, 1 insertion(+) diff --git a/Library.sln b/Library.sln index 85b8939d8..606811aaf 100644 --- a/Library.sln +++ b/Library.sln @@ -14,6 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Directory.Build.targets = Directory.Build.targets global.json = global.json nuget.config = nuget.config + README.md = README.md stylecop.json = stylecop.json version.json = version.json EndProjectSection From 160569a53024729c70b014fcad3c005e05a11ad2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 May 2020 09:35:59 -0600 Subject: [PATCH 0155/1753] Update package references --- Directory.Build.props | 6 +++--- test/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 7a97368fc..9c119f372 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,11 +24,11 @@ - + - - + + diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 28433bf5c..29ac7bf82 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -6,7 +6,7 @@ - + From 6d120a6a222577b239671d0f14f89bd5c63dbb59 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 May 2020 09:56:20 -0600 Subject: [PATCH 0156/1753] Update SDK to 3.1.300 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 0275fa5c9..0200a660d 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.201", + "version": "3.1.300", "rollForward": "patch", "allowPrerelease": false } From ecbb92cd2f3022bb408014c8394869c8f9ed20a2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 May 2020 10:20:17 -0600 Subject: [PATCH 0157/1753] Quote arguments to mklink This prevents breaks when the linked paths contain spaces, commas or other characters. --- azure-pipelines/artifacts/_stage_all.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index a05db5292..4e6a6dbe0 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -33,7 +33,7 @@ function Create-SymbolicLink { if ($IsMacOS -or $IsLinux) { ln $Target $Link | Out-Null } else { - cmd /c mklink $Link $Target | Out-Null + cmd /c "mklink `"$Link`" `"$Target`"" | Out-Null } } From 860402b0b5cd59f44ca392c4ae42d38013eb637f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Jun 2020 15:23:03 -0600 Subject: [PATCH 0158/1753] Fix Install-DotNetSdk.ps1 script on Windows PowerShell It misinterpreted it as a Mac/Linux environment under Windows Powershell. It only worked as-is under PowerShell Core, where `$IsWindows` is defined. --- tools/Install-DotNetSdk.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 7f9bf6cdc..a13638ae7 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -92,7 +92,9 @@ $envVars = @{ } if ($InstallLocality -eq 'machine') { - if ($IsWindows) { + if ($IsMacOS -or $IsLinux) { + $DotNetInstallDir = '/usr/share/dotnet' + } else { if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { Install-DotNet -Version $sdkVersion } @@ -104,8 +106,6 @@ if ($InstallLocality -eq 'machine') { } return - } else { - $DotNetInstallDir = '/usr/share/dotnet' } } elseif ($InstallLocality -eq 'repo') { $DotNetInstallDir = "$DotNetInstallScriptRoot/.dotnet" From 3c97ead14af585787a0cc41040dbb8e7077c5f9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jun 2020 07:17:00 -0600 Subject: [PATCH 0159/1753] Update .NET Core SDK version to 3.1.301 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 0200a660d..11833de02 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.300", + "version": "3.1.301", "rollForward": "patch", "allowPrerelease": false } From bc3f88d11b10f7f34769ad7af884a3eb9cb66fe9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jun 2020 07:09:02 -0600 Subject: [PATCH 0160/1753] Avoid unannounced system restart When installing the .NET SDK or runtime, if the installer wants a system restart, it would do so quietly. This avoids the restart but adds a prompt at the end of the script to inform the user of a restart being required when necessary. Fixes #57 --- init.ps1 | 3 +++ tools/Install-DotNetSdk.ps1 | 14 ++++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/init.ps1 b/init.ps1 index ca0d718a3..72d68b5fa 100755 --- a/init.ps1 +++ b/init.ps1 @@ -44,6 +44,9 @@ $EnvVars = @{} if (!$NoPrerequisites) { & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken -Force:$UpgradePrerequisites & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality + if ($LASTEXITCODE -eq 3010) { + Exit 3010 + } # The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. # But it only works on Windows. diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index a13638ae7..be5f6a276 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -77,8 +77,10 @@ Function Install-DotNet($Version, [switch]$Runtime) { Write-Host "Downloading .NET Core $sdkSubstring$Version..." $Installer = Get-InstallerExe -Version $Version -Runtime:$Runtime Write-Host "Installing .NET Core $sdkSubstring$Version..." - cmd /c start /wait $Installer /install /quiet - if ($LASTEXITCODE -ne 0) { + cmd /c start /wait $Installer /install /passive /norestart + if ($LASTEXITCODE -eq 3010) { + Write-Verbose "Restart required" + } elseif ($LASTEXITCODE -ne 0) { throw "Failure to install .NET Core SDK" } } @@ -95,16 +97,24 @@ if ($InstallLocality -eq 'machine') { if ($IsMacOS -or $IsLinux) { $DotNetInstallDir = '/usr/share/dotnet' } else { + $restartRequired = $false if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { Install-DotNet -Version $sdkVersion + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) } $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { Install-DotNet -Version $_ -Runtime + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) } } + if ($restartRequired) { + Write-Host -ForegroundColor Yellow "System restart required" + Exit 3010 + } + return } } elseif ($InstallLocality -eq 'repo') { From 4a0dface5e4967814178cdf2ebf67f38b01744a7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jul 2020 15:08:50 -0600 Subject: [PATCH 0161/1753] Remove strongname.snk This is generated by expanding the template. It was mistakenly checked in at some point. --- strongname.snk | Bin 596 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 strongname.snk diff --git a/strongname.snk b/strongname.snk deleted file mode 100644 index a4d0a2ce39df5f7c284340b4a2c4690385c44208..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 596 zcmV-a0;~N80ssI2Bme+XQ$aES1ONa50097Td7B6KsP|cl#<{bONo_!&t)QUG9wW^j zM1zvNAOI=XF}potSO>54lS%MGl8tv)xYTSw?~K<1McvNlJ;DITeY__C?><|;F`bgX zj;&2ME}KBWPb0zVSK+iW?{2`tzZR-#x0K_|t&0FhD+3urA!lNmCH;&b|?g|_AC39ox-0 zcV%KJis3}%`RVWSXN58fc}#LF$A#kcB2VWh=MH0zs+k7{ zQT<5V>NGhWzC7Jnt4A?n%Kk`fPt&FR4k~q{TSW%@D{plIpotzop}i+x`~C))*Vr-i zrW2)aE17f*=wCRa_#bHkYlQko_Jh)wN@;?yML9mYk)XZ`l6IQ*D7xZmmL=m(T|zMG i={(T>StYQl!YSPV From 2095a96269bc9bcf6c2eb9e21e3bbd2ccc33cc97 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 24 Jul 2020 07:57:24 -0600 Subject: [PATCH 0162/1753] Print existing variable in Azure Pipelines --- azure-pipelines/variables/_pipelines.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 14d6ffc28..3de19d7a2 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -8,7 +8,7 @@ # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. $keyCaps = $_.Key.ToUpper() if (Test-Path -Path "env:$keyCaps") { - Write-Host "Skipping setting $keyCaps because variable is already set." -ForegroundColor Cyan + Write-Host "Skipping setting $keyCaps because variable is already set to '$(Get-Content env:$keyCaps)'." -ForegroundColor Cyan } else { Write-Host "$keyCaps=$($_.Value)" -ForegroundColor Yellow if ($env:TF_BUILD) { From ecf6c16025a3905e673cdd542ad80185a9587e9e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 24 Jul 2020 08:46:23 -0600 Subject: [PATCH 0163/1753] Fix build and snk updates during template expansion We inappropriately removed the required snk file for our own build in 4a0dface5e496. This brings it back. It also updates Expand-Template.ps1 to overwrite the existing one rather than creating a new one in an ignored location. --- Expand-Template.ps1 | 4 ++-- strongname.snk | Bin 0 -> 596 bytes 2 files changed, 2 insertions(+), 2 deletions(-) create mode 100644 strongname.snk diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index dc53d1c15..5ed211d03 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -101,8 +101,8 @@ try { git add "test/$LibraryName.Tests/$LibraryName.Tests.csproj" # Establish a new strong-name key - & $sn.Path -k 2048 src/strongname.snk - git add src/strongname.snk + & $sn.Path -k 2048 strongname.snk + git add strongname.snk # Replace placeholders in source files Replace-Placeholders -Path "src/$LibraryName/Calculator.cs" -Replacements @{ diff --git a/strongname.snk b/strongname.snk new file mode 100644 index 0000000000000000000000000000000000000000..a4d0a2ce39df5f7c284340b4a2c4690385c44208 GIT binary patch literal 596 zcmV-a0;~N80ssI2Bme+XQ$aES1ONa50097Td7B6KsP|cl#<{bONo_!&t)QUG9wW^j zM1zvNAOI=XF}potSO>54lS%MGl8tv)xYTSw?~K<1McvNlJ;DITeY__C?><|;F`bgX zj;&2ME}KBWPb0zVSK+iW?{2`tzZR-#x0K_|t&0FhD+3urA!lNmCH;&b|?g|_AC39ox-0 zcV%KJis3}%`RVWSXN58fc}#LF$A#kcB2VWh=MH0zs+k7{ zQT<5V>NGhWzC7Jnt4A?n%Kk`fPt&FR4k~q{TSW%@D{plIpotzop}i+x`~C))*Vr-i zrW2)aE17f*=wCRa_#bHkYlQko_Jh)wN@;?yML9mYk)XZ`l6IQ*D7xZmmL=m(T|zMG i={(T>StYQl!YSPV literal 0 HcmV?d00001 From c03b185de7c83b21f1f84ac01656e2d3226625ac Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 25 Jul 2020 09:59:36 -0600 Subject: [PATCH 0164/1753] Set output variables as well This allows them to be referenced by subsequent jobs and stages. --- azure-pipelines/install-dependencies.yml | 1 + azure-pipelines/variables/_pipelines.ps1 | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 5b1ac4afd..f773f3853 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -12,3 +12,4 @@ steps: - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: Set pipeline variables based on source + name: SetPipelineVariables diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 3de19d7a2..552995509 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -12,7 +12,10 @@ } else { Write-Host "$keyCaps=$($_.Value)" -ForegroundColor Yellow if ($env:TF_BUILD) { - Write-Host "##vso[task.setvariable variable=$keyCaps;]$($_.Value)" + # Create two variables: the first that can be used by its simple name and accessible only within this job. + Write-Host "##vso[task.setvariable variable=$keyCaps]$($_.Value)" + # and the second that works across jobs and stages but must be fully qualified when referenced. + Write-Host "##vso[task.setvariable variable=$keyCaps;isOutput=true]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { Write-Host "::set-env name=$keyCaps::$($_.Value)" } From 171534d501b52b18a1d8bba53f93ec0149ad016a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jul 2020 16:13:01 -0600 Subject: [PATCH 0165/1753] Remove microbuild from CI list --- .github/workflows/build.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 91040d811..b9f17c23c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -4,7 +4,6 @@ on: push: branches: - master - - microbuild - validate/* pull_request: From 285bd4f1a116799fe42bbb454710fec90155e9f8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Aug 2020 10:01:41 -0600 Subject: [PATCH 0166/1753] Enable GitHub Dependabot --- .editorconfig | 4 ++++ .github/dependabot.yml | 9 +++++++++ 2 files changed, 13 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.editorconfig b/.editorconfig index 979d170a0..15f0b0e6b 100644 --- a/.editorconfig +++ b/.editorconfig @@ -9,6 +9,10 @@ indent_style = space # (Please don't specify an indent_size here; that has too many unintended consequences.) +[*.yml] +indent_size = 2 +indent_style = space + # Code files [*.{cs,csx,vb,vbx,h,cpp,idl}] indent_size = 4 diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..aa48b0fe7 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,9 @@ +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: +- package-ecosystem: nuget + directory: / + schedule: + interval: weekly From cc969eccc71582c459b528fbd6f2a7752a302e4f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 4 Aug 2020 16:03:35 +0000 Subject: [PATCH 0167/1753] Bump xunit.runner.visualstudio from 2.4.1 to 2.4.3 Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.4.1 to 2.4.3. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/commits/v2.4.3) Signed-off-by: dependabot[bot] --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 29ac7bf82..a491f3697 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -8,7 +8,7 @@ - + From 116a8b074c2cc91e2ee2105e29b6bbaf9010c793 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 4 Aug 2020 16:03:38 +0000 Subject: [PATCH 0168/1753] Bump Nerdbank.GitVersioning from 3.1.91 to 3.2.31 Bumps [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) from 3.1.91 to 3.2.31. - [Release notes](https://github.com/dotnet/Nerdbank.GitVersioning/releases) - [Commits](https://github.com/dotnet/Nerdbank.GitVersioning/compare/v3.1.91...v3.2.31) Signed-off-by: dependabot[bot] --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 9c119f372..7a6a46aee 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -27,7 +27,7 @@ - + From a6010319f64a75446a3f0c513388e736e0c98c0f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 4 Aug 2020 16:16:14 +0000 Subject: [PATCH 0169/1753] Bump coverlet.msbuild from 2.8.1 to 2.9.0 Bumps [coverlet.msbuild](https://github.com/coverlet-coverage/coverlet) from 2.8.1 to 2.9.0. - [Release notes](https://github.com/coverlet-coverage/coverlet/releases) - [Commits](https://github.com/coverlet-coverage/coverlet/commits) Signed-off-by: dependabot[bot] --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index a491f3697..4b76c54b7 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -5,7 +5,7 @@ - + From a8c59c572c872c495b467e1a1a1f81d174592bd6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Aug 2020 06:21:04 +0000 Subject: [PATCH 0170/1753] Bump Microsoft.Net.Compilers.Toolset from 3.6.0 to 3.7.0 Bumps [Microsoft.Net.Compilers.Toolset](https://github.com/dotnet/roslyn) from 3.6.0 to 3.7.0. - [Release notes](https://github.com/dotnet/roslyn/releases) - [Changelog](https://github.com/dotnet/roslyn/blob/master/docs/Breaking%20API%20Changes.md) - [Commits](https://github.com/dotnet/roslyn/commits) Signed-off-by: dependabot[bot] --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 7a6a46aee..8ffdea803 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -28,7 +28,7 @@ - + From c73b9220f6b0131fc5ac67af91b71c96df51d782 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Aug 2020 06:21:04 +0000 Subject: [PATCH 0171/1753] Bump Microsoft.NET.Test.Sdk from 16.6.1 to 16.7.0 Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.6.1 to 16.7.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.6.1...v16.7.0) Signed-off-by: dependabot[bot] --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 4b76c54b7..6e1c82938 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -6,7 +6,7 @@ - + From 29cf0a517da6adf751a11d2558361d5240f831a2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Aug 2020 08:02:17 -0600 Subject: [PATCH 0172/1753] Update .NET Core SDK to 3.1.302 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 11833de02..cc9e47f21 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.301", + "version": "3.1.302", "rollForward": "patch", "allowPrerelease": false } From fe64abe20bc74fc6aecedcbc54176b76298e4302 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Aug 2020 09:13:44 -0600 Subject: [PATCH 0173/1753] Get WPF inner-builds to import NuGet packages' imports Workaround for https://github.com/dotnet/wpf/issues/810 --- Directory.Build.props | 27 +++++++++++++++++++++++++++ Directory.Build.targets | 6 ++++++ src/Directory.Build.targets | 5 ----- 3 files changed, 33 insertions(+), 5 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 7a6a46aee..23d033f65 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -40,4 +40,31 @@ + + + false + true + + + + + <_WpfTempProjectNuGetFilePathNoExt>$(RepoRootPath)obj\$(_TargetAssemblyProjectName)\$(_TargetAssemblyProjectName)$(MSBuildProjectExtension).nuget.g + + false + false + false + false + + + + diff --git a/Directory.Build.targets b/Directory.Build.targets index 8c119d541..65a15bfc8 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -1,2 +1,8 @@ + + + false + + + diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index c1ce36344..e7edee55a 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,8 +1,3 @@ - - - false - - From 225c8e7b9ea43c30640323f8ba4b89c5783b386c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 15 Aug 2020 09:00:24 -0600 Subject: [PATCH 0174/1753] Ignore CA2007 in tests --- test/.editorconfig | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/.editorconfig b/test/.editorconfig index 89195ddae..2abae62d7 100644 --- a/test/.editorconfig +++ b/test/.editorconfig @@ -38,3 +38,6 @@ dotnet_diagnostic.CA1063.severity = silent # CA1816: Dispose methods should call SuppressFinalize dotnet_diagnostic.CA1816.severity = silent + +# CA2007: Consider calling ConfigureAwait on the awaited task +dotnet_diagnostic.CA2007.severity = none From eef30466f115466841d4107cfc7cd6affec91e08 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Aug 2020 06:30:20 +0000 Subject: [PATCH 0175/1753] Bump Microsoft.CodeAnalysis.FxCopAnalyzers from 3.0.0 to 3.3.0 Bumps [Microsoft.CodeAnalysis.FxCopAnalyzers](https://github.com/dotnet/roslyn-analyzers) from 3.0.0 to 3.3.0. - [Release notes](https://github.com/dotnet/roslyn-analyzers/releases) - [Changelog](https://github.com/dotnet/roslyn-analyzers/blob/master/PostReleaseActivities.md) - [Commits](https://github.com/dotnet/roslyn-analyzers/compare/v3.0.0...v3.3.0) Signed-off-by: dependabot[bot] --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index ce0d2a55f..b9f89e5a2 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,7 +24,7 @@ - + From d5f3e774f5b345b578742607edc91513fcf66d0f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 19 Aug 2020 10:57:24 -0600 Subject: [PATCH 0176/1753] Add YAML based release pipeline --- azure-pipelines/release.yml | 72 +++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 azure-pipelines/release.yml diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml new file mode 100644 index 000000000..bfe5987cd --- /dev/null +++ b/azure-pipelines/release.yml @@ -0,0 +1,72 @@ +trigger: none # We only want to trigger manually or based on resources +pr: none + +resources: + pipelines: + - pipeline: CI + source: Library # TODO: This should match the name of your CI pipeline + trigger: + tags: + - auto-release + +stages: +- stage: GitHubRelease + displayName: GitHub Release + jobs: + - deployment: create + pool: + vmImage: ubuntu-latest + environment: No-Approval + strategy: + runOnce: + deploy: + steps: + - download: none + - powershell: | + Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + displayName: Set pipeline name + - task: GitHubRelease@1 + displayName: GitHub release (create) + inputs: + gitHubConnection: # TODO: fill in service connection here + repositoryName: $(Build.Repository.Name) + target: $(resources.pipeline.CI.sourceCommit) + tagSource: userSpecifiedTag + tag: v$(resources.pipeline.CI.runName) + title: v$(resources.pipeline.CI.runName) + isDraft: true # After running this step, visit the new draft release, edit, and publish. + changeLogCompareToRelease: lastNonDraftRelease + changeLogType: issueBased + changeLogLabels: | + [ + { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, + { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } + ] + +- stage: nuget_org + displayName: nuget.org + dependsOn: GitHubRelease + jobs: + - deployment: push + pool: + vmImage: ubuntu-latest + environment: No-Approval + strategy: + runOnce: + deploy: + steps: + - download: CI + artifact: deployables-Windows + displayName: Download deployables-Windows artifact + patterns: 'deployables-Windows/*' + - task: NuGetToolInstaller@1 + displayName: Use NuGet 5.x + inputs: + versionSpec: 5.x + - task: NuGetCommand@2 + displayName: NuGet push + inputs: + command: push + packagesToPush: $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg + nuGetFeedType: external + publishFeedCredentials: # TODO: fill in service connection here From 9469bdf8c4e70ac8a8d5d7b8eacbf94ad2b1c5e0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 19 Aug 2020 12:13:49 -0600 Subject: [PATCH 0177/1753] Fix up init.cmd to set env vars from .ps1 child process --- azure-pipelines/Set-EnvVars.ps1 | 20 ++++++++++++++++++- init.cmd | 16 +++++++++++++++ init.ps1 | 35 ++++++++++++++++++--------------- tools/Install-DotNetSdk.ps1 | 22 ++++++++++----------- 4 files changed, 65 insertions(+), 28 deletions(-) diff --git a/azure-pipelines/Set-EnvVars.ps1 b/azure-pipelines/Set-EnvVars.ps1 index 9d14d9aa0..bde2e3438 100644 --- a/azure-pipelines/Set-EnvVars.ps1 +++ b/azure-pipelines/Set-EnvVars.ps1 @@ -4,8 +4,13 @@ Azure Pipeline and CMD environments are considered. .PARAMETER Variables A hashtable of variables to be set. +.PARAMETER PrependPath + A set of paths to prepend to the PATH environment variable. .OUTPUTS A boolean indicating whether the environment variables can be expected to propagate to the caller's environment. +.DESCRIPTION + The CmdEnvScriptPath environment variable may be optionally set to a path to a cmd shell script to be created (or appended to if it already exists) that will set the environment variables in cmd.exe that are set within the PowerShell environment. + This is used by init.cmd in order to reapply any new environment variables to the parent cmd.exe process that were set in the powershell child process. #> [CmdletBinding(SupportsShouldProcess=$true)] Param( @@ -18,7 +23,7 @@ if ($Variables.Count -eq 0) { return $true } -$cmdInstructions = !$env:TF_BUILD -and !$env:GITHUB_ACTIONS -and $env:PS1UnderCmd -eq '1' +$cmdInstructions = !$env:TF_BUILD -and !$env:GITHUB_ACTIONS -and !$env:CmdEnvScriptPath -and ($env:PS1UnderCmd -eq '1') if ($cmdInstructions) { Write-Warning "Environment variables have been set that will be lost because you're running under cmd.exe" Write-Host "Environment variables that must be set manually:" -ForegroundColor Blue @@ -38,6 +43,7 @@ if ($env:GITHUB_ACTIONS) { Write-Host "GitHub Actions detected. Logging commands will be used to propagate environment variables and prepend path." } +$CmdEnvScript = '' $Variables.GetEnumerator() |% { Set-Item -Path env:$($_.Key) -Value $_.Value @@ -52,6 +58,8 @@ $Variables.GetEnumerator() |% { if ($cmdInstructions) { Write-Host "SET $($_.Key)=$($_.Value)" } + + $CmdEnvScript += "SET $($_.Key)=$($_.Value)`r`n" } $pathDelimiter = ';' @@ -73,7 +81,17 @@ if ($PrependPath) { if ($env:GITHUB_ACTIONS) { Write-Host "::add-path::$_" } + + $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" + } +} + +if ($env:CmdEnvScriptPath) { + if (Test-Path $env:CmdEnvScriptPath) { + $CmdEnvScript = (Get-Content -Path $env:CmdEnvScriptPath) + $CmdEnvScript } + + Set-Content -Path $env:CmdEnvScriptPath -Value $CmdEnvScript } return !$cmdInstructions diff --git a/init.cmd b/init.cmd index 970285c2f..667efabb7 100644 --- a/init.cmd +++ b/init.cmd @@ -1,4 +1,20 @@ @echo off SETLOCAL set PS1UnderCmd=1 + +:: Get the datetime in a format that can go in a filename. +set _my_datetime=%date%_%time% +set _my_datetime=%_my_datetime: =_% +set _my_datetime=%_my_datetime::=% +set _my_datetime=%_my_datetime:/=_% +set _my_datetime=%_my_datetime:.=_% +set CmdEnvScriptPath=%temp%\envvarscript_%_my_datetime%.cmd + powershell.exe -NoProfile -NoLogo -ExecutionPolicy bypass -Command "try { & '%~dpn0.ps1' %*; exit $LASTEXITCODE } catch { write-host $_; exit 1 }" + +:: Set environment variables in the parent cmd.exe process. +IF EXIST "%CmdEnvScriptPath%" ( + ENDLOCAL + CALL "%CmdEnvScriptPath%" + DEL "%CmdEnvScriptPath%" +) diff --git a/init.ps1 b/init.ps1 index 72d68b5fa..a6978b6fe 100755 --- a/init.ps1 +++ b/init.ps1 @@ -2,28 +2,31 @@ <# .SYNOPSIS -Installs dependencies required to build and test the projects in this repository. + Installs dependencies required to build and test the projects in this repository. .DESCRIPTION -This MAY not require elevation, as the SDK and runtimes are installed to a per-user location, -unless the `-InstallLocality` switch is specified directing to a per-repo or per-machine location. -See detailed help on that switch for more information. + This MAY not require elevation, as the SDK and runtimes are installed to a per-user location, + unless the `-InstallLocality` switch is specified directing to a per-repo or per-machine location. + See detailed help on that switch for more information. + + The CmdEnvScriptPath environment variable may be optionally set to a path to a cmd shell script to be created (or appended to if it already exists) that will set the environment variables in cmd.exe that are set within the PowerShell environment. + This is used by init.cmd in order to reapply any new environment variables to the parent cmd.exe process that were set in the powershell child process. .PARAMETER InstallLocality -A value indicating whether dependencies should be installed locally to the repo or at a per-user location. -Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. -Visual Studio will only notice and use these SDKs/runtimes if VS is launched from the environment that runs this script. -Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. -When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. -Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. -Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. + A value indicating whether dependencies should be installed locally to the repo or at a per-user location. + Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. + Visual Studio will only notice and use these SDKs/runtimes if VS is launched from the environment that runs this script. + Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. + When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. + Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. + Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. .PARAMETER NoPrerequisites -Skips the installation of prerequisite software (e.g. SDKs, tools). + Skips the installation of prerequisite software (e.g. SDKs, tools). .PARAMETER UpgradePrerequisites -Takes time to install prerequisites even if they are already present in case they need to be upgraded. -No effect if -NoPrerequisites is specified. + Takes time to install prerequisites even if they are already present in case they need to be upgraded. + No effect if -NoPrerequisites is specified. .PARAMETER NoRestore -Skips the package restore step. + Skips the package restore step. .PARAMETER AccessToken -An optional access token for authenticating to Azure Artifacts authenticated feeds. + An optional access token for authenticating to Azure Artifacts authenticated feeds. #> [CmdletBinding(SupportsShouldProcess=$true)] Param ( diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index be5f6a276..a02b5cdce 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -2,19 +2,19 @@ <# .SYNOPSIS -Installs the .NET SDK specified in the global.json file at the root of this repository, -along with supporting .NET Core runtimes used for testing. + Installs the .NET SDK specified in the global.json file at the root of this repository, + along with supporting .NET Core runtimes used for testing. .DESCRIPTION -This MAY not require elevation, as the SDK and runtimes are installed locally to this repo location, -unless `-InstallLocality machine` is specified. + This MAY not require elevation, as the SDK and runtimes are installed locally to this repo location, + unless `-InstallLocality machine` is specified. .PARAMETER InstallLocality -A value indicating whether dependencies should be installed locally to the repo or at a per-user location. -Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. -Visual Studio will only notice and use these SDKs/runtimes if VS is launched from the environment that runs this script. -Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. -When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. -Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. -Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. + A value indicating whether dependencies should be installed locally to the repo or at a per-user location. + Per-user allows sharing the installed dependencies across repositories and allows use of a shared expanded package cache. + Visual Studio will only notice and use these SDKs/runtimes if VS is launched from the environment that runs this script. + Per-repo allows for high isolation, allowing for a more precise recreation of the environment within an Azure Pipelines build. + When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. + Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. + Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( From 5439be7fde0ebed774cffc561bf2390cea1a87b3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 19 Aug 2020 12:14:19 -0600 Subject: [PATCH 0178/1753] Move Set-EnvVars.ps1 to tools --- init.ps1 | 2 +- tools/Install-DotNetSdk.ps1 | 2 +- tools/Install-NuGetCredProvider.ps1 | 8 +++++--- {azure-pipelines => tools}/Set-EnvVars.ps1 | 0 4 files changed, 7 insertions(+), 5 deletions(-) rename {azure-pipelines => tools}/Set-EnvVars.ps1 (100%) diff --git a/init.ps1 b/init.ps1 index a6978b6fe..e5aad5bfa 100755 --- a/init.ps1 +++ b/init.ps1 @@ -74,7 +74,7 @@ try { } } - & "$PSScriptRoot\azure-pipelines\Set-EnvVars.ps1" -Variables $EnvVars | Out-Null + & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars | Out-Null } catch { Write-Error $error[0] diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index a02b5cdce..2da4a73dc 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -165,5 +165,5 @@ $runtimeVersions | Get-Unique |% { } if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these installed runtimes?")) { - & "$PSScriptRoot/../azure-pipelines/Set-EnvVars.ps1" -Variables $envVars -PrependPath $DotNetInstallDir | Out-Null + & "$PSScriptRoot/Set-EnvVars.ps1" -Variables $envVars -PrependPath $DotNetInstallDir | Out-Null } diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index 2b3fb6fb4..6d3100349 100755 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -19,6 +19,8 @@ Param ( [string]$AccessToken ) +$envVars = @{} + $toolsPath = & "$PSScriptRoot\..\azure-pipelines\Get-TempToolsPath.ps1" if ($IsMacOS -or $IsLinux) { @@ -66,9 +68,9 @@ if ($AccessToken) { Add-Member -InputObject $auth -MemberType NoteProperty -Name endpointCredentials -Value $endpoints $authJson = ConvertTo-Json -InputObject $auth - $envVars = @{ + $envVars += @{ 'VSS_NUGET_EXTERNAL_FEED_ENDPOINTS'=$authJson; } - - & "$PSScriptRoot\..\azure-pipelines\Set-EnvVars.ps1" -Variables $envVars | Out-Null } + +& "$PSScriptRoot/Set-EnvVars.ps1" -Variables $envVars | Out-Null diff --git a/azure-pipelines/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 similarity index 100% rename from azure-pipelines/Set-EnvVars.ps1 rename to tools/Set-EnvVars.ps1 From 7d217d1f1658b5348bd9739b1e742c9ad7e21402 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Aug 2020 21:54:00 -0600 Subject: [PATCH 0179/1753] Run net472 tests on mac/linux (which means on Mono) --- azure-pipelines/dotnet.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 6764e6ecc..8f4e950f0 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -12,7 +12,7 @@ steps: command: test arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: net472-$(Agent.JobName) - condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) + condition: succeededOrFailed() - task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp2.1 @@ -20,6 +20,7 @@ steps: command: test arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: netcoreapp2.1-$(Agent.JobName) + condition: succeededOrFailed() - task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp3.1 @@ -27,6 +28,7 @@ steps: command: test arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" testRunTitle: netcoreapp3.1-$(Agent.JobName) + condition: succeededOrFailed() - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true From 461288dfc334ecacc78d797ab9ceba504bbac25b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 23 Aug 2020 12:58:47 -0600 Subject: [PATCH 0180/1753] Beef up contrib doc explanation of init.ps1 --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2102ba9b0..36424c42d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,8 @@ with any additional questions or comments. All dependencies can be installed by running the `init.ps1` script at the root of the repository using Windows PowerShell or [PowerShell Core][pwsh] (on any OS). +Some dependencies installed by `init.ps1` may only be discoverable from the same command line environment the init script was run from due to environment variables, so be sure to launch Visual Studio or build the repo from that same environment. +Alternatively, run `init.ps1 -InstallLocality Machine` (which may require elevation) in order to install dependencies at machine-wide locations so Visual Studio and builds work everywhere. The only prerequisite for building, testing, and deploying from this repository is the [.NET SDK](https://get.dot.net/). From b79b08af1a6da50c9bee63c8b5e932992be53fa2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 23 Aug 2020 13:15:57 -0600 Subject: [PATCH 0181/1753] Add warning that non-machine installs must run within same environment --- tools/Install-DotNetSdk.ps1 | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 2da4a73dc..ec66c949a 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -148,7 +148,10 @@ if (-not (Test-Path $DotNetInstallScriptPath)) { } } +$anythingInstalled = $false + if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" } else { Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" @@ -158,6 +161,7 @@ $switches += '-Runtime','dotnet' $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" } else { Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" @@ -167,3 +171,7 @@ $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these installed runtimes?")) { & "$PSScriptRoot/Set-EnvVars.ps1" -Variables $envVars -PrependPath $DotNetInstallDir | Out-Null } + +if ($anythingInstalled -and ($InstallLocality -ne 'machine') -and !$env:TF_BUILD -and !$env:GITHUB_ACTIONS) { + Write-Warning ".NET Core runtimes or SDKs were installed to a non-machine location. Perform your builds or open Visual Studio from this same environment in order for tools to discover the location of these dependencies." +} From 3d1c43c3d3222adfec73c0981fc799308a6a94e4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 24 Aug 2020 06:48:20 -0600 Subject: [PATCH 0182/1753] Bump Microsoft.NET.Test.Sdk from 16.7.0 to 16.7.1 (#72) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.7.0 to 16.7.1. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.7.0...v16.7.1) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 6e1c82938..ea4220b9a 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -6,7 +6,7 @@ - + From 641eaa17cdf690aacad122a78b3f32b13cf36d8a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Sep 2020 03:40:22 -0600 Subject: [PATCH 0183/1753] Provide better error when sn is not on the PATH Since the .NET Core SDK does not include the sn tool, on mac/linux the only way to create strong name keys is with mono. The expand-template.ps1 script didn't explain this to the user, but instead searched a Windows directory. This commit improves the error they see. Fixes #73 --- Expand-Template.ps1 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 5ed211d03..e0708bd4d 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -56,6 +56,10 @@ function Replace-Placeholders { # Try to find sn.exe if it isn't on the PATH $sn = Get-Command sn -ErrorAction SilentlyContinue if (-not $sn) { + if ($IsMacOS -or $IsLinux) { + Write-Error "sn command not found on PATH. Install mono and/or vote up this issue: https://github.com/dotnet/sdk/issues/13560" + exit(1) + } $snExes = Get-ChildItem -Recurse "${env:ProgramFiles(x86)}\Microsoft SDKs\Windows\sn.exe" if ($snExes) { $sn = Get-Command $snExes[0].FullName From e3449f0b073df5ec14886be35a8f01e76f4c50f1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Sep 2020 03:44:08 -0600 Subject: [PATCH 0184/1753] Fail fast when dotnet returns an exit code --- Expand-Template.ps1 | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index e0708bd4d..adc4fb112 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -82,31 +82,48 @@ try { if ($Squash) { $originalCommitId = git rev-parse HEAD git reset --soft $(git rev-list --max-parents=0 HEAD) + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git commit --amend -qm "Initial template from https://github.com/AArnott/Library.Template" -m "Original commit from template $originalCommitId" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } } # Rename project directories and solution git mv Library.sln "$LibraryName.sln" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv src/Library/Library.csproj "src/Library/$LibraryName.csproj" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv src/Library "src/$LibraryName" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv test/Library.Tests/Library.Tests.csproj "test/Library.Tests/$LibraryName.Tests.csproj" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv test/Library.Tests "test/$LibraryName.Tests" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Refresh solution file both to update paths and give the projects unique GUIDs dotnet sln remove src/Library/Library.csproj + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } dotnet sln remove test/Library.Tests/Library.Tests.csproj + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } dotnet sln add "src/$LibraryName" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } dotnet sln add "test/$LibraryName.Tests" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git add "$LibraryName.sln" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Update project reference in test project. Add before removal to keep the same ItemGroup in place. dotnet add "test/$LibraryName.Tests" reference "src/$LibraryName" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } dotnet remove "test/$LibraryName.Tests" reference src/Library/Library.csproj + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git add "test/$LibraryName.Tests/$LibraryName.Tests.csproj" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Establish a new strong-name key & $sn.Path -k 2048 strongname.snk + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git add strongname.snk + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Replace placeholders in source files Replace-Placeholders -Path "src/$LibraryName/Calculator.cs" -Replacements @{ @@ -153,7 +170,9 @@ try { # Self destruct git rm Expand-Template.* + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git rm :/azure-pipelines/expand-template.yml + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Self-integrity check Get-ChildItem -Recurse -File -Exclude bin,obj,README.md,Expand-Template.* |? { -not $_.FullName.Contains("obj") } |% { @@ -165,6 +184,7 @@ try { # Commit the changes git commit -qm "Expanded template for $LibraryName" -m "This expansion done by the (now removed) Expand-Template.ps1 script." + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } Write-Host -ForegroundColor Green "Template successfully expanded." From 0c212b6459c470633a941c7854eb6f73f258f488 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Sep 2020 05:59:22 -0600 Subject: [PATCH 0185/1753] Skip .NET SDK and runtime install when unneeded --- tools/Check-DotNetRuntime.ps1 | 41 +++++++++++++++++++++++++++++ tools/Check-DotNetSdk.ps1 | 31 ++++++++++++++++++++++ tools/Install-DotNetSdk.ps1 | 49 ++++++++++++++++++++++++----------- 3 files changed, 106 insertions(+), 15 deletions(-) create mode 100644 tools/Check-DotNetRuntime.ps1 create mode 100644 tools/Check-DotNetSdk.ps1 diff --git a/tools/Check-DotNetRuntime.ps1 b/tools/Check-DotNetRuntime.ps1 new file mode 100644 index 000000000..9d0121095 --- /dev/null +++ b/tools/Check-DotNetRuntime.ps1 @@ -0,0 +1,41 @@ +<# +.SYNOPSIS + Checks whether a given .NET Core runtime is installed. +#> +[CmdletBinding()] +Param ( + [Parameter()] + [ValidateSet('Microsoft.AspNetCore.App','Microsoft.NETCore.App')] + [string]$Runtime='Microsoft.NETCore.App', + [Parameter(Mandatory=$true)] + [Version]$Version +) + +$dotnet = Get-Command dotnet -ErrorAction SilentlyContinue +if (!$dotnet) { + # Nothing is installed. + Write-Output $false + exit 1 +} + +Function IsVersionMatch { + Param( + [Parameter()] + $actualVersion + ) + return $actualVersion -and + $Version.Major -eq $actualVersion.Major -and + $Version.Minor -eq $actualVersion.Minor -and + (($Version.Build -eq -1) -or ($Version.Build -eq $actualVersion.Build)) -and + (($Version.Revision -eq -1) -or ($Version.Revision -eq $actualVersion.Revision)) +} + +$installedRuntimes = dotnet --list-runtimes |? { $_.Split()[0] -ieq $Runtime } |% { $v = $null; [Version]::tryparse($_.Split()[1], [ref] $v); $v } +$matchingRuntimes = $installedRuntimes |? { IsVersionMatch -actualVersion $_ } +if (!$matchingRuntimes) { + Write-Output $false + exit 1 +} + +Write-Output $true +exit 0 diff --git a/tools/Check-DotNetSdk.ps1 b/tools/Check-DotNetSdk.ps1 new file mode 100644 index 000000000..9d080f75f --- /dev/null +++ b/tools/Check-DotNetSdk.ps1 @@ -0,0 +1,31 @@ +<# +.SYNOPSIS + Checks whether the .NET Core SDK required by this repo is installed. +#> +[CmdletBinding()] +Param ( +) + +$dotnet = Get-Command dotnet -ErrorAction SilentlyContinue +if (!$dotnet) { + # Nothing is installed. + Write-Output $false + exit 1 +} + +# We need to set the current directory so dotnet considers the SDK required by our global.json file. +Push-Location "$PSScriptRoot\.." +try { + dotnet -h 2>&1 | Out-Null + if ($LASTEXITCODE -eq 129) { + # This error code indicates no matching SDK exists. + Write-Output $false + exit 2 + } + + # The required SDK is already installed! + Write-Output $true + exit 0 +} finally { + Pop-Location +} diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index ec66c949a..f7c023e61 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -15,11 +15,14 @@ When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. +.PARAMETER Force + Installs the preferred .NET SDK and runtime versions even if compatible versions are found to already be installed. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( [ValidateSet('repo','user','machine')] - [string]$InstallLocality='user' + [string]$InstallLocality='user', + [switch]$Force ) $DotNetInstallScriptRoot = "$PSScriptRoot/../obj/tools" @@ -98,15 +101,23 @@ if ($InstallLocality -eq 'machine') { $DotNetInstallDir = '/usr/share/dotnet' } else { $restartRequired = $false - if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - Install-DotNet -Version $sdkVersion - $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetSdk.ps1"))) { + if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + Install-DotNet -Version $sdkVersion + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } + } else { + Write-Verbose "A .NET SDK version compatible with $sdkVersion is already installed." } $runtimeVersions | Get-Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - Install-DotNet -Version $_ -Runtime - $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetRuntime.ps1" -Version $_))) { + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + Install-DotNet -Version $_ -Runtime + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } + } else { + Write-Verbose ".NET runtime $_ is already installed." } } @@ -150,21 +161,29 @@ if (-not (Test-Path $DotNetInstallScriptPath)) { $anythingInstalled = $false -if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" +if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetSdk.ps1"))) { + if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" + } else { + Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" + } } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" + Write-Verbose "A .NET SDK version compatible with $sdkVersion is already installed." } $switches += '-Runtime','dotnet' $runtimeVersions | Get-Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" + if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetRuntime.ps1" -Version $_))) { + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" + } else { + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" + } } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" + Write-Verbose ".NET runtime $_ is already installed." } } From 1c2cb37ea5e403f058c045559bc1788d416c2bf7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Sep 2020 05:59:35 -0600 Subject: [PATCH 0186/1753] Install SDK to expand-template when necessary --- Expand-Template.ps1 | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index adc4fb112..c6ae8cba2 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -15,7 +15,7 @@ The `/{guid}` path to the Azure Pipelines artifact feed to push your nuget packa .PARAMETER Squash A switch that causes all of git history to be squashed to just one initial commit for the template, and one for its expansion. #> -[CmdletBinding()] +[CmdletBinding(SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter(Mandatory=$true)] [string]$LibraryName, @@ -69,6 +69,15 @@ if (-not $sn) { } } +if (-not (& "$PSScriptRoot\tools\Check-DotNetSdk.ps1")) { + if ($PSCmdlet.ShouldProcess('Install .NET Core SDK?')) { + & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" + } else { + Write-Error "Matching .NET Core SDK version not found. Install now?" + exit 1 + } +} + # Verify all commands we use are on the PATH ('git','dotnet') |% { if (-not (Get-Command $_ -ErrorAction SilentlyContinue)) { From 8377c641a87333da635846e2b4511900407ac1bd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 13 Sep 2020 07:40:35 -0600 Subject: [PATCH 0187/1753] Catch exception thrown on some machines --- tools/Check-DotNetSdk.ps1 | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/tools/Check-DotNetSdk.ps1 b/tools/Check-DotNetSdk.ps1 index 9d080f75f..6c9fa772c 100644 --- a/tools/Check-DotNetSdk.ps1 +++ b/tools/Check-DotNetSdk.ps1 @@ -17,8 +17,10 @@ if (!$dotnet) { Push-Location "$PSScriptRoot\.." try { dotnet -h 2>&1 | Out-Null - if ($LASTEXITCODE -eq 129) { - # This error code indicates no matching SDK exists. + if (($LASTEXITCODE -eq 129) -or # On Linux + ($LASTEXITCODE -eq -2147450751) # On Windows + ) { + # These exit codes indicate no matching SDK exists. Write-Output $false exit 2 } @@ -26,6 +28,10 @@ try { # The required SDK is already installed! Write-Output $true exit 0 +} catch { + # I don't know why, but on some build agents (e.g. MicroBuild), an exception is thrown from the `dotnet` invocation when a match is not found. + Write-Output $false + exit 3 } finally { Pop-Location } From 69a74f8c05201c01d1771f9ea2fa528283275e0d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 11:46:12 -0600 Subject: [PATCH 0188/1753] Revert incremental install of SDKs/Runtimes The 0c212b6459c4 commit brought this optimization in, but it is buggy because an SDK or runtime might not be installed because it's at the machine level, but if another runtime is missing and installed, it sets env vars which hide the machine level ones already found, so now they need to also be installed. But they weren't, so the build would just fail. Similarly, if the script is supposed to install to the machine location and the SDK is already installed at the user location, the recent optimization would skip installing it at the machine location. --- tools/Install-DotNetSdk.ps1 | 49 ++++++++++++------------------------- 1 file changed, 15 insertions(+), 34 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index f7c023e61..ec66c949a 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -15,14 +15,11 @@ When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. -.PARAMETER Force - Installs the preferred .NET SDK and runtime versions even if compatible versions are found to already be installed. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( [ValidateSet('repo','user','machine')] - [string]$InstallLocality='user', - [switch]$Force + [string]$InstallLocality='user' ) $DotNetInstallScriptRoot = "$PSScriptRoot/../obj/tools" @@ -101,23 +98,15 @@ if ($InstallLocality -eq 'machine') { $DotNetInstallDir = '/usr/share/dotnet' } else { $restartRequired = $false - if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetSdk.ps1"))) { - if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - Install-DotNet -Version $sdkVersion - $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) - } - } else { - Write-Verbose "A .NET SDK version compatible with $sdkVersion is already installed." + if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + Install-DotNet -Version $sdkVersion + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) } $runtimeVersions | Get-Unique |% { - if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetRuntime.ps1" -Version $_))) { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - Install-DotNet -Version $_ -Runtime - $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) - } - } else { - Write-Verbose ".NET runtime $_ is already installed." + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + Install-DotNet -Version $_ -Runtime + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) } } @@ -161,29 +150,21 @@ if (-not (Test-Path $DotNetInstallScriptPath)) { $anythingInstalled = $false -if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetSdk.ps1"))) { - if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" - } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" - } +if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" } else { - Write-Verbose "A .NET SDK version compatible with $sdkVersion is already installed." + Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" } $switches += '-Runtime','dotnet' $runtimeVersions | Get-Unique |% { - if ($Force -or (-not (& "$PSScriptRoot/Check-DotNetRuntime.ps1" -Version $_))) { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" - } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" - } + if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" } else { - Write-Verbose ".NET runtime $_ is already installed." + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" } } From 6c9781abbfcdcf0bd3001583cae8be38ab4c4903 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 11:34:03 -0600 Subject: [PATCH 0189/1753] Bump SDK to 3.1.402 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index cc9e47f21..a2e8ff9ec 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.302", + "version": "3.1.402", "rollForward": "patch", "allowPrerelease": false } From b30fd8c4581092f01199563ab5f130e6e6f859f3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 11:55:07 -0600 Subject: [PATCH 0190/1753] VS default branch is now 'main' --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index 67462ece9..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'master' +'main' From 1304c04d58a501d47ce335515b8aa61404a8126e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 14:52:20 -0600 Subject: [PATCH 0191/1753] Use lowercase for privateassets --- Directory.Build.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index b9f89e5a2..c6652de48 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -25,8 +25,8 @@ - - + + From 35ce94a23526a98dd3b827c1c609f6a4cf9968e9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 14:50:01 -0600 Subject: [PATCH 0192/1753] Simplify Project tag --- Directory.Build.props | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index c6652de48..8bb360bf0 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,5 +1,4 @@ - + Debug $(MSBuildThisFileDirectory) From c406cb86fdc100dd8ace0902562701f6a0110b1f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 14:50:11 -0600 Subject: [PATCH 0193/1753] Update URL for NB.GV schema --- version.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.json b/version.json index 38da1662c..a13f567b5 100644 --- a/version.json +++ b/version.json @@ -1,8 +1,8 @@ { - "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", + "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", "version": "0.1-beta", "publicReleaseRefSpec": [ "^refs/heads/master$", "^refs/heads/v\\d+(?:\\.\\d+)?$" ] -} \ No newline at end of file +} From 0e61dca4a45f1acafac48c379f336f5469d0fe25 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 14:51:07 -0600 Subject: [PATCH 0194/1753] Update MicroBuild version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 88d099b85..43443a42c 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -19,7 +19,7 @@ true snupkg - 2.0.58 + 2.0.61 From 6b65934cf810450cd8e38761635acaedbaa1fbd1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 20:57:23 -0600 Subject: [PATCH 0195/1753] Add symbol archive stage and insertion pipeline Also: * make SignType more amiable to schedule triggers that are real signed. * avoid Ref12 indexing except on default branch. --- azure-pipelines.yml | 2 - azure-pipelines/artifacts/VSInsertion.ps1 | 15 ++++++ azure-pipelines/build.yml | 3 -- azure-pipelines/microbuild.after.yml | 2 +- azure-pipelines/microbuild.before.yml | 5 +- azure-pipelines/official.yml | 59 +++++++++++++++++------ azure-pipelines/variables/SignType.ps1 | 11 +++++ azure-pipelines/variables/ci_feed.ps1 | 5 +- azure-pipelines/vs-insertion.yml | 50 +++++++++++++++++++ 9 files changed, 127 insertions(+), 25 deletions(-) create mode 100644 azure-pipelines/artifacts/VSInsertion.ps1 create mode 100644 azure-pipelines/variables/SignType.ps1 create mode 100644 azure-pipelines/vs-insertion.yml diff --git a/azure-pipelines.yml b/azure-pipelines.yml index a8a143bbd..e590031a6 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -20,5 +20,3 @@ variables: jobs: - template: azure-pipelines/build.yml - parameters: - SignType: diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 new file mode 100644 index 000000000..9c9c42507 --- /dev/null +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -0,0 +1,15 @@ +# This artifact captures everything needed to insert into VS (NuGet packages, insertion metadata, etc.) + +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +$BuildConfiguration = $env:BUILDCONFIGURATION +if (!$BuildConfiguration) { + $BuildConfiguration = 'Debug' +} + +$PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" + +if (!(Test-Path $PackagesRoot)) { return } + +@{ + "$PackagesRoot" = (Get-ChildItem $PackagesRoot -Recurse) +} diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 12298dfe3..b42cc549d 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -2,7 +2,6 @@ parameters: - name: windowsPool type: string default: Hosted Windows 2019 with VS2019 -- name: SignType jobs: - job: Windows @@ -17,8 +16,6 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.before.yml - parameters: - SignType: ${{ parameters.SignType }} - template: dotnet.yml diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 31fe8470e..ca7bcac32 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -23,5 +23,5 @@ steps: /repoName:$(Build.Repository.Name) /additionalCodexArguments:-bld /additionalCodexArguments:$(Build.ArtifactStagingDirectory)/build_logs - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) + condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), ne(variables['Build.Reason'], 'PullRequest')) continueOnError: true diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 07fadebfd..b1efae6e9 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,9 +1,6 @@ -parameters: -- name: SignType - steps: - task: MicroBuildSigningPlugin@2 inputs: - signType: ${{ parameters.SignType }} + signType: $(SignType) zipSources: false displayName: Install MicroBuild Signing Plugin diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 3126dc971..e2957470e 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -11,23 +11,54 @@ trigger: - .vscode/ parameters: -- name: SignType +- name: SignTypeSelection displayName: Sign type type: string default: Test values: [ 'Test', 'Real' ] -variables: - TreatWarningsAsErrors: true - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - BuildConfiguration: Release - BuildPlatform: Any CPU - push_to_ci: true - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages - SignType: ${{ parameters.SignType }} +stages: -jobs: -- template: build.yml - parameters: - windowsPool: VSEng-MicroBuildVS2019 - SignType: ${{ parameters.SignType }} +- stage: Build + variables: + TreatWarningsAsErrors: true + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BuildConfiguration: Release + BuildPlatform: Any CPU + push_to_ci: true + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + SignTypeSelection: ${{ parameters.SignTypeSelection }} + + jobs: + - template: build.yml + parameters: + windowsPool: VSEng-MicroBuildVS2019 + +- stage: symbol_archive + displayName: Symbol archival + condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) + jobs: + - job: archive + pool: VSEng-ReleasePool + steps: + - download: current + artifact: Variables-Windows + displayName: Download Variables-Windows artifact + - task: PowerShell@2 + displayName: Set VSTS variables based on artifacts + inputs: + targetType: filePath + filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + - download: current + artifact: symbols-Windows + displayName: Download symbols-Windows artifact + - task: MicroBuildArchiveSymbols@1 + displayName: Archive $(SymbolsFeatureName) on Symweb + inputs: + SymbolsFeatureName: $(SymbolsFeatureName) + SymbolsSymwebProject: VS + SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildNumber)\Symbols.Archival + SymbolsEmailContacts: vsidemicrobuild + SymbolsAgentPath: $(Pipeline.Workspace)/symbols-Windows + - task: MicroBuildCleanup@1 + displayName: Send Telemetry diff --git a/azure-pipelines/variables/SignType.ps1 b/azure-pipelines/variables/SignType.ps1 new file mode 100644 index 000000000..a2f7845e6 --- /dev/null +++ b/azure-pipelines/variables/SignType.ps1 @@ -0,0 +1,11 @@ +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9') { + if ($env:BUILD_REASON -eq 'Schedule') { + 'real' + } else { + if ($env:SignTypeSelection) { + $env:SignTypeSelection + } else { + 'test' + } + } + } diff --git a/azure-pipelines/variables/ci_feed.ps1 b/azure-pipelines/variables/ci_feed.ps1 index b5530b3f1..82bad79da 100644 --- a/azure-pipelines/variables/ci_feed.ps1 +++ b/azure-pipelines/variables/ci_feed.ps1 @@ -1,4 +1,7 @@ -if ($env:SIGNTYPE -eq 'Real') { +$signType = $env:SIGNTYPE +if (!$signType) { $signType = & "$PSScriptRoot/SignType.ps1" } + +if ($signType -eq 'Real') { '09d8d03c-1ac8-456e-9274-4d2364527d99' # VSIDE-RealSigned-Release } else { 'da484c78-f942-44ef-b197-99e2a1bef53c' # VSIDE-TestSigned-Release diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml new file mode 100644 index 000000000..75c54f316 --- /dev/null +++ b/azure-pipelines/vs-insertion.yml @@ -0,0 +1,50 @@ +trigger: none # We only want to trigger manually or based on resources +pr: none + +resources: + pipelines: + - pipeline: CI + source: Library # TODO: This should match the name of your CI pipeline + tags: + - Real signed + trigger: + tags: + - Real signed + - auto-insertion + +stages: +- stage: VS + displayName: VS insertion + jobs: + - deployment: insertion + pool: VSEng-ReleasePool + environment: No-Approval + strategy: + runOnce: + deploy: + steps: + - powershell: | + Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + displayName: Set pipeline name + - template: release-deployment-prep.yml + - download: CI + artifact: VSInsertion-Windows + displayName: Download VSInsertion-Windows artifact + - task: NuGetCommand@2 + displayName: Push CoreXT packages to VS feed + inputs: + command: push + packagesToPush: $(Pipeline.Workspace)/CI/VSInsertion-windows/*.nupkg + publishVstsFeed: 97a41293-2972-4f48-8c0e-05493ae82010 + allowPackageConflicts: true + - task: MicroBuildInsertVsPayload@3 + displayName: Insert VS Payload + inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) + InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) + InsertionBuildPolicy: Request Perf DDRITs + AutoCompletePR: true + AutoCompleteMergeStrategy: Squash + - task: MicroBuildCleanup@1 + displayName: Send Telemetry From 3d8ca75830e89fad6a2edb545d5a011b23a73a24 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 21:05:02 -0600 Subject: [PATCH 0196/1753] Switch (back) to VSEng-RMPool This is so the pipeline can be tested on the devdiv account's "Personal" project. --- azure-pipelines/official.yml | 2 +- azure-pipelines/vs-insertion.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index e2957470e..7c78b472f 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -39,7 +39,7 @@ stages: condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) jobs: - job: archive - pool: VSEng-ReleasePool + pool: VSEng-RMPool steps: - download: current artifact: Variables-Windows diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 75c54f316..43ceba0ae 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -17,7 +17,7 @@ stages: displayName: VS insertion jobs: - deployment: insertion - pool: VSEng-ReleasePool + pool: VSEng-RMPool environment: No-Approval strategy: runOnce: From 897c8f1ef13971edc27cdce4229c79677e18c90b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Sep 2020 21:12:49 -0600 Subject: [PATCH 0197/1753] Revert "Bump SDK to 3.1.402" Our MicroBuild agents do not have MSBuild 16.7 as required by this SDK. This reverts commit 6c9781abbfcdcf0bd3001583cae8be38ab4c4903. --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index a2e8ff9ec..cc9e47f21 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.402", + "version": "3.1.302", "rollForward": "patch", "allowPrerelease": false } From 8988145e2fb94d742b70b0f9546496aeddf39a39 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 15 Sep 2020 06:57:38 -0600 Subject: [PATCH 0198/1753] Switch to VSEng-RMPool This reverts commit 3d8ca75830e89fad6a2edb545d5a011b23a73a24. --- azure-pipelines/official.yml | 2 +- azure-pipelines/vs-insertion.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 7c78b472f..e2957470e 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -39,7 +39,7 @@ stages: condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) jobs: - job: archive - pool: VSEng-RMPool + pool: VSEng-ReleasePool steps: - download: current artifact: Variables-Windows diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 43ceba0ae..75c54f316 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -17,7 +17,7 @@ stages: displayName: VS insertion jobs: - deployment: insertion - pool: VSEng-RMPool + pool: VSEng-ReleasePool environment: No-Approval strategy: runOnce: From dab310dc23288d38578206c1f283831fd0b4cccb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Sep 2020 18:34:43 -0600 Subject: [PATCH 0199/1753] Add CredScan and PoliCheck --- azure-pipelines/microbuild.after.yml | 2 ++ azure-pipelines/secure-development-tools.yml | 11 +++++++++++ 2 files changed, 13 insertions(+) create mode 100644 azure-pipelines/secure-development-tools.yml diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index ca7bcac32..38f53b584 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -25,3 +25,5 @@ steps: /additionalCodexArguments:$(Build.ArtifactStagingDirectory)/build_logs condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), ne(variables['Build.Reason'], 'PullRequest')) continueOnError: true + +- template: secure-development-tools.yml diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml new file mode 100644 index 000000000..941d5b0c8 --- /dev/null +++ b/azure-pipelines/secure-development-tools.yml @@ -0,0 +1,11 @@ +steps: + + ### Check for checked in credentials. +- task: CredScan@3 + displayName: 'Run CredScan' + + ### Run PoliCheck to check for disallowed terms. targetType: F indicates we're searching files and folders. +- task: PoliCheck@1 + displayName: 'Run PoliCheck' + inputs: + targetType: F From 5b68e5a3a37aec9850079fb16e074eb9518ed1ac Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Sep 2020 23:10:41 -0600 Subject: [PATCH 0200/1753] Fix SignType variable on non-Windows agents --- azure-pipelines/variables/SignType.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/SignType.ps1 b/azure-pipelines/variables/SignType.ps1 index a2f7845e6..0c1a335aa 100644 --- a/azure-pipelines/variables/SignType.ps1 +++ b/azure-pipelines/variables/SignType.ps1 @@ -2,8 +2,8 @@ if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9') { if ($env:BUILD_REASON -eq 'Schedule') { 'real' } else { - if ($env:SignTypeSelection) { - $env:SignTypeSelection + if ($env:SIGNTYPESELECTION) { + $env:SIGNTYPESELECTION } else { 'test' } From 19da325b6bb3aa7d61195098c546e6d0ed58cf31 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Sep 2020 09:24:48 -0600 Subject: [PATCH 0201/1753] Add `Nullable` package --- Directory.Build.props | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 8bb360bf0..4e95413bf 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,10 +24,11 @@ + - + From e00b38d09ce88c091325e6c572b397827b146683 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Sep 2020 12:26:36 -0600 Subject: [PATCH 0202/1753] Checkout ps1 with LF endings --- .gitattributes | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.gitattributes b/.gitattributes index 9b6ea6248..c22a129ef 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,8 +3,9 @@ ############################################################################### * text=auto -# Ensure bash shell scripts use LF line endings +# Ensure shell scripts use LF line endings (linux only accepts LF) *.sh eol=lf +*.ps1 eol=lf ############################################################################### # Set default behavior for command prompt diff. @@ -20,7 +21,7 @@ # # Merging from the command prompt will add diff markers to the files if there # are conflicts (Merging from VS is not affected by the settings below, in VS -# the diff markers are never inserted). Diff markers may cause the following +# the diff markers are never inserted). Diff markers may cause the following # file extensions to fail to load in VS. An alternative would be to treat # these files as binary and thus will always conflict and require user # intervention with every merge. To do so, just uncomment the entries below @@ -49,9 +50,9 @@ ############################################################################### # diff behavior for common document formats -# +# # Convert binary document formats to text before diffing them. This feature -# is only available from the command line. Turn it on by uncommenting the +# is only available from the command line. Turn it on by uncommenting the # entries below. ############################################################################### #*.doc diff=astextplain From 4765380c9ee5f82d2622728cfb4397d93e23a265 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 30 Mar 2020 10:00:18 -0600 Subject: [PATCH 0203/1753] Reorder TFMs in test project This gets the default run (and only run from VS Code) to work on Linux. --- test/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index b48b5d81a..2b7800299 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -2,7 +2,7 @@ - net472;netcoreapp2.1;netcoreapp3.1 + netcoreapp3.1;netcoreapp2.1;net472 false true From 68153893f540a33cd449500c5ca742888928e54e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Sep 2020 13:50:58 -0600 Subject: [PATCH 0204/1753] Add devcontainer.json Also add other supporting files so that the VS Code 'dev container' scenario and GitHub Codespaces works nicely. --- .devcontainer/Dockerfile | 8 ++++++++ .devcontainer/devcontainer.json | 16 ++++++++++++++++ .vscode/extensions.json | 4 +++- .vscode/launch.json | 14 ++++++++++++++ .vscode/tasks.json | 17 +++++++++++++++++ 5 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json create mode 100644 .vscode/launch.json create mode 100644 .vscode/tasks.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 000000000..c551ecf23 --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,8 @@ +FROM mcr.microsoft.com/dotnet/core/sdk:3.1-bionic + +# Installing mono makes `dotnet test` work without errors even for net472. +# But installing it takes a long time, so it's excluded by default. +#RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF +#RUN echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic main" | tee /etc/apt/sources.list.d/mono-official-stable.list +#RUN apt-get update +#RUN DEBIAN_FRONTEND=noninteractive apt-get install -y mono-devel diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..9a86e07da --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,16 @@ +{ + "name": "Dev space", + "dockerFile": "Dockerfile", + "postCreateCommand": "./init.ps1 -InstallLocality machine", + "extensions": [ + "ms-azure-devops.azure-pipelines", + "ms-dotnettools.csharp", + "k--kato.docomment", + "editorconfig.editorconfig", + "pflannery.vscode-versionlens", + "davidanson.vscode-markdownlint", + "dotjoshjohnson.xml", + "ms-vscode-remote.remote-containers", + "ms-azuretools.vscode-docker" + ] +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json index ecda668ec..4ca016163 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -9,7 +9,9 @@ "editorconfig.editorconfig", "pflannery.vscode-versionlens", "davidanson.vscode-markdownlint", - "dotjoshjohnson.xml" + "dotjoshjohnson.xml", + "ms-vscode-remote.remote-containers", + "ms-azuretools.vscode-docker" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. "unwantedRecommendations": [] diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 000000000..a6e4859c2 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,14 @@ +{ + // Use IntelliSense to find out which attributes exist for C# debugging + // Use hover for the description of the existing attributes + // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md + "version": "0.2.0", + "configurations": [ + { + "name": ".NET Core Attach", + "type": "coreclr", + "request": "attach", + "processId": "${command:pickProcess}" + } + ] +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 000000000..67b06180f --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,17 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "command": "dotnet", + "type": "process", + "args": [ + "build", + "${workspaceFolder}", + "/property:GenerateFullPaths=true", + "/consoleloggerparameters:NoSummary" + ], + "problemMatcher": "$msCompile" + } + ] +} From e1294286706d94b02029da23aa48ab177fa8d494 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Sep 2020 17:59:29 -0600 Subject: [PATCH 0205/1753] Honor .editorconfig in Omnisharp --- .vscode/settings.json | 5 ++++- test/Library.Tests/CalculatorTests.cs | 7 +------ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index f0cafc05f..00aaed88f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,8 @@ { "files.trimTrailingWhitespace": true, "files.insertFinalNewline": true, - "files.trimFinalNewlines": true + "files.trimFinalNewlines": true, + "omnisharp.enableEditorConfigSupport": true, + "omnisharp.enableImportCompletion": true, + "omnisharp.enableRoslynAnalyzers": true } diff --git a/test/Library.Tests/CalculatorTests.cs b/test/Library.Tests/CalculatorTests.cs index 84fe9a97c..44e89aaa4 100644 --- a/test/Library.Tests/CalculatorTests.cs +++ b/test/Library.Tests/CalculatorTests.cs @@ -1,18 +1,13 @@ // Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System; using Library; using Xunit; -using Xunit.Abstractions; public class CalculatorTests { - private readonly ITestOutputHelper logger; - - public CalculatorTests(ITestOutputHelper logger) + public CalculatorTests() { - this.logger = logger; } [Fact] From aed5ff61d26dc1aa77f1eeeb73ddc47a640b1c39 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 26 Sep 2020 21:07:19 -0600 Subject: [PATCH 0206/1753] Fix RootNamespace property to actually take effect --- test/Directory.Build.props | 1 - test/Library.Tests/Library.Tests.csproj | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 2b7800299..2371a7ef5 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -5,7 +5,6 @@ netcoreapp3.1;netcoreapp2.1;net472 false true - diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index ea4220b9a..3565372a8 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -1,5 +1,9 @@ + + + + From ed5a2c7d9c9251c19276fba9035608daf26cccff Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 28 Sep 2020 08:24:57 -0600 Subject: [PATCH 0207/1753] Bump MicroBuild signing plugin to v3 --- azure-pipelines/microbuild.before.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index b1efae6e9..206c18792 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,5 +1,5 @@ steps: -- task: MicroBuildSigningPlugin@2 +- task: MicroBuildSigningPlugin@3 inputs: signType: $(SignType) zipSources: false From 41d2e5533ffdacbb6abf9555860bead64cbcd1ea Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 30 Sep 2020 17:19:25 +0000 Subject: [PATCH 0208/1753] Use PowerShell as the preferred terminal --- .devcontainer/devcontainer.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 9a86e07da..996302820 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,6 +1,9 @@ { "name": "Dev space", "dockerFile": "Dockerfile", + "settings": { + "terminal.integrated.shell.linux": "/usr/bin/pwsh" + }, "postCreateCommand": "./init.ps1 -InstallLocality machine", "extensions": [ "ms-azure-devops.azure-pipelines", From fa5d1e6eacf9de4a29fdf9d429541e33d0ddc8d2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 13 Oct 2020 16:05:42 -0500 Subject: [PATCH 0209/1753] Bump Nerdbank.GitVersioning from 3.2.31 to 3.3.37 (#75) Bumps [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) from 3.2.31 to 3.3.37. - [Release notes](https://github.com/dotnet/Nerdbank.GitVersioning/releases) - [Commits](https://github.com/dotnet/Nerdbank.GitVersioning/compare/v3.2.31...v3.3.37) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 4e95413bf..7fb8d8263 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -27,7 +27,7 @@ - + From bfd65cceb1895c72d04008ee5bcb9abed1f4d6dc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Oct 2020 08:23:21 -0600 Subject: [PATCH 0210/1753] Print mono version in Azure Pipelines --- azure-pipelines/install-dependencies.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index f773f3853..7563bc1f8 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -7,6 +7,11 @@ steps: $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors .\init.ps1 -AccessToken $AccessToken ${{ parameters['initArgs'] }} -UpgradePrerequisites dotnet --info + + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } displayName: Install prerequisites - powershell: azure-pipelines/variables/_pipelines.ps1 From d565e565887678c06b0fe4194944cbbe1b1565cb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Oct 2020 21:41:27 -0600 Subject: [PATCH 0211/1753] Add auto-insertion schedule --- azure-pipelines/build.yml | 4 ++++ azure-pipelines/official.yml | 6 ++++++ azure-pipelines/schedule-only-steps.yml | 3 +++ 3 files changed, 13 insertions(+) create mode 100644 azure-pipelines/schedule-only-steps.yml diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index b42cc549d..bea76aa39 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -9,6 +9,10 @@ jobs: steps: - checkout: self clean: true + + - ${{ if eq(variables['Build.Reason'], 'Schedule') }}: + - template: schedule-only-steps.yml + - template: install-dependencies.yml - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index e2957470e..5515aa489 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -9,6 +9,12 @@ trigger: - doc/ - '*.md' - .vscode/ +#schedules: +#- cron: "0 3 * * *" # Daily @ 8 PM PST +# displayName: Daily vs-insertion +# branches: +# include: +# - microbuild parameters: - name: SignTypeSelection diff --git a/azure-pipelines/schedule-only-steps.yml b/azure-pipelines/schedule-only-steps.yml new file mode 100644 index 000000000..ad07a341b --- /dev/null +++ b/azure-pipelines/schedule-only-steps.yml @@ -0,0 +1,3 @@ +steps: +- powershell: echo "##vso[build.addbuildtag]auto-insertion" + displayName: Tag for auto-insertion From 5fdb2443f20647acb95316eaa1c39f94422a8f39 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Oct 2020 07:42:32 -0600 Subject: [PATCH 0212/1753] Update dependencies monthly instead of weekly --- .github/dependabot.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index aa48b0fe7..b9b0f54a2 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,4 +6,4 @@ updates: - package-ecosystem: nuget directory: / schedule: - interval: weekly + interval: monthly From ae3cf160dfc211aff23cb523c7dbd0444b9e3f51 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Oct 2020 08:49:32 -0600 Subject: [PATCH 0213/1753] Add missing release-deployment-prep.yml file --- azure-pipelines/release-deployment-prep.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 azure-pipelines/release-deployment-prep.yml diff --git a/azure-pipelines/release-deployment-prep.yml b/azure-pipelines/release-deployment-prep.yml new file mode 100644 index 000000000..6dee28e5a --- /dev/null +++ b/azure-pipelines/release-deployment-prep.yml @@ -0,0 +1,9 @@ +steps: +- download: CI + artifact: Variables-Windows + displayName: Download Variables-Windows artifact +- task: PowerShell@2 + displayName: Set VSTS variables based on artifacts + inputs: + targetType: filePath + filePath: $(Pipeline.Workspace)/CI/Variables-Windows/_pipelines.ps1 From 7468032f6778fb28ceb8d5654f2be5f70005d791 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Oct 2020 08:58:32 -0600 Subject: [PATCH 0214/1753] Fix push to nuget.org --- azure-pipelines/release.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index bfe5987cd..0ef91cb3a 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -58,7 +58,6 @@ stages: - download: CI artifact: deployables-Windows displayName: Download deployables-Windows artifact - patterns: 'deployables-Windows/*' - task: NuGetToolInstaller@1 displayName: Use NuGet 5.x inputs: @@ -67,6 +66,6 @@ stages: displayName: NuGet push inputs: command: push - packagesToPush: $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg + packagesToPush: $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg nuGetFeedType: external publishFeedCredentials: # TODO: fill in service connection here From 4f2a03546774ba1f8312a2c3c8d4838aff43ca13 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Oct 2020 09:05:58 -0600 Subject: [PATCH 0215/1753] Add release notes link to built package --- Directory.Build.props | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Directory.Build.props b/Directory.Build.props index 7fb8d8263..7ced2673b 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -41,6 +41,13 @@ + + + + + + + false true From 02211a9bc3558d0048b57fc7e5739e2f24d89753 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Oct 2020 12:30:22 -0600 Subject: [PATCH 0216/1753] Replace company placeholder for Microsoft --- Directory.Build.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 9620269ca..c6264a381 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -9,9 +9,9 @@ enable true - COMPANY-PLACEHOLDER - COMPANY-PLACEHOLDER - © COMPANY-PLACEHOLDER. All rights reserved. + Microsoft + Microsoft + © Microsoft Corporation. All rights reserved. MIT true true From e3e2c9ba25855d12d4a253bca72fff72bbe1e790 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 25 Oct 2020 21:22:58 -0600 Subject: [PATCH 0217/1753] Fix template expansion --- Expand-Template.ps1 | 13 +------------ LICENSE | 2 +- src/Library/Calculator.cs | 2 +- stylecop.json | 2 +- test/Library.Tests/CalculatorTests.cs | 2 +- 5 files changed, 5 insertions(+), 16 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index ca081d3b3..abd7fad00 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -17,7 +17,7 @@ A switch that causes all of git history to be squashed to just one initial commi Param( [Parameter(Mandatory=$true)] [string]$LibraryName, - [Parameter(Mandatory=$true)] + [Parameter()] [string]$Author = "Microsoft Corporation", [Parameter()] [string]$CodeCovToken, @@ -127,20 +127,9 @@ try { # Replace placeholders in source files Replace-Placeholders -Path "src/$LibraryName/Calculator.cs" -Replacements @{ 'Library'=$LibraryName - 'COMPANY-PLACEHOLDER'=$Author } Replace-Placeholders -Path "test/$LibraryName.Tests/CalculatorTests.cs" -Replacements @{ 'Library'=$LibraryName - 'COMPANY-PLACEHOLDER'=$Author - } - Replace-Placeholders -Path "LICENSE" -Replacements @{ - 'COMPANY-PLACEHOLDER'=$Author - } - Replace-Placeholders -Path "stylecop.json" -Replacements @{ - 'COMPANY-PLACEHOLDER'=$Author - } - Replace-Placeholders -Path "Directory.Build.props" -Replacements @{ - 'COMPANY-PLACEHOLDER'=$Author } Replace-Placeholders -Path "README.md" -Replacements @{ "(?m)^.*\[NuGet package\][^`r`n]*"="[![NuGet package](https://img.shields.io/nuget/v/$LibraryName.svg)](https://nuget.org/packages/$LibraryName)" diff --git a/LICENSE b/LICENSE index 44122ac6e..5ae193c94 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) COMPANY-PLACEHOLDER +Copyright (c) Microsoft Corporation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/src/Library/Calculator.cs b/src/Library/Calculator.cs index 9156a1a34..84da575f8 100644 --- a/src/Library/Calculator.cs +++ b/src/Library/Calculator.cs @@ -1,4 +1,4 @@ -// Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. +// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. namespace Library diff --git a/stylecop.json b/stylecop.json index 379189493..2453d57c0 100644 --- a/stylecop.json +++ b/stylecop.json @@ -2,7 +2,7 @@ "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "settings": { "documentationRules": { - "companyName": "COMPANY-PLACEHOLDER", + "companyName": "Microsoft Corporation", "copyrightText": "Copyright (c) {companyName}. All rights reserved.\nLicensed under the {licenseName} license. See {licenseFile} file in the project root for full license information.", "variables": { "licenseName": "MIT", diff --git a/test/Library.Tests/CalculatorTests.cs b/test/Library.Tests/CalculatorTests.cs index 44e89aaa4..cc6c0ea32 100644 --- a/test/Library.Tests/CalculatorTests.cs +++ b/test/Library.Tests/CalculatorTests.cs @@ -1,4 +1,4 @@ -// Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. +// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. using Library; From 3df3788623a3dd622095bdb7ae1f761bd6474971 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 25 Oct 2020 21:36:40 -0600 Subject: [PATCH 0218/1753] Avoid warnings in Expand-Template due to line endings --- Expand-Template.ps1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index abd7fad00..b3eb5f4ff 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -92,6 +92,8 @@ try { if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } } + git config core.safecrlf false # Avoid warnings when adding files with mangled line endings + # Rename project directories and solution git mv Library.sln "$LibraryName.sln" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } @@ -190,6 +192,7 @@ try { } } finally { + git config --local --unset core.safecrlf Pop-Location } From 958ffedb97ea213d52b76e04af515e31b1342eba Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 25 Oct 2020 21:36:40 -0600 Subject: [PATCH 0219/1753] Avoid warnings in Expand-Template due to line endings --- Expand-Template.ps1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index c6ae8cba2..d665e56a3 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -96,6 +96,8 @@ try { if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } } + git config core.safecrlf false # Avoid warnings when adding files with mangled line endings + # Rename project directories and solution git mv Library.sln "$LibraryName.sln" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } @@ -204,6 +206,7 @@ try { } } finally { + git config --local --unset core.safecrlf Pop-Location } From 05b332401c7545ac7c669f59defdcf796d4925e9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 1 Nov 2020 06:14:20 -0700 Subject: [PATCH 0220/1753] Bump Microsoft.CodeAnalysis.FxCopAnalyzers from 3.3.0 to 3.3.1 (#76) Bumps [Microsoft.CodeAnalysis.FxCopAnalyzers](https://github.com/dotnet/roslyn-analyzers) from 3.3.0 to 3.3.1. - [Release notes](https://github.com/dotnet/roslyn-analyzers/releases) - [Changelog](https://github.com/dotnet/roslyn-analyzers/blob/master/PostReleaseActivities.md) - [Commits](https://github.com/dotnet/roslyn-analyzers/compare/v3.3.0...v3.3.1) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 7ced2673b..642fb1d7d 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -23,7 +23,7 @@ - + From 9c16ae2061cf5dc70b79c9cfa94bac9e95a978c8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 2 Nov 2020 09:48:52 -0700 Subject: [PATCH 0221/1753] Publish test symbols on failures When investigating test run failures from Azure Pipelines, symbols from test binaries may be just as important as symbols from product binaries. So publish them as pipeline artifacts as well. Also index all these symbols even in PR builds, since PR builds may fail and investigations may be required. --- azure-pipelines/Get-SymbolFiles.ps1 | 67 ++++++++++++++++++++++ azure-pipelines/artifacts/symbols.ps1 | 54 +---------------- azure-pipelines/artifacts/test_symbols.ps1 | 12 ++++ azure-pipelines/dotnet.yml | 11 +++- 4 files changed, 90 insertions(+), 54 deletions(-) create mode 100644 azure-pipelines/Get-SymbolFiles.ps1 create mode 100644 azure-pipelines/artifacts/test_symbols.ps1 diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 new file mode 100644 index 000000000..bba177f1a --- /dev/null +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -0,0 +1,67 @@ +<# +.SYNOPSIS + Collect the list of PDBs built in this repo, after converting them from portable to Windows PDBs. +.PARAMETER Path + The root path to recursively search for PDBs. +.PARAMETER Tests + A switch indicating to find test-related PDBs instead of product-only PDBs. +#> +[CmdletBinding()] +param ( + [parameter(Mandatory=$true)] + [string]$Path, + [switch]$Tests +) + +$WindowsPdbSubDirName = "symstore" + +$ActivityName = "Collecting symbols from $Path" +Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" +$PDBs = Get-ChildItem -rec "$Path\*.pdb" |? { $_.FullName -notmatch "\W$WindowsPdbSubDirName\W" } + +# Filter PDBs to product OR test related. +$testregex = "unittest|tests" +if ($Tests) { + $PDBs = $PDBs |? { $_.FullName -match $testregex } +} else { + $PDBs = $PDBs |? { $_.FullName -notmatch $testregex } +} + +Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" +$PDBsByHash = @{} +$i = 0 +$PDBs |% { + Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" -PercentComplete (100 * $i / $PDBs.Length) + $hash = Get-FileHash $_ + $i++ + Add-Member -InputObject $_ -MemberType NoteProperty -Name Hash -Value $hash.Hash + Write-Output $_ +} | Sort-Object CreationTime |% { + # De-dupe based on hash. Prefer the first match so we take the first built copy. + if (-not $PDBsByHash.ContainsKey($_.Hash)) { + $PDBsByHash.Add($_.Hash, $_.FullName) + Write-Output $_ + } +} |% { + # Collect the DLLs/EXEs as well. + $dllPath = "$($_.Directory)\$($_.BaseName).dll" + $exePath = "$($_.Directory)\$($_.BaseName).exe" + if (Test-Path $dllPath) { + $BinaryImagePath = $dllPath + } elseif (Test-Path $exePath) { + $BinaryImagePath = $exePath + } + + Write-Output $BinaryImagePath + + # Convert the PDB to legacy Windows PDBs + Write-Host "Converting PDB for $_" -ForegroundColor DarkGray + $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" + if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } + & "$PSScriptRoot\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath "$WindowsPdbDir\$($_.BaseName).pdb" + if ($LASTEXITCODE -ne 0) { + Write-Warning "PDB conversion of `"$_`" failed." + } + + Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" +} diff --git a/azure-pipelines/artifacts/symbols.ps1 b/azure-pipelines/artifacts/symbols.ps1 index 504913689..b3451ce1e 100644 --- a/azure-pipelines/artifacts/symbols.ps1 +++ b/azure-pipelines/artifacts/symbols.ps1 @@ -1,55 +1,3 @@ -Function Get-SymbolFiles { - [CmdletBinding()] - param ( - [parameter(Mandatory=$true)] - [string]$Path - ) - - $WindowsPdbSubDirName = "symstore" - - $ActivityName = "Collecting symbols from $Path" - Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" - $PDBs = Get-ChildItem -rec "$Path\*.pdb" |? { $_.FullName -notmatch "unittest|tests|\W$WindowsPdbSubDirName\W" } - Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" - $PDBsByHash = @{} - $i = 0 - $PDBs |% { - Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" -PercentComplete (100 * $i / $PDBs.Length) - $hash = Get-FileHash $_ - $i++ - Add-Member -InputObject $_ -MemberType NoteProperty -Name Hash -Value $hash.Hash - Write-Output $_ - } | Sort-Object CreationTime |% { - # De-dupe based on hash. Prefer the first match so we take the first built copy. - if (-not $PDBsByHash.ContainsKey($_.Hash)) { - $PDBsByHash.Add($_.Hash, $_.FullName) - Write-Output $_ - } - } |% { - # Collect the DLLs/EXEs as well. - $dllPath = "$($_.Directory)\$($_.BaseName).dll" - $exePath = "$($_.Directory)\$($_.BaseName).exe" - if (Test-Path $dllPath) { - $BinaryImagePath = $dllPath - } elseif (Test-Path $exePath) { - $BinaryImagePath = $exePath - } - - Write-Output $BinaryImagePath - - # Convert the PDB to legacy Windows PDBs - Write-Host "Converting PDB for $_" -ForegroundColor DarkGray - $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" - if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } - & "$PSScriptRoot\..\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath "$WindowsPdbDir\$($_.BaseName).pdb" - if ($LASTEXITCODE -ne 0) { - Write-Warning "PDB conversion of `"$_`" failed." - } - - Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" - } -} - # This doesn't work off Windows, nor do we need to convert symbols on multiple OS agents if ($IsMacOS -or $IsLinux) { return; @@ -57,7 +5,7 @@ if ($IsMacOS -or $IsLinux) { $BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") if (!(Test-Path $BinPath)) { return } -$symbolfiles = Get-SymbolFiles -Path $BinPath | Get-Unique +$symbolfiles = & "$PSScriptRoot\..\Get-SymbolFiles.ps1" -Path $BinPath | Get-Unique @{ "$BinPath" = $SymbolFiles; diff --git a/azure-pipelines/artifacts/test_symbols.ps1 b/azure-pipelines/artifacts/test_symbols.ps1 new file mode 100644 index 000000000..d65ad0ae5 --- /dev/null +++ b/azure-pipelines/artifacts/test_symbols.ps1 @@ -0,0 +1,12 @@ +# This doesn't work off Windows, nor do we need to convert symbols on multiple OS agents +if ($IsMacOS -or $IsLinux) { + return; +} + +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") +if (!(Test-Path $BinPath)) { return } +$symbolfiles = & "$PSScriptRoot\..\Get-SymbolFiles.ps1" -Path $BinPath -Tests | Get-Unique + +@{ + "$BinPath" = $SymbolFiles; +} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 8f4e950f0..e664ecd3c 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -47,7 +47,16 @@ steps: IndexSources: false SymbolServerType: TeamServices displayName: Publish symbols to symbol server - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'), eq(variables['Agent.OS'], 'Windows_NT')) + condition: eq(variables['Agent.OS'], 'Windows_NT') # Execute on failed test runs too. Windows-only till https://github.com/microsoft/azure-pipelines-tasks/issues/13821 is fixed. + +- task: PublishSymbols@2 + inputs: + SymbolsFolder: $(Build.ArtifactStagingDirectory)/test_symbols-$(Agent.JobName) + SearchPattern: '**/*.pdb' + IndexSources: false + SymbolServerType: TeamServices + displayName: Publish test symbols to symbol server + condition: and(failed(), eq(variables['Agent.OS'], 'Windows_NT')) # Execute on failed test runs only. - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io From 1ba201241f4ab86578fd26e6f0489aaa620268cc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 2 Nov 2020 11:17:29 -0700 Subject: [PATCH 0222/1753] Remove macOS from Azure Pipeline runs --- azure-pipelines.yml | 8 ++++++++ azure-pipelines/build.yml | 4 ++++ azure-pipelines/publish-codecoverage.yml | 4 ++++ 3 files changed, 16 insertions(+) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 22f8b5530..bba62459d 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -10,6 +10,12 @@ trigger: - .vscode/ - .github/ +parameters: +- name: includeMacOS + displayName: Build on macOS + type: boolean + default: false # macOS is often bogged down in Azure Pipelines + variables: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true @@ -20,3 +26,5 @@ variables: jobs: - template: azure-pipelines/build.yml + parameters: + includeMacOS: ${{ parameters.includeMacOS }} diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 186438a1b..b4561394c 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -1,5 +1,6 @@ parameters: windowsPool: Hosted Windows 2019 with VS2019 + includeMacOS: jobs: - job: Windows @@ -26,6 +27,7 @@ jobs: - template: expand-template.yml - job: macOS + condition: ${{ parameters.includeMacOS }} pool: vmImage: macOS-10.15 steps: @@ -50,4 +52,6 @@ jobs: parameters: initArgs: -NoRestore - template: publish-codecoverage.yml + parameters: + includeMacOS: ${{ parameters.includeMacOS }} - template: publish-deployables.yml diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 976f0781b..0112aacf7 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -1,3 +1,6 @@ +parameters: + includeMacOS: + steps: - download: current artifact: coverageResults-Windows @@ -11,6 +14,7 @@ steps: artifact: coverageResults-macOS displayName: Download macOS code coverage results continueOnError: true + condition: ${{ parameters.includeMacOS }} - powershell: | dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj From f0f17b4981e70505e9bf44b9c30841ba62fabd8c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 2 Nov 2020 12:50:51 -0700 Subject: [PATCH 0223/1753] Use scale set agent pool for official builds --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 5515aa489..49bbf65b4 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -38,7 +38,7 @@ stages: jobs: - template: build.yml parameters: - windowsPool: VSEng-MicroBuildVS2019 + windowsPool: VSEngSS-MicroBuild2019 - stage: symbol_archive displayName: Symbol archival From d4b9a6afcd2fd37fe66be60a2ad9888a194cf53f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Nov 2020 10:05:53 -0700 Subject: [PATCH 0224/1753] Capture binlog for test runs --- azure-pipelines/dotnet.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index e664ecd3c..5c498fc9a 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -10,7 +10,7 @@ steps: displayName: dotnet test -f net472 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" + arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net472.binlog" testRunTitle: net472-$(Agent.JobName) condition: succeededOrFailed() @@ -18,7 +18,7 @@ steps: displayName: dotnet test -f netcoreapp2.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp2.1.binlog" testRunTitle: netcoreapp2.1-$(Agent.JobName) condition: succeededOrFailed() @@ -26,7 +26,7 @@ steps: displayName: dotnet test -f netcoreapp3.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp3.1.binlog" testRunTitle: netcoreapp3.1-$(Agent.JobName) condition: succeededOrFailed() From 9cd3529dc29a092a0e32ce3bbcbf0fe48761ae80 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Nov 2020 09:06:02 -0700 Subject: [PATCH 0225/1753] Add InsertPropsValues.ps1 variable This gets a VS insertion to participate in the newer PackageReference too. --- azure-pipelines/variables/InsertPropsValues.ps1 | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 azure-pipelines/variables/InsertPropsValues.ps1 diff --git a/azure-pipelines/variables/InsertPropsValues.ps1 b/azure-pipelines/variables/InsertPropsValues.ps1 new file mode 100644 index 000000000..05df93b7b --- /dev/null +++ b/azure-pipelines/variables/InsertPropsValues.ps1 @@ -0,0 +1,14 @@ +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BUILDCONFIGURATION") + +$dirsToSearch = "$BinPath\NuGet\*.nupkg" |? { Test-Path $_ } +$icv=@() +if ($dirsToSearch) { + Get-ChildItem -Path $dirsToSearch |% { + if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + $id = $Matches[1] + $version = $Matches[2] + } + } +} + +Write-Output ([string]::join(',',$icv)) From f29f68a9dd73bef18349510da43de5c25a2aa580 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Nov 2020 15:11:24 -0700 Subject: [PATCH 0226/1753] Use simpler task names --- azure-pipelines/microbuild.after.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 38f53b584..6e29912b1 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,5 +1,5 @@ steps: -- task: ms-vseng.MicroBuildShipTasks.7c429315-71ba-4cb3-94bb-f829c95f7915.MicroBuildCodesignVerify@2 +- task: MicroBuildCodesignVerify@2 displayName: Verify Signed Files inputs: TargetFolders: | @@ -9,11 +9,11 @@ steps: condition: succeededOrFailed() displayName: MicroBuild Cleanup -- task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0 +- task: ComponentGovernanceComponentDetection@0 displayName: Component Detection condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) -- task: Ref12.ref12-analyze-task.ref12-analyze-task.Ref12Analyze@0 +- task: Ref12Analyze@0 displayName: Ref12 (Codex) Analyze inputs: codexoutputroot: $(Build.ArtifactStagingDirectory)\Codex From c234c68d0b45e5cc621db26063c199b51b4a45fd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Nov 2020 08:51:22 -0700 Subject: [PATCH 0227/1753] Update to .NET 5.0.100 SDK --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index a2e8ff9ec..e6e7ee5c0 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.402", + "version": "5.0.100", "rollForward": "patch", "allowPrerelease": false } From d8b3fc060bc43cc9e0371a62720e2b828c72f308 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 16 Nov 2020 09:48:54 -0700 Subject: [PATCH 0228/1753] Adapt to GitHub's new env and path operations Fixes #79 --- azure-pipelines/variables/_pipelines.ps1 | 2 +- tools/Set-EnvVars.ps1 | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 552995509..867b7fc8b 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -17,7 +17,7 @@ # and the second that works across jobs and stages but must be fully qualified when referenced. Write-Host "##vso[task.setvariable variable=$keyCaps;isOutput=true]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { - Write-Host "::set-env name=$keyCaps::$($_.Value)" + Add-Content -Path $env:GITHUB_ENV -Value "$keyCaps=$($_.Value)" } Set-Item -Path "env:$keyCaps" -Value $_.Value } diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index bde2e3438..3f6f86ba5 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -52,7 +52,7 @@ $Variables.GetEnumerator() |% { Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" } if ($env:GITHUB_ACTIONS) { - Write-Host "::set-env name=$($_.Key)::$($_.Value)" + Add-Content -Path $env:GITHUB_ENV -Value "$($_.Key)=$($_.Value)" } if ($cmdInstructions) { @@ -79,7 +79,7 @@ if ($PrependPath) { Write-Host "##vso[task.prependpath]$_" } if ($env:GITHUB_ACTIONS) { - Write-Host "::add-path::$_" + Add-Content -Path $env:GITHUB_PATH -Value $_ } $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" From 759f9645c2ff5385c00f7c7e7a1613fba9628f8a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Nov 2020 08:45:06 -0700 Subject: [PATCH 0229/1753] Add .NET 5.0 as a tested runtime --- Directory.Build.props | 2 +- azure-pipelines/dotnet.yml | 8 ++++++++ test/Directory.Build.props | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 642fb1d7d..ae6f905bb 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,7 +24,7 @@ - + diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 5c498fc9a..34db9a40b 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -30,6 +30,14 @@ steps: testRunTitle: netcoreapp3.1-$(Agent.JobName) condition: succeededOrFailed() +- task: DotNetCoreCLI@2 + displayName: dotnet test -f net5.0 + inputs: + command: test + arguments: --no-build -c $(BuildConfiguration) -f net5.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0.binlog" + testRunTitle: net5.0-$(Agent.JobName) + condition: succeededOrFailed() + - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: Update pipeline variables based on build outputs diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 2371a7ef5..4803641a5 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -2,7 +2,7 @@ - netcoreapp3.1;netcoreapp2.1;net472 + net5.0;netcoreapp3.1;netcoreapp2.1;net472 false true From 80928a35fc7d1499cadfd62f3e656ccb713a3c2f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Nov 2020 08:46:15 -0700 Subject: [PATCH 0230/1753] Update package dependencies --- Directory.Build.props | 4 ++-- test/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 642fb1d7d..db63a1898 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,12 +24,12 @@ - + - + diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 3565372a8..ee3b3ae6f 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From 14dc279ad8ce1a6d85706ddd8aadf7bed47decbe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 1 Dec 2020 14:53:50 -0700 Subject: [PATCH 0231/1753] Add stock MSFT starter files --- CODE_OF_CONDUCT.md | 9 +++++++++ SECURITY.md | 41 +++++++++++++++++++++++++++++++++++++++++ SUPPORT.md | 25 +++++++++++++++++++++++++ 3 files changed, 75 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 SECURITY.md create mode 100644 SUPPORT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..f9ba8cf65 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ +# Microsoft Open Source Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + +Resources: + +- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) +- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..f7b89984f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,41 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). + +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). + +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). + + \ No newline at end of file diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 000000000..8b05616fc --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,25 @@ +# TODO: The maintainer of this repo has not yet edited this file + +**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project? + +- **No CSS support:** Fill out this template with information about how to file issues and get help. +- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). +- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide. + +*Then remove this first heading from this SUPPORT.MD file before publishing your repo.* + +# Support + +## How to file issues and get help + +This project uses GitHub Issues to track bugs and feature requests. Please search the existing +issues before filing new issues to avoid duplicates. For new issues, file your bug or +feature request as a new Issue. + +For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE +FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER +CHANNEL. WHERE WILL YOU HELP PEOPLE?**. + +## Microsoft Support Policy + +Support for this **PROJECT or PRODUCT** is limited to the resources listed above. From eda964053b115e4adc55a34c70058b8d8e68eff4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Dec 2020 12:52:35 -0700 Subject: [PATCH 0232/1753] Update MicroBuild Insert task version --- azure-pipelines/vs-insertion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 75c54f316..90645cb21 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -37,7 +37,7 @@ stages: packagesToPush: $(Pipeline.Workspace)/CI/VSInsertion-windows/*.nupkg publishVstsFeed: 97a41293-2972-4f48-8c0e-05493ae82010 allowPackageConflicts: true - - task: MicroBuildInsertVsPayload@3 + - task: MicroBuildInsertVsPayload@4 displayName: Insert VS Payload inputs: TeamName: $(TeamName) From ee54c45f8f038d108bfbd4a1273b0f5d80553cf9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Dec 2020 13:08:36 -0700 Subject: [PATCH 0233/1753] Remove code to push to CI The feeds it was pushing to were obsolete anyway. --- azure-pipelines/official.yml | 1 - azure-pipelines/publish-deployables.yml | 10 ---------- azure-pipelines/variables/ci_feed.ps1 | 8 -------- 3 files changed, 19 deletions(-) delete mode 100644 azure-pipelines/variables/ci_feed.ps1 diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 5515aa489..e19311a66 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -31,7 +31,6 @@ stages: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release BuildPlatform: Any CPU - push_to_ci: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index 9cb41fc6b..5a981b26f 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -7,13 +7,3 @@ steps: displayName: Use NuGet 5.x inputs: versionSpec: 5.x - -- task: NuGetCommand@2 - displayName: Push packages to CI feed - inputs: - command: push - packagesToPush: $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg - nuGetFeedType: internal - publishVstsFeed: $(ci_feed) - allowPackageConflicts: true - condition: and(succeeded(), eq(variables['push_to_ci'], 'true'), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) diff --git a/azure-pipelines/variables/ci_feed.ps1 b/azure-pipelines/variables/ci_feed.ps1 deleted file mode 100644 index 82bad79da..000000000 --- a/azure-pipelines/variables/ci_feed.ps1 +++ /dev/null @@ -1,8 +0,0 @@ -$signType = $env:SIGNTYPE -if (!$signType) { $signType = & "$PSScriptRoot/SignType.ps1" } - -if ($signType -eq 'Real') { - '09d8d03c-1ac8-456e-9274-4d2364527d99' # VSIDE-RealSigned-Release -} else { - 'da484c78-f942-44ef-b197-99e2a1bef53c' # VSIDE-TestSigned-Release -} From 9ecac8356a944264348485e22e2fbfd9ec41cbe9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Dec 2020 13:13:46 -0700 Subject: [PATCH 0234/1753] Update team name --- azure-pipelines/variables/TeamName.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/TeamName.ps1 b/azure-pipelines/variables/TeamName.ps1 index 871749a58..d3e73642a 100644 --- a/azure-pipelines/variables/TeamName.ps1 +++ b/azure-pipelines/variables/TeamName.ps1 @@ -1 +1 @@ -'VS IDE' +'VS Core' From a6ae0b843a96eeed123234e9e6e6f6f6dce469c6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Dec 2020 20:25:40 -0700 Subject: [PATCH 0235/1753] Bring back code to support CI feeds, but just remove our existing CI feed. --- azure-pipelines/official.yml | 1 + azure-pipelines/publish-deployables.yml | 10 ++++++++++ 2 files changed, 11 insertions(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index e19311a66..5515aa489 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -31,6 +31,7 @@ stages: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release BuildPlatform: Any CPU + push_to_ci: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index 5a981b26f..9cb41fc6b 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -7,3 +7,13 @@ steps: displayName: Use NuGet 5.x inputs: versionSpec: 5.x + +- task: NuGetCommand@2 + displayName: Push packages to CI feed + inputs: + command: push + packagesToPush: $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg + nuGetFeedType: internal + publishVstsFeed: $(ci_feed) + allowPackageConflicts: true + condition: and(succeeded(), eq(variables['push_to_ci'], 'true'), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) From 3fa4f21b2326fb79aa47ceb8c7b5e2743ff7fb7d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Dec 2020 21:04:18 -0700 Subject: [PATCH 0236/1753] Add missing includeMacOS switch to official builds --- azure-pipelines/official.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 5515aa489..82532aa55 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -22,6 +22,10 @@ parameters: type: string default: Test values: [ 'Test', 'Real' ] +- name: includeMacOS + displayName: Build on macOS + type: boolean + default: false # macOS is often bogged down in Azure Pipelines stages: @@ -39,6 +43,7 @@ stages: - template: build.yml parameters: windowsPool: VSEng-MicroBuildVS2019 + includeMacOS: ${{ parameters.includeMacOS }} - stage: symbol_archive displayName: Symbol archival From bb90bbb9fbe6b6c69e7ea5392a7d334bf6c8286a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Dec 2020 21:24:59 -0700 Subject: [PATCH 0237/1753] Revert team name change It breaks symbol archival --- azure-pipelines/variables/TeamName.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/variables/TeamName.ps1 b/azure-pipelines/variables/TeamName.ps1 index d3e73642a..5f2822c50 100644 --- a/azure-pipelines/variables/TeamName.ps1 +++ b/azure-pipelines/variables/TeamName.ps1 @@ -1 +1,2 @@ -'VS Core' +# This value is used to craft a \\cpvsbuild\drops path for symbol archival. +'VS IDE' From 1aaddcfd2d397004c01aacd549136e06b80350bf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Dec 2020 16:16:48 -0700 Subject: [PATCH 0238/1753] Update code analysis --- .editorconfig | 3 +++ Directory.Build.props | 3 ++- test/.editorconfig | 6 ++++++ 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 15f0b0e6b..3be52e30b 100644 --- a/.editorconfig +++ b/.editorconfig @@ -165,5 +165,8 @@ csharp_prefer_braces = true:silent # SA1130: Use lambda syntax dotnet_diagnostic.SA1130.severity = silent +# CA1508: Avoid dead conditional code +dotnet_diagnostic.CA1508.severity = warning + [*.sln] indent_style = tab diff --git a/Directory.Build.props b/Directory.Build.props index ae6f905bb..dedb50b87 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -7,6 +7,7 @@ $(RepoRootPath)bin\Packages\$(Configuration)\ 8.0 enable + latest true true @@ -23,7 +24,7 @@ - + diff --git a/test/.editorconfig b/test/.editorconfig index 2abae62d7..19b19171d 100644 --- a/test/.editorconfig +++ b/test/.editorconfig @@ -21,6 +21,12 @@ dotnet_diagnostic.VSTHRD111.severity = none # VSTHRD200: Use Async suffix for async methods dotnet_diagnostic.VSTHRD200.severity = silent +# CA1014: Mark assemblies with CLSCompliant +dotnet_diagnostic.CA1014.severity = none + +# CA1050: Declare types in namespaces +dotnet_diagnostic.CA1050.severity = none + # CA1303: Do not pass literals as localized parameters dotnet_diagnostic.CA1303.severity = none From 3ecde23ecfbd8983ee613dee60ed2c0bfe140608 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Dec 2020 16:17:45 -0700 Subject: [PATCH 0239/1753] Update compiler toolset This applies the fix to https://github.com/dotnet/roslyn/issues/49882 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index dedb50b87..2253d3e56 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -25,7 +25,7 @@ - + From 20e22606dc0c5bd2349b1c847ea619809bbe3946 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Dec 2020 16:34:12 -0700 Subject: [PATCH 0240/1753] Download pdb2pdb from pkgs.dev.azure.com instead of dotnet.myget.org --- azure-pipelines/Convert-PDB.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 index a3212213b..cfdb23697 100644 --- a/azure-pipelines/Convert-PDB.ps1 +++ b/azure-pipelines/Convert-PDB.ps1 @@ -24,7 +24,7 @@ if (-not (Test-Path $pdb2pdbpath)) { if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } $baseDir = (Resolve-Path $baseDir).Path # Normalize it - & (& $PSScriptRoot\Get-NuGetTool.ps1) install pdb2pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://dotnet.myget.org/F/symreader-converter/api/v3/index.json | Out-Null + & (& $PSScriptRoot\Get-NuGetTool.ps1) install pdb2pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/myget-legacy/nuget/v3/index.json | Out-Null } $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' From 1e98c8f2c174806de3a82ca08b3834429a641bfc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Dec 2020 17:19:13 -0700 Subject: [PATCH 0241/1753] Update source and pkg id for pdb2pdb tool --- azure-pipelines/Convert-PDB.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 index cfdb23697..e9ecebcdb 100644 --- a/azure-pipelines/Convert-PDB.ps1 +++ b/azure-pipelines/Convert-PDB.ps1 @@ -18,13 +18,13 @@ [string]$OutputPath ) - $version = '1.1.0-beta1-64128-01' + $version = '1.1.0-beta2-20115-01' $baseDir = "$PSScriptRoot\..\obj\tools" - $pdb2pdbpath = "$baseDir\pdb2pdb.$version\tools\Pdb2Pdb.exe" + $pdb2pdbpath = "$baseDir\Microsoft.DiaSymReader.Pdb2Pdb.$version\tools\Pdb2Pdb.exe" if (-not (Test-Path $pdb2pdbpath)) { if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } $baseDir = (Resolve-Path $baseDir).Path # Normalize it - & (& $PSScriptRoot\Get-NuGetTool.ps1) install pdb2pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/myget-legacy/nuget/v3/index.json | Out-Null + & (& $PSScriptRoot\Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null } $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' From e48583cdb8b5fec1e8debd747952ac6275ff6285 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 17 Dec 2020 10:45:30 -0700 Subject: [PATCH 0242/1753] Update to .NET Core SDK 3.1.404 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index a2e8ff9ec..daed8e947 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "3.1.402", + "version": "3.1.404", "rollForward": "patch", "allowPrerelease": false } From f29842186805f5522ff168e2b4c61337c42759fd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 18 Dec 2020 17:52:49 -0700 Subject: [PATCH 0243/1753] Fix display name of symbol archival task --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 82532aa55..692d3deb7 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -64,7 +64,7 @@ stages: artifact: symbols-Windows displayName: Download symbols-Windows artifact - task: MicroBuildArchiveSymbols@1 - displayName: Archive $(SymbolsFeatureName) on Symweb + displayName: Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) SymbolsSymwebProject: VS From e36ce89e39e21d9adf14ca5e7aa4a9a684ee2701 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 1 Jan 2021 07:27:43 -0700 Subject: [PATCH 0244/1753] Bump Microsoft.NET.Test.Sdk from 16.8.0 to 16.8.3 (#85) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.8.0 to 16.8.3. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.8.0...v16.8.3) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index ee3b3ae6f..aef334c26 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From c8c97da661b70635c42b56d5c3e6111f62abc448 Mon Sep 17 00:00:00 2001 From: Julien Chomarat Date: Thu, 7 Jan 2021 11:06:16 +0100 Subject: [PATCH 0245/1753] Remove [*.cs] Remove the second [*.cs] because it is already declared at line 122 --- .editorconfig | 2 -- 1 file changed, 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index 15f0b0e6b..4937e1537 100644 --- a/.editorconfig +++ b/.editorconfig @@ -160,8 +160,6 @@ csharp_new_line_before_members_in_anonymous_types = true # Blocks are allowed csharp_prefer_braces = true:silent -[*.cs] - # SA1130: Use lambda syntax dotnet_diagnostic.SA1130.severity = silent From 3639f0321c4fb5bf4153f6c84c3e91cff68b244c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 15 Jan 2021 10:32:24 -0700 Subject: [PATCH 0246/1753] Bump version of codesign verify task --- azure-pipelines/microbuild.after.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 6e29912b1..55fee5ec2 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,5 +1,5 @@ steps: -- task: MicroBuildCodesignVerify@2 +- task: MicroBuildCodesignVerify@3 displayName: Verify Signed Files inputs: TargetFolders: | From e47af99c1a8ba0dd97b6370d5f1b214c39e2ef67 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 15 Jan 2021 10:36:00 -0700 Subject: [PATCH 0247/1753] Remove protocolVersion attribute from nuget.config This isn't necessary so long as the URL ends in `/index.json`. --- nuget.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuget.config b/nuget.config index c0173d1ba..68f36551f 100644 --- a/nuget.config +++ b/nuget.config @@ -6,6 +6,6 @@ - + From 15802d7d14fb2b3865b27e4099ce2fd05fdf9bb4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 15 Jan 2021 12:19:50 -0700 Subject: [PATCH 0248/1753] Clean up trailing line endings --- SUPPORT.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/SUPPORT.md b/SUPPORT.md index 8b05616fc..ecbe64c04 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -10,16 +10,16 @@ # Support -## How to file issues and get help +## How to file issues and get help -This project uses GitHub Issues to track bugs and feature requests. Please search the existing -issues before filing new issues to avoid duplicates. For new issues, file your bug or +This project uses GitHub Issues to track bugs and feature requests. Please search the existing +issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new Issue. -For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE +For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER CHANNEL. WHERE WILL YOU HELP PEOPLE?**. -## Microsoft Support Policy +## Microsoft Support Policy Support for this **PROJECT or PRODUCT** is limited to the resources listed above. From e7e6de897b7ec8f6a442fd5ab9008d1d8993f271 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Feb 2021 20:17:53 -0700 Subject: [PATCH 0249/1753] Bump coverlet.msbuild from 2.9.0 to 3.0.2 (#88) Bumps [coverlet.msbuild](https://github.com/coverlet-coverage/coverlet) from 2.9.0 to 3.0.2. - [Release notes](https://github.com/coverlet-coverage/coverlet/releases) - [Commits](https://github.com/coverlet-coverage/coverlet/commits) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index aef334c26..72782f198 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -9,7 +9,7 @@ - + From f52b382221eba041c184e3a70268d7799f52841d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 15 Jan 2021 12:19:50 -0700 Subject: [PATCH 0250/1753] Clean up trailing line endings --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 737df08ab..f23361448 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -68,7 +68,7 @@ stages: inputs: SymbolsFeatureName: $(SymbolsFeatureName) SymbolsSymwebProject: VS - SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildNumber)\Symbols.Archival + SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival SymbolsEmailContacts: vsidemicrobuild SymbolsAgentPath: $(Pipeline.Workspace)/symbols-Windows - task: MicroBuildCleanup@1 From 17ccfd1c617c6a3eaf6c95bedc5031404fb425a0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Nov 2020 08:51:22 -0700 Subject: [PATCH 0251/1753] Update to .NET 5.0.102 SDK --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index e6e7ee5c0..b95ee4da2 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.100", + "version": "5.0.102", "rollForward": "patch", "allowPrerelease": false } From 72d343729e63bc2cb098aab63e63f3a6e96d5e4d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 17:11:22 -0700 Subject: [PATCH 0252/1753] Update compilers --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 2253d3e56..c67b24ac4 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -25,7 +25,7 @@ - + From fba5eed179f121b5db92185215b15af7caa73266 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 17:33:40 -0700 Subject: [PATCH 0253/1753] Rename master branch to main --- .github/workflows/build.yml | 2 +- README.md | 4 ++-- azure-pipelines.yml | 2 +- version.json | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b9f17c23c..8567b4c9e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,7 +3,7 @@ name: CI on: push: branches: - - master + - main - validate/* pull_request: diff --git a/README.md b/README.md index 5424ff0a0..22d1091ef 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ ![NuGet package](https://img.shields.io/badge/nuget-your--package--here-yellow.svg) -[![Azure Pipelines status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/AArnott.Library.Template?branchName=master)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=29&branchName=master) +[![Azure Pipelines status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/AArnott.Library.Template?branchName=main)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=29&branchName=main) ![GitHub Actions status](https://github.com/aarnott/Library.Template/workflows/CI/badge.svg) -[![codecov](https://codecov.io/gh/aarnott/library.template/branch/master/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) +[![codecov](https://codecov.io/gh/aarnott/library.template/branch/main/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) ## Features diff --git a/azure-pipelines.yml b/azure-pipelines.yml index bba62459d..2e4b2c157 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,7 +1,7 @@ trigger: branches: include: - - master + - main - 'validate/*' paths: exclude: diff --git a/version.json b/version.json index a13f567b5..f0da4f6a1 100644 --- a/version.json +++ b/version.json @@ -2,7 +2,7 @@ "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", "version": "0.1-beta", "publicReleaseRefSpec": [ - "^refs/heads/master$", + "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" ] } From 7d993369c0977f77c28754360781ec67b3eeedf2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 4 Feb 2021 18:25:04 -0700 Subject: [PATCH 0254/1753] Bump Microsoft.CodeAnalysis.NetAnalyzers from 5.0.1 to 5.0.3 (#89) Bumps [Microsoft.CodeAnalysis.NetAnalyzers](https://github.com/dotnet/roslyn-analyzers) from 5.0.1 to 5.0.3. - [Release notes](https://github.com/dotnet/roslyn-analyzers/releases) - [Changelog](https://github.com/dotnet/roslyn-analyzers/blob/master/PostReleaseActivities.md) - [Commits](https://github.com/dotnet/roslyn-analyzers/compare/5.0.1...5.0.3) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index ecc066061..bedac7bbb 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,7 +24,7 @@ - + From 28f1b256e7915a8889c3868cc965907fbb508dc9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 18:17:22 -0700 Subject: [PATCH 0255/1753] Consume newer PDB conversion package that is signed --- azure-pipelines/Convert-PDB.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 index e9ecebcdb..7a20305dc 100644 --- a/azure-pipelines/Convert-PDB.ps1 +++ b/azure-pipelines/Convert-PDB.ps1 @@ -18,7 +18,7 @@ [string]$OutputPath ) - $version = '1.1.0-beta2-20115-01' + $version = '1.1.0-beta2-21101-01' $baseDir = "$PSScriptRoot\..\obj\tools" $pdb2pdbpath = "$baseDir\Microsoft.DiaSymReader.Pdb2Pdb.$version\tools\Pdb2Pdb.exe" if (-not (Test-Path $pdb2pdbpath)) { From b3f2ca32e4b9139125b5075a556965731ff5bf1a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 18:28:51 -0700 Subject: [PATCH 0256/1753] Update dotnet-reportgenerator-globaltool to 4.8.5 --- azure-pipelines/publish-codecoverage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 0112aacf7..d83eb64ad 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -16,7 +16,7 @@ steps: continueOnError: true condition: ${{ parameters.includeMacOS }} - powershell: | - dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.2.2 --configfile azure-pipelines/justnugetorg.nuget.config + dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.8.5 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.*.cobertura.xml" From 18b5902d5ea27b3d71aed9f231e79e142ea57c8c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 20:58:50 -0700 Subject: [PATCH 0257/1753] Propagate failure to install .NET SDK --- tools/Install-DotNetSdk.ps1 | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index ec66c949a..06710ee3d 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -149,10 +149,16 @@ if (-not (Test-Path $DotNetInstallScriptPath)) { } $anythingInstalled = $false +$global:LASTEXITCODE = 0 if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } } else { Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" } @@ -163,6 +169,11 @@ $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } } else { Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" } From 5355f205cefddc0b46291cd02ca7e96f9df072d2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 21:06:04 -0700 Subject: [PATCH 0258/1753] Use pinned dotnet installer script This unblocks builds by working around https://github.com/dotnet/install-scripts/issues/136 --- tools/Install-DotNetSdk.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 06710ee3d..83ddec87f 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -134,10 +134,10 @@ if ($DotNetInstallDir) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://dot.net/v1/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/1ebb108764c092e7a314ff3fe1388f582cbcf89a/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://dot.net/v1/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/1ebb108764c092e7a314ff3fe1388f582cbcf89a/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } From ecc46dc8f71c838d66ca1948fd70336d1c2f2e49 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 Feb 2021 16:13:29 -0700 Subject: [PATCH 0259/1753] Consume new Microbuild package IDs --- Directory.Build.props | 4 ++-- test/Directory.Build.props | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index ce25ce63e..4d0eff737 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -19,11 +19,11 @@ true snupkg - 2.0.61 + 2.0.65 - + diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 8edee7310..0f7ca5780 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -8,6 +8,6 @@ - + From e4eaa925a2327ec9d23a17fb08cec013121b1352 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Feb 2021 17:33:22 -0700 Subject: [PATCH 0260/1753] Adjust for main as default branch --- azure-pipelines/microbuild.after.yml | 2 +- azure-pipelines/official.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 55fee5ec2..853b61179 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -23,7 +23,7 @@ steps: /repoName:$(Build.Repository.Name) /additionalCodexArguments:-bld /additionalCodexArguments:$(Build.ArtifactStagingDirectory)/build_logs - condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'), ne(variables['Build.Reason'], 'PullRequest')) + condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'), ne(variables['Build.Reason'], 'PullRequest')) continueOnError: true - template: secure-development-tools.yml diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index f23361448..b1cddc155 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -1,7 +1,7 @@ trigger: branches: include: - - master + - main - microbuild - 'validate/*' paths: From 2152fb59ab19d37691ff3fe9ac0df58cf433d921 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Feb 2021 19:53:57 -0700 Subject: [PATCH 0261/1753] Update LangVersion to 9 Also update StyleCop. --- Directory.Build.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index bedac7bbb..0281d8abc 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -5,7 +5,7 @@ $(RepoRootPath)obj\$(MSBuildProjectName)\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - 8.0 + 9.0 enable latest true @@ -30,7 +30,7 @@ - + From a64ebcc0e9965c8b5119c79807f5b47bcfd8e96e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Feb 2021 08:29:48 -0700 Subject: [PATCH 0262/1753] Update .NET installer script This may help with curl failures, as described in https://github.com/dotnet/install-scripts/issues/139 --- tools/Install-DotNetSdk.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 83ddec87f..132c374e6 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -134,10 +134,10 @@ if ($DotNetInstallDir) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/1ebb108764c092e7a314ff3fe1388f582cbcf89a/src/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/7a9d5dcab92cf131fc2d8977052f8c2c2d540e22/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/1ebb108764c092e7a314ff3fe1388f582cbcf89a/src/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/7a9d5dcab92cf131fc2d8977052f8c2c2d540e22/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } From 0cfb17c6eb4955b5c96830af3ee364b24b8944e8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Feb 2021 17:41:12 -0700 Subject: [PATCH 0263/1753] Secure nuget packages to require signatures by known parties --- azure-pipelines/official.yml | 3 +++ nuget.config | 12 +++++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index b1cddc155..d00f13dfd 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -27,6 +27,9 @@ parameters: type: boolean default: false # macOS is often bogged down in Azure Pipelines +variables: + NugetSecurityAnalysisWarningLevel: none # nuget.config requires signed packages by trusted owners + stages: - stage: Build diff --git a/nuget.config b/nuget.config index 57d032189..90f832a98 100644 --- a/nuget.config +++ b/nuget.config @@ -1,7 +1,8 @@ - + + @@ -13,4 +14,13 @@ + + + Microsoft;xunit;manuel.roemer;sharwell;jamesnk;aarnott;MarcoRossignoli;Thecentury + + + + + + From 791accaddbc87f2a06675d7620c849bc0a15a605 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Feb 2021 15:55:28 -0700 Subject: [PATCH 0264/1753] Embed PDBs for all local builds --- Directory.Build.props | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Directory.Build.props b/Directory.Build.props index 0281d8abc..836dd5210 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -10,6 +10,9 @@ latest true + + embedded + true $(MSBuildThisFileDirectory)\strongname.snk From c463b89ca7a0edd3c8024420f3559b024126f8c7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Feb 2021 10:20:37 -0700 Subject: [PATCH 0265/1753] Produce ref assembly for better incremental build Referencing projects don't need to recompile if the public API of a referenced project does not change. --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index 836dd5210..081e4cfa7 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -9,6 +9,7 @@ enable latest true + true embedded From af7742d884fdbed4e517da5bb9c62365746f5d19 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 24 Feb 2021 09:51:59 -0700 Subject: [PATCH 0266/1753] Use `dotnet build` for official builds --- azure-pipelines/dotnet.yml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 51d35eed9..958154a05 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,20 +1,9 @@ steps: -# We use VSBuild instead of "dotnet build" on Windows where MicroBuild tasks have to run (since they don't support MSBuild Core yet). -- task: VSBuild@1 - displayName: Build Visual Studio solution - inputs: - msbuildArgs: /t:build,pack /m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog" - platform: Any CPU - configuration: $(BuildConfiguration) - condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - - script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build - condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) - script: dotnet pack --no-build -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/pack.binlog" displayName: dotnet pack - condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) - task: DotNetCoreCLI@2 displayName: dotnet test -f net472 From c24318f044150c84e25c12d3240dddcfb9b509d8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 24 Feb 2021 09:52:16 -0700 Subject: [PATCH 0267/1753] Update to .NET SDK 5.0.103 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index b95ee4da2..24c50bd3e 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.102", + "version": "5.0.103", "rollForward": "patch", "allowPrerelease": false } From fb488e6cd9acbf391f24db08cdbb51f2d0826113 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 24 Feb 2021 09:52:51 -0700 Subject: [PATCH 0268/1753] Sort PackageReference items --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 72782f198..8da189276 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -11,8 +11,8 @@ - + From 1a1917e0cdf8fb1afac30641c52b2866f334f58f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 24 Feb 2021 09:57:51 -0700 Subject: [PATCH 0269/1753] Remove dead build authoring --- azure-pipelines/build.yml | 1 - azure-pipelines/publish-deployables.yml | 19 ------------------- 2 files changed, 20 deletions(-) delete mode 100644 azure-pipelines/publish-deployables.yml diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 764820fde..51e1fe314 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -65,4 +65,3 @@ jobs: - template: publish-codecoverage.yml parameters: includeMacOS: ${{ parameters.includeMacOS }} - - template: publish-deployables.yml diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml deleted file mode 100644 index 9cb41fc6b..000000000 --- a/azure-pipelines/publish-deployables.yml +++ /dev/null @@ -1,19 +0,0 @@ -steps: -- download: current - displayName: Download deployables - artifact: deployables-Windows - -- task: NuGetToolInstaller@1 - displayName: Use NuGet 5.x - inputs: - versionSpec: 5.x - -- task: NuGetCommand@2 - displayName: Push packages to CI feed - inputs: - command: push - packagesToPush: $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg - nuGetFeedType: internal - publishVstsFeed: $(ci_feed) - allowPackageConflicts: true - condition: and(succeeded(), eq(variables['push_to_ci'], 'true'), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) From a568829bc239d746133f05200936a1074627a9ce Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Mar 2021 09:19:46 -0700 Subject: [PATCH 0270/1753] Bump Microsoft.NET.Test.Sdk from 16.8.3 to 16.9.1 (#95) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.8.3 to 16.9.1. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.8.3...v16.9.1) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 8da189276..b1728e23d 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From bf34bea3b0d8cb04c617fa82a2b4bbd487e6ebaa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Mar 2021 16:42:18 +0000 Subject: [PATCH 0271/1753] Bump coverlet.msbuild from 3.0.2 to 3.0.3 (#94) --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index b1728e23d..5a37213f1 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -9,7 +9,7 @@ - + From 1c04816f75df76aefb8cfdb9f61865de2104ff92 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 2 Apr 2021 10:09:48 -0600 Subject: [PATCH 0272/1753] Bump Microsoft.Net.Compilers.Toolset from 3.9.0-3.final to 3.9.0 (#96) Bumps [Microsoft.Net.Compilers.Toolset](https://github.com/dotnet/roslyn) from 3.9.0-3.final to 3.9.0. - [Release notes](https://github.com/dotnet/roslyn/releases) - [Changelog](https://github.com/dotnet/roslyn/blob/main/docs/Breaking%20API%20Changes.md) - [Commits](https://github.com/dotnet/roslyn/commits/v3.9.0) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 081e4cfa7..df9e2a693 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -29,7 +29,7 @@ - + From 1685f22a5954a7ffd5b83ab4a85769551a27dc5c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 10 Apr 2021 06:51:29 -0600 Subject: [PATCH 0273/1753] Bump .NET SDK to 5.0.201 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 24c50bd3e..e8e7c67eb 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.103", + "version": "5.0.201", "rollForward": "patch", "allowPrerelease": false } From 98156ca3cad1a3095df9b061df4adaa4fe8bbc62 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Apr 2021 08:35:25 -0600 Subject: [PATCH 0274/1753] Fix local pack builds Local dev boxes were failing to build the `pack` target because symbols are now embedded into the assembly in that configuration and thus there were no pdb files to include in the snupkg file. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index df9e2a693..ad5589bfe 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -23,7 +23,7 @@ MIT true true - true + true snupkg From 00cc0d4cdc0cade1e1ef311b63ed36c5f9293fb0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Apr 2021 08:35:42 -0600 Subject: [PATCH 0275/1753] Bump .NET SDK to 5.0.202 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index e8e7c67eb..728ab6742 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.201", + "version": "5.0.202", "rollForward": "patch", "allowPrerelease": false } From 70e32877551294b242d2cabb89ffb955944ffcb0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Apr 2021 08:18:59 -0600 Subject: [PATCH 0276/1753] Fix InsertPropsValues.ps1 --- azure-pipelines/variables/InsertPropsValues.ps1 | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/azure-pipelines/variables/InsertPropsValues.ps1 b/azure-pipelines/variables/InsertPropsValues.ps1 index 05df93b7b..8d1e70a11 100644 --- a/azure-pipelines/variables/InsertPropsValues.ps1 +++ b/azure-pipelines/variables/InsertPropsValues.ps1 @@ -1,14 +1,2 @@ -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BUILDCONFIGURATION") - -$dirsToSearch = "$BinPath\NuGet\*.nupkg" |? { Test-Path $_ } -$icv=@() -if ($dirsToSearch) { - Get-ChildItem -Path $dirsToSearch |% { - if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { - $id = $Matches[1] - $version = $Matches[2] - } - } -} - -Write-Output ([string]::join(',',$icv)) +# These values are commonly the same. +& "$PSScriptRoot/InsertConfigValues.ps1" From ca33a6cabf6125d561f8e80466840181d8494592 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 1 May 2021 18:28:42 -0600 Subject: [PATCH 0277/1753] Bump Microsoft.NET.Test.Sdk from 16.9.1 to 16.9.4 (#98) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.9.1 to 16.9.4. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.9.1...v16.9.4) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 5a37213f1..2b8eff730 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From aba19025767fed9e84f867e3a1efc1e6a3051e92 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 1 May 2021 18:28:55 -0600 Subject: [PATCH 0278/1753] Bump Nerdbank.GitVersioning from 3.3.37 to 3.4.194 (#97) Bumps [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) from 3.3.37 to 3.4.194. - [Release notes](https://github.com/dotnet/Nerdbank.GitVersioning/releases) - [Commits](https://github.com/dotnet/Nerdbank.GitVersioning/compare/v3.3.37...v3.4.194) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index ad5589bfe..1dc06021d 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -32,7 +32,7 @@ - + From 4e2e5d5bd2d226055a91980eda9ad522602d4fa2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 3 May 2021 09:23:38 -0600 Subject: [PATCH 0279/1753] Trust new Microsoft/nuget certificates --- nuget.config | 2 ++ 1 file changed, 2 insertions(+) diff --git a/nuget.config b/nuget.config index 90f832a98..d9f432e1d 100644 --- a/nuget.config +++ b/nuget.config @@ -18,9 +18,11 @@ Microsoft;xunit;manuel.roemer;sharwell;jamesnk;aarnott;MarcoRossignoli;Thecentury + + From 679db2a7343675e138cb42469f227fe335668ed5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 12 May 2021 07:55:17 -0600 Subject: [PATCH 0280/1753] Handle 4-integer package versions in InsertConfigValues.ps1 --- azure-pipelines/variables/InsertConfigValues.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index 1455a5b74..eaf003270 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -3,7 +3,7 @@ $BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env: $icv=@() if (Test-Path "$BinPath") { Get-ChildItem -Path "$BinPath\*.nupkg" -rec |% { - if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] $icv += "$id=$version" From d3d35b668d08a2852bdd224c4f695d8b8e677605 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 15 May 2021 17:45:08 -0600 Subject: [PATCH 0281/1753] Add support for windowsdesktop runtimes to Install-DotNetSdk.ps1 script --- tools/Install-DotNetSdk.ps1 | 44 ++++++++++++++++++++++++++++--------- 1 file changed, 34 insertions(+), 10 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 132c374e6..3afca0eed 100755 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -31,17 +31,25 @@ $sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1 # Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() +$windowsDesktopRuntimeVersions = @() Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { $projXml = [xml](Get-Content -Path $_) - $targetFrameworks = $projXml.Project.PropertyGroup.TargetFramework - if (!$targetFrameworks) { - $targetFrameworks = $projXml.Project.PropertyGroup.TargetFrameworks - if ($targetFrameworks) { - $targetFrameworks = $targetFrameworks -Split ';' + $pg = $projXml.Project.PropertyGroup + if ($pg) { + $targetFrameworks = $pg.TargetFramework + if (!$targetFrameworks) { + $targetFrameworks = $pg.TargetFrameworks + if ($targetFrameworks) { + $targetFrameworks = $targetFrameworks -Split ';' + } } } $targetFrameworks |? { $_ -match 'netcoreapp(\d+\.\d+)' } |% { - $runtimeVersions += $Matches[1] + $v = $Matches[1] + $runtimeVersions += $v + if ($v -ge '3.0' -and -not ($IsMacOS -or $IsLinux)) { + $windowsDesktopRuntimeVersions += $v + } } } @@ -163,19 +171,35 @@ if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" } -$switches += '-Runtime','dotnet' +$dotnetRuntimeSwitches = $switches + '-Runtime','dotnet' -$runtimeVersions | Get-Unique |% { +$runtimeVersions | Sort-Object -Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches" + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $dotnetRuntimeSwitches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $dotnetRuntimeSwitches -DryRun" + } +} + +$windowsDesktopRuntimeSwitches = $switches + '-Runtime','windowsdesktop' + +$windowsDesktopRuntimeVersions | Sort-Object -Unique |% { + if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $windowsDesktopRuntimeSwitches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $switches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $windowsDesktopRuntimeSwitches -DryRun" } } From f62b3815de957cae7e1f99376215fbec4fab84f0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 29 May 2021 09:21:55 -0600 Subject: [PATCH 0282/1753] Unpack xml doc files with nupkg for better Intellisense When using devcontainer for development, the xml files were not getting unpacked due to an environment variable being set in the docker container. This reverts that. Workaround for https://github.com/dotnet/dotnet-docker/issues/2790 --- .devcontainer/Dockerfile | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index c551ecf23..40e736b3f 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -6,3 +6,8 @@ FROM mcr.microsoft.com/dotnet/core/sdk:3.1-bionic #RUN echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic main" | tee /etc/apt/sources.list.d/mono-official-stable.list #RUN apt-get update #RUN DEBIAN_FRONTEND=noninteractive apt-get install -y mono-devel + +# Clear the NUGET_XMLDOC_MODE env var so xml api doc files get unpacked, allowing a rich experience in Intellisense. +# See https://github.com/dotnet/dotnet-docker/issues/2790 for a discussion on this, where the prioritized use case +# was *not* devcontainers, sadly. +ENV NUGET_XMLDOC_MODE= From 8644f535701be9be5f1f6b92fb5f10c566272394 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 29 May 2021 09:28:27 -0600 Subject: [PATCH 0283/1753] Update devcontainer base image to match global.json This leads to faster devcontainer creation times because init.ps1 can skip the SDK installation step. --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 40e736b3f..4e7707663 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,4 @@ -FROM mcr.microsoft.com/dotnet/core/sdk:3.1-bionic +FROM mcr.microsoft.com/dotnet/sdk:5.0.202-focal # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From ee7f2ebc84a391f77229dce0d76878940b0b4c59 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 29 May 2021 09:48:29 -0600 Subject: [PATCH 0284/1753] Add powershell extension to devcontainer.json --- .devcontainer/devcontainer.json | 3 ++- .editorconfig | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 996302820..f4e3b31a3 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -14,6 +14,7 @@ "davidanson.vscode-markdownlint", "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", - "ms-azuretools.vscode-docker" + "ms-azuretools.vscode-docker", + "ms-vscode.powershell" ] } diff --git a/.editorconfig b/.editorconfig index 01feb97fc..3f5b80ac4 100644 --- a/.editorconfig +++ b/.editorconfig @@ -30,6 +30,7 @@ indent_size = 2 # JSON files [*.json] indent_size = 2 +indent_style = space # Dotnet code style settings: [*.{cs,vb}] From 7a23e0daa9c0179205aed56bab82e5dd5df75d24 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 29 May 2021 19:05:50 -0600 Subject: [PATCH 0285/1753] Fixes the Install-DotNetSdk.ps1 script when the path to the repo contains spaces (#100) --- tools/Install-DotNetSdk.ps1 | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) mode change 100755 => 100644 tools/Install-DotNetSdk.ps1 diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 old mode 100755 new mode 100644 index 3afca0eed..91399997c --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -136,16 +136,16 @@ if ($InstallLocality -eq 'machine') { Write-Host "Installing .NET Core SDK and runtimes to $DotNetInstallDir" -ForegroundColor Blue if ($DotNetInstallDir) { - $switches += '-InstallDir',$DotNetInstallDir + $switches += '-InstallDir',"`"$DotNetInstallDir`"" $envVars['DOTNET_MULTILEVEL_LOOKUP'] = '0' $envVars['DOTNET_ROOT'] = $DotNetInstallDir } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/7a9d5dcab92cf131fc2d8977052f8c2c2d540e22/src/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/49d5da7f7d313aa65d24fe95cc29767faef553fd/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/7a9d5dcab92cf131fc2d8977052f8c2c2d540e22/src/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/49d5da7f7d313aa65d24fe95cc29767faef553fd/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } @@ -156,19 +156,24 @@ if (-not (Test-Path $DotNetInstallScriptPath)) { } } +# In case the script we invoke is in a directory with spaces, wrap it with single quotes. +# In case the path includes single quotes, escape them. +$DotNetInstallScriptPathExpression = $DotNetInstallScriptPath.Replace("'", "''") +$DotNetInstallScriptPathExpression = "& '$DotNetInstallScriptPathExpression'" + $anythingInstalled = $false $global:LASTEXITCODE = 0 if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion $switches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Version $sdkVersion $switches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion $switches -DryRun" } $dotnetRuntimeSwitches = $switches + '-Runtime','dotnet' @@ -176,14 +181,14 @@ $dotnetRuntimeSwitches = $switches + '-Runtime','dotnet' $runtimeVersions | Sort-Object -Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $dotnetRuntimeSwitches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $dotnetRuntimeSwitches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $dotnetRuntimeSwitches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $dotnetRuntimeSwitches -DryRun" } } @@ -192,14 +197,14 @@ $windowsDesktopRuntimeSwitches = $switches + '-Runtime','windowsdesktop' $windowsDesktopRuntimeVersions | Sort-Object -Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop runtime $_", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $windowsDesktopRuntimeSwitches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $windowsDesktopRuntimeSwitches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPath -Channel $_ $windowsDesktopRuntimeSwitches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $windowsDesktopRuntimeSwitches -DryRun" } } From 30c95ce6bfce68ed827ec86eace746cca6f3af8d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Jun 2021 07:05:02 -0600 Subject: [PATCH 0286/1753] Bump Microsoft.NET.Test.Sdk from 16.9.4 to 16.10.0 (#101) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.9.4 to 16.10.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.9.4...v16.10.0) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 2b8eff730..38e325ac4 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From 7c90eadbe31ccbf681c4f61a8002d93cef712ba5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Jun 2021 13:20:30 +0000 Subject: [PATCH 0287/1753] Bump Nerdbank.GitVersioning from 3.4.194 to 3.4.205 (#103) --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 1dc06021d..3282b7950 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -32,7 +32,7 @@ - + From fc1faae5f71bb2f7e4fa9cafef565617756b78d6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Jun 2021 13:31:36 +0000 Subject: [PATCH 0288/1753] Bump Microsoft.NETFramework.ReferenceAssemblies from 1.0.0 to 1.0.2 (#102) --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 3282b7950..d375bb2b1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -30,7 +30,7 @@ - + From 2f9ae16d7de3980d88b3ca5af327f2f24bc0b483 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 15 Jun 2021 15:57:41 -0600 Subject: [PATCH 0289/1753] Update StyleCop.Analyzers to 1.2.0-beta.333 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index d375bb2b1..7ea3c86b1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -34,7 +34,7 @@ - + From 29e05c03fb75ff4f5b6422edc171cad77b13c860 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Jun 2021 08:32:15 -0600 Subject: [PATCH 0290/1753] Run IDExxxx analyzers in the build This helps the repo stay clean so users don't see a bunch of warnings in the error list when they open the solution from a team branch. --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index 7ea3c86b1..bcc5a80d7 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -8,6 +8,7 @@ 9.0 enable latest + true true true From ce744862270a6515fae669bf84e7495e134b61d6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Jun 2021 08:33:56 -0600 Subject: [PATCH 0291/1753] Update Nerdbank.GitVersioning to 3.4.216 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index bcc5a80d7..bb311c675 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -33,7 +33,7 @@ - + From 68f4b7f1e1e0034f226f37722724a64d7af6723e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Jun 2021 08:35:32 -0600 Subject: [PATCH 0292/1753] Update Microsoft.Net.Compilers.Toolset to 3.10.0 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index bb311c675..88b2e5836 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -30,7 +30,7 @@ - + From 936cffbc91ed3972ceb562d37eb0275f6c0172e3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Jun 2021 19:09:04 -0600 Subject: [PATCH 0293/1753] Workaround for microbuild plugin dependency bug --- init.ps1 | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/init.ps1 b/init.ps1 index ca6962654..c3c5b5e55 100755 --- a/init.ps1 +++ b/init.ps1 @@ -121,6 +121,11 @@ try { $EnvVars['LocLanguages'] = "JPN" } + # This is a workaround for https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1283978 + if ($Signing -or $Setup -or $OptProf -or $Localization) { + & $InstallNuGetPkgScriptPath MicroBuild.Core.Sentinel -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + } + & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars | Out-Null } catch { From e7fab6db055c5173fa1cf105e48094283923175c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 28 Jun 2021 06:59:28 -0600 Subject: [PATCH 0294/1753] Update Ubuntu agent on AzP to 20.04 --- azure-pipelines/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index b4561394c..cd39a76ab 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -18,7 +18,7 @@ jobs: - job: Linux pool: - vmImage: Ubuntu 18.04 + vmImage: Ubuntu 20.04 steps: - checkout: self clean: true @@ -43,7 +43,7 @@ jobs: - Linux - macOS pool: - vmImage: Ubuntu 18.04 + vmImage: Ubuntu 20.04 condition: succeededOrFailed() steps: - checkout: self From f1f2fce207a492f4a29ac292aa986dfca87db13d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 28 Jun 2021 08:40:45 -0600 Subject: [PATCH 0295/1753] Remove unused `BuildPlatform` build variable --- azure-pipelines/official.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index d00f13dfd..fb2ff576d 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -37,7 +37,6 @@ stages: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release - BuildPlatform: Any CPU push_to_ci: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} From 671330c8bfdf3804d5db8932085863454d8c466a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 28 Jun 2021 12:07:48 -0600 Subject: [PATCH 0296/1753] Only update config/props values on inserted packages --- azure-pipelines/artifacts/VSInsertion.ps1 | 2 +- azure-pipelines/variables/InsertConfigValues.ps1 | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 9c9c42507..88cab0f80 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -8,7 +8,7 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" -if (!(Test-Path $PackagesRoot)) { return } +if (!(Test-Path $PackagesRoot)) { return @{} } @{ "$PackagesRoot" = (Get-ChildItem $PackagesRoot -Recurse) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index eaf003270..ddc472ebf 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -1,9 +1,9 @@ -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BUILDCONFIGURATION") +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") $icv=@() -if (Test-Path "$BinPath") { - Get-ChildItem -Path "$BinPath\*.nupkg" -rec |% { - if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { +foreach ($kvp in $InsertedPkgs.GetEnumerator()) { + $kvp.Value |% { + if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] $icv += "$id=$version" From d3b2f39ccc2ed8078da4d86302ac39ee2d007d52 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 28 Jun 2021 13:28:24 -0600 Subject: [PATCH 0297/1753] Use NuGetAuthenticate in AzP instead of hand installation This works around microsoft/artifacts-credprovider#244 --- azure-pipelines/install-dependencies.yml | 7 ++++++- init.ps1 | 10 +++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 7563bc1f8..4f848b099 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -3,9 +3,14 @@ parameters: steps: +- task: NuGetAuthenticate@0 + displayName: Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true + - powershell: | $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors - .\init.ps1 -AccessToken $AccessToken ${{ parameters['initArgs'] }} -UpgradePrerequisites + .\init.ps1 -AccessToken $AccessToken ${{ parameters['initArgs'] }} -UpgradePrerequisites -NoNuGetCredProvider dotnet --info # Print mono version if it is present. diff --git a/init.ps1 b/init.ps1 index e5aad5bfa..4cf910f26 100755 --- a/init.ps1 +++ b/init.ps1 @@ -20,6 +20,9 @@ Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. .PARAMETER NoPrerequisites Skips the installation of prerequisite software (e.g. SDKs, tools). +.PARAMETER NoNuGetCredProvider + Skips the installation of the NuGet credential provider. Useful in pipelines with the `NuGetAuthenticate` task, as a workaround for https://github.com/microsoft/artifacts-credprovider/issues/244. + This switch is ignored and installation is skipped when -NoPrerequisites is specified. .PARAMETER UpgradePrerequisites Takes time to install prerequisites even if they are already present in case they need to be upgraded. No effect if -NoPrerequisites is specified. @@ -35,6 +38,8 @@ Param ( [Parameter()] [switch]$NoPrerequisites, [Parameter()] + [switch]$NoNuGetCredProvider, + [Parameter()] [switch]$UpgradePrerequisites, [Parameter()] [switch]$NoRestore, @@ -45,7 +50,10 @@ Param ( $EnvVars = @{} if (!$NoPrerequisites) { - & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken -Force:$UpgradePrerequisites + if (!$NoNuGetCredProvider) { + & "$PSScriptRoot\tools\Install-NuGetCredProvider.ps1" -AccessToken $AccessToken -Force:$UpgradePrerequisites + } + & "$PSScriptRoot\tools\Install-DotNetSdk.ps1" -InstallLocality $InstallLocality if ($LASTEXITCODE -eq 3010) { Exit 3010 From 505f36a697ae0736f029b6e9baab9b54fdd611bb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 30 Jun 2021 18:26:45 -0600 Subject: [PATCH 0298/1753] Update .NET SDK --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 728ab6742..34eb419ff 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.202", + "version": "5.0.301", "rollForward": "patch", "allowPrerelease": false } From c0e8f4210567af6799ebd6343ae59dd6e547558e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Jul 2021 06:50:34 -0600 Subject: [PATCH 0299/1753] Use batched CI --- azure-pipelines.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 2e4b2c157..a1435d918 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,4 +1,5 @@ trigger: + batch: true branches: include: - main From 5459e34d9f59e153637e2c8b49fa36a39265a5ef Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Jul 2021 06:50:50 -0600 Subject: [PATCH 0300/1753] Use batched CI --- azure-pipelines/official.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index fb2ff576d..d0199759c 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -1,4 +1,5 @@ trigger: + batch: true branches: include: - main From 3230021112457742dbc0a6c05f5088c19fe25156 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Jul 2021 07:19:49 -0600 Subject: [PATCH 0301/1753] Bump Nerdbank.GitVersioning from 3.4.216 to 3.4.220 (#106) Bumps [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) from 3.4.216 to 3.4.220. - [Release notes](https://github.com/dotnet/Nerdbank.GitVersioning/releases) - [Commits](https://github.com/dotnet/Nerdbank.GitVersioning/compare/v3.4.216...v3.4.220) --- updated-dependencies: - dependency-name: Nerdbank.GitVersioning dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 88b2e5836..d439a72c3 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -33,7 +33,7 @@ - + From 3a49199ce9cc05805877e6a0822e5b9e9f153804 Mon Sep 17 00:00:00 2001 From: Steve Bush Date: Sun, 25 Jul 2021 11:11:45 -0700 Subject: [PATCH 0302/1753] Add support for TargetFrameworks of the form netXX Add support for TargetFrameworks of the form netXX to Dotnet SDK installer script --- tools/Install-DotNetSdk.ps1 | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 91399997c..00772a9e2 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -51,6 +51,15 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$P $windowsDesktopRuntimeVersions += $v } } + + # Add target frameworks of the form: netXX + $targetFrameworks |? { $_ -match 'net(\d+\.\d+)' } |% { + $v = $Matches[1] + $runtimeVersions += $v + if (-not ($IsMacOS -or $IsLinux)) { + $windowsDesktopRuntimeVersions += $v + } + } } Function Get-FileFromWeb([Uri]$Uri, $OutDir) { From fd43c77b00bc00d5fddf485f994a34f07313df15 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 25 Jul 2021 21:29:11 -0600 Subject: [PATCH 0303/1753] Update coverlet.msbuild and .NET SDK --- global.json | 2 +- test/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/global.json b/global.json index 34eb419ff..d28f85bf6 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.301", + "version": "5.0.302", "rollForward": "patch", "allowPrerelease": false } diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 38e325ac4..660f9fb5b 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -9,7 +9,7 @@ - + From 46334e874dd86736272896a33892183fdc447cf8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Jul 2021 13:23:59 -0600 Subject: [PATCH 0304/1753] Update microbuild feed URL to the newer format --- init.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.ps1 b/init.ps1 index 3454b80ac..825ce9fd7 100755 --- a/init.ps1 +++ b/init.ps1 @@ -104,7 +104,7 @@ try { $InstallNuGetPkgScriptPath = ".\azure-pipelines\Install-NuGetPackage.ps1" $nugetVerbosity = 'quiet' if ($Verbose) { $nugetVerbosity = 'normal' } - $MicroBuildPackageSource = 'https://devdiv.pkgs.visualstudio.com/DefaultCollection/_packaging/MicroBuildToolset/nuget/v3/index.json' + $MicroBuildPackageSource = 'https://pkgs.dev.azure.com/devdiv/_packaging/MicroBuildToolset%40Local/nuget/v3/index.json' if ($Signing) { Write-Host "Installing MicroBuild signing plugin" -ForegroundColor $HeaderColor & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Signing -source $MicroBuildPackageSource -Verbosity $nugetVerbosity From 70495e7db031ec433689a191f7ef6c7d31ad2ca1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Jul 2021 14:38:35 -0600 Subject: [PATCH 0305/1753] Remove obsolete task parameter --- azure-pipelines/microbuild.before.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 206c18792..96cd32540 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -2,5 +2,4 @@ steps: - task: MicroBuildSigningPlugin@3 inputs: signType: $(SignType) - zipSources: false displayName: Install MicroBuild Signing Plugin From 998b4dbed1cf203d8c423b13d9c5133b77f16232 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 1 Aug 2021 07:20:04 -0600 Subject: [PATCH 0306/1753] Bump Nerdbank.GitVersioning from 3.4.220 to 3.4.231 (#110) Bumps [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) from 3.4.220 to 3.4.231. - [Release notes](https://github.com/dotnet/Nerdbank.GitVersioning/releases) - [Commits](https://github.com/dotnet/Nerdbank.GitVersioning/compare/v3.4.220...v3.4.231) --- updated-dependencies: - dependency-name: Nerdbank.GitVersioning dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index d439a72c3..125552453 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -33,7 +33,7 @@ - + From b1f3bdc6a226ee9385eb414ffcf2173cede3b313 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Aug 2021 10:06:18 -0600 Subject: [PATCH 0307/1753] Enable Component Governance to PR builds (#111) It actually does something useful, and will soon be mandated. --- azure-pipelines/microbuild.after.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 853b61179..8559b27a0 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -11,7 +11,6 @@ steps: - task: ComponentGovernanceComponentDetection@0 displayName: Component Detection - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - task: Ref12Analyze@0 displayName: Ref12 (Codex) Analyze From 9ce97e7830e218640dd01862305ac8b36d71aedc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Aug 2021 10:11:41 -0600 Subject: [PATCH 0308/1753] Remove workaround for microbuild plugin bug The bug is now fixed. --- init.ps1 | 5 ----- 1 file changed, 5 deletions(-) diff --git a/init.ps1 b/init.ps1 index 825ce9fd7..fef2cb091 100755 --- a/init.ps1 +++ b/init.ps1 @@ -129,11 +129,6 @@ try { $EnvVars['LocLanguages'] = "JPN" } - # This is a workaround for https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1283978 - if ($Signing -or $Setup -or $OptProf -or $Localization) { - & $InstallNuGetPkgScriptPath MicroBuild.Core.Sentinel -source $MicroBuildPackageSource -Verbosity $nugetVerbosity - } - & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars | Out-Null } catch { From 1808050a987440698578162df0f4f077c86feb18 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Aug 2021 08:51:43 -0600 Subject: [PATCH 0309/1753] Drop netcoreapp2.1 as a target It is no longer in its LTS lifecycle. --- azure-pipelines/dotnet.yml | 8 -------- test/Directory.Build.props | 2 +- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 34db9a40b..50ba58f1d 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -14,14 +14,6 @@ steps: testRunTitle: net472-$(Agent.JobName) condition: succeededOrFailed() -- task: DotNetCoreCLI@2 - displayName: dotnet test -f netcoreapp2.1 - inputs: - command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp2.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp2.1.binlog" - testRunTitle: netcoreapp2.1-$(Agent.JobName) - condition: succeededOrFailed() - - task: DotNetCoreCLI@2 displayName: dotnet test -f netcoreapp3.1 inputs: diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 4803641a5..1b45d7162 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -2,7 +2,7 @@ - net5.0;netcoreapp3.1;netcoreapp2.1;net472 + net5.0;netcoreapp3.1;net472 false true From 10ed82d6504eb858dfca86b69d0b732896556e9c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Aug 2021 09:11:57 -0600 Subject: [PATCH 0310/1753] Suppress SA1401 (private fields) in tests --- test/.editorconfig | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/.editorconfig b/test/.editorconfig index 19b19171d..8aa791bef 100644 --- a/test/.editorconfig +++ b/test/.editorconfig @@ -47,3 +47,6 @@ dotnet_diagnostic.CA1816.severity = silent # CA2007: Consider calling ConfigureAwait on the awaited task dotnet_diagnostic.CA2007.severity = none + +# SA1401: Fields should be private +dotnet_diagnostic.SA1401.severity = silent From f90f4949877855b010afdff5626dd238390ceb9d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Aug 2021 11:40:33 -0600 Subject: [PATCH 0311/1753] Touch-up on code style --- .editorconfig | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 3f5b80ac4..0689e4e0a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -129,7 +129,7 @@ csharp_indent_switch_labels = true csharp_indent_labels = flush_left # Prefer "var" everywhere -csharp_style_var_for_built_in_types = true:suggestion +csharp_style_var_for_built_in_types = false csharp_style_var_when_type_is_apparent = true:suggestion csharp_style_var_elsewhere = false:warning @@ -167,5 +167,8 @@ dotnet_diagnostic.SA1130.severity = silent # CA1508: Avoid dead conditional code dotnet_diagnostic.CA1508.severity = warning +# IDE1006: Naming Styles - StyleCop handles these for us +dotnet_diagnostic.IDE1006.severity = none + [*.sln] indent_style = tab From 9cd3507c973ea9662b69928f0490e1e00ea447b9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Sep 2021 11:48:29 -0600 Subject: [PATCH 0312/1753] Bump Microsoft.NET.Test.Sdk from 16.10.0 to 16.11.0 (#114) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.10.0 to 16.11.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.10.0...v16.11.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 660f9fb5b..c66b7aac2 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From ad83aa039c3868874a928c92aa886726a7623d2d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Sep 2021 11:48:43 -0600 Subject: [PATCH 0313/1753] Bump Microsoft.Net.Compilers.Toolset from 3.10.0 to 3.11.0 (#113) Bumps [Microsoft.Net.Compilers.Toolset](https://github.com/dotnet/roslyn) from 3.10.0 to 3.11.0. - [Release notes](https://github.com/dotnet/roslyn/releases) - [Changelog](https://github.com/dotnet/roslyn/blob/main/docs/Breaking%20API%20Changes.md) - [Commits](https://github.com/dotnet/roslyn/commits) --- updated-dependencies: - dependency-name: Microsoft.Net.Compilers.Toolset dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 125552453..c732a3a94 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -30,7 +30,7 @@ - + From 9ac560c10f1a1e4f6397519d66956f0f8bfddc3b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 1 Sep 2021 22:36:19 -0600 Subject: [PATCH 0314/1753] Fix SDK installation on ARM64 --- tools/Install-DotNetSdk.ps1 | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 00772a9e2..67c66c1e7 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -29,6 +29,9 @@ $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot # Look up actual required .NET Core SDK version from global.json $sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" +$arch = 'x64' +if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { $arch = 'ARM64' } + # Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() $windowsDesktopRuntimeVersions = @() @@ -51,7 +54,7 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$P $windowsDesktopRuntimeVersions += $v } } - + # Add target frameworks of the form: netXX $targetFrameworks |? { $_ -match 'net(\d+\.\d+)' } |% { $v = $Matches[1] @@ -86,7 +89,7 @@ Function Get-InstallerExe($Version, [switch]$Runtime) { $Version = $versionInfo[-1] } - Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/dotnet-$($sdkOrRuntime.ToLowerInvariant())-$Version-win-x64.exe" -OutDir "$DotNetInstallScriptRoot" + Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/dotnet-$($sdkOrRuntime.ToLowerInvariant())-$Version-win-$arch.exe" -OutDir "$DotNetInstallScriptRoot" } Function Install-DotNet($Version, [switch]$Runtime) { @@ -103,7 +106,7 @@ Function Install-DotNet($Version, [switch]$Runtime) { } $switches = @( - '-Architecture','x64' + '-Architecture',$arch ) $envVars = @{ # For locally installed dotnet, skip first time experience which takes a long time From 7e6aa52248c2b3bc5d466d39ec8518830e2b8991 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Sep 2021 09:35:36 -0600 Subject: [PATCH 0315/1753] Switch to the VSEngSS-MicroBuild2019-1ES pool --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index d0199759c..38ea71248 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -45,7 +45,7 @@ stages: jobs: - template: build.yml parameters: - windowsPool: VSEngSS-MicroBuild2019 + windowsPool: VSEngSS-MicroBuild2019-1ES includeMacOS: ${{ parameters.includeMacOS }} - stage: symbol_archive From cb6afb9d96ef72482684e0fcd4db5f5d75166920 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Sep 2021 15:53:31 -0600 Subject: [PATCH 0316/1753] Update Microbuild version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 7744e2b97..91ea7ecc2 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,7 +24,7 @@ true snupkg - 2.0.65 + 2.0.66 From c70330018b2f9c772ef886819baf47537214d84e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Sep 2021 15:55:41 -0600 Subject: [PATCH 0317/1753] Update StyleCop.Analyzers version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index c732a3a94..277c9cde1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -35,7 +35,7 @@ - + From b2453ab34a09cfb47c3d34e8cf912af611a5283e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Sep 2021 21:07:23 -0600 Subject: [PATCH 0318/1753] Fix position of runsettings in .editorconfig --- .editorconfig | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index 0689e4e0a..6015ff487 100644 --- a/.editorconfig +++ b/.editorconfig @@ -20,11 +20,11 @@ insert_final_newline = true trim_trailing_whitespace = true # Xml project files -[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,runsettings}] +[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}] indent_size = 2 # Xml config files -[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}] +[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct,runsettings}] indent_size = 2 # JSON files From eba9acb28b6c66b40a14d7759365b20a9d89df0f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Sep 2021 20:49:50 -0600 Subject: [PATCH 0319/1753] Update .NET SDK to 5.0.400 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 4e7707663..889499464 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,4 @@ -FROM mcr.microsoft.com/dotnet/sdk:5.0.202-focal +FROM mcr.microsoft.com/dotnet/sdk:5.0.400-focal # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index d28f85bf6..9f36eab1a 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.302", + "version": "5.0.400", "rollForward": "patch", "allowPrerelease": false } From e94bf29eed1dc1ba106f263e2e5ac1c27aa0c096 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Sep 2021 08:59:25 -0600 Subject: [PATCH 0320/1753] Build on ubuntu 20.04 in Github workflows This matches what we were already doing on Azure Pipelines. --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8567b4c9e..1b3b6b131 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,7 +22,7 @@ jobs: fail-fast: false matrix: os: - - ubuntu-18.04 + - ubuntu-20.04 - macos-latest - windows-latest From 9c06ecb7ee50f4fef66dd82ff1bbe9949e3e2d31 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Sep 2021 09:00:17 -0600 Subject: [PATCH 0321/1753] Publish variables, symbols and deployables from non-Windows agents too --- .github/workflows/build.yml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1b3b6b131..b8499b90c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -61,9 +61,8 @@ jobs: - name: Upload variables uses: actions/upload-artifact@v1 with: - name: variables + name: variables-${{ runner.os }} path: obj/_artifacts/variables - if: runner.os == 'Windows' continue-on-error: true - name: Upload build_logs if: always() @@ -89,16 +88,15 @@ jobs: - name: Upload symbols uses: actions/upload-artifact@v1 with: - name: symbols + name: symbols-${{ runner.os }} path: obj/_artifacts/symbols - if: runner.os == 'Windows' continue-on-error: true - name: Upload deployables uses: actions/upload-artifact@v1 with: - name: deployables + name: deployables-${{ runner.os }} path: obj/_artifacts/deployables - if: always() && runner.os == 'Windows' + if: always() - name: Publish code coverage results to codecov.io run: bash <(curl -s https://codecov.io/bash) shell: bash From 4854ca17b0473bc9627bd457bcfcc03cfdf7e59c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Sep 2021 09:30:47 -0600 Subject: [PATCH 0322/1753] Fix up symbol collection off-Windows --- azure-pipelines/Convert-PDB.ps1 | 12 +++++++++--- azure-pipelines/Get-SymbolFiles.ps1 | 26 ++++++++++++++------------ azure-pipelines/artifacts/symbols.ps1 | 10 ++-------- 3 files changed, 25 insertions(+), 23 deletions(-) diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 index 7a20305dc..2d394e72d 100644 --- a/azure-pipelines/Convert-PDB.ps1 +++ b/azure-pipelines/Convert-PDB.ps1 @@ -18,13 +18,19 @@ [string]$OutputPath ) + if ($IsMacOS -or $IsLinux) { + Write-Error "This script only works on Windows" + return + } + $version = '1.1.0-beta2-21101-01' - $baseDir = "$PSScriptRoot\..\obj\tools" - $pdb2pdbpath = "$baseDir\Microsoft.DiaSymReader.Pdb2Pdb.$version\tools\Pdb2Pdb.exe" + $baseDir = "$PSScriptRoot/../obj/tools" + $pdb2pdbpath = "$baseDir/Microsoft.DiaSymReader.Pdb2Pdb.$version/tools/Pdb2Pdb.exe" if (-not (Test-Path $pdb2pdbpath)) { if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } $baseDir = (Resolve-Path $baseDir).Path # Normalize it - & (& $PSScriptRoot\Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null + Write-Verbose "& (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null" + & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null } $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index bba177f1a..45afe7c2a 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -17,7 +17,7 @@ $WindowsPdbSubDirName = "symstore" $ActivityName = "Collecting symbols from $Path" Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" -$PDBs = Get-ChildItem -rec "$Path\*.pdb" |? { $_.FullName -notmatch "\W$WindowsPdbSubDirName\W" } +$PDBs = Get-ChildItem -rec "$Path/*.pdb" |? { $_.FullName -notmatch "\W$WindowsPdbSubDirName\W" } # Filter PDBs to product OR test related. $testregex = "unittest|tests" @@ -44,8 +44,8 @@ $PDBs |% { } } |% { # Collect the DLLs/EXEs as well. - $dllPath = "$($_.Directory)\$($_.BaseName).dll" - $exePath = "$($_.Directory)\$($_.BaseName).exe" + $dllPath = "$($_.Directory)/$($_.BaseName).dll" + $exePath = "$($_.Directory)/$($_.BaseName).exe" if (Test-Path $dllPath) { $BinaryImagePath = $dllPath } elseif (Test-Path $exePath) { @@ -54,14 +54,16 @@ $PDBs |% { Write-Output $BinaryImagePath - # Convert the PDB to legacy Windows PDBs - Write-Host "Converting PDB for $_" -ForegroundColor DarkGray - $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" - if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } - & "$PSScriptRoot\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath "$WindowsPdbDir\$($_.BaseName).pdb" - if ($LASTEXITCODE -ne 0) { - Write-Warning "PDB conversion of `"$_`" failed." - } + if (-not ($IsMacOS -or $IsLinux)) { + # Convert the PDB to legacy Windows PDBs + Write-Host "Converting PDB for $_" -ForegroundColor DarkGray + $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" + if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } + & "$PSScriptRoot\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath "$WindowsPdbDir\$($_.BaseName).pdb" + if ($LASTEXITCODE -ne 0) { + Write-Warning "PDB conversion of `"$_`" failed." + } - Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" + Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" + } } diff --git a/azure-pipelines/artifacts/symbols.ps1 b/azure-pipelines/artifacts/symbols.ps1 index b3451ce1e..8704571ec 100644 --- a/azure-pipelines/artifacts/symbols.ps1 +++ b/azure-pipelines/artifacts/symbols.ps1 @@ -1,11 +1,5 @@ -# This doesn't work off Windows, nor do we need to convert symbols on multiple OS agents -if ($IsMacOS -or $IsLinux) { - return; -} - -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") -if (!(Test-Path $BinPath)) { return } -$symbolfiles = & "$PSScriptRoot\..\Get-SymbolFiles.ps1" -Path $BinPath | Get-Unique +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../bin") +$symbolfiles = & "$PSScriptRoot/../Get-SymbolFiles.ps1" -Path $BinPath | Get-Unique @{ "$BinPath" = $SymbolFiles; From 4438c0718d81c15796eaa4cadd96352ed436825b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Sep 2021 14:27:58 -0600 Subject: [PATCH 0323/1753] Update to latest dotnet-install script --- tools/Install-DotNetSdk.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 67c66c1e7..73dae25fe 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -154,10 +154,10 @@ if ($DotNetInstallDir) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/49d5da7f7d313aa65d24fe95cc29767faef553fd/src/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/781752509a890ca7520f1182e8bae71f9a53d754/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/49d5da7f7d313aa65d24fe95cc29767faef553fd/src/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/781752509a890ca7520f1182e8bae71f9a53d754/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } From f220004889a1ac02ac55cafcc84b737be04f4ad1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Sep 2021 07:14:15 -0600 Subject: [PATCH 0324/1753] Capture dumps from test hangs on Mac/Linux --- .github/workflows/Linux.runsettings | 15 ++++++++++++++- .github/workflows/macOS.runsettings | 15 ++++++++++++++- azure-pipelines/Darwin.runsettings | 15 ++++++++++++++- azure-pipelines/Linux.runsettings | 15 ++++++++++++++- azure-pipelines/artifacts/testResults.ps1 | 2 +- 5 files changed, 57 insertions(+), 5 deletions(-) diff --git a/.github/workflows/Linux.runsettings b/.github/workflows/Linux.runsettings index b444e8196..5e2244a02 100644 --- a/.github/workflows/Linux.runsettings +++ b/.github/workflows/Linux.runsettings @@ -1 +1,14 @@ - + + + + + + + + + %GITHUB_WORKSPACE% + + + + + diff --git a/.github/workflows/macOS.runsettings b/.github/workflows/macOS.runsettings index b444e8196..5e2244a02 100644 --- a/.github/workflows/macOS.runsettings +++ b/.github/workflows/macOS.runsettings @@ -1 +1,14 @@ - + + + + + + + + + %GITHUB_WORKSPACE% + + + + + diff --git a/azure-pipelines/Darwin.runsettings b/azure-pipelines/Darwin.runsettings index b444e8196..0b43ecb09 100644 --- a/azure-pipelines/Darwin.runsettings +++ b/azure-pipelines/Darwin.runsettings @@ -1 +1,14 @@ - + + + + + + + + + %BUILD_ARTIFACTSTAGINGDIRECTORY% + + + + + diff --git a/azure-pipelines/Linux.runsettings b/azure-pipelines/Linux.runsettings index b444e8196..0b43ecb09 100644 --- a/azure-pipelines/Linux.runsettings +++ b/azure-pipelines/Linux.runsettings @@ -1 +1,14 @@ - + + + + + + + + + %BUILD_ARTIFACTSTAGINGDIRECTORY% + + + + + diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index 1e4c4c4e2..7895ddcaa 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -2,7 +2,7 @@ if ($env:AGENT_TEMPDIRECTORY) { # The DotNetCoreCLI uses an alternate location to publish these files $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' @{ - $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); + $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); } } else { $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" From da2dbc0e905c0b6045c7f51875848fa50cad9b7e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Sep 2021 07:56:31 -0600 Subject: [PATCH 0325/1753] Remove ResultsDirectory tag --- .github/workflows/Linux.runsettings | 2 -- .github/workflows/Windows.runsettings | 2 -- .github/workflows/macOS.runsettings | 2 -- azure-pipelines/Darwin.runsettings | 2 -- azure-pipelines/Linux.runsettings | 2 -- azure-pipelines/Windows_NT.runsettings | 2 -- 6 files changed, 12 deletions(-) diff --git a/.github/workflows/Linux.runsettings b/.github/workflows/Linux.runsettings index 5e2244a02..db20611f1 100644 --- a/.github/workflows/Linux.runsettings +++ b/.github/workflows/Linux.runsettings @@ -5,8 +5,6 @@ - - %GITHUB_WORKSPACE% diff --git a/.github/workflows/Windows.runsettings b/.github/workflows/Windows.runsettings index 5e2244a02..db20611f1 100644 --- a/.github/workflows/Windows.runsettings +++ b/.github/workflows/Windows.runsettings @@ -5,8 +5,6 @@ - - %GITHUB_WORKSPACE% diff --git a/.github/workflows/macOS.runsettings b/.github/workflows/macOS.runsettings index 5e2244a02..db20611f1 100644 --- a/.github/workflows/macOS.runsettings +++ b/.github/workflows/macOS.runsettings @@ -5,8 +5,6 @@ - - %GITHUB_WORKSPACE% diff --git a/azure-pipelines/Darwin.runsettings b/azure-pipelines/Darwin.runsettings index 0b43ecb09..db20611f1 100644 --- a/azure-pipelines/Darwin.runsettings +++ b/azure-pipelines/Darwin.runsettings @@ -5,8 +5,6 @@ - - %BUILD_ARTIFACTSTAGINGDIRECTORY% diff --git a/azure-pipelines/Linux.runsettings b/azure-pipelines/Linux.runsettings index 0b43ecb09..db20611f1 100644 --- a/azure-pipelines/Linux.runsettings +++ b/azure-pipelines/Linux.runsettings @@ -5,8 +5,6 @@ - - %BUILD_ARTIFACTSTAGINGDIRECTORY% diff --git a/azure-pipelines/Windows_NT.runsettings b/azure-pipelines/Windows_NT.runsettings index 0b43ecb09..db20611f1 100644 --- a/azure-pipelines/Windows_NT.runsettings +++ b/azure-pipelines/Windows_NT.runsettings @@ -5,8 +5,6 @@ - - %BUILD_ARTIFACTSTAGINGDIRECTORY% From ecbaf97d74980f7455d3426f0138611992acc256 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Sep 2021 08:32:30 -0600 Subject: [PATCH 0326/1753] Update SDK to 5.0.401 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 9f36eab1a..3057bb452 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "5.0.400", + "version": "5.0.401", "rollForward": "patch", "allowPrerelease": false } From 04544dcde313bc25a6ed33f196816d48210fade1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Sep 2021 14:31:02 -0600 Subject: [PATCH 0327/1753] Update Nerdbank.GitVersioning to 3.5.37-alpha This gets `msbuild -graph -isolate` working. Note when using `dotnet build` the `-graph -isolate` switches must be combined with `--no-restore` to workaround https://github.com/dotnet/msbuild/issues/6856. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 277c9cde1..0df35e997 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -33,7 +33,7 @@ - + From f6bc832d634d56f1107a29f747159c06c32eb892 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Sep 2021 15:30:05 -0600 Subject: [PATCH 0328/1753] Optimize the build for just one version applied everywhere --- Directory.Build.props | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Directory.Build.props b/Directory.Build.props index 0df35e997..9184728d7 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -12,6 +12,9 @@ true true + + $(MSBuildThisFileDirectory) + embedded From 934d5f208f748fcdaf99e628c36c127246af99e6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Sep 2021 15:36:27 -0600 Subject: [PATCH 0329/1753] Add a collection for prepended paths --- init.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/init.ps1 b/init.ps1 index 4cf910f26..cb86c6cac 100755 --- a/init.ps1 +++ b/init.ps1 @@ -48,6 +48,7 @@ Param ( ) $EnvVars = @{} +$PrependPath = @() if (!$NoPrerequisites) { if (!$NoNuGetCredProvider) { @@ -82,7 +83,7 @@ try { } } - & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars | Out-Null + & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars -PrependPath $PrependPath | Out-Null } catch { Write-Error $error[0] From 62687e5afd6515409d332ee7cbbba5e38ea45885 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Sep 2021 16:56:28 -0600 Subject: [PATCH 0330/1753] Stabilize package restore in the face of outside influences --- nuget.config | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/nuget.config b/nuget.config index 68f36551f..22f7b8098 100644 --- a/nuget.config +++ b/nuget.config @@ -8,4 +8,8 @@ + + + + From ccae4b2e7701f9d7236c035f33fc0d702b80271e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 3 Oct 2021 14:01:00 -0600 Subject: [PATCH 0331/1753] Place obj folders in the same hierarchy as the source appears in the repo This avoids inadvertent obj dir collisions when the project name matches, which tends to happen when using dirs.proj. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 9184728d7..3b53649ad 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -2,7 +2,7 @@ Debug $(MSBuildThisFileDirectory) - $(RepoRootPath)obj\$(MSBuildProjectName)\ + $(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ 9.0 From 26afcd2276a2b0df4157d1594c260fd264a6adcd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 3 Oct 2021 14:01:13 -0600 Subject: [PATCH 0332/1753] Calculate the version just once for the whole repo --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index 3b53649ad..8a8effea9 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -11,6 +11,7 @@ true true true + $(RepoRootPath) $(MSBuildThisFileDirectory) From 392da69055086b58b6296379aa6c502a5b2ba947 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 3 Oct 2021 14:01:33 -0600 Subject: [PATCH 0333/1753] Opt into the WPF nuget fix in .NET 5 SDK --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index 8a8effea9..6e481b01a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -11,6 +11,7 @@ true true true + true $(RepoRootPath) From 341aba5d8f66353b57161a25248ddd3f1c172190 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 6 Oct 2021 11:36:13 -0600 Subject: [PATCH 0334/1753] Use public hosted pool for VS insertions We only need VSEng-ReleasePool for symbol archival. --- azure-pipelines/vs-insertion.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 90645cb21..6aef78894 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -17,7 +17,8 @@ stages: displayName: VS insertion jobs: - deployment: insertion - pool: VSEng-ReleasePool + pool: + vmImage: windows-latest environment: No-Approval strategy: runOnce: From 8094b0aac7e7ef8cb7b1c3b3cfd64455b0986973 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 8 Oct 2021 17:55:07 -0600 Subject: [PATCH 0335/1753] Set indent size for msbuildproj files --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 6015ff487..c561b3810 100644 --- a/.editorconfig +++ b/.editorconfig @@ -20,7 +20,7 @@ insert_final_newline = true trim_trailing_whitespace = true # Xml project files -[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}] +[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,msbuildproj}] indent_size = 2 # Xml config files From 6cd48ff31414e2004ebb579d6a9e3e2ab4d422df Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Oct 2021 15:07:39 -0600 Subject: [PATCH 0336/1753] Move TargetFramework properties into projects They cause more confusion and issues being imported than its worth. --- src/Directory.Build.props | 4 ---- src/Library/Library.csproj | 4 +++- test/Directory.Build.props | 1 - test/Library.Tests/Library.Tests.csproj | 1 + 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 165d2ddd4..77d947658 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,7 +1,3 @@ - - - netstandard2.0 - diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index 61718a1f8..4641dbd64 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,3 +1,5 @@ - + + netstandard2.0 + diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 1b45d7162..449a06e45 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -2,7 +2,6 @@ - net5.0;netcoreapp3.1;net472 false true diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index c66b7aac2..9a0a5820e 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -1,6 +1,7 @@ + net5.0;netcoreapp3.1;net472 From 295a5328208e65883c9a3add6fdfdba3bd14b34a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 06:24:16 -0600 Subject: [PATCH 0337/1753] Include README in nupkg --- src/Library/Library.csproj | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index 4641dbd64..a7547da10 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,5 +1,9 @@ netstandard2.0 + README.md + + + From d3cb4c585962ff32716f4e6c22a3ebe905a6e8a4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 06:38:13 -0600 Subject: [PATCH 0338/1753] Revert "Include README in nupkg" This reverts commit 295a5328208e65883c9a3add6fdfdba3bd14b34a. This is due to https://github.com/NuGet/Home/issues/10791. We can reapply the readme after switching to .NET SDK 6.0. --- src/Library/Library.csproj | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index a7547da10..4641dbd64 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,9 +1,5 @@ netstandard2.0 - README.md - - - From 2174046dee68180b06a3de37420161cfa4566dbb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 06:38:42 -0600 Subject: [PATCH 0339/1753] Reapply "Include README in nupkg" This reverts commit d3cb4c585962ff32716f4e6c22a3ebe905a6e8a4. --- src/Library/Library.csproj | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index 4641dbd64..a7547da10 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,5 +1,9 @@ netstandard2.0 + README.md + + + From 5fa2a94852e82ada595c6d3a7c112670d9590493 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 06:51:05 -0600 Subject: [PATCH 0340/1753] Update to .NET 6 SDK --- Directory.Build.props | 3 +-- global.json | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 6e481b01a..fac9c6770 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -34,8 +34,7 @@ - - + diff --git a/global.json b/global.json index 3057bb452..973759e1f 100644 --- a/global.json +++ b/global.json @@ -1,7 +1,7 @@ { "sdk": { - "version": "5.0.401", + "version": "6.0.100-rc.2.21505.57", "rollForward": "patch", - "allowPrerelease": false + "allowPrerelease": true } } From 346548ac0da1ae678c32af3b0381df4c34277a0b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 07:31:30 -0600 Subject: [PATCH 0341/1753] Search for .NET 5+ runtime requirements --- tools/Install-DotNetSdk.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 73dae25fe..427899307 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -47,7 +47,7 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$P } } } - $targetFrameworks |? { $_ -match 'netcoreapp(\d+\.\d+)' } |% { + $targetFrameworks |? { $_ -match 'net(?:coreapp)?(\d+\.\d+)' } |% { $v = $Matches[1] $runtimeVersions += $v if ($v -ge '3.0' -and -not ($IsMacOS -or $IsLinux)) { From ef76eb2d0d8cc2d90ce4eee2cd07d485b18ecedf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 08:20:31 -0600 Subject: [PATCH 0342/1753] Use C# 10 syntax --- Directory.Build.props | 4 ++-- src/Library/Calculator.cs | 39 ++++++++++++++++++--------------------- 2 files changed, 20 insertions(+), 23 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index fac9c6770..38102b59f 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -5,8 +5,9 @@ $(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - 9.0 + 10.0 enable + enable latest true true @@ -34,7 +35,6 @@ - diff --git a/src/Library/Calculator.cs b/src/Library/Calculator.cs index 9156a1a34..706c341d9 100644 --- a/src/Library/Calculator.cs +++ b/src/Library/Calculator.cs @@ -1,29 +1,26 @@ // Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Library -{ - using System; +namespace Library; +/// +/// My first class. +/// +public static class Calculator +{ /// - /// My first class. + /// Adds two integers. /// - public static class Calculator - { - /// - /// Adds two integers. - /// - /// The first integer. - /// The second integer. - /// The sum of the two integers. - public static int Add(int a, int b) => a + b; + /// The first integer. + /// The second integer. + /// The sum of the two integers. + public static int Add(int a, int b) => a + b; - /// - /// Subtracts one integer from another. - /// - /// The original integer. - /// The integer to subtract. - /// The difference between the two integers. - public static int Subtract(int a, int b) => a - b; - } + /// + /// Subtracts one integer from another. + /// + /// The original integer. + /// The integer to subtract. + /// The difference between the two integers. + public static int Subtract(int a, int b) => a - b; } From 2cc62417f55390b6ef18b69c51fe3b1ec7dc1082 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Oct 2021 08:22:53 -0600 Subject: [PATCH 0343/1753] Remove WPF workaround that isn't necessary with the .NET 6 SDK --- Directory.Build.props | 1 - 1 file changed, 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 38102b59f..38d8582da 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -12,7 +12,6 @@ true true true - true $(RepoRootPath) From 8a53e8b57038869eb0b5d7cfc4a08650b4ca56e7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 28 Oct 2021 07:13:05 -0600 Subject: [PATCH 0344/1753] Archive symbols on VSEng-ReleasePool-1ES --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 38ea71248..fc6965650 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -53,7 +53,7 @@ stages: condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) jobs: - job: archive - pool: VSEng-ReleasePool + pool: VSEng-ReleasePool-1ES steps: - download: current artifact: Variables-Windows From a280dfc4ad77431e75a359b37c27886cf3a3afe7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Nov 2021 13:00:43 +0000 Subject: [PATCH 0345/1753] Bump Microsoft.NET.Test.Sdk from 16.11.0 to 17.0.0 Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 16.11.0 to 17.0.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v16.11.0...v17.0.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 9a0a5820e..ebd5df8ff 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -11,7 +11,7 @@ - + From ab053bb6cc903ac4a48ba198f126b5e021905e33 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Nov 2021 06:13:29 -0600 Subject: [PATCH 0346/1753] Disable default, redundant NB.GV behavior We already call `nbgv cloud` in the cloud builds, so there is no need to set certain pipeline variables with every project. In fact given a couple bugs that have come into NB.GV lately around issues on [AzP](https://github.com/dotnet/Nerdbank.GitVersioning/pull/675) or [GitHub Actions](https://github.com/dotnet/Nerdbank.GitVersioning/issues/683) around setting pipeline variables, this should improve build reliability. --- version.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/version.json b/version.json index f0da4f6a1..39add9860 100644 --- a/version.json +++ b/version.json @@ -4,5 +4,8 @@ "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" - ] + ], + "cloudBuild": { + "setVersionVariables": false + } } From 16d30af64f26f62e547805ebcb002b1efd3f7a6d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Nov 2021 10:29:57 -0600 Subject: [PATCH 0347/1753] Log artifact warnings in more cases We were not warning when *groups* would be defined by an artifact collector even if all those groups were empty. --- azure-pipelines/artifacts/_all.ps1 | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index efd6bdb3e..db10c5ffa 100755 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -25,10 +25,9 @@ Function EnsureTrailingSlash($path) { Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse |% { $ArtifactName = $_.BaseName + $totalFileCount = 0 $fileGroups = & $_ - if (!$fileGroups -or $fileGroups.Count -eq 0) { - Write-Warning "No files found for the `"$ArtifactName`" artifact." - } else { + if ($fileGroups) { $fileGroups.GetEnumerator() | % { $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key.ToString()), [UriKind]::Absolute) $_.Value | % { @@ -46,7 +45,12 @@ Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse |% { Add-Member -InputObject $artifact -MemberType NoteProperty -Name ContainerFolder -Value (Split-Path $RelativePath) Write-Output $artifact + $totalFileCount += 1 } } } + + if ($totalFileCount -eq 0) { + Write-Warning "No files found for the `"$ArtifactName`" artifact." + } } From cbf38a43293df070b8dc0cf8f365e2b237f4bd22 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Nov 2021 12:31:26 -0700 Subject: [PATCH 0348/1753] Use .NET SDK 6.0.100 GA --- global.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/global.json b/global.json index 973759e1f..e2af429b5 100644 --- a/global.json +++ b/global.json @@ -1,7 +1,7 @@ { "sdk": { - "version": "6.0.100-rc.2.21505.57", + "version": "6.0.100", "rollForward": "patch", - "allowPrerelease": true + "allowPrerelease": false } } From 4582d85ab68fe930a4b2016a7351322a0e6672db Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Nov 2021 08:25:49 -0700 Subject: [PATCH 0349/1753] Collect coverage in non-multitargeting environments --- azure-pipelines/artifacts/coverageResults.ps1 | 4 ++-- azure-pipelines/publish-codecoverage.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index addbf85c2..8fdb3f720 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -3,7 +3,7 @@ $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") # Prepare code coverage reports for merging on another machine if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`"" - $reports = Get-ChildItem "$RepoRoot/bin/coverage.*.cobertura.xml" -Recurse + $reports = Get-ChildItem "$RepoRoot/bin/coverage.*cobertura.xml" -Recurse $reports |% { $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } Set-Content -Path $_ -Value $content -Encoding UTF8 @@ -16,7 +16,7 @@ if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } @{ $RepoRoot = ( - @(Get-ChildItem "$RepoRoot\bin\coverage.*.cobertura.xml" -Recurse) + + @(Get-ChildItem "$RepoRoot\bin\coverage.*cobertura.xml" -Recurse) + (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse) ); } diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index d83eb64ad..3667b976c 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -19,7 +19,7 @@ steps: dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.8.5 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" - $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.*.cobertura.xml" + $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.*cobertura.xml" $reports |% { $content = Get-Content -Path $_ |% { $_.Replace("{reporoot}", "$(System.DefaultWorkingDirectory)") } Set-Content -Path $_ -Value $content -Encoding UTF8 From 920947343737b964b1f84a4359529286bb9b869f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Nov 2021 21:43:01 -0700 Subject: [PATCH 0350/1753] Touch-ups --- .devcontainer/Dockerfile | 2 +- .vscode/settings.json | 12 ++++++------ Directory.Build.props | 1 - 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 889499464..c47acfaa9 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,4 @@ -FROM mcr.microsoft.com/dotnet/sdk:5.0.400-focal +FROM mcr.microsoft.com/dotnet/sdk:6.0.100-focal # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/.vscode/settings.json b/.vscode/settings.json index 00aaed88f..3ae1371c6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,8 +1,8 @@ { - "files.trimTrailingWhitespace": true, - "files.insertFinalNewline": true, - "files.trimFinalNewlines": true, - "omnisharp.enableEditorConfigSupport": true, - "omnisharp.enableImportCompletion": true, - "omnisharp.enableRoslynAnalyzers": true + "files.trimTrailingWhitespace": true, + "files.insertFinalNewline": true, + "files.trimFinalNewlines": true, + "omnisharp.enableEditorConfigSupport": true, + "omnisharp.enableImportCompletion": true, + "omnisharp.enableRoslynAnalyzers": true } diff --git a/Directory.Build.props b/Directory.Build.props index 38d8582da..0ce1cbb72 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -12,7 +12,6 @@ true true true - $(RepoRootPath) $(MSBuildThisFileDirectory) From 686e55d0f99445c0db83bdbe45d14722a5597651 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Nov 2021 12:41:18 -0700 Subject: [PATCH 0351/1753] Add Apply-Template.ps1 script to automate template updates --- Apply-Template.ps1 | 27 +++++++++++++++++++++++++++ Expand-Template.ps1 | 2 +- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 Apply-Template.ps1 diff --git a/Apply-Template.ps1 b/Apply-Template.ps1 new file mode 100644 index 000000000..544b7a7c0 --- /dev/null +++ b/Apply-Template.ps1 @@ -0,0 +1,27 @@ +#!/usr/bin/env pwsh + +<# +.SYNOPSIS +Applies the template to another repo in a semi-destructive way. +Always apply to a clean working copy so that undesired updates can be easily reverted. +.PARAMETER Path +The path to the root of the repo to be updated with the latest version of this template. +#> + +[CmdletBinding(SupportsShouldProcess, ConfirmImpact='Medium')] +Param( + [Parameter(Mandatory=$true)] + [ValidateScript({Test-Path $_})] + [string]$Path +) + +Write-Host "Updating $Path" +robocopy /mir $PSScriptRoot/azure-pipelines $Path/azure-pipelines +robocopy /mir $PSScriptRoot/.devcontainer $Path/.devcontainer +robocopy /mir $PSScriptRoot/.github $Path/.github +robocopy /mir $PSScriptRoot/.vscode $Path/.vscode +robocopy /mir $PSScriptRoot/tools $Path/tools +robocopy $PSScriptRoot $Path Directory.Build.* global.json init.* azure-pipelines.yml .gitignore .gitattributes .editorconfig +robocopy $PSScriptRoot/src $Path/src Directory.Build.* .editorconfig +robocopy $PSScriptRoot/test $Path/test Directory.Build.* .editorconfig +Remove-Item $Path/azure-pipelines/expand-template.yml diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index d665e56a3..9e4d49737 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -180,7 +180,7 @@ try { Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements # Self destruct - git rm Expand-Template.* + git rm Expand-Template.* Apply-Template.ps1 if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git rm :/azure-pipelines/expand-template.yml if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } From c89a91562b6aeabbc18e6647165230d04a386d04 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Nov 2021 12:44:29 -0700 Subject: [PATCH 0352/1753] Suppress microbuild nonshipping dependency --- test/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index ef88f73ac..6ada957dd 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -7,6 +7,6 @@ - + From 861b1285548438f448bed6bc6ac63161095cfbb4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Nov 2021 15:50:41 -0700 Subject: [PATCH 0353/1753] Build on Microbuild 2022 agents --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index fc6965650..b6791c676 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -45,7 +45,7 @@ stages: jobs: - template: build.yml parameters: - windowsPool: VSEngSS-MicroBuild2019-1ES + windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: ${{ parameters.includeMacOS }} - stage: symbol_archive From 805c87a603471d8cb6af194e727304ae05d1579b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Nov 2021 15:49:51 -0700 Subject: [PATCH 0354/1753] Build on VS 2022 agents --- azure-pipelines/build.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index cd39a76ab..a1f5e786d 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -1,6 +1,9 @@ parameters: - windowsPool: Hosted Windows 2019 with VS2019 - includeMacOS: +- name: windowsPool + type: object + default: + vmImage: windows-2022 +- name: includeMacOS jobs: - job: Windows From 4fb29c86e9d117361e15454ba5d82a2f4e39259b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Nov 2021 16:27:20 -0700 Subject: [PATCH 0355/1753] Update Microsoft.SourceLink.GitHub package version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 0ce1cbb72..2e7716027 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -34,7 +34,7 @@ - + From decffacc230f5a45d6cef669d0c81a08ce63353d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Nov 2021 15:49:28 -0700 Subject: [PATCH 0356/1753] Define TeamEmail variable --- azure-pipelines/variables/TeamEmail.ps1 | 1 + 1 file changed, 1 insertion(+) create mode 100644 azure-pipelines/variables/TeamEmail.ps1 diff --git a/azure-pipelines/variables/TeamEmail.ps1 b/azure-pipelines/variables/TeamEmail.ps1 new file mode 100644 index 000000000..7cf66982b --- /dev/null +++ b/azure-pipelines/variables/TeamEmail.ps1 @@ -0,0 +1 @@ +'vsidemicrobuild@microsoft.com' From 2eb1688704d5de2990fd51407b2ec64ac41019d3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Nov 2021 15:48:47 -0700 Subject: [PATCH 0357/1753] Collect diagnostic test logs --- azure-pipelines/artifacts/testResults.ps1 | 20 +++++++++++++------- azure-pipelines/dotnet.yml | 6 +++--- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index 7895ddcaa..862155da7 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -1,12 +1,18 @@ +$result = @{} + if ($env:AGENT_TEMPDIRECTORY) { # The DotNetCoreCLI uses an alternate location to publish these files $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' - @{ - $env:AGENT_TEMPDIRECTORY = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); - } -} else { + $result[$env:AGENT_TEMPDIRECTORY] = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); +} +else { $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" - @{ - $testRoot = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File); - } + $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) +} + +$testlogsPath = "$env:BUILD_ARTIFACTSTAGINGDIRECTORY\test_logs" +if (Test-Path $testlogsPath) { + $result[$testlogsPath] = Get-ChildItem "$testlogsPath\*"; } + +$result diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 50ba58f1d..70cd23ee0 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -10,7 +10,7 @@ steps: displayName: dotnet test -f net472 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net472.binlog" + arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net472.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net472.txt" testRunTitle: net472-$(Agent.JobName) condition: succeededOrFailed() @@ -18,7 +18,7 @@ steps: displayName: dotnet test -f netcoreapp3.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp3.1.binlog" + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp3.1.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/netcoreapp3.1.txt" testRunTitle: netcoreapp3.1-$(Agent.JobName) condition: succeededOrFailed() @@ -26,7 +26,7 @@ steps: displayName: dotnet test -f net5.0 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f net5.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0.binlog" + arguments: --no-build -c $(BuildConfiguration) -f net5.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net5.0.txt" testRunTitle: net5.0-$(Agent.JobName) condition: succeededOrFailed() From df52bbc7da6d37808c1e0095bea0ba3e1905697d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Nov 2021 15:49:06 -0700 Subject: [PATCH 0358/1753] Remove CA1508, which has too many false positives --- .editorconfig | 3 --- 1 file changed, 3 deletions(-) diff --git a/.editorconfig b/.editorconfig index c561b3810..0d75b34a3 100644 --- a/.editorconfig +++ b/.editorconfig @@ -164,9 +164,6 @@ csharp_prefer_braces = true:silent # SA1130: Use lambda syntax dotnet_diagnostic.SA1130.severity = silent -# CA1508: Avoid dead conditional code -dotnet_diagnostic.CA1508.severity = warning - # IDE1006: Naming Styles - StyleCop handles these for us dotnet_diagnostic.IDE1006.severity = none From c5db1efad8a160ec9869b4e1cf0b72b07b59526f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 25 Nov 2021 22:26:34 -0700 Subject: [PATCH 0359/1753] Fix ARM detection on Linux The `$env:PROCESSOR_ARCHITECTURE` environment variable simply isn't set on linux. --- tools/Install-DotNetSdk.ps1 | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 427899307..f5a300a4e 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -29,8 +29,7 @@ $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot # Look up actual required .NET Core SDK version from global.json $sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" -$arch = 'x64' -if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { $arch = 'ARM64' } +$arch = [System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture # Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() From c9ed75c04a722207de4f79a2cb17f558b8ae4641 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 29 Nov 2021 16:17:37 -0700 Subject: [PATCH 0360/1753] Format whitespace in init.ps1 --- init.ps1 | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/init.ps1 b/init.ps1 index cb86c6cac..774ead583 100755 --- a/init.ps1 +++ b/init.ps1 @@ -31,10 +31,10 @@ .PARAMETER AccessToken An optional access token for authenticating to Azure Artifacts authenticated feeds. #> -[CmdletBinding(SupportsShouldProcess=$true)] +[CmdletBinding(SupportsShouldProcess = $true)] Param ( - [ValidateSet('repo','user','machine')] - [string]$InstallLocality='user', + [ValidateSet('repo', 'user', 'machine')] + [string]$InstallLocality = 'user', [Parameter()] [switch]$NoPrerequisites, [Parameter()] @@ -68,8 +68,8 @@ if (!$NoPrerequisites) { } # Workaround nuget credential provider bug that causes very unreliable package restores on Azure Pipelines -$env:NUGET_PLUGIN_HANDSHAKE_TIMEOUT_IN_SECONDS=20 -$env:NUGET_PLUGIN_REQUEST_TIMEOUT_IN_SECONDS=20 +$env:NUGET_PLUGIN_HANDSHAKE_TIMEOUT_IN_SECONDS = 20 +$env:NUGET_PLUGIN_REQUEST_TIMEOUT_IN_SECONDS = 20 Push-Location $PSScriptRoot try { From b75b239dfc8258e7c5d8c60ea9b4bc338392293f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 1 Dec 2021 11:57:57 -0700 Subject: [PATCH 0361/1753] Suppress powershell interpreting of AzP macros --- azure-pipelines/publish-codecoverage.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 3667b976c..a0862be3f 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -18,10 +18,10 @@ steps: - powershell: | dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.8.5 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj - Write-Host "Substituting {reporoot} with $(System.DefaultWorkingDirectory)" - $reports = Get-ChildItem -Recurse "$(Pipeline.Workspace)/coverage.*cobertura.xml" + Write-Host 'Substituting {reporoot} with $(System.DefaultWorkingDirectory)' + $reports = Get-ChildItem -Recurse '$(Pipeline.Workspace)/coverage.*cobertura.xml' $reports |% { - $content = Get-Content -Path $_ |% { $_.Replace("{reporoot}", "$(System.DefaultWorkingDirectory)") } + $content = Get-Content -Path $_ |% { $_.Replace('{reporoot}', '$(System.DefaultWorkingDirectory)') } Set-Content -Path $_ -Value $content -Encoding UTF8 } $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_ })) From e1fafe9b84943d228456c3595a547c2d62a8acc0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 10:55:44 -0700 Subject: [PATCH 0362/1753] Secure p/invoke native library loads --- src/AssemblyInfo.cs | 6 ++++++ src/Directory.Build.targets | 4 ++++ 2 files changed, 10 insertions(+) create mode 100644 src/AssemblyInfo.cs diff --git a/src/AssemblyInfo.cs b/src/AssemblyInfo.cs new file mode 100644 index 000000000..81feda271 --- /dev/null +++ b/src/AssemblyInfo.cs @@ -0,0 +1,6 @@ +// Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System.Runtime.InteropServices; + +[assembly: DefaultDllImportSearchPaths(DllImportSearchPath.SafeDirectories)] diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index e7edee55a..566ab4fcf 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,3 +1,7 @@ + + + + From ca5dc779b4abe27cc6aca34a1498af6fa0a3eca9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 13:05:54 -0700 Subject: [PATCH 0363/1753] Generate NOTICE file and include in nuget packages --- Directory.Build.props | 4 ++++ azure-pipelines/microbuild.after.yml | 3 --- azure-pipelines/microbuild.before.yml | 9 +++++++++ 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 70ab3c7bc..ee2465876 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -41,6 +41,10 @@ + + + + diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 8559b27a0..70f07eaa8 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -9,9 +9,6 @@ steps: condition: succeededOrFailed() displayName: MicroBuild Cleanup -- task: ComponentGovernanceComponentDetection@0 - displayName: Component Detection - - task: Ref12Analyze@0 displayName: Ref12 (Codex) Analyze inputs: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 96cd32540..ab9306944 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,4 +1,13 @@ steps: +- task: ComponentGovernanceComponentDetection@0 + displayName: Component Detection + +- task: notice@0 + displayName: Generate NOTICE file + inputs: + outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE + outputformat: text + - task: MicroBuildSigningPlugin@3 inputs: signType: $(SignType) From 099d36f7c4fe6b82e091833675e52ede3617b7ca Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 13:12:48 -0700 Subject: [PATCH 0364/1753] Fix PoliCheck to actually break builds on failures --- azure-pipelines/PoliCheckExclusions.xml | 10 ++++++++++ azure-pipelines/secure-development-tools.yml | 16 +++++++++++----- 2 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 azure-pipelines/PoliCheckExclusions.xml diff --git a/azure-pipelines/PoliCheckExclusions.xml b/azure-pipelines/PoliCheckExclusions.xml new file mode 100644 index 000000000..5ae167100 --- /dev/null +++ b/azure-pipelines/PoliCheckExclusions.xml @@ -0,0 +1,10 @@ + + + NODE_MODULES|.STORE + + + + + + + diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 941d5b0c8..ca05939e1 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -1,11 +1,17 @@ steps: - ### Check for checked in credentials. - task: CredScan@3 - displayName: 'Run CredScan' + displayName: Run CredScan - ### Run PoliCheck to check for disallowed terms. targetType: F indicates we're searching files and folders. -- task: PoliCheck@1 - displayName: 'Run PoliCheck' +- task: PoliCheck@2 + displayName: Run PoliCheck inputs: targetType: F + targetArgument: $(System.DefaultWorkingDirectory) + optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml + +- task: PostAnalysis@2 + displayName: Break on compliance issues + inputs: + GdnBreakAllTools: true + GdnBreakGdnToolBinSkimSeverity: Warning From a53b29ece9260d9d844cc4e90bd2ad84bcdf05cb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 13:18:59 -0700 Subject: [PATCH 0365/1753] Add SDT task reporting --- azure-pipelines/secure-development-tools.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index ca05939e1..56d262791 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -10,6 +10,20 @@ steps: targetArgument: $(System.DefaultWorkingDirectory) optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml +- task: SdtReport@2 + displayName: Create Security Analysis Report + inputs: + GdnExportAllTools: true + +- task: PublishSecurityAnalysisLogs@3 + displayName: Publish Code Analysis Logs + inputs: + ArtifactName: CodeAnalysisLogs + ArtifactType: Container + PublishProcessedResults: true + AllTools: true + ToolLogsNotFoundAction: Standard + - task: PostAnalysis@2 displayName: Break on compliance issues inputs: From 848f9799a8d6b890195c9bc231766e4466349402 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 13:19:14 -0700 Subject: [PATCH 0366/1753] Add BinSkim to SDT tasks --- azure-pipelines/Get-SymbolFiles.ps1 | 10 ++++++++-- azure-pipelines/secure-development-tools.yml | 7 +++++++ azure-pipelines/variables/BinSkimTargets.ps1 | 4 ++++ 3 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 azure-pipelines/variables/BinSkimTargets.ps1 diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index 45afe7c2a..8793e19c6 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -5,12 +5,16 @@ The root path to recursively search for PDBs. .PARAMETER Tests A switch indicating to find test-related PDBs instead of product-only PDBs. +.PARAMETER ConvertToWindowsPDBs + A switch to convert and return paths to Windows PDBs instead of portable PDBs. + Ignored on non-Windows agents. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$Path, - [switch]$Tests + [switch]$Tests, + [switch]$ConvertToWindowsPDBs=$true ) $WindowsPdbSubDirName = "symstore" @@ -54,7 +58,7 @@ $PDBs |% { Write-Output $BinaryImagePath - if (-not ($IsMacOS -or $IsLinux)) { + if ($ConvertToWindowsPDBs -and -not ($IsMacOS -or $IsLinux)) { # Convert the PDB to legacy Windows PDBs Write-Host "Converting PDB for $_" -ForegroundColor DarkGray $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" @@ -65,5 +69,7 @@ $PDBs |% { } Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" + } else { + Write-Output $_.FullName } } diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 56d262791..0ac9b3246 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -10,6 +10,13 @@ steps: targetArgument: $(System.DefaultWorkingDirectory) optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml +- task: BinSkim@3 + displayName: Run BinSkim + inputs: + InputType: Basic + Function: analyze + AnalyzeTarget: $(BinSkimTargets) + - task: SdtReport@2 displayName: Create Security Analysis Report inputs: diff --git a/azure-pipelines/variables/BinSkimTargets.ps1 b/azure-pipelines/variables/BinSkimTargets.ps1 new file mode 100644 index 000000000..5c0dd24ec --- /dev/null +++ b/azure-pipelines/variables/BinSkimTargets.ps1 @@ -0,0 +1,4 @@ +$Path = "$PSScriptRoot\..\..\bin" +if (Test-Path $Path) { + [string]::join(';', (& "$PSScriptRoot\..\Get-SymbolFiles.ps1" -ConvertToWindowsPDBs:$false -Path $Path)) +} From 1be4fa9788b5295754319602b6524de64f865a42 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 16:50:33 -0700 Subject: [PATCH 0367/1753] Fix regression in platform detection in Windows Powershell --- tools/Install-DotNetSdk.ps1 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index f5a300a4e..3c82ee2b2 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -30,6 +30,10 @@ $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot $sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" $arch = [System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture +if (!$arch) { # Windows Powershell leaves this blank + $arch = 'x64' + if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { $arch = 'ARM64' } +} # Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() From 81634e306fd8a561434c42687ee7f3f84b4a0067 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 3 Dec 2021 06:40:03 -0700 Subject: [PATCH 0368/1753] Set basic version build variables in pipeline --- azure-pipelines/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index a1f5e786d..796be61d6 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -13,7 +13,7 @@ jobs: clean: true - template: install-dependencies.yml - - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud' + - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -c' displayName: Set build number - template: dotnet.yml From 02a6d80f2ca20040fc1d3624e461c2f40b5773d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Dec 2021 13:27:49 -0700 Subject: [PATCH 0369/1753] Add APIScan SDT task --- azure-pipelines/build.yml | 9 +++++ azure-pipelines/falsepositives.gdnsuppress | 12 +++++++ azure-pipelines/microbuild.after.yml | 6 ++++ azure-pipelines/official.yml | 5 +++ azure-pipelines/secure-development-tools.yml | 35 ++++++++++++++++++++ 5 files changed, 67 insertions(+) create mode 100644 azure-pipelines/falsepositives.gdnsuppress diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 58cb97163..8523ab858 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -4,10 +4,17 @@ parameters: default: vmImage: windows-2022 - name: includeMacOS +- name: EnableAPIScan + type: boolean + default: false jobs: - job: Windows pool: ${{ parameters.windowsPool }} + variables: + - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline + - group: VSCloudServices-APIScan steps: - checkout: self clean: true @@ -27,6 +34,8 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml + parameters: + EnableAPIScan: ${{ parameters.EnableAPIScan }} - template: expand-template.yml diff --git a/azure-pipelines/falsepositives.gdnsuppress b/azure-pipelines/falsepositives.gdnsuppress new file mode 100644 index 000000000..1248172b9 --- /dev/null +++ b/azure-pipelines/falsepositives.gdnsuppress @@ -0,0 +1,12 @@ +{ + "version": "latest", + "suppressionSets": { + "falsepositives": { + "name": "falsepositives", + "createdDate": "2021-12-03 00:23:08Z", + "lastUpdatedDate": "2021-12-03 00:23:08Z" + } + }, + "results": { + } +} diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 70f07eaa8..6f107833b 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,3 +1,7 @@ +parameters: +- name: EnableAPIScan + type: boolean + steps: - task: MicroBuildCodesignVerify@3 displayName: Verify Signed Files @@ -23,3 +27,5 @@ steps: continueOnError: true - template: secure-development-tools.yml + parameters: + EnableAPIScan: ${{ parameters.EnableAPIScan }} diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index b6791c676..bac667b65 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -27,6 +27,10 @@ parameters: displayName: Build on macOS type: boolean default: false # macOS is often bogged down in Azure Pipelines +- name: EnableAPIScan + displayName: Run APIScan + type: boolean + default: true variables: NugetSecurityAnalysisWarningLevel: none # nuget.config requires signed packages by trusted owners @@ -45,6 +49,7 @@ stages: jobs: - template: build.yml parameters: + EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: ${{ parameters.includeMacOS }} diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 0ac9b3246..e6b4d6247 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -1,3 +1,7 @@ +parameters: +- name: EnableAPIScan + type: boolean + steps: - task: CredScan@3 @@ -17,6 +21,27 @@ steps: Function: analyze AnalyzeTarget: $(BinSkimTargets) +- task: CopyFiles@2 + displayName: Collect APIScan inputs + inputs: + SourceFolder: $(Build.ArtifactStagingDirectory)/Symbols-$(Agent.JobName) + # Exclude any patterns from the Contents (e.g. `!**/git2*`) that we have symbols for but do not need to run APIScan on. + Contents: | + ** + TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs + +- task: APIScan@2 + displayName: Run APIScan + inputs: + softwareFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs + softwareName: $(SymbolsFeatureName) + softwareVersionNum: $(GitBuildVersion) + isLargeApp: false + toolVersion: Latest + condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) + env: + AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) + - task: SdtReport@2 displayName: Create Security Analysis Report inputs: @@ -36,3 +61,13 @@ steps: inputs: GdnBreakAllTools: true GdnBreakGdnToolBinSkimSeverity: Warning + GdnBreakSuppressionFiles: $(System.DefaultWorkingDirectory)/azure-pipelines/falsepositives.gdnsuppress + GdnBreakSuppressionSets: falsepositives + GdnBreakOutputSuppressionFile: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions/ + GdnBreakOutputSuppressionSet: falsepositives + +# This is useful when false positives appear so we can copy some of the output into the suppressions file. +- publish: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions + artifact: guardian_failures_as_suppressions + displayName: Publish Guardian failures + condition: failed() From e4ef595f167a6848292a1c121bee85c7ae1cae09 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 3 Dec 2021 08:06:54 -0700 Subject: [PATCH 0370/1753] Patch AssemblyInfo.cs --- Apply-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Apply-Template.ps1 b/Apply-Template.ps1 index 544b7a7c0..0d3f3d8e2 100644 --- a/Apply-Template.ps1 +++ b/Apply-Template.ps1 @@ -22,6 +22,6 @@ robocopy /mir $PSScriptRoot/.github $Path/.github robocopy /mir $PSScriptRoot/.vscode $Path/.vscode robocopy /mir $PSScriptRoot/tools $Path/tools robocopy $PSScriptRoot $Path Directory.Build.* global.json init.* azure-pipelines.yml .gitignore .gitattributes .editorconfig -robocopy $PSScriptRoot/src $Path/src Directory.Build.* .editorconfig +robocopy $PSScriptRoot/src $Path/src Directory.Build.* .editorconfig AssemblyInfo.cs robocopy $PSScriptRoot/test $Path/test Directory.Build.* .editorconfig Remove-Item $Path/azure-pipelines/expand-template.yml From 7d02faa9b0662aa263dbd2cf068e473b2e911c8e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 3 Dec 2021 08:07:31 -0700 Subject: [PATCH 0371/1753] Skip copying APIScan inputs when APIScan is disabled --- azure-pipelines/secure-development-tools.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index e6b4d6247..21eab9d36 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -29,6 +29,7 @@ steps: Contents: | ** TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs + condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) - task: APIScan@2 displayName: Run APIScan From 52d37aebaa5b7f119810d2fba3977006f99ef289 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 3 Dec 2021 08:15:02 -0700 Subject: [PATCH 0372/1753] Update Nerdbank.GitVersioning --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 2e7716027..3b2b143bb 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -35,7 +35,7 @@ - + From c2b0252db640401aa5b1cf62f44d30e4298bff46 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 3 Dec 2021 11:48:23 -0700 Subject: [PATCH 0373/1753] Reduce frequency of changing version given to APIScan --- azure-pipelines/build.yml | 2 +- azure-pipelines/secure-development-tools.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 8523ab858..27ba5b5be 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -24,7 +24,7 @@ jobs: - template: install-dependencies.yml - - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -c' + - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -ca' displayName: Set build number - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 21eab9d36..99925c13d 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -36,7 +36,7 @@ steps: inputs: softwareFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs softwareName: $(SymbolsFeatureName) - softwareVersionNum: $(GitBuildVersion) + softwareVersionNum: $(NBGV_MajorMinorVersion) isLargeApp: false toolVersion: Latest condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) From 4f87de906bc58b5b6a505c4eadbd7ff6068ac60a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 6 Jan 2022 12:39:52 -0700 Subject: [PATCH 0374/1753] Bump BinSkim to v4 --- azure-pipelines/secure-development-tools.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 99925c13d..c5ebf04e5 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -14,12 +14,13 @@ steps: targetArgument: $(System.DefaultWorkingDirectory) optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml -- task: BinSkim@3 +- task: BinSkim@4 displayName: Run BinSkim inputs: InputType: Basic Function: analyze - AnalyzeTarget: $(BinSkimTargets) + TargetPattern: guardianGlob + AnalyzeTargetGlob: $(BinSkimTargets) - task: CopyFiles@2 displayName: Collect APIScan inputs From c31f6ad1e0ffaf45e333da288419a9e17529f2b0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jan 2022 08:26:38 -0700 Subject: [PATCH 0375/1753] Fix Expand-Template to replace tokens in AssemblyInfo.cs --- Expand-Template.ps1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 9e4d49737..d203d85f0 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -145,6 +145,9 @@ try { 'Library'=$LibraryName 'COMPANY-PLACEHOLDER'=$Author } + Replace-Placeholders -Path "src/AssemblyInfo.cs" -Replacements @{ + 'COMPANY-PLACEHOLDER'=$Author + } Replace-Placeholders -Path "LICENSE" -Replacements @{ 'COMPANY-PLACEHOLDER'=$Author } From 6cf12a28d7447b8921e2854937ee09d1a10b8bbb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jan 2022 08:09:07 -0700 Subject: [PATCH 0376/1753] Enable publishing of artifacts in multiple passes When an artifact is not ready yet, but other artifacts are and must be prepared, we can now run `artifacts/_pipelines.ps1` multiple times in the pipeline. To opt out of an earlier pass, the artifact script need only produce 0 files. After an artifact script returns some files, that artifact will be published and will not be published again. This is similar to `variables/_pipelines.ps1` behavior, which we already run twice. --- azure-pipelines/artifacts/_all.ps1 | 84 ++++++++++++++---------- azure-pipelines/artifacts/_pipelines.ps1 | 5 ++ azure-pipelines/artifacts/_stage_all.ps1 | 2 +- 3 files changed, 55 insertions(+), 36 deletions(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index db10c5ffa..afe42be30 100755 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -1,18 +1,24 @@ #!/usr/bin/env pwsh -# This script returns all the artifacts that should be collected after a build. -# -# Each powershell artifact is expressed as an object with these properties: -# Source - the full path to the source file -# ArtifactName - the name of the artifact to upload to -# ContainerFolder - the relative path within the artifact in which the file should appear -# -# Each artifact aggregating .ps1 script should return a hashtable: -# Key = path to the directory from which relative paths within the artifact should be calculated -# Value = an array of paths (absolute or relative to the BaseDirectory) to files to include in the artifact. -# FileInfo objects are also allowed. - -$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +<# +.SYNOPSIS + This script returns all the artifacts that should be collected after a build. + Each powershell artifact is expressed as an object with these properties: + Source - the full path to the source file + ArtifactName - the name of the artifact to upload to + ContainerFolder - the relative path within the artifact in which the file should appear + Each artifact aggregating .ps1 script should return a hashtable: + Key = path to the directory from which relative paths within the artifact should be calculated + Value = an array of paths (absolute or relative to the BaseDirectory) to files to include in the artifact. + FileInfo objects are also allowed. +.PARAMETER Force + Executes artifact scripts even if they have already been uploaded. +#> + +param ( + [string]$ArtifactNameSuffix, + [switch]$Force +) Function EnsureTrailingSlash($path) { if ($path.length -gt 0 -and !$path.EndsWith('\') -and !$path.EndsWith('/')) { @@ -22,35 +28,43 @@ Function EnsureTrailingSlash($path) { $path.Replace('\', [IO.Path]::DirectorySeparatorChar) } -Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse |% { - $ArtifactName = $_.BaseName +Function Test-ArtifactUploaded($artifactName) { + $varName = "ARTIFACTUPLOADED_$($artifactName.ToUpper())" + Test-Path "env:$varName" +} - $totalFileCount = 0 - $fileGroups = & $_ - if ($fileGroups) { - $fileGroups.GetEnumerator() | % { - $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key.ToString()), [UriKind]::Absolute) - $_.Value | % { - if ($_.GetType() -eq [IO.FileInfo] -or $_.GetType() -eq [IO.DirectoryInfo]) { - $_ = $_.FullName - } +Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse | % { + $ArtifactName = $_.BaseName + if ($Force -or !(Test-ArtifactUploaded($ArtifactName + $ArtifactNameSuffix))) { + $totalFileCount = 0 + $fileGroups = & $_ + if ($fileGroups) { + $fileGroups.GetEnumerator() | % { + $BaseDirectory = New-Object Uri ((EnsureTrailingSlash $_.Key.ToString()), [UriKind]::Absolute) + $_.Value | ? { $_ } | % { + if ($_.GetType() -eq [IO.FileInfo] -or $_.GetType() -eq [IO.DirectoryInfo]) { + $_ = $_.FullName + } - $artifact = New-Object -TypeName PSObject - Add-Member -InputObject $artifact -MemberType NoteProperty -Name ArtifactName -Value $ArtifactName + $artifact = New-Object -TypeName PSObject + Add-Member -InputObject $artifact -MemberType NoteProperty -Name ArtifactName -Value $ArtifactName - $SourceFullPath = New-Object Uri ($BaseDirectory, $_) - Add-Member -InputObject $artifact -MemberType NoteProperty -Name Source -Value $SourceFullPath.LocalPath + $SourceFullPath = New-Object Uri ($BaseDirectory, $_) + Add-Member -InputObject $artifact -MemberType NoteProperty -Name Source -Value $SourceFullPath.LocalPath - $RelativePath = [Uri]::UnescapeDataString($BaseDirectory.MakeRelative($SourceFullPath)) - Add-Member -InputObject $artifact -MemberType NoteProperty -Name ContainerFolder -Value (Split-Path $RelativePath) + $RelativePath = [Uri]::UnescapeDataString($BaseDirectory.MakeRelative($SourceFullPath)) + Add-Member -InputObject $artifact -MemberType NoteProperty -Name ContainerFolder -Value (Split-Path $RelativePath) - Write-Output $artifact - $totalFileCount += 1 + Write-Output $artifact + $totalFileCount += 1 + } } } - } - if ($totalFileCount -eq 0) { - Write-Warning "No files found for the `"$ArtifactName`" artifact." + if ($totalFileCount -eq 0) { + Write-Warning "No files found for the `"$ArtifactName`" artifact." + } + } else { + Write-Host "Skipping $ArtifactName because it has already been uploaded." -ForegroundColor DarkGray } } diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 5bca7c6c1..73a3af0ac 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -7,4 +7,9 @@ param ( & "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix |% { Write-Host "##vso[artifact.upload containerfolder=$($_.Name);artifactname=$($_.Name);]$($_.Path)" + + # Set a variable which will out-live this script so that a subsequent attempt to collect and upload artifacts + # will skip this one from a check in the _all.ps1 script. + $varName = "ARTIFACTUPLOADED_$($_.Name.ToUpper())" + Write-Host "##vso[task.setvariable variable=$varName]true" } diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index 4e6a6dbe0..4788a3f5b 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -38,7 +38,7 @@ function Create-SymbolicLink { } # Stage all artifacts -$Artifacts = & "$PSScriptRoot\_all.ps1" +$Artifacts = & "$PSScriptRoot\_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix $Artifacts |% { $DestinationFolder = (Join-Path (Join-Path $ArtifactStagingFolder "$($_.ArtifactName)$ArtifactNameSuffix") $_.ContainerFolder).TrimEnd('\') $Name = "$(Split-Path $_.Source -Leaf)" From 6235412ac9f7bb02c49be49821f329fc30d7499f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jan 2022 11:21:05 -0700 Subject: [PATCH 0377/1753] Build SBOM manifest as part of build --- Expand-Template.ps1 | 3 +++ azure-pipelines/artifacts/VSInsertion.ps1 | 3 +++ azure-pipelines/build.yml | 5 +++++ azure-pipelines/microbuild.after.yml | 9 +++++++++ azure-pipelines/official.yml | 1 + 5 files changed, 21 insertions(+) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 8d4c2f4b2..5705e7221 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -155,6 +155,9 @@ try { $YmlReplacements['(codecov_token: ).*(#.*)'] = "#`$1`$2" } Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements + Replace-Placeholders -Path "azure-pipelines/microbuild.after.yml" -Replacements @{ + 'Library' = $LibraryName; + } Replace-Placeholders -Path "azure-pipelines/variables/InsertVersionsValues.ps1" -Replacements @{ 'LibraryName' = $LibraryName; diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 88cab0f80..80e621e74 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -8,6 +8,9 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" +# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $PackagesRoot/_manifest)) { return @{} } + if (!(Test-Path $PackagesRoot)) { return @{} } @{ diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 27ba5b5be..1d003eb1e 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -36,6 +36,11 @@ jobs: - template: microbuild.after.yml parameters: EnableAPIScan: ${{ parameters.EnableAPIScan }} + # Repeat this step to scoop up any artifacts that would only be collected after running microbuild.after.yml + - powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" + failOnStderr: true + displayName: Publish artifacts + condition: succeededOrFailed() - template: expand-template.yml diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 6f107833b..e889a464d 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -13,6 +13,15 @@ steps: condition: succeededOrFailed() displayName: MicroBuild Cleanup +- task: ManifestGeneratorTask@0 + displayName: Software Bill of Materials generation + inputs: + BuildDropPath: $(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration) + BuildComponentPath: $(System.DefaultWorkingDirectory)/obj/src/Library + +- powershell: Copy-Item -Recurse "$(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration)/_manifest" "$(System.DefaultWorkingDirectory)/bin/Packages/$(BuildConfiguration)/NuGet" + displayName: Publish Software Bill of Materials + - task: Ref12Analyze@0 displayName: Ref12 (Codex) Analyze inputs: diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index bac667b65..3fca09995 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -45,6 +45,7 @@ stages: push_to_ci: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} + Packaging.EnableSBOMSigning: true jobs: - template: build.yml From d581062a43eafc81b1320c18656d2d1eb9519ca2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jan 2022 16:06:27 -0700 Subject: [PATCH 0378/1753] Retain inserted builds for two years --- azure-pipelines/vs-insertion.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 6aef78894..9f09b8ef9 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -49,3 +49,12 @@ stages: AutoCompleteMergeStrategy: Squash - task: MicroBuildCleanup@1 displayName: Send Telemetry + - powershell: | + $contentType = 'application/json'; + $headers = @{ Authorization = 'Bearer $(System.AccessToken)' }; + $rawRequest = @{ daysValid = 365 * 2; definitionId = $(resources.pipeline.CI.pipelineID); ownerId = 'User:$(Build.RequestedForId)'; protectPipeline = $false; runId = $(resources.pipeline.CI.runId) }; + $request = ConvertTo-Json @($rawRequest); + Write-Host $request + $uri = "$(System.CollectionUri)$(System.TeamProject)/_apis/build/retention/leases?api-version=6.0-preview.1"; + Invoke-RestMethod -uri $uri -method POST -Headers $headers -ContentType $contentType -Body $request; + displayName: Retain inserted builds From d2aa6efa1e59faa9a36e6eec093ced72fe62e8b1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Jan 2022 08:01:13 -0700 Subject: [PATCH 0379/1753] Fix symbol archival step Symbol archival was failing when InsertConfigValues.ps1 was running from a downloaded artifact, but it is only designed to run within the repo. It failed within the repo because VSInsertion.ps1 started returning an empty set of files due to the recent SBOM change in 6235412: Build SBOM manifest as part of build The fix is to give the scripts a way to communicate that the SBOM is not relevant so that InsertConfigValues can still run when required. --- azure-pipelines/artifacts/VSInsertion.ps1 | 10 +++++++++- azure-pipelines/release-deployment-prep.yml | 2 +- azure-pipelines/variables/InsertConfigValues.ps1 | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 80e621e74..4c56deabe 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -1,5 +1,13 @@ # This artifact captures everything needed to insert into VS (NuGet packages, insertion metadata, etc.) +<# +.PARAMETER SbomNotRequired + Indicates that returning the artifacts available is preferable to nothing at all when the SBOM has not yet been generated. +#> +Param ( + [switch]$SbomNotRequired +) + $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") $BuildConfiguration = $env:BUILDCONFIGURATION if (!$BuildConfiguration) { @@ -9,7 +17,7 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" # This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $PackagesRoot/_manifest)) { return @{} } +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $PackagesRoot/_manifest) -and -not $SbomNotRequired) { return @{} } if (!(Test-Path $PackagesRoot)) { return @{} } diff --git a/azure-pipelines/release-deployment-prep.yml b/azure-pipelines/release-deployment-prep.yml index 6dee28e5a..059fd1d0a 100644 --- a/azure-pipelines/release-deployment-prep.yml +++ b/azure-pipelines/release-deployment-prep.yml @@ -3,7 +3,7 @@ steps: artifact: Variables-Windows displayName: Download Variables-Windows artifact - task: PowerShell@2 - displayName: Set VSTS variables based on artifacts + displayName: Set pipeline variables based on artifacts inputs: targetType: filePath filePath: $(Pipeline.Workspace)/CI/Variables-Windows/_pipelines.ps1 diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index ddc472ebf..efed018c7 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -1,4 +1,4 @@ -$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1" -SbomNotRequired) $icv=@() foreach ($kvp in $InsertedPkgs.GetEnumerator()) { From c01e120589f2d9642b78335c219f65540aad7adb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Feb 2022 08:24:29 -0700 Subject: [PATCH 0380/1753] Bump coverlet.msbuild from 3.1.0 to 3.1.1 (#134) Bumps [coverlet.msbuild](https://github.com/coverlet-coverage/coverlet) from 3.1.0 to 3.1.1. - [Release notes](https://github.com/coverlet-coverage/coverlet/releases) - [Commits](https://github.com/coverlet-coverage/coverlet/commits) --- updated-dependencies: - dependency-name: coverlet.msbuild dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index ebd5df8ff..b3fc51f0a 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From 88988319bebd9cdd5390de9f79e1000d34a24e88 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 1 Feb 2022 10:20:25 -0700 Subject: [PATCH 0381/1753] Update StyleCop.Analyzers Switch to the .Unstable package ID so that dependabot will help us keep it current even though it seems to be ever-unstable lately. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 3b2b143bb..f913d080b 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -37,7 +37,7 @@ - + From ad7449bd60ea86c89861957843a7293d3b4a8e56 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 1 Feb 2022 10:52:26 -0700 Subject: [PATCH 0382/1753] Update sample test, which was sporting dead code --- test/Library.Tests/CalculatorTests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/CalculatorTests.cs b/test/Library.Tests/CalculatorTests.cs index 44e89aaa4..042e7d940 100644 --- a/test/Library.Tests/CalculatorTests.cs +++ b/test/Library.Tests/CalculatorTests.cs @@ -14,7 +14,7 @@ public CalculatorTests() public void AddOrSubtract() { // This tests aggregation of code coverage across test runs. -#if NETCOREAPP2_1 +#if NETCOREAPP3_1 Assert.Equal(3, Calculator.Add(1, 2)); #else Assert.Equal(-1, Calculator.Subtract(1, 2)); From 8ef6d0681b469e121d77080262383498fb22f96c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 2 Feb 2022 20:47:23 -0700 Subject: [PATCH 0383/1753] Update Nerdbank.GitVersioning --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index f913d080b..e6f1f4ad5 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -35,7 +35,7 @@ - + From ae5e025248ae617c174e42fe5d934b07890f34e3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 2 Feb 2022 20:50:26 -0700 Subject: [PATCH 0384/1753] Add explanatory comment for using unstable stylecop id --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index e6f1f4ad5..a8f35b37b 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -37,6 +37,7 @@ + From d043d36952bfd1e79428ca0657a98ff38b7813a2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 2 Feb 2022 21:50:53 -0700 Subject: [PATCH 0385/1753] Update MicroBuild version --- Directory.Build.props | 2 +- init.ps1 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 65219a6f9..aef458c18 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -28,7 +28,7 @@ true snupkg - 2.0.66 + 2.0.68 diff --git a/init.ps1 b/init.ps1 index 043d45514..0a7e1cbd3 100755 --- a/init.ps1 +++ b/init.ps1 @@ -114,7 +114,7 @@ try { if ($Setup) { Write-Host "Installing MicroBuild SwixBuild plugin..." -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath MicroBuild.Plugins.SwixBuild -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $InstallNuGetPkgScriptPath Microsoft.VisualStudioEng.MicroBuild.Plugins.SwixBuild -source $MicroBuildPackageSource -Verbosity $nugetVerbosity } if ($OptProf) { From dcf939351c44b76905308cb5dbc85bb385e48f92 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 09:33:45 -0700 Subject: [PATCH 0386/1753] Capture netcoreapp3.1 TFM test crash dump naming pattern on linux --- azure-pipelines/artifacts/testResults.ps1 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index 862155da7..2f894c97b 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -3,7 +3,9 @@ $result = @{} if ($env:AGENT_TEMPDIRECTORY) { # The DotNetCoreCLI uses an alternate location to publish these files $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' - $result[$env:AGENT_TEMPDIRECTORY] = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse }); + $result[$env:AGENT_TEMPDIRECTORY] = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { + Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\*_crashdump.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse + }); } else { $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" From 4a85ff84c82c79b9d800eadaa3a99c83b0e5ce3d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 09:12:58 -0700 Subject: [PATCH 0387/1753] Replace runsettings files with switches --- .github/workflows/Linux.runsettings | 12 ------------ .github/workflows/Windows.runsettings | 12 ------------ .github/workflows/build.yml | 2 +- .github/workflows/macOS.runsettings | 12 ------------ azure-pipelines/Darwin.runsettings | 12 ------------ azure-pipelines/Linux.runsettings | 12 ------------ azure-pipelines/Windows_NT.runsettings | 12 ------------ azure-pipelines/dotnet.yml | 6 +++--- 8 files changed, 4 insertions(+), 76 deletions(-) delete mode 100644 .github/workflows/Linux.runsettings delete mode 100644 .github/workflows/Windows.runsettings delete mode 100644 .github/workflows/macOS.runsettings delete mode 100644 azure-pipelines/Darwin.runsettings delete mode 100644 azure-pipelines/Linux.runsettings delete mode 100644 azure-pipelines/Windows_NT.runsettings diff --git a/.github/workflows/Linux.runsettings b/.github/workflows/Linux.runsettings deleted file mode 100644 index db20611f1..000000000 --- a/.github/workflows/Linux.runsettings +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/.github/workflows/Windows.runsettings b/.github/workflows/Windows.runsettings deleted file mode 100644 index db20611f1..000000000 --- a/.github/workflows/Windows.runsettings +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b8499b90c..ba968ab8d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,7 +43,7 @@ jobs: - name: pack run: dotnet pack --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" - name: test - run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --settings "${{ github.workspace }}/.github/workflows/${{ runner.os }}.runsettings" + run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --blame-hang-timeout 30s --blame-crash" - name: Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh diff --git a/.github/workflows/macOS.runsettings b/.github/workflows/macOS.runsettings deleted file mode 100644 index db20611f1..000000000 --- a/.github/workflows/macOS.runsettings +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/azure-pipelines/Darwin.runsettings b/azure-pipelines/Darwin.runsettings deleted file mode 100644 index db20611f1..000000000 --- a/azure-pipelines/Darwin.runsettings +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/azure-pipelines/Linux.runsettings b/azure-pipelines/Linux.runsettings deleted file mode 100644 index db20611f1..000000000 --- a/azure-pipelines/Linux.runsettings +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/azure-pipelines/Windows_NT.runsettings b/azure-pipelines/Windows_NT.runsettings deleted file mode 100644 index db20611f1..000000000 --- a/azure-pipelines/Windows_NT.runsettings +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 70cd23ee0..506eb6450 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -10,7 +10,7 @@ steps: displayName: dotnet test -f net472 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net472.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net472.txt" + arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --blame-hang-timeout 30s --blame-crash /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net472.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net472.txt;TraceLevel=info" testRunTitle: net472-$(Agent.JobName) condition: succeededOrFailed() @@ -18,7 +18,7 @@ steps: displayName: dotnet test -f netcoreapp3.1 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp3.1.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/netcoreapp3.1.txt" + arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --blame-hang-timeout 30s --blame-crash /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp3.1.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/netcoreapp3.1.txt;TraceLevel=info" testRunTitle: netcoreapp3.1-$(Agent.JobName) condition: succeededOrFailed() @@ -26,7 +26,7 @@ steps: displayName: dotnet test -f net5.0 inputs: command: test - arguments: --no-build -c $(BuildConfiguration) -f net5.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net5.0.txt" + arguments: --no-build -c $(BuildConfiguration) -f net5.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --blame-hang-timeout 30s --blame-crash /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net5.0.txt;TraceLevel=info" testRunTitle: net5.0-$(Agent.JobName) condition: succeededOrFailed() From 9fb050e9d04dc1eb1a0257c239fc557637d74efc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 12:32:40 -0700 Subject: [PATCH 0388/1753] Fix GitHub workflow file syntax error (#137) --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ba968ab8d..3be177466 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,7 +43,7 @@ jobs: - name: pack run: dotnet pack --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" - name: test - run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --blame-hang-timeout 30s --blame-crash" + run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --blame-hang-timeout 30s --blame-crash - name: Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh From da8eef4ed65b12c824b3b2782a4c503fe1b68a4c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 12:39:56 -0700 Subject: [PATCH 0389/1753] Build and pack in one step --- .github/workflows/build.yml | 4 +--- azure-pipelines/dotnet.yml | 5 +---- 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3be177466..574cf5242 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -39,9 +39,7 @@ jobs: run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - name: build - run: dotnet build --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/build.binlog" - - name: pack - run: dotnet pack --no-build -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/pack.binlog" + run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/build.binlog" - name: test run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --blame-hang-timeout 30s --blame-crash - name: Update pipeline variables based on build outputs diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 506eb6450..d7469c643 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,11 +1,8 @@ steps: -- script: dotnet build --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" +- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build -- script: dotnet pack --no-build -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/pack.binlog" - displayName: dotnet pack - - task: DotNetCoreCLI@2 displayName: dotnet test -f net472 inputs: From 1699ddf88159c2fc54a8488592df939fb3708398 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 09:59:54 -0700 Subject: [PATCH 0390/1753] Replace several `DotNetCoreCLI` task with one `dotnet test` task Closes #136 --- .../Get-ArtifactsStagingDirectory.ps1 | 13 +++++++ azure-pipelines/artifacts/_stage_all.ps1 | 9 +---- azure-pipelines/dotnet-test-cloud.ps1 | 37 +++++++++++++++++++ azure-pipelines/dotnet.yml | 25 +------------ 4 files changed, 53 insertions(+), 31 deletions(-) create mode 100644 azure-pipelines/Get-ArtifactsStagingDirectory.ps1 create mode 100644 azure-pipelines/dotnet-test-cloud.ps1 diff --git a/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 b/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 new file mode 100644 index 000000000..d96b16107 --- /dev/null +++ b/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 @@ -0,0 +1,13 @@ +Param( + [switch]$CleanIfLocal +) +if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { + $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY +} else { + $ArtifactStagingFolder = Join-Path (Resolve-Path $PSScriptRoot/..) (Join-Path obj _artifacts) + if ($CleanIfLocal -and (Test-Path $ArtifactStagingFolder)) { + Remove-Item $ArtifactStagingFolder -Recurse -Force + } +} + +$ArtifactStagingFolder diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index 4788a3f5b..af398a2e6 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -7,14 +7,7 @@ param ( ) $RepoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot (Join-Path .. ..))) -if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { - $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY -} else { - $ArtifactStagingFolder = Join-Path $RepoRoot (Join-Path obj _artifacts) - if (Test-Path $ArtifactStagingFolder) { - Remove-Item $ArtifactStagingFolder -Recurse -Force - } -} +$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal function Create-SymbolicLink { param ( diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 new file mode 100644 index 000000000..c8642453d --- /dev/null +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -0,0 +1,37 @@ +Param( + [string]$Configuration='Debug', + [string]$Agent='Local', + [switch]$PublishResults +) + +$RepoRoot = Resolve-Path (Join-Path $PSScriptRoot '..') +$ArtifactStagingFolder = & "$PSScriptRoot/Get-ArtifactsStagingDirectory.ps1" + +dotnet test $RepoRoot ` + --no-build ` + -c $Configuration ` + --filter "TestCategory!=FailsInCloudTest" ` + -p:CollectCoverage=true ` + --blame-hang-timeout 30s ` + --blame-crash ` + -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` + --diag "$ArtifactStagingFolder/test_logs/diag.log;TraceLevel=info" ` + --logger trx + +$unknownCounter = 0 +Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { + Copy-Item $_ -Destination $ArtifactStagingFolder/test_logs/ + + if ($PublishResults) { + $x = [xml](Get-Content -Path $_) + $storage = $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')[0].storage -replace '\\','/' + if ($storage -match '/(?[^/]+)/(?[^/]+)\.dll$') { + $runTitle = "$($matches.lib) ($($matches.tfm), $Agent)" + } else { + $unknownCounter += 1; + $runTitle = "unknown$unknownCounter ($Agent)"; + } + + Write-Host "##vso[results.publish type=VSTest;runTitle=$runTitle;publishRunAttachments=true;resultFiles=$_;failTaskOnFailedTests=true;testRunSystem=VSTS - PTR;]" + } +} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index d7469c643..2d2d70272 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -3,29 +3,8 @@ steps: - script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build -- task: DotNetCoreCLI@2 - displayName: dotnet test -f net472 - inputs: - command: test - arguments: --no-build -c $(BuildConfiguration) -f net472 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --blame-hang-timeout 30s --blame-crash /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net472.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net472.txt;TraceLevel=info" - testRunTitle: net472-$(Agent.JobName) - condition: succeededOrFailed() - -- task: DotNetCoreCLI@2 - displayName: dotnet test -f netcoreapp3.1 - inputs: - command: test - arguments: --no-build -c $(BuildConfiguration) -f netcoreapp3.1 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --blame-hang-timeout 30s --blame-crash /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_netcoreapp3.1.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/netcoreapp3.1.txt;TraceLevel=info" - testRunTitle: netcoreapp3.1-$(Agent.JobName) - condition: succeededOrFailed() - -- task: DotNetCoreCLI@2 - displayName: dotnet test -f net5.0 - inputs: - command: test - arguments: --no-build -c $(BuildConfiguration) -f net5.0 --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --blame-hang-timeout 30s --blame-crash /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0.binlog" --diag "$(Build.ArtifactStagingDirectory)/test_logs/net5.0.txt;TraceLevel=info" - testRunTitle: net5.0-$(Agent.JobName) - condition: succeededOrFailed() +- powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults + displayName: dotnet test - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true From 04f05d67b81aacbdfd9cd5c89c57425a55f2a727 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 13:29:25 -0700 Subject: [PATCH 0391/1753] Drop redundant build verbosity switch --- azure-pipelines/dotnet.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 2d2d70272..86b7eb825 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,6 +1,6 @@ steps: -- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" +- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: dotnet build - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults From 849e4b8e01691f784a9a74385a225ec82c5e8068 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 15:25:48 -0700 Subject: [PATCH 0392/1753] Simplify Join-Path expressions --- azure-pipelines/Get-ArtifactsStagingDirectory.ps1 | 2 +- azure-pipelines/artifacts/Variables.ps1 | 8 ++++---- azure-pipelines/artifacts/_stage_all.ps1 | 3 +-- azure-pipelines/dotnet-test-cloud.ps1 | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 b/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 index d96b16107..723574f52 100644 --- a/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 +++ b/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 @@ -4,7 +4,7 @@ Param( if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY } else { - $ArtifactStagingFolder = Join-Path (Resolve-Path $PSScriptRoot/..) (Join-Path obj _artifacts) + $ArtifactStagingFolder = [System.IO.Path]::GetFullPath("$PSScriptRoot/../obj/_artifacts") if ($CleanIfLocal -and (Test-Path $ArtifactStagingFolder)) { Remove-Item $ArtifactStagingFolder -Recurse -Force } diff --git a/azure-pipelines/artifacts/Variables.ps1 b/azure-pipelines/artifacts/Variables.ps1 index c6330cd38..4bc6d2165 100644 --- a/azure-pipelines/artifacts/Variables.ps1 +++ b/azure-pipelines/artifacts/Variables.ps1 @@ -2,13 +2,13 @@ # It "snaps" the values of these variables where we can compute them during the build, # and otherwise captures the scripts to run later during an Azure Pipelines environment release. -$RepoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot (Join-Path .. ..))) -$ArtifactBasePath = Join-Path $RepoRoot (Join-Path obj _artifacts) +$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot/../..") +$ArtifactBasePath = "$RepoRoot/obj/_artifacts" $VariablesArtifactPath = Join-Path $ArtifactBasePath variables if (-not (Test-Path $VariablesArtifactPath)) { New-Item -ItemType Directory -Path $VariablesArtifactPath | Out-Null } # Copy variables, either by value if the value is calculable now, or by script -Get-ChildItem -Path (Join-Path $PSScriptRoot (Join-Path .. variables)) |% { +Get-ChildItem "$PSScriptRoot/../variables" |% { $value = $null if (-not $_.BaseName.StartsWith('_')) { # Skip trying to interpret special scripts # First check the environment variables in case the variable was set in a queued build @@ -35,7 +35,7 @@ Get-ChildItem -Path (Join-Path $PSScriptRoot (Join-Path .. variables)) |% { $value = Get-Content -Path $_.FullName } - Set-Content -Path (Join-Path $VariablesArtifactPath $_.Name) -Value $value + Set-Content -Path "$VariablesArtifactPath/$($_.Name)" -Value $value } @{ diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index af398a2e6..87421d56a 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -6,7 +6,6 @@ param ( [string]$ArtifactNameSuffix ) -$RepoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot (Join-Path .. ..))) $ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal function Create-SymbolicLink { @@ -33,7 +32,7 @@ function Create-SymbolicLink { # Stage all artifacts $Artifacts = & "$PSScriptRoot\_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix $Artifacts |% { - $DestinationFolder = (Join-Path (Join-Path $ArtifactStagingFolder "$($_.ArtifactName)$ArtifactNameSuffix") $_.ContainerFolder).TrimEnd('\') + $DestinationFolder = [System.IO.Path]::GetFullPath("$ArtifactStagingFolder/$($_.ArtifactName)$ArtifactNameSuffix/$($_.ContainerFolder)").TrimEnd('\') $Name = "$(Split-Path $_.Source -Leaf)" #Write-Host "$($_.Source) -> $($_.ArtifactName)\$($_.ContainerFolder)" -ForegroundColor Yellow diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index c8642453d..a7a63a02b 100644 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -4,7 +4,7 @@ Param( [switch]$PublishResults ) -$RepoRoot = Resolve-Path (Join-Path $PSScriptRoot '..') +$RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path $ArtifactStagingFolder = & "$PSScriptRoot/Get-ArtifactsStagingDirectory.ps1" dotnet test $RepoRoot ` From e9df7075913bfea945429fa29f1322c2fcdc6e30 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 16:11:09 -0700 Subject: [PATCH 0393/1753] Collect and publish symbols from every build agent Accommodates https://github.com/microsoft/azure-pipelines-tasks/issues/13821 by publish symbols on a Windows agent Closes #135 --- azure-pipelines/Convert-PDB.ps1 | 43 ---------------- azure-pipelines/Get-SymbolFiles.ps1 | 20 ++------ azure-pipelines/artifacts/symbols.ps1 | 1 + azure-pipelines/artifacts/test_symbols.ps1 | 9 +--- azure-pipelines/build.yml | 6 ++- azure-pipelines/dotnet.yml | 18 ------- azure-pipelines/publish-symbols.yml | 59 ++++++++++++++++++++++ 7 files changed, 70 insertions(+), 86 deletions(-) delete mode 100644 azure-pipelines/Convert-PDB.ps1 create mode 100644 azure-pipelines/publish-symbols.yml diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 deleted file mode 100644 index 2d394e72d..000000000 --- a/azure-pipelines/Convert-PDB.ps1 +++ /dev/null @@ -1,43 +0,0 @@ -<# -.SYNOPSIS - Converts between Windows PDB and Portable PDB formats. -.PARAMETER DllPath - The path to the DLL whose PDB is to be converted. -.PARAMETER PdbPath - The path to the PDB to convert. May be omitted if the DLL was compiled on this machine and the PDB is still at its original path. -.PARAMETER OutputPath - The path of the output PDB to write. -#> -#Function Convert-PortableToWindowsPDB() { - Param( - [Parameter(Mandatory=$true,Position=0)] - [string]$DllPath, - [Parameter()] - [string]$PdbPath, - [Parameter(Mandatory=$true,Position=1)] - [string]$OutputPath - ) - - if ($IsMacOS -or $IsLinux) { - Write-Error "This script only works on Windows" - return - } - - $version = '1.1.0-beta2-21101-01' - $baseDir = "$PSScriptRoot/../obj/tools" - $pdb2pdbpath = "$baseDir/Microsoft.DiaSymReader.Pdb2Pdb.$version/tools/Pdb2Pdb.exe" - if (-not (Test-Path $pdb2pdbpath)) { - if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } - $baseDir = (Resolve-Path $baseDir).Path # Normalize it - Write-Verbose "& (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null" - & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null - } - - $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' - if ($PdbPath) { - $args += '/pdb',$PdbPath - } - - Write-Verbose "$pdb2pdbpath $args" - & $pdb2pdbpath $args -#} diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index 45afe7c2a..d4c5289ae 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -1,10 +1,10 @@ <# .SYNOPSIS - Collect the list of PDBs built in this repo, after converting them from portable to Windows PDBs. + Collect the list of PDBs built in this repo. .PARAMETER Path - The root path to recursively search for PDBs. + The directory to recursively search for PDBs. .PARAMETER Tests - A switch indicating to find test-related PDBs instead of product-only PDBs. + A switch indicating to find PDBs only for test binaries instead of only for shipping shipping binaries. #> [CmdletBinding()] param ( @@ -53,17 +53,5 @@ $PDBs |% { } Write-Output $BinaryImagePath - - if (-not ($IsMacOS -or $IsLinux)) { - # Convert the PDB to legacy Windows PDBs - Write-Host "Converting PDB for $_" -ForegroundColor DarkGray - $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" - if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } - & "$PSScriptRoot\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath "$WindowsPdbDir\$($_.BaseName).pdb" - if ($LASTEXITCODE -ne 0) { - Write-Warning "PDB conversion of `"$_`" failed." - } - - Write-Output "$WindowsPdbDir\$($_.BaseName).pdb" - } + Write-Output $_.FullName } diff --git a/azure-pipelines/artifacts/symbols.ps1 b/azure-pipelines/artifacts/symbols.ps1 index 8704571ec..9e2c7bd5b 100644 --- a/azure-pipelines/artifacts/symbols.ps1 +++ b/azure-pipelines/artifacts/symbols.ps1 @@ -1,4 +1,5 @@ $BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../bin") +if (!(Test-Path $BinPath)) { return } $symbolfiles = & "$PSScriptRoot/../Get-SymbolFiles.ps1" -Path $BinPath | Get-Unique @{ diff --git a/azure-pipelines/artifacts/test_symbols.ps1 b/azure-pipelines/artifacts/test_symbols.ps1 index d65ad0ae5..ce2b6481c 100644 --- a/azure-pipelines/artifacts/test_symbols.ps1 +++ b/azure-pipelines/artifacts/test_symbols.ps1 @@ -1,11 +1,6 @@ -# This doesn't work off Windows, nor do we need to convert symbols on multiple OS agents -if ($IsMacOS -or $IsLinux) { - return; -} - -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../bin") if (!(Test-Path $BinPath)) { return } -$symbolfiles = & "$PSScriptRoot\..\Get-SymbolFiles.ps1" -Path $BinPath -Tests | Get-Unique +$symbolfiles = & "$PSScriptRoot/../Get-SymbolFiles.ps1" -Path $BinPath -Tests | Get-Unique @{ "$BinPath" = $SymbolFiles; diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 796be61d6..f779fd12c 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -45,8 +45,7 @@ jobs: - Windows - Linux - macOS - pool: - vmImage: Ubuntu 20.04 + pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). condition: succeededOrFailed() steps: - checkout: self @@ -54,6 +53,9 @@ jobs: - template: install-dependencies.yml parameters: initArgs: -NoRestore + - template: publish-symbols.yml + parameters: + includeMacOS: ${{ parameters.includeMacOS }} - template: publish-codecoverage.yml parameters: includeMacOS: ${{ parameters.includeMacOS }} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 86b7eb825..a103adfd3 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -16,24 +16,6 @@ steps: displayName: Publish artifacts condition: succeededOrFailed() -- task: PublishSymbols@2 - inputs: - SymbolsFolder: $(Build.ArtifactStagingDirectory)/symbols-$(Agent.JobName) - SearchPattern: '**/*.pdb' - IndexSources: false - SymbolServerType: TeamServices - displayName: Publish symbols to symbol server - condition: eq(variables['Agent.OS'], 'Windows_NT') # Execute on failed test runs too. Windows-only till https://github.com/microsoft/azure-pipelines-tasks/issues/13821 is fixed. - -- task: PublishSymbols@2 - inputs: - SymbolsFolder: $(Build.ArtifactStagingDirectory)/test_symbols-$(Agent.JobName) - SearchPattern: '**/*.pdb' - IndexSources: false - SymbolServerType: TeamServices - displayName: Publish test symbols to symbol server - condition: and(failed(), eq(variables['Agent.OS'], 'Windows_NT')) # Execute on failed test runs only. - - bash: bash <(curl -s https://codecov.io/bash) displayName: Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') diff --git a/azure-pipelines/publish-symbols.yml b/azure-pipelines/publish-symbols.yml new file mode 100644 index 000000000..c45eff020 --- /dev/null +++ b/azure-pipelines/publish-symbols.yml @@ -0,0 +1,59 @@ +parameters: + includeMacOS: + +steps: +- task: DownloadPipelineArtifact@2 + inputs: + artifact: symbols-Windows + path: $(Pipeline.Workspace)/symbols/Windows + displayName: Download Windows symbols + continueOnError: true +- task: DownloadPipelineArtifact@2 + inputs: + artifact: symbols-Linux + path: $(Pipeline.Workspace)/symbols/Linux + displayName: Download Linux symbols + continueOnError: true +- task: DownloadPipelineArtifact@2 + inputs: + artifact: symbols-macOS + path: $(Pipeline.Workspace)/symbols/macOS + displayName: Download macOS symbols + continueOnError: true + condition: ${{ parameters.includeMacOS }} + +- task: DownloadPipelineArtifact@2 + inputs: + artifact: test_symbols-Windows + path: $(Pipeline.Workspace)/test_symbols/Windows + displayName: Download Windows test symbols + continueOnError: true +- task: DownloadPipelineArtifact@2 + inputs: + artifact: test_symbols-Linux + path: $(Pipeline.Workspace)/test_symbols/Linux + displayName: Download Linux test symbols + continueOnError: true +- task: DownloadPipelineArtifact@2 + inputs: + artifact: test_symbols-macOS + path: $(Pipeline.Workspace)/test_symbols/macOS + displayName: Download macOS test symbols + continueOnError: true + condition: ${{ parameters.includeMacOS }} + +- task: PublishSymbols@2 + inputs: + SymbolsFolder: $(Pipeline.Workspace)/symbols + SearchPattern: '**/*.pdb' + IndexSources: false + SymbolServerType: TeamServices + displayName: Publish symbols + +- task: PublishSymbols@2 + inputs: + SymbolsFolder: $(Pipeline.Workspace)/test_symbols + SearchPattern: '**/*.pdb' + IndexSources: false + SymbolServerType: TeamServices + displayName: Publish test symbols From 6ecd99be42bc60e4bb359e84e9ec12dadc863403 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 16:20:49 -0700 Subject: [PATCH 0394/1753] Do not include product symbols with test symbols --- azure-pipelines/Get-SymbolFiles.ps1 | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index d4c5289ae..fccb1bb13 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -13,19 +13,12 @@ param ( [switch]$Tests ) -$WindowsPdbSubDirName = "symstore" - $ActivityName = "Collecting symbols from $Path" Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" -$PDBs = Get-ChildItem -rec "$Path/*.pdb" |? { $_.FullName -notmatch "\W$WindowsPdbSubDirName\W" } +$PDBs = Get-ChildItem -rec "$Path/*.pdb" # Filter PDBs to product OR test related. $testregex = "unittest|tests" -if ($Tests) { - $PDBs = $PDBs |? { $_.FullName -match $testregex } -} else { - $PDBs = $PDBs |? { $_.FullName -notmatch $testregex } -} Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" $PDBsByHash = @{} @@ -42,6 +35,12 @@ $PDBs |% { $PDBsByHash.Add($_.Hash, $_.FullName) Write-Output $_ } +} |? { + if ($Tests) { + $_.FullName -match $testregex + } else { + $_.FullName -notmatch $testregex + } } |% { # Collect the DLLs/EXEs as well. $dllPath = "$($_.Directory)/$($_.BaseName).dll" From e67a6e4b39d1625ebcea0dcf89f34c458984e1d4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Feb 2022 17:38:54 -0700 Subject: [PATCH 0395/1753] Update GitHub Actions to more closely resemble AzP --- .github/workflows/build.yml | 31 +++++++++++++------ .../Get-ArtifactsStagingDirectory.ps1 | 2 ++ azure-pipelines/artifacts/build_logs.ps1 | 11 ++----- azure-pipelines/dotnet-test-cloud.ps1 | 2 ++ 4 files changed, 29 insertions(+), 17 deletions(-) mode change 100644 => 100755 azure-pipelines/dotnet-test-cloud.ps1 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 574cf5242..18ae3e289 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,14 +34,20 @@ jobs: run: | ./init.ps1 -UpgradePrerequisites dotnet --info + + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } shell: pwsh - name: Set pipeline variables based on source run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - name: build - run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"bin/build_logs/build.binlog" + run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - name: test - run: dotnet test --no-build -c ${{ env.BUILDCONFIGURATION }} /bl:"bin/build_logs/test.binlog" --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --logger trx --blame-hang-timeout 30s --blame-crash + run: azure-pipelines/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} + shell: pwsh - name: Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh @@ -54,46 +60,53 @@ jobs: uses: actions/upload-artifact@v1 with: name: projectAssetsJson-${{ runner.os }} - path: obj/_artifacts/projectAssetsJson + path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: Upload variables uses: actions/upload-artifact@v1 with: name: variables-${{ runner.os }} - path: obj/_artifacts/variables + path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: Upload build_logs if: always() uses: actions/upload-artifact@v1 with: name: build_logs-${{ runner.os }} - path: obj/_artifacts/build_logs + path: ${{ runner.temp }}/_artifacts/build_logs + continue-on-error: true + - name: Upload test_logs + if: always() + uses: actions/upload-artifact@v1 + with: + name: test_logs-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/test_logs continue-on-error: true - name: Upload testResults if: always() uses: actions/upload-artifact@v1 with: name: testResults-${{ runner.os }} - path: obj/_artifacts/testResults + path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: Upload coverageResults if: always() uses: actions/upload-artifact@v1 with: name: coverageResults-${{ runner.os }} - path: obj/_artifacts/coverageResults + path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: Upload symbols uses: actions/upload-artifact@v1 with: name: symbols-${{ runner.os }} - path: obj/_artifacts/symbols + path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: Upload deployables uses: actions/upload-artifact@v1 with: name: deployables-${{ runner.os }} - path: obj/_artifacts/deployables + path: ${{ runner.temp }}/_artifacts/deployables if: always() - name: Publish code coverage results to codecov.io run: bash <(curl -s https://codecov.io/bash) diff --git a/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 b/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 index 723574f52..391e5713a 100644 --- a/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 +++ b/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 @@ -3,6 +3,8 @@ Param( ) if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY +} elseif ($env:RUNNER_TEMP) { + $ArtifactStagingFolder = "$env:RUNNER_TEMP\_artifacts" } else { $ArtifactStagingFolder = [System.IO.Path]::GetFullPath("$PSScriptRoot/../obj/_artifacts") if ($CleanIfLocal -and (Test-Path $ArtifactStagingFolder)) { diff --git a/azure-pipelines/artifacts/build_logs.ps1 b/azure-pipelines/artifacts/build_logs.ps1 index b55ba48f3..f05358e03 100644 --- a/azure-pipelines/artifacts/build_logs.ps1 +++ b/azure-pipelines/artifacts/build_logs.ps1 @@ -1,12 +1,7 @@ -if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { - $artifactsRoot = $env:BUILD_ARTIFACTSTAGINGDIRECTORY -} else { - $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") - $artifactsRoot = "$RepoRoot\bin" -} +$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" -if (!(Test-Path $artifactsRoot/build_logs)) { return } +if (!(Test-Path $ArtifactStagingFolder/build_logs)) { return } @{ - "$artifactsRoot/build_logs" = (Get-ChildItem -Recurse "$artifactsRoot/build_logs") + "$ArtifactStagingFolder/build_logs" = (Get-ChildItem -Recurse "$ArtifactStagingFolder/build_logs") } diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 old mode 100644 new mode 100755 index a7a63a02b..440bd8909 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -1,3 +1,5 @@ +#!/usr/bin/env pwsh + Param( [string]$Configuration='Debug', [string]$Agent='Local', From 17cfe3aef9d38f1aa9dc642a3e1c209253be44c7 Mon Sep 17 00:00:00 2001 From: n9 Date: Tue, 8 Feb 2022 21:00:09 +0100 Subject: [PATCH 0396/1753] change: AsyncQueue.ToArray() made public + some tests (#986) --- src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs | 2 +- .../net472/PublicAPI.Unshipped.txt | 1 + .../netcoreapp3.1/PublicAPI.Unshipped.txt | 1 + .../netstandard2.0/PublicAPI.Unshipped.txt | 1 + test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs | 3 +++ 5 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs index fea615b3f..53dd5914b 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs @@ -324,7 +324,7 @@ public bool TryDequeue([MaybeNullWhen(false)] out T value) /// /// Returns a copy of this queue as an array. /// - internal T[] ToArray() + public T[] ToArray() { lock (this.SyncRoot) { diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index e85d3c718..ffcf5d4cb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,3 +1,4 @@ +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt index e85d3c718..ffcf5d4cb 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt @@ -1,3 +1,4 @@ +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index e85d3c718..ffcf5d4cb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,3 +1,4 @@ +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs index a039a09eb..f4a61f9a2 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs @@ -25,6 +25,7 @@ public void JustInitialized() Assert.Equal(0, this.queue.Count); Assert.True(this.queue.IsEmpty); Assert.False(this.queue.Completion.IsCompleted); + Assert.Empty(this.queue.ToArray()); } [Fact] @@ -34,6 +35,7 @@ public void Enqueue() this.queue.Enqueue(value); Assert.Equal(1, this.queue.Count); Assert.False(this.queue.IsEmpty); + Assert.Single(this.queue.ToArray()); } [Fact] @@ -43,6 +45,7 @@ public void TryEnqueue() Assert.True(this.queue.TryEnqueue(value)); Assert.Equal(1, this.queue.Count); Assert.False(this.queue.IsEmpty); + Assert.Single(this.queue.ToArray()); } [Fact] From 8a837f711324dce3d66570271c9cc3a62dc8e2d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 17 Feb 2022 09:09:17 -0700 Subject: [PATCH 0397/1753] Activate msbuild 17's platform negotiation feature Not that this template repo itself requires it, but it's a great baseline to start with as it means the repo will grow nicely as it gets more complicated for real projects. --- Directory.Build.props | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index a8f35b37b..935550c9e 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -13,6 +13,10 @@ true true + + true + true + $(MSBuildThisFileDirectory) @@ -35,7 +39,7 @@ - + From e261c40938f2a1190824fbec4c7c020292f5f5b3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 17 Feb 2022 09:58:44 -0700 Subject: [PATCH 0398/1753] Switch to EO-compliant agent pools --- azure-pipelines/release.yml | 6 ++++-- azure-pipelines/vs-insertion.yml | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 0ef91cb3a..1470f765d 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -15,7 +15,8 @@ stages: jobs: - deployment: create pool: - vmImage: ubuntu-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesUbuntu20.04compliant environment: No-Approval strategy: runOnce: @@ -49,7 +50,8 @@ stages: jobs: - deployment: push pool: - vmImage: ubuntu-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesUbuntu20.04compliant environment: No-Approval strategy: runOnce: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 9f09b8ef9..8c5b1aa93 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -18,7 +18,8 @@ stages: jobs: - deployment: insertion pool: - vmImage: windows-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesWindows2022compliant environment: No-Approval strategy: runOnce: From 77dbafa8da305334849bc693b863b33ce968cf14 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 17 Feb 2022 10:18:44 -0700 Subject: [PATCH 0399/1753] Switch to EO-compliant agent pools --- azure-pipelines/OptProf.yml | 3 ++- azure-pipelines/official.yml | 3 ++- azure-pipelines/release.yml | 6 ++++-- azure-pipelines/vs-insertion.yml | 3 ++- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 6c7befb85..5d72a2745 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -50,7 +50,8 @@ stages: jobs: - job: QueueOptProf pool: - vmImage: windows-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesWindows2022compliant variables: InsertPayloadName: vs-threading InsertTopicBranch: team/VS-IDE/vs-threading-OptProf-run-$(Build.BuildId) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 2e2b83508..f49cf5301 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -98,7 +98,8 @@ stages: jobs: - deployment: push pool: - vmImage: ubuntu-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesUbuntu20.04compliant environment: No-Approval strategy: runOnce: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 46fb6c0e0..ef331fb61 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -15,7 +15,8 @@ stages: jobs: - deployment: create pool: - vmImage: ubuntu-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesUbuntu20.04compliant environment: No-Approval strategy: runOnce: @@ -53,7 +54,8 @@ stages: jobs: - deployment: push pool: - vmImage: ubuntu-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesUbuntu20.04compliant environment: No-Approval strategy: runOnce: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 6fa9f0423..88a1c227a 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -18,7 +18,8 @@ stages: jobs: - deployment: insertion pool: - vmImage: windows-latest + name: AzurePipelines-EO + vmImage: AzurePipelinesWindows2022compliant environment: No-Approval strategy: runOnce: From 5c80e555077eea402cad588246e98ed64ae35388 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 19 Feb 2022 06:51:34 -0700 Subject: [PATCH 0400/1753] Fix insertion pipeline --- azure-pipelines/vs-insertion.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 88a1c227a..c7166a536 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -17,9 +17,7 @@ stages: displayName: VS insertion jobs: - deployment: insertion - pool: - name: AzurePipelines-EO - vmImage: AzurePipelinesWindows2022compliant + pool: VSEngSS-MicroBuild2022-1ES environment: No-Approval strategy: runOnce: From 7d468a2f3f06c9e7ea86e34dca1eecdfc3e39780 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Feb 2022 07:01:25 -0700 Subject: [PATCH 0401/1753] Fix VS insertion pool --- azure-pipelines/vs-insertion.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 8c5b1aa93..77853a6a6 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -17,9 +17,7 @@ stages: displayName: VS insertion jobs: - deployment: insertion - pool: - name: AzurePipelines-EO - vmImage: AzurePipelinesWindows2022compliant + pool: VSEngSS-MicroBuild2022-1ES environment: No-Approval strategy: runOnce: From f48369ec851ad94936fb50e74cff901fc291e5fb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 2 Mar 2022 14:28:15 -0700 Subject: [PATCH 0402/1753] Add `SynchronizationContext.GetAwaiter` extension method This makes `await someSyncContext;` work as expected. --- .../AwaitExtensions.cs | 79 +++++++++++++++++++ .../net472/PublicAPI.Unshipped.txt | 7 ++ .../netcoreapp3.1/PublicAPI.Unshipped.txt | 7 ++ .../netstandard2.0/PublicAPI.Unshipped.txt | 7 ++ .../AwaitExtensionsTests.cs | 47 +++++++++++ 5 files changed, 147 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index 2fe9910c3..595cde38d 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -31,6 +31,20 @@ public static TaskSchedulerAwaiter GetAwaiter(this TaskScheduler scheduler) return new TaskSchedulerAwaiter(scheduler); } + /// + /// Gets an awaiter that schedules continuations on the specified . + /// + /// The synchronization context used to execute continuations. + /// An awaitable. + /// + /// The awaiter that is returned will always result in yielding, even if already executing within the specified . + /// + public static SynchronizationContextAwaiter GetAwaiter(this SynchronizationContext synchronizationContext) + { + Requires.NotNull(synchronizationContext, nameof(synchronizationContext)); + return new SynchronizationContextAwaiter(synchronizationContext); + } + /// /// Gets an awaitable that schedules continuations on the specified scheduler. /// @@ -442,6 +456,71 @@ public void GetResult() } } + /// + /// An awaiter returned from . + /// + public readonly struct SynchronizationContextAwaiter : ICriticalNotifyCompletion + { + private static readonly SendOrPostCallback SyncContextDelegate = s => ((Action)s!)(); + + /// + /// The context for continuations. + /// + private readonly SynchronizationContext syncContext; + + /// + /// Initializes a new instance of the struct. + /// + /// The context for continuations. + public SynchronizationContextAwaiter(SynchronizationContext syncContext) + { + this.syncContext = syncContext; + } + + /// + /// Gets a value indicating whether no yield is necessary. + /// + /// Always returns . + public bool IsCompleted => false; + + /// + /// Schedules a continuation to execute using the specified . + /// + /// The delegate to invoke. + public void OnCompleted(Action continuation) => this.syncContext.Post(SyncContextDelegate, continuation); + + /// + /// Schedules a continuation to execute using the specified + /// without capturing the . + /// + /// The action. + public void UnsafeOnCompleted(Action continuation) + { +#if NETFRAMEWORK // Only bother suppressing flow on .NET Framework where the perf would improve from doing so. + if (ExecutionContext.IsFlowSuppressed()) + { + this.syncContext.Post(SyncContextDelegate, continuation); + } + else + { + using (ExecutionContext.SuppressFlow()) + { + this.syncContext.Post(SyncContextDelegate, continuation); + } + } +#else + this.syncContext.Post(SyncContextDelegate, continuation); +#endif + } + + /// + /// Does nothing. + /// + public void GetResult() + { + } + } + /// /// An awaitable that will always lead the calling async method to yield, /// then immediately resume, possibly on the original . diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index ffcf5d4cb..7426766cf 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,9 +1,16 @@ Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool Microsoft.VisualStudio.Threading.SemaphoreFaultedException Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt index ffcf5d4cb..7426766cf 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt @@ -1,9 +1,16 @@ Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool Microsoft.VisualStudio.Threading.SemaphoreFaultedException Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index ffcf5d4cb..7426766cf 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,9 +1,16 @@ Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool Microsoft.VisualStudio.Threading.SemaphoreFaultedException Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index c293bc189..660572e55 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -566,6 +566,53 @@ public async Task ConfigureAwaitForAggregateException_InnerCanceledAndFaulted() } } + [Fact] + public void GetAwaiter_SynchronizationContext_ValidatesArgs() + { + Assert.Throws(() => AwaitExtensions.GetAwaiter((SynchronizationContext)null!)); + } + + [Fact] + public async Task SyncContext_Awaiter() + { + TaskCompletionSource syncContextSource = new(); + SingleThreadedSynchronizationContext.Frame frame = new(); + Thread? otherThread = null; + Task otherThreadTask = Task.Run(delegate + { + SingleThreadedSynchronizationContext syncContext; + try + { + syncContext = new(); + otherThread = Thread.CurrentThread; + syncContextSource.SetResult(syncContext); + } + catch (Exception ex) + { + syncContextSource.SetException(ex); + throw; + } + + syncContext.PushFrame(frame); + }); + + try + { + SynchronizationContext context = await syncContextSource.Task; + Assert.NotSame(Thread.CurrentThread, otherThread); + await context; + Assert.Same(Thread.CurrentThread, otherThread); + await Task.Yield(); + Assert.Same(Thread.CurrentThread, otherThread); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.NotSame(Thread.CurrentThread, otherThread); + } + finally + { + frame.Continue = false; + } + } + [SkippableFact] public async Task AwaitRegKeyChange() { From 34b8473bf0307082f8d97817b3fd23f28097b885 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Mar 2022 08:19:19 -0700 Subject: [PATCH 0403/1753] Fix optprof runs --- azure-pipelines/OptProf.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 5d72a2745..3201f263f 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -49,9 +49,7 @@ stages: - stage: QueueVSBuild jobs: - job: QueueOptProf - pool: - name: AzurePipelines-EO - vmImage: AzurePipelinesWindows2022compliant + pool: VSEngSS-MicroBuild2022-1ES variables: InsertPayloadName: vs-threading InsertTopicBranch: team/VS-IDE/vs-threading-OptProf-run-$(Build.BuildId) From a803831c66647bb775cf1febd2117966ad6b801d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 6 Mar 2022 07:12:33 -0700 Subject: [PATCH 0404/1753] Bump Microsoft.NET.Test.Sdk from 17.0.0 to 17.1.0 (#143) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.0.0 to 17.1.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v17.0.0...v17.1.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index b3fc51f0a..e75f6ae8f 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -11,7 +11,7 @@ - + From 25fa06401e58cdd3037106914d3e9febe230f80f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 6 Mar 2022 14:25:10 +0000 Subject: [PATCH 0405/1753] Bump coverlet.msbuild from 3.1.1 to 3.1.2 (#144) --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index e75f6ae8f..077d8d8f9 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From f1581aacb92bda75bce2bd68ed44a698f2bf1884 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 8 Mar 2022 09:02:53 -0700 Subject: [PATCH 0406/1753] Update .NET SDK to 6.0.200 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index e2af429b5..6bfbd1775 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "6.0.100", + "version": "6.0.200", "rollForward": "patch", "allowPrerelease": false } From dab9d490fb609e1917ae8af130146e89247f4bd7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 8 Mar 2022 09:52:51 -0700 Subject: [PATCH 0407/1753] Merge pull request #995 from AArnott/updateDependencies Update dependencies --- .../Microsoft.VisualStudio.Threading.csproj | 2 +- src/SosThreadingTools/SosThreadingTools.csproj | 4 ++-- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 4 ++-- .../Microsoft.VisualStudio.Threading.Tests.csproj | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index ae5b3dcb6..b018d4db6 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -40,7 +40,7 @@ - + diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 3ae573c11..5741b96b2 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -26,8 +26,8 @@ - - + + diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 223a8c2db..955d58b50 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -16,11 +16,11 @@ - + - + diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 6e7a831c3..0d7e5f4ad 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -22,8 +22,8 @@ - - + + From 1fab6662bffc06deb952800d4eb921af0ba5f4b5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 8 Mar 2022 17:13:37 +0000 Subject: [PATCH 0408/1753] Bump Microsoft.VisualStudio.Shell.15.0 (#996) --- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 955d58b50..7da30a2d1 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -20,7 +20,7 @@ - + From cfa18ae4623dae6215f666d02acd2d7cb856a3c6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Mar 2022 17:14:01 -0700 Subject: [PATCH 0409/1753] Re-enable transitive P2Ps Because it isn't actually required for msbuild platform negotiation. --- Directory.Build.props | 1 - 1 file changed, 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 935550c9e..e70a74bb2 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -15,7 +15,6 @@ true - true $(MSBuildThisFileDirectory) From 8a61e11c513a79b1f5ab8f747cc4414dba4946ee Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 9 Mar 2022 18:44:12 -0700 Subject: [PATCH 0410/1753] Delete a remnant of push_to_ci --- azure-pipelines/official.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index a4ae3884e..1c800f3c4 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -42,7 +42,6 @@ stages: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release - push_to_ci: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} Packaging.EnableSBOMSigning: true From b1ab87b9de515d893344d3ecb6399a652cfc41a3 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 21 Mar 2022 22:44:19 -0700 Subject: [PATCH 0411/1753] Prevent creating two task waiting chains when joins AsyncLazy. --- src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index e14eac66e..e1527c100 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -185,7 +185,7 @@ public Task GetValueAsync(CancellationToken cancellationToken) if (!this.value.IsCompleted) { - this.joinableTask?.JoinAsync(cancellationToken).Forget(); + return this.joinableTask?.JoinAsync(cancellationToken) ?? this.value.WithCancellation(cancellationToken); } return this.value.WithCancellation(cancellationToken); From 333fd10c01ce9a1c38cc2e21f0f4403e3669ca94 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 24 Mar 2022 09:02:30 -0600 Subject: [PATCH 0412/1753] AsyncSemaphore fix for deadlock in narrow cancellation race condition This avoids calling `CancellationTokenRegistration.Dispose` while holding a private lock in EnterAsync. There is one remaining case where we may hold a lock while calling it, but that's in the inlined case of EnterAsync and CTR will have its default value, and thus could not have anything to block on. The problematic case that we're fixing is when the token is canceled while EnterAsync is executing between where the CTR is assigned and where we called `info.Cleanup()`. In such a case, we would deadlock because Cleanup would wait for handlers to complete but the handler is waiting for the lock. Fixes #1000 --- .../AsyncSemaphore.cs | 27 ++++++++++++++++--- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs b/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs index 8df00e8ed..0c7378eb6 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs @@ -101,6 +101,8 @@ public Task EnterAsync(TimeSpan timeout, CancellationToken cancellatio return Task.FromCanceled(cancellationToken); } + WaiterInfo? info = null; + bool shouldCleanupInfo = false; lock (this.syncObject) { if (this.disposed) @@ -119,7 +121,7 @@ public Task EnterAsync(TimeSpan timeout, CancellationToken cancellatio } else { - WaiterInfo info = new WaiterInfo(this, cancellationToken); + info = new WaiterInfo(this, cancellationToken); LinkedListNode? node = this.GetNode(info); // Careful: consider that if the token was cancelled just now (after we checked it on entry to this method) @@ -141,15 +143,22 @@ public Task EnterAsync(TimeSpan timeout, CancellationToken cancellatio else { // Make sure we don't leak the Timer if cancellation happened before we created it. - info.Cleanup(); + shouldCleanupInfo = true; // Also recycle the unused node. this.RecycleNode(node); } - - return info.Trigger.Task; } } + + // We cleanup outside the lock because cleanup can block on the cancellation handler, + // and the handler can take the same lock as we held earlier in this method. + if (shouldCleanupInfo) + { + info.Cleanup(); + } + + return info.Trigger.Task; } /// @@ -230,6 +239,8 @@ private static void CancellationHandler(object? state) } // Clear registration and references. + // We *may* be holding a lock on syncObject at this point iff this handler was executed inline with EnterAsync. + // In such a case, we haven't (yet) set WaiterInfo.CTR, so no deadlock risk exists in that case. waiterInfo.Cleanup(); } @@ -340,6 +351,14 @@ internal WaiterInfo(AsyncSemaphore owner, CancellationToken cancellationToken) internal IDisposable? TimerTokenSource { private get; set; } + /// + /// Disposes of and any applicable timer. + /// + /// + /// Callers should avoid calling this method while holding the lock + /// since can block on completion of + /// which requires that same lock. + /// internal void Cleanup() { CancellationTokenRegistration cancellationTokenRegistration; From 21b4ff3710989ce8db6aec603135c54e812b36db Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 08:25:51 -0600 Subject: [PATCH 0413/1753] Promote unshipped to shipped apis --- .../net472/PublicAPI.Shipped.txt | 4 ++++ .../net472/PublicAPI.Unshipped.txt | 4 ---- .../netcoreapp3.1/PublicAPI.Shipped.txt | 4 ++++ .../netcoreapp3.1/PublicAPI.Unshipped.txt | 4 ---- .../netstandard2.0/PublicAPI.Shipped.txt | 4 ++++ .../netstandard2.0/PublicAPI.Unshipped.txt | 4 ---- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt index 56d837e4e..3d7cc2bc8 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt @@ -454,3 +454,7 @@ Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCom Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 860bd7636..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,4 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt index d8a42137d..916298d7d 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt @@ -452,3 +452,7 @@ Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCom Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt index 860bd7636..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt @@ -1,4 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt index d8a42137d..916298d7d 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt @@ -452,3 +452,7 @@ Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCom Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 860bd7636..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,4 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan From 5ae77872b1ef0a4e561e992414707f48530bd284 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 08:23:15 -0600 Subject: [PATCH 0414/1753] Add net5.0 and net5.0-windows to TargetFrameworks --- azure-pipelines/dotnet.yml | 9 + .../AsyncReaderWriterLock.cs | 2 - .../AwaitExtensions.cs | 6 + src/Microsoft.VisualStudio.Threading/Dgml.cs | 14 +- .../DispatcherExtensions.cs | 2 +- ...inableTaskContext+HangReportContributor.cs | 4 +- .../JoinableTaskFactory.cs | 2 - .../Microsoft.VisualStudio.Threading.csproj | 5 +- .../net5.0-windows/PublicAPI.Shipped.txt | 460 ++++++++++++++++++ .../net5.0-windows/PublicAPI.Unshipped.txt | 12 + .../net5.0/PublicAPI.Shipped.txt | 458 +++++++++++++++++ .../net5.0/PublicAPI.Unshipped.txt | 12 + .../DispatcherExtensionsTests.cs | 2 +- ...rosoft.VisualStudio.Threading.Tests.csproj | 2 +- ...ingleThreadedTestSynchronizationContext.cs | 2 +- 15 files changed, 973 insertions(+), 19 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt create mode 100644 src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Unshipped.txt create mode 100644 src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt create mode 100644 src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Unshipped.txt diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 527b43b85..55494b6e7 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -38,6 +38,15 @@ steps: workingDirectory: test/Microsoft.VisualStudio.Threading.Tests condition: ne(variables['OptProf'], 'true') +- task: DotNetCoreCLI@2 + displayName: dotnet test -f net5.0-windows + inputs: + command: test + arguments: --no-build -c $(BuildConfiguration) -f net5.0-windows --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0-windows.binlog" + testRunTitle: net5.0-windows-$(Agent.JobName) + workingDirectory: test/Microsoft.VisualStudio.Threading.Tests + condition: ne(variables['OptProf'], 'true') + # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertConfigValues.ps1 to notice. - powershell: azure-pipelines\artifacts\VSInsertion.ps1 displayName: Prepare VSInsertion artifact diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index ca1f5604c..a0d9869e0 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -1104,9 +1104,7 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi // an accidental execution fork that is exposing concurrency inappropriately. if (this.CanCurrentThreadHoldActiveLock && !(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) { -#if NETFRAMEWORK || NETCOREAPP // Assertion failures crash on .NET Core < 3.0 Report.Fail("Dangerous request for read lock from fork of write lock."); -#endif Verify.FailOperation(Strings.DangerousReadLockRequestFromWriteLockFork); } diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index 595cde38d..8fb84921a 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -10,6 +10,7 @@ namespace Microsoft.VisualStudio.Threading using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; using System.Runtime.ExceptionServices; + using System.Runtime.InteropServices; using System.Threading; using System.Threading.Tasks; using Microsoft.Win32; @@ -122,6 +123,11 @@ public static TaskAwaiter GetAwaiter(this WaitHandle handle) /// public static Task WaitForChangeAsync(this RegistryKey registryKey, bool watchSubtree = true, RegistryChangeNotificationFilters change = RegistryChangeNotificationFilters.Value | RegistryChangeNotificationFilters.Subkey, CancellationToken cancellationToken = default(CancellationToken)) { + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + throw new PlatformNotSupportedException(); + } + Requires.NotNull(registryKey, nameof(registryKey)); return WaitForRegistryChangeAsync(registryKey.Handle, watchSubtree, change, cancellationToken); diff --git a/src/Microsoft.VisualStudio.Threading/Dgml.cs b/src/Microsoft.VisualStudio.Threading/Dgml.cs index e47cb3a89..8dbb1880e 100644 --- a/src/Microsoft.VisualStudio.Threading/Dgml.cs +++ b/src/Microsoft.VisualStudio.Threading/Dgml.cs @@ -33,12 +33,12 @@ internal static XDocument Create(out XElement nodes, out XElement links, string new XAttribute("Layout", layout))); if (direction is object) { - dgml.Root.Add(new XAttribute("GraphDirection", direction)); + dgml.Root!.Add(new XAttribute("GraphDirection", direction)); } nodes = new XElement(XName.Get("Nodes", Namespace)); links = new XElement(XName.Get("Links", Namespace)); - dgml.Root.Add(nodes); + dgml.Root!.Add(nodes); dgml.Root.Add(links); dgml.WithCategories(Category("Contains", isContainment: true)); return dgml; @@ -107,7 +107,7 @@ internal static XElement Link(string source, string target) internal static XElement Link(XElement source, XElement target) { - return Link(source.Attribute("Id").Value, target.Attribute("Id").Value); + return Link(source.Attribute("Id")!.Value, target.Attribute("Id")!.Value); } internal static XDocument WithLink(this XDocument document, XElement link) @@ -192,7 +192,7 @@ internal static XElement ContainedBy(this XElement node, string containerId, XDo Requires.NotNull(node, nameof(node)); Requires.NotNullOrEmpty(containerId, nameof(containerId)); - document.WithLink(Link(containerId, node.Attribute("Id").Value).WithCategories("Contains")); + document.WithLink(Link(containerId, node.Attribute("Id")!.Value).WithCategories("Contains")); return node; } @@ -230,7 +230,7 @@ internal static XDocument WithStyle(this XDocument document, string categoryId, Requires.NotNull(properties, nameof(properties)); Requires.NotNullOrEmpty(targetType, nameof(targetType)); - XElement? container = document.Root.Element(StylesName); + XElement? container = document.Root!.Element(StylesName); if (container is null) { document.Root.Add(container = new XElement(StylesName)); @@ -241,7 +241,7 @@ internal static XDocument WithStyle(this XDocument document, string categoryId, new XAttribute("TargetType", targetType), new XAttribute("GroupLabel", categoryId), new XElement(XName.Get("Condition", Namespace), new XAttribute("Expression", "HasCategory('" + categoryId + "')"))); - style.Add(properties.Select(p => new XElement(XName.Get("Setter", Namespace), new XAttribute("Property", p.Key), new XAttribute("Value", p.Value)))); + style.Add(properties.Select(p => new XElement(XName.Get("Setter", Namespace), new XAttribute("Property", p.Key), new XAttribute("Value", p.Value!)))); container.Add(style); @@ -274,7 +274,7 @@ private static XElement GetRootElement(this XDocument document, XName name) Requires.NotNull(document, nameof(document)); Requires.NotNull(name, nameof(name)); - XElement? container = document.Root.Element(name); + XElement? container = document.Root!.Element(name); if (container is null) { document.Root.Add(container = new XElement(name)); diff --git a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs index 682f6075f..1ebd5fc9b 100644 --- a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -#if NETFRAMEWORK +#if NETFRAMEWORK || WINDOWS namespace Microsoft.VisualStudio.Threading { diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs index d86ff1965..c2840bc5d 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs @@ -129,7 +129,7 @@ private static List> CreateNodeLabels(Dictionary> CreateNodeLabels(Dictionary - netstandard2.0;netcoreapp3.1;net472 - + netstandard2.0;netcoreapp3.1;net5.0;net5.0-windows;net472 + true + Async synchronization primitives, async collections, TPL and dataflow extensions. Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). Threading Async Lock Synchronization Threadsafe diff --git a/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt new file mode 100644 index 000000000..3d7cc2bc8 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt @@ -0,0 +1,460 @@ +#nullable enable +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncBarrier +Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void +Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCountdownEvent +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncEventHandler +Microsoft.VisualStudio.Threading.AsyncEventHandler +Microsoft.VisualStudio.Threading.AsyncLazy +Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void +Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T +Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T +Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazyInitializer +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool +Microsoft.VisualStudio.Threading.AsyncLocal +Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void +Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? +Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncQueue +Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void +Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void +Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int +Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void +Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T +Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! +Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncSemaphore +Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void +Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int +Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser +Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken +Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory +Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void +Microsoft.VisualStudio.Threading.DispatcherExtensions +Microsoft.VisualStudio.Threading.HangReportContribution +Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! +Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? +Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? +Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void +Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void +Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? +Microsoft.VisualStudio.Threading.IAsyncDisposable +Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.IHangReportContributor +Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! +Microsoft.VisualStudio.Threading.JoinableTask +Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter +Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void +Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTask +Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter +Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T +Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTaskCollection +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? +Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext +Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! +Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! +Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance +Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance +Microsoft.VisualStudio.Threading.JoinableTaskContextException +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextNode +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance +Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions +Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions +Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions +Microsoft.VisualStudio.Threading.JoinableTaskFactory +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? +Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext +Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.ReentrantSemaphore +Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int +Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance +Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void +Microsoft.VisualStudio.Threading.SpecializedSyncContext +Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void +Microsoft.VisualStudio.Threading.ThreadingTools +Microsoft.VisualStudio.Threading.TplExtensions +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask +override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! +override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! +override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void +override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool +override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void +override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int +override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! +override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void +override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter +static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool +static Microsoft.VisualStudio.Threading.DispatcherExtensions.WithPriority(this Microsoft.VisualStudio.Threading.JoinableTaskFactory! joinableTaskFactory, System.Windows.Threading.Dispatcher! dispatcher, System.Windows.Threading.DispatcherPriority priority) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! +static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! +static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext +static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext +static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool +static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool +static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int +virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void +virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void +virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void +virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void +virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void +virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext +Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void +Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? +override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! +override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void +override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Unshipped.txt new file mode 100644 index 000000000..79b8d419e --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Unshipped.txt @@ -0,0 +1,12 @@ +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt new file mode 100644 index 000000000..916298d7d --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt @@ -0,0 +1,458 @@ +#nullable enable +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncBarrier +Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void +Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCountdownEvent +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncEventHandler +Microsoft.VisualStudio.Threading.AsyncEventHandler +Microsoft.VisualStudio.Threading.AsyncLazy +Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void +Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T +Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T +Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazyInitializer +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool +Microsoft.VisualStudio.Threading.AsyncLocal +Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void +Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? +Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncQueue +Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void +Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void +Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int +Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void +Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T +Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! +Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool +Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable +Microsoft.VisualStudio.Threading.AsyncSemaphore +Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void +Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int +Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser +Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool +Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken +Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory +Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void +Microsoft.VisualStudio.Threading.HangReportContribution +Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! +Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? +Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? +Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void +Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void +Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? +Microsoft.VisualStudio.Threading.IAsyncDisposable +Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.IHangReportContributor +Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! +Microsoft.VisualStudio.Threading.JoinableTask +Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter +Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void +Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTask +Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter +Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T +Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTaskCollection +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? +Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void +Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext +Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! +Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid +Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! +Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance +Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance +Microsoft.VisualStudio.Threading.JoinableTaskContextException +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextNode +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! +Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance +Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions +Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions +Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions +Microsoft.VisualStudio.Threading.JoinableTaskFactory +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T +Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? +Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext +Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void +Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.ReentrantSemaphore +Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int +Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode +Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance +Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void +Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void +Microsoft.VisualStudio.Threading.SpecializedSyncContext +Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void +Microsoft.VisualStudio.Threading.ThreadingTools +Microsoft.VisualStudio.Threading.TplExtensions +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask +override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! +override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! +override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void +override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool +override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void +override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void +override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int +override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! +override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void +override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter +static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable +static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool +static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool +static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! +static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! +static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext +static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext +static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool +static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool +static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! +static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! +static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int +virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void +virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void +virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void +virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void +virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void +virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void +virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext +Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void +Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? +override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! +override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void +override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable +Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void +Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan diff --git a/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Unshipped.txt new file mode 100644 index 000000000..79b8d419e --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Unshipped.txt @@ -0,0 +1,12 @@ +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs index f40d1d6f3..a34dd5e14 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -#if NETFRAMEWORK +#if NETFRAMEWORK || WINDOWS using System; using System.Threading; diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 0d7e5f4ad..ee5654b32 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -1,6 +1,6 @@  - net472;netcoreapp3.1;net5.0 + net472;netcoreapp3.1;net5.0;net5.0-windows true true diff --git a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs index 029563f99..3574e282c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -#if NETFRAMEWORK +#if NETFRAMEWORK || WINDOWS #define UseWpfContext #endif From b790e7bbd0dc39d099846df2c180dfad2634c263 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 08:55:09 -0600 Subject: [PATCH 0415/1753] Keep build working on non-Windows agents --- azure-pipelines/dotnet.yml | 2 +- .../Microsoft.VisualStudio.Threading.csproj | 9 ++++++--- .../Microsoft.VisualStudio.Threading.Tests.csproj | 5 ++++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 55494b6e7..cf1be406f 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -45,7 +45,7 @@ steps: arguments: --no-build -c $(BuildConfiguration) -f net5.0-windows --filter "TestCategory!=FailsInCloudTest" -v n /p:CollectCoverage=true --settings "$(Build.Repository.LocalPath)/azure-pipelines/$(Agent.OS).runsettings" /bl:"$(Build.ArtifactStagingDirectory)/build_logs/test_net5.0-windows.binlog" testRunTitle: net5.0-windows-$(Agent.JobName) workingDirectory: test/Microsoft.VisualStudio.Threading.Tests - condition: ne(variables['OptProf'], 'true') + condition: and(ne(variables['OptProf'], 'true'), eq(variables['Agent.OS'], 'Windows_NT')) # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertConfigValues.ps1 to notice. - powershell: azure-pipelines\artifacts\VSInsertion.ps1 diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 1209b2e6a..0526a523b 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -1,14 +1,17 @@  - netstandard2.0;netcoreapp3.1;net5.0;net5.0-windows;net472 - true - + netstandard2.0;netcoreapp3.1;net5.0;net472 + Async synchronization primitives, async collections, TPL and dataflow extensions. Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). Threading Async Lock Synchronization Threadsafe true + + $(TargetFrameworks);net5.0-windows + true + ResXFileCodeGenerator diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index ee5654b32..399ebb05b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -1,6 +1,6 @@  - net472;netcoreapp3.1;net5.0;net5.0-windows + net472;netcoreapp3.1;net5.0 true true @@ -9,6 +9,9 @@ $(DefineConstants);ISOLATED_TEST_SUPPORT + + $(TargetFrameworks);net5.0-windows + InternalUtilities.cs From 12f7483b000824c81b90edf8dbbd869dcb634362 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 09:21:09 -0600 Subject: [PATCH 0416/1753] Fix TargetFramework detection --- tools/Install-DotNetSdk.ps1 | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 3c82ee2b2..d1da42503 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -42,12 +42,12 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$P $projXml = [xml](Get-Content -Path $_) $pg = $projXml.Project.PropertyGroup if ($pg) { - $targetFrameworks = $pg.TargetFramework - if (!$targetFrameworks) { - $targetFrameworks = $pg.TargetFrameworks - if ($targetFrameworks) { - $targetFrameworks = $targetFrameworks -Split ';' - } + $targetFrameworks = @() + $tf = $pg.TargetFramework + $targetFrameworks += $tf + $tfs = $pg.TargetFrameworks + if ($tfs) { + $targetFrameworks = $tfs -Split ';' } } $targetFrameworks |? { $_ -match 'net(?:coreapp)?(\d+\.\d+)' } |% { From e92074087c0087bcbdcbfe7bf86030d9f09f1bde Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 09:22:42 -0600 Subject: [PATCH 0417/1753] Improve TargetFramework detection --- tools/Install-DotNetSdk.ps1 | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 3c82ee2b2..d1da42503 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -42,12 +42,12 @@ Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$P $projXml = [xml](Get-Content -Path $_) $pg = $projXml.Project.PropertyGroup if ($pg) { - $targetFrameworks = $pg.TargetFramework - if (!$targetFrameworks) { - $targetFrameworks = $pg.TargetFrameworks - if ($targetFrameworks) { - $targetFrameworks = $targetFrameworks -Split ';' - } + $targetFrameworks = @() + $tf = $pg.TargetFramework + $targetFrameworks += $tf + $tfs = $pg.TargetFrameworks + if ($tfs) { + $targetFrameworks = $tfs -Split ';' } } $targetFrameworks |? { $_ -match 'net(?:coreapp)?(\d+\.\d+)' } |% { From 50464724da66473f831e71bc72df266c78090884 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 25 Mar 2022 15:58:47 +0000 Subject: [PATCH 0418/1753] Bump StyleCop.Analyzers from 1.2.0-beta.354 to 1.2.0-beta.406 (#1007) --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 8197ed724..cdb9a747a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -37,7 +37,7 @@ - + From ee55aa181f579345b6140f0c58103a3920057e7b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 10:29:06 -0600 Subject: [PATCH 0419/1753] Merge pull request #1010 from AArnott/updateDeps Update dependencies --- .../Microsoft.VisualStudio.Threading.csproj | 2 +- src/SosThreadingTools/SosThreadingTools.csproj | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 0526a523b..298723c92 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -44,7 +44,7 @@ - + diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 5741b96b2..9f0665a2b 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -26,8 +26,8 @@ - - + + From 50970d6a15da2b8360f1901dac6cfada3f542030 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Mar 2022 11:27:41 -0600 Subject: [PATCH 0420/1753] Build 17.2 stable package --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index e94b618dc..3f21a9c28 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.2-alpha", + "version": "17.2", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 291cc3a0c351f1b917fd698479cc20698b3be4f7 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 28 Mar 2022 14:53:13 -0700 Subject: [PATCH 0421/1753] Remove duplicated condition check. We set this.joinableTask to null at the end of the JTF task spinned off here, so value.IsCompleted means that this.joinableTask to be null. Based on that, we can cut all duplicated condition checks to keep it as simple as possible. --- src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index e1527c100..2ecd4cb9a 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -183,12 +183,7 @@ public Task GetValueAsync(CancellationToken cancellationToken) resumableAwaiter?.Resume(); } - if (!this.value.IsCompleted) - { - return this.joinableTask?.JoinAsync(cancellationToken) ?? this.value.WithCancellation(cancellationToken); - } - - return this.value.WithCancellation(cancellationToken); + return this.joinableTask?.JoinAsync(cancellationToken) ?? this.value.WithCancellation(cancellationToken); } /// From 96bc8849c39076328352e0c0f57cbf7e92d811c3 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 29 Mar 2022 16:41:50 -0700 Subject: [PATCH 0422/1753] Revert "Prevent creating two task waiting chains when joins AsyncLazy." --- src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 2ecd4cb9a..e14eac66e 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -183,7 +183,12 @@ public Task GetValueAsync(CancellationToken cancellationToken) resumableAwaiter?.Resume(); } - return this.joinableTask?.JoinAsync(cancellationToken) ?? this.value.WithCancellation(cancellationToken); + if (!this.value.IsCompleted) + { + this.joinableTask?.JoinAsync(cancellationToken).Forget(); + } + + return this.value.WithCancellation(cancellationToken); } /// From 657cbd04b619b459c92a6d44948513df7ad08295 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 29 Mar 2022 17:52:41 -0700 Subject: [PATCH 0423/1753] Reduce overhead when no cancellation token is being used. --- .../JoinableTask.cs | 48 ++++++++++++------- .../JoinableTask`1.cs | 19 ++++++-- .../ThreadingTools.cs | 2 +- 3 files changed, 47 insertions(+), 22 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index e000a2454..6a21a4933 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -590,13 +590,27 @@ private Task QueueNeedProcessEvent /// before the async operation has completed. /// /// A task that completes after the asynchronous operation completes and the join is reverted. - public async Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) + public Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) { cancellationToken.ThrowIfCancellationRequested(); - using (this.AmbientJobJoinsThis()) + if (!cancellationToken.CanBeCanceled) { - await this.Task.WithCancellation(AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); + // if a completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. + _ = this.AmbientJobJoinsThis(); + return this.Task; + } + else + { + return JoinSlowAsync(this, cancellationToken); + } + + static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) + { + using (me.AmbientJobJoinsThis()) + { + await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); + } } } @@ -1055,6 +1069,20 @@ internal int GetPendingEventCountForSynchronousTask(JoinableTask synchronousTask return this.queueNeedProcessEvent; } + private protected JoinRelease AmbientJobJoinsThis() + { + if (!this.IsCompleted) + { + JoinableTask? ambientJob = this.JoinableTaskContext.AmbientTask; + if (ambientJob is object && ambientJob != this) + { + return JoinableTaskDependencyGraph.AddDependency(ambientJob, this); + } + } + + return default(JoinRelease); + } + private static bool TryDequeueSelfOrDependencies(IJoinableTaskDependent currentNode, bool onMainThread, HashSet visited, [NotNullWhen(true)] out SingleExecuteProtector? work) { Requires.NotNull(currentNode, nameof(currentNode)); @@ -1191,19 +1219,5 @@ private void AddStateFlags(JoinableTaskFlags flags) } } } - - private JoinRelease AmbientJobJoinsThis() - { - if (!this.IsCompleted) - { - JoinableTask? ambientJob = this.JoinableTaskContext.AmbientTask; - if (ambientJob is object && ambientJob != this) - { - return JoinableTaskDependencyGraph.AddDependency(ambientJob, this); - } - } - - return default(JoinRelease); - } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index 75e923df5..0d12e46e1 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -56,12 +56,23 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, Joi return this.Task; } - return JoinSlowAsync(cancellationToken); + if (!cancellationToken.CanBeCanceled) + { + // if a completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. + _ = this.AmbientJobJoinsThis(); + return this.Task; + } - async Task JoinSlowAsync(CancellationToken cancellationToken) + return JoinSlowAsync(this, cancellationToken); + + static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) { - await base.JoinAsync(cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); - return await this.Task.ConfigureAwait(AwaitShouldCaptureSyncContext); + using (me.AmbientJobJoinsThis()) + { + await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); + } + + return await me.Task.ConfigureAwaitRunInline(); } } diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs index 26336abd0..04fe7b55e 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs @@ -307,7 +307,7 @@ private static async Task WithCancellationSlow(this Task task, bool continueOnCa // Rethrow any fault/cancellation exception, even if we awaited above. // But if we skipped the above if branch, this will actually yield // on an incompleted task. - await task.ConfigureAwait(continueOnCapturedContext); + await task.ConfigureAwaitRunInline(); } /// From 7e34288f4cf0fbb6f1f86c7a05199a7330b50eda Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 30 Mar 2022 07:20:08 -0600 Subject: [PATCH 0424/1753] Fix Install-DotNetSdk.ps1 for Windows machine-wide installations --- tools/Install-DotNetSdk.ps1 | 44 +++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 3c82ee2b2..6b584f1cf 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -72,6 +72,7 @@ Function Get-FileFromWeb([Uri]$Uri, $OutDir) { $OutFile = Join-Path $OutDir $Uri.Segments[-1] if (!(Test-Path $OutFile)) { Write-Verbose "Downloading $Uri..." + if (!(Test-Path $OutDir)) { mkdir $OutDir } try { (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) } finally { @@ -87,12 +88,51 @@ Function Get-InstallerExe($Version, [switch]$Runtime) { if ($Runtime) { $sdkOrRuntime = 'Runtime' } # Get the latest/actual version for the specified one - if (([Version]$Version).Build -eq -1) { + $TypedVersion = [Version]$Version + if ($TypedVersion.Build -eq -1) { $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/latest.version" -UseBasicParsing) $Version = $versionInfo[-1] } - Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/dotnet-$($sdkOrRuntime.ToLowerInvariant())-$Version-win-$arch.exe" -OutDir "$DotNetInstallScriptRoot" + $majorMinor = "$($TypedVersion.Major).$($TypedVersion.Minor)" + $ReleasesFile = Join-Path $DotNetInstallScriptRoot "$majorMinor\releases.json" + if (!(Test-Path $ReleasesFile)) { + Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata/$majorMinor/releases.json" -OutDir (Split-Path $ReleasesFile) + } + + $releases = Get-Content $ReleasesFile | ConvertFrom-Json + $url = $null + foreach ($release in $releases.releases) { + $filesElement = $null + if ($Runtime) { + if ($release.runtime.version -eq $Version) { + $filesElement = $release.runtime.files + } + } else { + if ($release.sdk.version -eq $Version) { + $filesElement = $release.sdk.files + } + } + + if ($filesElement) { + foreach ($file in $filesElement) { + if ($file.rid -eq "win-$arch") { + $url = $file.url + Break + } + } + + if ($url) { + Break + } + } + } + + if ($url) { + Get-FileFromWeb -Uri $url -OutDir $DotNetInstallScriptRoot + } else { + Write-Error "Unable to find release of $sdkOrRuntime v$Version" + } } Function Install-DotNet($Version, [switch]$Runtime) { From 600cb05214d51a86bcfcf31d050c5fe53af9aa06 Mon Sep 17 00:00:00 2001 From: Eric Arndt Date: Wed, 30 Mar 2022 12:37:46 -0700 Subject: [PATCH 0425/1753] Cache boxed bool values to reduce allocation overhead --- src/Microsoft.VisualStudio.Threading/Boxed.cs | 26 +++++++++++++++++++ .../ThreadingEventSource.cs | 4 +-- 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/Boxed.cs diff --git a/src/Microsoft.VisualStudio.Threading/Boxed.cs b/src/Microsoft.VisualStudio.Threading/Boxed.cs new file mode 100644 index 000000000..aa553b23f --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/Boxed.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading +{ + internal static class Boxed + { + /// + /// Returns an object containing . + /// + public static readonly object True = true; + + /// + /// Returns an object containing . + /// + public static readonly object False = false; + + /// + /// Returns an object containing specified value. + /// + public static object Box(bool value) + { + return value ? True : False; + } + } +} diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs index 4b98a0d40..ecfbce1b3 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs @@ -106,7 +106,7 @@ public void WaitReaderWriterLockStop(int lockId, AsyncReaderWriterLock.LockKind [Event(CompleteOnCurrentThreadStartEvent)] public void CompleteOnCurrentThreadStart(int taskId, bool isOnMainThread) { - this.WriteEvent(CompleteOnCurrentThreadStartEvent, taskId, isOnMainThread); + this.WriteEvent(CompleteOnCurrentThreadStartEvent, taskId, Boxed.Box(isOnMainThread)); } /// @@ -145,7 +145,7 @@ public void WaitSynchronouslyStop() [Event(PostExecutionStartEvent, Level = EventLevel.Verbose)] public void PostExecutionStart(int requestId, bool mainThreadAffinitized) { - this.WriteEvent(PostExecutionStartEvent, requestId, mainThreadAffinitized); + this.WriteEvent(PostExecutionStartEvent, requestId, Boxed.Box(mainThreadAffinitized)); } /// From 3aeff335e600bb8968e1fd7d1eb2d9a05900c328 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 30 Mar 2022 18:13:34 -0600 Subject: [PATCH 0426/1753] Ignore launchSettings.json --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index d060a300b..716456084 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ *.user *.userosscache *.sln.docstates +launchSettings.json # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs From b917529de6555deb96fbcccda3ce986659259cd9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Mar 2022 07:50:18 -0600 Subject: [PATCH 0427/1753] Replace deployments with ordinary jobs --- azure-pipelines/release.yml | 87 +++++++++++++++++-------------------- 1 file changed, 39 insertions(+), 48 deletions(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index bfe5987cd..029b654df 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -13,60 +13,51 @@ stages: - stage: GitHubRelease displayName: GitHub Release jobs: - - deployment: create + - job: create pool: vmImage: ubuntu-latest - environment: No-Approval - strategy: - runOnce: - deploy: - steps: - - download: none - - powershell: | - Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - displayName: Set pipeline name - - task: GitHubRelease@1 - displayName: GitHub release (create) - inputs: - gitHubConnection: # TODO: fill in service connection here - repositoryName: $(Build.Repository.Name) - target: $(resources.pipeline.CI.sourceCommit) - tagSource: userSpecifiedTag - tag: v$(resources.pipeline.CI.runName) - title: v$(resources.pipeline.CI.runName) - isDraft: true # After running this step, visit the new draft release, edit, and publish. - changeLogCompareToRelease: lastNonDraftRelease - changeLogType: issueBased - changeLogLabels: | - [ - { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, - { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } - ] + steps: + - powershell: | + Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + displayName: Set pipeline name + - task: GitHubRelease@1 + displayName: GitHub release (create) + inputs: + gitHubConnection: # TODO: fill in service connection here + repositoryName: $(Build.Repository.Name) + target: $(resources.pipeline.CI.sourceCommit) + tagSource: userSpecifiedTag + tag: v$(resources.pipeline.CI.runName) + title: v$(resources.pipeline.CI.runName) + isDraft: true # After running this step, visit the new draft release, edit, and publish. + changeLogCompareToRelease: lastNonDraftRelease + changeLogType: issueBased + changeLogLabels: | + [ + { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, + { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } + ] - stage: nuget_org displayName: nuget.org dependsOn: GitHubRelease jobs: - - deployment: push + - job: push pool: vmImage: ubuntu-latest - environment: No-Approval - strategy: - runOnce: - deploy: - steps: - - download: CI - artifact: deployables-Windows - displayName: Download deployables-Windows artifact - patterns: 'deployables-Windows/*' - - task: NuGetToolInstaller@1 - displayName: Use NuGet 5.x - inputs: - versionSpec: 5.x - - task: NuGetCommand@2 - displayName: NuGet push - inputs: - command: push - packagesToPush: $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg - nuGetFeedType: external - publishFeedCredentials: # TODO: fill in service connection here + steps: + - download: CI + artifact: deployables-Windows + displayName: Download deployables-Windows artifact + patterns: 'deployables-Windows/*' + - task: NuGetToolInstaller@1 + displayName: Use NuGet 5.x + inputs: + versionSpec: 5.x + - task: NuGetCommand@2 + displayName: NuGet push + inputs: + command: push + packagesToPush: $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg + nuGetFeedType: external + publishFeedCredentials: # TODO: fill in service connection here From efe7fddda409bb2241a6a6aacdd1a91367c1585d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Mar 2022 09:15:01 -0600 Subject: [PATCH 0428/1753] Simplify release and CI package push --- azure-pipelines.yml | 2 +- azure-pipelines/publish-deployables.yml | 13 +--- azure-pipelines/release.yml | 90 +++++++++++-------------- 3 files changed, 41 insertions(+), 64 deletions(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index a1435d918..fe8363a2d 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -22,7 +22,7 @@ variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - ci_feed: CI # Azure Artifacts feed name + ci_feed: https://pkgs.dev.azure.com/andrewarnott/_packaging/CI/nuget/v3/index.json # Azure Artifacts feed URL NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages jobs: diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index a4f8e593f..f8c1dfc9d 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -3,17 +3,6 @@ steps: displayName: Download deployables artifact: deployables-Windows -- task: NuGetToolInstaller@1 - displayName: Use NuGet 5.x - inputs: - versionSpec: 5.x - -- task: NuGetCommand@2 +- script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/*.nupkg -s $(ci_feed) -k azdo --skip-duplicate displayName: Push packages to CI feed - inputs: - command: push - packagesToPush: $(Pipeline.Workspace)/deployables-Windows/*.nupkg - nuGetFeedType: internal - publishVstsFeed: $(ci_feed) - allowPackageConflicts: true condition: and(succeeded(), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 029b654df..205c514bf 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -9,55 +9,43 @@ resources: tags: - auto-release -stages: -- stage: GitHubRelease - displayName: GitHub Release - jobs: - - job: create - pool: - vmImage: ubuntu-latest - steps: - - powershell: | - Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - displayName: Set pipeline name - - task: GitHubRelease@1 - displayName: GitHub release (create) - inputs: - gitHubConnection: # TODO: fill in service connection here - repositoryName: $(Build.Repository.Name) - target: $(resources.pipeline.CI.sourceCommit) - tagSource: userSpecifiedTag - tag: v$(resources.pipeline.CI.runName) - title: v$(resources.pipeline.CI.runName) - isDraft: true # After running this step, visit the new draft release, edit, and publish. - changeLogCompareToRelease: lastNonDraftRelease - changeLogType: issueBased - changeLogLabels: | - [ - { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, - { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } - ] +variables: +- group: Publishing secrets -- stage: nuget_org - displayName: nuget.org - dependsOn: GitHubRelease - jobs: - - job: push - pool: - vmImage: ubuntu-latest - steps: - - download: CI - artifact: deployables-Windows - displayName: Download deployables-Windows artifact - patterns: 'deployables-Windows/*' - - task: NuGetToolInstaller@1 - displayName: Use NuGet 5.x - inputs: - versionSpec: 5.x - - task: NuGetCommand@2 - displayName: NuGet push - inputs: - command: push - packagesToPush: $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg - nuGetFeedType: external - publishFeedCredentials: # TODO: fill in service connection here +jobs: +- job: release + pool: + vmImage: ubuntu-latest + steps: + - checkout: none + - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + displayName: Set pipeline name + - task: UseDotNet@2 + displayName: Install .NET SDK + inputs: + packageType: sdk + version: 6.x + - task: GitHubRelease@1 + displayName: GitHub release (create) + inputs: + gitHubConnection: # TODO: fill in service connection here + repositoryName: $(Build.Repository.Name) + target: $(resources.pipeline.CI.sourceCommit) + tagSource: userSpecifiedTag + tag: v$(resources.pipeline.CI.runName) + title: v$(resources.pipeline.CI.runName) + isDraft: true # After running this step, visit the new draft release, edit, and publish. + changeLogCompareToRelease: lastNonDraftRelease + changeLogType: issueBased + changeLogLabels: | + [ + { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, + { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } + ] + - download: CI + artifact: deployables-Windows + displayName: Download deployables-Windows artifact + patterns: 'deployables-Windows/*' + - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate + displayName: Push nuget packages + condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) From 52dcdc720bd044be13fa99e29d6d94b94d120559 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Mar 2022 09:28:40 -0600 Subject: [PATCH 0429/1753] GitHub release enhancements - Set GitHub release prerelease flag - Include deployables as release artifacts --- azure-pipelines/release.yml | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 205c514bf..437ee65bb 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -18,13 +18,23 @@ jobs: vmImage: ubuntu-latest steps: - checkout: none - - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - displayName: Set pipeline name + - powershell: | + Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + if ('$(resources.pipeline.CI.runName)'.Contains('-')) { + Write-Host "##vso[task.setvariable variable=IsPrerelease]true" + } else { + Write-Host "##vso[task.setvariable variable=IsPrerelease]false" + } + displayName: Set up pipeline - task: UseDotNet@2 displayName: Install .NET SDK inputs: packageType: sdk version: 6.x + - download: CI + artifact: deployables-Windows + displayName: Download deployables-Windows artifact + patterns: 'deployables-Windows/*' - task: GitHubRelease@1 displayName: GitHub release (create) inputs: @@ -35,6 +45,8 @@ jobs: tag: v$(resources.pipeline.CI.runName) title: v$(resources.pipeline.CI.runName) isDraft: true # After running this step, visit the new draft release, edit, and publish. + isPreRelease: $(IsPrerelease) + assets: $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg changeLogCompareToRelease: lastNonDraftRelease changeLogType: issueBased changeLogLabels: | @@ -42,10 +54,6 @@ jobs: { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } ] - - download: CI - artifact: deployables-Windows - displayName: Download deployables-Windows artifact - patterns: 'deployables-Windows/*' - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate displayName: Push nuget packages condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) From 05b8a491c03a9acb4268477a3e187a4c8ec9769e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Mar 2022 10:37:02 -0600 Subject: [PATCH 0430/1753] Increase test timeout to 60s --- azure-pipelines/dotnet-test-cloud.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 440bd8909..08cd4d1fd 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -14,7 +14,7 @@ dotnet test $RepoRoot ` -c $Configuration ` --filter "TestCategory!=FailsInCloudTest" ` -p:CollectCoverage=true ` - --blame-hang-timeout 30s ` + --blame-hang-timeout 60s ` --blame-crash ` -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` --diag "$ArtifactStagingFolder/test_logs/diag.log;TraceLevel=info" ` From 4feafe4c1c30128f97780fa78c7dc271b2bb80c7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Mar 2022 13:33:50 -0600 Subject: [PATCH 0431/1753] Add sample azure-public stage --- azure-pipelines/official.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 1c800f3c4..d7b949d33 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -60,6 +60,7 @@ stages: - job: archive pool: VSEng-ReleasePool-1ES steps: + - checkout: none - download: current artifact: Variables-Windows displayName: Download Variables-Windows artifact @@ -81,3 +82,29 @@ stages: SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy - task: MicroBuildCleanup@1 displayName: Send Telemetry + +# - stage: azure_public_vsimpl_feed +# displayName: azure-public/vs-impl feed +# condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) +# jobs: +# - job: push +# pool: +# name: AzurePipelines-EO +# vmImage: AzurePipelinesUbuntu20.04compliant +# steps: +# - checkout: none +# - download: current +# artifact: deployables-Windows +# displayName: Download deployables-Windows artifact +# - task: UseDotNet@2 +# displayName: Install .NET SDK +# inputs: +# packageType: sdk +# version: 6.x +# - task: NuGetAuthenticate@0 +# displayName: Authenticate NuGet feeds +# inputs: +# nuGetServiceConnections: azure-public/vs-impl +# forceReinstallCredentialProvider: true +# - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate +# displayName: Push nuget packages From 34262db00810c6f0e48dfe12efbea0a69b1acf89 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Mar 2022 13:34:19 -0600 Subject: [PATCH 0432/1753] Add recognition for RIDs in test paths --- azure-pipelines/dotnet-test-cloud.ps1 | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 08cd4d1fd..7d5a4350a 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -27,8 +27,12 @@ Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { if ($PublishResults) { $x = [xml](Get-Content -Path $_) $storage = $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')[0].storage -replace '\\','/' - if ($storage -match '/(?[^/]+)/(?[^/]+)\.dll$') { - $runTitle = "$($matches.lib) ($($matches.tfm), $Agent)" + if ($storage -match '/(?net[^/]+)/(?:(?[^/]+)/)?(?[^/]+)\.dll$') { + if ($matches.rid) { + $runTitle = "$($matches.lib) ($($matches.tfm), $($matches.rid), $Agent)" + } else { + $runTitle = "$($matches.lib) ($($matches.tfm), $Agent)" + } } else { $unknownCounter += 1; $runTitle = "unknown$unknownCounter ($Agent)"; From 3cc5f48e42c0b9b1ea87b7bf141f81eeace7e8dc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 5 Apr 2022 06:38:05 -0600 Subject: [PATCH 0433/1753] Insert into rel/d17.2 branch --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..49d6dadfb 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.2' From 2afb7938b06111b0f944e47a3ce0c75cfe798948 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 5 Apr 2022 06:38:47 -0600 Subject: [PATCH 0434/1753] Build 17.3-alpha version --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index 3f21a9c28..f73e69568 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.2", + "version": "17.3-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From e3793f2431b1edeb4f325c327874aedc151bdabb Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 6 Apr 2022 18:46:47 -0700 Subject: [PATCH 0435/1753] Not change some await configuration to reduce risks. --- src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs | 2 +- src/Microsoft.VisualStudio.Threading/ThreadingTools.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index 0d12e46e1..e9785d8d6 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -72,7 +72,7 @@ static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancell await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); } - return await me.Task.ConfigureAwaitRunInline(); + return await me.Task.ConfigureAwait(AwaitShouldCaptureSyncContext); } } diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs index 04fe7b55e..26336abd0 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs @@ -307,7 +307,7 @@ private static async Task WithCancellationSlow(this Task task, bool continueOnCa // Rethrow any fault/cancellation exception, even if we awaited above. // But if we skipped the above if branch, this will actually yield // on an incompleted task. - await task.ConfigureAwaitRunInline(); + await task.ConfigureAwait(continueOnCapturedContext); } /// From 1b36639916352e2eb51c5228e1288941879f49c0 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Thu, 7 Apr 2022 11:19:29 -0700 Subject: [PATCH 0436/1753] no need to dispose JTF dependency when task is completed. --- src/Microsoft.VisualStudio.Threading/JoinableTask.cs | 9 ++++++++- .../JoinableTask`1.cs | 12 +++++++++--- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 6a21a4933..b71d15efe 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -607,10 +607,17 @@ private Task QueueNeedProcessEvent static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) { - using (me.AmbientJobJoinsThis()) + JoinRelease dependency = me.AmbientJobJoinsThis(); + + try { await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); } + catch + { + dependency.Dispose(); + throw; + } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index e9785d8d6..6c3cbc295 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -67,12 +67,18 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, Joi static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) { - using (me.AmbientJobJoinsThis()) + JoinableTaskCollection.JoinRelease dependency = me.AmbientJobJoinsThis(); + + try { await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); + return await me.Task.ConfigureAwait(AwaitShouldCaptureSyncContext); + } + catch + { + dependency.Dispose(); + throw; } - - return await me.Task.ConfigureAwait(AwaitShouldCaptureSyncContext); } } From e9667e91c3692daa053d366e549308dd7f5066cc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 7 Apr 2022 21:02:06 -0600 Subject: [PATCH 0437/1753] Only dispose dependency link on cancellation Also touch-up code comments and modify syntax to make it consistent across the two methods. --- src/Microsoft.VisualStudio.Threading/JoinableTask.cs | 5 +++-- .../JoinableTask`1.cs | 11 +++++++---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index b71d15efe..28bc69bba 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -596,7 +596,7 @@ private Task QueueNeedProcessEvent if (!cancellationToken.CanBeCanceled) { - // if a completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. + // A completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. _ = this.AmbientJobJoinsThis(); return this.Task; } @@ -607,13 +607,14 @@ private Task QueueNeedProcessEvent static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) { + // No need to dispose of this except in cancellation case. JoinRelease dependency = me.AmbientJobJoinsThis(); try { await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); } - catch + catch (OperationCanceledException) { dependency.Dispose(); throw; diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index 6c3cbc295..14bb2ac4e 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -58,15 +58,18 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, Joi if (!cancellationToken.CanBeCanceled) { - // if a completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. + // A completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. _ = this.AmbientJobJoinsThis(); return this.Task; } - - return JoinSlowAsync(this, cancellationToken); + else + { + return JoinSlowAsync(this, cancellationToken); + } static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) { + // No need to dispose of this except in cancellation case. JoinableTaskCollection.JoinRelease dependency = me.AmbientJobJoinsThis(); try @@ -74,7 +77,7 @@ static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancell await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); return await me.Task.ConfigureAwait(AwaitShouldCaptureSyncContext); } - catch + catch (OperationCanceledException) { dependency.Dispose(); throw; From 246aac62e8e349ffdb6679cfde92b34ec8418311 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sat, 9 Apr 2022 11:58:10 -0700 Subject: [PATCH 0438/1753] Fix performance problems when we have lots of tasks waiting on AsyncLazy. The problem is that ListOfOftenOne was not designed for the current usage. When we add lots of items to it, it will repeat allocating arrays. A new data structure was created to retain some advantage of the original one like more efficient to hold 0 or 1 items. (And comparing to List, it saves memory for small amount of items, as we do not need any thread-safe related design here. We don't allow enumerating items directly so we don't need any reentry protection. It was completely designed to fit the current need. Consider we rarely remove a JoinableTask from a collection, and most JoinAsync will wait until the task to finish, it is rarely that we need remove any added item, so the design is to keep Add close to O(1), and remove O(n). --- .../JoinableTask+ExecutionQueue.cs | 11 +- .../JoinableTask.cs | 6 +- .../RarelyRemoveItemSet`1.cs | 242 ++++++++++++++++++ 3 files changed, 255 insertions(+), 4 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs index a765d3d66..4ca95722f 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs @@ -69,7 +69,16 @@ protected override void OnCompleted() { base.OnCompleted(); - this.owningJob.OnQueueCompleted(); + if ((this.owningJob.state & JoinableTaskFlags.CompleteFinalized) != JoinableTaskFlags.CompleteFinalized) + { + using (this.owningJob.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.owningJob.JoinableTaskContext.SyncContextLock) + { + this.owningJob.OnQueueCompleted(); + } + } + } } private void Scavenge() diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 28bc69bba..0e44c1232 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -60,7 +60,7 @@ public partial class JoinableTask : IJoinableTaskDependent /// The collections that this job is a member of. /// [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private ListOfOftenOne dependencyParents; + private RarelyRemoveItemSet dependencyParents; /// /// The returned by the async delegate that this JoinableTask originally executed, @@ -479,7 +479,7 @@ internal IEnumerable ContainingCollections get { Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); - return this.dependencyParents.OfType().ToList(); + return this.dependencyParents.ToArray().OfType(); } } @@ -1022,7 +1022,7 @@ internal void OnQueueCompleted() // notifications come in. this.JoinableTaskContext.OnJoinableTaskCompleted(this); - foreach (IJoinableTaskDependent? collection in this.dependencyParents) + foreach (IJoinableTaskDependent collection in this.dependencyParents.EnumerateAndClear()) { JoinableTaskDependencyGraph.RemoveDependency(collection, this, forceCleanup: true); } diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs new file mode 100644 index 000000000..85b74e2f4 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -0,0 +1,242 @@ +// Copyright (c) Microsoft. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading +{ + using System; + using System.Collections.Generic; + + /// + /// A collection optimized for usually small number of elements, and items are rarely removed. + /// Note: this implementation is not thread-safe. It must be protected to prevent race conditions. + /// + /// The type of elements to be stored. + internal struct RarelyRemoveItemSet + where T : class + { + private const int MaxExpansionSize = 16 * 1024; + + /// + /// The single value or array of values stored by this collection. Null if empty. + /// + private object? value; + + /// + /// The number of items. + /// + private int count; + + /// + /// Adds an element to the collection. + /// + public void Add(T value) + { + if (this.value is T[] valueArray) + { + if (valueArray.Length > this.count) + { + valueArray[this.count] = value; + } + else + { + int nextSize = valueArray.Length > MaxExpansionSize ? (valueArray.Length + MaxExpansionSize) : valueArray.Length * 2; + + Array.Resize(ref valueArray, nextSize); + valueArray[this.count] = value; + this.value = valueArray; + } + } + else + { + if (this.count == 0) + { + this.value = value; + } + else + { + Assumes.Equals(1, this.count); + valueArray = new T[2] { (T)this.value!, value }; + this.value = valueArray; + } + } + + this.count++; + } + + /// + /// Removes an element from the collection. + /// + public void Remove(T value) + { + if (this.count == 0) + { + return; + } + + if (this.value is T[] valueArray) + { + for (int i = 0; i < this.count; i++) + { + if (valueArray[i] == value) + { + // found matched item + --this.count; + + if (i < this.count) + { + valueArray[i] = valueArray[this.count]; + } + + // prevent holding reference + valueArray[this.count] = null!; + } + } + } + else if (this.value == value) + { + this.value = null; + this.count = 0; + } + } + + /// + /// Gets the result out of the current list, and reset it to empty. + /// + public Enumerable EnumerateAndClear() + { + var copy = new Enumerable(this.value, this.count); + + this.value = null; + this.count = 0; + + return copy; + } + + /// + /// Make a thread safe copy of the content of this list. + /// + public T[] ToArray() + { + if (this.count == 0) + { + return Array.Empty(); + } + + var results = new T[this.count]; + if (this.value is T[] valueArray) + { + Array.Copy(valueArray, results, this.count); + } + else + { + results[0] = (T)this.value!; + } + + return results; + } + + public struct Enumerable + { + private readonly object? value; + + /// + /// The number of items. + /// + private readonly int count; + + public Enumerable(object? value, int count) + { + this.value = value; + this.count = count; + } + + /// + /// Returns an enumerator for a current snapshot of the collection. + /// + public Enumerator GetEnumerator() + { + return new Enumerator(this.value, this.count); + } + } + + public struct Enumerator : IEnumerator + { + private const int IndexBeforeFirstArrayElement = -1; + private const int IndexSingleElement = -2; + private const int IndexBeforeSingleElement = -3; + + private readonly object? enumeratedValue; + private readonly int count; + + private int currentIndex; + + internal Enumerator(object? enumeratedValue, int count) + { + this.enumeratedValue = enumeratedValue; + this.count = count; + this.currentIndex = 0; + this.Reset(); + } + + public T Current + { + get + { + if (this.currentIndex == IndexBeforeFirstArrayElement || this.currentIndex == IndexBeforeSingleElement) + { + throw new InvalidOperationException(); + } + + // enumeratedValue cannot be null here following a call to `MoveNext` that returns true (required + // for correct usage of IEnumerator). + return this.currentIndex == IndexSingleElement + ? (T)this.enumeratedValue! + : ((T[])this.enumeratedValue!)[this.currentIndex]; + } + } + + object System.Collections.IEnumerator.Current + { + get { return this.Current; } + } + + public void Dispose() + { + } + + public bool MoveNext() + { + if (this.currentIndex == IndexBeforeSingleElement && this.count > 0) + { + this.currentIndex = IndexSingleElement; + return true; + } + + if (this.currentIndex == IndexSingleElement) + { + return false; + } + + if (this.currentIndex == IndexBeforeFirstArrayElement) + { + this.currentIndex = 0; + return true; + } + + var array = (T[]?)this.enumeratedValue; + if (this.currentIndex >= 0 && this.currentIndex < this.count) + { + this.currentIndex++; + return this.currentIndex < this.count; + } + + return false; + } + + public void Reset() + { + this.currentIndex = this.enumeratedValue is T[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; + } + } + } +} From e90ad8ead100fc0dd2a824cc8485497d3c72b27a Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sat, 9 Apr 2022 12:06:20 -0700 Subject: [PATCH 0439/1753] Add unit test coverage. They were copied from tests for ListOfOftenOne to ensure new data structure to work in the similar way. --- ...rosoft.VisualStudio.Threading.Tests.csproj | 3 + .../RarelyRemoveItemSetTests.cs | 141 ++++++++++++++++++ 2 files changed, 144 insertions(+) create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 399ebb05b..5e68dbe5a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -19,6 +19,9 @@ ListOfOftenOne`1.cs + + RarelyRemoveItemSet`1.cs + WeakKeyDictionary`2.cs diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs new file mode 100644 index 000000000..3f15f96f4 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -0,0 +1,141 @@ +// Copyright (c) Microsoft. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System.Linq; +using Microsoft.VisualStudio.Threading; +using Xunit; +using Xunit.Abstractions; + +public class RarelyRemoveItemSetTests : TestBase +{ + private RarelyRemoveItemSet list; + + public RarelyRemoveItemSetTests(ITestOutputHelper logger) + : base(logger) + { + this.list = default(RarelyRemoveItemSet); + } + + [Fact] + public void EnumerationOfEmpty() + { + using (RarelyRemoveItemSet.Enumerator enumerator = this.list.EnumerateAndClear().GetEnumerator()) + { + Assert.False(enumerator.MoveNext()); + enumerator.Reset(); + Assert.False(enumerator.MoveNext()); + } + } + + [Fact] + public void EnumerationOfOne() + { + this.list.Add(new GenericParameterHelper(1)); + using (RarelyRemoveItemSet.Enumerator enumerator = this.list.EnumerateAndClear().GetEnumerator()) + { + Assert.True(enumerator.MoveNext()); + Assert.Equal(1, enumerator.Current.Data); + Assert.False(enumerator.MoveNext()); + enumerator.Reset(); + Assert.True(enumerator.MoveNext()); + Assert.Equal(1, enumerator.Current.Data); + Assert.False(enumerator.MoveNext()); + } + } + + [Fact] + public void EnumerationOfTwo() + { + this.list.Add(new GenericParameterHelper(1)); + this.list.Add(new GenericParameterHelper(2)); + using (RarelyRemoveItemSet.Enumerator enumerator = this.list.EnumerateAndClear().GetEnumerator()) + { + Assert.True(enumerator.MoveNext()); + Assert.Equal(1, enumerator.Current.Data); + Assert.True(enumerator.MoveNext()); + Assert.Equal(2, enumerator.Current.Data); + Assert.False(enumerator.MoveNext()); + enumerator.Reset(); + Assert.True(enumerator.MoveNext()); + Assert.Equal(1, enumerator.Current.Data); + Assert.True(enumerator.MoveNext()); + Assert.Equal(2, enumerator.Current.Data); + Assert.False(enumerator.MoveNext()); + } + } + + [Fact] + public void RemoveFromEmpty() + { + this.list.Remove(null!); + Assert.Empty(this.list.ToArray()); + this.list.Remove(new GenericParameterHelper(5)); + Assert.Empty(this.list.ToArray()); + } + + [Fact] + public void RemoveFromOne() + { + var value = new GenericParameterHelper(1); + this.list.Add(value); + + this.list.Remove(null!); + Assert.Single(this.list.ToArray()); + this.list.Remove(new GenericParameterHelper(5)); + Assert.Single(this.list.ToArray()); + this.list.Remove(value); + Assert.Empty(this.list.ToArray()); + } + + [Fact] + public void RemoveFromTwoLIFO() + { + var value1 = new GenericParameterHelper(1); + var value2 = new GenericParameterHelper(2); + this.list.Add(value1); + this.list.Add(value2); + + this.list.Remove(null!); + Assert.Equal(2, this.list.ToArray().Length); + this.list.Remove(new GenericParameterHelper(5)); + Assert.Equal(2, this.list.ToArray().Length); + this.list.Remove(value2); + Assert.Single(this.list.ToArray()); + Assert.Equal(1, this.list.ToArray()[0].Data); + this.list.Remove(value1); + Assert.Empty(this.list.ToArray()); + } + + [Fact] + public void RemoveFromTwoFIFO() + { + var value1 = new GenericParameterHelper(1); + var value2 = new GenericParameterHelper(2); + this.list.Add(value1); + this.list.Add(value2); + + this.list.Remove(null!); + Assert.Equal(2, this.list.ToArray().Length); + this.list.Remove(new GenericParameterHelper(5)); + Assert.Equal(2, this.list.ToArray().Length); + this.list.Remove(value1); + Assert.Single(this.list.ToArray()); + Assert.Equal(2, this.list.ToArray()[0].Data); + this.list.Remove(value2); + Assert.Empty(this.list.ToArray()); + } + + [Fact] + public void EnumerateAndClear() + { + this.list.Add(new GenericParameterHelper(1)); + + using (RarelyRemoveItemSet.Enumerator enumerator = this.list.EnumerateAndClear().GetEnumerator()) + { + Assert.Empty(this.list.ToArray()); // The collection should have been cleared. + Assert.True(enumerator.MoveNext()); + Assert.Equal(1, enumerator.Current.Data); + Assert.False(enumerator.MoveNext()); + } + } +} From 9d0b31316dbb66265441a80686c63dc7b1d45351 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 10 Apr 2022 09:19:59 -0600 Subject: [PATCH 0440/1753] Use appropriate slash for the agent OS Fixes #150 --- azure-pipelines/publish-deployables.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index f8c1dfc9d..9ccdc29e2 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -3,6 +3,6 @@ steps: displayName: Download deployables artifact: deployables-Windows -- script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/*.nupkg -s $(ci_feed) -k azdo --skip-duplicate +- powershell: dotnet nuget push "$(Resolve-Path '$(Pipeline.Workspace)\deployables-Windows\')*.nupkg" -s $(ci_feed) -k azdo --skip-duplicate displayName: Push packages to CI feed condition: and(succeeded(), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) From f7881a5334a22ba3aee6601d8c27da9ac219409a Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sun, 10 Apr 2022 16:57:52 -0700 Subject: [PATCH 0441/1753] Optimize for common condition & break loop after removing. --- .../RarelyRemoveItemSet`1.cs | 63 ++++++++++--------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index 85b74e2f4..e4e7e7d6f 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -89,6 +89,7 @@ public void Remove(T value) // prevent holding reference valueArray[this.count] = null!; + break; } } } @@ -135,7 +136,7 @@ public T[] ToArray() return results; } - public struct Enumerable + public readonly struct Enumerable { private readonly object? value; @@ -182,23 +183,20 @@ public T Current { get { - if (this.currentIndex == IndexBeforeFirstArrayElement || this.currentIndex == IndexBeforeSingleElement) + if (this.currentIndex >= 0 && this.currentIndex < this.count) { - throw new InvalidOperationException(); + return ((T[])this.enumeratedValue!)[this.currentIndex]; + } + else if (this.currentIndex == IndexSingleElement) + { + return (T)this.enumeratedValue!; } - // enumeratedValue cannot be null here following a call to `MoveNext` that returns true (required - // for correct usage of IEnumerator). - return this.currentIndex == IndexSingleElement - ? (T)this.enumeratedValue! - : ((T[])this.enumeratedValue!)[this.currentIndex]; + throw new InvalidOperationException(); } } - object System.Collections.IEnumerator.Current - { - get { return this.Current; } - } + object System.Collections.IEnumerator.Current => this.Current; public void Dispose() { @@ -206,28 +204,31 @@ public void Dispose() public bool MoveNext() { - if (this.currentIndex == IndexBeforeSingleElement && this.count > 0) - { - this.currentIndex = IndexSingleElement; - return true; - } - - if (this.currentIndex == IndexSingleElement) - { - return false; - } - - if (this.currentIndex == IndexBeforeFirstArrayElement) + if (this.currentIndex >= 0) { - this.currentIndex = 0; - return true; + if (this.currentIndex < this.count) + { + this.currentIndex++; + return this.currentIndex < this.count; + } } - - var array = (T[]?)this.enumeratedValue; - if (this.currentIndex >= 0 && this.currentIndex < this.count) + else { - this.currentIndex++; - return this.currentIndex < this.count; + switch (this.currentIndex) + { + case IndexBeforeSingleElement: + if (this.count > 0) + { + this.currentIndex = IndexSingleElement; + return true; + } + + break; + + case IndexBeforeFirstArrayElement: + this.currentIndex = 0; + return true; + } } return false; From 2467f8b2c25b3f648344b76417d9ddf086e8ac4d Mon Sep 17 00:00:00 2001 From: Asaf Agami Date: Mon, 11 Apr 2022 16:31:42 +0300 Subject: [PATCH 0442/1753] Update VSTHRD100.md There has been previous discussion about whether async void event handlers should raise VSTHRD100 warnings, and the recommended approach in previous issues is to avoid async void for event handlers and use RunAsync instead. The documentation for VSTHRD100 doesn't address the event handler edge case, and refers to an article that recommends using async void for event handlers. This change addresses it. This code example has been suggested in this issue: https://github.com/microsoft/vs-threading/issues/447#issuecomment-481068451 --- doc/analyzers/VSTHRD100.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/analyzers/VSTHRD100.md b/doc/analyzers/VSTHRD100.md index 837405d0c..771a606ef 100644 --- a/doc/analyzers/VSTHRD100.md +++ b/doc/analyzers/VSTHRD100.md @@ -26,4 +26,15 @@ async Task DoSomethingAsync() A code fix is offered that automatically changes the return type of the method. +For event handlers, avoid `async void` by using `RunAsync`: +```csharp +obj.Event += (s, e) => joinableTaskFactory.RunAsync(() => OnEventAsync(s, e)); +} + +private async Task OnEventAsync(object sender, EventArgs e) +{ + // async code here. +} +``` + Refer to [Async/Await - Best Practices in Asynchronous Programming](https://msdn.microsoft.com/en-us/magazine/jj991977.aspx) for more info. From 3f11fb5dce7ba03f3753099c1314f15c9bc47b72 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Apr 2022 13:46:40 -0600 Subject: [PATCH 0443/1753] Update devcontainer Dockerfile to match global.json --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index c47acfaa9..234db6d1e 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,4 @@ -FROM mcr.microsoft.com/dotnet/sdk:6.0.100-focal +FROM mcr.microsoft.com/dotnet/sdk:6.0.200-focal # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From e899f99b887eb091e4068958078638fa2bcad9b8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Apr 2022 13:57:10 -0600 Subject: [PATCH 0444/1753] Do not trigger CI on changes to the release or vs-insertion pipeline --- azure-pipelines/official.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index d7b949d33..48ef6cc9b 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -10,6 +10,8 @@ trigger: - doc/ - '*.md' - .vscode/ + - azure-pipelines/release.yml + - azure-pipelines/vs-insertion.yml #schedules: #- cron: "0 3 * * *" # Daily @ 8 PM PST # displayName: Daily vs-insertion From dd60e837b038dc6964181712275085332f5dfd83 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Apr 2022 17:41:52 -0600 Subject: [PATCH 0445/1753] Remove explicit Microsoft.NETFramework.ReferenceAssemblies PackageReference --- Directory.Build.props | 1 - 1 file changed, 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index e70a74bb2..ecb971a7d 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -36,7 +36,6 @@ - From 885c8ec6e85fb70460a35cad77e1a46934567135 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Apr 2022 06:02:02 -0600 Subject: [PATCH 0446/1753] Turn off SBOM signing It times out too frequently. --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 48ef6cc9b..b13d2e1de 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -46,7 +46,7 @@ stages: BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} - Packaging.EnableSBOMSigning: true + Packaging.EnableSBOMSigning: false jobs: - template: build.yml From 09516ca14922aadc4474d3f2e05cdef8a168dd75 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Apr 2022 06:18:04 -0600 Subject: [PATCH 0447/1753] Tolerate trx files with test run failures --- azure-pipelines/dotnet-test-cloud.ps1 | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 7d5a4350a..877f11ed3 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -26,16 +26,20 @@ Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { if ($PublishResults) { $x = [xml](Get-Content -Path $_) - $storage = $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')[0].storage -replace '\\','/' - if ($storage -match '/(?net[^/]+)/(?:(?[^/]+)/)?(?[^/]+)\.dll$') { + $runTitle = $null + if ($x.TestRun.TestDefinitions -and $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')) { + $storage = $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')[0].storage -replace '\\','/' + if ($storage -match '/(?net[^/]+)/(?:(?[^/]+)/)?(?[^/]+)\.dll$') { if ($matches.rid) { $runTitle = "$($matches.lib) ($($matches.tfm), $($matches.rid), $Agent)" } else { $runTitle = "$($matches.lib) ($($matches.tfm), $Agent)" } - } else { - $unknownCounter += 1; - $runTitle = "unknown$unknownCounter ($Agent)"; + } + } + if (!$runTitle) { + $unknownCounter += 1; + $runTitle = "unknown$unknownCounter ($Agent)"; } Write-Host "##vso[results.publish type=VSTest;runTitle=$runTitle;publishRunAttachments=true;resultFiles=$_;failTaskOnFailedTests=true;testRunSystem=VSTS - PTR;]" From 0974832515527b2a46a2aaeb05e9e8339621ac88 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Apr 2022 06:52:57 -0600 Subject: [PATCH 0448/1753] Skip tests in optprof runs --- azure-pipelines/dotnet.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index b4b0828c6..1231260c4 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -14,6 +14,7 @@ steps: - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults displayName: dotnet test + condition: and(succeeded(), ne(variables['OptProf'], 'true')) # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertConfigValues.ps1 to notice. - powershell: azure-pipelines\artifacts\VSInsertion.ps1 From 33e19c8934b26a2508f79353a5c20ba259a9dcac Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Apr 2022 08:29:59 -0600 Subject: [PATCH 0449/1753] Improve pipeline verbosity --- azure-pipelines/Convert-PDB.ps1 | 57 +++++++++++------------ azure-pipelines/artifacts/VSInsertion.ps1 | 17 ++++++- azure-pipelines/microbuild.after.yml | 2 +- 3 files changed, 44 insertions(+), 32 deletions(-) diff --git a/azure-pipelines/Convert-PDB.ps1 b/azure-pipelines/Convert-PDB.ps1 index 2d394e72d..f119a164e 100644 --- a/azure-pipelines/Convert-PDB.ps1 +++ b/azure-pipelines/Convert-PDB.ps1 @@ -8,36 +8,35 @@ .PARAMETER OutputPath The path of the output PDB to write. #> -#Function Convert-PortableToWindowsPDB() { - Param( - [Parameter(Mandatory=$true,Position=0)] - [string]$DllPath, - [Parameter()] - [string]$PdbPath, - [Parameter(Mandatory=$true,Position=1)] - [string]$OutputPath - ) +[CmdletBinding()] +Param( + [Parameter(Mandatory=$true,Position=0)] + [string]$DllPath, + [Parameter()] + [string]$PdbPath, + [Parameter(Mandatory=$true,Position=1)] + [string]$OutputPath +) - if ($IsMacOS -or $IsLinux) { - Write-Error "This script only works on Windows" - return - } +if ($IsMacOS -or $IsLinux) { + Write-Error "This script only works on Windows" + return +} - $version = '1.1.0-beta2-21101-01' - $baseDir = "$PSScriptRoot/../obj/tools" - $pdb2pdbpath = "$baseDir/Microsoft.DiaSymReader.Pdb2Pdb.$version/tools/Pdb2Pdb.exe" - if (-not (Test-Path $pdb2pdbpath)) { - if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } - $baseDir = (Resolve-Path $baseDir).Path # Normalize it - Write-Verbose "& (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null" - & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null - } +$version = '1.1.0-beta2-21101-01' +$baseDir = "$PSScriptRoot/../obj/tools" +$pdb2pdbpath = "$baseDir/Microsoft.DiaSymReader.Pdb2Pdb.$version/tools/Pdb2Pdb.exe" +if (-not (Test-Path $pdb2pdbpath)) { + if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } + $baseDir = (Resolve-Path $baseDir).Path # Normalize it + Write-Verbose "& (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null" + & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null +} - $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' - if ($PdbPath) { - $args += '/pdb',$PdbPath - } +$args = $DllPath,'/out',$OutputPath,'/nowarn','0021' +if ($PdbPath) { + $args += '/pdb',$PdbPath +} - Write-Verbose "$pdb2pdbpath $args" - & $pdb2pdbpath $args -#} +Write-Verbose "$pdb2pdbpath $args" +& $pdb2pdbpath $args diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 4c56deabe..0d1cb3739 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -4,10 +4,17 @@ .PARAMETER SbomNotRequired Indicates that returning the artifacts available is preferable to nothing at all when the SBOM has not yet been generated. #> +[CmdletBinding()] Param ( [switch]$SbomNotRequired ) +if ($IsMacOS -or $IsLinux) { + # We only package up for insertions on Windows agents since they are where optprof can happen. + Write-Verbose "Skipping VSInsertion artifact since we're not on Windows." + return @{} +} + $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") $BuildConfiguration = $env:BUILDCONFIGURATION if (!$BuildConfiguration) { @@ -17,9 +24,15 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" # This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $PackagesRoot/_manifest) -and -not $SbomNotRequired) { return @{} } +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $PackagesRoot/_manifest) -and -not $SbomNotRequired) { + Write-Host "Skipping because SBOM isn't generated yet." + return @{} +} -if (!(Test-Path $PackagesRoot)) { return @{} } +if (!(Test-Path $PackagesRoot)) { + Write-Warning "Skipping because packages haven't been built yet." + return @{} +} @{ "$PackagesRoot" = (Get-ChildItem $PackagesRoot -Recurse) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index e889a464d..876348085 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -19,7 +19,7 @@ steps: BuildDropPath: $(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration) BuildComponentPath: $(System.DefaultWorkingDirectory)/obj/src/Library -- powershell: Copy-Item -Recurse "$(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration)/_manifest" "$(System.DefaultWorkingDirectory)/bin/Packages/$(BuildConfiguration)/NuGet" +- powershell: Copy-Item -Recurse -Verbose "$(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration)/_manifest" "$(System.DefaultWorkingDirectory)/bin/Packages/$(BuildConfiguration)/NuGet" displayName: Publish Software Bill of Materials - task: Ref12Analyze@0 From e21c1c1653f89510c77fc4f077d4fb4c2acc333a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Apr 2022 08:30:10 -0600 Subject: [PATCH 0450/1753] Improve pipeline verbosity --- azure-pipelines/artifacts/_stage_all.ps1 | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index 87421d56a..e4954c131 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -1,7 +1,7 @@ # This script links all the artifacts described by _all.ps1 # into a staging directory, reading for uploading to a cloud build artifact store. # It returns a sequence of objects with Name and Path properties. - +[CmdletBinding()] param ( [string]$ArtifactNameSuffix ) @@ -21,7 +21,6 @@ function Create-SymbolicLink { if (Test-Path $Link) { Remove-Item $Link } $LinkContainer = Split-Path $Link -Parent if (!(Test-Path $LinkContainer)) { mkdir $LinkContainer } - Write-Verbose "Linking $Link to $Target" if ($IsMacOS -or $IsLinux) { ln $Target $Link | Out-Null } else { From 00eb19d63f25b7da7f6b950bf277def5858fcd37 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Apr 2022 09:05:26 -0600 Subject: [PATCH 0451/1753] Fix VSInsertion artifact collection --- azure-pipelines/artifacts/VSInsertion.ps1 | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index edfcc2e5d..b3b4661b6 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -21,16 +21,11 @@ if (!$BuildConfiguration) { $BuildConfiguration = 'Debug' } -$NuGetPackages = "$RepoRoot\bin\Packages\$config\NuGet" -$CoreXTPackages = "$RepoRoot\bin\Packages\$config\CoreXT" -# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $NuGetPackages/_manifest) -and -not $SbomNotRequired) { - Write-Host "Skipping because SBOM isn't generated yet." - return @{} -} +$NuGetPackages = "$RepoRoot\bin\Packages\$BuildConfiguration\NuGet" +$CoreXTPackages = "$RepoRoot\bin\Packages\$BuildConfiguration\CoreXT" if (!(Test-Path $NuGetPackages)) { - Write-Warning "Skipping because packages haven't been built yet." + Write-Warning "Skipping because NuGet packages haven't been built yet." return @{} } @@ -57,6 +52,12 @@ if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } +# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $NuGetPackages/_manifest) -and -not $SbomNotRequired) { + Write-Host "Skipping because SBOM isn't generated yet." + return @{} +} + @{ "$NuGetPackages" = (Get-ChildItem $NuGetPackages -Recurse) "$CoreXTPackages" = (Get-ChildItem "$CoreXTPackages\Microsoft.VisualStudio.Threading.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); From 57e0cb27d9382f7a63033069c44ae8503bf0686a Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 13 Apr 2022 10:09:14 -0700 Subject: [PATCH 0452/1753] Address code review feedbacks comments/nullable changes/etc... --- .../RarelyRemoveItemSet`1.cs | 82 ++++++++++--------- 1 file changed, 42 insertions(+), 40 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index e4e7e7d6f..fb5ea5d3e 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -12,12 +12,12 @@ namespace Microsoft.VisualStudio.Threading /// /// The type of elements to be stored. internal struct RarelyRemoveItemSet - where T : class + where T : class? { private const int MaxExpansionSize = 16 * 1024; /// - /// The single value or array of values stored by this collection. Null if empty. + /// The single value or array of values stored by this collection. /// private object? value; @@ -29,9 +29,9 @@ internal struct RarelyRemoveItemSet /// /// Adds an element to the collection. /// - public void Add(T value) + internal void Add(T value) { - if (this.value is T[] valueArray) + if (this.value is T?[] valueArray) { if (valueArray.Length > this.count) { @@ -54,8 +54,8 @@ public void Add(T value) } else { - Assumes.Equals(1, this.count); - valueArray = new T[2] { (T)this.value!, value }; + Assumes.True(this.count == 1); + valueArray = new T?[2] { (T?)this.value, value }; this.value = valueArray; } } @@ -66,14 +66,14 @@ public void Add(T value) /// /// Removes an element from the collection. /// - public void Remove(T value) + internal void Remove(T value) { if (this.count == 0) { return; } - if (this.value is T[] valueArray) + if (this.value is T?[] valueArray) { for (int i = 0; i < this.count; i++) { @@ -84,11 +84,13 @@ public void Remove(T value) if (i < this.count) { + // if the item removed was not the latest item in the array, we move the latest item in the original array there to fill the hole. + // After that, we reduce the size of the array by 1. (This eliminates extra work to move more than one item during Remove.) valueArray[i] = valueArray[this.count]; } // prevent holding reference - valueArray[this.count] = null!; + valueArray[this.count] = null; break; } } @@ -103,7 +105,7 @@ public void Remove(T value) /// /// Gets the result out of the current list, and reset it to empty. /// - public Enumerable EnumerateAndClear() + internal Enumerable EnumerateAndClear() { var copy = new Enumerable(this.value, this.count); @@ -116,50 +118,26 @@ public Enumerable EnumerateAndClear() /// /// Make a thread safe copy of the content of this list. /// - public T[] ToArray() + internal T?[] ToArray() { if (this.count == 0) { return Array.Empty(); } - var results = new T[this.count]; - if (this.value is T[] valueArray) + var results = new T?[this.count]; + if (this.value is T?[] valueArray) { Array.Copy(valueArray, results, this.count); } else { - results[0] = (T)this.value!; + results[0] = (T?)this.value; } return results; } - public readonly struct Enumerable - { - private readonly object? value; - - /// - /// The number of items. - /// - private readonly int count; - - public Enumerable(object? value, int count) - { - this.value = value; - this.count = count; - } - - /// - /// Returns an enumerator for a current snapshot of the collection. - /// - public Enumerator GetEnumerator() - { - return new Enumerator(this.value, this.count); - } - } - public struct Enumerator : IEnumerator { private const int IndexBeforeFirstArrayElement = -1; @@ -196,7 +174,7 @@ public T Current } } - object System.Collections.IEnumerator.Current => this.Current; + object? System.Collections.IEnumerator.Current => this.Current; public void Dispose() { @@ -236,7 +214,31 @@ public bool MoveNext() public void Reset() { - this.currentIndex = this.enumeratedValue is T[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; + this.currentIndex = this.enumeratedValue is T?[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; + } + } + + internal readonly struct Enumerable + { + private readonly object? value; + + /// + /// The number of items. + /// + private readonly int count; + + internal Enumerable(object? value, int count) + { + this.value = value; + this.count = count; + } + + /// + /// Returns an enumerator for a current snapshot of the collection. + /// + public Enumerator GetEnumerator() + { + return new Enumerator(this.value, this.count); } } } From a26e5577739cc85eb79c3c6fe61af952b04fdecb Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 13 Apr 2022 10:34:12 -0700 Subject: [PATCH 0453/1753] Add unit test to cover remove a middle item. --- .../RarelyRemoveItemSet`1.cs | 6 ++--- .../RarelyRemoveItemSetTests.cs | 26 ++++++++++++++++++- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index fb5ea5d3e..dab3476af 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -118,21 +118,21 @@ internal Enumerable EnumerateAndClear() /// /// Make a thread safe copy of the content of this list. /// - internal T?[] ToArray() + internal T[] ToArray() { if (this.count == 0) { return Array.Empty(); } - var results = new T?[this.count]; + var results = new T[this.count]; if (this.value is T?[] valueArray) { Array.Copy(valueArray, results, this.count); } else { - results[0] = (T?)this.value; + results[0] = (T)this.value!; } return results; diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs index 3f15f96f4..ec3403352 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Linq; using Microsoft.VisualStudio.Threading; using Xunit; using Xunit.Abstractions; @@ -125,6 +124,31 @@ public void RemoveFromTwoFIFO() Assert.Empty(this.list.ToArray()); } + [Fact] + public void RemoveFromMultiple() + { + var values = new GenericParameterHelper[5]; + for (int i = 0; i < 5; i++) + { + values[i] = new GenericParameterHelper(i); + this.list.Add(values[i]); + } + + this.list.Remove(values[2]); + Assert.Equal(4, this.list.ToArray().Length); + + this.list.Remove(values[4]); + Assert.Equal(3, this.list.ToArray().Length); + + this.list.Remove(values[0]); + Assert.Equal(2, this.list.ToArray().Length); + + this.list.Remove(values[3]); + Assert.Single(this.list.ToArray()); + + Assert.Equal(1, this.list.ToArray()[0].Data); + } + [Fact] public void EnumerateAndClear() { From 6adb38a64e0669cfc5f7043109c467315a9ae417 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 13 Apr 2022 14:06:18 -0700 Subject: [PATCH 0454/1753] Add a GC test to ensure new list doesn't hold removed values. --- .../RarelyRemoveItemSetTests.cs | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs index ec3403352..68000cce0 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -1,6 +1,8 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Runtime.CompilerServices; using Microsoft.VisualStudio.Threading; using Xunit; using Xunit.Abstractions; @@ -149,6 +151,19 @@ public void RemoveFromMultiple() Assert.Equal(1, this.list.ToArray()[0].Data); } + [Fact] + public void RemoveFromMultipleGCTest() + { + WeakReference[]? weakValues = this.RemoveFromMultipleGCTestHelper(); + + GC.Collect(); + + for (int i = 0; i < 5; i++) + { + Assert.False(weakValues[i].IsAlive); + } + } + [Fact] public void EnumerateAndClear() { @@ -162,4 +177,28 @@ public void EnumerateAndClear() Assert.False(enumerator.MoveNext()); } } + + [MethodImpl(MethodImplOptions.NoInlining)] // must not be inlined so that locals are guaranteed to be freed. + private WeakReference[] RemoveFromMultipleGCTestHelper() + { + GenericParameterHelper[]? values = new GenericParameterHelper[5]; + var weakValues = new WeakReference[5]; + + for (int i = 0; i < 5; i++) + { + values[i] = new GenericParameterHelper(i); + weakValues[i] = new WeakReference(values[i]); + this.list.Add(values[i]); + } + + this.list.Remove(values[4]); + this.list.Remove(values[1]); + this.list.Remove(values[3]); + this.list.Remove(values[0]); + this.list.Remove(values[2]); + + Assert.Empty(this.list.ToArray()); + + return weakValues; + } } From 49423974b3140f5dc6a22ac2777e83ce1d38bd48 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 13 Apr 2022 18:59:46 -0700 Subject: [PATCH 0455/1753] Add a comment. --- .../RarelyRemoveItemSetTests.cs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs index 68000cce0..e8b1cc27a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -151,6 +151,9 @@ public void RemoveFromMultiple() Assert.Equal(1, this.list.ToArray()[0].Data); } + /// + /// Test to make sure the list does not reference deleted items. + /// [Fact] public void RemoveFromMultipleGCTest() { From 20075b620328906e87320b6082cf73803ff84873 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Apr 2022 06:15:59 -0600 Subject: [PATCH 0456/1753] Appease StyleCop change --- src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs | 2 +- .../RarelyRemoveItemSetTests.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index dab3476af..7c9058c73 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -1,4 +1,4 @@ -// Copyright (c) Microsoft. All rights reserved. +// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. namespace Microsoft.VisualStudio.Threading diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs index e8b1cc27a..325150b28 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -1,4 +1,4 @@ -// Copyright (c) Microsoft. All rights reserved. +// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; From 003976f3ce49bc842fe2b0463996607c364176c8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Apr 2022 06:41:56 -0600 Subject: [PATCH 0457/1753] Added a few more assertions to a removal test --- .../RarelyRemoveItemSet`1.cs | 2 +- .../RarelyRemoveItemSetTests.cs | 11 ++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index 7c9058c73..ac539d0e6 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -138,7 +138,7 @@ internal T[] ToArray() return results; } - public struct Enumerator : IEnumerator + internal struct Enumerator : IEnumerator { private const int IndexBeforeFirstArrayElement = -1; private const int IndexSingleElement = -2; diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs index 325150b28..54bd926a0 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -2,6 +2,7 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; +using System.Linq; using System.Runtime.CompilerServices; using Microsoft.VisualStudio.Threading; using Xunit; @@ -138,17 +139,25 @@ public void RemoveFromMultiple() this.list.Remove(values[2]); Assert.Equal(4, this.list.ToArray().Length); + AssertContains(0, 1, 3, 4); this.list.Remove(values[4]); Assert.Equal(3, this.list.ToArray().Length); + AssertContains(0, 1, 3); this.list.Remove(values[0]); Assert.Equal(2, this.list.ToArray().Length); + AssertContains(1, 3); this.list.Remove(values[3]); Assert.Single(this.list.ToArray()); + AssertContains(1); - Assert.Equal(1, this.list.ToArray()[0].Data); + void AssertContains(params int[] values) + { + // We specifically do not care about order of elements. + Assert.Equal(values.OrderBy(k => k), this.list.ToArray().Select(v => v.Data).OrderBy(k => k)); + } } /// From 0ac22f889f6d001ba5e2e9b6a2ccecb6f393bc84 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Apr 2022 07:01:18 -0600 Subject: [PATCH 0458/1753] Document how to create a merge commit in a Library.Template based repo --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 22d1091ef..0f9715f38 100644 --- a/README.md +++ b/README.md @@ -36,3 +36,48 @@ Further customize your repo by: 1. Verify the license is suitable for your goal as it appears in the LICENSE and stylecop.json files and the Directory.Build.props file's `PackageLicenseExpression` property. 1. Reset or replace the badges at the top of this file. + +### Maintaining your repo based on this template + +The best way to keep your repo in sync with this template's evolving features and best practices is to periodically merge the template into your repo: + +```ps1 +git checkout main # your default branch +git pull # make sure you're at tip +git fetch libtemplate # fetch latest Library.Template +git merge libtemplate/main +``` + +There will frequently be merge conflicts to work out, but they will be easier to resolve than running the `Apply-Template.ps1` script every time, which simply blows away all your local changes with the latest from the template. + +If you do not already have Library.Template history in your repo or have never completed a merge before, the above steps may produce errors. +To get it working the first time, follow these steps: + +```ps1 +git remote add libtemplate https://github.com/AArnott/Library.Template.git +git fetch libtemplate +``` + +If the `git merge` step described earlier still fails for you, you may need to artificially create your first merge. +First, you must have a local clone of Library.Template on your box: + +```ps1 +git clone https://github.com/AArnott/Library.Template.git +``` + +Make sure you have either `main` checked out in that clone, as appropriate to match. +Use `git rev-parse HEAD` within the Library.Template repo and record the resulting commit as we'll use it later. + +Run the `Apply-Template.ps1` script, passing in the path to your own Library.Template-based repo. This will blow away most customizations you may have made to your repo's build authoring. You should *carefully* review all changes to your repo, staging those changes that you want to keep and reverting those that remove customizations you made. + +Now it's time to commit your changes. We do this in a very low-level way in order to have git record this as a *merge* commit even though it didn't start as a merge. +By doing this, git will allow future merges from `libtemplate/main` and only new changes will be brought down, which will be much easier than the `Apply-Template.ps1` script you just ran. +We create the merge commit with these commands: + +1. Be sure to have staged or reverted all the changes in your repo. +1. Run `git write-tree` within your repo. This will print out a git tree hash. +1. Run `git commit-tree -p HEAD -p A B -m "Merged latest Library.Template"`, where `A` is the output from `git rev-parse HEAD` that you recorded earlier, and `B` is the output from your prior `git write-tree` command. +1. Run `git merge X` where `X` is the output of the `git commit-tree` command. + +Congratulations. You're all done. +Next time you want to sync to latest from Library.Template, you can the simple `git merge` steps given at the start of this section. From cbdabad295480b1844ad94a9ae64ac86d6b5a8a9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Apr 2022 07:09:32 -0600 Subject: [PATCH 0459/1753] Customize documented steps for microbuild branch --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a80b7b2db..cd9a4d2f8 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ The best way to keep your repo in sync with this template's evolving features an git checkout main # your default branch git pull # make sure you're at tip git fetch libtemplate # fetch latest Library.Template -git merge libtemplate/main +git merge libtemplate/microbuild ``` There will frequently be merge conflicts to work out, but they will be easier to resolve than running the `Apply-Template.ps1` script every time, which simply blows away all your local changes with the latest from the template. @@ -74,7 +74,7 @@ Use `git rev-parse HEAD` within the Library.Template repo and record the resulti Run the `Apply-Template.ps1` script, passing in the path to your own Library.Template-based repo. This will blow away most customizations you may have made to your repo's build authoring. You should *carefully* review all changes to your repo, staging those changes that you want to keep and reverting those that remove customizations you made. Now it's time to commit your changes. We do this in a very low-level way in order to have git record this as a *merge* commit even though it didn't start as a merge. -By doing this, git will allow future merges from `libtemplate/main` and only new changes will be brought down, which will be much easier than the `Apply-Template.ps1` script you just ran. +By doing this, git will allow future merges from `libtemplate/microbuild` and only new changes will be brought down, which will be much easier than the `Apply-Template.ps1` script you just ran. We create the merge commit with these commands: 1. Be sure to have staged or reverted all the changes in your repo. From 19515d7ca90ca669fa4c874af46977b7a3ebd6aa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 14 Apr 2022 09:36:30 -0600 Subject: [PATCH 0460/1753] Protect against misapplication of the Apply-Template script --- Apply-Template.ps1 | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/Apply-Template.ps1 b/Apply-Template.ps1 index 0d3f3d8e2..d659670b3 100644 --- a/Apply-Template.ps1 +++ b/Apply-Template.ps1 @@ -15,6 +15,20 @@ Param( [string]$Path ) +Push-Location $Path +try { + # Look for our own initial commit in the target repo's history. + # If it's there, they've already switched to using git merge to freshen up. + # Using Apply-Template would just complicate future merges, so block it. + git log 05f49ce799c1f9cc696d53eea89699d80f59f833 ^HEAD | Out-Null + if ($LASTEXITCODE -eq 0) { + Write-Error 'The target repo already has Library.Template history merged into it. Use `git merge` instead of this script to freshen your repo. See the README.md file for details.' + exit 1 + } +} finally { + Pop-Location +} + Write-Host "Updating $Path" robocopy /mir $PSScriptRoot/azure-pipelines $Path/azure-pipelines robocopy /mir $PSScriptRoot/.devcontainer $Path/.devcontainer From 86a18ec2dd3772eefd6ef5d35ad2520382fe8d9c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 23 Apr 2022 10:02:34 -0600 Subject: [PATCH 0461/1753] Ignore .lutconfig files --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 716456084..65f947769 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ *.user *.userosscache *.sln.docstates +*.lutconfig launchSettings.json # User-specific files (MonoDevelop/Xamarin Studio) From b656d1058f82d10de8e43e1c49f151f7ff4e3f88 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Apr 2022 15:57:11 -0600 Subject: [PATCH 0462/1753] Clarify nuget push task --- azure-pipelines/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 437ee65bb..6690cccfa 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -55,5 +55,5 @@ jobs: { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } ] - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate - displayName: Push nuget packages + displayName: Push packages to nuget.org condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) From f39d7fc74bcd8b2625670bd68e0053b37b400d74 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 1 May 2022 14:35:13 -0600 Subject: [PATCH 0463/1753] Test on .NET 6 instead of .NET 5 .NET 5 falls out of Microsoft support in just a few days, so folks should focus testing on the currently supported platforms. --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 077d8d8f9..201086455 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -1,7 +1,7 @@ - net5.0;netcoreapp3.1;net472 + net6.0;netcoreapp3.1;net472 From 16d65511f7f92d18eb9dfb19fd40388e86e7a514 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 1 May 2022 15:59:52 -0600 Subject: [PATCH 0464/1753] Skip CI for release pipeline changes Also remove extra slash in snk path --- Directory.Build.props | 2 +- azure-pipelines.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index ecb971a7d..834e74573 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -23,7 +23,7 @@ embedded true - $(MSBuildThisFileDirectory)\strongname.snk + $(MSBuildThisFileDirectory)strongname.snk COMPANY-PLACEHOLDER COMPANY-PLACEHOLDER diff --git a/azure-pipelines.yml b/azure-pipelines.yml index fe8363a2d..b7d86b455 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -10,6 +10,7 @@ trigger: - '*.md' - .vscode/ - .github/ + - azure-pipelines/release.yml parameters: - name: includeMacOS From e0d4ad51a33eacceb0ef1c20a43f7a8b75c79c9d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 1 May 2022 21:35:19 -0600 Subject: [PATCH 0465/1753] Add support for running 32-bit tests --- azure-pipelines/dotnet-test-cloud.ps1 | 45 ++++++++-- tools/Install-DotNetSdk.ps1 | 124 ++++++++++++++++++++------ 2 files changed, 138 insertions(+), 31 deletions(-) diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 877f11ed3..43cdc3e00 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -1,15 +1,50 @@ #!/usr/bin/env pwsh +<# +.SYNOPSIS + Runs tests as they are run in cloud test runs. +.PARAMETER Configuration + The configuration within which to run tests +.PARAMETER Agent + The name of the agent. This is used in preparing test run titles. +.PARAMETER PublishResults + A switch to publish results to Azure Pipelines. +.PARAMETER x86 + A switch to run the tests in an x86 process. +.PARAMETER dotnet32 + The path to a 32-bit dotnet executable to use. +#> +[CmdletBinding()] Param( [string]$Configuration='Debug', [string]$Agent='Local', - [switch]$PublishResults + [switch]$PublishResults, + [switch]$x86, + [string]$dotnet32 ) $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path $ArtifactStagingFolder = & "$PSScriptRoot/Get-ArtifactsStagingDirectory.ps1" -dotnet test $RepoRoot ` +$dotnet = 'dotnet' +if ($x86) { + $x86RunTitleSuffix = ", x86" + if ($dotnet32) { + $dotnet = $dotnet32 + } else { + $dotnet32Possibilities = "$PSScriptRoot\../obj/tools/x86/.dotnet/dotnet.exe", "$env:AGENT_TOOLSDIRECTORY/x86/dotnet/dotnet.exe", "${env:ProgramFiles(x86)}\dotnet\dotnet.exe" + $dotnet32Matches = $dotnet32Possibilities |? { Test-Path $_ } + if ($dotnet32Matches) { + $dotnet = Resolve-Path @($dotnet32Matches)[0] + Write-Host "Running tests using `"$dotnet`"" -ForegroundColor DarkGray + } else { + Write-Error "Unable to find 32-bit dotnet.exe" + return 1 + } + } +} + +& $dotnet test $RepoRoot ` --no-build ` -c $Configuration ` --filter "TestCategory!=FailsInCloudTest" ` @@ -18,7 +53,7 @@ dotnet test $RepoRoot ` --blame-crash ` -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` --diag "$ArtifactStagingFolder/test_logs/diag.log;TraceLevel=info" ` - --logger trx + --logger trx ` $unknownCounter = 0 Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { @@ -33,13 +68,13 @@ Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { if ($matches.rid) { $runTitle = "$($matches.lib) ($($matches.tfm), $($matches.rid), $Agent)" } else { - $runTitle = "$($matches.lib) ($($matches.tfm), $Agent)" + $runTitle = "$($matches.lib) ($($matches.tfm)$x86RunTitleSuffix, $Agent)" } } } if (!$runTitle) { $unknownCounter += 1; - $runTitle = "unknown$unknownCounter ($Agent)"; + $runTitle = "unknown$unknownCounter ($Agent$x86RunTitleSuffix)"; } Write-Host "##vso[results.publish type=VSTest;runTitle=$runTitle;publishRunAttachments=true;resultFiles=$_;failTaskOnFailedTests=true;testRunSystem=VSTS - PTR;]" diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 7dcddc782..76a397f04 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -15,20 +15,28 @@ When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. +.PARAMETER IncludeX86 + Installs a x86 SDK and runtimes in addition to the x64 ones. Only supported on Windows. Ignored on others. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( [ValidateSet('repo','user','machine')] - [string]$InstallLocality='user' + [string]$InstallLocality='user', + [switch]$IncludeX86 ) $DotNetInstallScriptRoot = "$PSScriptRoot/../obj/tools" if (!(Test-Path $DotNetInstallScriptRoot)) { New-Item -ItemType Directory -Path $DotNetInstallScriptRoot -WhatIf:$false | Out-Null } $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot -# Look up actual required .NET Core SDK version from global.json +# Look up actual required .NET SDK version from global.json $sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" +If ($IncludeX86 -and ($IsMacOS -or $IsLinux)) { + Write-Verbose "Ignoring -IncludeX86 switch because 32-bit runtimes are only supported on Windows." + $IncludeX86 = $false +} + $arch = [System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture if (!$arch) { # Windows Powershell leaves this blank $arch = 'x64' @@ -72,7 +80,7 @@ Function Get-FileFromWeb([Uri]$Uri, $OutDir) { $OutFile = Join-Path $OutDir $Uri.Segments[-1] if (!(Test-Path $OutFile)) { Write-Verbose "Downloading $Uri..." - if (!(Test-Path $OutDir)) { mkdir $OutDir } + if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir } try { (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) } finally { @@ -83,7 +91,7 @@ Function Get-FileFromWeb([Uri]$Uri, $OutDir) { $OutFile } -Function Get-InstallerExe($Version, [switch]$Runtime) { +Function Get-InstallerExe($Version, $Architecture, [switch]$Runtime) { $sdkOrRuntime = 'Sdk' if ($Runtime) { $sdkOrRuntime = 'Runtime' } @@ -116,7 +124,7 @@ Function Get-InstallerExe($Version, [switch]$Runtime) { if ($filesElement) { foreach ($file in $filesElement) { - if ($file.rid -eq "win-$arch") { + if ($file.rid -eq "win-$Architecture") { $url = $file.url Break } @@ -135,22 +143,20 @@ Function Get-InstallerExe($Version, [switch]$Runtime) { } } -Function Install-DotNet($Version, [switch]$Runtime) { +Function Install-DotNet($Version, $Architecture, [switch]$Runtime) { if ($Runtime) { $sdkSubstring = '' } else { $sdkSubstring = 'SDK ' } Write-Host "Downloading .NET Core $sdkSubstring$Version..." - $Installer = Get-InstallerExe -Version $Version -Runtime:$Runtime + $Installer = Get-InstallerExe -Version $Version -Architecture $Architecture -Runtime:$Runtime Write-Host "Installing .NET Core $sdkSubstring$Version..." cmd /c start /wait $Installer /install /passive /norestart if ($LASTEXITCODE -eq 3010) { Write-Verbose "Restart required" } elseif ($LASTEXITCODE -ne 0) { - throw "Failure to install .NET Core SDK" + throw "Failure to install .NET SDK" } } -$switches = @( - '-Architecture',$arch -) +$switches = @() $envVars = @{ # For locally installed dotnet, skip first time experience which takes a long time 'DOTNET_SKIP_FIRST_TIME_EXPERIENCE' = 'true'; @@ -161,15 +167,25 @@ if ($InstallLocality -eq 'machine') { $DotNetInstallDir = '/usr/share/dotnet' } else { $restartRequired = $false - if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { - Install-DotNet -Version $sdkVersion + if ($PSCmdlet.ShouldProcess(".NET SDK $sdkVersion", "Install")) { + Install-DotNet -Version $sdkVersion -Architecture $arch $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + + if ($IncludeX86) { + Install-DotNet -Version $sdkVersion -Architecture x86 + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } } $runtimeVersions | Get-Unique |% { if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - Install-DotNet -Version $_ -Runtime + Install-DotNet -Version $_ -Architecture $arch -Runtime $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + + if ($IncludeX86) { + Install-DotNet -Version $_ -Architecture x86 -Runtime + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } } } @@ -182,20 +198,34 @@ if ($InstallLocality -eq 'machine') { } } elseif ($InstallLocality -eq 'repo') { $DotNetInstallDir = "$DotNetInstallScriptRoot/.dotnet" + $DotNetX86InstallDir = "$DotNetInstallScriptRoot/x86/.dotnet" } elseif ($env:AGENT_TOOLSDIRECTORY) { $DotNetInstallDir = "$env:AGENT_TOOLSDIRECTORY/dotnet" + $DotNetX86InstallDir = "$env:AGENT_TOOLSDIRECTORY/x86/dotnet" } else { $DotNetInstallDir = Join-Path $HOME .dotnet } -Write-Host "Installing .NET Core SDK and runtimes to $DotNetInstallDir" -ForegroundColor Blue - if ($DotNetInstallDir) { - $switches += '-InstallDir',"`"$DotNetInstallDir`"" + if (!(Test-Path $DotNetInstallDir)) { New-Item -ItemType Directory -Path $DotNetInstallDir } + $DotNetInstallDir = Resolve-Path $DotNetInstallDir + Write-Host "Installing .NET SDK and runtimes to $DotNetInstallDir" -ForegroundColor Blue $envVars['DOTNET_MULTILEVEL_LOOKUP'] = '0' $envVars['DOTNET_ROOT'] = $DotNetInstallDir } +if ($IncludeX86) { + if ($DotNetX86InstallDir) { + if (!(Test-Path $DotNetX86InstallDir)) { New-Item -ItemType Directory -Path $DotNetX86InstallDir } + $DotNetX86InstallDir = Resolve-Path $DotNetX86InstallDir + Write-Host "Installing x86 .NET SDK and runtimes to $DotNetX86InstallDir" -ForegroundColor Blue + } else { + # Only machine-wide or repo-wide installations can handle two unique dotnet.exe architectures. + Write-Error "The installation location or OS isn't supported for x86 installation. Try a different -InstallLocality value." + return 1 + } +} + if ($IsMacOS -or $IsLinux) { $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/781752509a890ca7520f1182e8bae71f9a53d754/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" @@ -219,47 +249,89 @@ $DotNetInstallScriptPathExpression = "& '$DotNetInstallScriptPathExpression'" $anythingInstalled = $false $global:LASTEXITCODE = 0 -if ($PSCmdlet.ShouldProcess(".NET Core SDK $sdkVersion", "Install")) { +if ($PSCmdlet.ShouldProcess(".NET SDK $sdkVersion", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion $switches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture $arch -InstallDir $DotNetInstallDir $switches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion $switches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture $arch -InstallDir $DotNetInstallDir $switches -DryRun" +} + +if ($IncludeX86) { + if ($PSCmdlet.ShouldProcess(".NET x86 SDK $sdkVersion", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture x86 -InstallDir $DotNetX86InstallDir $switches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET x86 SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture x86 -InstallDir $DotNetX86InstallDir $switches -DryRun" + } } $dotnetRuntimeSwitches = $switches + '-Runtime','dotnet' $runtimeVersions | Sort-Object -Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET Core $Arch runtime $_", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $dotnetRuntimeSwitches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $dotnetRuntimeSwitches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $dotnetRuntimeSwitches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $dotnetRuntimeSwitches -DryRun" + } + + if ($IncludeX86) { + if ($PSCmdlet.ShouldProcess(".NET Core x86 runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $dotnetRuntimeSwitches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $dotnetRuntimeSwitches -DryRun" + } } } $windowsDesktopRuntimeSwitches = $switches + '-Runtime','windowsdesktop' $windowsDesktopRuntimeVersions | Sort-Object -Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop runtime $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop $arch runtime $_", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $windowsDesktopRuntimeSwitches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $windowsDesktopRuntimeSwitches" if ($LASTEXITCODE -ne 0) { Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ $windowsDesktopRuntimeSwitches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $windowsDesktopRuntimeSwitches -DryRun" + } + + if ($IncludeX86) { + if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop x86 runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $windowsDesktopRuntimeSwitches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $windowsDesktopRuntimeSwitches -DryRun" + } } } From 553c404a46e916c2ca3a4afe69ce2f642c502c77 Mon Sep 17 00:00:00 2001 From: Jialong Cheng <40867840+jialongcheng@users.noreply.github.com> Date: Tue, 3 May 2022 10:08:18 -0700 Subject: [PATCH 0466/1753] Expose a property on whether JoinableTaskContext has any JTF blocking calls on the main thread (#1026) * Expose a property on whether JoinableTaskContext has any JTF blocking calls on the main thread Co-authored-by: Andrew Arnott --- .../JoinableTaskContext.cs | 34 +++++++ .../JoinableTaskFactory.cs | 13 +++ .../net472/PublicAPI.Shipped.txt | 1 + .../net5.0-windows/PublicAPI.Shipped.txt | 1 + .../net5.0/PublicAPI.Shipped.txt | 1 + .../netcoreapp3.1/PublicAPI.Shipped.txt | 1 + .../netstandard2.0/PublicAPI.Shipped.txt | 1 + .../JoinableTaskContextTests.cs | 91 +++++++++++++++++-- 8 files changed, 137 insertions(+), 6 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 46e58685b..26df4578b 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -116,6 +116,11 @@ public partial class JoinableTaskContext : IDisposable /// private readonly int mainThreadManagedThreadId; + /// + /// The count of blocking API calls on the main thread. + /// + private volatile int mainThreadJTFBlockingCount; + /// /// A single joinable task factory that itself cannot be joined. /// @@ -200,6 +205,11 @@ public bool IsWithinJoinableTask get { return this.AmbientTask is object; } } + /// + /// Gets a value indicating whether the main thread is blocked by any joinable task. + /// + public bool IsMainThreadBlockedByAnyone => this.mainThreadJTFBlockingCount > 0; + /// /// Gets the underlying that controls the main thread in the host. /// @@ -471,6 +481,30 @@ internal IDisposable RegisterHangNotifications(JoinableTaskContextNode node) return new HangNotificationRegistration(node); } + /// + /// Increment the count of blocking API calls on the main thread. + /// + /// + /// This method should only be called on the main thread. + /// + internal void IncrementMainThreadBlockingCount() + { + Assumes.True(this.IsOnMainThread); + this.mainThreadJTFBlockingCount++; + } + + /// + /// Decrement the count of blocking API calls on the main thread. + /// + /// + /// This method should only be called on the main thread. + /// + internal void DecrementMainThreadBlockingCount() + { + Assumes.True(this.IsOnMainThread); + this.mainThreadJTFBlockingCount--; + } + /// /// Invoked when a hang is suspected to have occurred involving the main thread. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 3c35da3e4..7d6848100 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -545,6 +545,12 @@ protected internal virtual void WaitSynchronously(Task task) protected virtual void WaitSynchronouslyCore(Task task) { Requires.NotNull(task, nameof(task)); + + if (this.Context.IsOnMainThread) + { + this.Context.IncrementMainThreadBlockingCount(); + } + int hangTimeoutsCount = 0; // useful for debugging dump files to see how many times we looped. int hangNotificationCount = 0; Guid hangId = Guid.Empty; @@ -588,6 +594,13 @@ protected virtual void WaitSynchronouslyCore(Task task) // Our caller just wants to know when the Task completes, // whether successfully or not. } + finally + { + if (this.Context.IsOnMainThread) + { + this.Context.DecrementMainThreadBlockingCount(); + } + } } /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt index 3d7cc2bc8..4c31e1fcf 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt @@ -244,6 +244,7 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt index 3d7cc2bc8..4c31e1fcf 100644 --- a/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt @@ -244,6 +244,7 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt index 916298d7d..0cab613db 100644 --- a/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt @@ -243,6 +243,7 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt index 916298d7d..0cab613db 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt @@ -243,6 +243,7 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt index 916298d7d..0cab613db 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt @@ -243,6 +243,7 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index 09545dcfa..acca37a26 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -45,6 +45,85 @@ await Task.Run(delegate }); } + [Fact] + public void IsMainThreadBlockedByAnyone_True() + { + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + AsyncManualResetEvent mainThreadBlockerEvent = new AsyncManualResetEvent(false); + AsyncManualResetEvent backgroundThreadMonitorEvent = new AsyncManualResetEvent(false); + + // Start task to monitor IsMainThreadBlockedByAnyone + Task monitorTask = Task.Run(async () => + { + await mainThreadBlockerEvent.WaitAsync(this.TimeoutToken); + + while (!this.Context.IsMainThreadBlockedByAnyone) + { + // Give the main thread time to enter a blocking state, if the test hasn't already timed out. + await Task.Delay(50, this.TimeoutToken); + } + + backgroundThreadMonitorEvent.Set(); + }); + + JoinableTask? joinable = this.Factory.RunAsync(async delegate + { + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + await this.Factory.SwitchToMainThreadAsync(this.TimeoutToken); + + this.Factory.Run(async () => + { + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + mainThreadBlockerEvent.Set(); + await backgroundThreadMonitorEvent.WaitAsync(this.TimeoutToken); + }); + }); + + joinable.Join(); + monitorTask.WaitWithoutInlining(throwOriginalException: true); + + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + } + + [Fact] + public void IsMainThreadBlockedByAnyone_False() + { + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + ManualResetEventSlim backgroundThreadBlockerEvent = new(); + + JoinableTask? joinable = this.Factory.RunAsync(async delegate + { + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + + this.Factory.Run(async () => + { + backgroundThreadBlockerEvent.Set(); + + // Set a delay sufficient for the other thread to have noticed if IsMainThreadBlockedByAnyone is true + // while we're suspended. + await Task.Delay(AsyncDelay); + }); + }); + + backgroundThreadBlockerEvent.Wait(UnexpectedTimeout); + + do + { + // Give the background thread time to enter a blocking state, if the test hasn't already timed out. + this.TimeoutToken.ThrowIfCancellationRequested(); + + // IsMainThreadBlockedByAnyone should be false when a background thread is blocked. + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + Thread.Sleep(10); + } + while (!joinable.IsCompleted); + + joinable.Join(); + + Assert.False(this.Context.IsMainThreadBlockedByAnyone); + } + [Fact] public void ReportHangOnRun() { @@ -410,8 +489,8 @@ public void GetHangReportProducesDgmlWithNamedJoinableCollections() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Collection" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Collection" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label == jtcName); return Task.CompletedTask; }); @@ -433,8 +512,8 @@ public void GetHangReportProducesDgmlWithMethodNameRequestingMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.GetHangReportProducesDgmlWithMethodNameRequestingMainThread))); } @@ -456,8 +535,8 @@ public void GetHangReportProducesDgmlWithMethodNameYieldingOnMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.YieldingMethodAsync))); }); } From 78cba24937d03e10c3266e7421b1aef038d0e354 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 May 2022 21:07:12 -0600 Subject: [PATCH 0467/1753] Shift to `using` directives outside the namespace This is a concession from StyleCop defaults, but it's just too hard to paddle upstream with the C# language team, which doesn't consistently test their refactoring features when `using` is inside the namespace. --- stylecop.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/stylecop.json b/stylecop.json index 379189493..6cd455746 100644 --- a/stylecop.json +++ b/stylecop.json @@ -10,6 +10,9 @@ }, "fileNamingConvention": "metadata", "xmlHeader": false + }, + "orderingRules": { + "usingDirectivesPlacement": "outsideNamespace" } } } From c82cc3463cb88e1591401059e127a1d84c4317f9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 May 2022 21:07:33 -0600 Subject: [PATCH 0468/1753] Permit attribute lists with multiple attributes in tests --- test/.editorconfig | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/.editorconfig b/test/.editorconfig index 8aa791bef..74dd4a1fa 100644 --- a/test/.editorconfig +++ b/test/.editorconfig @@ -50,3 +50,6 @@ dotnet_diagnostic.CA2007.severity = none # SA1401: Fields should be private dotnet_diagnostic.SA1401.severity = silent + +# SA1133: Do not combine attributes +dotnet_diagnostic.SA1133.severity = silent From 0a6f58c3cc425ca7a8612acb9129e730fce8507c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 May 2022 21:22:34 -0600 Subject: [PATCH 0469/1753] Update Nerdbank.GitVersioning dependency --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 834e74573..2e13d76f0 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -37,7 +37,7 @@ - + From 9dde17ff42c902d3be0951021e049b7c8fc6fec1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 May 2022 21:32:22 -0600 Subject: [PATCH 0470/1753] Use icons for all task display names --- azure-pipelines/build.yml | 2 +- azure-pipelines/dotnet.yml | 10 +++++----- azure-pipelines/expand-template.yml | 6 +++--- azure-pipelines/install-dependencies.yml | 6 +++--- azure-pipelines/publish-codecoverage.yml | 10 +++++----- azure-pipelines/publish-deployables.yml | 4 ++-- azure-pipelines/publish-symbols.yml | 16 ++++++++-------- azure-pipelines/release.yml | 10 +++++----- 8 files changed, 32 insertions(+), 32 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index f779fd12c..5bfd95f53 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -14,7 +14,7 @@ jobs: - template: install-dependencies.yml - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -c' - displayName: Set build number + displayName: ⚙ Set build number - template: dotnet.yml - template: expand-template.yml diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index a103adfd3..1d7d9de76 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,23 +1,23 @@ steps: - script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" - displayName: dotnet build + displayName: 🛠 dotnet build - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults - displayName: dotnet test + displayName: 🧪 dotnet test - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true - displayName: Update pipeline variables based on build outputs + displayName: ⚙ Update pipeline variables based on build outputs condition: succeededOrFailed() - powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" failOnStderr: true - displayName: Publish artifacts + displayName: 📢 Publish artifacts condition: succeededOrFailed() - bash: bash <(curl -s https://codecov.io/bash) - displayName: Publish code coverage results to codecov.io + displayName: 📢 Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') timeoutInMinutes: 3 continueOnError: true diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index ed510de3e..d843f1eac 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -2,13 +2,13 @@ steps: - script: | dotnet build-server shutdown git clean -fdx - displayName: Cleaning repo for template expansion + displayName: 🧹 Cleaning repo for template expansion - powershell: | git config user.name "test user" git config user.email "andrewarnott@gmail.com" ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" - displayName: Expanding template + displayName: 🧪 Expanding template failOnStderr: true # TODO: Verify that all changes are staged to the git index - script: dotnet build - displayName: dotnet build (expanded template) + displayName: 🛠 dotnet build (expanded template) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 4f848b099..3993f1043 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -4,7 +4,7 @@ parameters: steps: - task: NuGetAuthenticate@0 - displayName: Authenticate NuGet feeds + displayName: 🔏 Authenticate NuGet feeds inputs: forceReinstallCredentialProvider: true @@ -17,9 +17,9 @@ steps: if (Get-Command mono -ErrorAction SilentlyContinue) { mono --version } - displayName: Install prerequisites + displayName: ⚙ Install prerequisites - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true - displayName: Set pipeline variables based on source + displayName: ⚙ Set pipeline variables based on source name: SetPipelineVariables diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index a0862be3f..423e12fce 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -4,15 +4,15 @@ parameters: steps: - download: current artifact: coverageResults-Windows - displayName: Download Windows code coverage results + displayName: 🔻 Download Windows code coverage results continueOnError: true - download: current artifact: coverageResults-Linux - displayName: Download Linux code coverage results + displayName: 🔻 Download Linux code coverage results continueOnError: true - download: current artifact: coverageResults-macOS - displayName: Download macOS code coverage results + displayName: 🔻 Download macOS code coverage results continueOnError: true condition: ${{ parameters.includeMacOS }} - powershell: | @@ -26,9 +26,9 @@ steps: } $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_ })) obj/reportgenerator -reports:"$Inputs" -targetdir:coveragereport -reporttypes:Cobertura - displayName: Merge coverage + displayName: ⚙ Merge coverage - task: PublishCodeCoverageResults@1 - displayName: Publish code coverage results to Azure DevOps + displayName: 📢 Publish code coverage results to Azure DevOps inputs: codeCoverageTool: cobertura summaryFileLocation: 'coveragereport/Cobertura.xml' diff --git a/azure-pipelines/publish-deployables.yml b/azure-pipelines/publish-deployables.yml index 9ccdc29e2..31e80a437 100644 --- a/azure-pipelines/publish-deployables.yml +++ b/azure-pipelines/publish-deployables.yml @@ -1,8 +1,8 @@ steps: - download: current - displayName: Download deployables + displayName: 🔻 Download deployables artifact: deployables-Windows - powershell: dotnet nuget push "$(Resolve-Path '$(Pipeline.Workspace)\deployables-Windows\')*.nupkg" -s $(ci_feed) -k azdo --skip-duplicate - displayName: Push packages to CI feed + displayName: 📦 Push packages to CI feed condition: and(succeeded(), ne(variables['ci_feed'], ''), ne(variables['Build.Reason'], 'PullRequest')) diff --git a/azure-pipelines/publish-symbols.yml b/azure-pipelines/publish-symbols.yml index c45eff020..00c188fc3 100644 --- a/azure-pipelines/publish-symbols.yml +++ b/azure-pipelines/publish-symbols.yml @@ -6,19 +6,19 @@ steps: inputs: artifact: symbols-Windows path: $(Pipeline.Workspace)/symbols/Windows - displayName: Download Windows symbols + displayName: 🔻 Download Windows symbols continueOnError: true - task: DownloadPipelineArtifact@2 inputs: artifact: symbols-Linux path: $(Pipeline.Workspace)/symbols/Linux - displayName: Download Linux symbols + displayName: 🔻 Download Linux symbols continueOnError: true - task: DownloadPipelineArtifact@2 inputs: artifact: symbols-macOS path: $(Pipeline.Workspace)/symbols/macOS - displayName: Download macOS symbols + displayName: 🔻 Download macOS symbols continueOnError: true condition: ${{ parameters.includeMacOS }} @@ -26,19 +26,19 @@ steps: inputs: artifact: test_symbols-Windows path: $(Pipeline.Workspace)/test_symbols/Windows - displayName: Download Windows test symbols + displayName: 🔻 Download Windows test symbols continueOnError: true - task: DownloadPipelineArtifact@2 inputs: artifact: test_symbols-Linux path: $(Pipeline.Workspace)/test_symbols/Linux - displayName: Download Linux test symbols + displayName: 🔻 Download Linux test symbols continueOnError: true - task: DownloadPipelineArtifact@2 inputs: artifact: test_symbols-macOS path: $(Pipeline.Workspace)/test_symbols/macOS - displayName: Download macOS test symbols + displayName: 🔻 Download macOS test symbols continueOnError: true condition: ${{ parameters.includeMacOS }} @@ -48,7 +48,7 @@ steps: SearchPattern: '**/*.pdb' IndexSources: false SymbolServerType: TeamServices - displayName: Publish symbols + displayName: 📢 Publish symbols - task: PublishSymbols@2 inputs: @@ -56,4 +56,4 @@ steps: SearchPattern: '**/*.pdb' IndexSources: false SymbolServerType: TeamServices - displayName: Publish test symbols + displayName: 📢 Publish test symbols diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 6690cccfa..2679b24e7 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -25,18 +25,18 @@ jobs: } else { Write-Host "##vso[task.setvariable variable=IsPrerelease]false" } - displayName: Set up pipeline + displayName: ⚙ Set up pipeline - task: UseDotNet@2 - displayName: Install .NET SDK + displayName: ⚙ Install .NET SDK inputs: packageType: sdk version: 6.x - download: CI artifact: deployables-Windows - displayName: Download deployables-Windows artifact + displayName: 🔻 Download deployables-Windows artifact patterns: 'deployables-Windows/*' - task: GitHubRelease@1 - displayName: GitHub release (create) + displayName: 📢 GitHub release (create) inputs: gitHubConnection: # TODO: fill in service connection here repositoryName: $(Build.Repository.Name) @@ -55,5 +55,5 @@ jobs: { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } ] - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate - displayName: Push packages to nuget.org + displayName: 📦 Push packages to nuget.org condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) From 9805678248d0fbda63f97982f37e35de71890d2f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 12 May 2022 08:41:05 -0600 Subject: [PATCH 0471/1753] Fix NUGET_PACKAGES path in pipelines Be default the NUGET_PACKAGES path has a trailing slash. In our override, we should do this as well or the msbuild property that gets generated is missing the slash, which can break some builds. --- .github/workflows/build.yml | 2 +- azure-pipelines.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 18ae3e289..4db43f53c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -12,7 +12,7 @@ env: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BUILDCONFIGURATION: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages + NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages/ jobs: build: diff --git a/azure-pipelines.yml b/azure-pipelines.yml index b7d86b455..d98ed107d 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -24,7 +24,7 @@ variables: BuildConfiguration: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ ci_feed: https://pkgs.dev.azure.com/andrewarnott/_packaging/CI/nuget/v3/index.json # Azure Artifacts feed URL - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ jobs: - template: azure-pipelines/build.yml From da08e901c94c416cbbdfa980020ced9ed9612851 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 12 May 2022 16:08:56 -0600 Subject: [PATCH 0472/1753] Add ability to split stage and publish artifact steps --- azure-pipelines/artifacts/_all.ps1 | 10 +++---- azure-pipelines/artifacts/_pipelines.ps1 | 35 ++++++++++++++++++++---- azure-pipelines/artifacts/_stage_all.ps1 | 8 +++++- 3 files changed, 42 insertions(+), 11 deletions(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index afe42be30..c9182a45a 100755 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -12,7 +12,7 @@ Value = an array of paths (absolute or relative to the BaseDirectory) to files to include in the artifact. FileInfo objects are also allowed. .PARAMETER Force - Executes artifact scripts even if they have already been uploaded. + Executes artifact scripts even if they have already been staged. #> param ( @@ -28,14 +28,14 @@ Function EnsureTrailingSlash($path) { $path.Replace('\', [IO.Path]::DirectorySeparatorChar) } -Function Test-ArtifactUploaded($artifactName) { - $varName = "ARTIFACTUPLOADED_$($artifactName.ToUpper())" +Function Test-ArtifactStaged($artifactName) { + $varName = "ARTIFACTSTAGED_$($artifactName.ToUpper())" Test-Path "env:$varName" } Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse | % { $ArtifactName = $_.BaseName - if ($Force -or !(Test-ArtifactUploaded($ArtifactName + $ArtifactNameSuffix))) { + if ($Force -or !(Test-ArtifactStaged($ArtifactName + $ArtifactNameSuffix))) { $totalFileCount = 0 $fileGroups = & $_ if ($fileGroups) { @@ -65,6 +65,6 @@ Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse | % { Write-Warning "No files found for the `"$ArtifactName`" artifact." } } else { - Write-Host "Skipping $ArtifactName because it has already been uploaded." -ForegroundColor DarkGray + Write-Host "Skipping $ArtifactName because it has already been staged." -ForegroundColor DarkGray } } diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 73a3af0ac..a62d2675b 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -2,14 +2,39 @@ # into commands that instruct Azure Pipelines to actually collect those artifacts. param ( - [string]$ArtifactNameSuffix + [string]$ArtifactNameSuffix, + [switch]$StageOnly ) -& "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix |% { - Write-Host "##vso[artifact.upload containerfolder=$($_.Name);artifactname=$($_.Name);]$($_.Path)" +Function Set-PipelineVariable($name, $value) { + if ((Test-Path "Env:\$name") -and (Get-Item "Env:\$name").Value -eq $value) { + return # already set + } + + #New-Item -Path "Env:\$name".ToUpper() -Value $value -Force | Out-Null + Write-Host "##vso[task.setvariable variable=$name]$value" +} + +Function Test-ArtifactUploaded($artifactName) { + $varName = "ARTIFACTUPLOADED_$($artifactName.ToUpper())" + Test-Path "env:$varName" +} +& "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix |% { # Set a variable which will out-live this script so that a subsequent attempt to collect and upload artifacts # will skip this one from a check in the _all.ps1 script. - $varName = "ARTIFACTUPLOADED_$($_.Name.ToUpper())" - Write-Host "##vso[task.setvariable variable=$varName]true" + Set-PipelineVariable "ARTIFACTSTAGED_$($_.Name.ToUpper())" 'true' + Write-Host "Staged artifact $($_.Name) to $($_.Path)" + + if (!$StageOnly) { + if (Test-ArtifactUploaded $_.Name) { + Write-Host "Skipping $($_.Name) because it has already been uploaded." -ForegroundColor DarkGray + } else { + Write-Host "##vso[artifact.upload containerfolder=$($_.Name);artifactname=$($_.Name);]$($_.Path)" + + # Set a variable which will out-live this script so that a subsequent attempt to collect and upload artifacts + # will skip this one from a check in the _all.ps1 script. + Set-PipelineVariable "ARTIFACTUPLOADED_$($_.Name.ToUpper())" 'true' + } + } } diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index e4954c131..b7166b4eb 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -42,7 +42,13 @@ $Artifacts |% { } } -$Artifacts |% { "$($_.ArtifactName)$ArtifactNameSuffix" } | Get-Unique |% { +$ArtifactNames = $Artifacts |% { "$($_.ArtifactName)$ArtifactNameSuffix" } +$ArtifactNames += Get-ChildItem env:ARTIFACTSTAGED_* |% { + # Return from ALLCAPS to the actual capitalization used for the artifact. + $artifactNameAllCaps = "$($_.Name.Substring('ARTIFACTSTAGED_'.Length))" + (Get-ChildItem $ArtifactStagingFolder\$artifactNameAllCaps* -Filter $artifactNameAllCaps).Name +} +$ArtifactNames | Get-Unique |% { $artifact = New-Object -TypeName PSObject Add-Member -InputObject $artifact -MemberType NoteProperty -Name Name -Value $_ Add-Member -InputObject $artifact -MemberType NoteProperty -Name Path -Value (Join-Path $ArtifactStagingFolder $_) From c268a9e8d99bfed18778aaecea828720522c6dea Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 18 May 2022 16:18:24 -0600 Subject: [PATCH 0473/1753] Fix several Install-DotNetSdk issues * Stop popping Windows Explorer dialogs * Stop installing the same .NET runtime versions multiple times. * Install WindowsDesktop too. --- tools/Install-DotNetSdk.ps1 | 57 +++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 25 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 76a397f04..2bac3b9bc 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -80,7 +80,7 @@ Function Get-FileFromWeb([Uri]$Uri, $OutDir) { $OutFile = Join-Path $OutDir $Uri.Segments[-1] if (!(Test-Path $OutFile)) { Write-Verbose "Downloading $Uri..." - if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir } + if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir | Out-Null } try { (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) } finally { @@ -91,35 +91,31 @@ Function Get-FileFromWeb([Uri]$Uri, $OutDir) { $OutFile } -Function Get-InstallerExe($Version, $Architecture, [switch]$Runtime) { - $sdkOrRuntime = 'Sdk' - if ($Runtime) { $sdkOrRuntime = 'Runtime' } - +Function Get-InstallerExe( + $Version, + $Architecture, + [ValidateSet('Sdk','Runtime','WindowsDesktop')] + [string]$sku +) { # Get the latest/actual version for the specified one $TypedVersion = [Version]$Version if ($TypedVersion.Build -eq -1) { - $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sdkOrRuntime/$Version/latest.version" -UseBasicParsing) + $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sku/$Version/latest.version" -UseBasicParsing) $Version = $versionInfo[-1] } $majorMinor = "$($TypedVersion.Major).$($TypedVersion.Minor)" $ReleasesFile = Join-Path $DotNetInstallScriptRoot "$majorMinor\releases.json" if (!(Test-Path $ReleasesFile)) { - Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata/$majorMinor/releases.json" -OutDir (Split-Path $ReleasesFile) + Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata/$majorMinor/releases.json" -OutDir (Split-Path $ReleasesFile) | Out-Null } $releases = Get-Content $ReleasesFile | ConvertFrom-Json $url = $null foreach ($release in $releases.releases) { $filesElement = $null - if ($Runtime) { - if ($release.runtime.version -eq $Version) { - $filesElement = $release.runtime.files - } - } else { - if ($release.sdk.version -eq $Version) { - $filesElement = $release.sdk.files - } + if ($release.$sku.version -eq $Version) { + $filesElement = $release.$sku.files } if ($filesElement) { @@ -139,15 +135,14 @@ Function Get-InstallerExe($Version, $Architecture, [switch]$Runtime) { if ($url) { Get-FileFromWeb -Uri $url -OutDir $DotNetInstallScriptRoot } else { - Write-Error "Unable to find release of $sdkOrRuntime v$Version" + Write-Error "Unable to find release of $sku v$Version" } } -Function Install-DotNet($Version, $Architecture, [switch]$Runtime) { - if ($Runtime) { $sdkSubstring = '' } else { $sdkSubstring = 'SDK ' } - Write-Host "Downloading .NET Core $sdkSubstring$Version..." - $Installer = Get-InstallerExe -Version $Version -Architecture $Architecture -Runtime:$Runtime - Write-Host "Installing .NET Core $sdkSubstring$Version..." +Function Install-DotNet($Version, $Architecture, [ValidateSet('Sdk','Runtime','WindowsDesktop')][string]$sku = 'Sdk') { + Write-Host "Downloading .NET Core $sku $Version..." + $Installer = Get-InstallerExe -Version $Version -Architecture $Architecture -sku $sku + Write-Host "Installing .NET Core $sku $Version..." cmd /c start /wait $Installer /install /passive /norestart if ($LASTEXITCODE -eq 3010) { Write-Verbose "Restart required" @@ -177,13 +172,25 @@ if ($InstallLocality -eq 'machine') { } } - $runtimeVersions | Get-Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core runtime $_", "Install")) { - Install-DotNet -Version $_ -Architecture $arch -Runtime + $runtimeVersions | Sort-Object | Get-Unique |% { + if ($PSCmdlet.ShouldProcess(".NET runtime $_", "Install")) { + Install-DotNet -Version $_ -sku Runtime -Architecture $arch + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + + if ($IncludeX86) { + Install-DotNet -Version $_ -sku Runtime -Architecture x86 + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } + } + } + + $windowsDesktopRuntimeVersions | Sort-Object | Get-Unique |% { + if ($PSCmdlet.ShouldProcess(".NET Windows Desktop $_", "Install")) { + Install-DotNet -Version $_ -sku WindowsDesktop -Architecture $arch $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) if ($IncludeX86) { - Install-DotNet -Version $_ -Architecture x86 -Runtime + Install-DotNet -Version $_ -sku WindowsDesktop -Architecture x86 $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) } } From 88e1d9e8b452584ea8446c3a994bcbd4fdf762ab Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 20 Apr 2022 18:08:01 -0600 Subject: [PATCH 0474/1753] Add net5.0-windows TFM to analyzers test project --- .../Helpers/ReferencesHelper.cs | 8 +++++++- ...VisualStudio.Threading.Analyzers.Tests.csproj | 16 ++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index b5fe86d64..f5210cd9a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -9,7 +9,13 @@ namespace Microsoft.VisualStudio.Threading.Analyzers.Tests internal static class ReferencesHelper { - public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Default +#if NETFRAMEWORK + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetFramework.Net471.Default +#elif NETCOREAPP3_1 + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetCore.NetCoreApp31 +#elif NET5_0 + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net50 +#endif .WithPackages(ImmutableArray.Create( new PackageIdentity("System.Collections.Immutable", "5.0.0"), new PackageIdentity("System.Threading.Tasks.Extensions", "4.5.4"), diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 4f6812c5f..1edaf3994 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -1,17 +1,18 @@  - netcoreapp3.1 + netcoreapp3.1;net5.0 true true true $(NoWarn);NU1701 $(DefineConstants);WINDOWS + true - $(TargetFrameworks);net472 + $(TargetFrameworks);net5.0-windows;net472 @@ -27,8 +28,8 @@ - - + + @@ -53,4 +54,11 @@ AdditionalFiles + + + + + + + From 5b91202c0ae112e40cea842837d1290d5cad8fb9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 May 2022 08:50:04 -0600 Subject: [PATCH 0475/1753] Retarget net5.0 to net6.0 The net5.0 runtime isn't supported any more. --- .../Microsoft.VisualStudio.Threading.csproj | 6 +++--- .../PublicAPI.Shipped.txt | 0 .../PublicAPI.Unshipped.txt | 0 .../{net5.0 => net6.0}/PublicAPI.Shipped.txt | 0 .../{net5.0 => net6.0}/PublicAPI.Unshipped.txt | 0 .../Helpers/ReferencesHelper.cs | 4 +++- ...icrosoft.VisualStudio.Threading.Analyzers.Tests.csproj | 8 ++++---- .../Microsoft.VisualStudio.Threading.Tests.csproj | 4 ++-- 8 files changed, 12 insertions(+), 10 deletions(-) rename src/Microsoft.VisualStudio.Threading/{net5.0-windows => net6.0-windows}/PublicAPI.Shipped.txt (100%) rename src/Microsoft.VisualStudio.Threading/{net5.0-windows => net6.0-windows}/PublicAPI.Unshipped.txt (100%) rename src/Microsoft.VisualStudio.Threading/{net5.0 => net6.0}/PublicAPI.Shipped.txt (100%) rename src/Microsoft.VisualStudio.Threading/{net5.0 => net6.0}/PublicAPI.Unshipped.txt (100%) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 298723c92..7cd1b743f 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -1,6 +1,6 @@  - netstandard2.0;netcoreapp3.1;net5.0;net472 + netstandard2.0;netcoreapp3.1;net6.0;net472 Async synchronization primitives, async collections, TPL and dataflow extensions. Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). @@ -9,8 +9,8 @@ true - $(TargetFrameworks);net5.0-windows - true + $(TargetFrameworks);net6.0-windows + true diff --git a/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Shipped.txt rename to src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt diff --git a/src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading/net5.0-windows/PublicAPI.Unshipped.txt rename to src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt diff --git a/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Shipped.txt rename to src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt diff --git a/src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading/net5.0/PublicAPI.Unshipped.txt rename to src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index f5210cd9a..1319b6b6c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -13,8 +13,10 @@ internal static class ReferencesHelper public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetFramework.Net471.Default #elif NETCOREAPP3_1 public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetCore.NetCoreApp31 -#elif NET5_0 +#elif NET6_0 public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net50 +#else +#error Fix TFM conditions #endif .WithPackages(ImmutableArray.Create( new PackageIdentity("System.Collections.Immutable", "5.0.0"), diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 1edaf3994..a0ce8d28e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -1,18 +1,18 @@  - netcoreapp3.1;net5.0 + netcoreapp3.1;net6.0 true true true $(NoWarn);NU1701 $(DefineConstants);WINDOWS - true + true - $(TargetFrameworks);net5.0-windows;net472 + $(TargetFrameworks);net6.0-windows;net472 @@ -54,7 +54,7 @@ AdditionalFiles - + diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index d7fc9541f..65e55c388 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -1,6 +1,6 @@  - net5.0;netcoreapp3.1 + net6.0;netcoreapp3.1 true true @@ -10,7 +10,7 @@ $(DefineConstants);ISOLATED_TEST_SUPPORT - $(TargetFrameworks);net472;net5.0-windows + $(TargetFrameworks);net472;net6.0-windows From b877cfbdf68a75705421982c82ee61146bfae9af Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 May 2022 09:00:36 -0600 Subject: [PATCH 0476/1753] Fix net6.0 test failures --- .../Helpers/ReferencesHelper.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 1319b6b6c..273459b81 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -14,7 +14,7 @@ internal static class ReferencesHelper #elif NETCOREAPP3_1 public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetCore.NetCoreApp31 #elif NET6_0 - public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net50 + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net60 #else #error Fix TFM conditions #endif From 142d512090b072b3634c6341428286434d601284 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 May 2022 09:49:40 -0600 Subject: [PATCH 0477/1753] Drop Windows 7 support and (unstable) test --- Microsoft.VisualStudio.Threading.sln | 14 +- .../AwaitExtensions.cs | 270 +----------------- .../LightUps.cs | 36 --- .../AwaitExtensionsTests.cs | 45 --- 4 files changed, 14 insertions(+), 351 deletions(-) delete mode 100644 src/Microsoft.VisualStudio.Threading/LightUps.cs diff --git a/Microsoft.VisualStudio.Threading.sln b/Microsoft.VisualStudio.Threading.sln index 6e6704560..6c9d87141 100644 --- a/Microsoft.VisualStudio.Threading.sln +++ b/Microsoft.VisualStudio.Threading.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.28413.118 +# Visual Studio Version 17 +VisualStudioVersion = 17.3.32517.449 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers", "src\Microsoft.VisualStudio.Threading.Analyzers\Microsoft.VisualStudio.Threading.Analyzers.csproj", "{536F3F9A-B457-43B8-BC93-CE1C16959037}" EndProject @@ -18,8 +18,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution version.json = version.json EndProjectSection EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher", "test\Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher\Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj", "{4961AA84-088C-46C0-BAC0-F9E87A9F03A7}" -EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading", "src\Microsoft.VisualStudio.Threading\Microsoft.VisualStudio.Threading.csproj", "{D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Tests", "test\Microsoft.VisualStudio.Threading.Tests\Microsoft.VisualStudio.Threading.Tests.csproj", "{CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}" @@ -58,14 +56,6 @@ Global {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|Any CPU.Build.0 = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.ActiveCfg = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.Build.0 = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.Build.0 = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.Build.0 = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.ActiveCfg = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.Build.0 = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.ActiveCfg = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.Build.0 = Release|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.Build.0 = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|NonWindows.ActiveCfg = Debug|Any CPU diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index 043d3fa7d..0f7bb5d45 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -204,49 +204,20 @@ public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInli /// private static async Task WaitForRegistryChangeAsync(SafeRegistryHandle registryKeyHandle, bool watchSubtree, RegistryChangeNotificationFilters change, CancellationToken cancellationToken) { - IDisposable? dedicatedThreadReleaser = null; - try - { - using (var evt = new ManualResetEvent(false)) - { - static void DoNotify(SafeRegistryHandle registryKeyHandle, bool watchSubtree, RegistryChangeNotificationFilters change, WaitHandle evt) - { - int win32Error = NativeMethods.RegNotifyChangeKeyValue( - registryKeyHandle, - watchSubtree, - change, - evt.SafeWaitHandle, - true); - if (win32Error != 0) - { - throw new Win32Exception(win32Error); - } - } - - if (LightUps.IsWindows8OrLater) - { - change |= NativeMethods.REG_NOTIFY_THREAD_AGNOSTIC; - DoNotify(registryKeyHandle, watchSubtree, change, evt); - } - else - { - // Engage our downlevel support by using a single, dedicated thread to guarantee - // that we request notification on a thread that will not be destroyed later. - // Although we *could* await this, we synchronously block because our caller expects - // subscription to have begun before we return: for the async part to simply be notification. - // This async method we're calling uses .ConfigureAwait(false) internally so this won't - // deadlock if we're called on a thread with a single-thread SynchronizationContext. - Action registerAction = () => DoNotify(registryKeyHandle, watchSubtree, change, evt); - dedicatedThreadReleaser = DownlevelRegistryWatcherSupport.ExecuteOnDedicatedThreadAsync(registerAction).GetAwaiter().GetResult(); - } - - await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); - } - } - finally + using ManualResetEvent evt = new(false); + change |= NativeMethods.REG_NOTIFY_THREAD_AGNOSTIC; + int win32Error = NativeMethods.RegNotifyChangeKeyValue( + registryKeyHandle, + watchSubtree, + change, + evt.SafeWaitHandle, + true); + if (win32Error != 0) { - dedicatedThreadReleaser?.Dispose(); + throw new Win32Exception(win32Error); } + + await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); } /// @@ -770,222 +741,5 @@ public void OnCompleted(Action continuation) TaskScheduler.Default); } } - - /// - /// Provides a dedicated thread for requesting registry change notifications. - /// - /// - /// For versions of Windows prior to Windows 8, requesting registry change notifications - /// required that the thread that made the request remain alive or else the watcher would - /// simply signal the event and stop watching for changes. - /// This class provides a single, dedicated thread for requesting such notifications - /// so that they don't get canceled when a thread happens to exit. - /// The dedicated thread is released when no one is watching the registry any more. - /// - private static class DownlevelRegistryWatcherSupport - { - /// - /// The size of the stack allocated for a thread that expects to stay within just a few methods in depth. - /// - /// - /// The default stack size for a thread is 1MB. - /// - private const int SmallThreadStackSize = 100 * 1024; - - /// - /// The object to lock when accessing any fields. - /// This is also the object that is waited on by the dedicated thread, - /// and may be pulsed by others to wake the dedicated thread to do some work. - /// - private static readonly object SyncObject = new object(); - - /// - /// A queue of actions the dedicated thread should take. - /// - private static readonly Queue>> PendingWork = new Queue>>(); - - /// - /// The number of callers that still have an interest in the survival of the dedicated thread. - /// The dedicated thread will exit when this value reaches 0. - /// - private static int keepAliveCount; - - /// - /// The thread that should stay alive and be dequeuing . - /// - private static Thread? liveThread; - - /// - /// Executes some action on a long-lived thread. - /// - /// The delegate to execute. - /// - /// A task that either faults with the exception thrown by - /// or completes after successfully executing the delegate - /// with a result that should be disposed when it is safe to terminate the long-lived thread. - /// - /// - /// This thread never posts to , so it is safe - /// to call this method and synchronously block on its result. - /// - internal static async Task ExecuteOnDedicatedThreadAsync(Action action) - { - Requires.NotNull(action, nameof(action)); - - var tcs = new TaskCompletionSource(); - bool keepAliveCountIncremented = false; - try - { - lock (SyncObject) - { - PendingWork.Enqueue(Tuple.Create(action, tcs)); - - try - { - // This block intentionally left blank. - } - finally - { - // We make these two assignments within a finally block - // to guard against an untimely ThreadAbortException causing - // us to execute just one of them. - keepAliveCountIncremented = true; - ++keepAliveCount; - } - - if (keepAliveCount == 1) - { - Assumes.Null(liveThread); - liveThread = new Thread(Worker, SmallThreadStackSize) - { - IsBackground = true, - Name = "Registry watcher", - }; - liveThread.Start(); - } - else - { - // There *could* temporarily be multiple threads in some race conditions. - // Pulse all of them so that the live one is sure to get the message. - Monitor.PulseAll(SyncObject); - } - } - - await tcs.Task.ConfigureAwait(false); - return new ThreadHandleRelease(); - } - catch - { - if (keepAliveCountIncremented) - { - // Our caller will never have a chance to release their claim on the dedicated thread, - // so do it for them. - ReleaseRefOnDedicatedThread(); - } - - throw; - } - } - - /// - /// Decrements the count of interested parties in the live thread, - /// and helps it to terminate if necessary. - /// - private static void ReleaseRefOnDedicatedThread() - { - lock (SyncObject) - { - if (--keepAliveCount == 0) - { - liveThread = null; - - // Wake up any obsolete thread(s) so they can go to exit. - Monitor.PulseAll(SyncObject); - } - } - } - - /// - /// Executes thread-affinitized work from a queue until both the queue is empty - /// and any lingering interest in the survival of the dedicated thread has been released. - /// - /// - /// This method serves as the for our dedicated thread. - /// - private static void Worker() - { - while (true) - { - Tuple>? work = null; - lock (SyncObject) - { - if (Thread.CurrentThread != liveThread) - { - // Regardless of our PendingWork and keepAliveCount, - // it isn't meant for this thread any more. - // This happens when keepAliveCount (at least temporarily) - // hits 0, so this thread must be assumed to be on its exit path, - // and another thread will be spawned to process new requests. - Assumes.True(liveThread is object || (keepAliveCount == 0 && PendingWork.Count == 0)); - return; - } - - if (PendingWork.Count > 0) - { - work = PendingWork.Dequeue(); - } - else if (keepAliveCount == 0) - { - // No work, and no reason to stay alive. Exit the thread. - return; - } - else - { - // Sleep until another thread wants to wake us up with a Pulse. - Monitor.Wait(SyncObject); - } - } - - if (work is object) - { - try - { - work.Item1(); - work.Item2.SetResult(EmptyStruct.Instance); - } - catch (Exception ex) - { - work.Item2.SetException(ex); - } - } - } - } - - /// - /// Decrements the dedicated thread use counter by at most one upon disposal. - /// - private class ThreadHandleRelease : IDisposable - { - /// - /// A value indicating whether this instance has already been disposed. - /// - private bool disposed; - - /// - /// Release the keep alive count reserved by this instance. - /// - public void Dispose() - { - lock (SyncObject) - { - if (!this.disposed) - { - this.disposed = true; - ReleaseRefOnDedicatedThread(); - } - } - } - } - } } } diff --git a/src/Microsoft.VisualStudio.Threading/LightUps.cs b/src/Microsoft.VisualStudio.Threading/LightUps.cs deleted file mode 100644 index e893b868c..000000000 --- a/src/Microsoft.VisualStudio.Threading/LightUps.cs +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -namespace Microsoft.VisualStudio.Threading -{ - using System; - - /// - /// A non-generic class used to store statics that do not vary by generic type argument. - /// - internal static class LightUps - { - /// - /// Gets a value indicating whether we execute Windows 7 code even on later versions of Windows. - /// - internal const bool ForceWindows7Mode = false; - - /// - /// The for Windows 8. - /// - private static readonly Version Windows8Version = new Version(6, 2, 9200); - - /// - /// Gets a value indicating whether the current operating system is Windows 8 or later. - /// - internal static bool IsWindows8OrLater - { - get - { - return !ForceWindows7Mode - && Environment.OSVersion.Platform == PlatformID.Win32NT - && Environment.OSVersion.Version >= Windows8Version; - } - } - } -} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index 447ae6689..301eb2ff7 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -789,51 +789,6 @@ public async Task AwaitRegKeyChange_CallingThreadDestroyed() } } - [SkippableFact] - public async Task AwaitRegKeyChange_DoesNotPreventAppTerminationOnWin7() - { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); - string testExePath = Path.Combine( - AppDomain.CurrentDomain.BaseDirectory!, - "..", - "..", - "..", - "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher", -#if DEBUG - "Debug", -#else - "Release", -#endif - "net472", - "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.exe"); - this.Logger.WriteLine("Using testexe path: {0}", testExePath); - var psi = new ProcessStartInfo(testExePath) - { - CreateNoWindow = true, - WindowStyle = ProcessWindowStyle.Hidden, - }; - Process testExeProcess = Process.Start(psi)!; - try - { - // The assertion and timeout are interesting here: - // If the dedicated thread is not a background thread, the process does - // seem to terminate anyway, but it can sometimes (3 out of 10 times) - // take up to 10 seconds to terminate (perhaps when a GC finalizer runs?) - // while other times it's really fast. - // But when the dedicated thread is a background thread, it seems reliably fast. - this.TimeoutTokenSource = new CancellationTokenSource(TimeSpan.FromSeconds(8)); - int exitCode = await AwaitExtensions.WaitForExitAsync(testExeProcess, this.TimeoutToken); - Assert.Equal(0, exitCode); - } - finally - { - if (!testExeProcess.HasExited) - { - testExeProcess.Kill(); - } - } - } - private class RegKeyTest : IDisposable { private readonly string keyName; From 5045ec56b5e6c3acef8fc9f697a68c5de94def09 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 May 2022 16:24:27 -0600 Subject: [PATCH 0478/1753] Disable a few tests that fail repeatedly in Azure Pipelines --- .../JoinableTaskTests.cs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index a97975f49..7ed1d5d38 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -3156,6 +3156,7 @@ public void MitigationAgainstBadSyncContextOnMainThread() #if ISOLATED_TEST_SUPPORT [Fact, Trait("Stress", "true")] [Trait("GC", "true")] + [Trait("TestCategory", "FailsInCloudTest")] public void SwitchToMainThreadMemoryLeak() { if (this.ExecuteInIsolation()) @@ -3172,6 +3173,7 @@ async delegate [Fact, Trait("Stress", "true")] [Trait("GC", "true")] + [Trait("TestCategory", "FailsInCloudTest")] public void SwitchToMainThreadMemoryLeakWithCancellationToken() { if (this.ExecuteInIsolation()) @@ -3453,6 +3455,7 @@ public void RunAsyncWithYieldingDelegateNestedInRunOverhead() } [Fact] + [Trait("TestCategory", "FailsInCloudTest")] public void SwitchToMainThreadShouldNotLeakJoinableTaskWhenGetResultRunsFirst() { WeakReference weakResult = this.SwitchToMainThreadShouldNotLeakJoinableTaskWhenGetResultRunsFirst_Helper(); From 2ba8ed981ed0cf8e60ef1d3103991f7b2f95fa9f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 May 2022 10:59:38 -0600 Subject: [PATCH 0479/1753] Replace manual p/invokes to consume CsWin32 generated code --- .../AwaitExtensions.cs | 22 +++++--- .../Microsoft.VisualStudio.Threading.csproj | 1 + .../NativeMethods.cs | 50 ------------------- .../NativeMethods.txt | 2 + .../NoMessagePumpSyncContext.cs | 9 +++- .../RegistryChangeNotificationFilters.cs | 13 ++--- 6 files changed, 32 insertions(+), 65 deletions(-) delete mode 100644 src/Microsoft.VisualStudio.Threading/NativeMethods.cs create mode 100644 src/Microsoft.VisualStudio.Threading/NativeMethods.txt diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index 0f7bb5d45..c0bf86a68 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -4,15 +4,16 @@ namespace Microsoft.VisualStudio.Threading { using System; - using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; using System.Runtime.ExceptionServices; using System.Runtime.InteropServices; using System.Threading; using System.Threading.Tasks; + using global::Windows.Win32; + using global::Windows.Win32.Foundation; + using global::Windows.Win32.System.Registry; using Microsoft.Win32; using Microsoft.Win32.SafeHandles; @@ -204,17 +205,26 @@ public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInli /// private static async Task WaitForRegistryChangeAsync(SafeRegistryHandle registryKeyHandle, bool watchSubtree, RegistryChangeNotificationFilters change, CancellationToken cancellationToken) { +#if NET5_0_OR_GREATER + if (!OperatingSystem.IsWindowsVersionAtLeast(8)) +#else + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) +#endif + { + throw new PlatformNotSupportedException(); + } + using ManualResetEvent evt = new(false); - change |= NativeMethods.REG_NOTIFY_THREAD_AGNOSTIC; - int win32Error = NativeMethods.RegNotifyChangeKeyValue( + REG_NOTIFY_FILTER dwNotifyFilter = (REG_NOTIFY_FILTER)change | REG_NOTIFY_FILTER.REG_NOTIFY_THREAD_AGNOSTIC; + WIN32_ERROR win32Error = PInvoke.RegNotifyChangeKeyValue( registryKeyHandle, watchSubtree, - change, + dwNotifyFilter, evt.SafeWaitHandle, true); if (win32Error != 0) { - throw new Win32Exception(win32Error); + throw new Win32Exception((int)win32Error); } await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 7cd1b743f..2fc64d27f 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -46,6 +46,7 @@ + From 6a1593c66812b348812be702b41320290839ce0c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Jun 2022 14:24:49 +0000 Subject: [PATCH 0484/1753] Bump StyleCop.Analyzers.Unstable from 1.2.0.406 to 1.2.0.435 (#156) --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index a2da14f66..22c1b94de 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -40,7 +40,7 @@ - + From a91a2f1e2331902ab7515f1d317cf105892b9cb9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Jun 2022 14:31:58 +0000 Subject: [PATCH 0485/1753] Bump xunit.runner.visualstudio from 2.4.3 to 2.4.5 (#158) --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 7dd444b67..402468a83 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -12,7 +12,7 @@ - + From b2b7a794b9dc89ed5b15935554dfe059168a9264 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 1 Jun 2022 15:01:01 -0600 Subject: [PATCH 0486/1753] Merge pull request #1048 from AArnott/updateDeps Update dependencies --- src/SosThreadingTools/SosThreadingTools.csproj | 4 ++-- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 9f0665a2b..9d6b5483b 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -26,8 +26,8 @@ - - + + diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index a0ce8d28e..b01911016 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -27,9 +27,9 @@ - - - + + + From fa9ad391d135e28d61ea2ba49d49a2bd365991a5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Jun 2022 15:26:19 -0600 Subject: [PATCH 0487/1753] Bump xunit.runner.visualstudio from 2.4.3 to 2.4.5 (#1052) Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.4.3 to 2.4.5. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/commits) --- updated-dependencies: - dependency-name: xunit.runner.visualstudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 +- .../Microsoft.VisualStudio.Threading.Tests.csproj | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index b01911016..a80a44636 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -32,7 +32,7 @@ - + diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 65e55c388..589bc95b5 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -33,7 +33,7 @@ - + From aa14b7909ef82031e4e5463b8f454802bee674b9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Jun 2022 21:26:32 +0000 Subject: [PATCH 0488/1753] Bump Nerdbank.GitVersioning from 3.5.85-alpha to 3.5.107 (#1053) --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 0c77e79b6..3e5254be1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -38,7 +38,7 @@ - + From 8cea471130fb29c0dd686645a7483fdae95a396c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Jun 2022 15:26:46 -0600 Subject: [PATCH 0489/1753] Bump StyleCop.Analyzers.Unstable from 1.2.0.406 to 1.2.0.435 (#1051) Bumps [StyleCop.Analyzers.Unstable](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) from 1.2.0.406 to 1.2.0.435. - [Release notes](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/releases) - [Commits](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commits) --- updated-dependencies: - dependency-name: StyleCop.Analyzers.Unstable dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 3e5254be1..120eef173 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -40,7 +40,7 @@ - + From 3f035ed919c5ba24ec5c5426023a6dc7cbec2b77 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Jun 2022 15:45:47 -0600 Subject: [PATCH 0490/1753] Bump Microsoft.Diagnostics.Runtime from 2.1.327704 to 2.1.330101 (#1049) Bumps [Microsoft.Diagnostics.Runtime](https://github.com/Microsoft/clrmd) from 2.1.327704 to 2.1.330101. - [Release notes](https://github.com/Microsoft/clrmd/releases) - [Changelog](https://github.com/microsoft/clrmd/blob/master/doc/ReleaseNotes2.0.md) - [Commits](https://github.com/Microsoft/clrmd/commits) --- updated-dependencies: - dependency-name: Microsoft.Diagnostics.Runtime dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- src/SosThreadingTools/SosThreadingTools.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 9d6b5483b..d0d3e4a6d 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -26,7 +26,7 @@ - + From 63022b967ef44bef2391e57b093927753f32b4f1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 6 Jun 2022 15:44:17 +0000 Subject: [PATCH 0491/1753] Bump Microsoft.NET.Test.Sdk from 17.1.0 to 17.2.0 (#1054) --- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 +- .../Microsoft.VisualStudio.Threading.Tests.csproj | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index a80a44636..fe79a3409 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -26,7 +26,7 @@ - + diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 589bc95b5..635ae6cbf 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -29,7 +29,7 @@ - + From 73aa23b392d0d031e7eff121125803df25a14f87 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 6 Jun 2022 09:52:33 -0600 Subject: [PATCH 0492/1753] Bump Microsoft.VisualStudio.Validation from 17.0.53 to 17.0.58 (#1050) Bumps [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) from 17.0.53 to 17.0.58. - [Release notes](https://github.com/microsoft/vs-validation/releases) - [Commits](https://github.com/microsoft/vs-validation/commits) --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Validation dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .../Microsoft.VisualStudio.Threading.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 2fc64d27f..aae3f5780 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -44,7 +44,7 @@ - + From 8f2ed5eaf2436e9e49e741650308c0b45b4a53df Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jun 2022 15:50:23 -0600 Subject: [PATCH 0493/1753] Update SDK to 6.0.300 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 234db6d1e..b13ca0aca 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,4 @@ -FROM mcr.microsoft.com/dotnet/sdk:6.0.200-focal +FROM mcr.microsoft.com/dotnet/sdk:6.0.300-focal # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 6bfbd1775..954a92e75 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "6.0.200", + "version": "6.0.300", "rollForward": "patch", "allowPrerelease": false } From 8c6b68ecdd6cb98a02bc89e762d4cf8851e0148b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jun 2022 08:48:38 -0600 Subject: [PATCH 0494/1753] Add adoption caution about github issues being closed --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0f9715f38..8cab6b7af 100644 --- a/README.md +++ b/README.md @@ -79,5 +79,9 @@ We create the merge commit with these commands: 1. Run `git commit-tree -p HEAD -p A B -m "Merged latest Library.Template"`, where `A` is the output from `git rev-parse HEAD` that you recorded earlier, and `B` is the output from your prior `git write-tree` command. 1. Run `git merge X` where `X` is the output of the `git commit-tree` command. +**CAUTION**: when merging this for the first time, a github-hosted repo may close issues in your repo with the same number as issues that this repo closed in git commit messages. +Verify after completing your PR by visiting your github closed issues, sorted by recently updated, and reactivate any that were inadvertently closed by this merge. +This shouldn't be a recurring issue because going forward, we will avoid referencing github issues with simple `#123` syntax in this repo's history. + Congratulations. You're all done. Next time you want to sync to latest from Library.Template, you can the simple `git merge` steps given at the start of this section. From f678dd36be37f69272b6346b4ba3acb7472ec418 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jun 2022 12:12:42 -0600 Subject: [PATCH 0495/1753] Install the nuget cred provider for .NET 6 and .NET Framework Recently we've only been getting the .NET Core 3.1 plugin, which leaves .NET Framework-based nuget tools un-authenticated. --- tools/Install-NuGetCredProvider.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index 6d3100349..496049a29 100755 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -33,7 +33,7 @@ if ($IsMacOS -or $IsLinux) { $installerScript = Join-Path $toolsPath $installerScript -if (!(Test-Path $installerScript)) { +if (!(Test-Path $installerScript) -or $Force) { Invoke-WebRequest $sourceUrl -OutFile $installerScript } @@ -43,7 +43,7 @@ if ($IsMacOS -or $IsLinux) { chmod u+x $installerScript } -& $installerScript -Force:$Force +& $installerScript -Force:$Force -AddNetfx -InstallNet6 if ($AccessToken) { $endpoints = @() From d8f567ef793329d7ff8cc09cf43922d2d00316c9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jun 2022 08:58:02 -0600 Subject: [PATCH 0496/1753] Avoid truncated code coverage data Apply workaround for microsoft/vstest issue 3724. --- azure-pipelines/artifacts/coverageResults.ps1 | 7 +-- azure-pipelines/dotnet-test-cloud.ps1 | 3 +- azure-pipelines/publish-codecoverage.yml | 7 +-- azure-pipelines/test.runsettings | 44 +++++++++++++++++++ test/Directory.Build.targets | 7 --- test/Library.Tests/Library.Tests.csproj | 1 - 6 files changed, 54 insertions(+), 15 deletions(-) create mode 100644 azure-pipelines/test.runsettings diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index 8fdb3f720..b3a08891b 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -1,10 +1,11 @@ $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +$coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse) + # Prepare code coverage reports for merging on another machine if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`"" - $reports = Get-ChildItem "$RepoRoot/bin/coverage.*cobertura.xml" -Recurse - $reports |% { + $coverageFiles |% { $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } Set-Content -Path $_ -Value $content -Encoding UTF8 } @@ -16,7 +17,7 @@ if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } @{ $RepoRoot = ( - @(Get-ChildItem "$RepoRoot\bin\coverage.*cobertura.xml" -Recurse) + + $coverageFiles + (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse) ); } diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 43cdc3e00..24bf812a1 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -48,7 +48,8 @@ if ($x86) { --no-build ` -c $Configuration ` --filter "TestCategory!=FailsInCloudTest" ` - -p:CollectCoverage=true ` + --collect "Code Coverage;Format=cobertura" ` + --settings "$PSScriptRoot/test.runsettings" ` --blame-hang-timeout 60s ` --blame-crash ` -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 423e12fce..4bc1b3bb7 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -16,14 +16,15 @@ steps: continueOnError: true condition: ${{ parameters.includeMacOS }} - powershell: | - dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 4.8.5 --configfile azure-pipelines/justnugetorg.nuget.config + dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 5.1.9 --configfile azure-pipelines/justnugetorg.nuget.config Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj Write-Host 'Substituting {reporoot} with $(System.DefaultWorkingDirectory)' - $reports = Get-ChildItem -Recurse '$(Pipeline.Workspace)/coverage.*cobertura.xml' + $reports = Get-ChildItem -Recurse '$(Pipeline.Workspace)/*.cobertura.xml' $reports |% { $content = Get-Content -Path $_ |% { $_.Replace('{reporoot}', '$(System.DefaultWorkingDirectory)') } Set-Content -Path $_ -Value $content -Encoding UTF8 } + $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_ })) obj/reportgenerator -reports:"$Inputs" -targetdir:coveragereport -reporttypes:Cobertura displayName: ⚙ Merge coverage @@ -31,5 +32,5 @@ steps: displayName: 📢 Publish code coverage results to Azure DevOps inputs: codeCoverageTool: cobertura - summaryFileLocation: 'coveragereport/Cobertura.xml' + summaryFileLocation: coveragereport/Cobertura.xml failIfCoverageEmpty: true diff --git a/azure-pipelines/test.runsettings b/azure-pipelines/test.runsettings new file mode 100644 index 000000000..c69022fc0 --- /dev/null +++ b/azure-pipelines/test.runsettings @@ -0,0 +1,44 @@ + + + + + + + + + \.dll$ + \.exe$ + + + xunit\..* + + + + + ^System\.Diagnostics\.DebuggerHiddenAttribute$ + ^System\.Diagnostics\.DebuggerNonUserCodeAttribute$ + ^System\.CodeDom\.Compiler\.GeneratedCodeAttribute$ + ^System\.Diagnostics\.CodeAnalysis\.ExcludeFromCodeCoverageAttribute$ + + + + + True + + True + + True + + False + + True + + True + + True + + + + + + diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index 2faab3754..e7edee55a 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,10 +1,3 @@ - - cobertura - [xunit.*]* - - $(OutputPath)/ - - diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 402468a83..92062dc79 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,6 @@ - From f064b9a150eb529716d393fc0f1f60b55a301eb4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jun 2022 16:22:01 -0600 Subject: [PATCH 0497/1753] Normalize slashes in coverage --- azure-pipelines/publish-codecoverage.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 4bc1b3bb7..23e88a6e8 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -21,7 +21,8 @@ steps: Write-Host 'Substituting {reporoot} with $(System.DefaultWorkingDirectory)' $reports = Get-ChildItem -Recurse '$(Pipeline.Workspace)/*.cobertura.xml' $reports |% { - $content = Get-Content -Path $_ |% { $_.Replace('{reporoot}', '$(System.DefaultWorkingDirectory)') } + # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. + $content = Get-Content -Path $_ |% { [Regex]::Replace($_, '{reporoot}([^"]+)', { '$(System.DefaultWorkingDirectory)' + $args[0].groups[1].value.replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) }) } Set-Content -Path $_ -Value $content -Encoding UTF8 } From e903112e9ebff59ebad913bf6c89b14f97f707b1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jun 2022 13:20:10 -0600 Subject: [PATCH 0498/1753] Include only unique coverage reports in artifact The test runner is creating *two* cobertura.xml files for each test run. Besides doubling the size of the coverageResults artifact, this makes the `publish-codecoverage.yml` pipeline step do much more work which can take *minutes* instead of seconds. --- azure-pipelines/artifacts/coverageResults.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index b3a08891b..280ff9ae0 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -1,6 +1,6 @@ $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") -$coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse) +$coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse | Where {$_.FullName -notlike "*/In/*" -and $_.FullName -notlike "*\In\*" }) # Prepare code coverage reports for merging on another machine if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { From 0847b84735ed0e192efa1056cbe7ce05a7aba677 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jun 2022 13:42:00 -0600 Subject: [PATCH 0499/1753] Provide another example of VSTHRD100 resolution --- doc/analyzers/VSTHRD100.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/analyzers/VSTHRD100.md b/doc/analyzers/VSTHRD100.md index 771a606ef..b1a7278d5 100644 --- a/doc/analyzers/VSTHRD100.md +++ b/doc/analyzers/VSTHRD100.md @@ -24,7 +24,9 @@ async Task DoSomethingAsync() } ``` -A code fix is offered that automatically changes the return type of the method. +A code fix is offered that automatically changes the return type of the method. + +### Event handlers For event handlers, avoid `async void` by using `RunAsync`: ```csharp @@ -37,4 +39,18 @@ private async Task OnEventAsync(object sender, EventArgs e) } ``` +When using method group syntax as an argument, you can define the method with the required signature, without the `async` modifier, and define an anonymous delegate or lambda within the method, like this: + +```cs +var menuItem = new MenuCommand(HandleEvent, commandId); + +private void HandleEvent(object sender, EventArgs e) +{ + _ = joinableTaskFactory.RunAsync(async () => + { + // async code + }); +} +``` + Refer to [Async/Await - Best Practices in Asynchronous Programming](https://msdn.microsoft.com/en-us/magazine/jj991977.aspx) for more info. From 2593c30ffcb90f40196d8450707ed553658af22a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jun 2022 18:25:16 -0600 Subject: [PATCH 0500/1753] Revert "Expose a property on whether JoinableTaskContext has any JTF blocking calls on the main thread (#1026)" This reverts commit 553c404a46e916c2ca3a4afe69ce2f642c502c77. --- .../JoinableTaskContext.cs | 34 ------- .../JoinableTaskFactory.cs | 13 --- .../net472/PublicAPI.Shipped.txt | 1 - .../net6.0-windows/PublicAPI.Shipped.txt | 1 - .../net6.0/PublicAPI.Shipped.txt | 1 - .../netcoreapp3.1/PublicAPI.Shipped.txt | 1 - .../netstandard2.0/PublicAPI.Shipped.txt | 1 - .../JoinableTaskContextTests.cs | 91 ++----------------- 8 files changed, 6 insertions(+), 137 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 5c71a7ecf..3fa22c923 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -116,11 +116,6 @@ public partial class JoinableTaskContext : IDisposable /// private readonly int mainThreadManagedThreadId; - /// - /// The count of blocking API calls on the main thread. - /// - private volatile int mainThreadJTFBlockingCount; - /// /// A single joinable task factory that itself cannot be joined. /// @@ -205,11 +200,6 @@ public bool IsWithinJoinableTask get { return this.AmbientTask is object; } } - /// - /// Gets a value indicating whether the main thread is blocked by any joinable task. - /// - public bool IsMainThreadBlockedByAnyone => this.mainThreadJTFBlockingCount > 0; - /// /// Gets the underlying that controls the main thread in the host. /// @@ -486,30 +476,6 @@ internal IDisposable RegisterHangNotifications(JoinableTaskContextNode node) return new HangNotificationRegistration(node); } - /// - /// Increment the count of blocking API calls on the main thread. - /// - /// - /// This method should only be called on the main thread. - /// - internal void IncrementMainThreadBlockingCount() - { - Assumes.True(this.IsOnMainThread); - this.mainThreadJTFBlockingCount++; - } - - /// - /// Decrement the count of blocking API calls on the main thread. - /// - /// - /// This method should only be called on the main thread. - /// - internal void DecrementMainThreadBlockingCount() - { - Assumes.True(this.IsOnMainThread); - this.mainThreadJTFBlockingCount--; - } - /// /// Invoked when a hang is suspected to have occurred involving the main thread. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 7d6848100..3c35da3e4 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -545,12 +545,6 @@ protected internal virtual void WaitSynchronously(Task task) protected virtual void WaitSynchronouslyCore(Task task) { Requires.NotNull(task, nameof(task)); - - if (this.Context.IsOnMainThread) - { - this.Context.IncrementMainThreadBlockingCount(); - } - int hangTimeoutsCount = 0; // useful for debugging dump files to see how many times we looped. int hangNotificationCount = 0; Guid hangId = Guid.Empty; @@ -594,13 +588,6 @@ protected virtual void WaitSynchronouslyCore(Task task) // Our caller just wants to know when the Task completes, // whether successfully or not. } - finally - { - if (this.Context.IsOnMainThread) - { - this.Context.DecrementMainThreadBlockingCount(); - } - } } /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt index 4c31e1fcf..3d7cc2bc8 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt @@ -244,7 +244,6 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt index 4c31e1fcf..3d7cc2bc8 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt @@ -244,7 +244,6 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt index 0cab613db..916298d7d 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt @@ -243,7 +243,6 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt index 0cab613db..916298d7d 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt @@ -243,7 +243,6 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt index 0cab613db..916298d7d 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt @@ -243,7 +243,6 @@ Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.ge Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlockedByAnyone.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index c9d7c69f5..d0b00c42f 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -45,85 +45,6 @@ await Task.Run(delegate }); } - [Fact] - public void IsMainThreadBlockedByAnyone_True() - { - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - AsyncManualResetEvent mainThreadBlockerEvent = new AsyncManualResetEvent(false); - AsyncManualResetEvent backgroundThreadMonitorEvent = new AsyncManualResetEvent(false); - - // Start task to monitor IsMainThreadBlockedByAnyone - Task monitorTask = Task.Run(async () => - { - await mainThreadBlockerEvent.WaitAsync(this.TimeoutToken); - - while (!this.Context.IsMainThreadBlockedByAnyone) - { - // Give the main thread time to enter a blocking state, if the test hasn't already timed out. - await Task.Delay(50, this.TimeoutToken); - } - - backgroundThreadMonitorEvent.Set(); - }); - - JoinableTask? joinable = this.Factory.RunAsync(async delegate - { - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - await this.Factory.SwitchToMainThreadAsync(this.TimeoutToken); - - this.Factory.Run(async () => - { - await TaskScheduler.Default.SwitchTo(alwaysYield: true); - mainThreadBlockerEvent.Set(); - await backgroundThreadMonitorEvent.WaitAsync(this.TimeoutToken); - }); - }); - - joinable.Join(); - monitorTask.WaitWithoutInlining(throwOriginalException: true); - - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - } - - [Fact] - public void IsMainThreadBlockedByAnyone_False() - { - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - ManualResetEventSlim backgroundThreadBlockerEvent = new(); - - JoinableTask? joinable = this.Factory.RunAsync(async delegate - { - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - await TaskScheduler.Default.SwitchTo(alwaysYield: true); - - this.Factory.Run(async () => - { - backgroundThreadBlockerEvent.Set(); - - // Set a delay sufficient for the other thread to have noticed if IsMainThreadBlockedByAnyone is true - // while we're suspended. - await Task.Delay(AsyncDelay); - }); - }); - - backgroundThreadBlockerEvent.Wait(UnexpectedTimeout); - - do - { - // Give the background thread time to enter a blocking state, if the test hasn't already timed out. - this.TimeoutToken.ThrowIfCancellationRequested(); - - // IsMainThreadBlockedByAnyone should be false when a background thread is blocked. - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - Thread.Sleep(10); - } - while (!joinable.IsCompleted); - - joinable.Join(); - - Assert.False(this.Context.IsMainThreadBlockedByAnyone); - } - [Fact] public void ReportHangOnRun() { @@ -489,8 +410,8 @@ public void GetHangReportProducesDgmlWithNamedJoinableCollections() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Collection" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Collection" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label == jtcName); return Task.CompletedTask; }); @@ -512,8 +433,8 @@ public void GetHangReportProducesDgmlWithMethodNameRequestingMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.GetHangReportProducesDgmlWithMethodNameRequestingMainThread))); } @@ -535,8 +456,8 @@ public void GetHangReportProducesDgmlWithMethodNameYieldingOnMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.YieldingMethodAsync))); }); } From c881dcad9590e33952a956950d6a2e4c4249c0ef Mon Sep 17 00:00:00 2001 From: Steve Bush Date: Wed, 15 Jun 2022 09:02:52 -0700 Subject: [PATCH 0501/1753] CodeCov binary uploader Replaces the bash CodeCov uploader with the latest binary version. A PowerShell script downloads the latest codecov binary. Another PowerShell script collects and uploads code coverage artifact files to CodeCov.io. You can pass flags and a coverage report name as parameters. --- .github/workflows/build.yml | 5 ++-- azure-pipelines/Get-CodeCovTool.ps1 | 38 ++++++++++++++++++++++++++ azure-pipelines/dotnet.yml | 5 +++- azure-pipelines/publish-CodeCov.ps1 | 42 +++++++++++++++++++++++++++++ 4 files changed, 87 insertions(+), 3 deletions(-) create mode 100644 azure-pipelines/Get-CodeCovTool.ps1 create mode 100644 azure-pipelines/publish-CodeCov.ps1 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4db43f53c..cde83cd9b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -109,7 +109,8 @@ jobs: path: ${{ runner.temp }}/_artifacts/deployables if: always() - name: Publish code coverage results to codecov.io - run: bash <(curl -s https://codecov.io/bash) - shell: bash + run: ./azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}Host,${{ env.BUILDCONFIGURATION }}" + shell: pwsh timeout-minutes: 3 continue-on-error: true + if: always() diff --git a/azure-pipelines/Get-CodeCovTool.ps1 b/azure-pipelines/Get-CodeCovTool.ps1 new file mode 100644 index 000000000..d6ca157bf --- /dev/null +++ b/azure-pipelines/Get-CodeCovTool.ps1 @@ -0,0 +1,38 @@ +<# +.SYNOPSIS + Downloads the CodeCov.io uploader tool and returns the path to it. +#> +[CmdletBinding()] +Param( +) + +$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" +$binaryToolsPath = Join-Path $toolsPath codecov +if (!(Test-Path $binaryToolsPath)) { $null = mkdir $binaryToolsPath } + +if ($IsMacOS) +{ + $codeCovPath = Join-Path $binaryToolsPath codecov + $codeCovUrl = "https://uploader.codecov.io/latest/macos/codecov" +} +elseif ($IsLinux) +{ + $codeCovPath = Join-Path $binaryToolsPath codecov + $codeCovUrl = "https://uploader.codecov.io/latest/linux/codecov" +} +else +{ + $codeCovPath = Join-Path $binaryToolsPath codecov.exe + $codeCovUrl = "https://uploader.codecov.io/latest/windows/codecov.exe" +} + +if (!(Test-Path $codeCovPath)) { + Write-Host "Downloading latest codeconv..." -ForegroundColor Yellow + (New-Object System.Net.WebClient).DownloadFile($codeCovUrl, $codeCovPath) +} + +if ($IsMacOS -or $IsLinux) { + chmod u+x $codeCovPath +} + +return (Resolve-Path $codeCovPath).Path diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 1d7d9de76..a461c147d 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -16,7 +16,10 @@ steps: displayName: 📢 Publish artifacts condition: succeededOrFailed() -- bash: bash <(curl -s https://codecov.io/bash) +- powershell: | + $ArtifactStagingFolder = & "azure-pipelines/Get-ArtifactsStagingDirectory.ps1" + $CoverageResultsFolder = Join-Path $ArtifactStagingFolder "coverageResults-$(Agent.JobName)" + azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "$(codecov_token)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)Host,$(BuildConfiguration)" displayName: 📢 Publish code coverage results to codecov.io condition: ne(variables['codecov_token'], '') timeoutInMinutes: 3 diff --git a/azure-pipelines/publish-CodeCov.ps1 b/azure-pipelines/publish-CodeCov.ps1 new file mode 100644 index 000000000..ec550e7aa --- /dev/null +++ b/azure-pipelines/publish-CodeCov.ps1 @@ -0,0 +1,42 @@ +<# +.SYNOPSIS + Uploads code coverage to codecov.io +.PARAMETER CodeCovToken + Code coverage token to use +.PARAMETER PathToCodeCoverage + Path to root of code coverage files +.PARAMETER Name + Optional name to upload with codecoverge +.PARAMETER Flags + Optional flags to upload with codecoverge +#> +[CmdletBinding()] +Param ( + [string]$CodeCovToken, + [string]$PathToCodeCoverage, + [string]$Name="", + [string]$Flags="" +) + +$RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path +$CodeCoveragePathWildcard = (Join-Path $PathToCodeCoverage "*.cobertura.xml") + +Write-Host "RepoRoot: $RepoRoot" -ForegroundColor Yellow +Write-Host "CodeCoveragePathWildcard: $CodeCoveragePathWildcard" -ForegroundColor Yellow + +Get-ChildItem -Recurse -Path $CodeCoveragePathWildcard | % { + + if ($IsMacOS -or $IsLinux) + { + $relativeFilePath = Resolve-Path -relative $_ + } + else + { + $relativeFilePath = Resolve-Path -relative (Get-ChildItem $_ | Select-Object -ExpandProperty Target) + } + + Write-Host "Uploading: $relativeFilePath" -ForegroundColor Yellow + Write-Host "Flags: $Flags$TargetFrameworkFlag$TestTypeFlag$OSTypeFlag" -ForegroundColor Yellow + + & (& "$PSScriptRoot/Get-CodeCovTool.ps1") -t "$CodeCovToken" -f "$relativeFilePath" -R "$RepoRoot" -F "$Flags" -n "$Name" +} From 79a441098f323457a8033a09a843300b00631de3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jun 2022 13:08:50 -0600 Subject: [PATCH 0502/1753] Add completions for dotnet-test-cloud script --- azure-pipelines/dotnet-test-cloud.ps1 | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 24bf812a1..d07f1ad8f 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -16,6 +16,7 @@ #> [CmdletBinding()] Param( + [ValidateSet('Debug', 'Release')] [string]$Configuration='Debug', [string]$Agent='Local', [switch]$PublishResults, From 85d970c258bafda482b003ba79f4510a491a570d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jun 2022 13:09:08 -0600 Subject: [PATCH 0503/1753] Move coverage merge script to a ps1 that can be locally invoked --- .gitignore | 1 + azure-pipelines/Merge-CodeCoverage.ps1 | 42 ++++++++++++++++++++++++ azure-pipelines/publish-codecoverage.yml | 14 +------- 3 files changed, 44 insertions(+), 13 deletions(-) create mode 100644 azure-pipelines/Merge-CodeCoverage.ps1 diff --git a/.gitignore b/.gitignore index 65f947769..3bb499198 100644 --- a/.gitignore +++ b/.gitignore @@ -140,6 +140,7 @@ _TeamCity* # Visual Studio code coverage results *.coverage *.coveragexml +/coveragereport/ # NCrunch _NCrunch_* diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 new file mode 100644 index 000000000..6672b94cd --- /dev/null +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -0,0 +1,42 @@ +#!/usr/bin/env pwsh + +<# +.SYNOPSIS + Merges code coverage reports. +.PARAMETER Path + The path(s) to search for Cobertura code coverage reports. +.PARAMETER Format + The format for the merged result. The default is Cobertura +.PARAMETER OutputDir + The directory the merged result will be written to. The default is `coveragereport` in the root of this repo. +#> +[CmdletBinding()] +Param( + [Parameter(Mandatory=$true)] + [string[]]$Path, + [ValidateSet('Badges', 'Clover', 'Cobertura', 'CsvSummary', 'Html', 'Html_Dark', 'Html_Light', 'HtmlChart', 'HtmlInline', 'HtmlInline_AzurePipelines', 'HtmlInline_AzurePipelines_Dark', 'HtmlInline_AzurePipelines_Light', 'HtmlSummary', 'JsonSummary', 'Latex', 'LatexSummary', 'lcov', 'MarkdownSummary', 'MHtml', 'PngChart', 'SonarQube', 'TeamCitySummary', 'TextSummary', 'Xml', 'XmlSummary')] + [string]$Format='Cobertura', + [string]$OutputDir=("$PSScriptRoot/../coveragereport") +) + +$RepoRoot = [string](Resolve-Path $PSScriptRoot/..) + +if (!(Test-Path $RepoRoot/obj/reportgenerator*)) { + dotnet tool install --tool-path $RepoRoot/obj dotnet-reportgenerator-globaltool --version 5.1.9 --configfile $PSScriptRoot/justnugetorg.nuget.config +} + +Write-Verbose "Searching $Path for *.cobertura.xml files" +$reports = Get-ChildItem -Recurse $Path -Filter *.cobertura.xml + +if ($reports) { + $reports |% { $_.FullName } |% { + # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. + $content = Get-Content -Path $_ |% { [Regex]::Replace($_, '{reporoot}([^"]+)', { $RepoRoot + $args[0].groups[1].value.replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) }) } + Set-Content -Path $_ -Value $content -Encoding UTF8 + } + + $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_.FullName })) + & "$RepoRoot/obj/reportgenerator" -reports:"$Inputs" -targetdir:$OutputDir -reporttypes:$Format +} else { + Write-Error "No reports found to merge." +} diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 23e88a6e8..6e7ef21bd 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -15,19 +15,7 @@ steps: displayName: 🔻 Download macOS code coverage results continueOnError: true condition: ${{ parameters.includeMacOS }} -- powershell: | - dotnet tool install --tool-path obj dotnet-reportgenerator-globaltool --version 5.1.9 --configfile azure-pipelines/justnugetorg.nuget.config - Copy-Item -Recurse $(Pipeline.Workspace)/coverageResults-Windows/obj/* $(System.DefaultWorkingDirectory)/obj - Write-Host 'Substituting {reporoot} with $(System.DefaultWorkingDirectory)' - $reports = Get-ChildItem -Recurse '$(Pipeline.Workspace)/*.cobertura.xml' - $reports |% { - # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. - $content = Get-Content -Path $_ |% { [Regex]::Replace($_, '{reporoot}([^"]+)', { '$(System.DefaultWorkingDirectory)' + $args[0].groups[1].value.replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) }) } - Set-Content -Path $_ -Value $content -Encoding UTF8 - } - - $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_ })) - obj/reportgenerator -reports:"$Inputs" -targetdir:coveragereport -reporttypes:Cobertura +- powershell: azure-pipelines/Merge-CodeCoverage.ps1 -Path '$(Pipeline.Workspace)' -OutputDir coveragereport -Format Cobertura -Verbose displayName: ⚙ Merge coverage - task: PublishCodeCoverageResults@1 displayName: 📢 Publish code coverage results to Azure DevOps From ed1a9e20581886261d63793e6b4d7e1982d094ce Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 Jun 2022 11:24:33 -0600 Subject: [PATCH 0504/1753] Fix InsertConfigValues inclusion of the VSInsertionMetadata package The SBOM check was preventing generation of the package, which meant that later the InsertConfigValues.ps1 script wouldn't pick it up. --- azure-pipelines/artifacts/VSInsertion.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 0e848f3c2..499bdc01d 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -13,9 +13,6 @@ $NuGetPackages = "$RepoRoot\bin\Packages\$config\NuGet" $CoreXTPackages = "$RepoRoot\bin\Packages\$config\CoreXT" if (-not (Test-Path $NuGetPackages)) { Write-Warning "No NuGet packages found. Has a build been run?"; return @{} } -# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $NuGetPackages/_manifest)) { return @{} } - $ArtifactBasePath = "$RepoRoot\obj\_artifacts" $ArtifactPath = "$ArtifactBasePath\VSInsertion" if (-not (Test-Path $ArtifactPath)) { New-Item -ItemType Directory -Path $ArtifactPath | Out-Null } @@ -39,6 +36,9 @@ if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } +# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $NuGetPackages/_manifest)) { return @{} } + @{ "$NuGetPackages" = (Get-ChildItem -Recurse $NuGetPackages); "$CoreXTPackages" = (Get-ChildItem "$CoreXTPackages\Microsoft.VisualStudio.Threading.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); From ac247b8566c88e201f1df92013048ce7f3a30772 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 Jun 2022 15:44:22 -0600 Subject: [PATCH 0505/1753] Revert "Add completions for dotnet-test-cloud script" It was problematic since it disallowed non-default config names. This reverts commit 79a441098f323457a8033a09a843300b00631de3. --- azure-pipelines/dotnet-test-cloud.ps1 | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index d07f1ad8f..24bf812a1 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -16,7 +16,6 @@ #> [CmdletBinding()] Param( - [ValidateSet('Debug', 'Release')] [string]$Configuration='Debug', [string]$Agent='Local', [switch]$PublishResults, From 6156061d6576a32b150393a22787c24629ef1545 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 18 Jun 2022 12:15:07 -0600 Subject: [PATCH 0506/1753] Touch-up formatting and simplify/correct a bit --- azure-pipelines/Get-CodeCovTool.ps1 | 11 ++++------- azure-pipelines/publish-CodeCov.ps1 | 30 +++++++++-------------------- 2 files changed, 13 insertions(+), 28 deletions(-) diff --git a/azure-pipelines/Get-CodeCovTool.ps1 b/azure-pipelines/Get-CodeCovTool.ps1 index d6ca157bf..63b5d3f3c 100644 --- a/azure-pipelines/Get-CodeCovTool.ps1 +++ b/azure-pipelines/Get-CodeCovTool.ps1 @@ -10,24 +10,21 @@ $toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" $binaryToolsPath = Join-Path $toolsPath codecov if (!(Test-Path $binaryToolsPath)) { $null = mkdir $binaryToolsPath } -if ($IsMacOS) -{ +if ($IsMacOS) { $codeCovPath = Join-Path $binaryToolsPath codecov $codeCovUrl = "https://uploader.codecov.io/latest/macos/codecov" } -elseif ($IsLinux) -{ +elseif ($IsLinux) { $codeCovPath = Join-Path $binaryToolsPath codecov $codeCovUrl = "https://uploader.codecov.io/latest/linux/codecov" } -else -{ +else { $codeCovPath = Join-Path $binaryToolsPath codecov.exe $codeCovUrl = "https://uploader.codecov.io/latest/windows/codecov.exe" } if (!(Test-Path $codeCovPath)) { - Write-Host "Downloading latest codeconv..." -ForegroundColor Yellow + Write-Host "Downloading latest codecov upload tool..." -ForegroundColor Yellow (New-Object System.Net.WebClient).DownloadFile($codeCovUrl, $codeCovPath) } diff --git a/azure-pipelines/publish-CodeCov.ps1 b/azure-pipelines/publish-CodeCov.ps1 index ec550e7aa..1f4d3790f 100644 --- a/azure-pipelines/publish-CodeCov.ps1 +++ b/azure-pipelines/publish-CodeCov.ps1 @@ -6,37 +6,25 @@ .PARAMETER PathToCodeCoverage Path to root of code coverage files .PARAMETER Name - Optional name to upload with codecoverge + Name to upload with codecoverge .PARAMETER Flags - Optional flags to upload with codecoverge + Flags to upload with codecoverge #> [CmdletBinding()] Param ( + [Parameter(Mandatory=$true)] [string]$CodeCovToken, + [Parameter(Mandatory=$true)] [string]$PathToCodeCoverage, - [string]$Name="", - [string]$Flags="" + [string]$Name, + [string]$Flags ) $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path -$CodeCoveragePathWildcard = (Join-Path $PathToCodeCoverage "*.cobertura.xml") -Write-Host "RepoRoot: $RepoRoot" -ForegroundColor Yellow -Write-Host "CodeCoveragePathWildcard: $CodeCoveragePathWildcard" -ForegroundColor Yellow - -Get-ChildItem -Recurse -Path $CodeCoveragePathWildcard | % { - - if ($IsMacOS -or $IsLinux) - { - $relativeFilePath = Resolve-Path -relative $_ - } - else - { - $relativeFilePath = Resolve-Path -relative (Get-ChildItem $_ | Select-Object -ExpandProperty Target) - } +Get-ChildItem -Recurse -Path $PathToCodeCoverage -Filter "*.cobertura.xml" | % { + $relativeFilePath = Resolve-Path -relative $_ Write-Host "Uploading: $relativeFilePath" -ForegroundColor Yellow - Write-Host "Flags: $Flags$TargetFrameworkFlag$TestTypeFlag$OSTypeFlag" -ForegroundColor Yellow - - & (& "$PSScriptRoot/Get-CodeCovTool.ps1") -t "$CodeCovToken" -f "$relativeFilePath" -R "$RepoRoot" -F "$Flags" -n "$Name" + & (& "$PSScriptRoot/Get-CodeCovTool.ps1") -t $CodeCovToken -f $relativeFilePath -R $RepoRoot -F $Flags -n $Name } From 50d35dfde8113caedeca40f6c14d8b93686b3055 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 18 Jun 2022 15:22:38 -0600 Subject: [PATCH 0507/1753] fixup --- azure-pipelines/publish-CodeCov.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/publish-CodeCov.ps1 b/azure-pipelines/publish-CodeCov.ps1 index 1f4d3790f..9926f0188 100644 --- a/azure-pipelines/publish-CodeCov.ps1 +++ b/azure-pipelines/publish-CodeCov.ps1 @@ -23,7 +23,7 @@ Param ( $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path Get-ChildItem -Recurse -Path $PathToCodeCoverage -Filter "*.cobertura.xml" | % { - $relativeFilePath = Resolve-Path -relative $_ + $relativeFilePath = Resolve-Path -relative $_.FullName Write-Host "Uploading: $relativeFilePath" -ForegroundColor Yellow & (& "$PSScriptRoot/Get-CodeCovTool.ps1") -t $CodeCovToken -f $relativeFilePath -R $RepoRoot -F $Flags -n $Name From 8abd437547653f0c2a01eb96dcf75d9945829cf0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 18 Jun 2022 14:54:27 -0600 Subject: [PATCH 0508/1753] Add signature validation --- azure-pipelines/Get-CodeCovTool.ps1 | 77 ++++++++++++++++++++++++----- 1 file changed, 64 insertions(+), 13 deletions(-) diff --git a/azure-pipelines/Get-CodeCovTool.ps1 b/azure-pipelines/Get-CodeCovTool.ps1 index 63b5d3f3c..ca580b4db 100644 --- a/azure-pipelines/Get-CodeCovTool.ps1 +++ b/azure-pipelines/Get-CodeCovTool.ps1 @@ -1,35 +1,86 @@ <# .SYNOPSIS Downloads the CodeCov.io uploader tool and returns the path to it. +.PARAMETER AllowSkipVerify + Allows skipping signature verification of the downloaded tool if gpg is not installed. #> [CmdletBinding()] Param( + [switch]$AllowSkipVerify ) -$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" -$binaryToolsPath = Join-Path $toolsPath codecov -if (!(Test-Path $binaryToolsPath)) { $null = mkdir $binaryToolsPath } - if ($IsMacOS) { - $codeCovPath = Join-Path $binaryToolsPath codecov $codeCovUrl = "https://uploader.codecov.io/latest/macos/codecov" + $toolName = 'codecov' } elseif ($IsLinux) { - $codeCovPath = Join-Path $binaryToolsPath codecov $codeCovUrl = "https://uploader.codecov.io/latest/linux/codecov" + $toolName = 'codecov' } else { - $codeCovPath = Join-Path $binaryToolsPath codecov.exe $codeCovUrl = "https://uploader.codecov.io/latest/windows/codecov.exe" + $toolName = 'codecov.exe' } -if (!(Test-Path $codeCovPath)) { - Write-Host "Downloading latest codecov upload tool..." -ForegroundColor Yellow - (New-Object System.Net.WebClient).DownloadFile($codeCovUrl, $codeCovPath) +$shaSuffix = ".SHA256SUM" +$sigSuffix = $shaSuffix + ".sig" + +Function Get-FileFromWeb([Uri]$Uri, $OutDir) { + $OutFile = Join-Path $OutDir $Uri.Segments[-1] + if (!(Test-Path $OutFile)) { + Write-Verbose "Downloading $Uri..." + if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir | Out-Null } + try { + (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) + } finally { + # This try/finally causes the script to abort + } + } + + $OutFile } -if ($IsMacOS -or $IsLinux) { - chmod u+x $codeCovPath +$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" +$binaryToolsPath = Join-Path $toolsPath codecov +$testingPath = Join-Path $binaryToolsPath unverified +$finalToolPath = Join-Path $binaryToolsPath $toolName + +if (!(Test-Path $finalToolPath)) { + if (Test-Path $testingPath) { + Remove-Item -Recurse -Force $testingPath # ensure we download all matching files + } + $tool = Get-FileFromWeb $codeCovUrl $testingPath + $sha = Get-FileFromWeb "$codeCovUrl$shaSuffix" $testingPath + $sig = Get-FileFromWeb "$codeCovUrl$sigSuffix" $testingPath + $key = Get-FileFromWeb https://keybase.io/codecovsecurity/pgp_keys.asc $testingPath + + if ((Get-Command gpg -ErrorAction SilentlyContinue)) { + Write-Host "Importing codecov key" -ForegroundColor Yellow + gpg --import $key + Write-Host "Verifying signature on codecov hash" -ForegroundColor Yellow + gpg --verify $sig $sha + } else { + if ($AllowSkipVerify) { + Write-Warning "gpg not found. Unable to verify hash signature." + } else { + throw "gpg not found. Unable to verify hash signature. Install gpg or add -AllowSkipVerify to override." + } + } + + Write-Host "Verifying hash on downloaded tool" -ForegroundColor Yellow + $actualHash = (Get-FileHash -Path $tool -Algorithm SHA256).Hash + $expectedHash = (Get-Content $sha).Split()[0] + if ($actualHash -ne $expectedHash) { + # Validation failed. Delete the tool so we can't execute it. + #Remove-Item $codeCovPath + throw "codecov uploader tool failed signature validation." + } + + Copy-Item $tool $finalToolPath + + if ($IsMacOS -or $IsLinux) { + chmod u+x $finalToolPath + } } -return (Resolve-Path $codeCovPath).Path +return $finalToolPath From d0b0b55b461068eb2b7cc3c5e440880cf5203b75 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 18 Jun 2022 17:57:28 -0600 Subject: [PATCH 0509/1753] Fix perf scaling issue in merging coverage reports --- azure-pipelines/Merge-CodeCoverage.ps1 | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 6672b94cd..91ab67ab3 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -31,8 +31,12 @@ $reports = Get-ChildItem -Recurse $Path -Filter *.cobertura.xml if ($reports) { $reports |% { $_.FullName } |% { # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. - $content = Get-Content -Path $_ |% { [Regex]::Replace($_, '{reporoot}([^"]+)', { $RepoRoot + $args[0].groups[1].value.replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) }) } - Set-Content -Path $_ -Value $content -Encoding UTF8 + $xml = [xml](Get-Content -Path $_) + $xml.coverage.packages.package.classes.class |? { $_.filename} |% { + $_.filename = $_.filename.Replace('{reporoot}', $RepoRoot).Replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) + } + + $xml.Save($_) } $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_.FullName })) From fa0ac399504747ba4f8b71bfab31a974698811a6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 Jun 2022 08:44:04 -0600 Subject: [PATCH 0510/1753] Log _pipelines scripts verbosely --- azure-pipelines/artifacts/_all.ps1 | 1 + azure-pipelines/artifacts/_pipelines.ps1 | 8 ++++++-- azure-pipelines/artifacts/_stage_all.ps1 | 10 +++++++--- azure-pipelines/artifacts/testResults.ps1 | 4 ++++ azure-pipelines/dotnet.yml | 2 +- azure-pipelines/variables/_all.ps1 | 11 +++++++++-- azure-pipelines/variables/_pipelines.ps1 | 15 +++++++++++---- 7 files changed, 39 insertions(+), 12 deletions(-) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index c9182a45a..033cc87c9 100755 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -15,6 +15,7 @@ Executes artifact scripts even if they have already been staged. #> +[CmdletBinding(SupportsShouldProcess = $true)] param ( [string]$ArtifactNameSuffix, [switch]$Force diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index a62d2675b..2d3338b24 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -1,6 +1,10 @@ -# This script translates all the artifacts described by _all.ps1 -# into commands that instruct Azure Pipelines to actually collect those artifacts. +<# +.SYNOPSIS + This script translates all the artifacts described by _all.ps1 + into commands that instruct Azure Pipelines to actually collect those artifacts. +#> +[CmdletBinding()] param ( [string]$ArtifactNameSuffix, [switch]$StageOnly diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index b7166b4eb..d81d16d46 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -1,6 +1,10 @@ -# This script links all the artifacts described by _all.ps1 -# into a staging directory, reading for uploading to a cloud build artifact store. -# It returns a sequence of objects with Name and Path properties. +<# +.SYNOPSIS + This script links all the artifacts described by _all.ps1 + into a staging directory, reading for uploading to a cloud build artifact store. + It returns a sequence of objects with Name and Path properties. +#> + [CmdletBinding()] param ( [string]$ArtifactNameSuffix diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index 2f894c97b..4fa0fe62b 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -1,3 +1,7 @@ +[CmdletBinding()] +Param( +) + $result = @{} if ($env:AGENT_TEMPDIRECTORY) { diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index a461c147d..ca9fc9b8a 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -11,7 +11,7 @@ steps: displayName: ⚙ Update pipeline variables based on build outputs condition: succeededOrFailed() -- powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" +- powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose failOnStderr: true displayName: 📢 Publish artifacts condition: succeededOrFailed() diff --git a/azure-pipelines/variables/_all.ps1 b/azure-pipelines/variables/_all.ps1 index 0407d307e..cc6e88105 100755 --- a/azure-pipelines/variables/_all.ps1 +++ b/azure-pipelines/variables/_all.ps1 @@ -1,7 +1,14 @@ #!/usr/bin/env pwsh -# This script returns a hashtable of build variables that should be set -# at the start of a build or release definition's execution. +<# +.SYNOPSIS + This script returns a hashtable of build variables that should be set + at the start of a build or release definition's execution. +#> + +[CmdletBinding(SupportsShouldProcess = $true)] +param ( +) $vars = @{} diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 867b7fc8b..951106d2d 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -1,8 +1,15 @@ -# This script translates the variables returned by the _all.ps1 script -# into commands that instruct Azure Pipelines to actually set those variables for other pipeline tasks to consume. +<# +.SYNOPSIS + This script translates the variables returned by the _all.ps1 script + into commands that instruct Azure Pipelines to actually set those variables for other pipeline tasks to consume. -# The build or release definition may have set these variables to override -# what the build would do. So only set them if they have not already been set. + The build or release definition may have set these variables to override + what the build would do. So only set them if they have not already been set. +#> + +[CmdletBinding()] +param ( +) (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. From cb730eacdd53e4ca06b7f9c74b06da74f44db3a9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 Jun 2022 08:46:30 -0600 Subject: [PATCH 0511/1753] Collect test results from the right directory The dump files used to be written to an agent TEMP directory. Somewhere along the lines they moved to the TestResults directory within the repo itself. Fixes AArnott/Library.Template#167 --- azure-pipelines/artifacts/testResults.ps1 | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/azure-pipelines/artifacts/testResults.ps1 b/azure-pipelines/artifacts/testResults.ps1 index 4fa0fe62b..301a43763 100644 --- a/azure-pipelines/artifacts/testResults.ps1 +++ b/azure-pipelines/artifacts/testResults.ps1 @@ -4,17 +4,8 @@ Param( $result = @{} -if ($env:AGENT_TEMPDIRECTORY) { - # The DotNetCoreCLI uses an alternate location to publish these files - $guidRegex = '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$' - $result[$env:AGENT_TEMPDIRECTORY] = (Get-ChildItem $env:AGENT_TEMPDIRECTORY -Directory |? { $_.Name -match $guidRegex } |% { - Get-ChildItem "$($_.FullName)\dotnet*.dmp","$($_.FullName)\*_crashdump.dmp","$($_.FullName)\testhost*.dmp","$($_.FullName)\Sequence_*.xml" -Recurse - }); -} -else { - $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" - $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) -} +$testRoot = Resolve-Path "$PSScriptRoot\..\..\test" +$result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) $testlogsPath = "$env:BUILD_ARTIFACTSTAGINGDIRECTORY\test_logs" if (Test-Path $testlogsPath) { From 540ea6a9b78c8c2a8e99ffb553ba523defaa7e81 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 Jun 2022 16:25:12 -0600 Subject: [PATCH 0512/1753] Prepare release notes with breaking changes --- azure-pipelines/release.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 2679b24e7..4c9db860a 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -51,6 +51,7 @@ jobs: changeLogType: issueBased changeLogLabels: | [ + { "label" : "breaking change", "displayName" : "Breaking changes", "state" : "closed" }, { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } ] From bcc95836e0f8c7747cab85d4985d2a83c9840999 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 21 Jun 2022 12:03:53 -0600 Subject: [PATCH 0513/1753] Build 17.3 stable version --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index f73e69568..c133d242f 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.3-alpha", + "version": "17.3", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 387e8803a906f9bd1e1c486128eca1aa67f5f6dd Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Wed, 22 Jun 2022 10:58:16 -0700 Subject: [PATCH 0514/1753] Handle 4-integer package versions in InsertConfigValues.ps1 This is sourced from https://github.com/microsoft/vs-streamjsonrpc/commit/679db2a7343675e138cb42469f227fe335668ed5 --- azure-pipelines/variables/InsertConfigValues.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index efed018c7..1ab53f34e 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -3,7 +3,7 @@ $InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1" -SbomNotRequired $icv=@() foreach ($kvp in $InsertedPkgs.GetEnumerator()) { $kvp.Value |% { - if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] $icv += "$id=$version" From 2c7486f63461a1064a4b8454dc52a289377a73d9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Jun 2022 19:34:34 -0600 Subject: [PATCH 0515/1753] Handle 4-integer package versions in InsertConfigValues.ps1 --- azure-pipelines/variables/InsertConfigValues.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index efed018c7..1ab53f34e 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -3,7 +3,7 @@ $InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1" -SbomNotRequired $icv=@() foreach ($kvp in $InsertedPkgs.GetEnumerator()) { $kvp.Value |% { - if ($_.Name -match "^(.*)\.(\d+\.\d+\.\d+(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] $icv += "$id=$version" From 1239fb44341e1d1c238bd70f46c3dd79d995bfc7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 1 Jul 2022 10:52:27 -0600 Subject: [PATCH 0516/1753] Insert 17.3 into release branch --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..062f3f4c3 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.3' From 1db95a61e11f381d93501591c3a85e9884ddb7e2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 1 Jul 2022 10:52:56 -0600 Subject: [PATCH 0517/1753] Build 17.4 alpha --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- version.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index 062f3f4c3..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.3' +'main' diff --git a/version.json b/version.json index c133d242f..a430878df 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.3", + "version": "17.4-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From ae41d45de6f400accec8975bf9c7c07187b507bd Mon Sep 17 00:00:00 2001 From: Mickey Tyler Date: Tue, 19 Jul 2022 14:08:44 -0700 Subject: [PATCH 0518/1753] Adding yml file for OptProf profiling workflow --- azure-pipelines/vs-threading_OptProf.yml | 90 ++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 azure-pipelines/vs-threading_OptProf.yml diff --git a/azure-pipelines/vs-threading_OptProf.yml b/azure-pipelines/vs-threading_OptProf.yml new file mode 100644 index 000000000..4d5d980b3 --- /dev/null +++ b/azure-pipelines/vs-threading_OptProf.yml @@ -0,0 +1,90 @@ +# OptProf profiling workflow for VS-Threading repository + +trigger: none + +resources: + pipelines: + - pipeline: VisualStudioBuildUnderTest + source: DD-CB-PR + trigger: + tags: + - vs-threading-insertion + - pipeline: DartLab + source: DartLab + branch: main + - pipeline: DartLab.OptProf + source: DartLab.OptProf + branch: main + repositories: + - repository: DartLabTemplates + type: git + name: DartLab.Templates + ref: refs/heads/main + - repository: DartLabOptProfTemplates + type: git + name: DartLab.OptProf + ref: refs/heads/main + +parameters: + +# The prefix naming of the OptimizationInputs drop +- name: optimizationDropPrefix + type: string + default: OptimizationInputs/DevDiv/microsoft/vs-threading + +stages: +- template: \templates\stages\visual-studio\single-runsettings.yml@DartLabOptProfTemplates + parameters: + ##### Required ##### + runSettingsURI: $(Pipeline.Workspace)\VisualStudioBuildUnderTest\BuildArtifacts\runsettings\vs-threading.OptProf.runsettings + visualStudioBootstrapperURI: https://vsdrop.corp.microsoft.com/file/v1/$(VisualStudio.BuildUnderTest.ProductsDropName);bootstrappers/Enterprise/vs_enterprise.exe + ##### Optional ##### + name: OptProfProfilingWorkflow + displayName: OptProf Profiling Workflow + optOptimizationInputsDropName: $(OptimizationInputsDropName) + previousOptimizationInputsDropName: $(PreviousOptimizationInputsDropName) + testLabPoolName: VS-Platform + ##### Step Hooks ##### + preTestMachineConfigurationStepList: + - download: VisualStudioBuildUnderTest + - task: PowerShell@2 + name: SetProductsDropName + displayName: Set 'VisualStudio.BuildUnderTest.ProductsDropName' + inputs: + filePath: $(DartLab.Path)\Scripts\VisualStudio\Build\Get-VisualStudioDropName.ps1 + arguments: -DropNamePrefix 'Products' -VstsDropUrlsJson '$(Pipeline.Workspace)\VisualStudioBuildUnderTest\BuildArtifacts\VstsDropUrls.json' -OutVariableName 'VisualStudio.BuildUnderTest.ProductsDropName' + preDeployAndRunTestsStepList: + - download: VisualStudioBuildUnderTest + prePublishOptimizationInputsDropStepList: + # Set parameter for PreviousOptimizationInputsDropName, MicroBuildCommitID, and OptimizationInputsDropName + - powershell: | + try { + $artifactName = 'InsertionOutputs' + $BuildID = $(resources.pipeline.VisualStudioBuildUnderTest.runID) + $artifact = Get-BuildArtifact -InstanceURL 'https://dev.azure.com/devdiv' -ProjectName 'DevDiv' -BuildID $BuildID -ArtifactName $artifactName -OAuthAccessToken (ConvertTo-SecureString '$(System.AccessToken)' -AsPlainText -Force) + $containerName = $artifact.Resource.Data -Split '/' | Select-Object -Last 1 + $fileName = Join-Path $containerName 'Metadata.json' + $jsonString = Read-BuildArtifactFile -InstanceURL 'https://dev.azure.com/devdiv' -ProjectName 'DevDiv' -BuildID $BuildID -ArtifactName $artifactName -FileName $fileName -OAuthAccessToken (ConvertTo-SecureString '$(System.AccessToken)' -AsPlainText -Force) + $json = $jsonString | ConvertFrom-Json + + Write-Host "The content of the metadata.json file was $json" + + $dropname = $json.OptimizationData + $commitID = $json.CommitID + $OptimizationInputsDropName = "${{parameters.optimizationDropPrefix}}/$($commitID)/$(Build.BuildId)/$(System.StageId)/$(System.StageAttempt)" + + Write-Host "PreviousOptimizationInputsDropName: $dropname" + Set-AzurePipelinesVariable 'PreviousOptimizationInputsDropName' $dropname + + Write-Host "MicroBuildCommitID: $commitID" + Set-AzurePipelinesVariable 'MicroBuildCommitID' $commitID + + Write-Host "OptimizationInputsDropName: $OptimizationInputsDropName" + Set-AzurePipelinesVariable 'OptimizationInputsDropName' $OptimizationInputsDropName + } + catch { + Write-Host $_ + Write-Error "Failed to set OptimizationInputsDropName pipeline variable" + throw + } + displayName: Set MicroBuildCommitID, PreviousOptimizationInputsDropName, and OptimizationInputsDropName From 08f0dda821d3e10ef062d606c6f830435b7c1593 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Jul 2022 16:20:17 -0600 Subject: [PATCH 0519/1753] Rename pipeline file --- azure-pipelines/{vs-threading_OptProf.yml => OptProf_part2.yml} | 2 -- 1 file changed, 2 deletions(-) rename azure-pipelines/{vs-threading_OptProf.yml => OptProf_part2.yml} (98%) diff --git a/azure-pipelines/vs-threading_OptProf.yml b/azure-pipelines/OptProf_part2.yml similarity index 98% rename from azure-pipelines/vs-threading_OptProf.yml rename to azure-pipelines/OptProf_part2.yml index 4d5d980b3..37a0197d0 100644 --- a/azure-pipelines/vs-threading_OptProf.yml +++ b/azure-pipelines/OptProf_part2.yml @@ -1,5 +1,3 @@ -# OptProf profiling workflow for VS-Threading repository - trigger: none resources: From ea43cb944de62ae82585a5dc51ae34ac2d66d65e Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Tue, 19 Jul 2022 10:24:19 -0700 Subject: [PATCH 0520/1753] Add JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask method This re-expose a property on whether JoinableTaskContext has any JoinableTask blocking calls on the main thread This is based on a revert of commit b0cf1501da22e26907a887d2f18adc63f22988b5, reversing changes made to 0847b84735ed0e192efa1056cbe7ce05a7aba677. --- .../JoinableTaskContext.cs | 34 +++++++ .../JoinableTaskFactory.cs | 13 +++ .../VSThreadHelper.cs | 18 ++++ .../JoinableTaskContextTests.cs | 91 +++++++++++++++++-- 4 files changed, 150 insertions(+), 6 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 3fa22c923..acdaaae57 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -116,6 +116,11 @@ public partial class JoinableTaskContext : IDisposable /// private readonly int mainThreadManagedThreadId; + /// + /// The count of s blocking the main thread. + /// + private volatile int mainThreadBlockingJoinableTaskCount; + /// /// A single joinable task factory that itself cannot be joined. /// @@ -200,6 +205,11 @@ public bool IsWithinJoinableTask get { return this.AmbientTask is object; } } + /// + /// Gets a value indicating whether the main thread is blocked by any joinable task. + /// + internal bool IsMainThreadBlockedByAnyJoinableTask => this.mainThreadBlockingJoinableTaskCount > 0; + /// /// Gets the underlying that controls the main thread in the host. /// @@ -476,6 +486,30 @@ internal IDisposable RegisterHangNotifications(JoinableTaskContextNode node) return new HangNotificationRegistration(node); } + /// + /// Increment the count of s blocking the main thread. + /// + /// + /// This method should only be called on the main thread. + /// + internal void IncrementMainThreadBlockingCount() + { + Assumes.True(this.IsOnMainThread); + this.mainThreadBlockingJoinableTaskCount++; + } + + /// + /// Decrement the count of s blocking the main thread. + /// + /// + /// This method should only be called on the main thread. + /// + internal void DecrementMainThreadBlockingCount() + { + Assumes.True(this.IsOnMainThread); + this.mainThreadBlockingJoinableTaskCount--; + } + /// /// Invoked when a hang is suspected to have occurred involving the main thread. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 3c35da3e4..7d6848100 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -545,6 +545,12 @@ protected internal virtual void WaitSynchronously(Task task) protected virtual void WaitSynchronouslyCore(Task task) { Requires.NotNull(task, nameof(task)); + + if (this.Context.IsOnMainThread) + { + this.Context.IncrementMainThreadBlockingCount(); + } + int hangTimeoutsCount = 0; // useful for debugging dump files to see how many times we looped. int hangNotificationCount = 0; Guid hangId = Guid.Empty; @@ -588,6 +594,13 @@ protected virtual void WaitSynchronouslyCore(Task task) // Our caller just wants to know when the Task completes, // whether successfully or not. } + finally + { + if (this.Context.IsOnMainThread) + { + this.Context.DecrementMainThreadBlockingCount(); + } + } } /// diff --git a/src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs b/src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs new file mode 100644 index 000000000..f2ce67d80 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs @@ -0,0 +1,18 @@ +namespace Microsoft.VisualStudio.Threading +{ +#pragma warning disable RS0016 //Add public types and members to the declared API + /// + /// A helper class for integration with Visual Studio. + /// APIs in this file are intended for Microsoft internal use only. + /// + public static class VSThreadHelper + { +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member + public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext joinableTaskContext) +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member + { + return joinableTaskContext?.IsMainThreadBlockedByAnyJoinableTask == true; + } + } +#pragma warning restore RS0016 // Add public types and members to the declared API +} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index d0b00c42f..f74ea8d18 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -45,6 +45,85 @@ await Task.Run(delegate }); } + [Fact] + public void IsMainThreadBlockedByAnyJoinableTask_True() + { + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + AsyncManualResetEvent mainThreadBlockerEvent = new AsyncManualResetEvent(false); + AsyncManualResetEvent backgroundThreadMonitorEvent = new AsyncManualResetEvent(false); + + // Start task to monitor IsMainThreadBlockedByAnyJoinableTask + Task monitorTask = Task.Run(async () => + { + await mainThreadBlockerEvent.WaitAsync(this.TimeoutToken); + + while (!VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)) + { + // Give the main thread time to enter a blocking state, if the test hasn't already timed out. + await Task.Delay(50, this.TimeoutToken); + } + + backgroundThreadMonitorEvent.Set(); + }); + + JoinableTask? joinable = this.Factory.RunAsync(async delegate + { + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + await this.Factory.SwitchToMainThreadAsync(this.TimeoutToken); + + this.Factory.Run(async () => + { + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + mainThreadBlockerEvent.Set(); + await backgroundThreadMonitorEvent.WaitAsync(this.TimeoutToken); + }); + }); + + joinable.Join(); + monitorTask.WaitWithoutInlining(throwOriginalException: true); + + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + } + + [Fact] + public void IsMainThreadBlockedByAnyJoinableTask_False() + { + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + ManualResetEventSlim backgroundThreadBlockerEvent = new(); + + JoinableTask? joinable = this.Factory.RunAsync(async delegate + { + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + + this.Factory.Run(async () => + { + backgroundThreadBlockerEvent.Set(); + + // Set a delay sufficient for the other thread to have noticed if IsMainThreadBlockedByAnyJoinableTask is true + // while we're suspended. + await Task.Delay(AsyncDelay); + }); + }); + + backgroundThreadBlockerEvent.Wait(UnexpectedTimeout); + + do + { + // Give the background thread time to enter a blocking state, if the test hasn't already timed out. + this.TimeoutToken.ThrowIfCancellationRequested(); + + // IsMainThreadBlockedByAnyJoinableTask should be false when a background thread is blocked. + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + Thread.Sleep(10); + } + while (!joinable.IsCompleted); + + joinable.Join(); + + Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); + } + [Fact] public void ReportHangOnRun() { @@ -410,8 +489,8 @@ public void GetHangReportProducesDgmlWithNamedJoinableCollections() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Collection" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Collection" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label == jtcName); return Task.CompletedTask; }); @@ -433,8 +512,8 @@ public void GetHangReportProducesDgmlWithMethodNameRequestingMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.GetHangReportProducesDgmlWithMethodNameRequestingMainThread))); } @@ -456,8 +535,8 @@ public void GetHangReportProducesDgmlWithMethodNameYieldingOnMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.YieldingMethodAsync))); }); } From c1654d46918074841a7964d8bf81de62e4fd86a8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Jul 2022 18:22:04 -0600 Subject: [PATCH 0521/1753] Hide the internal API more, and move the tests --- .../JoinableTaskInternals.cs | 23 +++++ .../VSThreadHelper.cs | 18 ---- .../JoinableTaskContextTests.cs | 91 ++---------------- .../JoinableTaskInternalsTests.cs | 95 +++++++++++++++++++ 4 files changed, 124 insertions(+), 103 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs delete mode 100644 src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs new file mode 100644 index 000000000..f173eca91 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs @@ -0,0 +1,23 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading; + +using System.ComponentModel; + +#pragma warning disable RS0016 // Add public types and members to the declared API +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member + +/// +/// A helper class for integration with Visual Studio. +/// APIs in this file are intended for Microsoft internal use only +/// and are subject to change without notice. +/// +[EditorBrowsable(EditorBrowsableState.Never)] +public static class JoinableTaskInternals +{ + public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext? joinableTaskContext) + { + return joinableTaskContext?.IsMainThreadBlockedByAnyJoinableTask == true; + } +} diff --git a/src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs b/src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs deleted file mode 100644 index f2ce67d80..000000000 --- a/src/Microsoft.VisualStudio.Threading/VSThreadHelper.cs +++ /dev/null @@ -1,18 +0,0 @@ -namespace Microsoft.VisualStudio.Threading -{ -#pragma warning disable RS0016 //Add public types and members to the declared API - /// - /// A helper class for integration with Visual Studio. - /// APIs in this file are intended for Microsoft internal use only. - /// - public static class VSThreadHelper - { -#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member - public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext joinableTaskContext) -#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member - { - return joinableTaskContext?.IsMainThreadBlockedByAnyJoinableTask == true; - } - } -#pragma warning restore RS0016 // Add public types and members to the declared API -} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index f74ea8d18..d0b00c42f 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -45,85 +45,6 @@ await Task.Run(delegate }); } - [Fact] - public void IsMainThreadBlockedByAnyJoinableTask_True() - { - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - AsyncManualResetEvent mainThreadBlockerEvent = new AsyncManualResetEvent(false); - AsyncManualResetEvent backgroundThreadMonitorEvent = new AsyncManualResetEvent(false); - - // Start task to monitor IsMainThreadBlockedByAnyJoinableTask - Task monitorTask = Task.Run(async () => - { - await mainThreadBlockerEvent.WaitAsync(this.TimeoutToken); - - while (!VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)) - { - // Give the main thread time to enter a blocking state, if the test hasn't already timed out. - await Task.Delay(50, this.TimeoutToken); - } - - backgroundThreadMonitorEvent.Set(); - }); - - JoinableTask? joinable = this.Factory.RunAsync(async delegate - { - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - await this.Factory.SwitchToMainThreadAsync(this.TimeoutToken); - - this.Factory.Run(async () => - { - await TaskScheduler.Default.SwitchTo(alwaysYield: true); - mainThreadBlockerEvent.Set(); - await backgroundThreadMonitorEvent.WaitAsync(this.TimeoutToken); - }); - }); - - joinable.Join(); - monitorTask.WaitWithoutInlining(throwOriginalException: true); - - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - } - - [Fact] - public void IsMainThreadBlockedByAnyJoinableTask_False() - { - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - ManualResetEventSlim backgroundThreadBlockerEvent = new(); - - JoinableTask? joinable = this.Factory.RunAsync(async delegate - { - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - await TaskScheduler.Default.SwitchTo(alwaysYield: true); - - this.Factory.Run(async () => - { - backgroundThreadBlockerEvent.Set(); - - // Set a delay sufficient for the other thread to have noticed if IsMainThreadBlockedByAnyJoinableTask is true - // while we're suspended. - await Task.Delay(AsyncDelay); - }); - }); - - backgroundThreadBlockerEvent.Wait(UnexpectedTimeout); - - do - { - // Give the background thread time to enter a blocking state, if the test hasn't already timed out. - this.TimeoutToken.ThrowIfCancellationRequested(); - - // IsMainThreadBlockedByAnyJoinableTask should be false when a background thread is blocked. - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - Thread.Sleep(10); - } - while (!joinable.IsCompleted); - - joinable.Join(); - - Assert.False(VSThreadHelper.IsMainThreadBlockedByAnyJoinableTask(this.Context)); - } - [Fact] public void ReportHangOnRun() { @@ -489,8 +410,8 @@ public void GetHangReportProducesDgmlWithNamedJoinableCollections() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Collection" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Collection" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label == jtcName); return Task.CompletedTask; }); @@ -512,8 +433,8 @@ public void GetHangReportProducesDgmlWithMethodNameRequestingMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.GetHangReportProducesDgmlWithMethodNameRequestingMainThread))); } @@ -535,8 +456,8 @@ public void GetHangReportProducesDgmlWithMethodNameYieldingOnMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.YieldingMethodAsync))); }); } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs new file mode 100644 index 000000000..6544cce31 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System.Threading; +using System.Threading.Tasks; +using Microsoft.VisualStudio.Threading; +using Xunit; +using Xunit.Abstractions; + +public class JoinableTaskInternalsTests : JoinableTaskTestBase +{ + public JoinableTaskInternalsTests(ITestOutputHelper logger) + : base(logger) + { + } + + [Fact] + public void IsMainThreadBlockedByAnyJoinableTask_True() + { + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + AsyncManualResetEvent mainThreadBlockerEvent = new AsyncManualResetEvent(false); + AsyncManualResetEvent backgroundThreadMonitorEvent = new AsyncManualResetEvent(false); + + // Start task to monitor IsMainThreadBlockedByAnyJoinableTask + Task monitorTask = Task.Run(async () => + { + await mainThreadBlockerEvent.WaitAsync(this.TimeoutToken); + + while (!JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)) + { + // Give the main thread time to enter a blocking state, if the test hasn't already timed out. + await Task.Delay(50, this.TimeoutToken); + } + + backgroundThreadMonitorEvent.Set(); + }); + + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + await this.asyncPump.SwitchToMainThreadAsync(this.TimeoutToken); + + this.asyncPump.Run(async () => + { + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + mainThreadBlockerEvent.Set(); + await backgroundThreadMonitorEvent.WaitAsync(this.TimeoutToken); + }); + }); + + joinable.Join(); + monitorTask.WaitWithoutInlining(throwOriginalException: true); + + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + } + + [Fact] + public void IsMainThreadBlockedByAnyJoinableTask_False() + { + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + ManualResetEventSlim backgroundThreadBlockerEvent = new(); + + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + + this.asyncPump.Run(async () => + { + backgroundThreadBlockerEvent.Set(); + + // Set a delay sufficient for the other thread to have noticed if IsMainThreadBlockedByAnyJoinableTask is true + // while we're suspended. + await Task.Delay(AsyncDelay); + }); + }); + + backgroundThreadBlockerEvent.Wait(UnexpectedTimeout); + + do + { + // Give the background thread time to enter a blocking state, if the test hasn't already timed out. + this.TimeoutToken.ThrowIfCancellationRequested(); + + // IsMainThreadBlockedByAnyJoinableTask should be false when a background thread is blocked. + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + Thread.Sleep(10); + } + while (!joinable.IsCompleted); + + joinable.Join(); + + Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); + } +} From ee8de49270c72a7e28b526035c2a5d9206d15371 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Jul 2022 18:44:38 -0600 Subject: [PATCH 0522/1753] Turn off PR trigger for optprof part 2 --- azure-pipelines/OptProf_part2.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/OptProf_part2.yml b/azure-pipelines/OptProf_part2.yml index 37a0197d0..edef0ec96 100644 --- a/azure-pipelines/OptProf_part2.yml +++ b/azure-pipelines/OptProf_part2.yml @@ -1,4 +1,5 @@ trigger: none +pr: none resources: pipelines: From c5683bea1c776521445818e010a656a96d58b873 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 21 Jul 2022 21:14:22 -0600 Subject: [PATCH 0523/1753] Fix symbol file collection when the dll or exe is missing --- azure-pipelines/Get-SymbolFiles.ps1 | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index fccb1bb13..9183c340e 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -49,8 +49,13 @@ $PDBs |% { $BinaryImagePath = $dllPath } elseif (Test-Path $exePath) { $BinaryImagePath = $exePath + } else { + Write-Warning "`"$_`" found with no matching binary file." + $BinaryImagePath = $null } - Write-Output $BinaryImagePath - Write-Output $_.FullName + if ($BinaryImagePath) { + Write-Output $BinaryImagePath + Write-Output $_.FullName + } } From 540833819f90b3dacf9753c7c2f3baee19e5094c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 21 Jul 2022 18:18:26 -0600 Subject: [PATCH 0524/1753] Fix publishing of legacy symbols where on binary image can be found --- azure-pipelines/Publish-Legacy-Symbols.ps1 | 25 +++++++++++++--------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/azure-pipelines/Publish-Legacy-Symbols.ps1 b/azure-pipelines/Publish-Legacy-Symbols.ps1 index 6ca7ddb68..5c4035a19 100644 --- a/azure-pipelines/Publish-Legacy-Symbols.ps1 +++ b/azure-pipelines/Publish-Legacy-Symbols.ps1 @@ -14,19 +14,24 @@ Get-ChildItem "$ArtifactStagingFolder\*.pdb" -Recurse |% { $BinaryImagePath = $dllPath } elseif (Test-Path $exePath) { $BinaryImagePath = $exePath + } else { + Write-Warning "`"$_`" found with no matching binary file." + $BinaryImagePath = $null } - # Convert the PDB to legacy Windows PDBs - Write-Host "Converting PDB for $_" -ForegroundColor DarkGray - $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" - if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } - $legacyPdbPath = "$WindowsPdbDir\$($_.BaseName).pdb" - & "$PSScriptRoot\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath $legacyPdbPath - if ($LASTEXITCODE -ne 0) { - Write-Warning "PDB conversion of `"$_`" failed." - } + if ($BinaryImagePath) { + # Convert the PDB to legacy Windows PDBs + Write-Host "Converting PDB for $_" -ForegroundColor DarkGray + $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" + if (!(Test-Path $WindowsPdbDir)) { mkdir $WindowsPdbDir | Out-Null } + $legacyPdbPath = "$WindowsPdbDir\$($_.BaseName).pdb" + & "$PSScriptRoot\Convert-PDB.ps1" -DllPath $BinaryImagePath -PdbPath $_ -OutputPath $legacyPdbPath + if ($LASTEXITCODE -ne 0) { + Write-Warning "PDB conversion of `"$_`" failed." + } - Move-Item $legacyPdbPath $_ -Force + Move-Item $legacyPdbPath $_ -Force + } } Write-Host "##vso[artifact.upload containerfolder=symbols-legacy;artifactname=symbols-legacy;]$ArtifactStagingFolder" From b5f7042d435965c623a41856c911675c7ffb5ad1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 21 Jul 2022 18:23:12 -0600 Subject: [PATCH 0525/1753] Update SBOM support to use the new SBOM plugin Remove deprecated SBOM handling SBOM is now generated as part of the build (when it applies). --- azure-pipelines/Install-NuGetPackage.ps1 | 2 ++ azure-pipelines/artifacts/VSInsertion.ps1 | 11 ----------- azure-pipelines/build.yml | 5 ----- azure-pipelines/microbuild.after.yml | 9 --------- azure-pipelines/microbuild.before.yml | 3 +++ azure-pipelines/variables/InsertConfigValues.ps1 | 2 +- init.ps1 | 12 ++++++++++++ 7 files changed, 18 insertions(+), 26 deletions(-) diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/azure-pipelines/Install-NuGetPackage.ps1 index 0bf057104..13967233f 100644 --- a/azure-pipelines/Install-NuGetPackage.ps1 +++ b/azure-pipelines/Install-NuGetPackage.ps1 @@ -45,6 +45,8 @@ try { $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru if ($p.ExitCode -ne 0) { throw } } + + Write-Output (Get-ChildItem "$PackagesDir\$PackageId.*")[0].FullName } finally { Pop-Location } diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 0d1cb3739..ba6af3205 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -1,12 +1,7 @@ # This artifact captures everything needed to insert into VS (NuGet packages, insertion metadata, etc.) -<# -.PARAMETER SbomNotRequired - Indicates that returning the artifacts available is preferable to nothing at all when the SBOM has not yet been generated. -#> [CmdletBinding()] Param ( - [switch]$SbomNotRequired ) if ($IsMacOS -or $IsLinux) { @@ -23,12 +18,6 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" -# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $PackagesRoot/_manifest) -and -not $SbomNotRequired) { - Write-Host "Skipping because SBOM isn't generated yet." - return @{} -} - if (!(Test-Path $PackagesRoot)) { Write-Warning "Skipping because packages haven't been built yet." return @{} diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index a8c33859b..f0e6c7e15 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -36,11 +36,6 @@ jobs: - template: microbuild.after.yml parameters: EnableAPIScan: ${{ parameters.EnableAPIScan }} - # Repeat this step to scoop up any artifacts that would only be collected after running microbuild.after.yml - - powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" - failOnStderr: true - displayName: Publish artifacts - condition: succeededOrFailed() - template: expand-template.yml diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 876348085..6f107833b 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -13,15 +13,6 @@ steps: condition: succeededOrFailed() displayName: MicroBuild Cleanup -- task: ManifestGeneratorTask@0 - displayName: Software Bill of Materials generation - inputs: - BuildDropPath: $(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration) - BuildComponentPath: $(System.DefaultWorkingDirectory)/obj/src/Library - -- powershell: Copy-Item -Recurse -Verbose "$(System.DefaultWorkingDirectory)/bin/Library/$(BuildConfiguration)/_manifest" "$(System.DefaultWorkingDirectory)/bin/Packages/$(BuildConfiguration)/NuGet" - displayName: Publish Software Bill of Materials - - task: Ref12Analyze@0 displayName: Ref12 (Codex) Analyze inputs: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index ab9306944..05efd4a91 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -12,3 +12,6 @@ steps: inputs: signType: $(SignType) displayName: Install MicroBuild Signing Plugin + +- task: MicroBuildSbomPlugin@1 + displayName: Install MicroBuild Sbom Plugin diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index 1ab53f34e..3ae11de94 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -1,4 +1,4 @@ -$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1" -SbomNotRequired) +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") $icv=@() foreach ($kvp in $InsertedPkgs.GetEnumerator()) { diff --git a/init.ps1 b/init.ps1 index 0a7e1cbd3..4a576ac28 100755 --- a/init.ps1 +++ b/init.ps1 @@ -39,6 +39,8 @@ Install the MicroBuild setup plugin for building VSIXv3 packages. .PARAMETER OptProf Install the MicroBuild OptProf plugin for building optimized assemblies on desktop machines. +.PARAMETER Sbom + Install the MicroBuild SBOM plugin. .PARAMETER AccessToken An optional access token for authenticating to Azure Artifacts authenticated feeds. #> @@ -63,6 +65,8 @@ Param ( [Parameter()] [switch]$OptProf, [Parameter()] + [switch]$SBOM, + [Parameter()] [string]$AccessToken ) @@ -130,6 +134,14 @@ try { $EnvVars['LocLanguages'] = "JPN" } + if ($SBOM) { + Write-Host "Installing MicroBuild SBOM plugin" -ForegroundColor $HeaderColor + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Sbom -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $PkgMicrosoft_ManifestTool_CrossPlatform = & $InstallNuGetPkgScriptPath Microsoft.ManifestTool.CrossPlatform -source 'https://1essharedassets.pkgs.visualstudio.com/1esPkgs/_packaging/SBOMTool/nuget/v3/index.json' -Verbosity $nugetVerbosity + $EnvVars['GenerateSBOM'] = "true" + $EnvVars['PkgMicrosoft_ManifestTool_CrossPlatform'] = $PkgMicrosoft_ManifestTool_CrossPlatform + } + & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars -PrependPath $PrependPath | Out-Null } catch { From e2a1ef6043b980ce7cc7c26bcb355d6574cd9461 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 Jul 2022 12:58:48 -0600 Subject: [PATCH 0526/1753] Remove dead Win7 registry watcher test code This is something of a follow-up from the code removed in 142d512090b072b3634c6341428286434d601284 (#1034). --- .../App.config | 10 ---------- ...Threading.Tests.Win7RegistryWatcher.csproj | 9 --------- .../Program.cs | 19 ------------------- ...rosoft.VisualStudio.Threading.Tests.csproj | 4 ---- 4 files changed, 42 deletions(-) delete mode 100644 test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config delete mode 100644 test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj delete mode 100644 test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config deleted file mode 100644 index 7870c6210..000000000 --- a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj deleted file mode 100644 index 849497670..000000000 --- a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj +++ /dev/null @@ -1,9 +0,0 @@ - - - net472 - Exe - - - - - diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs deleted file mode 100644 index 220aca346..000000000 --- a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs +++ /dev/null @@ -1,19 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -namespace Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher -{ - using Microsoft.Win32; - - internal static class Program - { - private static void Main() - { - // Watch a registry key. Then try to exit the program. - // If in Win7 support mode we start a thread to monitor for registry changes, - // this verifies that the thread is a *background* thread that won't keep the process running. - RegistryKey? key = Registry.CurrentUser.OpenSubKey("SOFTWARE"); - key.WaitForChangeAsync(); - } - } -} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 635ae6cbf..e2d0b97e0 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -47,9 +47,5 @@ true - - false - true - From 4ba28adada63dc6d9d823731e09d54733a16a85f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 Jul 2022 13:14:15 -0600 Subject: [PATCH 0527/1753] Revert "Remove dead Win7 registry watcher test code" This reverts commit e2a1ef6043b980ce7cc7c26bcb355d6574cd9461. --- .../App.config | 10 ++++++++++ ...Threading.Tests.Win7RegistryWatcher.csproj | 9 +++++++++ .../Program.cs | 19 +++++++++++++++++++ ...rosoft.VisualStudio.Threading.Tests.csproj | 4 ++++ 4 files changed, 42 insertions(+) create mode 100644 test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config create mode 100644 test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj create mode 100644 test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config new file mode 100644 index 000000000..7870c6210 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/App.config @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj new file mode 100644 index 000000000..849497670 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj @@ -0,0 +1,9 @@ + + + net472 + Exe + + + + + diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs new file mode 100644 index 000000000..220aca346 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs @@ -0,0 +1,19 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher +{ + using Microsoft.Win32; + + internal static class Program + { + private static void Main() + { + // Watch a registry key. Then try to exit the program. + // If in Win7 support mode we start a thread to monitor for registry changes, + // this verifies that the thread is a *background* thread that won't keep the process running. + RegistryKey? key = Registry.CurrentUser.OpenSubKey("SOFTWARE"); + key.WaitForChangeAsync(); + } + } +} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index e2d0b97e0..635ae6cbf 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -47,5 +47,9 @@ true + + false + true + From 82376fab3e14b2a87e129f3b0ab7e2f49b27133a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 Jul 2022 13:52:01 -0600 Subject: [PATCH 0528/1753] Revert "Drop Windows 7 support and (unstable) test" This reverts commit 142d512090b072b3634c6341428286434d601284. --- Microsoft.VisualStudio.Threading.sln | 14 +- .../AwaitExtensions.cs | 273 +++++++++++++++++- .../LightUps.cs | 36 +++ .../AwaitExtensionsTests.cs | 45 +++ 4 files changed, 353 insertions(+), 15 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/LightUps.cs diff --git a/Microsoft.VisualStudio.Threading.sln b/Microsoft.VisualStudio.Threading.sln index 6c9d87141..6e6704560 100644 --- a/Microsoft.VisualStudio.Threading.sln +++ b/Microsoft.VisualStudio.Threading.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 17 -VisualStudioVersion = 17.3.32517.449 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.28413.118 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers", "src\Microsoft.VisualStudio.Threading.Analyzers\Microsoft.VisualStudio.Threading.Analyzers.csproj", "{536F3F9A-B457-43B8-BC93-CE1C16959037}" EndProject @@ -18,6 +18,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution version.json = version.json EndProjectSection EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher", "test\Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher\Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj", "{4961AA84-088C-46C0-BAC0-F9E87A9F03A7}" +EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading", "src\Microsoft.VisualStudio.Threading\Microsoft.VisualStudio.Threading.csproj", "{D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Tests", "test\Microsoft.VisualStudio.Threading.Tests\Microsoft.VisualStudio.Threading.Tests.csproj", "{CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}" @@ -56,6 +58,14 @@ Global {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|Any CPU.Build.0 = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.ActiveCfg = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.Build.0 = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.Build.0 = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.ActiveCfg = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.Build.0 = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.ActiveCfg = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.Build.0 = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.ActiveCfg = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.Build.0 = Release|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.Build.0 = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|NonWindows.ActiveCfg = Debug|Any CPU diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index c0bf86a68..1abfadb68 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -4,6 +4,7 @@ namespace Microsoft.VisualStudio.Threading { using System; + using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics; using System.Runtime.CompilerServices; @@ -206,7 +207,7 @@ public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInli private static async Task WaitForRegistryChangeAsync(SafeRegistryHandle registryKeyHandle, bool watchSubtree, RegistryChangeNotificationFilters change, CancellationToken cancellationToken) { #if NET5_0_OR_GREATER - if (!OperatingSystem.IsWindowsVersionAtLeast(8)) + if (!OperatingSystem.IsWindowsVersionAtLeast(7)) #else if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) #endif @@ -214,20 +215,49 @@ private static async Task WaitForRegistryChangeAsync(SafeRegistryHandle registry throw new PlatformNotSupportedException(); } - using ManualResetEvent evt = new(false); - REG_NOTIFY_FILTER dwNotifyFilter = (REG_NOTIFY_FILTER)change | REG_NOTIFY_FILTER.REG_NOTIFY_THREAD_AGNOSTIC; - WIN32_ERROR win32Error = PInvoke.RegNotifyChangeKeyValue( - registryKeyHandle, - watchSubtree, - dwNotifyFilter, - evt.SafeWaitHandle, - true); - if (win32Error != 0) + IDisposable? dedicatedThreadReleaser = null; + try { - throw new Win32Exception((int)win32Error); - } + using ManualResetEvent evt = new(false); + REG_NOTIFY_FILTER dwNotifyFilter = (REG_NOTIFY_FILTER)change; + + static void DoNotify(SafeRegistryHandle registryKeyHandle, bool watchSubtree, REG_NOTIFY_FILTER change, WaitHandle evt) + { + WIN32_ERROR win32Error = PInvoke.RegNotifyChangeKeyValue( + registryKeyHandle, + watchSubtree, + change, + evt.SafeWaitHandle, + true); + if (win32Error != 0) + { + throw new Win32Exception((int)win32Error); + } + } - await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); + if (LightUps.IsWindows8OrLater) + { + dwNotifyFilter |= REG_NOTIFY_FILTER.REG_NOTIFY_THREAD_AGNOSTIC; + DoNotify(registryKeyHandle, watchSubtree, dwNotifyFilter, evt); + } + else + { + // Engage our downlevel support by using a single, dedicated thread to guarantee + // that we request notification on a thread that will not be destroyed later. + // Although we *could* await this, we synchronously block because our caller expects + // subscription to have begun before we return: for the async part to simply be notification. + // This async method we're calling uses .ConfigureAwait(false) internally so this won't + // deadlock if we're called on a thread with a single-thread SynchronizationContext. + Action registerAction = () => DoNotify(registryKeyHandle, watchSubtree, dwNotifyFilter, evt); + dedicatedThreadReleaser = DownlevelRegistryWatcherSupport.ExecuteOnDedicatedThreadAsync(registerAction).GetAwaiter().GetResult(); + } + + await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); + } + finally + { + dedicatedThreadReleaser?.Dispose(); + } } /// @@ -751,5 +781,222 @@ public void OnCompleted(Action continuation) TaskScheduler.Default); } } + + /// + /// Provides a dedicated thread for requesting registry change notifications. + /// + /// + /// For versions of Windows prior to Windows 8, requesting registry change notifications + /// required that the thread that made the request remain alive or else the watcher would + /// simply signal the event and stop watching for changes. + /// This class provides a single, dedicated thread for requesting such notifications + /// so that they don't get canceled when a thread happens to exit. + /// The dedicated thread is released when no one is watching the registry any more. + /// + private static class DownlevelRegistryWatcherSupport + { + /// + /// The size of the stack allocated for a thread that expects to stay within just a few methods in depth. + /// + /// + /// The default stack size for a thread is 1MB. + /// + private const int SmallThreadStackSize = 100 * 1024; + + /// + /// The object to lock when accessing any fields. + /// This is also the object that is waited on by the dedicated thread, + /// and may be pulsed by others to wake the dedicated thread to do some work. + /// + private static readonly object SyncObject = new object(); + + /// + /// A queue of actions the dedicated thread should take. + /// + private static readonly Queue>> PendingWork = new(); + + /// + /// The number of callers that still have an interest in the survival of the dedicated thread. + /// The dedicated thread will exit when this value reaches 0. + /// + private static int keepAliveCount; + + /// + /// The thread that should stay alive and be dequeuing . + /// + private static Thread? liveThread; + + /// + /// Executes some action on a long-lived thread. + /// + /// The delegate to execute. + /// + /// A task that either faults with the exception thrown by + /// or completes after successfully executing the delegate + /// with a result that should be disposed when it is safe to terminate the long-lived thread. + /// + /// + /// This thread never posts to , so it is safe + /// to call this method and synchronously block on its result. + /// + internal static async Task ExecuteOnDedicatedThreadAsync(Action action) + { + Requires.NotNull(action, nameof(action)); + + var tcs = new TaskCompletionSource(); + bool keepAliveCountIncremented = false; + try + { + lock (SyncObject) + { + PendingWork.Enqueue(Tuple.Create(action, tcs)); + + try + { + // This block intentionally left blank. + } + finally + { + // We make these two assignments within a finally block + // to guard against an untimely ThreadAbortException causing + // us to execute just one of them. + keepAliveCountIncremented = true; + ++keepAliveCount; + } + + if (keepAliveCount == 1) + { + Assumes.Null(liveThread); + liveThread = new Thread(Worker, SmallThreadStackSize) + { + IsBackground = true, + Name = "Registry watcher", + }; + liveThread.Start(); + } + else + { + // There *could* temporarily be multiple threads in some race conditions. + // Pulse all of them so that the live one is sure to get the message. + Monitor.PulseAll(SyncObject); + } + } + + await tcs.Task.ConfigureAwait(false); + return new ThreadHandleRelease(); + } + catch + { + if (keepAliveCountIncremented) + { + // Our caller will never have a chance to release their claim on the dedicated thread, + // so do it for them. + ReleaseRefOnDedicatedThread(); + } + + throw; + } + } + + /// + /// Decrements the count of interested parties in the live thread, + /// and helps it to terminate if necessary. + /// + private static void ReleaseRefOnDedicatedThread() + { + lock (SyncObject) + { + if (--keepAliveCount == 0) + { + liveThread = null; + + // Wake up any obsolete thread(s) so they can go to exit. + Monitor.PulseAll(SyncObject); + } + } + } + + /// + /// Executes thread-affinitized work from a queue until both the queue is empty + /// and any lingering interest in the survival of the dedicated thread has been released. + /// + /// + /// This method serves as the for our dedicated thread. + /// + private static void Worker() + { + while (true) + { + Tuple>? work = null; + lock (SyncObject) + { + if (Thread.CurrentThread != liveThread) + { + // Regardless of our PendingWork and keepAliveCount, + // it isn't meant for this thread any more. + // This happens when keepAliveCount (at least temporarily) + // hits 0, so this thread must be assumed to be on its exit path, + // and another thread will be spawned to process new requests. + Assumes.True(liveThread is object || (keepAliveCount == 0 && PendingWork.Count == 0)); + return; + } + + if (PendingWork.Count > 0) + { + work = PendingWork.Dequeue(); + } + else if (keepAliveCount == 0) + { + // No work, and no reason to stay alive. Exit the thread. + return; + } + else + { + // Sleep until another thread wants to wake us up with a Pulse. + Monitor.Wait(SyncObject); + } + } + + if (work is object) + { + try + { + work.Item1(); + work.Item2.SetResult(EmptyStruct.Instance); + } + catch (Exception ex) + { + work.Item2.SetException(ex); + } + } + } + } + + /// + /// Decrements the dedicated thread use counter by at most one upon disposal. + /// + private class ThreadHandleRelease : IDisposable + { + /// + /// A value indicating whether this instance has already been disposed. + /// + private bool disposed; + + /// + /// Release the keep alive count reserved by this instance. + /// + public void Dispose() + { + lock (SyncObject) + { + if (!this.disposed) + { + this.disposed = true; + ReleaseRefOnDedicatedThread(); + } + } + } + } + } } } diff --git a/src/Microsoft.VisualStudio.Threading/LightUps.cs b/src/Microsoft.VisualStudio.Threading/LightUps.cs new file mode 100644 index 000000000..e893b868c --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/LightUps.cs @@ -0,0 +1,36 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading +{ + using System; + + /// + /// A non-generic class used to store statics that do not vary by generic type argument. + /// + internal static class LightUps + { + /// + /// Gets a value indicating whether we execute Windows 7 code even on later versions of Windows. + /// + internal const bool ForceWindows7Mode = false; + + /// + /// The for Windows 8. + /// + private static readonly Version Windows8Version = new Version(6, 2, 9200); + + /// + /// Gets a value indicating whether the current operating system is Windows 8 or later. + /// + internal static bool IsWindows8OrLater + { + get + { + return !ForceWindows7Mode + && Environment.OSVersion.Platform == PlatformID.Win32NT + && Environment.OSVersion.Version >= Windows8Version; + } + } + } +} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index 301eb2ff7..447ae6689 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -789,6 +789,51 @@ public async Task AwaitRegKeyChange_CallingThreadDestroyed() } } + [SkippableFact] + public async Task AwaitRegKeyChange_DoesNotPreventAppTerminationOnWin7() + { + Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + string testExePath = Path.Combine( + AppDomain.CurrentDomain.BaseDirectory!, + "..", + "..", + "..", + "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher", +#if DEBUG + "Debug", +#else + "Release", +#endif + "net472", + "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.exe"); + this.Logger.WriteLine("Using testexe path: {0}", testExePath); + var psi = new ProcessStartInfo(testExePath) + { + CreateNoWindow = true, + WindowStyle = ProcessWindowStyle.Hidden, + }; + Process testExeProcess = Process.Start(psi)!; + try + { + // The assertion and timeout are interesting here: + // If the dedicated thread is not a background thread, the process does + // seem to terminate anyway, but it can sometimes (3 out of 10 times) + // take up to 10 seconds to terminate (perhaps when a GC finalizer runs?) + // while other times it's really fast. + // But when the dedicated thread is a background thread, it seems reliably fast. + this.TimeoutTokenSource = new CancellationTokenSource(TimeSpan.FromSeconds(8)); + int exitCode = await AwaitExtensions.WaitForExitAsync(testExeProcess, this.TimeoutToken); + Assert.Equal(0, exitCode); + } + finally + { + if (!testExeProcess.HasExited) + { + testExeProcess.Kill(); + } + } + } + private class RegKeyTest : IDisposable { private readonly string keyName; From 5b612fe98821adc0608fdd5936f67e2d1bc40f97 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 22 Jul 2022 14:21:04 -0600 Subject: [PATCH 0529/1753] Bump Microsoft.VisualStudio.Validation from 17.0.58 to 17.0.64 (#1062) Bumps [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) from 17.0.58 to 17.0.64. - [Release notes](https://github.com/microsoft/vs-validation/releases) - [Commits](https://github.com/microsoft/vs-validation/commits) --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Validation dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .../Microsoft.VisualStudio.Threading.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index aae3f5780..c59f6053a 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -44,7 +44,7 @@ - + From e3d1af2f48d1454ffe45db80345d5516ecbcafe0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 22 Jul 2022 14:21:32 -0600 Subject: [PATCH 0530/1753] Bump Microsoft.Diagnostics.Runtime from 2.1.330101 to 2.2.332302 (#1061) Bumps [Microsoft.Diagnostics.Runtime](https://github.com/Microsoft/clrmd) from 2.1.330101 to 2.2.332302. - [Release notes](https://github.com/Microsoft/clrmd/releases) - [Changelog](https://github.com/microsoft/clrmd/blob/main/doc/ReleaseNotes2.0.md) - [Commits](https://github.com/Microsoft/clrmd/commits) --- updated-dependencies: - dependency-name: Microsoft.Diagnostics.Runtime dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- src/SosThreadingTools/SosThreadingTools.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index d0d3e4a6d..406ed3d36 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -26,7 +26,7 @@ - + From f0cef20debadfefb956f340d9465a62907df0dda Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 22 Jul 2022 14:21:49 -0600 Subject: [PATCH 0531/1753] Bump Microsoft.VisualStudio.Interop (#1060) Bumps Microsoft.VisualStudio.Interop from 17.2.32531.470 to 17.3.32630.470. --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Interop dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index fe79a3409..e72aa54c1 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -27,7 +27,7 @@ - + From 7cc5a15009551f5951cb64916b29db85d438433b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 Jul 2022 16:57:52 -0600 Subject: [PATCH 0532/1753] Skip zipping sources when real signing --- azure-pipelines/microbuild.before.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 05efd4a91..72fd72bb3 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -11,6 +11,7 @@ steps: - task: MicroBuildSigningPlugin@3 inputs: signType: $(SignType) + zipSources: false displayName: Install MicroBuild Signing Plugin - task: MicroBuildSbomPlugin@1 From 717cbce27383557a6930ecc99c68cb27962420f5 Mon Sep 17 00:00:00 2001 From: Drew Noakes Date: Mon, 25 Jul 2022 16:16:31 +1000 Subject: [PATCH 0533/1753] Remove non-existant "Properties" folder from project file --- .../Microsoft.VisualStudio.Threading.Analyzers.csproj | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj index a6c688ef0..58c9d7edd 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj @@ -28,7 +28,4 @@ - - - From de49f1f08ae4a4ec5f41d5a947599296dabb91ea Mon Sep 17 00:00:00 2001 From: Drew Noakes Date: Mon, 25 Jul 2022 16:17:44 +1000 Subject: [PATCH 0534/1753] VSTHRD100 flags async void for local functions and lamdas --- .../VSTHRD100AsyncVoidMethodAnalyzer.cs | 32 +++++++++++++--- .../VSTHRD100AsyncVoidMethodAnalyzerTests.cs | 37 +++++++++++++++++++ 2 files changed, 63 insertions(+), 6 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs index 04bbd5cf4..ae2125858 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs @@ -3,14 +3,11 @@ namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; using System.Collections.Immutable; - using System.Linq; - using System.Threading; using System.Threading.Tasks; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; + using Microsoft.CodeAnalysis.Operations; /// /// Detects the Async Void methods which are NOT used as asynchronous event handlers. @@ -60,10 +57,11 @@ public override void Initialize(AnalysisContext context) context.EnableConcurrentExecution(); context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterSymbolAction(Utils.DebuggableWrapper(this.AnalyzeNode), SymbolKind.Method); + context.RegisterSymbolAction(Utils.DebuggableWrapper(AnalyzeNode), SymbolKind.Method); + context.RegisterOperationAction(Utils.DebuggableWrapper(AnalyzeOperation), OperationKind.LocalFunction, OperationKind.AnonymousFunction); } - private void AnalyzeNode(SymbolAnalysisContext context) + private static void AnalyzeNode(SymbolAnalysisContext context) { var methodSymbol = (IMethodSymbol)context.Symbol; if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) @@ -71,5 +69,27 @@ private void AnalyzeNode(SymbolAnalysisContext context) context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); } } + + private static void AnalyzeOperation(OperationAnalysisContext context) + { + if (context.Operation is ILocalFunctionOperation localFunctionOperation) + { + AnalyzeSymbol(localFunctionOperation.Symbol); + } + else if (context.Operation is IAnonymousFunctionOperation anonymousFunctionOperation) + { + AnalyzeSymbol(anonymousFunctionOperation.Symbol); + } + + return; + + void AnalyzeSymbol(IMethodSymbol methodSymbol) + { + if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); + } + } + } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs index 69ac0c8f7..deeb744a1 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs @@ -24,6 +24,43 @@ async void F() { await Verify.VerifyAnalyzerAsync(test, expected); } + [Fact] + public async Task ReportWarningOnAsyncVoidLocalFunction() + { + var test = @" +using System; + +class Test { + void M() { + F(); + + async void F() {} + } +} +"; + CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 20); + await Verify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportWarningOnAsyncVoidLambda() + { + var test = @" +using System; +using System.Threading.Tasks; + +class Test { + void M() { + F(async void () => await Task.Delay(0)); + + void F(Action a) {} + } +} +"; + CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(7, 11); + await Verify.VerifyAnalyzerAsync(test, expected); + } + [Fact] public async Task ReportWarningOnAsyncVoidMethodSimilarToAsyncEventHandler() { From 0ebe82aece3b8a7ffecfca9fd8ab5171b604c8fa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 25 Jul 2022 11:11:46 -0600 Subject: [PATCH 0535/1753] Fix invalid C# syntax in test --- .../VSTHRD100AsyncVoidMethodAnalyzerTests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs index deeb744a1..3a31a6303 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs @@ -51,7 +51,7 @@ public async Task ReportWarningOnAsyncVoidLambda() class Test { void M() { - F(async void () => await Task.Delay(0)); + F(async () => await Task.Delay(0)); void F(Action a) {} } From a95d5a9d33cefef589626746660f2c1b1e000c4f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 25 Jul 2022 11:15:26 -0600 Subject: [PATCH 0536/1753] Add a test for an async delegate --- .../VSTHRD100AsyncVoidMethodAnalyzerTests.cs | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs index 3a31a6303..703c6eecd 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs @@ -61,6 +61,25 @@ void F(Action a) {} await Verify.VerifyAnalyzerAsync(test, expected); } + [Fact] + public async Task ReportWarningOnAsyncVoidDelegate() + { + var test = @" +using System; +using System.Threading.Tasks; + +class Test { + void M() { + F(async delegate() { await Task.Delay(0); }); + + void F(Action a) {} + } +} +"; + CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(7, 11); + await Verify.VerifyAnalyzerAsync(test, expected); + } + [Fact] public async Task ReportWarningOnAsyncVoidMethodSimilarToAsyncEventHandler() { From b7a52ae8ddfa47f86d10943528dfaafec91989b2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 25 Jul 2022 14:51:05 -0600 Subject: [PATCH 0537/1753] Update MicroBuild package version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 8886338e0..c55c85c8a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -31,7 +31,7 @@ true snupkg - 2.0.68 + 2.0.72 From 7d69d2a446ba4e3cec42c9787b3c18bf96d30a26 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 26 Jul 2022 17:44:03 -0600 Subject: [PATCH 0538/1753] Update MicroBuild version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index c55c85c8a..bc6ba5cd8 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -31,7 +31,7 @@ true snupkg - 2.0.72 + 2.0.73 From 0bb373adc92cdaca099a82d4dcdb1d59c8f73ffe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 27 Jul 2022 13:58:05 -0600 Subject: [PATCH 0539/1753] Fix WPF workaround This presumably broke when the intermediate directory was changed to include the relative path to the project directory. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 22c1b94de..dcf31a292 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -75,7 +75,7 @@ It's also not necessary to generate these assets. --> - <_WpfTempProjectNuGetFilePathNoExt>$(RepoRootPath)obj\$(_TargetAssemblyProjectName)\$(_TargetAssemblyProjectName)$(MSBuildProjectExtension).nuget.g + <_WpfTempProjectNuGetFilePathNoExt>$(BaseIntermediateOutputPath)..\$(_TargetAssemblyProjectName)\$(_TargetAssemblyProjectName)$(MSBuildProjectExtension).nuget.g false false From 4d1b60a66e7c1b26e28baab14e5d7c4cb03048b8 Mon Sep 17 00:00:00 2001 From: Drew Noakes Date: Thu, 28 Jul 2022 22:02:29 +1000 Subject: [PATCH 0540/1753] Don't fire VSTHRD100 for async lambdas/delegates These are already covered by VSTHRD101. --- .../VSTHRD100AsyncVoidMethodAnalyzer.cs | 14 +------ .../VSTHRD100AsyncVoidMethodAnalyzerTests.cs | 38 ------------------- 2 files changed, 2 insertions(+), 50 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs index ae2125858..0e7f5886b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs @@ -58,7 +58,7 @@ public override void Initialize(AnalysisContext context) context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); context.RegisterSymbolAction(Utils.DebuggableWrapper(AnalyzeNode), SymbolKind.Method); - context.RegisterOperationAction(Utils.DebuggableWrapper(AnalyzeOperation), OperationKind.LocalFunction, OperationKind.AnonymousFunction); + context.RegisterOperationAction(Utils.DebuggableWrapper(AnalyzeOperation), OperationKind.LocalFunction); } private static void AnalyzeNode(SymbolAnalysisContext context) @@ -74,17 +74,7 @@ private static void AnalyzeOperation(OperationAnalysisContext context) { if (context.Operation is ILocalFunctionOperation localFunctionOperation) { - AnalyzeSymbol(localFunctionOperation.Symbol); - } - else if (context.Operation is IAnonymousFunctionOperation anonymousFunctionOperation) - { - AnalyzeSymbol(anonymousFunctionOperation.Symbol); - } - - return; - - void AnalyzeSymbol(IMethodSymbol methodSymbol) - { + IMethodSymbol methodSymbol = localFunctionOperation.Symbol; if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) { context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs index 703c6eecd..3c642cdc0 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs @@ -42,44 +42,6 @@ async void F() {} await Verify.VerifyAnalyzerAsync(test, expected); } - [Fact] - public async Task ReportWarningOnAsyncVoidLambda() - { - var test = @" -using System; -using System.Threading.Tasks; - -class Test { - void M() { - F(async () => await Task.Delay(0)); - - void F(Action a) {} - } -} -"; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(7, 11); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportWarningOnAsyncVoidDelegate() - { - var test = @" -using System; -using System.Threading.Tasks; - -class Test { - void M() { - F(async delegate() { await Task.Delay(0); }); - - void F(Action a) {} - } -} -"; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(7, 11); - await Verify.VerifyAnalyzerAsync(test, expected); - } - [Fact] public async Task ReportWarningOnAsyncVoidMethodSimilarToAsyncEventHandler() { From 3ec6f43d2500784af5585714d411cbf33d9bd55c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Aug 2022 12:25:45 -0600 Subject: [PATCH 0541/1753] Bump Nullable from 1.3.0 to 1.3.1 (#172) Bumps [Nullable](https://github.com/manuelroemer/Nullable) from 1.3.0 to 1.3.1. - [Release notes](https://github.com/manuelroemer/Nullable/releases) - [Changelog](https://github.com/manuelroemer/Nullable/blob/master/CHANGELOG.md) - [Commits](https://github.com/manuelroemer/Nullable/commits) --- updated-dependencies: - dependency-name: Nullable dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index dcf31a292..c2b4b004f 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -38,7 +38,7 @@ - + From 45948958aece65a9048c74443139f5ce5fed952d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Aug 2022 18:33:20 +0000 Subject: [PATCH 0542/1753] Bump Nerdbank.GitVersioning from 3.5.107 to 3.5.108 (#171) --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index c2b4b004f..d13dbc489 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -37,7 +37,7 @@ - + From 396af02e150f71f9e1fdd942807a7332c698eca5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Aug 2022 12:19:04 -0600 Subject: [PATCH 0543/1753] Give plenty of time for pipelines for real-signing --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index f0e6c7e15..7ce7738a4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -11,6 +11,7 @@ parameters: jobs: - job: Windows pool: ${{ parameters.windowsPool }} + timeoutInMinutes: 180 # Give plenty of time due to real signing variables: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline From 7fd07c23d49f61f69a0e50a50ef12dc9c9bedc5b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Aug 2022 12:19:16 -0600 Subject: [PATCH 0544/1753] Skip APIScan on arm64 binaries --- azure-pipelines/secure-development-tools.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index c5ebf04e5..3e1badc4d 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -29,6 +29,7 @@ steps: # Exclude any patterns from the Contents (e.g. `!**/git2*`) that we have symbols for but do not need to run APIScan on. Contents: | ** + !**/arm64/** TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) From b39494e5d1115a599f4ed01565bc5419a8dace36 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Aug 2022 09:16:02 -0600 Subject: [PATCH 0545/1753] Make running tests in a pipeline optional --- azure-pipelines.yml | 5 +++++ azure-pipelines/build.yml | 16 +++++++++++++--- azure-pipelines/dotnet.yml | 4 ++++ azure-pipelines/publish-codecoverage.yml | 2 +- 4 files changed, 23 insertions(+), 4 deletions(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index d98ed107d..2cac17bd9 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -17,6 +17,10 @@ parameters: displayName: Build on macOS type: boolean default: false # macOS is often bogged down in Azure Pipelines +- name: RunTests + displayName: Run tests + type: boolean + default: true variables: TreatWarningsAsErrors: true @@ -30,3 +34,4 @@ jobs: - template: azure-pipelines/build.yml parameters: includeMacOS: ${{ parameters.includeMacOS }} + RunTests: ${{ parameters.RunTests }} diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5bfd95f53..cb4899493 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -4,6 +4,9 @@ parameters: default: vmImage: windows-2022 - name: includeMacOS +- name: RunTests + type: boolean + default: true jobs: - job: Windows @@ -17,6 +20,8 @@ jobs: displayName: ⚙ Set build number - template: dotnet.yml + parameters: + RunTests: ${{ parameters.RunTests }} - template: expand-template.yml - job: Linux @@ -27,6 +32,8 @@ jobs: clean: true - template: install-dependencies.yml - template: dotnet.yml + parameters: + RunTests: ${{ parameters.RunTests }} - template: expand-template.yml - job: macOS @@ -38,6 +45,8 @@ jobs: clean: true - template: install-dependencies.yml - template: dotnet.yml + parameters: + RunTests: ${{ parameters.RunTests }} - template: expand-template.yml - job: WrapUp @@ -56,7 +65,8 @@ jobs: - template: publish-symbols.yml parameters: includeMacOS: ${{ parameters.includeMacOS }} - - template: publish-codecoverage.yml - parameters: - includeMacOS: ${{ parameters.includeMacOS }} + - ${{ if parameters.RunTests }}: + - template: publish-codecoverage.yml + parameters: + includeMacOS: ${{ parameters.includeMacOS }} - template: publish-deployables.yml diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index ca9fc9b8a..055d44e90 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,3 +1,6 @@ +parameters: + RunTests: + steps: - script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" @@ -5,6 +8,7 @@ steps: - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults displayName: 🧪 dotnet test + condition: and(succeeded(), ${{ parameters.RunTests }}) - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 6e7ef21bd..11de8ffa1 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -14,7 +14,7 @@ steps: artifact: coverageResults-macOS displayName: 🔻 Download macOS code coverage results continueOnError: true - condition: ${{ parameters.includeMacOS }} + condition: and(succeeded(), ${{ parameters.includeMacOS }}) - powershell: azure-pipelines/Merge-CodeCoverage.ps1 -Path '$(Pipeline.Workspace)' -OutputDir coveragereport -Format Cobertura -Verbose displayName: ⚙ Merge coverage - task: PublishCodeCoverageResults@1 From 13d3a5635b19b6c4f7078059ebe042d3b38be9a3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Aug 2022 12:42:45 -0600 Subject: [PATCH 0546/1753] Detect more test assemblies --- azure-pipelines/Get-SymbolFiles.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index 9183c340e..0ce229fc2 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -18,7 +18,7 @@ Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" $PDBs = Get-ChildItem -rec "$Path/*.pdb" # Filter PDBs to product OR test related. -$testregex = "unittest|tests" +$testregex = "unittest|tests|\.test\." Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" $PDBsByHash = @{} From f68beb63687c66a3301f16bed97a791088281c22 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Aug 2022 15:09:03 -0600 Subject: [PATCH 0547/1753] More displayName icons --- azure-pipelines/microbuild.after.yml | 6 +++--- azure-pipelines/microbuild.before.yml | 8 ++++---- azure-pipelines/secure-development-tools.yml | 18 +++++++++--------- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 6f107833b..d6378b9fd 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -4,17 +4,17 @@ parameters: steps: - task: MicroBuildCodesignVerify@3 - displayName: Verify Signed Files + displayName: 🔍 Verify Signed Files inputs: TargetFolders: | $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet - task: MicroBuildCleanup@1 condition: succeededOrFailed() - displayName: MicroBuild Cleanup + displayName: ⚙️ MicroBuild Cleanup - task: Ref12Analyze@0 - displayName: Ref12 (Codex) Analyze + displayName: 📑 Ref12 (Codex) Analyze inputs: codexoutputroot: $(Build.ArtifactStagingDirectory)\Codex workflowArguments: | diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 72fd72bb3..a27cf36bd 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,9 +1,9 @@ steps: - task: ComponentGovernanceComponentDetection@0 - displayName: Component Detection + displayName: 🔍 Component Detection - task: notice@0 - displayName: Generate NOTICE file + displayName: 🛠️ Generate NOTICE file inputs: outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE outputformat: text @@ -12,7 +12,7 @@ steps: inputs: signType: $(SignType) zipSources: false - displayName: Install MicroBuild Signing Plugin + displayName: 🔧 Install MicroBuild Signing Plugin - task: MicroBuildSbomPlugin@1 - displayName: Install MicroBuild Sbom Plugin + displayName: 🔧 Install MicroBuild Sbom Plugin diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 3e1badc4d..324bfe86e 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -5,17 +5,17 @@ parameters: steps: - task: CredScan@3 - displayName: Run CredScan + displayName: 🔍 Run CredScan - task: PoliCheck@2 - displayName: Run PoliCheck + displayName: 🔍 Run PoliCheck inputs: targetType: F targetArgument: $(System.DefaultWorkingDirectory) optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml - task: BinSkim@4 - displayName: Run BinSkim + displayName: 🔍 Run BinSkim inputs: InputType: Basic Function: analyze @@ -23,7 +23,7 @@ steps: AnalyzeTargetGlob: $(BinSkimTargets) - task: CopyFiles@2 - displayName: Collect APIScan inputs + displayName: 🔍 Collect APIScan inputs inputs: SourceFolder: $(Build.ArtifactStagingDirectory)/Symbols-$(Agent.JobName) # Exclude any patterns from the Contents (e.g. `!**/git2*`) that we have symbols for but do not need to run APIScan on. @@ -34,7 +34,7 @@ steps: condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) - task: APIScan@2 - displayName: Run APIScan + displayName: 🔍 Run APIScan inputs: softwareFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs softwareName: $(SymbolsFeatureName) @@ -46,12 +46,12 @@ steps: AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) - task: SdtReport@2 - displayName: Create Security Analysis Report + displayName: 🛠️ Create Security Analysis Report inputs: GdnExportAllTools: true - task: PublishSecurityAnalysisLogs@3 - displayName: Publish Code Analysis Logs + displayName: 📢 Publish Code Analysis Logs inputs: ArtifactName: CodeAnalysisLogs ArtifactType: Container @@ -60,7 +60,7 @@ steps: ToolLogsNotFoundAction: Standard - task: PostAnalysis@2 - displayName: Break on compliance issues + displayName: 🏋️‍♀️ Break on compliance issues inputs: GdnBreakAllTools: true GdnBreakGdnToolBinSkimSeverity: Warning @@ -72,5 +72,5 @@ steps: # This is useful when false positives appear so we can copy some of the output into the suppressions file. - publish: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions artifact: guardian_failures_as_suppressions - displayName: Publish Guardian failures + displayName: 🔍 Publish Guardian failures condition: failed() From 5ff626cb52ca4f05217a7392f317928c5b4deba6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Aug 2022 15:14:15 -0600 Subject: [PATCH 0548/1753] Add a queue-time parameter for skipping compliance tasks --- azure-pipelines/build.yml | 6 +++++- azure-pipelines/microbuild.after.yml | 11 ++++++----- azure-pipelines/official.yml | 7 ++++++- azure-pipelines/secure-development-tools.yml | 6 ++++-- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 271a36648..2face9134 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -7,9 +7,12 @@ parameters: - name: RunTests type: boolean default: true +- name: EnableCompliance + type: boolean + default: true - name: EnableAPIScan type: boolean - default: false + default: true jobs: - job: Windows @@ -41,6 +44,7 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml parameters: + EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} - template: expand-template.yml diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index d6378b9fd..4c3554abd 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,6 +1,6 @@ parameters: -- name: EnableAPIScan - type: boolean + EnableCompliance: + EnableAPIScan: steps: - task: MicroBuildCodesignVerify@3 @@ -26,6 +26,7 @@ steps: condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'), ne(variables['Build.Reason'], 'PullRequest')) continueOnError: true -- template: secure-development-tools.yml - parameters: - EnableAPIScan: ${{ parameters.EnableAPIScan }} +- ${{ if eq(parameters.EnableCompliance, 'true') }}: + - template: secure-development-tools.yml + parameters: + EnableAPIScan: ${{ parameters.EnableAPIScan }} diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 1cc141f57..743fecb21 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -33,8 +33,12 @@ parameters: displayName: Run tests type: boolean default: true +- name: EnableCompliance + displayName: Run Compliance Tools + type: boolean + default: true - name: EnableAPIScan - displayName: Run APIScan + displayName: Include APIScan with Compliance tools type: boolean default: true @@ -55,6 +59,7 @@ stages: jobs: - template: build.yml parameters: + EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: ${{ parameters.includeMacOS }} diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 324bfe86e..cf5e26353 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -1,9 +1,11 @@ parameters: -- name: EnableAPIScan - type: boolean + EnableAPIScan: steps: +- powershell: echo "##vso[build.addbuildtag]compliance" + displayName: 🏷️ Tag run with 'compliance' + - task: CredScan@3 displayName: 🔍 Run CredScan From 4c03a7464f2d8512b75862e3a05e26db6f24f809 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Aug 2022 15:47:23 -0600 Subject: [PATCH 0549/1753] Fix Expand-Template --- Expand-Template.ps1 | 3 --- 1 file changed, 3 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 5705e7221..8d4c2f4b2 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -155,9 +155,6 @@ try { $YmlReplacements['(codecov_token: ).*(#.*)'] = "#`$1`$2" } Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements - Replace-Placeholders -Path "azure-pipelines/microbuild.after.yml" -Replacements @{ - 'Library' = $LibraryName; - } Replace-Placeholders -Path "azure-pipelines/variables/InsertVersionsValues.ps1" -Replacements @{ 'LibraryName' = $LibraryName; From d69d108c08c1e70399920a54e06aa5cfc050dd47 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Aug 2022 08:43:45 -0600 Subject: [PATCH 0550/1753] Hide the codecov publish task if it won't run Instead of showing it as a skipped task, just hide it if we won't run it because no codecov_token is provided. --- .github/workflows/build.yml | 2 +- azure-pipelines/dotnet.yml | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cde83cd9b..2c4ba94c6 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -11,7 +11,7 @@ env: TreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BUILDCONFIGURATION: Release - codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ + # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages/ jobs: diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 055d44e90..79babd4d4 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -20,11 +20,11 @@ steps: displayName: 📢 Publish artifacts condition: succeededOrFailed() -- powershell: | - $ArtifactStagingFolder = & "azure-pipelines/Get-ArtifactsStagingDirectory.ps1" - $CoverageResultsFolder = Join-Path $ArtifactStagingFolder "coverageResults-$(Agent.JobName)" - azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "$(codecov_token)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)Host,$(BuildConfiguration)" - displayName: 📢 Publish code coverage results to codecov.io - condition: ne(variables['codecov_token'], '') - timeoutInMinutes: 3 - continueOnError: true +- ${{ if and(ne(variables['codecov_token'], ''), parameters.RunTests) }}: + - powershell: | + $ArtifactStagingFolder = & "azure-pipelines/Get-ArtifactsStagingDirectory.ps1" + $CoverageResultsFolder = Join-Path $ArtifactStagingFolder "coverageResults-$(Agent.JobName)" + azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "$(codecov_token)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)Host,$(BuildConfiguration)" + displayName: 📢 Publish code coverage results to codecov.io + timeoutInMinutes: 3 + continueOnError: true From 44062e8b68603f85ee53326bcd8eadbacfe2bd1d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Aug 2022 16:52:57 -0600 Subject: [PATCH 0551/1753] Improve icon for task display name --- azure-pipelines/secure-development-tools.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index cf5e26353..ac540aead 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -48,7 +48,7 @@ steps: AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) - task: SdtReport@2 - displayName: 🛠️ Create Security Analysis Report + displayName: 📃 Create Security Analysis Report inputs: GdnExportAllTools: true From 68e3d617808b4558af4f940fe926e45c04715d0f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Aug 2022 08:53:58 -0600 Subject: [PATCH 0552/1753] Add warning about squashing a Lib.Template update --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8cab6b7af..d3b5acf07 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,8 @@ We create the merge commit with these commands: 1. Run `git commit-tree -p HEAD -p A B -m "Merged latest Library.Template"`, where `A` is the output from `git rev-parse HEAD` that you recorded earlier, and `B` is the output from your prior `git write-tree` command. 1. Run `git merge X` where `X` is the output of the `git commit-tree` command. +**IMPORTANT**: If using a pull request to get your changes into your repo, you must *merge* your PR. If you *squash* your PR, history will be lost and you will have to repeatedly resolve the same merge conflicts at the next Library.Template update. + **CAUTION**: when merging this for the first time, a github-hosted repo may close issues in your repo with the same number as issues that this repo closed in git commit messages. Verify after completing your PR by visiting your github closed issues, sorted by recently updated, and reactivate any that were inadvertently closed by this merge. This shouldn't be a recurring issue because going forward, we will avoid referencing github issues with simple `#123` syntax in this repo's history. From ecb2d113cc077bdf8f847afbfffd984c319eb79e Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Fri, 26 Aug 2022 09:48:32 -0700 Subject: [PATCH 0553/1753] Add a JoinableTaskToken type for use by VS --- .../JoinableTaskInternals.cs | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs index f173eca91..e8e15a657 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs @@ -3,6 +3,7 @@ namespace Microsoft.VisualStudio.Threading; +using System; using System.ComponentModel; #pragma warning disable RS0016 // Add public types and members to the declared API @@ -20,4 +21,37 @@ public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext? joi { return joinableTaskContext?.IsMainThreadBlockedByAnyJoinableTask == true; } + + public static JoinableTaskToken GetJoinableTaskToken(JoinableTaskContext? joinableTaskContext) + { + return new JoinableTaskToken() { JoinableTaskReference = joinableTaskContext?.AmbientTask?.WeakSelf }; + } + + public static bool IsMainThreadMaybeBlocked(JoinableTaskToken joinableTaskToken) + { + if (joinableTaskToken.JoinableTaskReference is not null && joinableTaskToken.JoinableTaskReference.TryGetTarget(out JoinableTask? joinableTask)) + { + if (joinableTask is object) + { + if ((joinableTask.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) + { + return false; + } + + if ((joinableTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + { + return true; + } + + return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(joinableTask); + } + } + + return false; + } + + public struct JoinableTaskToken + { + internal WeakReference? JoinableTaskReference; + } } From 9d6d5950f758b38c700c54c7301338a311ccd4cf Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Fri, 26 Aug 2022 16:53:48 -0700 Subject: [PATCH 0554/1753] Add unit tests. --- .../JoinableTask.cs | 18 ++ .../JoinableTaskContext.cs | 12 +- .../JoinableTaskInternals.cs | 25 +- .../JoinableTaskInternalsTests.cs | 297 ++++++++++++++++++ 4 files changed, 326 insertions(+), 26 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 8213a46fc..d22e6618d 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -416,6 +416,24 @@ internal JoinableTaskCreationOptions CreationOptions /// internal MethodInfo? EntryMethodInfo => this.initialDelegate?.GetMethodInfo(); + /// + /// Gets a very likely value whether the main thread is blocked by this + /// + internal bool MaybeBlockMainThread() + { + if ((this.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) + { + return false; + } + + if ((this.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + { + return true; + } + + return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(this); + } + /// /// Gets a value indicating whether this task has a non-empty queue. /// FOR DIAGNOSTICS COLLECTION ONLY. diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index acdaaae57..9bb339133 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -359,17 +359,7 @@ public bool IsMainThreadMaybeBlocked() JoinableTask? ambientTask = this.AmbientTask; if (ambientTask is object) { - if ((ambientTask.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) - { - return false; - } - - if ((ambientTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) - { - return true; - } - - return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(ambientTask); + return ambientTask.MaybeBlockMainThread(); } return false; diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs index e8e15a657..7575509b7 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs @@ -22,28 +22,23 @@ public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext? joi return joinableTaskContext?.IsMainThreadBlockedByAnyJoinableTask == true; } - public static JoinableTaskToken GetJoinableTaskToken(JoinableTaskContext? joinableTaskContext) + public static JoinableTaskToken? GetJoinableTaskToken(JoinableTaskContext? joinableTaskContext) { + if (joinableTaskContext?.AmbientTask?.WeakSelf is null) + { + return null; + } + return new JoinableTaskToken() { JoinableTaskReference = joinableTaskContext?.AmbientTask?.WeakSelf }; } - public static bool IsMainThreadMaybeBlocked(JoinableTaskToken joinableTaskToken) + public static bool IsMainThreadMaybeBlocked(JoinableTaskToken? joinableTaskToken) { - if (joinableTaskToken.JoinableTaskReference is not null && joinableTaskToken.JoinableTaskReference.TryGetTarget(out JoinableTask? joinableTask)) + if (joinableTaskToken?.JoinableTaskReference?.TryGetTarget(out JoinableTask? joinableTask) == true) { - if (joinableTask is object) + if (joinableTask is not null) { - if ((joinableTask.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) - { - return false; - } - - if ((joinableTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) - { - return true; - } - - return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(joinableTask); + return joinableTask.MaybeBlockMainThread(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs index 6544cce31..e9d7cc876 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs @@ -92,4 +92,301 @@ public void IsMainThreadBlockedByAnyJoinableTask_False() Assert.False(JoinableTaskInternals.IsMainThreadBlockedByAnyJoinableTask(this.context)); } + + [Fact] + public void GetJoinableTaskTokenNullWhenNoTask() + { + Assert.Null(JoinableTaskInternals.GetJoinableTaskToken(null)); + Assert.Null(JoinableTaskInternals.GetJoinableTaskToken(this.context)); + } + + [Fact] + public void GetJoinableTaskTokenNotNullWhenTaskRunning() + { + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + Assert.NotNull(JoinableTaskInternals.GetJoinableTaskToken(this.context)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.NotNull(JoinableTaskInternals.GetJoinableTaskToken(this.context)); + }); + + joinable.Join(); + Assert.Null(JoinableTaskInternals.GetJoinableTaskToken(this.context)); + } + + [Fact] + public void IsMainThreadMabyeBlockedFalseNullToken() + { + JoinableTaskInternals.JoinableTaskToken? token = null; + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + } + + [Fact] + public void IsMainThreadMabyeBlockedFalseWithNoTask() + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + } + + [Fact] + public void IsMainThreadBlockedFalseWhenAsync() + { + JoinableTaskInternals.JoinableTaskToken? token; + + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await Task.Yield(); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + this.testFrame.Continue = false; + }); + + this.PushFrame(); + joinable.Join(); // rethrow exceptions + } + + [Fact] + public void IsMainThreadBlockedTrueWhenAsyncBecomesBlocking() + { + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await Task.Yield(); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); // we're now running on top of Join() + + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); // although we're on background thread, we're blocking main thread. + + await this.asyncPump.RunAsync(async delegate + { + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await Task.Yield(); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await this.asyncPump.SwitchToMainThreadAsync(); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + }); + + joinable.Join(); + } + + [Fact] + public void IsMainThreadBlockedTrueWhenAsyncBecomesBlockingWithNestedTask() + { + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await Task.Yield(); + + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await this.asyncPump.RunAsync(async delegate + { + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + // Now release the message pump so we hit the Join() call + await this.asyncPump.SwitchToMainThreadAsync(); + this.testFrame.Continue = false; + await Task.Yield(); + + // From now on, we're blocking. + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + }); + + this.PushFrame(); // for duration of this, it appears to be non-blocking. + joinable.Join(); + } + + [Fact] + public void IsMainThreadBlockedTrueWhenOriginallySync() + { + this.asyncPump.Run(async delegate + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await Task.Yield(); + + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await this.asyncPump.RunAsync(async delegate + { + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await Task.Yield(); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await this.asyncPump.SwitchToMainThreadAsync(); + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + }); + } + + [Fact] + public void IsMainThreadBlockedFalseWhenSyncBlockingOtherThread() + { + Task.Run(delegate + { + this.asyncPump.Run(async delegate + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await Task.Yield(); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + }).WaitWithoutInlining(throwOriginalException: true); + } + + [Fact] + public void IsMainThreadBlockedTrueWhenAsyncOnOtherThreadBecomesSyncOnMainThread() + { + var nonBlockingStateObserved = new AsyncManualResetEvent(); + var nowBlocking = new AsyncManualResetEvent(); + JoinableTask? joinableTask = null; + Task.Run(delegate + { + joinableTask = this.asyncPump.RunAsync(async delegate + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + nonBlockingStateObserved.Set(); + await Task.Yield(); + await nowBlocking; + + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + }).Wait(); + + this.asyncPump.Run(async delegate + { + await nonBlockingStateObserved; + joinableTask!.JoinAsync().Forget(); + nowBlocking.Set(); + }); + } + + [Fact] + public void IsMainThreadBlockedFalseWhenTaskIsCompleted() + { + var nonBlockingStateObserved = new AsyncManualResetEvent(); + var nowBlocking = new AsyncManualResetEvent(); + + Task? checkTask = null; + this.asyncPump.Run( + async () => + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + + checkTask = Task.Run( + async () => + { + nonBlockingStateObserved.Set(); + + await nowBlocking; + + Assert.False(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + + Assert.True(JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await nonBlockingStateObserved; + }); + + nowBlocking.Set(); + + Assert.NotNull(checkTask); + checkTask!.Wait(); + } + + [Fact] + public void IsMainThreadMaybeBlockedEqualsJoinableTaskContextIsMainThreadMaybeBlocked_NoTask() + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + } + + [Fact] + public void IsMainThreadMaybeBlockedEqualsJoinableTaskContextIsMainThreadMaybeBlocked_Async() + { + JoinableTaskInternals.JoinableTaskToken? token; + JoinableTask? joinable = this.asyncPump.RunAsync(async delegate + { + token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await this.asyncPump.RunAsync(async delegate + { + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await Task.Yield(); + + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + + await this.asyncPump.SwitchToMainThreadAsync(); + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + }); + + joinable.Join(); + + token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + } + + [Fact] + public void IsMainThreadMaybeBlockedEqualsJoinableTaskContextIsMainThreadMaybeBlocked_Sync() + { + this.asyncPump.Run(async delegate + { + JoinableTaskInternals.JoinableTaskToken? token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + } + + [Fact] + public void DifferentTokenIsMainThreadMaybeBlockedNotEqualJoinableTaskContextIsMainThreadMaybeBlocked() + { + JoinableTaskInternals.JoinableTaskToken? token = null; + this.asyncPump.Run(async delegate + { + token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + + token = JoinableTaskInternals.GetJoinableTaskToken(this.context); + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + + Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + + this.asyncPump.Run(async delegate + { + Assert.NotEqual(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + Assert.NotEqual(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); + }); + } } From 62aa4c9fb9c4ced089d28b8d6bb2c7e64aa4e374 Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Fri, 26 Aug 2022 16:58:43 -0700 Subject: [PATCH 0555/1753] Remove unecessary lines --- .../JoinableTaskInternalsTests.cs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs index e9d7cc876..969fb62b9 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs @@ -374,12 +374,7 @@ public void DifferentTokenIsMainThreadMaybeBlockedNotEqualJoinableTaskContextIsM this.asyncPump.Run(async delegate { token = JoinableTaskInternals.GetJoinableTaskToken(this.context); - - token = JoinableTaskInternals.GetJoinableTaskToken(this.context); - Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); await TaskScheduler.Default.SwitchTo(alwaysYield: true); - - Assert.Equal(this.context.IsMainThreadMaybeBlocked(), JoinableTaskInternals.IsMainThreadMaybeBlocked(token)); }); this.asyncPump.Run(async delegate From 147c35b1c8a9f6d7e193deba155b5053ccfa6de3 Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Mon, 29 Aug 2022 10:13:10 -0700 Subject: [PATCH 0556/1753] Fix typlecop issues --- .../JoinableTask.cs | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index d22e6618d..c4a65e764 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -416,24 +416,6 @@ internal JoinableTaskCreationOptions CreationOptions /// internal MethodInfo? EntryMethodInfo => this.initialDelegate?.GetMethodInfo(); - /// - /// Gets a very likely value whether the main thread is blocked by this - /// - internal bool MaybeBlockMainThread() - { - if ((this.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) - { - return false; - } - - if ((this.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) - { - return true; - } - - return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(this); - } - /// /// Gets a value indicating whether this task has a non-empty queue. /// FOR DIAGNOSTICS COLLECTION ONLY. @@ -674,6 +656,24 @@ void IJoinableTaskDependent.OnDependencyRemoved(IJoinableTaskDependent joinChild { } + /// + /// Gets a very likely value whether the main thread is blocked by this . + /// + internal bool MaybeBlockMainThread() + { + if ((this.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) + { + return false; + } + + if ((this.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + { + return true; + } + + return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(this); + } + internal void Post(SendOrPostCallback d, object? state, bool mainThreadAffinitized) { using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) From 9fd6ef80b2cc717b08013ccdc75a248ddb72c6ee Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Mon, 29 Aug 2022 14:54:51 -0700 Subject: [PATCH 0557/1753] Cache AmbientTask --- .../JoinableTaskInternals.cs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs index 7575509b7..f0e54e672 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs @@ -24,12 +24,13 @@ public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext? joi public static JoinableTaskToken? GetJoinableTaskToken(JoinableTaskContext? joinableTaskContext) { - if (joinableTaskContext?.AmbientTask?.WeakSelf is null) + JoinableTask? ambientTask = joinableTaskContext?.AmbientTask; + if (ambientTask?.WeakSelf is null) { return null; } - return new JoinableTaskToken() { JoinableTaskReference = joinableTaskContext?.AmbientTask?.WeakSelf }; + return new JoinableTaskToken() { JoinableTaskReference = ambientTask?.WeakSelf }; } public static bool IsMainThreadMaybeBlocked(JoinableTaskToken? joinableTaskToken) From 5f4315dc3961aa37def1fd09215917a0596e94d5 Mon Sep 17 00:00:00 2001 From: Jialong Cheng Date: Mon, 29 Aug 2022 15:02:54 -0700 Subject: [PATCH 0558/1753] More concise change. --- .../JoinableTaskInternals.cs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs index f0e54e672..1786f0fe1 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs @@ -24,13 +24,12 @@ public static bool IsMainThreadBlockedByAnyJoinableTask(JoinableTaskContext? joi public static JoinableTaskToken? GetJoinableTaskToken(JoinableTaskContext? joinableTaskContext) { - JoinableTask? ambientTask = joinableTaskContext?.AmbientTask; - if (ambientTask?.WeakSelf is null) + if (joinableTaskContext?.AmbientTask?.WeakSelf is WeakReference currentTask) { - return null; + return new JoinableTaskToken() { JoinableTaskReference = currentTask }; } - return new JoinableTaskToken() { JoinableTaskReference = ambientTask?.WeakSelf }; + return null; } public static bool IsMainThreadMaybeBlocked(JoinableTaskToken? joinableTaskToken) From 8c56d91a1d1967e520e21ce55c87255780b7a798 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Sep 2022 13:25:43 -0600 Subject: [PATCH 0559/1753] Bump Microsoft.NET.Test.Sdk from 17.2.0 to 17.3.1 (#175) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.2.0 to 17.3.1. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/compare/v17.2.0...v17.3.1) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 92062dc79..a707cebea 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From 4dfc0ba9854c87eb8d310cfe337290c9c7bb5aeb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Sep 2022 13:25:57 -0600 Subject: [PATCH 0560/1753] Bump Nerdbank.GitVersioning from 3.5.108 to 3.5.109 (#174) Bumps [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) from 3.5.108 to 3.5.109. - [Release notes](https://github.com/dotnet/Nerdbank.GitVersioning/releases) - [Commits](https://github.com/dotnet/Nerdbank.GitVersioning/compare/v3.5.108...v3.5.109) --- updated-dependencies: - dependency-name: Nerdbank.GitVersioning dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index d13dbc489..35f7d62a6 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -37,7 +37,7 @@ - + From 2bcf967f7d8f19620077021f61219938478635e9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Sep 2022 13:26:07 -0600 Subject: [PATCH 0561/1753] Bump xunit from 2.4.1 to 2.4.2 (#173) Bumps [xunit](https://github.com/xunit/xunit) from 2.4.1 to 2.4.2. - [Release notes](https://github.com/xunit/xunit/releases) - [Commits](https://github.com/xunit/xunit/compare/2.4.1...2.4.2) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- test/Library.Tests/Library.Tests.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index a707cebea..2c1c3e8e5 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -12,7 +12,7 @@ - + From 8b87c079ec2dcb6da4f38449ec6a366cbd02506c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Sep 2022 20:56:12 -0600 Subject: [PATCH 0562/1753] Remove en-US from URL to docs --- SECURITY.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index f7b89984f..c8ee66023 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). -If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. ## Reporting Security Issues @@ -14,7 +14,7 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). -You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: @@ -38,4 +38,4 @@ We prefer all communications to be in English. Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). - \ No newline at end of file + From e16106d6686cf153c57064d2d55b77a9484f29d6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 6 Sep 2022 13:38:06 -0600 Subject: [PATCH 0563/1753] Update doc links --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36424c42d..e56631ddf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ You should install the version specified in `global.json` or a later version wit the same major.minor.Bxx "hundreds" band. For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.310 while the 2.2.400 version would not be considered compatible by .NET SDK. -See [.NET Core Versioning](https://docs.microsoft.com/en-us/dotnet/core/versions/) for more information. +See [.NET Core Versioning](https://docs.microsoft.com/dotnet/core/versions/) for more information. ## Package restore @@ -39,4 +39,4 @@ This repository can be built on Windows, Linux, and OSX. Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). -[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-6 +[pwsh]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell?view=powershell-6 diff --git a/README.md b/README.md index d3b5acf07..33ddbfab6 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ * Follow the best and simplest patterns of build, pack and test with dotnet CLI. * Init script that installs prerequisites and auth helpers, supporting both non-elevation and elevation modes. -* Static analyzers: [FxCop](https://docs.microsoft.com/en-us/visualstudio/code-quality/fxcop-analyzers?view=vs-2019) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) +* Static analyzers: default [Code Analysis](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/overview) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) * Read-only source tree (builds to top-level bin/obj folders) * Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/dotnet/nerdbank.gitversioning)) * Builds with a "pinned" .NET Core SDK to ensure reproducible builds across machines and across time. From 5d14d2cecbb3fd3caa6a421da1525d8480baef8b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Sep 2022 09:47:18 -0600 Subject: [PATCH 0564/1753] Force non-shallow clones Fixes issue 176 --- azure-pipelines/build.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index cb4899493..23b312218 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -13,6 +13,7 @@ jobs: pool: ${{ parameters.windowsPool }} steps: - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. clean: true - template: install-dependencies.yml @@ -29,6 +30,7 @@ jobs: vmImage: Ubuntu 20.04 steps: - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. clean: true - template: install-dependencies.yml - template: dotnet.yml @@ -42,6 +44,7 @@ jobs: vmImage: macOS-10.15 steps: - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. clean: true - template: install-dependencies.yml - template: dotnet.yml @@ -58,6 +61,7 @@ jobs: condition: succeededOrFailed() steps: - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. clean: true - template: install-dependencies.yml parameters: From 34f4c9f3058c9757647f61869bd7f226a32b7d14 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Sep 2022 10:56:39 -0600 Subject: [PATCH 0565/1753] Switch to using dotnet-coverage Now that the merge bug has been fixed, this should provide a better report than `dotnet-reportgenerator-globaltool` because methods with `#if` blocks will now still be merged in the report instead of being listed multiple times. --- azure-pipelines/Merge-CodeCoverage.ps1 | 15 ++++++++++----- azure-pipelines/publish-codecoverage.yml | 4 ++-- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 91ab67ab3..9fe925cf6 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -16,13 +16,13 @@ Param( [string[]]$Path, [ValidateSet('Badges', 'Clover', 'Cobertura', 'CsvSummary', 'Html', 'Html_Dark', 'Html_Light', 'HtmlChart', 'HtmlInline', 'HtmlInline_AzurePipelines', 'HtmlInline_AzurePipelines_Dark', 'HtmlInline_AzurePipelines_Light', 'HtmlSummary', 'JsonSummary', 'Latex', 'LatexSummary', 'lcov', 'MarkdownSummary', 'MHtml', 'PngChart', 'SonarQube', 'TeamCitySummary', 'TextSummary', 'Xml', 'XmlSummary')] [string]$Format='Cobertura', - [string]$OutputDir=("$PSScriptRoot/../coveragereport") + [string]$OutputFile=("$PSScriptRoot/../coveragereport/merged.cobertura.xml") ) $RepoRoot = [string](Resolve-Path $PSScriptRoot/..) -if (!(Test-Path $RepoRoot/obj/reportgenerator*)) { - dotnet tool install --tool-path $RepoRoot/obj dotnet-reportgenerator-globaltool --version 5.1.9 --configfile $PSScriptRoot/justnugetorg.nuget.config +if (!(Test-Path $RepoRoot/obj/dotnet-coverage*)) { + dotnet tool install --tool-path $RepoRoot/obj dotnet-coverage --version 17.4.3 --configfile $PSScriptRoot/justnugetorg.nuget.config } Write-Verbose "Searching $Path for *.cobertura.xml files" @@ -39,8 +39,13 @@ if ($reports) { $xml.Save($_) } - $Inputs = [string]::join(';', ($reports |% { Resolve-Path -relative $_.FullName })) - & "$RepoRoot/obj/reportgenerator" -reports:"$Inputs" -targetdir:$OutputDir -reporttypes:$Format + $Inputs = $reports |% { Resolve-Path -relative $_.FullName } + + if (Split-Path $OutputFile) { + New-Item -Type Directory -Path (Split-Path $OutputFile) | Out-Null + } + + & "$RepoRoot/obj/dotnet-coverage" merge $Inputs -o $OutputFile -f cobertura } else { Write-Error "No reports found to merge." } diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index 11de8ffa1..fbb6a39a7 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -15,11 +15,11 @@ steps: displayName: 🔻 Download macOS code coverage results continueOnError: true condition: and(succeeded(), ${{ parameters.includeMacOS }}) -- powershell: azure-pipelines/Merge-CodeCoverage.ps1 -Path '$(Pipeline.Workspace)' -OutputDir coveragereport -Format Cobertura -Verbose +- powershell: azure-pipelines/Merge-CodeCoverage.ps1 -Path '$(Pipeline.Workspace)' -OutputFile coveragereport/merged.cobertura.xml -Format Cobertura -Verbose displayName: ⚙ Merge coverage - task: PublishCodeCoverageResults@1 displayName: 📢 Publish code coverage results to Azure DevOps inputs: codeCoverageTool: cobertura - summaryFileLocation: coveragereport/Cobertura.xml + summaryFileLocation: coveragereport/merged.cobertura.xml failIfCoverageEmpty: true From 16f2a9a766f476d402fb4ba5ffa491b8f9df7661 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Sep 2022 09:41:37 -0600 Subject: [PATCH 0566/1753] Update NuGetAuthenticate task version --- azure-pipelines/install-dependencies.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 3993f1043..817826689 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -3,7 +3,7 @@ parameters: steps: -- task: NuGetAuthenticate@0 +- task: NuGetAuthenticate@1 displayName: 🔏 Authenticate NuGet feeds inputs: forceReinstallCredentialProvider: true From eba59d62b9184b50c52db83ee54e5f0486e8c602 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Sep 2022 09:41:37 -0600 Subject: [PATCH 0567/1753] Update NuGetAuthenticate task version --- azure-pipelines/official.yml | 2 +- azure-pipelines/vs-insertion.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 743fecb21..4be08885c 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -113,7 +113,7 @@ stages: # inputs: # packageType: sdk # version: 6.x -# - task: NuGetAuthenticate@0 +# - task: NuGetAuthenticate@1 # displayName: Authenticate NuGet feeds # inputs: # nuGetServiceConnections: azure-public/vs-impl diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 3143de8aa..7abb2e586 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -20,7 +20,7 @@ jobs: - checkout: none - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" displayName: Set pipeline name - - task: NuGetAuthenticate@0 + - task: NuGetAuthenticate@1 displayName: Authenticate NuGet feeds inputs: forceReinstallCredentialProvider: true From 261a02c2532c51a55e891cccdb0b56ca25c38f6b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Sep 2022 15:58:51 -0600 Subject: [PATCH 0568/1753] Document that we return the installed package path --- azure-pipelines/Install-NuGetPackage.ps1 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/azure-pipelines/Install-NuGetPackage.ps1 index 13967233f..cdac73085 100644 --- a/azure-pipelines/Install-NuGetPackage.ps1 +++ b/azure-pipelines/Install-NuGetPackage.ps1 @@ -11,6 +11,8 @@ The directory to install the package to. By default, it uses the Packages folder at the root of the repo. .PARAMETER ConfigFile The nuget.config file to use. By default, it uses :/nuget.config. +.OUTPUTS + System.String. The path to the installed package. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Low')] Param( @@ -46,6 +48,7 @@ try { if ($p.ExitCode -ne 0) { throw } } + # Provide the path to the installed package directory to our caller. Write-Output (Get-ChildItem "$PackagesDir\$PackageId.*")[0].FullName } finally { Pop-Location From a16659aacf3bff43aa5e36baba259e9ba0a5b5f7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Sep 2022 10:23:42 -0600 Subject: [PATCH 0569/1753] Install .NET SDK before authenticating nuget This may be important because how can NuGetAuthenticate decide to authenticate the `dotnet nuget` commands if `dotnet` isn't already there. --- azure-pipelines/vs-insertion.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 7abb2e586..112dd92f6 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -20,15 +20,15 @@ jobs: - checkout: none - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" displayName: Set pipeline name - - task: NuGetAuthenticate@1 - displayName: Authenticate NuGet feeds - inputs: - forceReinstallCredentialProvider: true - task: UseDotNet@2 displayName: Install .NET SDK inputs: packageType: sdk version: 6.x + - task: NuGetAuthenticate@1 + displayName: Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true - template: release-deployment-prep.yml - download: CI artifact: VSInsertion-Windows From c47c4b17546353648319dbf669b788d232d93bdf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Sep 2022 10:24:05 -0600 Subject: [PATCH 0570/1753] Split out the symbol archive and package push stages into a shareable yml file --- azure-pipelines/official.yml | 56 +------------------- azure-pipelines/prepare-insertion-stages.yml | 56 ++++++++++++++++++++ 2 files changed, 57 insertions(+), 55 deletions(-) create mode 100644 azure-pipelines/prepare-insertion-stages.yml diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 4be08885c..0a3980703 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -65,58 +65,4 @@ stages: includeMacOS: ${{ parameters.includeMacOS }} RunTests: ${{ parameters.RunTests }} -- stage: symbol_archive - displayName: Symbol archival - condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) - jobs: - - job: archive - pool: VSEng-ReleasePool-1ES - steps: - - checkout: none - - download: current - artifact: Variables-Windows - displayName: Download Variables-Windows artifact - - task: PowerShell@2 - displayName: Set VSTS variables based on artifacts - inputs: - targetType: filePath - filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 - - download: current - artifact: symbols-legacy - displayName: Download symbols-legacy artifact - - task: MicroBuildArchiveSymbols@1 - displayName: Archive symbols to Symweb - inputs: - SymbolsFeatureName: $(SymbolsFeatureName) - SymbolsSymwebProject: VS - SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival - SymbolsEmailContacts: vsidemicrobuild - SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy - - task: MicroBuildCleanup@1 - displayName: Send Telemetry - -# - stage: azure_public_vsimpl_feed -# displayName: azure-public/vs-impl feed -# condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) -# jobs: -# - job: push -# pool: -# name: AzurePipelines-EO -# vmImage: AzurePipelinesUbuntu20.04compliant -# steps: -# - checkout: none -# - download: current -# artifact: deployables-Windows -# displayName: Download deployables-Windows artifact -# - task: UseDotNet@2 -# displayName: Install .NET SDK -# inputs: -# packageType: sdk -# version: 6.x -# - task: NuGetAuthenticate@1 -# displayName: Authenticate NuGet feeds -# inputs: -# nuGetServiceConnections: azure-public/vs-impl -# forceReinstallCredentialProvider: true -# - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate -# displayName: Push nuget packages +- template: prepare-insertion-stages.yml diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml new file mode 100644 index 000000000..5d9da0767 --- /dev/null +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -0,0 +1,56 @@ +stages: +- stage: symbol_archive + displayName: Symbol archival + condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) + jobs: + - job: archive + pool: VSEng-ReleasePool-1ES + steps: + - checkout: none + - download: current + artifact: Variables-Windows + displayName: Download Variables-Windows artifact + - task: PowerShell@2 + displayName: Set VSTS variables based on artifacts + inputs: + targetType: filePath + filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + - download: current + artifact: symbols-legacy + displayName: Download symbols-legacy artifact + - task: MicroBuildArchiveSymbols@1 + displayName: Archive symbols to Symweb + inputs: + SymbolsFeatureName: $(SymbolsFeatureName) + SymbolsSymwebProject: VS + SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival + SymbolsEmailContacts: vsidemicrobuild + SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy + - task: MicroBuildCleanup@1 + displayName: Send Telemetry + +# - stage: azure_public_vsimpl_feed +# displayName: azure-public/vs-impl feed +# condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) +# jobs: +# - job: push +# pool: +# name: AzurePipelines-EO +# vmImage: AzurePipelinesUbuntu20.04compliant +# steps: +# - checkout: none +# - download: current +# artifact: deployables-Windows +# displayName: Download deployables-Windows artifact +# - task: UseDotNet@2 +# displayName: Install .NET SDK +# inputs: +# packageType: sdk +# version: 6.x +# - task: NuGetAuthenticate@1 +# displayName: Authenticate NuGet feeds +# inputs: +# nuGetServiceConnections: azure-public/vs-impl +# forceReinstallCredentialProvider: true +# - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate +# displayName: Push nuget packages From 10fcdb40dc799a4c8b061043237d3261e7eadd4d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Sep 2022 10:25:23 -0600 Subject: [PATCH 0571/1753] Add validation pipeline (targeted as a PR policy) --- azure-pipelines/Get-InsertionPRId.ps1 | 26 ++++++ azure-pipelines/PostPRMessage.ps1 | 57 ++++++++++++++ azure-pipelines/prepare-insertion-stages.yml | 2 +- azure-pipelines/vs-validation.yml | 83 ++++++++++++++++++++ 4 files changed, 167 insertions(+), 1 deletion(-) create mode 100644 azure-pipelines/Get-InsertionPRId.ps1 create mode 100644 azure-pipelines/PostPRMessage.ps1 create mode 100644 azure-pipelines/vs-validation.yml diff --git a/azure-pipelines/Get-InsertionPRId.ps1 b/azure-pipelines/Get-InsertionPRId.ps1 new file mode 100644 index 000000000..62cb30cd8 --- /dev/null +++ b/azure-pipelines/Get-InsertionPRId.ps1 @@ -0,0 +1,26 @@ +<# +.SYNOPSIS + Look up the pull request URL of the insertion PR. +#> +$stagingFolder = $env:BUILD_STAGINGDIRECTORY +if (!$stagingFolder) { + $stagingFolder = $env:SYSTEM_DEFAULTWORKINGDIRECTORY + if (!$stagingFolder) { + Write-Error "This script must be run in an Azure Pipeline." + exit 1 + } +} +$markdownFolder = Join-Path $stagingFolder (Join-Path 'MicroBuild' 'Output') +$markdownFile = Join-Path $markdownFolder 'PullRequestUrl.md' +if (!(Test-Path $markdownFile)) { + Write-Error "This script should be run after the MicroBuildInsertVsPayload task." + exit 2 +} + +$insertionPRUrl = Get-Content $markdownFile +if (!($insertionPRUrl -match 'https:.+?/pullrequest/(\d+)')) { + Write-Error "Failed to parse pull request URL: $insertionPRUrl" + exit 3 +} + +$Matches[1] diff --git a/azure-pipelines/PostPRMessage.ps1 b/azure-pipelines/PostPRMessage.ps1 new file mode 100644 index 000000000..4a2b7886e --- /dev/null +++ b/azure-pipelines/PostPRMessage.ps1 @@ -0,0 +1,57 @@ +[CmdletBinding(SupportsShouldProcess = $true)] +param( + [Parameter(Mandatory=$true)] + $AccessToken, + [Parameter(Mandatory=$true)] + $Markdown, + [ValidateSet('Active','ByDesign','Closed','Fixed','Pending','Unknown','WontFix')] + $CommentState='Active' +) + +# See https://docs.microsoft.com/en-us/dotnet/api/microsoft.teamfoundation.sourcecontrol.webapi.commentthreadstatus?view=azure-devops-dotnet +if ($CommentState -eq 'Active') { + $StatusCode = 1 +} elseif ($CommentState -eq 'ByDesign') { + $StatusCode = 5 +} elseif ($CommentState -eq 'Closed') { + $StatusCode = 4 +} elseif ($CommentState -eq 'Fixed') { + $StatusCode = 2 +} elseif ($CommentState -eq 'Pending') { + $StatusCode = 6 +} elseif ($CommentState -eq 'Unknown') { + $StatusCode = 0 +} elseif ($CommentState -eq 'WontFix') { + $StatusCode = 3 +} + +# Build the JSON body up +$body = ConvertTo-Json @{ + comments = @(@{ + parentCommentId = 0 + content = $Markdown + commentType = 1 + }) + status = $StatusCode +} + +Write-Verbose "Posting JSON payload: `n$Body" + +# Post the message to the Pull Request +# https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20request%20threads?view=azure-devops-rest-5.1 +$url = "$($env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI)$env:SYSTEM_TEAMPROJECTID/_apis/git/repositories/$($env:BUILD_REPOSITORY_NAME)/pullRequests/$($env:SYSTEM_PULLREQUEST_PULLREQUESTID)/threads?api-version=5.1" +if ($PSCmdlet.ShouldProcess($url, 'Post comment via REST call')) { + try { + if (!$env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI) { + Write-Error "Posting to the pull request requires that the script is running in an Azure Pipelines context." + exit 1 + } + Write-Host "Posting PR comment to: $url" + Invoke-RestMethod -Uri $url -Method POST -Headers @{Authorization = "Bearer $AccessToken"} -Body $Body -ContentType application/json + } + catch { + Write-Error $_ + Write-Error $_.Exception.Message + exit 2 + } +} diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 5d9da0767..a707454c4 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -11,7 +11,7 @@ stages: artifact: Variables-Windows displayName: Download Variables-Windows artifact - task: PowerShell@2 - displayName: Set VSTS variables based on artifacts + displayName: Set pipeline variables based on artifacts inputs: targetType: filePath filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml new file mode 100644 index 000000000..608600312 --- /dev/null +++ b/azure-pipelines/vs-validation.yml @@ -0,0 +1,83 @@ +# This is a top-level pipeline file, which is designed to be added as an optional PR build policy +# so that a VS insertion and all the validation that entails can be done before ever merging the PR +# in its original repo. + +trigger: none # We only want to trigger manually or based on resources +pr: none + +stages: +- stage: Build + variables: + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + SignTypeSelection: Real + BuildConfiguration: Release + ValidationBuild: true + + jobs: + - template: build.yml + parameters: + EnableCompliance: false + EnableAPIScan: false + windowsPool: VSEngSS-MicroBuild2022-1ES + includeMacOS: false + RunTests: false + +- template: prepare-insertion-stages.yml + +- stage: insertion + displayName: VS insertion + jobs: + - job: insertion + displayName: VS insertion + pool: VSEngSS-MicroBuild2022-1ES + steps: + - checkout: self + clean: true + fetchDepth: 1 + - task: UseDotNet@2 + displayName: Install .NET SDK + inputs: + packageType: sdk + version: 6.x + - task: NuGetAuthenticate@1 + displayName: Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true + - download: current + artifact: Variables-Windows + displayName: Download Variables-Windows artifact + - task: PowerShell@2 + displayName: Set pipeline variables based on artifacts + inputs: + targetType: filePath + filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + - download: current + artifact: VSInsertion-Windows + displayName: Download VSInsertion-Windows artifact + - script: dotnet nuget push VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate + displayName: Push CoreXT packages to VS feed + workingDirectory: $(Pipeline.Workspace) + - task: MicroBuildInsertVsPayload@4 + displayName: Insert VS Payload + inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) + InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) + InsertionDescription: | + This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. Expect the Required 'Public VS SDK test' to fail because validation builds do not push binaries to the Azure Artifact feeds on `azure-public`. + CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 + InsertionBuildPolicy: Request Perf DDRITs + AutoCompletePR: false + - powershell: | + $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 + $Markdown = @" + Validation insertion pull request created: !$insertionPRId + Please check status there before proceeding to merge this PR. + Remember to Abandon and Delete Source Branch on that insertion PR when validation is complete. + "@ + azure-pipelines/PostPRMessage.ps1 -AccessToken '$(System.AccessToken)' -Markdown $Markdown -Verbose + displayName: Comment on pull request + condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest')) + - task: MicroBuildCleanup@1 + displayName: Send Telemetry From d0f9808cfafbfb85908fd7c58567565145a7fe2e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 15 Sep 2022 17:43:05 -0600 Subject: [PATCH 0572/1753] Update docs in validation PRs --- azure-pipelines/vs-validation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 608600312..f021ca515 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -65,7 +65,7 @@ stages: TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) InsertionDescription: | - This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. Expect the Required 'Public VS SDK test' to fail because validation builds do not push binaries to the Azure Artifact feeds on `azure-public`. + This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 InsertionBuildPolicy: Request Perf DDRITs AutoCompletePR: false @@ -74,7 +74,7 @@ stages: $Markdown = @" Validation insertion pull request created: !$insertionPRId Please check status there before proceeding to merge this PR. - Remember to Abandon and Delete Source Branch on that insertion PR when validation is complete. + Remember to Abandon and (if allowed) to Delete Source Branch on that insertion PR when validation is complete. "@ azure-pipelines/PostPRMessage.ps1 -AccessToken '$(System.AccessToken)' -Markdown $Markdown -Verbose displayName: Comment on pull request From 990e1fddf79ead1ffdb27e79ea6f9a4c5973ee42 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Sep 2022 19:50:02 -0600 Subject: [PATCH 0573/1753] Add reasonable default person as a reviewer on insertion PRs --- azure-pipelines/variables/InsertReviewers.ps1 | 12 ++++++++++++ azure-pipelines/vs-validation.yml | 1 + 2 files changed, 13 insertions(+) create mode 100644 azure-pipelines/variables/InsertReviewers.ps1 diff --git a/azure-pipelines/variables/InsertReviewers.ps1 b/azure-pipelines/variables/InsertReviewers.ps1 new file mode 100644 index 000000000..6fd6648b0 --- /dev/null +++ b/azure-pipelines/variables/InsertReviewers.ps1 @@ -0,0 +1,12 @@ +# This is a list of AzDO account names or email addresses. +# Add your team DL and/or whoever should be notified of insertion PRs. +$contacts = ,$env:BUILD_REQUESTEDFOREMAIL + +if (Test-Path "$PSScriptRoot\TeamEmail.ps1") { + $contacts += & "$PSScriptRoot\TeamEmail.ps1" +} + +$contacts = $contacts |? { $_ } +if ($contacts) { + [string]::Join(',', $contacts) +} diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index f021ca515..3cbc196ed 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -68,6 +68,7 @@ stages: This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 InsertionBuildPolicy: Request Perf DDRITs + InsertionReviewers: $(Build.RequestedForEmail) AutoCompletePR: false - powershell: | $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 From 6f6af479ce91e97c641e777df3c9d2eec41b9f58 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Sep 2022 20:37:29 -0600 Subject: [PATCH 0574/1753] Add source code archival pipeline --- README.md | 1 + azure-pipelines/Archive-SourceCode.ps1 | 220 ++++++++++++++++++ azure-pipelines/archive-sourcecode.yml | 50 ++++ azure-pipelines/build.yml | 2 +- azure-pipelines/release.yml | 2 +- .../variables/BusinessGroupName.ps1 | 1 + 6 files changed, 274 insertions(+), 2 deletions(-) create mode 100644 azure-pipelines/Archive-SourceCode.ps1 create mode 100644 azure-pipelines/archive-sourcecode.yml create mode 100644 azure-pipelines/variables/BusinessGroupName.ps1 diff --git a/README.md b/README.md index 24a5c160e..12c5c49c1 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ Further customize your repo by: 1. Verify the license is suitable for your goal as it appears in the LICENSE and stylecop.json files and the Directory.Build.props file's `PackageLicenseExpression` property. 1. Reset or replace the badges at the top of this file. +1. Check and maybe change any variable groups referenced in the .yml files. Search for `- group:` to find them. ### Maintaining your repo based on this template diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 new file mode 100644 index 000000000..441bc1cf5 --- /dev/null +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -0,0 +1,220 @@ +#Requires -PSEdition Core -Version 7 +<# +.SYNOPSIS + Submits a source archival request for this repo. +.PARAMETER Requester + The alias for the user requesting this backup. +.PARAMETER ManagerAlias + The alias of the manager that owns the repo. +.PARAMETER TeamAlias + The alias of the team that owns the repo. +.PARAMETER BusinessGroupName + A human-readable title for your team or business group. +.PARAMETER ProductionType +.PARAMETER ReleaseType + The type of release being backed up. +.PARAMETER ReleaseDate + The date of the release of your software. Defaults to today. +.PARAMETER OwnerAlias + The alias of the owner. +.PARAMETER OS +.PARAMETER ProductLanguage + One or more languages. +.PARAMETER Notes + Any notes to record with the backup. +.PARAMETER FileCollection + One or more collections to archive. +.PARAMETER ProductName + The name of the product. This will default to the repository name. +.PARAMETER RepoUrl + The URL to the repository. This will default to the repository containing this script. +.PARAMETER BackupType + The kind of backup to be performed. +.PARAMETER ServerPath + The UNC path to the server to be backed up (if applicable). +.PARAMETER SourceCodeArchivalUri + The URI to POST the source code archival request to. + This value will typically come automatically by a variable group associated with your pipeline. + You can also look it up at https://dpsrequestforms.azurewebsites.net/#/help -> SCA Request Help -> SCA API Help -> Description +#> +[CmdletBinding(SupportsShouldProcess = $true, PositionalBinding = $false)] +param ( + [Parameter()] + [string]$Requester, + [Parameter(Mandatory = $true)] + [string]$ManagerAlias, + [Parameter(Mandatory = $true)] + [string]$TeamAlias, + [Parameter(Mandatory = $true)] + [string]$BusinessGroupName, + [Parameter()] + [string]$ProductionType = 'Visual Studio', + [Parameter()] + [string]$ReleaseType = 'RTW', + [Parameter()] + [DateTime]$ReleaseDate = [DateTime]::Today, + [Parameter()] + [string]$OwnerAlias, + [Parameter()] + [ValidateSet('64-Bit Win', '32-Bit Win', 'Linux', 'Mac', '64-Bit ARM', '32-Bit ARM')] + [string[]]$OS = @('64-Bit Win'), + [Parameter(Mandatory = $true)] + [ValidateSet('English', 'Chinese Simplified', 'Chinese Traditional', 'Czech', 'French', 'German', 'Italian', 'Japanese', 'Korean', 'Polish', 'Portuguese', 'Russian', 'Spanish', 'Turkish')] + [string[]]$ProductLanguage, + [Parameter()] + [string]$Notes = '', + [Parameter()] + [ValidateSet('Binaries', 'Localization', 'Source Code')] + [string[]]$FileCollection = @('Source Code'), + [Parameter()] + [string]$ProductName, + [Parameter()] + [Uri]$RepoUrl, + [Parameter()] + [ValidateSet('Server Path', 'Code Repo(Git URL/AzureDevOps)', 'Git', 'Azure Storage Account')] + [string]$BackupType = 'Code Repo(Git URL/AzureDevOps)', + [Parameter()] + [string]$ServerPath = '', + [Parameter()] + [Uri]$SourceCodeArchivalUri = $env:SOURCECODEARCHIVALURI +) + +function Invoke-Git() { + # Make sure we invoke git from within the repo. + Push-Location $PSScriptRoot + try { + return (git $args) + } + finally { + Pop-Location + } +} + +if (!$ProductName) { + if ($env:BUILD_REPOSITORY_NAME) { + Write-Verbose 'Using $env:BUILD_REPOSITORY_NAME for ProductName.' # single quotes are intentional so user sees the name of env var. + $ProductName = $env:BUILD_REPOSITORY_NAME + } + else { + $originUrl = [Uri](Invoke-Git remote get-url origin) + if ($originUrl) { + $lastPathSegment = $originUrl.Segments[$originUrl.Segments.Length - 1] + if ($lastPathSegment.EndsWith('.git')) { + $lastPathSegment = $lastPathSegment.Substring(0, $lastPathSegment.Length - '.git'.Length) + } + Write-Verbose 'Using origin remote URL to derive ProductName.' + $ProductName = $lastPathSegment + } + } + + if (!$ProductName) { + Write-Error "Unable to determine default value for -ProductName." + } +} + +if (!$OwnerAlias) { + if ($env:BUILD_REQUESTEDFOREMAIL) { + Write-Verbose 'Using $env:BUILD_REQUESTEDFOREMAIL and slicing to just the alias for OwnerAlias.' + $OwnerAlias = ($env:BUILD_REQUESTEDFOREMAIL -split '@')[0] + } + else { + Write-Verbose 'Using $env:USERNAME for OwnerAlias.' + $OwnerAlias = $env:USERNAME + } + if (!$OwnerAlias) { + Write-Error "Unable to determine default value for -OwnerAlias." + } +} + +if (!$Requester) { + if ($env:BUILD_REQUESTEDFOREMAIL) { + Write-Verbose 'Using $env:BUILD_REQUESTEDFOREMAIL and slicing to just the alias for Requester.' + $Requester = ($env:BUILD_REQUESTEDFOREMAIL -split '@')[0] + } + else { + Write-Verbose 'Using $env:USERNAME for Requester.' + $Requester = $env:USERNAME + } + if (!$Requester) { + Write-Error "Unable to determine default value for -Requester." + } +} + +if (!$RepoUrl) { + $RepoUrl = $env:BUILD_REPOSITORY_URI + if (!$RepoUrl) { + $originUrl = [Uri](Invoke-Git remote get-url origin) + if ($originUrl) { + Write-Verbose 'Using git origin remote url for GitURL.' + $RepoUrl = $originUrl + } + + if (!$RepoUrl) { + Write-Error "Unable to determine default value for -RepoUrl." + } + } +} + +Push-Location $PSScriptRoot +$versionsObj = & (& "$PSScriptRoot/Get-nbgv.ps1") get-version -f json | ConvertFrom-Json +Pop-Location + +$ReleaseDateString = $ReleaseDate.ToShortDateString() +$Version = $versionsObj.Version + +$BackupSize = Get-ChildItem $PSScriptRoot\..\.git -Recurse -File | Measure-Object -Property Length -Sum +$DataSizeMB = [int]($BackupSize.Sum / 1mb) +$FileCount = $BackupSize.Count + +$Request = @{ + "Requester" = $Requester + "Manager" = $ManagerAlias + "TeamAlias" = $TeamAlias + "AdditionalContacts" = $AdditionalContacts + "BusinessGroupName" = $BusinessGroupName + "ProductName" = $ProductName + "Version" = $Version + "ProductionType" = $ProductionType + "ReleaseType" = $ReleaseType + "ReleaseDateString" = $ReleaseDateString + "OS" = [string]::Join(',', $OS) + "ProductLanguage" = [string]::Join(',', $ProductLanguage) + "FileCollection" = [string]::Join(',', $FileCollection) + "OwnerAlias" = $OwnerAlias + "Notes" = $Notes + "CustomerProvidedDataSizeMB" = $DataSizeMB + "CustomerProvidedFileCount" = $FileCount + "BackupType" = $BackupType + "ServerPath" = $ServerPath + "AzureStorageAccount" = $AzureStorageAccount + "AzureStorageContainer" = $AzureStorageContainer + "GitURL" = $RepoUrl +} + +$RequestJson = ConvertTo-Json $Request +Write-Host "SCA request:`n$RequestJson" + +if ($PSCmdlet.ShouldProcess('source archival request', 'post')) { + if (!$SourceCodeArchivalUri) { + Write-Error "Unable to post request without -SourceCodeArchivalUri parameter." + exit 1 + } + + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + + $Response = Invoke-WebRequest -Uri $SourceCodeArchivalUri -Method POST -Body $RequestJson -ContentType "application/json" -UseBasicParsing -SkipHttpErrorCheck + Write-Host "Status Code : " -NoNewline + $responseContent = ConvertFrom-Json ($Response.Content) + if ($Response.StatusCode -eq 200) { + Write-Host $Response.StatusCode -ForegroundColor Green + Write-Host "Ticket ID : " -NoNewline + Write-Host $responseContent + } + else { + $responseContent = ConvertFrom-Json $Response.Content + Write-Host $Response.StatusCode -ForegroundColor Red + Write-Host "Message : $($responseContent.message)" + } +} elseif ($SourceCodeArchivalUri) { + Write-Host "Would have posted to $SourceCodeArchivalUri" +} diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml new file mode 100644 index 000000000..37b67cd39 --- /dev/null +++ b/azure-pipelines/archive-sourcecode.yml @@ -0,0 +1,50 @@ +trigger: none # We only want to trigger manually or based on resources +pr: none + +# Source archival requirements come from a compliance tenet. Review a sample task here: https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1550985 +# Source code should be archived within 30 days of the release date, and at least every quarter if your product is releasing more than once every 6 months. +# If your sources on GitHub are public open source project, then using GitHub Public Archive is sufficient. +schedules: +- cron: "13 13 13 */3 *" # Every three months + displayName: Periodic source archival + branches: + include: + - main + +parameters: +- name: notes + displayName: Notes to include in the SCA request + type: string +- name: whatif + displayName: Only simulate the request + type: boolean + +variables: +- group: VS Core team # Expected to provide ManagerAlias, SourceCodeArchivalUri + +pool: + name: AzurePipelines-EO + vmImage: AzurePipelinesUbuntu20.04compliant + +steps: +- checkout: self + clean: true + fetchDepth: 0 +- powershell: tools/Install-DotNetSdk.ps1 + displayName: Install .NET SDK +- powershell: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true + displayName: ⚙ Set pipeline variables based on source +- powershell: > + $TeamAlias = '$(TeamEmail)'.Substring(0, '$(TeamEmail)'.IndexOf('@')) + + azure-pipelines/Archive-SourceCode.ps1 + -ManagerAlias '$(ManagerAlias)' + -TeamAlias $TeamAlias + -BusinessGroupName '$(BusinessGroupName)' + -ProductName '$(SymbolsFeatureName)' + -ProductLanguage English + -Notes '${{ parameters.notes }}' + -Verbose + -WhatIf:$${{ parameters.whatif }} + displayName: Submit archival request diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index a819f3e02..e9b801f2c 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -21,7 +21,7 @@ jobs: variables: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline - - group: VSCloudServices-APIScan + - group: VSCloudServices-APIScan # Expected to provide ApiScanClientId, ApiScanSecret, ApiScanTenant steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index e1d883446..db7d7dd0d 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -10,7 +10,7 @@ resources: - auto-release variables: -- group: VS SDK feeds +- group: VS SDK feeds # Expected to provide NuGetOrgApiKey jobs: - job: release diff --git a/azure-pipelines/variables/BusinessGroupName.ps1 b/azure-pipelines/variables/BusinessGroupName.ps1 new file mode 100644 index 000000000..008242662 --- /dev/null +++ b/azure-pipelines/variables/BusinessGroupName.ps1 @@ -0,0 +1 @@ +'Visual Studio - VS Core' From c9f248d9179e97b27838604f5646fabd6d64150a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Sep 2022 21:23:50 -0600 Subject: [PATCH 0575/1753] Touch up on icons in pipeline --- azure-pipelines/archive-sourcecode.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 37b67cd39..3c0000c95 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -31,7 +31,7 @@ steps: clean: true fetchDepth: 0 - powershell: tools/Install-DotNetSdk.ps1 - displayName: Install .NET SDK + displayName: ⚙ Install .NET SDK - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: ⚙ Set pipeline variables based on source @@ -47,4 +47,4 @@ steps: -Notes '${{ parameters.notes }}' -Verbose -WhatIf:$${{ parameters.whatif }} - displayName: Submit archival request + displayName: 🗃️ Submit archival request From f43e6388312ddcff046adbc7b0b8e48627b47d39 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Sep 2022 22:48:12 -0600 Subject: [PATCH 0576/1753] Make `notes` parameter optional This works around lack of support by using a blank space as a default value. See https://developercommunity.visualstudio.com/idea/975396/optional-runtime-parameter.html --- azure-pipelines/Archive-SourceCode.ps1 | 2 +- azure-pipelines/archive-sourcecode.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index 441bc1cf5..8f605a8ed 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -181,7 +181,7 @@ $Request = @{ "ProductLanguage" = [string]::Join(',', $ProductLanguage) "FileCollection" = [string]::Join(',', $FileCollection) "OwnerAlias" = $OwnerAlias - "Notes" = $Notes + "Notes" = $Notes.Trim() "CustomerProvidedDataSizeMB" = $DataSizeMB "CustomerProvidedFileCount" = $FileCount "BackupType" = $BackupType diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 3c0000c95..2f00a00cb 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -15,6 +15,7 @@ parameters: - name: notes displayName: Notes to include in the SCA request type: string + default: ' ' # optional parameters require a non-empty default. - name: whatif displayName: Only simulate the request type: boolean From 12bda8587b4e368ff2417711f6c2d29928c00b12 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Sep 2022 17:21:42 -0600 Subject: [PATCH 0577/1753] Update macOS agent to OS12 --- azure-pipelines/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 23b312218..c8687859b 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -41,7 +41,7 @@ jobs: - job: macOS condition: ${{ parameters.includeMacOS }} pool: - vmImage: macOS-10.15 + vmImage: macOS-12 steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. From 34412f06a0e3a69eed70eedd8e8323d75e2d338b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Sep 2022 10:36:48 -0600 Subject: [PATCH 0578/1753] Add more analyzers --- .editorconfig | 9 +++++++++ Directory.Build.props | 2 ++ 2 files changed, 11 insertions(+) diff --git a/.editorconfig b/.editorconfig index 0d75b34a3..c8b5de9ac 100644 --- a/.editorconfig +++ b/.editorconfig @@ -167,5 +167,14 @@ dotnet_diagnostic.SA1130.severity = silent # IDE1006: Naming Styles - StyleCop handles these for us dotnet_diagnostic.IDE1006.severity = none +dotnet_diagnostic.DOC100.severity = silent +dotnet_diagnostic.DOC104.severity = warning +dotnet_diagnostic.DOC105.severity = warning +dotnet_diagnostic.DOC106.severity = warning +dotnet_diagnostic.DOC107.severity = warning +dotnet_diagnostic.DOC108.severity = warning +dotnet_diagnostic.DOC200.severity = warning +dotnet_diagnostic.DOC202.severity = warning + [*.sln] indent_style = tab diff --git a/Directory.Build.props b/Directory.Build.props index 35f7d62a6..f13158c00 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -41,6 +41,8 @@ + + From 671879ab3f16635eb6621c9dd1781e119b86f3ec Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Sep 2022 11:42:28 -0600 Subject: [PATCH 0579/1753] Switch to one nuget.config feed --- azure-pipelines/official.yml | 3 --- nuget.config | 24 ++++++------------------ 2 files changed, 6 insertions(+), 21 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 0a3980703..d469afdf3 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -42,9 +42,6 @@ parameters: type: boolean default: true -variables: - NugetSecurityAnalysisWarningLevel: none # nuget.config requires signed packages by trusted owners - stages: - stage: Build diff --git a/nuget.config b/nuget.config index b73bfabd2..4164936dc 100644 --- a/nuget.config +++ b/nuget.config @@ -2,31 +2,19 @@ - - - - - - - + - - - Microsoft;xunit;manuel.roemer;sharwell;jamesnk;aarnott;MarcoRossignoli;Thecentury - - - - - - - - + + + + + From 11b5be154b77323110cd068810753a2f5754426e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Sep 2022 12:05:56 -0600 Subject: [PATCH 0580/1753] Add commented nuget source for non-OSS repos --- nuget.config | 1 + 1 file changed, 1 insertion(+) diff --git a/nuget.config b/nuget.config index 4164936dc..66fe3b257 100644 --- a/nuget.config +++ b/nuget.config @@ -7,6 +7,7 @@ + From 7f33eec562d64cbf91e579509811e17fdc075d97 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Sep 2022 13:21:44 -0600 Subject: [PATCH 0581/1753] Switch to one public feed --- azure-pipelines/OptProf.yml | 2 -- azure-pipelines/official.yml | 3 --- nuget.config | 17 +---------------- 3 files changed, 1 insertion(+), 21 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 76cb8828b..ae69fb9e3 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -33,8 +33,6 @@ variables: - name: SignType value: real - group: Library.Template -- name: NugetSecurityAnalysisWarningLevel - value: none # nuget.config requires signed packages by trusted owners stages: - stage: Library diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 730e1b61a..6d7207b40 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -32,9 +32,6 @@ parameters: type: boolean default: false -variables: - NugetSecurityAnalysisWarningLevel: none # nuget.config requires signed packages by trusted owners - stages: - stage: Build diff --git a/nuget.config b/nuget.config index 40c3009ef..0de1d856b 100644 --- a/nuget.config +++ b/nuget.config @@ -2,24 +2,9 @@ - - - - - + - - - Microsoft;xunit;manuel.roemer;sharwell;jamesnk;aarnott;MarcoRossignoli;Thecentury;clairernovotny;reg;mmanela;onovotny - - - - - - - - From b94cc558a1ee66272e553ad665f004f32b9c1b80 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Sep 2022 07:44:44 -0600 Subject: [PATCH 0582/1753] Remove schedule trigger from servicing branches --- azure-pipelines/official.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 6d7207b40..729ee51c8 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -18,8 +18,6 @@ schedules: branches: include: - main - - 'v16.*' - - 'v17.*' parameters: - name: SignTypeSelection From fe603a52c8128146fa2b6561e93ba84b371cd7cd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Sep 2022 09:59:20 -0600 Subject: [PATCH 0583/1753] Use VS-Platform as the internal consumption feed --- nuget.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuget.config b/nuget.config index 66fe3b257..b4710e700 100644 --- a/nuget.config +++ b/nuget.config @@ -7,7 +7,7 @@ - + From a61f8b1d2d493607cc73d9b0d38d36c567633ff4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Sep 2022 10:00:14 -0600 Subject: [PATCH 0584/1753] Fix key to match the packageSource no matter which is kept --- nuget.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuget.config b/nuget.config index b4710e700..f1a998324 100644 --- a/nuget.config +++ b/nuget.config @@ -7,7 +7,7 @@ - + From 1066a1817cc8ce2de011ae54faddebe957fc4ed8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Sep 2022 10:10:09 -0600 Subject: [PATCH 0585/1753] Authenticate to azure-public/msft_consumption to allow ingestion of packages in official builds --- azure-pipelines/install-dependencies.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 817826689..4b71e6b53 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -6,6 +6,7 @@ steps: - task: NuGetAuthenticate@1 displayName: 🔏 Authenticate NuGet feeds inputs: + nuGetServiceConnections: azure-public/msft_consumption forceReinstallCredentialProvider: true - powershell: | From f0569776de5ddda31c3a8be52c1025a44dcf798e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Sep 2022 10:29:38 -0600 Subject: [PATCH 0586/1753] Revert "Authenticate to azure-public/msft_consumption to allow ingestion of packages in official builds" This led to the error in AzP: > ##[error]Error: The service connection for 'https://pkgs.dev.azure.com/azure-public/vside/_packaging/msft_consumption/nuget/v3/index.json' is not valid. ApiKey service connections are not supported in this task. Instead, use -ApiKey (NuGet) or --api-key (dotnet) when invoking the tool itself. See the task documentation for more details. This reverts commit 1066a1817cc8ce2de011ae54faddebe957fc4ed8. --- azure-pipelines/install-dependencies.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 4b71e6b53..817826689 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -6,7 +6,6 @@ steps: - task: NuGetAuthenticate@1 displayName: 🔏 Authenticate NuGet feeds inputs: - nuGetServiceConnections: azure-public/msft_consumption forceReinstallCredentialProvider: true - powershell: | From 2c34cc536a85f5f15227c874ca9e9946702744fe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Sep 2022 12:00:30 -0600 Subject: [PATCH 0587/1753] Authenticate to azure-public/msft_consumption to allow ingestion of packages in official builds This reverts commit f0569776de5ddda31c3a8be52c1025a44dcf798e. --- azure-pipelines/install-dependencies.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 817826689..4b71e6b53 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -6,6 +6,7 @@ steps: - task: NuGetAuthenticate@1 displayName: 🔏 Authenticate NuGet feeds inputs: + nuGetServiceConnections: azure-public/msft_consumption forceReinstallCredentialProvider: true - powershell: | From 7096a8d1665e3e21bc3ef5bd6f83a4198c42a6af Mon Sep 17 00:00:00 2001 From: Javier De la Garza Sanchez Date: Mon, 26 Sep 2022 11:14:52 -0700 Subject: [PATCH 0588/1753] Removed unstable tag from version 17.4 --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index a430878df..f42813ca4 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.4-alpha", + "version": "17.4", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 006072749dc96d071343e0e4aae5edd05635b6d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Sep 2022 10:27:46 -0600 Subject: [PATCH 0589/1753] Fix pipeline failure on azure-public --- azure-pipelines/install-dependencies.yml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 4b71e6b53..cdfd2ed42 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -3,11 +3,12 @@ parameters: steps: -- task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: - nuGetServiceConnections: azure-public/msft_consumption - forceReinstallCredentialProvider: true +- ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + - task: NuGetAuthenticate@1 + displayName: 🔏 Authenticate NuGet feeds + inputs: + nuGetServiceConnections: azure-public/msft_consumption + forceReinstallCredentialProvider: true - powershell: | $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors From 503365304724b6779e184ba84998f6dcf5cfb14a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Sep 2022 10:46:18 -0600 Subject: [PATCH 0590/1753] Authenticate nuget feeds on azure-public too --- azure-pipelines/install-dependencies.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index cdfd2ed42..0976e548e 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -3,12 +3,12 @@ parameters: steps: -- ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - - task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: +- task: NuGetAuthenticate@1 + displayName: 🔏 Authenticate NuGet feeds + inputs: + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: nuGetServiceConnections: azure-public/msft_consumption - forceReinstallCredentialProvider: true + forceReinstallCredentialProvider: true - powershell: | $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors From 2678ec5fa3e3d854140405cd980f241df8da617e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Sep 2022 08:39:19 -0600 Subject: [PATCH 0591/1753] Use static graph restore It's faster, and the future. --- Directory.Build.props | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Directory.Build.props b/Directory.Build.props index f13158c00..3170d14b1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -16,6 +16,9 @@ true + + true + $(MSBuildThisFileDirectory) From 90a2c4b7d3907b6f7d6e08eac3305fca6c310245 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Sep 2022 14:50:36 -0600 Subject: [PATCH 0592/1753] Remove the package mapping in nuget.config nuget no longer requires this. --- nuget.config | 5 ----- 1 file changed, 5 deletions(-) diff --git a/nuget.config b/nuget.config index f1a998324..52071eaac 100644 --- a/nuget.config +++ b/nuget.config @@ -13,9 +13,4 @@ - - - - - From 0552ddca8b22548fe1e331a64ebe430fe6a80008 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 30 Sep 2022 22:48:21 -0600 Subject: [PATCH 0593/1753] Update dependencies --- Directory.Build.props | 2 +- test/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 3170d14b1..8cada6c76 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -40,7 +40,7 @@ - + diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 2c1c3e8e5..4e9a7a4c4 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,7 @@ - + From 2eaf0fb8f261f978f6d60bef5fde8c87d5eb8640 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Oct 2022 11:48:02 -0600 Subject: [PATCH 0594/1753] Update .NET SDK to 6.0.401 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index b13ca0aca..5c1bdc7ab 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,4 @@ -FROM mcr.microsoft.com/dotnet/sdk:6.0.300-focal +FROM mcr.microsoft.com/dotnet/sdk:6.0.401-focal # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 954a92e75..7bf6fc99a 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "6.0.300", + "version": "6.0.401", "rollForward": "patch", "allowPrerelease": false } From 577e0023a2325ad5c9abd9d96dd1733ef83ec5be Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Oct 2022 11:49:36 -0600 Subject: [PATCH 0595/1753] Update MicroBuild version to 2.0.84 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 3da24e860..f74cb06d0 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -34,7 +34,7 @@ true snupkg - 2.0.73 + 2.0.84 From abab1d849933ee85cb6f026026f28e481db1bc64 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 20 Oct 2022 16:06:44 -0600 Subject: [PATCH 0596/1753] Fix variable detection on linux Linux can have empty values for environment variables. Windows evidently doesn't tend to have those. --- azure-pipelines/variables/_pipelines.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 951106d2d..11748b81b 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -14,7 +14,7 @@ param ( (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. $keyCaps = $_.Key.ToUpper() - if (Test-Path -Path "env:$keyCaps") { + if ((Test-Path "env:$keyCaps") -and (Get-Content "env:$keyCaps")) { Write-Host "Skipping setting $keyCaps because variable is already set to '$(Get-Content env:$keyCaps)'." -ForegroundColor Cyan } else { Write-Host "$keyCaps=$($_.Value)" -ForegroundColor Yellow From 93af18446791dfced1104fe02d9b7f0a67a54052 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 10:19:15 -0600 Subject: [PATCH 0597/1753] Fix using order and test project warnings --- .../CSharpCommonInterest.cs | 20 +- .../CSharpUtils.cs | 20 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 6 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 6 +- .../CSharpVSTHRD011UseAsyncLazyAnalyzer.cs | 6 +- .../CSharpVSTHRD012SpecifyJtfWhereAllowed.cs | 6 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 6 +- ...8AssertThreadRequirementUnconditionally.cs | 6 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 6 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 6 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 6 +- .../VSTHRD002UseJtfRunAnalyzer.cs | 22 +- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 24 +- .../VSTHRD010MainThreadUsageAnalyzer.cs | 26 +- ...02AvoidJtfRunInNonPublicMembersAnalyzer.cs | 22 +- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 26 +- .../VSTHRD104OfferAsyncOptionAnalyzer.cs | 22 +- ...7AwaitTaskWithinUsingExpressionAnalyzer.cs | 22 +- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 12 +- .../CommonFixes.cs | 36 +- .../FixUtils.cs | 24 +- .../NullableHelpers.cs | 4 +- .../SyntaxGeneratorExtensions.cs | 8 +- .../VSTHRD002UseJtfRunCodeFixWithAwait.cs | 32 +- .../VSTHRD010MainThreadUsageCodeFix.cs | 34 +- .../VSTHRD100AsyncVoidMethodCodeFix.cs | 30 +- .../VSTHRD103UseAsyncOptionCodeFix.cs | 32 +- ...07AwaitTaskWithinUsingExpressionCodeFix.cs | 32 +- ...THRD109AvoidAssertInAsyncMethodsCodeFix.cs | 34 +- .../VSTHRD111UseConfigureAwaitCodeFix.cs | 32 +- ...2ImplementSystemIAsyncDisposableCodeFix.cs | 16 +- .../VSTHRD114AvoidReturningNullTaskCodeFix.cs | 18 +- ...STHRD200UseAsyncNamingConventionCodeFix.cs | 30 +- .../VisualBasicUtils.cs | 12 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 6 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 6 +- ...isualBasicVSTHRD011UseAsyncLazyAnalyzer.cs | 6 +- ...ualBasicVSTHRD012SpecifyJtfWhereAllowed.cs | 6 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 6 +- ...8AssertThreadRequirementUnconditionally.cs | 6 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 6 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 6 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 6 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 10 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 10 +- .../AbstractVSTHRD011UseAsyncLazyAnalyzer.cs | 14 +- ...AbstractVSTHRD012SpecifyJtfWhereAllowed.cs | 14 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 16 +- ...8AssertThreadRequirementUnconditionally.cs | 14 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 10 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 8 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 12 +- .../CommonInterest.cs | 30 +- .../DiagnosticAnalyzerState.cs | 20 +- .../LanguageUtils.cs | 8 +- .../Namespaces.cs | 4 +- .../Types.cs | 4 +- .../Utils.cs | 36 +- .../VSTHRD100AsyncVoidMethodAnalyzer.cs | 12 +- .../VSTHRD101AsyncVoidLambdaAnalyzer.cs | 12 +- ...106UseInvokeAsyncForAsyncEventsAnalyzer.cs | 12 +- .../VSTHRD111UseConfigureAwaitAnalyzer.cs | 12 +- ...3CheckForSystemIAsyncDisposableAnalyzer.cs | 20 +- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 12 +- .../AsyncAutoResetEvent.cs | 22 +- .../AsyncBarrier.cs | 16 +- .../AsyncCountdownEvent.cs | 16 +- .../AsyncEventHandler.cs | 12 +- .../AsyncLazyInitializer.cs | 8 +- .../AsyncLazy`1.cs | 10 +- .../AsyncManualResetEvent.cs | 28 +- .../AsyncQueue`1.cs | 32 +- ...cReaderWriterLock+HangReportContributor.cs | 18 +- .../AsyncReaderWriterLock.cs | 102 +- .../AsyncReaderWriterResourceLock`2.cs | 30 +- .../AsyncSemaphore.cs | 12 +- .../AwaitExtensions.cs | 36 +- .../CancellableJoinComputation.cs | 12 +- .../CancellationTokenExtensions.cs | 10 +- .../DelegatingJoinableTaskFactory.cs | 16 +- src/Microsoft.VisualStudio.Threading/Dgml.cs | 14 +- .../DispatcherExtensions.cs | 10 +- .../EnumerateOneOrMany`1.cs | 14 +- .../HangReportContribution.cs | 16 +- .../IAsyncDisposable.cs | 4 +- .../IHangReportContributor.cs | 12 +- .../IllegalSemaphoreUsageException.cs | 6 +- .../InlineResumable.cs | 10 +- .../InternalUtilities.cs | 18 +- .../JoinableTask+ExecutionQueue.cs | 14 +- ...Task+JoinableTaskSynchronizationContext.cs | 14 +- .../JoinableTask.cs | 28 +- .../JoinableTaskCollection.cs | 16 +- ...inableTaskContext+HangReportContributor.cs | 16 +- .../JoinableTaskContext.cs | 30 +- .../JoinableTaskContextException.cs | 4 +- .../JoinableTaskContextNode.cs | 16 +- .../JoinableTaskCreationOptions.cs | 4 +- .../JoinableTaskDependencyGraph.cs | 14 +- .../JoinableTaskFactory.cs | 36 +- .../JoinableTaskInternals.cs | 3 +- .../JoinableTask`1.cs | 20 +- .../LightUps.cs | 4 +- .../ListOfOftenOne`1.cs | 18 +- .../NoMessagePumpSyncContext.cs | 14 +- .../NonConcurrentSynchronizationContext.cs | 12 +- .../NullableHelpers.cs | 4 +- .../ProgressWithCompletion`1.cs | 12 +- .../RarelyRemoveItemSet`1.cs | 6 +- .../ReentrantSemaphore.cs | 20 +- .../RegistryChangeNotificationFilters.cs | 6 +- .../RoslynDebug.cs | 4 +- .../SemaphoreFaultedException.cs | 4 +- .../SingleThreadedSynchronizationContext.cs | 10 +- .../SpecializedSyncContext.cs | 6 +- .../TaskCompletionSourceWithoutInlining`1.cs | 14 +- .../ThreadingEventSource.cs | 6 +- .../ThreadingTools.cs | 16 +- .../TplExtensions.cs | 40 +- .../WeakKeyDictionary`2.cs | 12 +- src/SosThreadingTools/Commands.cs | 8 +- src/SosThreadingTools/DebuggerContext.cs | 20 +- src/SosThreadingTools/DebuggerOutput.cs | 4 +- src/SosThreadingTools/DumpAsyncCommand.cs | 12 +- src/SosThreadingTools/ExtensionContext.cs | 10 +- src/SosThreadingTools/Utilities.cs | 10 +- test/IsolatedTestHost/Program.cs | 16 +- test/IsolatedTestHost/TestOutputHelper.cs | 6 +- .../Helpers/CSharpCodeFixVerifier`2+Test.cs | 127 +- .../Helpers/CSharpCodeFixVerifier`2.cs | 77 +- .../Helpers/ReferencesHelper.cs | 45 +- .../VisualBasicCodeFixVerifier`2+Test.cs | 123 +- .../Helpers/VisualBasicCodeFixVerifier`2.cs | 77 +- .../MultiAnalyzerTests.cs | 297 ++-- ...UseSwitchToMainThreadAsyncAnalyzerTests.cs | 119 +- .../VSTHRD002UseJtfRunAnalyzerTests.cs | 449 +++--- .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 695 +++++----- ...aitSwitchToMainThreadAsyncAnalyzerTests.cs | 85 +- .../VSTHRD010MainThreadUsageAnalyzerTests.cs | 1213 ++++++++--------- .../VSTHRD011UseAsyncLazyAnalyzerTests.cs | 145 +- .../VSTHRD012SpecifyJtfWhereAllowedTests.cs | 193 ++- .../VSTHRD100AsyncVoidMethodAnalyzerTests.cs | 109 +- .../VSTHRD100AsyncVoidMethodCodeFixTests.cs | 43 +- .../VSTHRD101AsyncVoidLambdaAnalyzerTests.cs | 119 +- ...idJtfRunInNonPublicMembersAnalyzerTests.cs | 257 ++-- .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 639 +++++---- .../VSTHRD104OfferAsyncOptionAnalyzerTests.cs | 63 +- ...plicitTaskSchedulerCurrentAnalyzerTests.cs | 97 +- ...eInvokeAsyncForAsyncEventsAnalyzerTests.cs | 191 ++- ...tTaskWithinUsingExpressionAnalyzerTests.cs | 131 +- ...rtThreadRequirementUnconditionallyTests.cs | 143 +- ...9AvoidAssertInAsyncMethodsAnalyzerTests.cs | 145 +- ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 257 ++-- ...VSTHRD111UseConfigureAwaitAnalyzerTests.cs | 127 +- ...mentSystemIAsyncDisposableAnalyzerTests.cs | 257 ++-- ...kForSystemIAsyncDisposableAnalyzerTests.cs | 199 ++- ...D114AvoidReturningNullTaskAnalyzerTests.cs | 259 ++-- ...RD114AvoidReturningNullTaskCodeFixTests.cs | 165 +-- ...00UseAsyncNamingConventionAnalyzerTests.cs | 407 +++--- .../Program.cs | 4 +- .../JoinableTaskTests.cs | 6 +- .../ReentrantSemaphoreTestBase.cs | 8 +- .../TestBase.cs | 10 +- .../TestUtilities.cs | 16 +- .../ThreadingToolsTests.cs | 4 +- 165 files changed, 4626 insertions(+), 4656 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs index edcfe3a82..fdcb5194b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Text; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Text; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - internal static class CSharpCommonInterest { internal static readonly IImmutableSet MethodSyntaxKinds = ImmutableHashSet.Create( diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index fd8b66fb2..98bd90f5f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Threading; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Threading; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Operations; - internal sealed class CSharpUtils : LanguageUtils { public static readonly CSharpUtils Instance = new CSharpUtils(); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 893c92e4d..02e96d15a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index f045b197a..71b8b03fc 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs index c31f15cc5..1edaea200 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs index d0330c8ae..357282782 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index deb87a496..3a7dad291 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs index 01dfa5faf..3022c6f31 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index fad37282e..69256510c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index c54263c8c..470eaec53 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs index 148913614..b49889fc0 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs index 903dd7199..241299d7f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// Report warnings when detect the code that is waiting on tasks or awaiters synchronously. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 16f794ad4..d0a16d39f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Diagnostics; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Diagnostics; - using System.Linq; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// Detects await Task inside JoinableTaskFactory.Run or RunAsync. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs index e3c366283..bf9d35685 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Threading; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; +using Microsoft.CodeAnalysis.Text; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Threading; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - using Microsoft.CodeAnalysis.Text; - /// /// Flag usage of objects that must only be invoked while on the main thread (e.g. STA COM objects) /// without having first verified that the current thread is main thread either by throwing if on @@ -440,7 +440,7 @@ internal void AnalyzeIsPattern(SyntaxNodeAnalysisContext context) /// /// Determines whether a given type is likely to be (or implemented by) a COM object. /// - /// true if the type appears to be a COM object; false if a managed object. + /// if the type appears to be a COM object; if a managed object. /// /// Type casts and type checks are thread-affinitized for (STA) COM objects, and free-threaded for managed ones. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs index 21ca86141..0f824bee8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// Discourages use of JTF.Run except in public members where the author presumably /// has limited opportunity to make the method async due to API impact and breaking changes. diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index 63a62d176..3f66fbe73 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// This analyzer recognizes invocations of JoinableTaskFactory.Run(Func{Task}), JoinableTask.Join(), and variants /// that occur within an async method, thus defeating a perfect opportunity to be asynchronous. @@ -144,7 +144,7 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) /// The candidate method. /// The baseline method. /// - /// true if has a superset of parameter types found in ; otherwise false. + /// if has a superset of parameter types found in ; otherwise . /// private static bool HasSupersetOfParameterTypes(IMethodSymbol candidateMethod, IMethodSymbol baselineMethod) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs index 66648e282..e3aa6f4ff 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp)] public class VSTHRD104OfferAsyncOptionAnalyzer : DiagnosticAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs index 339648aba..a7e1386ed 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// Analyzes expressions of `using` statements and creates a diagnostic when the expression /// is of type . diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index f03cba246..8dc31fdeb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// Report errors when async methods calls are not awaited or the result used in some way within a synchronous method. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs index 82596ccab..b890e617b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs @@ -1,26 +1,26 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Diagnostics; +using System.IO; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Text.RegularExpressions; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Text; +using static Microsoft.VisualStudio.Threading.Analyzers.CommonInterest; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Diagnostics; - using System.IO; - using System.Linq; - using System.Runtime.CompilerServices; - using System.Text.RegularExpressions; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Text; - using static CommonInterest; - internal static class CommonFixes { internal static async Task> ReadMethodsAsync(CodeFixContext codeFixContext, Regex fileNamePattern, CancellationToken cancellationToken) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs index 093053e76..77a181a4d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.FindSymbols; +using Microsoft.CodeAnalysis.Rename; +using Microsoft.CodeAnalysis.Simplification; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.FindSymbols; - using Microsoft.CodeAnalysis.Rename; - using Microsoft.CodeAnalysis.Simplification; - internal static class FixUtils { internal const string BookmarkAnnotationName = "Bookmark"; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs index 5201e6069..278bed254 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - internal static class NullableHelpers { /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs index 4e5b95457..aa630b181 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Linq; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Editing; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Linq; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Editing; - internal static class SyntaxGeneratorExtensions { /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs index 2b3b3865e..8b9fe6be0 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs @@ -1,24 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - [ExportCodeFixProvider(LanguageNames.CSharp)] public class VSTHRD002UseJtfRunCodeFixWithAwait : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs index 6fa16ce7b..b455aa075 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs @@ -1,25 +1,25 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Text; +using System.Text.RegularExpressions; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Formatting; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Text; - using System.Text.RegularExpressions; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Formatting; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - [ExportCodeFixProvider(LanguageNames.CSharp)] public class VSTHRD010MainThreadUsageCodeFix : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs index f9e6865b2..c1c4c5555 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs @@ -1,23 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - /// /// Provides a code action to fix the Async Void Method by changing the return type to Task. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs index 080a01f26..4febbde48 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs @@ -1,24 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Globalization; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - /// /// Provides a code action to fix calls to synchronous methods from async methods when async options exist. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs index 55eeb4dbd..190e66a1b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs @@ -1,24 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Globalization; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - /// /// Offers a code fix for diagnostics produced by the /// . diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs index 218cf4eef..9443dec36 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs @@ -1,25 +1,25 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Text; +using System.Text.RegularExpressions; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Formatting; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Text; - using System.Text.RegularExpressions; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Formatting; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - [ExportCodeFixProvider(LanguageNames.CSharp)] public class VSTHRD109AvoidAssertInAsyncMethodsCodeFix : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs index 0d58831cb..39ffa2151 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs @@ -1,24 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Simplification; +using Microsoft.VisualStudio.Threading; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Globalization; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Simplification; - using Microsoft.VisualStudio.Threading; - [ExportCodeFixProvider(LanguageNames.CSharp)] public class VSTHRD111UseConfigureAwaitCodeFix : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs index 2c2e02698..10e94f23d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.Editing; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Linq; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.Editing; - [ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic)] public class VSTHRD112ImplementSystemIAsyncDisposableCodeFix : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs index bae82295e..0acac449b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs @@ -1,17 +1,17 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.Editing; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.Editing; - using Microsoft.CodeAnalysis.Operations; - [ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic)] public class VSTHRD114AvoidReturningNullTaskCodeFix : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index 94958523d..edf65e2b6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -1,23 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeActions; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Rename; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Globalization; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeActions; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Rename; - [ExportCodeFixProvider(LanguageNames.CSharp)] public class VSTHRD200UseAsyncNamingConventionCodeFix : CodeFixProvider { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs index 17138ba2c..b436a54fe 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Linq; +using System.Threading; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Operations; +using Microsoft.CodeAnalysis.VisualBasic.Syntax; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Linq; - using System.Threading; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Operations; - using Microsoft.CodeAnalysis.VisualBasic.Syntax; - internal sealed class VisualBasicUtils : LanguageUtils { public static readonly VisualBasicUtils Instance = new VisualBasicUtils(); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 31657b1de..d6dd74522 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 82bd06be2..8e27f0212 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs index cfc02125c..1ee77539f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs index caaa7b6c5..496895f53 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 5411f047b..a473e94be 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs index 503dd9a11..f7b4e7e1c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 3326adbdf..2dacd0ab8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index 580f02186..b0cb3a249 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs index 51c161678..48c7c8020 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 54a69c690..888f98d1b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - public abstract class AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : DiagnosticAnalyzer { public const string Id = "VSTHRD001"; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 588ddc34e..7852e90c1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Detects invocations of JoinableTaskFactory.SwitchToMainThreadAsync that are not awaited. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs index 80a306daa..f7a631ac5 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Linq; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - public abstract class AbstractVSTHRD011UseAsyncLazyAnalyzer : DiagnosticAnalyzer { public const string Id = "VSTHRD011"; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs index 975e4a3ac..d45749590 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - public abstract class AbstractVSTHRD012SpecifyJtfWhereAllowed : DiagnosticAnalyzer { public const string Id = "VSTHRD012"; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 2fc5b0bf9..482247590 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Immutable; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Immutable; - using System.Linq; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Report errors when or /// overloads are invoked that do not accept an explicit . diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs index 5a28aa44a..28960e31f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Report warnings when methods that assert their thread affinity only do so under a condition, /// leaving its true thread requirements less discoverable to the caller. diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 6015138df..304cc92bd 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Report errors when async methods throw when not on the main thread instead of switching to it. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index cd8cde816..3cc7ca1cb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - /// /// Verifies that types that implement vs-threading's IAsyncDisposable interface also implement System.IAsyncDisposable. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs index ab092093c..f90d1a466 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Finds await expressions on that do not use . /// Also works on . diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index 93bb0c3a3..0b3c33b13 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -1,23 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.IO; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Text.RegularExpressions; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Text; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.IO; - using System.Linq; - using System.Runtime.CompilerServices; - using System.Text.RegularExpressions; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Text; - internal static class CommonInterest { internal static readonly Regex FileNamePatternForLegacyThreadSwitchingMembers = new Regex(@"^vs-threading\.LegacyThreadSwitchingMembers(\..*)?.txt$", FileNamePatternRegexOptions); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs index 6313692f2..9369534b5 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Concurrent; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Runtime.CompilerServices; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - /// /// A class for our analyzers that provide per-compilation caching by way of its private fields /// to support common utility methods. diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs index 7be617fde..b79661f29 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Threading; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Threading; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Operations; - internal abstract class LanguageUtils { internal abstract Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs index e946305ca..cea3ad84b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Generic; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Generic; - internal static class Namespaces { internal static readonly IReadOnlyList System = new[] diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs index 39c6401ef..d1ac3e588 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Generic; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Generic; - /// /// Identifiers used to identify various types so that we can avoid adding dependency only if absolutely needed. /// For each predefine value here, please update the unit test to detect if values go out of sync with the real types they represent. diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index 86f71f61d..876a47697 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Reflection; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Reflection; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - internal static class Utils { internal static Action DebuggableWrapper(Action handler) @@ -169,7 +169,7 @@ internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) /// For instance, if the symbol represents a property in a class, this method will return the type of that property. /// /// The input symbol. - /// The type represented by the input symbol; or null if could not figure out the type. + /// The type represented by the input symbol; or if could not figure out the type. internal static ITypeSymbol? ResolveTypeFromSymbol(ISymbol symbol) { ITypeSymbol? type = null; @@ -209,7 +209,7 @@ internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) /// /// The symbol whose namespace membership is being tested. /// A sequence of namespaces from global to most precise. For example: [System, Threading, Tasks]. - /// true if the symbol belongs to the given namespace; otherwise false. + /// if the symbol belongs to the given namespace; otherwise . internal static bool BelongsToNamespace(this ISymbol symbol, IReadOnlyList namespaces) { if (namespaces is null) @@ -278,7 +278,7 @@ internal static ISymbol GetContainingFunction(IOperation operation, ISymbol oper /// Determines whether a type could be used with the async modifier as a method return type. /// /// The type returned from a method. - /// true if the type can be returned from an async method. + /// if the type can be returned from an async method. /// /// This is not the same thing as being an *awaitable* type, which is a much lower bar. Any type can be made awaitable by offering a GetAwaiter method /// that follows the proper pattern. But being an async-compatible type in this sense is a type that can be returned from a method carrying the async keyword modifier, @@ -358,10 +358,10 @@ internal static bool IsXAtLeastAsPublicAsY(ISymbol x, ISymbol y) /// /// The symbol to be tested. /// - /// true if the symbol is a public type or member, + /// if the symbol is a public type or member, /// or a protected member inside a public type, /// or an explicit interface implementation of a public interface; - /// otherwise false. + /// otherwise . /// internal static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) { @@ -656,7 +656,7 @@ from symbol in offering.GetMembers() /// Determines whether a given parameter accepts a . /// /// The parameter. - /// true if the parameter takes a ; false otherwise. + /// if the parameter takes a ; otherwise. internal static bool IsCancellationTokenParameter(IParameterSymbol parameterSymbol) => parameterSymbol?.Type.Name == nameof(CancellationToken) && parameterSymbol.Type.BelongsToNamespace(Namespaces.SystemThreading); internal static ISymbol? GetUnderlyingSymbol(IOperation? operation) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs index 0e7f5886b..cc7cf1001 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Detects the Async Void methods which are NOT used as asynchronous event handlers. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs index 119298e74..54c94c135 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Analyzes the async lambdas and checks if they are being used as void-returning delegate types. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs index 3a0d9cb0b..0abce5f62 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Diagnostics; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Diagnostics; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Analyzes the usages on AsyncEventHandler delegates and reports warning if /// they are invoked NOT using the extension method TplExtensions.InvokeAsync() diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs index 70849d7f4..e7de58379 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Collections.Immutable; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System.Collections.Immutable; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Finds await expressions on that do not use . /// Also works on . diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs index 9bc3167a9..72d0b0a04 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Reflection.Emit; +using System.Text; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Reflection.Emit; - using System.Text; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Operations; - /// /// Verifies that code that performs type checks for vs-threading's IAsyncDisposable interface also check for System.IAsyncDisposable. /// diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index ab3ee2be8..c0b83d33e 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Immutable; +using System.Linq; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Collections.Immutable; - using System.Linq; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] public class VSTHRD200UseAsyncNamingConventionAnalyzer : DiagnosticAnalyzer { diff --git a/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs index c9ff97d16..c7f618f67 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// An asynchronous implementation of an AutoResetEvent. /// @@ -56,8 +56,8 @@ public AsyncAutoResetEvent() /// /// /// A value indicating whether to complete the task synchronously in the method, - /// as opposed to asynchronously. false better simulates the behavior of the - /// class, but true can result in slightly better performance. + /// as opposed to asynchronously. better simulates the behavior of the + /// class, but can result in slightly better performance. /// public AsyncAutoResetEvent(bool allowInliningAwaiters) { @@ -168,7 +168,7 @@ private class WaiterCompletionSource : TaskCompletionSourceWithoutInlining class. /// /// The event that is initializing this value. - /// true to allow continuations to be inlined upon the completer's callstack. + /// to allow continuations to be inlined upon the completer's callstack. /// The cancellation token associated with the waiter. internal WaiterCompletionSource(AsyncAutoResetEvent owner, bool allowInliningContinuations, CancellationToken cancellationToken) : base(allowInliningContinuations) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs b/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs index b95b76d88..0246654f7 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Concurrent; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// An asynchronous barrier that blocks the signaler until all other participants have signaled. /// diff --git a/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs index cf13fb540..a57edbcee 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.ComponentModel; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// An asynchronous style countdown event. /// diff --git a/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs b/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs index 161127814..cb65a246c 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - /// /// An asynchronous event handler. /// diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs index 22e4d0232..3e145b39c 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Threading; - using System.Threading.Tasks; - /// /// Lazily executes a delegate that has some side effect (typically initializing something) /// such that the delegate runs at most once. diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index f70753d69..63c38ff52 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Diagnostics; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Diagnostics; - using System.Threading; - using System.Threading.Tasks; - /// /// A thread-safe, lazily and asynchronously evaluated value factory. /// diff --git a/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs index 41e3ad186..57531b5ec 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Diagnostics; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.ComponentModel; - using System.Diagnostics; - using System.Linq; - using System.Runtime.CompilerServices; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// A flavor of that can be asynchronously awaited on. /// @@ -59,8 +59,8 @@ public class AsyncManualResetEvent /// /// A value indicating whether to allow callers' continuations to execute /// on the thread that calls before the call returns. - /// callers should not hold private locks if this value is true to avoid deadlocks. - /// When false, the task returned from may not have fully transitioned to + /// callers should not hold private locks if this value is to avoid deadlocks. + /// When , the task returned from may not have fully transitioned to /// its completed state by the time returns to its caller. /// public AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) @@ -114,7 +114,7 @@ public Task WaitAsync() /// /// /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated (so may return false for a bit more if called immediately). + /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). /// The returned task completes when the signal has definitely been set. /// /// @@ -180,7 +180,7 @@ public void Reset() /// /// /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated (so may return false for a bit more if called immediately). + /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). /// The returned task completes when the signal has definitely been set. /// /// diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs index e28cf4d07..d9ab19093 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs @@ -1,17 +1,17 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// A thread-safe, asynchronously dequeuable queue. /// @@ -168,7 +168,7 @@ public void Enqueue(T value) /// Adds an element to the tail of the queue if it has not yet completed. /// /// The value to add. - /// true if the value was added to the queue; false if the queue is already completed. + /// if the value was added to the queue; if the queue is already completed. public bool TryEnqueue(T value) { bool alreadyDispatched = false; @@ -212,7 +212,7 @@ public bool TryEnqueue(T value) /// Gets the value at the head of the queue without removing it from the queue, if it is non-empty. /// /// Receives the value at the head of the queue; or the default value for the element type if the queue is empty. - /// true if the queue was non-empty; false otherwise. + /// if the queue was non-empty; otherwise. public bool TryPeek([MaybeNullWhen(false)] out T value) { lock (this.SyncRoot) @@ -308,7 +308,7 @@ public T Peek() /// otherwise returns without an element. /// /// Receives the element from the head of the queue; or default(T) if the queue is empty. - /// true if an element was dequeued; false if the queue was empty. + /// if an element was dequeued; if the queue was empty. public bool TryDequeue([MaybeNullWhen(false)] out T value) { #pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. @@ -339,7 +339,7 @@ public T[] ToArray() /// /// The test on the head element that must succeed to dequeue. /// Receives the element from the head of the queue; or default(T) if the queue is empty. - /// true if an element was dequeued; false if the queue was empty. + /// if an element was dequeued; if the queue was empty. protected bool TryDequeue(Predicate valueCheck, [MaybeNullWhen(false)] out T value) { Requires.NotNull(valueCheck, nameof(valueCheck)); @@ -356,8 +356,8 @@ protected bool TryDequeue(Predicate valueCheck, [MaybeNullWhen(false)] out T /// /// The enqueued value. /// - /// true if the item will skip the queue because a dequeuer was already waiting for an item; - /// false if the item was actually added to the queue. + /// if the item will skip the queue because a dequeuer was already waiting for an item; + /// if the item was actually added to the queue. /// protected virtual void OnEnqueued(T value, bool alreadyDispatched) { @@ -384,7 +384,7 @@ protected virtual void OnCompleted() /// /// The test on the head element that must succeed to dequeue. /// Receives the element from the head of the queue; or default(T) if the queue is empty. - /// true if an element was dequeued; false if the queue was empty. + /// if an element was dequeued; if the queue was empty. private bool TryDequeueInternal(Predicate? valueCheck, [MaybeNullWhen(false)] out T value) { bool dequeued; diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs index 6b92a1248..cbed5dad5 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs @@ -1,17 +1,17 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using System.Xml.Linq; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Globalization; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using System.Xml.Linq; - public partial class AsyncReaderWriterLock : IHangReportContributor { [Flags] diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index 5e2ac64df..d5fa4c8ec 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Globalization; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Globalization; - using System.Linq; - using System.Runtime.CompilerServices; - using System.Threading; - using System.Threading.Tasks; - /// /// A non-blocking lock that allows concurrent access, exclusive access, or concurrent with upgradeability to exclusive access. /// @@ -166,7 +166,7 @@ public AsyncReaderWriterLock() /// Initializes a new instance of the class. /// /// - /// true to spend additional resources capturing diagnostic details that can be used + /// to spend additional resources capturing diagnostic details that can be used /// to analyze deadlocks or other issues. public AsyncReaderWriterLock(bool captureDiagnostics) : this(joinableTaskContext: null, captureDiagnostics) @@ -180,7 +180,7 @@ public AsyncReaderWriterLock(bool captureDiagnostics) /// A JoinableTaskContext to help resolve deadlocks caused by interdependency between top read lock tasks when there is a pending write lock blocking one of them. /// /// - /// true to spend additional resources capturing diagnostic details that can be used + /// to spend additional resources capturing diagnostic details that can be used /// to analyze deadlocks or other issues. public AsyncReaderWriterLock(JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) { @@ -263,7 +263,7 @@ public bool IsAnyPassiveLockHeld /// Gets a value indicating whether the caller holds a read lock. /// /// - /// This property returns false if any other lock type is held, unless + /// This property returns if any other lock type is held, unless /// within that alternate lock type this lock is also nested. /// public bool IsReadLockHeld @@ -276,7 +276,7 @@ public bool IsReadLockHeld /// to the lock compatibility of the caller's context. /// /// - /// This property returns false if any other lock type is held, unless + /// This property returns if any other lock type is held, unless /// within that alternate lock type this lock is also nested. /// public bool IsPassiveReadLockHeld @@ -288,7 +288,7 @@ public bool IsPassiveReadLockHeld /// Gets a value indicating whether the caller holds an upgradeable read lock. /// /// - /// This property returns false if any other lock type is held, unless + /// This property returns if any other lock type is held, unless /// within that alternate lock type this lock is also nested. /// public bool IsUpgradeableReadLockHeld @@ -301,7 +301,7 @@ public bool IsUpgradeableReadLockHeld /// to the lock compatibility of the caller's context. /// /// - /// This property returns false if any other lock type is held, unless + /// This property returns if any other lock type is held, unless /// within that alternate lock type this lock is also nested. /// public bool IsPassiveUpgradeableReadLockHeld @@ -313,7 +313,7 @@ public bool IsPassiveUpgradeableReadLockHeld /// Gets a value indicating whether the caller holds a write lock. /// /// - /// This property returns false if any other lock type is held, unless + /// This property returns if any other lock type is held, unless /// within that alternate lock type this lock is also nested. /// public bool IsWriteLockHeld @@ -326,7 +326,7 @@ public bool IsWriteLockHeld /// to the lock compatibility of the caller's context. /// /// - /// This property returns false if any other lock type is held, unless + /// This property returns if any other lock type is held, unless /// within that alternate lock type this lock is also nested. /// public bool IsPassiveWriteLockHeld @@ -381,9 +381,9 @@ protected bool CaptureDiagnostics /// hold an active lock. /// /// - /// The default implementation of this property returns true + /// The default implementation of this property returns /// when the calling thread is NOT an STA thread. - /// This property may be overridden to return false + /// This property may be overridden to return /// on threads that may compromise the integrity of the lock. /// protected virtual bool CanCurrentThreadHoldActiveLock @@ -547,7 +547,7 @@ public void Dispose() /// /// Disposes managed and unmanaged resources held by this instance. /// - /// true if was called; false if the object is being finalized. + /// if was called; if the object is being finalized. protected virtual void Dispose(bool disposing) { if (disposing) @@ -567,9 +567,9 @@ protected virtual void Dispose(bool disposing) /// /// Checks whether the aggregated flags from all locks in the lock stack satisfy the specified flag(s). /// - /// The flag(s) that must be specified for a true result. + /// The flag(s) that must be specified for a result. /// The head of the lock stack to consider. - /// true if all the specified flags are found somewhere in the lock stack; false otherwise. + /// if all the specified flags are found somewhere in the lock stack; otherwise. protected bool LockStackContains(LockFlags flags, LockHandle handle) { LockFlags aggregateFlags = LockFlags.None; @@ -631,7 +631,7 @@ protected LockFlags GetAggregateLockFlags() /// /// Fired when any lock is being released. /// - /// true if the last write lock that the caller holds is being released; false otherwise. + /// if the last write lock that the caller holds is being released; otherwise. /// The lock being released. /// A task whose completion signals the conclusion of the asynchronous operation. protected virtual Task OnBeforeLockReleasedAsync(bool exclusiveLockRelease, LockHandle releasingLock) @@ -895,7 +895,7 @@ private void AggregateLockStackKinds(Awaiter? awaiter, out bool read, out bool u /// Gets a value indicating whether all issued locks are merely the top-level lock or nesting locks of the specified lock. /// /// The most nested lock. - /// true if all issued locks are the specified lock or nesting locks of it. + /// if all issued locks are the specified lock or nesting locks of it. private bool AllHeldLocksAreByThisStack(Awaiter? awaiter) { Assumes.True(awaiter is null || !this.IsLockHeld(LockKind.Write, awaiter)); // this method doesn't yet handle sticky upgraded read locks (that appear in the write lock set). @@ -928,7 +928,7 @@ private bool AllHeldLocksAreByThisStack(Awaiter? awaiter) /// /// The kind of lock being queried for. /// The (possibly nested) lock. - /// true if the lock holder (also) holds the specified kind of lock. + /// if the lock holder (also) holds the specified kind of lock. private bool LockStackContains(LockKind kind, Awaiter? awaiter) { if (awaiter is object) @@ -963,7 +963,7 @@ private bool LockStackContains(LockKind kind, Awaiter? awaiter) /// which has actually be upgraded. /// /// The lock to test. - /// true if the test succeeds; false otherwise. + /// if the test succeeds; otherwise. private bool IsStickyWriteUpgradedLock(Awaiter awaiter) { if (awaiter.Kind == LockKind.UpgradeableRead && (awaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite) @@ -979,13 +979,13 @@ private bool IsStickyWriteUpgradedLock(Awaiter awaiter) /// /// Checks whether the caller's held locks (or the specified lock stack) includes an active lock of the specified type. - /// Always false when called on an STA thread. + /// Always when called on an STA thread. /// /// The type of lock to check for. /// The most nested lock of the caller, or null to look up the caller's lock in the CallContext. - /// true to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. - /// true to return true when a lock is held but unusable because of the context of the caller. - /// true if the caller holds active locks of the given type; false otherwise. + /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. + /// to return true when a lock is held but unusable because of the context of the caller. + /// if the caller holds active locks of the given type; otherwise. private bool IsLockHeld(LockKind kind, Awaiter? awaiter = null, bool checkSyncContextCompatibility = true, bool allowNonLockSupportingContext = false) { if (allowNonLockSupportingContext || this.IsLockSupportingContext(awaiter)) @@ -1007,12 +1007,12 @@ private bool IsLockHeld(LockKind kind, Awaiter? awaiter = null, bool checkSyncCo /// /// Checks whether a given lock is active. - /// Always false when called on an STA thread. + /// Always when called on an STA thread. /// /// The lock to check. - /// if false the return value will always be false if called on an STA thread. - /// true to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. - /// true if the lock is currently issued and the caller is not on an STA thread. + /// if the return value will always be if called on an STA thread. + /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. + /// if the lock is currently issued and the caller is not on an STA thread. private bool IsLockActive(Awaiter awaiter, bool considerStaActive, bool checkSyncContextCompatibility = false) { Requires.NotNull(awaiter, nameof(awaiter)); @@ -1054,7 +1054,7 @@ private void CheckSynchronizationContextAppropriateForLock(Awaiter? awaiter) /// /// The awaiter to issue a lock to. /// - /// A value indicating whether this lock was previously queued. false if this is a new just received request. + /// A value indicating whether this lock was previously queued. if this is a new just received request. /// The value is used to determine whether to reject it if has already been called and this /// is a new top-level request. /// @@ -1187,7 +1187,7 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi /// to the top-level lock request held by the given lock holder. /// /// The awaiter to start the search down the stack from. - /// The least nested upgradeable reader lock with sticky write flag; or null if none was found. + /// The least nested upgradeable reader lock with sticky write flag; or if none was found. private Awaiter? FindRootUpgradeableReadWithStickyWrite(Awaiter? headAwaiter) { if (headAwaiter is null) @@ -1259,7 +1259,7 @@ private Queue GetLockQueue(LockKind kind) /// Walks the nested lock stack until it finds an active one. /// /// The most nested lock to consider. May be null. - /// The first active lock encountered, or null if none. + /// The first active lock encountered, or if none. private Awaiter? GetFirstActiveSelfOrAncestor(Awaiter? awaiter) { while (awaiter is object) @@ -1295,7 +1295,7 @@ private void IssueAndExecute(Awaiter awaiter) /// /// A task that should complete before the releasing thread accesses any resource protected by /// a lock wrapping the lock being released. - /// The task will always be complete if is true. + /// The task will always be complete if is . /// This method guarantees that the lock is effectively released from the caller, and the /// can be safely recycled, before the synchronous portion of this method completes. /// @@ -1521,7 +1521,7 @@ private bool HasAnyNestedLocks(Awaiter lck) /// /// The awaiter being released. /// A flag indicating whether the lock being released was an upgraded read lock with the sticky write flag set. - /// true to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. private void OnReleaseReenterConcurrencyComplete(Awaiter awaiter, bool upgradedStickyWrite, bool searchAllWaiters) { Requires.NotNull(awaiter, nameof(awaiter)); @@ -1544,8 +1544,8 @@ private void OnReleaseReenterConcurrencyComplete(Awaiter awaiter, bool upgradedS /// Issues locks to one or more queued lock requests and executes their continuations /// based on lock availability and policy-based prioritization (writer-friendly, etc.) /// - /// true to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. - /// true if any locks were issued; false otherwise. + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// if any locks were issued; otherwise. private bool TryInvokeLockConsumer(bool searchAllWaiters) { return this.TryInvokeOneWriterIfAppropriate(searchAllWaiters) @@ -1630,7 +1630,7 @@ private void ApplyLockToCallContext(Awaiter? topAwaiter) /// /// Issues locks to all queued reader lock requests if there are no issued write locks. /// - /// true to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. /// A value indicating whether any readers were issued locks. private bool TryInvokeAllReadersIfAppropriate(bool searchAllWaiters) { @@ -1690,7 +1690,7 @@ private void TryInvokeAllDependentReadersIfAppropriate() /// /// Issues a lock to the next queued upgradeable reader, if no upgradeable read or write locks are currently issued. /// - /// true to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. /// A value indicating whether any upgradeable readers were issued locks. private bool TryInvokeOneUpgradeableReaderIfAppropriate(bool searchAllWaiters) { @@ -1719,7 +1719,7 @@ private bool TryInvokeOneUpgradeableReaderIfAppropriate(bool searchAllWaiters) /// Issues a lock to the next queued writer, if no other locks are currently issued /// or the last contending read lock was removed allowing a waiting upgradeable reader to upgrade. /// - /// true to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. /// A value indicating whether a writer was issued a lock. private bool TryInvokeOneWriterIfAppropriate(bool searchAllWaiters) { @@ -1753,8 +1753,8 @@ private bool TryInvokeOneWriterIfAppropriate(bool searchAllWaiters) /// Scans a lock awaiter queue for any that can be issued locks now. /// /// The queue to scan. - /// true to break out immediately after issuing the first lock. - /// true if any lock was issued; false otherwise. + /// to break out immediately after issuing the first lock. + /// if any lock was issued; otherwise. private bool TryInvokeAnyWaitersInQueue(Queue waiters, bool breakOnFirstIssue) { Requires.NotNull(waiters, nameof(waiters)); @@ -1886,7 +1886,7 @@ public readonly struct Awaitable /// The type of lock being requested. /// Any flags applied to the lock request. /// The cancellation token. - /// true to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. + /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. internal Awaitable(AsyncReaderWriterLock lck, LockKind kind, LockFlags options, CancellationToken cancellationToken, bool checkSyncContextCompatibility = true) { if (checkSyncContextCompatibility) @@ -2259,7 +2259,7 @@ public class Awaiter : ICriticalNotifyCompletion /// /// /// This field is initialized only when is constructed with - /// the captureDiagnostics parameter set to true. + /// the captureDiagnostics parameter set to . /// private StackTrace? requestingStackTrace; @@ -2398,7 +2398,7 @@ internal bool IsReleased /// /// Gets a value indicating whether the lock is active. /// - /// true iff the lock has bee issued, has not yet been released, and the caller is on an MTA thread. + /// iff the lock has bee issued, has not yet been released, and the caller is on an MTA thread. private bool LockIssued { get { return this.lck.IsLockActive(this, considerStaActive: false); } @@ -2510,7 +2510,7 @@ internal Task ReleaseAsync(bool lockConsumerCanceled = false) /// /// Executes the code that requires the lock. /// - /// true if the continuation was (asynchronously) invoked; false if there was no continuation available to invoke. + /// if the continuation was (asynchronously) invoked; if there was no continuation available to invoke. internal bool TryScheduleContinuationExecution() { Action? continuation = Interlocked.Exchange(ref this.continuation, null); diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs index f25fffe9f..f216e4a8c 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs @@ -1,17 +1,17 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Runtime.CompilerServices; - using System.Threading; - using System.Threading.Tasks; - /// /// A non-blocking lock that allows concurrent access, exclusive access, or concurrent with upgradeability to exclusive access, /// making special allowances for resources that must be prepared for concurrent or exclusive access. @@ -38,7 +38,7 @@ protected AsyncReaderWriterResourceLock() /// Initializes a new instance of the class. /// /// - /// true to spend additional resources capturing diagnostic details that can be used + /// to spend additional resources capturing diagnostic details that can be used /// to analyze deadlocks or other issues. protected AsyncReaderWriterResourceLock(bool captureDiagnostics) : base(captureDiagnostics) @@ -53,7 +53,7 @@ protected AsyncReaderWriterResourceLock(bool captureDiagnostics) /// A JoinableTaskContext to help resolve dead locks caused by interdependency between top read lock tasks when there is a pending write lock blocking one of them. /// /// - /// true to spend additional resources capturing diagnostic details that can be used + /// to spend additional resources capturing diagnostic details that can be used /// to analyze deadlocks or other issues. protected AsyncReaderWriterResourceLock(JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) : base(joinableTaskContext, captureDiagnostics) @@ -188,9 +188,9 @@ protected void SetResourceAsAccessed(TResource resource) /// Marks any loaded resources as having been retrieved under a lock if they /// satisfy some predicate. /// - /// A function that returns true if the provided resource should be considered retrieved. + /// A function that returns if the provided resource should be considered retrieved. /// The state object to pass as a second parameter to . - /// true if the delegate returned true on any of the invocations. + /// if the delegate returned on any of the invocations. protected bool SetResourceAsAccessed(Func resourceCheck, object? state) { return this.helper.SetResourceAsAccessed(resourceCheck, state); @@ -610,9 +610,9 @@ internal void SetResourceAsAccessed(TResource resource) /// Marks any loaded resources as having been retrieved under a lock if they /// satisfy some predicate. /// - /// A function that returns true if the provided resource should be considered retrieved. + /// A function that returns if the provided resource should be considered retrieved. /// The state object to pass as a second parameter to . - /// true if the delegate returned true on any of the invocations. + /// if the delegate returned on any of the invocations. internal bool SetResourceAsAccessed(Func resourceCheck, object? state) { Requires.NotNull(resourceCheck, nameof(resourceCheck)); diff --git a/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs b/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs index 19d5ecd24..80aa1917e 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Threading; - using System.Threading.Tasks; - /// /// An asynchronous like class with more convenient release syntax. /// @@ -184,7 +184,7 @@ public void Dispose() /// /// Disposes managed and unmanaged resources held by this instance. /// - /// true if was called; false if the object is being finalized. + /// if was called; if the object is being finalized. protected virtual void Dispose(bool disposing) { if (disposing) diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index 1abfadb68..ae7df0916 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -1,23 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Diagnostics; +using System.Runtime.CompilerServices; +using System.Runtime.ExceptionServices; +using System.Runtime.InteropServices; +using System.Threading; +using System.Threading.Tasks; +using global::Windows.Win32; +using global::Windows.Win32.Foundation; +using global::Windows.Win32.System.Registry; +using Microsoft.Win32; +using Microsoft.Win32.SafeHandles; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.ComponentModel; - using System.Diagnostics; - using System.Runtime.CompilerServices; - using System.Runtime.ExceptionServices; - using System.Runtime.InteropServices; - using System.Threading; - using System.Threading.Tasks; - using global::Windows.Win32; - using global::Windows.Win32.Foundation; - using global::Windows.Win32.System.Registry; - using Microsoft.Win32; - using Microsoft.Win32.SafeHandles; - /// /// Extension methods and awaitables for .NET 4.5. /// @@ -117,7 +117,7 @@ public static TaskAwaiter GetAwaiter(this WaitHandle handle) /// Returns a Task that completes when the specified registry key changes. /// /// The registry key to watch for changes. - /// true to watch the keys descendent keys as well; false to watch only this key without descendents. + /// to watch the keys descendent keys as well; to watch only this key without descendents. /// Indicates the kinds of changes to watch for. /// A token that may be canceled to release the resources from watching for changes and complete the returned Task as canceled. /// @@ -198,7 +198,7 @@ public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInli /// Returns a Task that completes when the specified registry key changes. /// /// The handle to the open registry key to watch for changes. - /// true to watch the keys descendent keys as well; false to watch only this key without descendents. + /// to watch the keys descendent keys as well; to watch only this key without descendents. /// Indicates the kinds of changes to watch for. /// A token that may be canceled to release the resources from watching for changes and complete the returned Task as canceled. /// @@ -397,7 +397,7 @@ public TaskSchedulerAwaiter(TaskScheduler scheduler, bool alwaysYield = false) /// /// Gets a value indicating whether no yield is necessary. /// - /// true if the caller is already running on that TaskScheduler. + /// if the caller is already running on that TaskScheduler. public bool IsCompleted { get diff --git a/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs b/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs index 399292ee8..cec11643a 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Threading; - using System.Threading.Tasks; - /// /// Represents a possible shared computation task, which can be joined by multiple consumers with a cancellation token. /// The overall computation is cancelled if all its consumers are cancelled. diff --git a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs index 4e88e32c7..2045d65e5 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Threading; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Threading; - /// /// Extensions to . /// @@ -170,7 +170,7 @@ public CombinedCancellationToken(CancellationToken cancellationToken) /// /// The left operand. /// The right operand. - /// true if they are equal; false otherwise. + /// if they are equal; otherwise. public static bool operator ==(CombinedCancellationToken left, CombinedCancellationToken right) => left.Equals(right); /// @@ -178,7 +178,7 @@ public CombinedCancellationToken(CancellationToken cancellationToken) /// /// The left operand. /// The right operand. - /// true if they are not equal; false if they are equal. + /// if they are not equal; if they are equal. public static bool operator !=(CombinedCancellationToken left, CombinedCancellationToken right) => !(left == right); /// diff --git a/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs index d6a6d1df6..20645e8e0 100644 --- a/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// A JoinableTaskFactory base class for derived types that delegate some of their work to an existing instance. /// @@ -73,7 +73,7 @@ protected internal override void OnTransitioningToMainThread(JoinableTask joinab /// The task whose request to transition to the main thread has completed. /// A value indicating whether the transition was cancelled before it was fulfilled. /// - /// This event is usually raised on the main thread, but can be on another thread when is true. + /// This event is usually raised on the main thread, but can be on another thread when is . /// protected internal override void OnTransitionedToMainThread(JoinableTask joinableTask, bool canceled) { diff --git a/src/Microsoft.VisualStudio.Threading/Dgml.cs b/src/Microsoft.VisualStudio.Threading/Dgml.cs index 13a0f5631..ee9688dd8 100644 --- a/src/Microsoft.VisualStudio.Threading/Dgml.cs +++ b/src/Microsoft.VisualStudio.Threading/Dgml.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Xml.Linq; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using System.Xml.Linq; - internal static class Dgml { /// diff --git a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs index f4c800201..87bfc2fcf 100644 --- a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs @@ -3,12 +3,12 @@ #if NETFRAMEWORK || WINDOWS +using System; +using System.Threading; +using System.Windows.Threading; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Threading; - using System.Windows.Threading; - /// /// Extension methods for the WPF for better /// interop with the . @@ -24,7 +24,7 @@ public static class DispatcherExtensions /// /// The priority with which to schedule any work on the UI thread, /// when and if is called - /// and for each asynchronous return to the main thread after an await. + /// and for each asynchronous return to the main thread after an . /// /// A that may be used for scheduling async work with the specified priority. public static JoinableTaskFactory WithPriority(this JoinableTaskFactory joinableTaskFactory, Dispatcher dispatcher, DispatcherPriority priority) diff --git a/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs b/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs index 56b6b6d37..bc0c6ba39 100644 --- a/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs +++ b/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - /// /// Enumerates either a single element or a list of elements. /// diff --git a/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs b/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs index b81741c72..a05e3a029 100644 --- a/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs +++ b/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.IO; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - /// /// A contribution to an aggregate hang report. /// @@ -60,7 +60,7 @@ public HangReportContribution(string content, string? contentType, string? conte /// /// Gets the nested hang reports, if any. /// - /// A read only collection, or null. + /// A read only collection, or . public IReadOnlyCollection? NestedReports { get; private set; } } } diff --git a/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs b/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs index fd46e11a9..22e3a08b9 100644 --- a/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs +++ b/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System.Threading.Tasks; - /// /// Defines an asynchronous method to release allocated resources. /// diff --git a/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs index 84dafa670..116e450fa 100644 --- a/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - /// /// Provides a facility to produce reports that may be useful when analyzing hangs. /// diff --git a/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs b/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs index 36ae12b6c..e92cc638a 100644 --- a/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs +++ b/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Globalization; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Globalization; - /// /// Exception which is thrown when the contract of a is violated. /// diff --git a/src/Microsoft.VisualStudio.Threading/InlineResumable.cs b/src/Microsoft.VisualStudio.Threading/InlineResumable.cs index 299fdff0f..4abd5bc56 100644 --- a/src/Microsoft.VisualStudio.Threading/InlineResumable.cs +++ b/src/Microsoft.VisualStudio.Threading/InlineResumable.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Runtime.CompilerServices; +using System.Threading; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Runtime.CompilerServices; - using System.Threading; - /// /// An awaiter that can be pre-created, and later immediately execute its one scheduled continuation. /// @@ -30,7 +30,7 @@ internal class InlineResumable : ICriticalNotifyCompletion /// /// Gets a value indicating whether an awaiting expression should yield. /// - /// Always false. + /// Always . public bool IsCompleted => this.resumed; /// diff --git a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs index 624dce9d3..fd0327068 100644 --- a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs +++ b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs @@ -1,17 +1,17 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections; +using System.Collections.Generic; +using System.Globalization; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections; - using System.Collections.Generic; - using System.Globalization; - using System.Linq; - using System.Reflection; - using System.Runtime.CompilerServices; - using System.Threading.Tasks; - /// /// Internal helper/extension methods for this assembly's own use. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs index 8c3c2b045..59791eecf 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; - public partial class JoinableTask { /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs index 17e8dfe37..776f67679 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - public partial class JoinableTask { /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index c4a65e764..3d19dfd4d 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -1,21 +1,21 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using JoinRelease = Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease; +using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Reflection; - using System.Runtime.CompilerServices; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using JoinRelease = Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease; - using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; - /// /// Tracks asynchronous operations and provides the ability to Join those operations to avoid /// deadlocks while synchronously blocking the Main thread for the operation's completion. @@ -68,7 +68,7 @@ public partial class JoinableTask : IJoinableTaskDependent /// had given us a Task. /// /// - /// This is null until after returns a (or the property is observed), + /// This is until after returns a (or the property is observed), /// and retains its value even after this JoinableTask completes. /// [DebuggerBrowsable(DebuggerBrowsableState.Never)] diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs index 1436b65d4..88204887e 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Threading; - using System.Threading.Tasks; - /// /// A collection of incomplete objects. /// @@ -45,9 +45,9 @@ public class JoinableTaskCollection : IJoinableTaskDependent, IEnumerable /// The instance to which this collection applies. /// - /// true if JoinableTask instances added to the collection multiple times should remain in the collection until they are + /// if JoinableTask instances added to the collection multiple times should remain in the collection until they are /// either removed the same number of times or until they are completed; - /// false causes the first Remove call for a JoinableTask to remove it from this collection regardless + /// causes the first Remove call for a JoinableTask to remove it from this collection regardless /// how many times it had been added. public JoinableTaskCollection(JoinableTaskContext context, bool refCountAddedJobs = false) { diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs index 44950c073..42ba5e1e3 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Xml.Linq; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Globalization; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using System.Xml.Linq; - public partial class JoinableTaskContext : IHangReportContributor { /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 9bb339133..0d4bc67de 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -1,21 +1,21 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Collections.Specialized; +using System.Diagnostics; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; +using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Concurrent; - using System.Collections.Generic; - using System.Collections.Specialized; - using System.Diagnostics; - using System.Linq; - using System.Reflection; - using System.Runtime.CompilerServices; - using System.Threading; - using System.Threading.Tasks; - using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; - using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; - /// /// A common context within which joinable tasks may be created and interact to avoid deadlocks. /// @@ -585,7 +585,7 @@ protected internal virtual JoinableTaskFactory CreateDefaultFactory() /// /// Disposes managed and unmanaged resources held by this instance. /// - /// true if was called; false if the object is being finalized. + /// if was called; if the object is being finalized. protected virtual void Dispose(bool disposing) { } @@ -699,7 +699,7 @@ public HangDetails(TimeSpan hangDuration, int notificationCount, Guid hangId, Me private class HangNotificationRegistration : IDisposable { /// - /// The node to receive notifications. May be null if has already been called. + /// The node to receive notifications. May be if has already been called. /// private JoinableTaskContextNode? node; diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs index 760ed13ae..4f33333ed 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; + namespace Microsoft.VisualStudio.Threading { - using System; - /// /// An exception thrown when the configuration provided to the /// are incorrect or a virtual method is overridden such that it violates a contract. diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs index 3fd24ef7e..0b5c67721 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// A customizable source of instances. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs index ed78281ea..7bc1784f6 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; + namespace Microsoft.VisualStudio.Threading { - using System; - /// /// Specifies flags that control optional behavior for the creation and execution of tasks. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs index 0c05f8b33..e4ae34b07 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Linq; +using System.Threading; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Linq; - using System.Threading; - /// /// Methods to maintain dependencies between . /// Those methods are expected to be called by or only to maintain relationship between them, and should not be called directly by other code. diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 7d6848100..41c97163d 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -1,23 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Globalization; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Security; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Globalization; - using System.Linq; - using System.Reflection; - using System.Runtime.CompilerServices; - using System.Security; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; - /// /// A factory for starting asynchronous tasks that can mitigate deadlocks /// when the tasks require the Main thread of an application and the Main @@ -36,7 +36,7 @@ public partial class JoinableTaskFactory private readonly SynchronizationContext mainThreadJobSyncContext; /// - /// The collection to add all created tasks to. May be null. + /// The collection to add all created tasks to. May be . /// private readonly JoinableTaskCollection? jobCollection; @@ -500,7 +500,7 @@ protected internal virtual void OnTransitioningToMainThread(JoinableTask joinabl /// The task whose request to transition to the main thread has completed. /// A value indicating whether the transition was cancelled before it was fulfilled. /// - /// This event is usually raised on the main thread, but can be on another thread when is true. + /// This event is usually raised on the main thread, but can be on another thread when is . /// protected internal virtual void OnTransitionedToMainThread(JoinableTask joinableTask, bool canceled) { @@ -1085,7 +1085,7 @@ internal class SingleExecuteProtector private bool raiseTransitionComplete; /// - /// The delegate to invoke. null if it has already been invoked. + /// The delegate to invoke. if it has already been invoked. /// /// May be of type or . private object? invokeDelegate; diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs index 1786f0fe1..03577d2c5 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskInternals.cs @@ -1,11 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading; - using System; using System.ComponentModel; +namespace Microsoft.VisualStudio.Threading; #pragma warning disable RS0016 // Add public types and members to the declared API #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index 27697ef70..caa99dba3 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Linq; - using System.Reflection; - using System.Runtime.CompilerServices; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// Tracks asynchronous operations and provides the ability to Join those operations to avoid /// deadlocks while synchronously blocking the Main thread for the operation's completion. diff --git a/src/Microsoft.VisualStudio.Threading/LightUps.cs b/src/Microsoft.VisualStudio.Threading/LightUps.cs index e893b868c..7baa9d766 100644 --- a/src/Microsoft.VisualStudio.Threading/LightUps.cs +++ b/src/Microsoft.VisualStudio.Threading/LightUps.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; + namespace Microsoft.VisualStudio.Threading { - using System; - /// /// A non-generic class used to store statics that do not vary by generic type argument. /// diff --git a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs index 361568c45..e3a9c7edb 100644 --- a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs +++ b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Linq; - using System.Text; - using System.Threading; - using System.Threading.Tasks; - /// /// A thread-safe collection optimized for very small number of non-null elements. /// @@ -87,7 +87,7 @@ public void Remove(T value) /// Checks for reference equality between the specified value and an element of this collection. /// /// The value to check for. - /// true if a match is found; false otherwise. + /// if a match is found; otherwise. /// /// This method is intended to hide the Linq Contains extension method to avoid /// the boxing of this struct and its Enumerator. diff --git a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs index 045e1c3a8..d8065eeb0 100644 --- a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Buffers; +using System.Runtime.InteropServices; +using System.Threading; +using global::Windows.Win32; +using global::Windows.Win32.Foundation; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Buffers; - using System.Runtime.InteropServices; - using System.Threading; - using global::Windows.Win32; - using global::Windows.Win32.Foundation; - /// /// A SynchronizationContext whose synchronously blocking Wait method does not allow /// any reentrancy via the message pump. diff --git a/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs index 6c9bc6905..25f67b916 100644 --- a/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Diagnostics.CodeAnalysis; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Diagnostics.CodeAnalysis; - using System.Threading; - using System.Threading.Tasks; - /// /// A that executes messages in the order they are received. /// @@ -47,7 +47,7 @@ public sealed class NonConcurrentSynchronizationContext : SynchronizationContext /// /// A value indicating whether to set this instance as when invoking delegates. /// This has the effect that async methods that are invoked on this - /// will execute their continuations on this as well unless they use with false as the argument. + /// will execute their continuations on this as well unless they use with as the argument. /// public NonConcurrentSynchronizationContext(bool sticky) { diff --git a/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs b/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs index 60e989559..49444128d 100644 --- a/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs +++ b/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; + namespace Microsoft.VisualStudio.Threading { - using System; - internal static class NullableHelpers { /// diff --git a/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs b/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs index 59cb291aa..0e57ccb76 100644 --- a/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs +++ b/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Threading; - using System.Threading.Tasks; - /// /// An incremental progress reporting mechanism that also allows /// asynchronous awaiting for all reports to be processed. diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index ac539d0e6..36da42afb 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - /// /// A collection optimized for usually small number of elements, and items are rarely removed. /// Note: this implementation is not thread-safe. It must be protected to prevent race conditions. diff --git a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs index b40831b1c..949faeb43 100644 --- a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs @@ -1,17 +1,17 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; +using System.Globalization; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Globalization; - using System.Runtime.CompilerServices; - using System.Threading; - using System.Threading.Tasks; - /// /// A -aware semaphore that allows reentrancy without consuming another slot in the semaphore. /// @@ -194,7 +194,7 @@ public void Dispose() /// /// Disposes managed and unmanaged resources held by this instance. /// - /// true if was called; false if the object is being finalized. + /// if was called; if the object is being finalized. protected virtual void Dispose(bool disposing) { if (disposing) diff --git a/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs b/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs index 5e69648d0..ab03d816c 100644 --- a/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs +++ b/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using global::Windows.Win32.System.Registry; + namespace Microsoft.VisualStudio.Threading { - using System; - using global::Windows.Win32.System.Registry; - /// /// The various types of data within a registry key that generate notifications /// when changed. diff --git a/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs b/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs index a2cc45cfe..3d399f3b8 100644 --- a/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs +++ b/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.Diagnostics.CodeAnalysis; + namespace System.Diagnostics { - using System.Diagnostics.CodeAnalysis; - internal static class RoslynDebug { /// diff --git a/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs b/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs index 5ce11edfd..f7ddd5b06 100644 --- a/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs +++ b/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; + namespace Microsoft.VisualStudio.Threading { - using System; - /// /// Exception thrown when a is in a faulted state. /// diff --git a/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs index 5bb78eacb..5e5d06fc7 100644 --- a/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Reflection; +using System.Threading; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Reflection; - using System.Threading; - /// /// A single-threaded synchronization context, akin to the DispatcherSynchronizationContext /// and WindowsFormsSynchronizationContext. diff --git a/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs b/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs index 2e1a5b05b..5810883ef 100644 --- a/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Threading; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Threading; - /// /// A structure that applies and reverts changes to the . /// diff --git a/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs b/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs index 58fce31e4..0e95f8675 100644 --- a/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs +++ b/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Diagnostics.CodeAnalysis; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Diagnostics.CodeAnalysis; - using System.Threading; - using System.Threading.Tasks; - /// /// A -derivative that /// does not inline continuations if so configured. @@ -24,7 +24,7 @@ internal class TaskCompletionSourceWithoutInlining : TaskCompletionSource /// Initializes a new instance of the class. /// /// - /// true to allow continuations to be inlined; otherwise false. + /// to allow continuations to be inlined; otherwise . /// /// /// TaskCreationOptions to pass on to the base constructor. @@ -52,7 +52,7 @@ internal TaskCompletionSourceWithoutInlining(bool allowInliningContinuations, Ta /// if wanted by the caller and supported by the platform. /// /// The base options supplied by the caller. - /// true to allow inlining continuations. + /// to allow inlining continuations. /// The possibly modified flags. private static TaskCreationOptions AdjustFlags(TaskCreationOptions options, bool allowInliningContinuations) { diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs index 721743247..365ad37c3 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Diagnostics.Tracing; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Diagnostics.Tracing; - /// /// The ETW source for logging events for this library. /// diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs index 23c0b8bb5..54f78c094 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Threading; - using System.Threading.Tasks; - /// /// Utility methods for working across threads. /// @@ -25,8 +25,8 @@ internal interface ICancellationNotification /// The field that may be manipulated by multiple threads. /// A function that receives the unchanged value and returns the changed value. /// - /// true if the location's value is changed by applying the result of the function; - /// false if the location's value remained the same because the last invocation of returned the existing value. + /// if the location's value is changed by applying the result of the function; + /// if the location's value remained the same because the last invocation of returned the existing value. /// public static bool ApplyChangeOptimistically(ref T hotLocation, Func applyChange) where T : class? @@ -67,8 +67,8 @@ public static bool ApplyChangeOptimistically(ref T hotLocation, Func ap /// An argument to pass to . /// A function that receives both the unchanged value and , then returns the changed value. /// - /// true if the location's value is changed by applying the result of the function; - /// false if the location's value remained the same because the last invocation of returned the existing value. + /// if the location's value is changed by applying the result of the function; + /// if the location's value remained the same because the last invocation of returned the existing value. /// public static bool ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, Func applyChange) where T : class? diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index 7aebd9ea8..ba9b03b32 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -1,15 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Security; +using System.Threading; +using System.Threading.Tasks; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Runtime.CompilerServices; - using System.Security; - using System.Threading; - using System.Threading.Tasks; - /// /// Extensions to the Task Parallel Library. /// @@ -28,12 +28,12 @@ public static partial class TplExtensions public static readonly Task CanceledTask = Task.FromCanceled(new CancellationToken(canceled: true)); /// - /// A completed task with a true result. + /// A completed task with a result. /// public static readonly Task TrueTask = Task.FromResult(true); /// - /// A completed task with a false result. + /// A completed task with a result. /// public static readonly Task FalseTask = Task.FromResult(false); @@ -195,7 +195,7 @@ public static Task AttachToParent(this Task task) /// The type of value returned by the task. /// The task whose result should be returned by the following task. /// A token whose cancellation signals that the following task should be cancelled. - /// The TaskCompletionSource whose task is to follow. Leave at null for a new task to be created. + /// The TaskCompletionSource whose task is to follow. Leave at for a new task to be created. /// The following task. public static Task FollowCancelableTaskToCompletion(Func> taskToFollow, CancellationToken ultimateCancellation, TaskCompletionSource? taskThatFollows = null) { @@ -234,7 +234,7 @@ public static Task FollowCancelableTaskToCompletion(Func> taskToFo /// faults or is canceled. /// /// The task whose completion should signal the completion of the returned awaitable. - /// if set to true the continuation will be scheduled on the caller's context; false to always execute the continuation on the threadpool. + /// if set to the continuation will be scheduled on the caller's context; to always execute the continuation on the threadpool. /// An awaitable. public static NoThrowTaskAwaitable NoThrowAwaitable(this Task task, bool captureContext = true) { @@ -268,7 +268,7 @@ public static void Forget(this Task? task) /// Invokes asynchronous event handlers, returning a task that completes when all event handlers have been invoked. /// Each handler is fully executed (including continuations) before the next handler in the list is invoked. /// - /// The event handlers. May be null. + /// The event handlers. May be . /// The event source. /// The event argument. /// The task that completes when all handlers have completed. @@ -308,7 +308,7 @@ public static async Task InvokeAsync(this AsyncEventHandler? handlers, object? s /// Each handler is fully executed (including continuations) before the next handler in the list is invoked. /// /// The type of argument passed to each handler. - /// The event handlers. May be null. + /// The event handlers. May be . /// The event source. /// The event argument. /// The task that completes when all handlers have completed. The task is faulted if any handlers throw an exception. @@ -427,15 +427,15 @@ public static Task ToApm(this Task task, AsyncCallback? callback, object? state) } /// - /// Creates a TPL Task that returns true when a is signaled or returns false if a timeout occurs first. + /// Creates a TPL Task that returns when a is signaled or returns if a timeout occurs first. /// /// The handle whose signal triggers the task to be completed. Do not use a here. - /// The timeout (in milliseconds) after which the task will return false if the handle is not signaled by that time. + /// The timeout (in milliseconds) after which the task will return if the handle is not signaled by that time. /// A token whose cancellation will cause the returned Task to immediately complete in a canceled state. /// /// A Task that completes when the handle is signaled or times out, or when the caller's cancellation token is canceled. - /// If the task completes because the handle is signaled, the task's result is true. - /// If the task completes because the handle is not signaled prior to the timeout, the task's result is false. + /// If the task completes because the handle is signaled, the task's result is . + /// If the task completes because the handle is not signaled prior to the timeout, the task's result is . /// /// /// The completion of the returned task is asynchronous with respect to the code that actually signals the wait handle. @@ -519,8 +519,8 @@ public static Task ToApm(this Task task, AsyncCallback? callback, object? state) /// The task whose completion should be applied to another. /// The task that should receive the completion status. /// - /// true to complete the supplied as efficiently as possible (inline with the completion of ); - /// false to complete the asynchronously. + /// to complete the supplied as efficiently as possible (inline with the completion of ); + /// to complete the asynchronously. /// Note if is completed when this method is invoked, then is always completed synchronously. /// internal static void ApplyResultTo(this Task task, TaskCompletionSource tcs, bool inlineSubsequentCompletion) @@ -720,7 +720,7 @@ public NoThrowTaskAwaiter GetAwaiter() /// Initializes a new instance of the struct. /// /// The task. - /// if set to true [capture context]. + /// if set to [capture context]. public NoThrowTaskAwaiter(Task task, bool captureContext) { Requires.NotNull(task, nameof(task)); diff --git a/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs b/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs index 985af29da..23f6423f3 100644 --- a/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs +++ b/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; + namespace Microsoft.VisualStudio.Threading { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - /// /// Dictionary that does not prevent keys from being garbage collected. /// @@ -40,7 +40,7 @@ internal class WeakKeyDictionary : IEnumerable /// Initializes a new instance of the class. /// - /// The key comparer to use. A null value indicates the default comparer will be used. + /// The key comparer to use. A value indicates the default comparer will be used. /// The initial capacity of the dictionary. Growth beyond this capacity will first induce a scavenge operation. public WeakKeyDictionary(IEqualityComparer? keyComparer = null, int capacity = 10) { diff --git a/src/SosThreadingTools/Commands.cs b/src/SosThreadingTools/Commands.cs index aa58b03d6..ada6f7b6b 100644 --- a/src/SosThreadingTools/Commands.cs +++ b/src/SosThreadingTools/Commands.cs @@ -1,12 +1,12 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Runtime.InteropServices; + namespace CpsDbg { - using System; - using System.Collections.Generic; - using System.Runtime.InteropServices; - internal static class Commands { private const string DumpAsyncCommand = "dumpasync"; diff --git a/src/SosThreadingTools/DebuggerContext.cs b/src/SosThreadingTools/DebuggerContext.cs index 9ee7d4834..4189f06f0 100644 --- a/src/SosThreadingTools/DebuggerContext.cs +++ b/src/SosThreadingTools/DebuggerContext.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Diagnostics; +using System.Globalization; +using System.IO; +using System.Linq; +using System.Reflection; +using System.Runtime.InteropServices; +using Microsoft.Diagnostics.Runtime; +using Microsoft.Diagnostics.Runtime.Interop; + namespace CpsDbg { - using System; - using System.Diagnostics; - using System.Globalization; - using System.IO; - using System.Linq; - using System.Reflection; - using System.Runtime.InteropServices; - using Microsoft.Diagnostics.Runtime; - using Microsoft.Diagnostics.Runtime.Interop; - internal class DebuggerContext { private const string ClrMD = "Microsoft.Diagnostics.Runtime"; diff --git a/src/SosThreadingTools/DebuggerOutput.cs b/src/SosThreadingTools/DebuggerOutput.cs index 68794dfe1..d97f26dec 100644 --- a/src/SosThreadingTools/DebuggerOutput.cs +++ b/src/SosThreadingTools/DebuggerOutput.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.Diagnostics.Runtime.Interop; + namespace CpsDbg { - using Microsoft.Diagnostics.Runtime.Interop; - internal class DebuggerOutput { private IDebugClient client; diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index 54fd89721..c82f24f04 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -1,14 +1,14 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using Microsoft.Diagnostics.Runtime; +using Microsoft.Diagnostics.Runtime.Interop; + namespace CpsDbg { - using System; - using System.Collections.Generic; - using System.Linq; - using Microsoft.Diagnostics.Runtime; - using Microsoft.Diagnostics.Runtime.Interop; - internal class DumpAsyncCommand : ICommandHandler { public void Execute(DebuggerContext context, string args) diff --git a/src/SosThreadingTools/ExtensionContext.cs b/src/SosThreadingTools/ExtensionContext.cs index bf9edc793..aa71a30a8 100644 --- a/src/SosThreadingTools/ExtensionContext.cs +++ b/src/SosThreadingTools/ExtensionContext.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.IO; +using System.Reflection; +using System.Runtime.InteropServices; + namespace CpsDbg { - using System; - using System.IO; - using System.Reflection; - using System.Runtime.InteropServices; - internal static class ExtensionContext { [DllExport(nameof(DebugExtensionInitialize), CallingConvention.StdCall)] diff --git a/src/SosThreadingTools/Utilities.cs b/src/SosThreadingTools/Utilities.cs index 3771b1006..e4bdcc2b7 100644 --- a/src/SosThreadingTools/Utilities.cs +++ b/src/SosThreadingTools/Utilities.cs @@ -1,13 +1,13 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Collections.Generic; +using System.Linq; +using Microsoft.Diagnostics.Runtime; + namespace CpsDbg { - using System; - using System.Collections.Generic; - using System.Linq; - using Microsoft.Diagnostics.Runtime; - internal static class Utilities { internal static ClrObject TryGetObjectField(this ClrObject clrObject, string fieldName) diff --git a/test/IsolatedTestHost/Program.cs b/test/IsolatedTestHost/Program.cs index 2ff062818..bcabc8a3c 100644 --- a/test/IsolatedTestHost/Program.cs +++ b/test/IsolatedTestHost/Program.cs @@ -1,16 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.IO; +using System.Linq; +using System.Reflection; +using System.Threading; +using System.Threading.Tasks; +using Xunit; + namespace IsolatedTestHost { - using System; - using System.IO; - using System.Linq; - using System.Reflection; - using System.Threading; - using System.Threading.Tasks; - using Xunit; - internal static class Program { private static int Main(string[] args) diff --git a/test/IsolatedTestHost/TestOutputHelper.cs b/test/IsolatedTestHost/TestOutputHelper.cs index b8f3331a3..1bdf3c17d 100644 --- a/test/IsolatedTestHost/TestOutputHelper.cs +++ b/test/IsolatedTestHost/TestOutputHelper.cs @@ -1,11 +1,11 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using Xunit.Abstractions; + namespace IsolatedTestHost { - using System; - using Xunit.Abstractions; - internal class TestOutputHelper : ITestOutputHelper { public void WriteLine(string message) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs index 1a43fe9d9..219effcd1 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs @@ -1,93 +1,92 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System; - using System.Collections.Immutable; - using System.IO; - using System.Linq; - using System.Reflection; - using System.Runtime.CompilerServices; - using System.Threading.Tasks; +using System; +using System.Collections.Immutable; +using System.IO; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Threading.Tasks; #if WINDOWS - using System.Windows.Threading; +using System.Windows.Threading; #endif - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Testing; - using Microsoft.CodeAnalysis.Testing.Verifiers; - using Microsoft.CodeAnalysis.Text; - using Xunit; - using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Testing; +using Microsoft.CodeAnalysis.Testing.Verifiers; +using Microsoft.CodeAnalysis.Text; +using Xunit; +using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public static partial class CSharpCodeFixVerifier +public static partial class CSharpCodeFixVerifier +{ + public class Test : CSharpCodeFixTest { - public class Test : CSharpCodeFixTest + public Test() { - public Test() + this.ReferenceAssemblies = ReferencesHelper.DefaultReferences; + + this.SolutionTransforms.Add((solution, projectId) => { - this.ReferenceAssemblies = ReferencesHelper.DefaultReferences; + Project project = solution.GetProject(projectId)!; - this.SolutionTransforms.Add((solution, projectId) => + if (this.IncludeMicrosoftVisualStudioThreading) { - Project project = solution.GetProject(projectId)!; - - if (this.IncludeMicrosoftVisualStudioThreading) - { - project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(JoinableTaskFactory).Assembly.Location)); - } + project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(JoinableTaskFactory).Assembly.Location)); + } - if (this.IncludeWindowsBase) - { + if (this.IncludeWindowsBase) + { #if WINDOWS - project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(Dispatcher).Assembly.Location)); + project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(Dispatcher).Assembly.Location)); #else - Skip.If(true); + Skip.If(true); #endif - } + } - if (this.IncludeVisualStudioSdk) - { - project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(IOleServiceProvider).Assembly.Location)); + if (this.IncludeVisualStudioSdk) + { + project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(IOleServiceProvider).Assembly.Location)); - var nugetPackagesFolder = Environment.CurrentDirectory; - foreach (var reference in ReferencesHelper.VSSDKPackageReferences) - { - project = project.AddMetadataReference(MetadataReference.CreateFromFile(Path.Combine(nugetPackagesFolder, reference))); - } + var nugetPackagesFolder = Environment.CurrentDirectory; + foreach (var reference in ReferencesHelper.VSSDKPackageReferences) + { + project = project.AddMetadataReference(MetadataReference.CreateFromFile(Path.Combine(nugetPackagesFolder, reference))); } + } - return project.Solution; - }); + return project.Solution; + }); - this.TestState.AdditionalFilesFactories.Add(() => - { - const string additionalFilePrefix = "AdditionalFiles."; - return from resourceName in Assembly.GetExecutingAssembly().GetManifestResourceNames() - where resourceName.StartsWith(additionalFilePrefix, StringComparison.Ordinal) - let content = ReadManifestResource(Assembly.GetExecutingAssembly(), resourceName) - select (filename: resourceName.Substring(additionalFilePrefix.Length), SourceText.From(content)); - }); - } + this.TestState.AdditionalFilesFactories.Add(() => + { + const string additionalFilePrefix = "AdditionalFiles."; + return from resourceName in Assembly.GetExecutingAssembly().GetManifestResourceNames() + where resourceName.StartsWith(additionalFilePrefix, StringComparison.Ordinal) + let content = ReadManifestResource(Assembly.GetExecutingAssembly(), resourceName) + select (filename: resourceName.Substring(additionalFilePrefix.Length), SourceText.From(content)); + }); + } - public bool IncludeMicrosoftVisualStudioThreading { get; set; } = true; + public bool IncludeMicrosoftVisualStudioThreading { get; set; } = true; - public bool IncludeWindowsBase { get; set; } + public bool IncludeWindowsBase { get; set; } - public bool IncludeVisualStudioSdk { get; set; } = true; + public bool IncludeVisualStudioSdk { get; set; } = true; - protected override ParseOptions CreateParseOptions() - { - return ((CSharpParseOptions)base.CreateParseOptions()).WithLanguageVersion(LanguageVersion.CSharp8); - } + protected override ParseOptions CreateParseOptions() + { + return ((CSharpParseOptions)base.CreateParseOptions()).WithLanguageVersion(LanguageVersion.CSharp8); + } - private static string ReadManifestResource(Assembly assembly, string resourceName) + private static string ReadManifestResource(Assembly assembly, string resourceName) + { + using (var reader = new StreamReader(assembly.GetManifestResourceStream(resourceName) ?? throw Assumes.Fail("Resource not found."))) { - using (var reader = new StreamReader(assembly.GetManifestResourceStream(resourceName) ?? throw Assumes.Fail("Resource not found."))) - { - return reader.ReadToEnd(); - } + return reader.ReadToEnd(); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs index 714844fb8..91cc3de5f 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs @@ -1,52 +1,51 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.CSharp.Testing; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Testing; +using Microsoft.CodeAnalysis.Testing.Verifiers; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public static partial class CSharpCodeFixVerifier + where TAnalyzer : DiagnosticAnalyzer, new() + where TCodeFix : CodeFixProvider, new() { - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.CSharp.Testing; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Testing; - using Microsoft.CodeAnalysis.Testing.Verifiers; - - public static partial class CSharpCodeFixVerifier - where TAnalyzer : DiagnosticAnalyzer, new() - where TCodeFix : CodeFixProvider, new() - { - public static DiagnosticResult Diagnostic() - => CSharpCodeFixVerifier.Diagnostic(); + public static DiagnosticResult Diagnostic() + => CSharpCodeFixVerifier.Diagnostic(); - public static DiagnosticResult Diagnostic(string diagnosticId) - => CSharpCodeFixVerifier.Diagnostic(diagnosticId); + public static DiagnosticResult Diagnostic(string diagnosticId) + => CSharpCodeFixVerifier.Diagnostic(diagnosticId); - public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) - => new DiagnosticResult(descriptor); + public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) + => new DiagnosticResult(descriptor); - public static Task VerifyAnalyzerAsync(string source, params DiagnosticResult[] expected) - { - var test = new Test { TestCode = source }; - test.ExpectedDiagnostics.AddRange(expected); - return test.RunAsync(); - } + public static Task VerifyAnalyzerAsync(string source, params DiagnosticResult[] expected) + { + var test = new Test { TestCode = source }; + test.ExpectedDiagnostics.AddRange(expected); + return test.RunAsync(); + } - public static Task VerifyCodeFixAsync(string source, string fixedSource) - => VerifyCodeFixAsync(source, DiagnosticResult.EmptyDiagnosticResults, fixedSource); + public static Task VerifyCodeFixAsync(string source, string fixedSource) + => VerifyCodeFixAsync(source, DiagnosticResult.EmptyDiagnosticResults, fixedSource); - public static Task VerifyCodeFixAsync(string source, DiagnosticResult expected, string fixedSource) - => VerifyCodeFixAsync(source, new[] { expected }, fixedSource); + public static Task VerifyCodeFixAsync(string source, DiagnosticResult expected, string fixedSource) + => VerifyCodeFixAsync(source, new[] { expected }, fixedSource); - public static Task VerifyCodeFixAsync(string source, DiagnosticResult[] expected, string fixedSource) + public static Task VerifyCodeFixAsync(string source, DiagnosticResult[] expected, string fixedSource) + { + var test = new Test { - var test = new Test - { - TestCode = source, - FixedCode = fixedSource, - }; - - test.ExpectedDiagnostics.AddRange(expected); - return test.RunAsync(); - } + TestCode = source, + FixedCode = fixedSource, + }; + + test.ExpectedDiagnostics.AddRange(expected); + return test.RunAsync(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 273459b81..2943dfbbe 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -1,39 +1,38 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Collections.Immutable; - using System.Net; - using Microsoft.CodeAnalysis.Testing; +using System.Collections.Immutable; +using System.Net; +using Microsoft.CodeAnalysis.Testing; - internal static class ReferencesHelper - { +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +internal static class ReferencesHelper +{ #if NETFRAMEWORK - public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetFramework.Net471.Default + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetFramework.Net471.Default #elif NETCOREAPP3_1 - public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetCore.NetCoreApp31 + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetCore.NetCoreApp31 #elif NET6_0 - public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net60 + public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net60 #else #error Fix TFM conditions #endif - .WithPackages(ImmutableArray.Create( - new PackageIdentity("System.Collections.Immutable", "5.0.0"), - new PackageIdentity("System.Threading.Tasks.Extensions", "4.5.4"), - new PackageIdentity("Microsoft.Bcl.AsyncInterfaces", "6.0.0"))); + .WithPackages(ImmutableArray.Create( + new PackageIdentity("System.Collections.Immutable", "5.0.0"), + new PackageIdentity("System.Threading.Tasks.Extensions", "4.5.4"), + new PackageIdentity("Microsoft.Bcl.AsyncInterfaces", "6.0.0"))); - internal static readonly ImmutableArray VSSDKPackageReferences = ImmutableArray.Create(new string[] - { - "Microsoft.VisualStudio.Shell.Framework.dll", - "Microsoft.VisualStudio.Shell.15.0.dll", - }); + internal static readonly ImmutableArray VSSDKPackageReferences = ImmutableArray.Create(new string[] + { + "Microsoft.VisualStudio.Shell.Framework.dll", + "Microsoft.VisualStudio.Shell.15.0.dll", + }); - static ReferencesHelper() - { + static ReferencesHelper() + { #pragma warning disable RS0030 // Do not used banned APIs - ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; + ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; #pragma warning restore RS0030 // Do not used banned APIs - } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs index e9cbfd48c..976fe1c2a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs @@ -1,91 +1,90 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System; - using System.Collections.Immutable; - using System.IO; - using System.Linq; - using System.Reflection; +using System; +using System.Collections.Immutable; +using System.IO; +using System.Linq; +using System.Reflection; #if WINDOWS - using System.Windows.Threading; +using System.Windows.Threading; #endif - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Testing.Verifiers; - using Microsoft.CodeAnalysis.Text; - using Microsoft.CodeAnalysis.VisualBasic; - using Microsoft.CodeAnalysis.VisualBasic.Testing; - using Xunit; - using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Testing.Verifiers; +using Microsoft.CodeAnalysis.Text; +using Microsoft.CodeAnalysis.VisualBasic; +using Microsoft.CodeAnalysis.VisualBasic.Testing; +using Xunit; +using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public static partial class VisualBasicCodeFixVerifier +public static partial class VisualBasicCodeFixVerifier +{ + public class Test : VisualBasicCodeFixTest { - public class Test : VisualBasicCodeFixTest + public Test() { - public Test() + this.ReferenceAssemblies = ReferencesHelper.DefaultReferences; + + this.SolutionTransforms.Add((solution, projectId) => { - this.ReferenceAssemblies = ReferencesHelper.DefaultReferences; + Project? project = solution.GetProject(projectId) ?? throw new ArgumentException("Not found.", nameof(projectId)); - this.SolutionTransforms.Add((solution, projectId) => + if (this.IncludeMicrosoftVisualStudioThreading) { - Project? project = solution.GetProject(projectId) ?? throw new ArgumentException("Not found.", nameof(projectId)); - - if (this.IncludeMicrosoftVisualStudioThreading) - { - project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(JoinableTaskFactory).Assembly.Location)); - } + project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(JoinableTaskFactory).Assembly.Location)); + } - if (this.IncludeWindowsBase) - { + if (this.IncludeWindowsBase) + { #if WINDOWS - project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(Dispatcher).Assembly.Location)); + project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(Dispatcher).Assembly.Location)); #else - Skip.If(true); + Skip.If(true); #endif - } + } - if (this.IncludeVisualStudioSdk) - { - project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(IOleServiceProvider).Assembly.Location)); + if (this.IncludeVisualStudioSdk) + { + project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(IOleServiceProvider).Assembly.Location)); - var nugetPackagesFolder = Environment.CurrentDirectory; - foreach (var reference in ReferencesHelper.VSSDKPackageReferences) - { - project = project.AddMetadataReference(MetadataReference.CreateFromFile(Path.Combine(nugetPackagesFolder, reference))); - } + var nugetPackagesFolder = Environment.CurrentDirectory; + foreach (var reference in ReferencesHelper.VSSDKPackageReferences) + { + project = project.AddMetadataReference(MetadataReference.CreateFromFile(Path.Combine(nugetPackagesFolder, reference))); } + } - return project.Solution; - }); + return project.Solution; + }); - this.TestState.AdditionalFilesFactories.Add(() => - { - const string additionalFilePrefix = "AdditionalFiles."; - return from resourceName in Assembly.GetExecutingAssembly().GetManifestResourceNames() - where resourceName.StartsWith(additionalFilePrefix, StringComparison.Ordinal) - let content = ReadManifestResource(Assembly.GetExecutingAssembly(), resourceName) - select (filename: resourceName.Substring(additionalFilePrefix.Length), SourceText.From(content)); - }); - } + this.TestState.AdditionalFilesFactories.Add(() => + { + const string additionalFilePrefix = "AdditionalFiles."; + return from resourceName in Assembly.GetExecutingAssembly().GetManifestResourceNames() + where resourceName.StartsWith(additionalFilePrefix, StringComparison.Ordinal) + let content = ReadManifestResource(Assembly.GetExecutingAssembly(), resourceName) + select (filename: resourceName.Substring(additionalFilePrefix.Length), SourceText.From(content)); + }); + } - public bool IncludeMicrosoftVisualStudioThreading { get; set; } = true; + public bool IncludeMicrosoftVisualStudioThreading { get; set; } = true; - public bool IncludeWindowsBase { get; set; } + public bool IncludeWindowsBase { get; set; } - public bool IncludeVisualStudioSdk { get; set; } = true; + public bool IncludeVisualStudioSdk { get; set; } = true; - protected override ParseOptions CreateParseOptions() - { - return ((VisualBasicParseOptions)base.CreateParseOptions()).WithLanguageVersion(LanguageVersion.VisualBasic15_5); - } + protected override ParseOptions CreateParseOptions() + { + return ((VisualBasicParseOptions)base.CreateParseOptions()).WithLanguageVersion(LanguageVersion.VisualBasic15_5); + } - private static string ReadManifestResource(Assembly assembly, string resourceName) + private static string ReadManifestResource(Assembly assembly, string resourceName) + { + using (var reader = new StreamReader(assembly.GetManifestResourceStream(resourceName) ?? throw Assumes.Fail("Resource not found."))) { - using (var reader = new StreamReader(assembly.GetManifestResourceStream(resourceName) ?? throw Assumes.Fail("Resource not found."))) - { - return reader.ReadToEnd(); - } + return reader.ReadToEnd(); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs index b01d6a801..377473909 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs @@ -1,52 +1,51 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CodeFixes; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Testing; +using Microsoft.CodeAnalysis.Testing.Verifiers; +using Microsoft.CodeAnalysis.VisualBasic.Testing; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public static partial class VisualBasicCodeFixVerifier + where TAnalyzer : DiagnosticAnalyzer, new() + where TCodeFix : CodeFixProvider, new() { - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CodeFixes; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Testing; - using Microsoft.CodeAnalysis.Testing.Verifiers; - using Microsoft.CodeAnalysis.VisualBasic.Testing; - - public static partial class VisualBasicCodeFixVerifier - where TAnalyzer : DiagnosticAnalyzer, new() - where TCodeFix : CodeFixProvider, new() - { - public static DiagnosticResult Diagnostic() - => VisualBasicCodeFixVerifier.Diagnostic(); + public static DiagnosticResult Diagnostic() + => VisualBasicCodeFixVerifier.Diagnostic(); - public static DiagnosticResult Diagnostic(string diagnosticId) - => VisualBasicCodeFixVerifier.Diagnostic(diagnosticId); + public static DiagnosticResult Diagnostic(string diagnosticId) + => VisualBasicCodeFixVerifier.Diagnostic(diagnosticId); - public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) - => new DiagnosticResult(descriptor); + public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) + => new DiagnosticResult(descriptor); - public static Task VerifyAnalyzerAsync(string source, params DiagnosticResult[] expected) - { - var test = new Test { TestCode = source }; - test.ExpectedDiagnostics.AddRange(expected); - return test.RunAsync(); - } + public static Task VerifyAnalyzerAsync(string source, params DiagnosticResult[] expected) + { + var test = new Test { TestCode = source }; + test.ExpectedDiagnostics.AddRange(expected); + return test.RunAsync(); + } - public static Task VerifyCodeFixAsync(string source, string fixedSource) - => VerifyCodeFixAsync(source, DiagnosticResult.EmptyDiagnosticResults, fixedSource); + public static Task VerifyCodeFixAsync(string source, string fixedSource) + => VerifyCodeFixAsync(source, DiagnosticResult.EmptyDiagnosticResults, fixedSource); - public static Task VerifyCodeFixAsync(string source, DiagnosticResult expected, string fixedSource) - => VerifyCodeFixAsync(source, new[] { expected }, fixedSource); + public static Task VerifyCodeFixAsync(string source, DiagnosticResult expected, string fixedSource) + => VerifyCodeFixAsync(source, new[] { expected }, fixedSource); - public static Task VerifyCodeFixAsync(string source, DiagnosticResult[] expected, string fixedSource) + public static Task VerifyCodeFixAsync(string source, DiagnosticResult[] expected, string fixedSource) + { + var test = new Test { - var test = new Test - { - TestCode = source, - FixedCode = fixedSource, - }; - - test.ExpectedDiagnostics.AddRange(expected); - return test.RunAsync(); - } + TestCode = source, + FixedCode = fixedSource, + }; + + test.ExpectedDiagnostics.AddRange(expected); + return test.RunAsync(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs index a6d3a7873..19438d321 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs @@ -1,25 +1,25 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.MultiAnalyzerTests.Verifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class MultiAnalyzerTests { - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = MultiAnalyzerTests.Verifier; - - public class MultiAnalyzerTests + [Fact] + public async Task JustOneDiagnosticPerLine() { - [Fact] - public async Task JustOneDiagnosticPerLine() - { - var test = @" + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -42,39 +42,39 @@ static void SetTaskSourceIfCompleted(Task task, TaskCompletionSource tc } }"; - DiagnosticResult[] expected = - { - Verify.Diagnostic(VSTHRD103UseAsyncOptionAnalyzer.DescriptorNoAlternativeMethod).WithSpan(10, 24, 10, 33).WithArguments("GetResult"), - Verify.Diagnostic(VSTHRD103UseAsyncOptionAnalyzer.Descriptor).WithSpan(11, 13, 11, 16).WithArguments("Run", "RunAsync"), - Verify.Diagnostic(VSTHRD002UseJtfRunAnalyzer.Descriptor).WithSpan(19, 32, 19, 38), - }; + DiagnosticResult[] expected = + { + CSVerify.Diagnostic(VSTHRD103UseAsyncOptionAnalyzer.DescriptorNoAlternativeMethod).WithSpan(10, 24, 10, 33).WithArguments("GetResult"), + CSVerify.Diagnostic(VSTHRD103UseAsyncOptionAnalyzer.Descriptor).WithSpan(11, 13, 11, 16).WithArguments("Run", "RunAsync"), + CSVerify.Diagnostic(VSTHRD002UseJtfRunAnalyzer.Descriptor).WithSpan(19, 32, 19, 38), + }; - // All expected diagnostics should include a location - Assert.All(expected, item => Assert.True(item.HasLocation)); + // All expected diagnostics should include a location + Assert.All(expected, item => Assert.True(item.HasLocation)); - // All diagnostics should fit on one line - Assert.All(expected, item => Assert.Equal(item.Spans[0].Span.EndLinePosition.Line, item.Spans[0].Span.StartLinePosition.Line)); + // All diagnostics should fit on one line + Assert.All(expected, item => Assert.Equal(item.Spans[0].Span.EndLinePosition.Line, item.Spans[0].Span.StartLinePosition.Line)); - // At most one diagnostic appears on any given line - Assert.Equal(expected.Length, expected.Select(d => d.Spans[0].Span.StartLinePosition.Line).Distinct().Count()); + // At most one diagnostic appears on any given line + Assert.Equal(expected.Length, expected.Select(d => d.Spans[0].Span.StartLinePosition.Line).Distinct().Count()); - var verifyTest = new Verify.Test - { - TestCode = test, - TestState = { MarkupHandling = MarkupMode.None }, - }; + var verifyTest = new CSVerify.Test + { + TestCode = test, + TestState = { MarkupHandling = MarkupMode.None }, + }; - verifyTest.ExpectedDiagnostics.AddRange(expected); - await verifyTest.RunAsync(); - } + verifyTest.ExpectedDiagnostics.AddRange(expected); + await verifyTest.RunAsync(); + } - /// - /// Verifies that no analyzer throws due to a missing interface member. - /// - [Fact] - public async Task MissingInterfaceImplementationMember() - { - var test = @" + /// + /// Verifies that no analyzer throws due to a missing interface member. + /// + [Fact] + public async Task MissingInterfaceImplementationMember() + { + var test = @" public interface A { void Foo(); } @@ -88,14 +88,14 @@ public Child() { } } "; - DiagnosticResult expected = Verify.CompilerError("CS0535").WithLocation(6, 23).WithArguments("Parent", "A.Foo()"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.CompilerError("CS0535").WithLocation(6, 23).WithArguments("Parent", "A.Foo()"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AnonymousTypeObjectCreationSyntax() - { - var test = @" + [Fact] + public async Task AnonymousTypeObjectCreationSyntax() + { + var test = @" using System; public class A { @@ -109,13 +109,13 @@ internal void C() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MissingTypeObjectCreationSyntax() - { - var test = @" + [Fact] + public async Task MissingTypeObjectCreationSyntax() + { + var test = @" using System; public class A { @@ -129,18 +129,18 @@ internal void C() { } "; - DiagnosticResult[] expected = - { - Verify.CompilerError("CS0246").WithLocation(6, 21).WithArguments("C"), - Verify.CompilerError("CS0246").WithLocation(10, 21).WithArguments("C"), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ManyMethodInvocationStyles() + DiagnosticResult[] expected = { - var test = @" + CSVerify.CompilerError("CS0246").WithLocation(6, 21).WithArguments("C"), + CSVerify.CompilerError("CS0246").WithLocation(10, 21).WithArguments("C"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ManyMethodInvocationStyles() + { + var test = @" using System; using System.Threading.Tasks; @@ -191,13 +191,13 @@ private void D() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task UseOf_XmlDocRefs_DoesNotProduceWarnings() - { - var test = @" + [Fact] + public async Task UseOf_XmlDocRefs_DoesNotProduceWarnings() + { + var test = @" using System; using System.Threading.Tasks; @@ -213,13 +213,13 @@ public void PublicFoo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task UseOf_nameof_DoesNotProduceWarnings() - { - var test = @" + [Fact] + public async Task UseOf_nameof_DoesNotProduceWarnings() + { + var test = @" using System; using System.Threading.Tasks; @@ -241,13 +241,13 @@ public void PublicFoo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task UseOf_Delegate_DoesNotProduceWarnings() - { - var test = @" + [Fact] + public async Task UseOf_Delegate_DoesNotProduceWarnings() + { + var test = @" using System; using System.Threading.Tasks; @@ -263,82 +263,81 @@ public void PublicFoo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - /// - /// Verifies that no reference to System.ValueTuple exists, - /// so we know the analyzers will work on VS2015. - /// - /// - /// We have to reference the assembly during compilation due to - /// https://github.com/dotnet/roslyn/issues/18629 - /// So this unit test guards that we don't accidentally require the assembly - /// at runtime. - /// - [Fact] - public void NoValueTupleReference() - { - System.Reflection.AssemblyName[]? refAssemblies = typeof(CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer) - .Assembly.GetReferencedAssemblies(); - Assert.DoesNotContain(refAssemblies, a => a.Name!.Equals("System.ValueTuple", StringComparison.OrdinalIgnoreCase)); - } + /// + /// Verifies that no reference to System.ValueTuple exists, + /// so we know the analyzers will work on VS2015. + /// + /// + /// We have to reference the assembly during compilation due to + /// https://github.com/dotnet/roslyn/issues/18629 + /// So this unit test guards that we don't accidentally require the assembly + /// at runtime. + /// + [Fact] + public void NoValueTupleReference() + { + System.Reflection.AssemblyName[]? refAssemblies = typeof(CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer) + .Assembly.GetReferencedAssemblies(); + Assert.DoesNotContain(refAssemblies, a => a.Name!.Equals("System.ValueTuple", StringComparison.OrdinalIgnoreCase)); + } - /// - /// Verifies that no reference to exists, - /// so we know the analyzers will work on .NET Framework versions that did not include it. - /// - /// - /// We reference the assembly during compilation for convenient use of nameof. - /// This unit test guards that we don't accidentally require the assembly - /// at runtime. - /// - [Fact] - public void NoValueTaskReference() - { - System.Reflection.AssemblyName[]? refAssemblies = typeof(CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer) - .Assembly.GetReferencedAssemblies(); - Assert.DoesNotContain(refAssemblies, a => a.Name!.Equals("System.Threading.Tasks.Extensions", StringComparison.OrdinalIgnoreCase)); - } + /// + /// Verifies that no reference to exists, + /// so we know the analyzers will work on .NET Framework versions that did not include it. + /// + /// + /// We reference the assembly during compilation for convenient use of nameof. + /// This unit test guards that we don't accidentally require the assembly + /// at runtime. + /// + [Fact] + public void NoValueTaskReference() + { + System.Reflection.AssemblyName[]? refAssemblies = typeof(CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer) + .Assembly.GetReferencedAssemblies(); + Assert.DoesNotContain(refAssemblies, a => a.Name!.Equals("System.Threading.Tasks.Extensions", StringComparison.OrdinalIgnoreCase)); + } - [Fact] - public async Task NameOfUsedInAttributeArgument() - { - var test = @" + [Fact] + public async Task NameOfUsedInAttributeArgument() + { + var test = @" [System.Diagnostics.DebuggerDisplay(""hi"", Name = nameof(System.Console))] class Foo { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - public static class Verifier - { - public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) - => new DiagnosticResult(descriptor); + public static class Verifier + { + public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) + => new DiagnosticResult(descriptor); - public static DiagnosticResult CompilerError(string errorIdentifier) - => new DiagnosticResult(errorIdentifier, DiagnosticSeverity.Error); + public static DiagnosticResult CompilerError(string errorIdentifier) + => new DiagnosticResult(errorIdentifier, DiagnosticSeverity.Error); - public static Task VerifyAnalyzerAsync(string source, params DiagnosticResult[] expected) + public static Task VerifyAnalyzerAsync(string source, params DiagnosticResult[] expected) + { + var test = new Test { - var test = new Test - { - TestCode = source, - }; + TestCode = source, + }; - test.ExpectedDiagnostics.AddRange(expected); - return test.RunAsync(); - } + test.ExpectedDiagnostics.AddRange(expected); + return test.RunAsync(); + } - public class Test : CSharpCodeFixVerifier.Test + public class Test : CSharpCodeFixVerifier.Test + { + protected override IEnumerable GetDiagnosticAnalyzers() { - protected override IEnumerable GetDiagnosticAnalyzers() - { - IEnumerable? analyzers = from type in typeof(VSTHRD002UseJtfRunAnalyzer).Assembly.GetTypes() - where type.GetCustomAttributes(typeof(DiagnosticAnalyzerAttribute), true).Any() - select (DiagnosticAnalyzer?)Activator.CreateInstance(type) ?? throw Assumes.Fail("Unable to instantiate the analyzer"); - return analyzers.ToImmutableArray(); - } + IEnumerable? analyzers = from type in typeof(VSTHRD002UseJtfRunAnalyzer).Assembly.GetTypes() + where type.GetCustomAttributes(typeof(DiagnosticAnalyzerAttribute), true).Any() + select (DiagnosticAnalyzer?)Activator.CreateInstance(type) ?? throw Assumes.Fail("Unable to instantiate the analyzer"); + return analyzers.ToImmutableArray(); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs index fd687ba37..0030faa58 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests +public class VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests +{ + [Fact] + public async Task ThreadHelperInvoke_ProducesDiagnostic() { - [Fact] - public async Task ThreadHelperInvoke_ProducesDiagnostic() - { - var test = @" + var test = @" using Microsoft.VisualStudio.Shell; class Test { @@ -22,13 +22,13 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test, Verify.Diagnostic().WithLocation(0)); - } + await CSVerify.VerifyAnalyzerAsync(test, CSVerify.Diagnostic().WithLocation(0)); + } - [Fact] - public async Task ThreadHelperBeginInvoke_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task ThreadHelperBeginInvoke_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Shell; class Test { @@ -38,13 +38,13 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test, Verify.Diagnostic().WithLocation(0)); - } + await CSVerify.VerifyAnalyzerAsync(test, CSVerify.Diagnostic().WithLocation(0)); + } - [Fact] - public async Task ThreadHelperInvokeAsync_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task ThreadHelperInvokeAsync_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Shell; class Test { @@ -54,13 +54,13 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test, Verify.Diagnostic().WithLocation(0)); - } + await CSVerify.VerifyAnalyzerAsync(test, CSVerify.Diagnostic().WithLocation(0)); + } - [SkippableFact] - public async Task DispatcherInvoke_ProducesDiagnostic() - { - var test = @" + [SkippableFact] + public async Task DispatcherInvoke_ProducesDiagnostic() + { + var test = @" using System.Windows.Threading; class Test { @@ -70,15 +70,15 @@ void Foo() { } "; - var t = new Verify.Test { TestCode = test, IncludeWindowsBase = true }; - t.ExpectedDiagnostics.Add(Verify.Diagnostic().WithLocation(0)); - await t.RunAsync(); - } + var t = new CSVerify.Test { TestCode = test, IncludeWindowsBase = true }; + t.ExpectedDiagnostics.Add(CSVerify.Diagnostic().WithLocation(0)); + await t.RunAsync(); + } - [SkippableFact] - public async Task DispatcherBeginInvoke_ProducesDiagnostic() - { - var test = @" + [SkippableFact] + public async Task DispatcherBeginInvoke_ProducesDiagnostic() + { + var test = @" using System; using System.Windows.Threading; @@ -89,15 +89,15 @@ void Foo() { } "; - var t = new Verify.Test { TestCode = test, IncludeWindowsBase = true }; - t.ExpectedDiagnostics.Add(Verify.Diagnostic().WithLocation(0)); - await t.RunAsync(); - } + var t = new CSVerify.Test { TestCode = test, IncludeWindowsBase = true }; + t.ExpectedDiagnostics.Add(CSVerify.Diagnostic().WithLocation(0)); + await t.RunAsync(); + } - [SkippableFact] - public async Task DispatcherInvokeAsync_ProducesDiagnostic() - { - var test = @" + [SkippableFact] + public async Task DispatcherInvokeAsync_ProducesDiagnostic() + { + var test = @" using System.Windows.Threading; class Test { @@ -107,15 +107,15 @@ void Foo() { } "; - var t = new Verify.Test { TestCode = test, IncludeWindowsBase = true }; - t.ExpectedDiagnostics.Add(Verify.Diagnostic().WithLocation(0)); - await t.RunAsync(); - } + var t = new CSVerify.Test { TestCode = test, IncludeWindowsBase = true }; + t.ExpectedDiagnostics.Add(CSVerify.Diagnostic().WithLocation(0)); + await t.RunAsync(); + } - [Fact] - public async Task SynchronizationContextSend_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task SynchronizationContextSend_ProducesDiagnostic() + { + var test = @" using System.Threading; class Test { @@ -125,13 +125,13 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test, Verify.Diagnostic().WithLocation(0)); - } + await CSVerify.VerifyAnalyzerAsync(test, CSVerify.Diagnostic().WithLocation(0)); + } - [Fact] - public async Task SynchronizationContextPost_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task SynchronizationContextPost_ProducesDiagnostic() + { + var test = @" using System.Threading; class Test { @@ -141,7 +141,6 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test, Verify.Diagnostic().WithLocation(0)); - } + await CSVerify.VerifyAnalyzerAsync(test, CSVerify.Diagnostic().WithLocation(0)); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs index 7473d6426..173bbf1aa 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs @@ -1,26 +1,26 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD002UseJtfRunAnalyzerTests +public class VSTHRD002UseJtfRunAnalyzerTests +{ + /// + /// We set TestCategory=AnyCategory here so that *some* test in our assembly uses + /// "TestCategory" as the name of a trait. This prevents VSTest.Console from failing + /// when invoked with /TestCaseFilter:"TestCategory!=FailsInCloudTest" for assemblies + /// such as this one that don't define any TestCategory tests. + /// + [Fact, Trait("TestCategory", "AnyCategory-SeeComment")] + public async Task TaskWaitShouldReportWarning() { - /// - /// We set TestCategory=AnyCategory here so that *some* test in our assembly uses - /// "TestCategory" as the name of a trait. This prevents VSTest.Console from failing - /// when invoked with /TestCaseFilter:"TestCategory!=FailsInCloudTest" for assemblies - /// such as this one that don't define any TestCategory tests. - /// - [Fact, Trait("TestCategory", "AnyCategory-SeeComment")] - public async Task TaskWaitShouldReportWarning() - { - var test = @" + var test = @" using System; using System.Threading.Tasks; @@ -31,7 +31,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -42,14 +42,14 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 14, 8, 18); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 14, 8, 18); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskWaitAnyShouldReportWarning() - { - var test = @" + [Fact] + public async Task TaskWaitAnyShouldReportWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -61,7 +61,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -73,14 +73,14 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 14, 9, 21); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 14, 9, 21); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskWhenAll_CompareWithAndWithout() - { - var test = @" + [Fact] + public async Task TaskWhenAll_CompareWithAndWithout() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -112,20 +112,20 @@ void WhenAll_NoWarnings() { } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic().WithSpan(14, 19, 14, 23), - Verify.Diagnostic().WithSpan(15, 19, 15, 23), - Verify.Diagnostic().WithSpan(16, 26, 16, 32), - Verify.Diagnostic().WithSpan(16, 54, 16, 63), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task TaskWhenAll_Multiple_NoWarning() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic().WithSpan(14, 19, 14, 23), + CSVerify.Diagnostic().WithSpan(15, 19, 15, 23), + CSVerify.Diagnostic().WithSpan(16, 26, 16, 32), + CSVerify.Diagnostic().WithSpan(16, 54, 16, 63), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task TaskWhenAll_Multiple_NoWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -151,13 +151,13 @@ void Foo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task TaskWhenAll_AfterResult_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_AfterResult_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -176,14 +176,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(13, 29, 13, 35); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(13, 29, 13, 35); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskWhenAll_DifferentResult_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_DifferentResult_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -206,14 +206,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(18, 26, 18, 32); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(18, 26, 18, 32); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskWhenAll_TaskPassedByValue_NoWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_TaskPassedByValue_NoWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -235,13 +235,13 @@ void Foo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task TaskWhenAll_TaskPassedByRef_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_TaskPassedByRef_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -263,14 +263,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(18, 26, 18, 32); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(18, 26, 18, 32); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskWhenAll_TaskPassedWithOut_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_TaskPassedWithOut_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -292,14 +292,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(18, 26, 18, 32); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(18, 26, 18, 32); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskWhenAll_TaskVariableReused_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_TaskVariableReused_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -320,14 +320,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(17, 32, 17, 38); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(17, 32, 17, 38); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskWhenAll_MultipleWhenAll_TaskVariableReused_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWhenAll_MultipleWhenAll_TaskVariableReused_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -352,14 +352,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(21, 32, 21, 38); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(21, 32, 21, 38); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskWaitAllShouldReportWarning() - { - var test = @" + [Fact] + public async Task TaskWaitAllShouldReportWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -371,7 +371,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -383,14 +383,14 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 14, 9, 21); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 14, 9, 21); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskWaitShouldReportWarning_WithinAnonymousDelegate() - { - var test = @" + [Fact] + public async Task TaskWaitShouldReportWarning_WithinAnonymousDelegate() + { + var test = @" using System; using System.Threading.Tasks; @@ -401,14 +401,14 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 31, 8, 35); - await Verify.VerifyCodeFixAsync(test, expected, test); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 31, 8, 35); + await CSVerify.VerifyCodeFixAsync(test, expected, test); + } - [Fact] - public async Task Task_Result_ShouldReportWarning() - { - var test = @" + [Fact] + public async Task Task_Result_ShouldReportWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -419,7 +419,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -430,14 +430,14 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 27, 8, 33); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 27, 8, 33); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task ValueTask_Result_ShouldReportWarning() - { - var test = @" + [Fact] + public async Task ValueTask_Result_ShouldReportWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -448,7 +448,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -459,14 +459,14 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 27, 8, 33); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 27, 8, 33); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskResultShouldReportWarning_WithinAnonymousDelegate() - { - var test = @" + [Fact] + public async Task TaskResultShouldReportWarning_WithinAnonymousDelegate() + { + var test = @" using System; using System.Threading.Tasks; @@ -477,14 +477,14 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 34, 8, 40); - await Verify.VerifyCodeFixAsync(test, expected, test); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 34, 8, 40); + await CSVerify.VerifyCodeFixAsync(test, expected, test); + } - [Fact] - public async Task TaskResultShouldNotReportWarning_WithinItsOwnContinuationDelegate() - { - var test = @" + [Fact] + public async Task TaskResultShouldNotReportWarning_WithinItsOwnContinuationDelegate() + { + var test = @" using System; using System.Threading.Tasks; @@ -506,19 +506,19 @@ void ContinueWith(Func, int> del) { } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic().WithSpan(9, 47, 9, 53), - Verify.Diagnostic().WithSpan(10, 29, 10, 35), - }; + DiagnosticResult[] expected = + { + CSVerify.Diagnostic().WithSpan(9, 47, 9, 53), + CSVerify.Diagnostic().WithSpan(10, 29, 10, 35), + }; - await Verify.VerifyCodeFixAsync(test, expected, test); - } + await CSVerify.VerifyCodeFixAsync(test, expected, test); + } - [Fact] - public async Task Task_GetAwaiter_GetResult_ShouldReportWarning() - { - var test = @" + [Fact] + public async Task Task_GetAwaiter_GetResult_ShouldReportWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -529,7 +529,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -540,14 +540,14 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 27, 8, 36); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 27, 8, 36); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task ValueTask_GetAwaiter_GetResult_ShouldReportWarning() - { - var test = @" + [Fact] + public async Task ValueTask_GetAwaiter_GetResult_ShouldReportWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -558,7 +558,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -569,16 +569,16 @@ async Task FAsync() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 27, 8, 36); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 27, 8, 36); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskResult_FixUpdatesCallers() + [Fact] + public async Task TaskResult_FixUpdatesCallers() + { + var test = new SourceFileList("Test", "cs") { - var test = new SourceFileList("Test", "cs") - { - @" + @" using System; using System.Threading.Tasks; @@ -602,17 +602,17 @@ static int Main(string[] args) } } ", - @" + @" class TestClient { int Multiply(int a, int b) { return Test.GetNumber(a) * b; } } ", - }; - var withFix = new SourceFileList("Test", "cs") - { - @" + }; + var withFix = new SourceFileList("Test", "cs") + { + @" using System; using System.Threading.Tasks; @@ -636,36 +636,36 @@ static async Task Main(string[] args) } } ", - @" + @" class TestClient { async System.Threading.Tasks.Task MultiplyAsync(int a, int b) { return await Test.GetNumberAsync(a) * b; } } ", - }; + }; - var verifyTest = new Verify.Test + var verifyTest = new CSVerify.Test + { + TestState = { - TestState = - { - OutputKind = OutputKind.ConsoleApplication, - }, - ExpectedDiagnostics = - { - Verify.Diagnostic().WithSpan("Test0.cs", 8, 21, 8, 27), - }, - }; - - verifyTest.TestState.Sources.AddRange(test); - verifyTest.FixedState.Sources.AddRange(withFix); - await verifyTest.RunAsync(); - } + OutputKind = OutputKind.ConsoleApplication, + }, + ExpectedDiagnostics = + { + CSVerify.Diagnostic().WithSpan("Test0.cs", 8, 21, 8, 27), + }, + }; - [Fact] - public async Task DoNotReportWarningInTaskReturningMethods() - { - var test = @" + verifyTest.TestState.Sources.AddRange(test); + verifyTest.FixedState.Sources.AddRange(withFix); + await verifyTest.RunAsync(); + } + + [Fact] + public async Task DoNotReportWarningInTaskReturningMethods() + { + var test = @" using System.Threading.Tasks; class Test { @@ -676,13 +676,13 @@ Task F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningOnCodeGeneratedByXaml2CS() - { - var test = @" + [Fact] + public async Task DoNotReportWarningOnCodeGeneratedByXaml2CS() + { + var test = @" //------------------------------------------------------------------------------ // // This code was generated by a tool. @@ -706,13 +706,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningOnJTFRun() - { - var test = @" + [Fact] + public async Task DoNotReportWarningOnJTFRun() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -727,13 +727,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningOnJoinableTaskJoin() - { - var test = @" + [Fact] + public async Task DoNotReportWarningOnJoinableTaskJoin() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -749,13 +749,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodsWithoutLeadingMember() - { - var test = @" + [Fact] + public async Task MethodsWithoutLeadingMember() + { + var test = @" using System; using System.Threading; using System.Threading.Tasks; @@ -772,13 +772,13 @@ public void Start(Task action, Action exceptionHandler = null) } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AnonymousDelegateWithExplicitCast() - { - var test = @" + [Fact] + public async Task AnonymousDelegateWithExplicitCast() + { + var test = @" using System; using System.Threading; using System.Threading.Tasks; @@ -796,7 +796,6 @@ public void Start(JoinableTask joinableTask, object registration) } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 0b9e291f8..870a0bb7e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1,23 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests +using System.Diagnostics.Tracing; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD003UseJtfRunAsyncAnalyzerTests { - using System.Diagnostics.Tracing; - using System.Linq; - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; - - public class VSTHRD003UseJtfRunAsyncAnalyzerTests - { - [Fact] - public async Task ReportWarningWhenTaskIsDefinedOutsideDelegate() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsDefinedOutsideDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -44,18 +44,18 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic().WithLocation(15, 19), - Verify.Diagnostic().WithLocation(16, 19), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportWarningWhenTaskTIsDefinedOutsideDelegate() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic().WithLocation(15, 19), + CSVerify.Diagnostic().WithLocation(16, 19), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportWarningWhenTaskTIsDefinedOutsideDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -80,14 +80,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(14, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(14, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskTIsReturnedDirectlyFromLambda() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskTIsReturnedDirectlyFromLambda() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -100,14 +100,14 @@ public static T WaitAndGetResult(Task task) } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(10, 59); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(10, 59); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskTIsReturnedDirectlyFromDelegate() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskTIsReturnedDirectlyFromDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -120,14 +120,14 @@ public static T WaitAndGetResult(Task task) } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(10, 68); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(10, 68); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskIsReturnedDirectlyFromMethod() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsReturnedDirectlyFromMethod() + { + var test = @" using System.Threading.Tasks; class Tests @@ -140,14 +140,14 @@ public Task GetTask() } } "; - DiagnosticResult expected = this.CreateDiagnostic(10, 16, 4); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 16, 4); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskIsReturnedDirectlyFromMethodViaExpressionBody() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsReturnedDirectlyFromMethodViaExpressionBody() + { + var test = @" using System.Threading.Tasks; class Tests @@ -157,14 +157,14 @@ class Tests public Task GetTask() => task; } "; - DiagnosticResult expected = this.CreateDiagnostic(8, 30, 4); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(8, 30, 4); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskParameterIsReturnedDirectlyFromMethodViaExpressionBody() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskParameterIsReturnedDirectlyFromMethodViaExpressionBody() + { + var test = @" using System.Threading.Tasks; class Tests @@ -172,14 +172,14 @@ class Tests public Task GetTask(Task task) => task; } "; - DiagnosticResult expected = this.CreateDiagnostic(6, 39, 4); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(6, 39, 4); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskIsReturnedAwaitedFromMethod() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsReturnedAwaitedFromMethod() + { + var test = @" using System.Threading.Tasks; class Tests @@ -192,16 +192,16 @@ public async Task AwaitAndGetResult() } } "; - DiagnosticResult expected = this.CreateDiagnostic(10, 22, 4); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 22, 4); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Theory] - [InlineData(true)] - [InlineData(false)] - public async Task ReportWarningWhenConfiguredTaskIsReturnedAwaitedFromMethod(bool continueOnCapturedContext) - { - var test = $@" + [Theory] + [InlineData(true)] + [InlineData(false)] + public async Task ReportWarningWhenConfiguredTaskIsReturnedAwaitedFromMethod(bool continueOnCapturedContext) + { + var test = $@" using System.Threading.Tasks; class Tests @@ -214,16 +214,16 @@ public async Task AwaitAndGetResult() }} }} "; - DiagnosticResult expected = this.CreateDiagnostic(10, 15, 21 + continueOnCapturedContext.ToString().Length); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 15, 21 + continueOnCapturedContext.ToString().Length); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Theory] - [InlineData(true)] - [InlineData(false)] - public async Task ReportWarningWhenConfiguredTaskTIsReturnedAwaitedFromMethod(bool continueOnCapturedContext) - { - var test = $@" + [Theory] + [InlineData(true)] + [InlineData(false)] + public async Task ReportWarningWhenConfiguredTaskTIsReturnedAwaitedFromMethod(bool continueOnCapturedContext) + { + var test = $@" using System.Threading.Tasks; class Tests @@ -236,14 +236,14 @@ public async Task AwaitAndGetResult() }} }} "; - DiagnosticResult expected = this.CreateDiagnostic(10, 22, 21 + continueOnCapturedContext.ToString().Length); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 22, 21 + continueOnCapturedContext.ToString().Length); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenConfiguredInlineTaskReturnedAwaitedFromMethod() - { - var test = @" + [Fact] + public async Task ReportWarningWhenConfiguredInlineTaskReturnedAwaitedFromMethod() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -257,14 +257,14 @@ public async Task AwaitAndGetResult() } } "; - DiagnosticResult expected = this.CreateDiagnostic(11, 15, 30); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(11, 15, 30); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenConfiguredInlineTaskTReturnedAwaitedFromMethod() - { - var test = @" + [Fact] + public async Task ReportWarningWhenConfiguredInlineTaskTReturnedAwaitedFromMethod() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -278,14 +278,14 @@ public async Task AwaitAndGetResult() } } "; - DiagnosticResult expected = this.CreateDiagnostic(11, 22, 30); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(11, 22, 30); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskFromFieldIsAwaitedInJtfRunDelegate() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskFromFieldIsAwaitedInJtfRunDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -303,14 +303,14 @@ static void Main(string[] args) } } "; - DiagnosticResult expected = this.CreateDiagnostic(14, 19, 1); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(14, 19, 1); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskTIsReturnedDirectlyWithCancellation() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskTIsReturnedDirectlyWithCancellation() + { + var test = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -324,14 +324,14 @@ public static T WaitAndGetResult(Task task, CancellationToken cancellation } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(11, 59); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(11, 59); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task DoNotReportWarningWhenTaskTIsPassedAsArgumentAndNoTaskIsReturned() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskTIsPassedAsArgumentAndNoTaskIsReturned() + { + var test = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -348,13 +348,13 @@ public static int WaitAndGetResult(Task task) private static int DoSomethingWith(Task t) => 3; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningWhenTaskTIsPassedAsArgumentAndTaskIsReturned() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskTIsPassedAsArgumentAndTaskIsReturned() + { + var test = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -371,14 +371,14 @@ public static void WaitAndGetResult(Task task, CancellationToken cancellat private static Task DoSomethingWith(Task t) => null; } "; - DiagnosticResult expected = this.CreateDiagnostic(12, 68, 4); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(12, 68, 4); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskIsDefinedOutsideDelegateUsingRunAsync() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsDefinedOutsideDelegateUsingRunAsync() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -403,14 +403,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(14, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(14, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskIsDefinedOutsideParanthesizedLambdaExpression() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsDefinedOutsideParanthesizedLambdaExpression() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -436,14 +436,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(14, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(14, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task DoNotReportWarningWhenTaskIsDefinedWithinDelegate() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskIsDefinedWithinDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -470,13 +470,13 @@ public async Task SomeOperationAsync() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenReturnedTaskIsDirectlyReturnedFromInvocation() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenReturnedTaskIsDirectlyReturnedFromInvocation() + { + var test = @" using System.Threading.Tasks; class Tests @@ -489,13 +489,13 @@ public Task Test() public Task SomeOperationAsync() => Task.CompletedTask; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenReturnedTaskIsAwaitedReturnedFromInvocation() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenReturnedTaskIsAwaitedReturnedFromInvocation() + { + var test = @" using System.Threading.Tasks; class Tests @@ -508,13 +508,13 @@ public async Task Test() public Task SomeOperationAsync() => Task.FromResult(3); } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenTaskIsDefinedWithinDelegateInSubblock() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskIsDefinedWithinDelegateInSubblock() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -544,13 +544,13 @@ public async Task SomeOperationAsync() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenTaskIsDefinedOutsideButInitializedWithinDelegate() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskIsDefinedOutsideButInitializedWithinDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -576,13 +576,13 @@ public async Task SomeOperationAsync() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenTaskIsInitializedBothOutsideAndInsideDelegate() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskIsInitializedBothOutsideAndInsideDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -608,13 +608,13 @@ public async Task SomeOperationAsync() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenTaskIsInitializedInsideDelegateConditionalStatement() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskIsInitializedInsideDelegateConditionalStatement() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -644,13 +644,13 @@ public async Task SomeOperationAsync() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningWhenTaskIsDefinedOutsideAndInitializedAfterAwait() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsDefinedOutsideAndInitializedAfterAwait() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -676,14 +676,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(14, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(14, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskIsDefinedOutsideAndInitializationIsCommentedOut() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskIsDefinedOutsideAndInitializationIsCommentedOut() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -710,14 +710,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(16, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(16, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenAwaitIsInsideForLoop() - { - var test = @" + [Fact] + public async Task ReportWarningWhenAwaitIsInsideForLoop() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -745,14 +745,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(16, 23); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(16, 23); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningsForMultipleAwaits() - { - var test = @" + [Fact] + public async Task ReportWarningsForMultipleAwaits() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -779,20 +779,20 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic().WithLocation(14, 19), - Verify.Diagnostic().WithLocation(15, 19), - Verify.Diagnostic().WithLocation(16, 19), - }; + DiagnosticResult[] expected = + { + CSVerify.Diagnostic().WithLocation(14, 19), + CSVerify.Diagnostic().WithLocation(15, 19), + CSVerify.Diagnostic().WithLocation(16, 19), + }; - await Verify.VerifyAnalyzerAsync(test, expected); - } + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task DoNotReportWarningWhenAwaitingAsyncMethod() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenAwaitingAsyncMethod() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -816,13 +816,13 @@ public async Task SomeOperationAsync() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenAwaitingJoinableTaskDefinedInsideDelegate() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenAwaitingJoinableTaskDefinedInsideDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -844,13 +844,13 @@ public void Test() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenAwaitingJoinableTaskDefinedOutsideDelegate() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenAwaitingJoinableTaskDefinedOutsideDelegate() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -873,13 +873,13 @@ public void Test() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningWhenHavingNestedLambdaExpressions() - { - var test = @" + [Fact] + public async Task ReportWarningWhenHavingNestedLambdaExpressions() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -909,14 +909,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(17, 23); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(17, 23); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningForDerivedJoinableTaskFactory() - { - var test = @" + [Fact] + public async Task ReportWarningForDerivedJoinableTaskFactory() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -951,14 +951,14 @@ public async Task SomeOperationAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(24, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(24, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenAwaitingTaskInField() - { - var test = @" + [Fact] + public async Task ReportWarningWhenAwaitingTaskInField() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -974,14 +974,14 @@ public void Test() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(12, 19, 4); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(12, 19, 4); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenAwaitingTaskInField_WithThisQualifier() - { - var test = @" + [Fact] + public async Task ReportWarningWhenAwaitingTaskInField_WithThisQualifier() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -997,14 +997,14 @@ public void Test() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(12, 19, 9); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(12, 19, 9); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task DoNotReportWarningWhenAwaitingTaskInFieldThatIsAssignedLocally() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskInFieldThatIsAssignedLocally() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; @@ -1023,13 +1023,13 @@ public void Test() { Task SomeOperationAsync() => Task.CompletedTask; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenCompletedTaskIsReturnedDirectlyFromMethod() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenCompletedTaskIsReturnedDirectlyFromMethod() + { + var test = @" using System; using System.Threading; using System.Threading.Tasks; @@ -1068,13 +1068,13 @@ public Task GetTask(int i) } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenTaskFromResultIsReturnedDirectlyFromMethod() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskFromResultIsReturnedDirectlyFromMethod() + { + var test = @" using System.Threading.Tasks; class Tests @@ -1085,13 +1085,13 @@ public Task GetTask() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningWhenTaskFromResultIsReturnedDirectlyFromMethod_FromField() - { - var test = @" + [Fact] + public async Task DoNotReportWarningWhenTaskFromResultIsReturnedDirectlyFromMethod_FromField() + { + var test = @" using System.Threading.Tasks; class Tests @@ -1104,13 +1104,13 @@ public Task GetTask() } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningWhenTaskFromResultIsReturnedDirectlyFromMethod_FromField_NotReadOnly() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskFromResultIsReturnedDirectlyFromMethod_FromField_NotReadOnly() + { + var test = @" using System.Threading.Tasks; class Tests @@ -1123,14 +1123,14 @@ public Task GetTask() } } "; - DiagnosticResult expected = this.CreateDiagnostic(10, 16, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 16, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningWhenTaskRunIsReturnedDirectlyFromMethod_FromField() - { - var test = @" + [Fact] + public async Task ReportWarningWhenTaskRunIsReturnedDirectlyFromMethod_FromField() + { + var test = @" using System.Threading.Tasks; class Tests @@ -1143,16 +1143,16 @@ public Task GetTask() } } "; - DiagnosticResult expected = this.CreateDiagnostic(10, 16, 8); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 16, 8); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task TaskReturningMethodIncludeArgumentFromOtherSyntaxTree() - { - // This is a regression test for a bug that only repro'd when the field was defined in a different document from where it was used - // as input to a return value from a Task-returning method. - var source1 = @" + [Fact] + public async Task TaskReturningMethodIncludeArgumentFromOtherSyntaxTree() + { + // This is a regression test for a bug that only repro'd when the field was defined in a different document from where it was used + // as input to a return value from a Task-returning method. + var source1 = @" using System.Collections.Immutable; using System.Threading.Tasks; @@ -1164,7 +1164,7 @@ private Task> SomethingAsync() } } "; - var source2 = @" + var source2 = @" using System.Collections.Immutable; class OtherClass @@ -1177,14 +1177,14 @@ class OtherClass } "; - var test = new Verify.Test { TestState = { Sources = { source1, source2 } } }; - await test.RunAsync(); - } + var test = new CSVerify.Test { TestState = { Sources = { source1, source2 } } }; + await test.RunAsync(); + } - [Fact] - public async Task CachedTaskReturnedFromExternalToCompilation() - { - string specialTasksCs = @" + [Fact] + public async Task CachedTaskReturnedFromExternalToCompilation() + { + string specialTasksCs = @" using System.Threading.Tasks; public static class SpecialTasks { @@ -1192,14 +1192,14 @@ public static class SpecialTasks { } "; - Verify.Test? test = null; - test = new Verify.Test + CSVerify.Test? test = null; + test = new CSVerify.Test + { + TestState = { - TestState = + Sources = { - Sources = - { - @" + @" using System.Threading.Tasks; public static class Boom { @@ -1209,32 +1209,32 @@ static Task MyMethodAsync() } } ", - }, - AdditionalProjects = + }, + AdditionalProjects = + { + ["ProjectA"] = { - ["ProjectA"] = + Sources = { - Sources = - { - ("SpecialTasks.cs", specialTasksCs), - }, + ("SpecialTasks.cs", specialTasksCs), }, }, - AdditionalProjectReferences = - { - "ProjectA", - }, }, - }; + AdditionalProjectReferences = + { + "ProjectA", + }, + }, + }; - await test.RunAsync(); - } + await test.RunAsync(); + } - [Fact] - public async Task DoNotReportWarningWithParenthesizedAwaitExpressions() - { - // This is a test for bug 849. Parenthesized expressions caused an InvalidCastException. - var test = @" + [Fact] + public async Task DoNotReportWarningWithParenthesizedAwaitExpressions() + { + // This is a test for bug 849. Parenthesized expressions caused an InvalidCastException. + var test = @" using System.Threading.Tasks; class Test { @@ -1249,10 +1249,9 @@ async Task FooAsync() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } - - private DiagnosticResult CreateDiagnostic(int line, int column, int length) => - Verify.Diagnostic().WithSpan(line, column, line, column + length); + await CSVerify.VerifyAnalyzerAsync(test); } + + private DiagnosticResult CreateDiagnostic(int line, int column, int length) => + CSVerify.Diagnostic().WithSpan(line, column, line, column + length); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs index 3dc18d8ce..3120a34d4 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; - public class VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests +{ + [Fact] + public async Task SyncMethod_ProducesDiagnostic() { - [Fact] - public async Task SyncMethod_ProducesDiagnostic() - { - var test = @" + var test = @" class Test { Microsoft.VisualStudio.Threading.JoinableTaskFactory jtf; @@ -25,13 +25,13 @@ void Foo() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncMethod_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AsyncMethod_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -46,13 +46,13 @@ async Task FooAsync() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncMethod_NoAwaitInParenthesizedLambda_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AsyncMethod_NoAwaitInParenthesizedLambda_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -66,13 +66,13 @@ async Task FooAsync() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncMethod_NoAwaitInAnonymousDelegate_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AsyncMethod_NoAwaitInAnonymousDelegate_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -86,13 +86,13 @@ async Task FooAsync() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncMethodWithAwait_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task AsyncMethodWithAwait_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -106,13 +106,13 @@ async Task FooAsync() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task TaskReturningSyncMethod_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task TaskReturningSyncMethod_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -127,7 +127,6 @@ Task FooAsync() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs index 95b7fd9b9..11048aea2 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using static Microsoft.VisualStudio.Threading.Analyzers.VSTHRD010MainThreadUsageAnalyzer; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using static Microsoft.VisualStudio.Threading.Analyzers.VSTHRD010MainThreadUsageAnalyzer; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD010MainThreadUsageAnalyzerTests +public class VSTHRD010MainThreadUsageAnalyzerTests +{ + [Fact] + public async Task InvokeVsReferenceOutsideMethod() { - [Fact] - public async Task InvokeVsReferenceOutsideMethod() - { - var test = @" + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -26,14 +26,14 @@ class Test { string name = G.Ref1.Name; } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(10, 26, 10, 30).WithArguments("IVsReference", "Test.VerifyOnUIThread"); - await Verify.VerifyCodeFixAsync(test, expected, test); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(10, 26, 10, 30).WithArguments("IVsReference", "Test.VerifyOnUIThread"); + await CSVerify.VerifyCodeFixAsync(test, expected, test); + } - [Fact] - public async Task InvokeVsSolutionComplexStyle() - { - var test = @" + [Fact] + public async Task InvokeVsSolutionComplexStyle() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -45,7 +45,7 @@ void F() { IVsSolution Method() { return null; } } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -58,19 +58,19 @@ void F() { IVsSolution Method() { return null; } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(7, 23, 7, 34).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task InvokeVsSolutionNoCheck() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(7, 23, 7, 34).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task InvokeVsSolutionNoCheck() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -81,7 +81,7 @@ void F() { } } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -93,26 +93,26 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - /// - /// Describes an idea for how another code fix can offer to wrap a method in a JTF.Run delegate to switch to the main thread. - /// - /// - /// This will need much more thorough testing than just this method, when the feature is implemented. - /// There are ref and out parameters, and return values to consider, for example. - /// - [Fact(Skip = "Feature is not yet implemented.")] - public async Task InvokeVsSolutionNoCheck_FixByJTFRunAndSwitch() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + /// + /// Describes an idea for how another code fix can offer to wrap a method in a JTF.Run delegate to switch to the main thread. + /// + /// + /// This will need much more thorough testing than just this method, when the feature is implemented. + /// There are ref and out parameters, and return values to consider, for example. + /// + [Fact(Skip = "Feature is not yet implemented.")] + public async Task InvokeVsSolutionNoCheck_FixByJTFRunAndSwitch() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -123,7 +123,7 @@ void F() { } } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -137,19 +137,19 @@ void F() { } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.SwitchToMainThreadAsync, - }.RunAsync(); - } - - [Fact] - public async Task InvokeVsSolutionNoCheck_InProperty() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.SwitchToMainThreadAsync, + }.RunAsync(); + } + + [Fact] + public async Task InvokeVsSolutionNoCheck_InProperty() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -163,7 +163,7 @@ int F { } } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -178,19 +178,19 @@ int F { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(9, 17, 9, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task InvokeVsSolutionNoCheck_InCtor() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(9, 17, 9, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task InvokeVsSolutionNoCheck_InCtor() + { + var test = @" using Microsoft.VisualStudio.Shell.Interop; class Test { @@ -200,7 +200,7 @@ class Test { } } "; - var fix = @" + var fix = @" using Microsoft.VisualStudio.Shell.Interop; class Test { @@ -211,19 +211,19 @@ class Test { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(7, 13, 7, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task TransitiveNoCheck_InCtor() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(7, 13, 7, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task TransitiveNoCheck_InCtor() + { + var test = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -242,7 +242,7 @@ static void VerifyOnUIThread() { } } "; - var fix1 = @" + var fix1 = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -262,7 +262,7 @@ static void VerifyOnUIThread() { } } "; - var fix2 = @" + var fix2 = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -283,28 +283,28 @@ static void VerifyOnUIThread() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(7, 9, 7, 12).WithArguments("Test.Foo", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix1, - CodeActionIndex = CodeFixIndex.VerifyOnUIThread, - }.RunAsync(); - - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix2, - CodeActionIndex = CodeFixIndex.ThrowIfNotOnUIThreadIndex1, - }.RunAsync(); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(7, 9, 7, 12).WithArguments("Test.Foo", "Test.VerifyOnUIThread"); + await new CSVerify.Test + { + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix1, + CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + }.RunAsync(); - [Fact] - public async Task InvokeVsSolutionWithCheck_InCtor() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix2, + CodeActionIndex = CodeFixIndex.ThrowIfNotOnUIThreadIndex1, + }.RunAsync(); + } + + [Fact] + public async Task InvokeVsSolutionWithCheck_InCtor() + { + var test = @" using Microsoft.VisualStudio.Shell.Interop; class Test { @@ -318,13 +318,13 @@ void VerifyOnUIThread() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InvokeVsSolutionBeforeAndAfterVerifyOnUIThread() - { - var test = @" + [Fact] + public async Task InvokeVsSolutionBeforeAndAfterVerifyOnUIThread() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -340,7 +340,7 @@ void VerifyOnUIThread() { } } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -357,19 +357,19 @@ void VerifyOnUIThread() { } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.ThrowIfNotOnUIThreadIndex0, - }.RunAsync(); - } - - [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] - public async Task InvokeVsSolutionAfterConditionedVerifyOnUIThread() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.ThrowIfNotOnUIThreadIndex0, + }.RunAsync(); + } + + [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] + public async Task InvokeVsSolutionAfterConditionedVerifyOnUIThread() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -387,14 +387,14 @@ void VerifyOnUIThread() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(12, 13, 12, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(12, 13, 12, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] - public async Task InvokeVsSolutionInBlockWithoutVerifyOnUIThread() - { - var test = @" + [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] + public async Task InvokeVsSolutionInBlockWithoutVerifyOnUIThread() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -412,14 +412,14 @@ void VerifyOnUIThread() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(11, 17, 11, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(11, 17, 11, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] - public async Task InvokeVsSolutionAfterSwallowingCatchBlockWhereVerifyOnUIThreadWasInTry() - { - var test = @" + [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] + public async Task InvokeVsSolutionAfterSwallowingCatchBlockWhereVerifyOnUIThreadWasInTry() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -437,14 +437,14 @@ void VerifyOnUIThread() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(12, 13, 12, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(12, 13, 12, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact(Skip = "Not yet supported. See https://github.com/microsoft/vs-threading/issues/542")] - public async Task InvokeVsSolutionAfterUIThreadAssertionAndSwitchToThreadPool() - { - var test = @" + [Fact(Skip = "Not yet supported. See https://github.com/microsoft/vs-threading/issues/542")] + public async Task InvokeVsSolutionAfterUIThreadAssertionAndSwitchToThreadPool() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -464,14 +464,14 @@ void VerifyOnUIThread() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorAsync).WithSpan(14, 13, 14, 24).WithArguments("IVsSolution", "JoinableTaskFactory.SwitchToMainThreadAsync"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorAsync).WithSpan(14, 13, 14, 24).WithArguments("IVsSolution", "JoinableTaskFactory.SwitchToMainThreadAsync"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact(Skip = "Not yet supported. See https://github.com/microsoft/vs-threading/issues/542")] - public async Task InvokeVsSolutionAfterUIThreadAssertionAndConfigureAwaitFalse() - { - var test = @" + [Fact(Skip = "Not yet supported. See https://github.com/microsoft/vs-threading/issues/542")] + public async Task InvokeVsSolutionAfterUIThreadAssertionAndConfigureAwaitFalse() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -493,14 +493,14 @@ void VerifyOnUIThread() { async Task SomeAsync() => await Task.Yield(); } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorAsync).WithSpan(14, 13, 14, 24).WithArguments("IVsSolution", "JoinableTaskFactory.SwitchToMainThreadAsync"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorAsync).WithSpan(14, 13, 14, 24).WithArguments("IVsSolution", "JoinableTaskFactory.SwitchToMainThreadAsync"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] - public async Task InvokeVsSolutionAfterUIThreadAssertionAndConditionalSwitchToThreadPool() - { - var test = @" + [Fact(Skip = "Not yet supported. See https://github.com/Microsoft/vs-threading/issues/38")] + public async Task InvokeVsSolutionAfterUIThreadAssertionAndConditionalSwitchToThreadPool() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -523,14 +523,14 @@ void VerifyOnUIThread() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorAsync).WithSpan(16, 13, 16, 24).WithArguments("IVsSolution", "JoinableTaskFactory.SwitchToMainThreadAsync"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorAsync).WithSpan(16, 13, 16, 24).WithArguments("IVsSolution", "JoinableTaskFactory.SwitchToMainThreadAsync"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task RequiresUIThreadTransitive_MultipleInMember() - { - var test = @" + [Fact] + public async Task RequiresUIThreadTransitive_MultipleInMember() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -555,7 +555,7 @@ void H() { static void VerifyOnUIThread() { } } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -582,23 +582,23 @@ static void VerifyOnUIThread() { } } "; - await new Verify.Test + await new CSVerify.Test + { + TestCode = test, + ExpectedDiagnostics = { - TestCode = test, - ExpectedDiagnostics = - { - Verify.Diagnostic(DescriptorSync).WithSpan(19, 9, 19, 10).WithArguments("Test.F", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(20, 9, 20, 10).WithArguments("Test.G", "Test.VerifyOnUIThread"), - }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.VerifyOnUIThread, - }.RunAsync(); - } + CSVerify.Diagnostic(DescriptorSync).WithSpan(19, 9, 19, 10).WithArguments("Test.F", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(20, 9, 20, 10).WithArguments("Test.G", "Test.VerifyOnUIThread"), + }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + }.RunAsync(); + } - [Fact] - public async Task RequiresUIThreadTransitive() - { - var test = @" + [Fact] + public async Task RequiresUIThreadTransitive() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -656,27 +656,27 @@ void VerifyOnUIThread() { } } "; - var expected = new DiagnosticResult[] - { - Verify.Diagnostic(DescriptorSync).WithSpan(13, 9, 13, 10).WithArguments("Test.F", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(17, 9, 17, 10).WithArguments("Test.G", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(22, 13, 22, 14).WithArguments("Test.H", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(32, 16, 32, 17).WithArguments("Test.H", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(35, 39, 35, 55).WithArguments("Test.get_MainThreadGetter", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(36, 40, 36, 61).WithArguments("Test.get_MainThreadGetter", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(37, 40, 37, 69).WithArguments("Test.get_MainThreadGetter", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(43, 39, 43, 55).WithArguments("Test.set_MainThreadSetter", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(44, 40, 44, 61).WithArguments("Test.set_MainThreadSetter", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(45, 40, 45, 69).WithArguments("Test.set_MainThreadSetter", "Test.VerifyOnUIThread"), - }; - - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task RequiresUIThreadNotTransitiveIfNotExplicit() + var expected = new DiagnosticResult[] { - var test = @" + CSVerify.Diagnostic(DescriptorSync).WithSpan(13, 9, 13, 10).WithArguments("Test.F", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(17, 9, 17, 10).WithArguments("Test.G", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(22, 13, 22, 14).WithArguments("Test.H", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(32, 16, 32, 17).WithArguments("Test.H", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(35, 39, 35, 55).WithArguments("Test.get_MainThreadGetter", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(36, 40, 36, 61).WithArguments("Test.get_MainThreadGetter", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(37, 40, 37, 69).WithArguments("Test.get_MainThreadGetter", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(43, 39, 43, 55).WithArguments("Test.set_MainThreadSetter", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(44, 40, 44, 61).WithArguments("Test.set_MainThreadSetter", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(45, 40, 45, 69).WithArguments("Test.set_MainThreadSetter", "Test.VerifyOnUIThread"), + }; + + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task RequiresUIThreadNotTransitiveIfNotExplicit() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -698,14 +698,14 @@ void VerifyOnUIThread() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 24).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task RequiresUIThread_NotTransitiveThroughAsyncCalls() - { - var test = @" + [Fact] + public async Task RequiresUIThread_NotTransitiveThroughAsyncCalls() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -725,13 +725,13 @@ private async Task FooAsync() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InvokeVsSolutionAfterSwitchedToMainThreadAsync() - { - var test = @" + [Fact] + public async Task InvokeVsSolutionAfterSwitchedToMainThreadAsync() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -747,13 +747,13 @@ async Task F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InvokeVsSolutionInLambda() - { - var test = @" + [Fact] + public async Task InvokeVsSolutionInLambda() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -771,7 +771,7 @@ static void VerifyOnUIThread() { } } "; - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -790,19 +790,19 @@ static void VerifyOnUIThread() { } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorSync).WithSpan(11, 17, 11, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.VerifyOnUIThread, - }.RunAsync(); - } - - [Fact] - public async Task InvokeVsSolutionInSimpleLambda() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorSync).WithSpan(11, 17, 11, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + }.RunAsync(); + } + + [Fact] + public async Task InvokeVsSolutionInSimpleLambda() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -821,7 +821,7 @@ static void VerifyOnUIThread() { } } "; - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -841,19 +841,19 @@ static void VerifyOnUIThread() { } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorSync).WithSpan(12, 17, 12, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.VerifyOnUIThread, - }.RunAsync(); - } - - [Fact] - public async Task InvokeVsSolutionInLambdaWithThreadValidation() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorSync).WithSpan(12, 17, 12, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + }.RunAsync(); + } + + [Fact] + public async Task InvokeVsSolutionInLambdaWithThreadValidation() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -871,13 +871,13 @@ void VerifyOnUIThread() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InvokeVsSolutionInAnonymous() - { - var test = @" + [Fact] + public async Task InvokeVsSolutionInAnonymous() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -895,7 +895,7 @@ static void VerifyOnUIThread() { } } "; - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -914,19 +914,19 @@ static void VerifyOnUIThread() { } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorSync).WithSpan(11, 17, 11, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.VerifyOnUIThread, - }.RunAsync(); - } - - [Fact] - public async Task GetPropertyFromVsReference() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorSync).WithSpan(11, 17, 11, 28).WithArguments("IVsSolution", "Test.VerifyOnUIThread") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + }.RunAsync(); + } + + [Fact] + public async Task GetPropertyFromVsReference() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -937,14 +937,14 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 22, 8, 26).WithArguments("IVsReference", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 22, 8, 26).WithArguments("IVsReference", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task CastToVsSolution() - { - var test = @" + [Fact] + public async Task CastToVsSolution() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -955,17 +955,17 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithLocation(8, 19).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithLocation(8, 19).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - /// - /// Verifies that the () cast operator does not produce a diagnostic when the type is to a managed type. - /// - [Fact] - public async Task CastToManagedType_ProducesNoDiagnostic() - { - var test = @" + /// + /// Verifies that the () cast operator does not produce a diagnostic when the type is to a managed type. + /// + [Fact] + public async Task CastToManagedType_ProducesNoDiagnostic() + { + var test = @" using System; namespace TestNS { @@ -981,13 +981,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task CastToVsSolutionAfterVerifyOnUIThread() - { - var test = @" + [Fact] + public async Task CastToVsSolutionAfterVerifyOnUIThread() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -1002,13 +1002,13 @@ void VerifyOnUIThread() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task CastToVsSolutionViaAs() - { - var test = @" + [Fact] + public async Task CastToVsSolutionViaAs() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -1019,14 +1019,14 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 24, 8, 38).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 24, 8, 38).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task CastToVsSolutionViaIsWithPatternMatching() - { - var test = @" + [Fact] + public async Task CastToVsSolutionViaIsWithPatternMatching() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -1038,17 +1038,17 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 18, 8, 32).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 18, 8, 32).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - /// - /// Verifies that the as cast operator does not produce a diagnostic when the type is to a managed type. - /// - [Fact] - public async Task CastToManagedTypeViaAs_ProducesNoDiagnostic() - { - var test = @" + /// + /// Verifies that the as cast operator does not produce a diagnostic when the type is to a managed type. + /// + [Fact] + public async Task CastToManagedTypeViaAs_ProducesNoDiagnostic() + { + var test = @" using System; namespace TestNS { @@ -1064,13 +1064,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task TestVsSolutionViaIs() - { - var test = @" + [Fact] + public async Task TestVsSolutionViaIs() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -1081,17 +1081,17 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 27, 8, 41).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 27, 8, 41).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - /// - /// Verifies that the is type check operator does not produce a diagnostic when the type is to a managed type. - /// - [Fact] - public async Task CastToManagedTypeViaIs_ProducesNoDiagnostic() - { - var test = @" + /// + /// Verifies that the is type check operator does not produce a diagnostic when the type is to a managed type. + /// + [Fact] + public async Task CastToManagedTypeViaIs_ProducesNoDiagnostic() + { + var test = @" using System; namespace TestNS { @@ -1107,13 +1107,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task CastToVsSolutionViaAsAfterVerifyOnUIThread() - { - var test = @" + [Fact] + public async Task CastToVsSolutionViaAsAfterVerifyOnUIThread() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -1128,13 +1128,13 @@ void VerifyOnUIThread() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InvokeVsSolutionNoCheck_InProperty_AfterThrowIfNotOnUIThread() - { - var test = @" + [Fact] + public async Task InvokeVsSolutionNoCheck_InProperty_AfterThrowIfNotOnUIThread() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1150,13 +1150,13 @@ int F { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ShouldNotThrowNullReferenceExceptionWhenCastToStringArray() - { - var test = @" + [Fact] + public async Task ShouldNotThrowNullReferenceExceptionWhenCastToStringArray() + { + var test = @" using System; class Test { @@ -1167,13 +1167,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ShouldNotReportWarningOnCastToEnum() - { - var test = @" + [Fact] + public async Task ShouldNotReportWarningOnCastToEnum() + { + var test = @" using System; using Microsoft.VisualStudio.Shell.Interop; @@ -1184,13 +1184,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task OleServiceProviderCast_OffUIThread_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task OleServiceProviderCast_OffUIThread_ProducesDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1202,18 +1202,18 @@ object Foo() } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(9, 31, 9, 85).WithArguments("IServiceProvider", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(9, 31, 9, 85).WithArguments("IServiceProvider", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - /// - /// Verifies that calling a public method of a public class is still considered requiring - /// the UI thread because it implements the IServiceProvider interface. - /// - [Fact] - public async Task GlobalServiceProvider_GetService_OffUIThread_ProducesDiagnostic() - { - var test = @" + /// + /// Verifies that calling a public method of a public class is still considered requiring + /// the UI thread because it implements the IServiceProvider interface. + /// + [Fact] + public async Task GlobalServiceProvider_GetService_OffUIThread_ProducesDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1226,18 +1226,18 @@ void Foo() } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic(DescriptorSync).WithSpan(9, 40, 9, 54).WithArguments("ServiceProvider", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(9, 55, 9, 65).WithArguments("ServiceProvider", "Test.VerifyOnUIThread"), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task Package_GetService_OffUIThread_ProducesDiagnostic() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic(DescriptorSync).WithSpan(9, 40, 9, 54).WithArguments("ServiceProvider", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(9, 55, 9, 65).WithArguments("ServiceProvider", "Test.VerifyOnUIThread"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task Package_GetService_OffUIThread_ProducesDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1249,14 +1249,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 29, 8, 39).WithArguments("Package", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 29, 8, 39).WithArguments("Package", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task Package_GetServiceAsync_OffUIThread_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task Package_GetServiceAsync_OffUIThread_ProducesNoDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1276,13 +1276,13 @@ async Task Foo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task Package_GetServiceAsync_ThenCast_OffUIThread_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task Package_GetServiceAsync_ThenCast_OffUIThread_ProducesDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1301,7 +1301,7 @@ async Task Foo() { } } "; - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1322,23 +1322,23 @@ async Task Foo() { } "; - await new Verify.Test + await new CSVerify.Test + { + TestCode = test, + ExpectedDiagnostics = { - TestCode = test, - ExpectedDiagnostics = - { - Verify.Diagnostic(DescriptorAsync).WithSpan(15, 61, 15, 72).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync"), - Verify.Diagnostic(DescriptorAsync).WithSpan(16, 56, 16, 67).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync"), - }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.NotThreadHelper, - }.RunAsync(); - } + CSVerify.Diagnostic(DescriptorAsync).WithSpan(15, 61, 15, 72).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync"), + CSVerify.Diagnostic(DescriptorAsync).WithSpan(16, 56, 16, 67).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync"), + }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.NotThreadHelper, + }.RunAsync(); + } - [Fact] - public async Task SwitchMethodFoundFromOtherStaticType() - { - var test = @" + [Fact] + public async Task SwitchMethodFoundFromOtherStaticType() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1353,7 +1353,7 @@ static async Task Foo() { } } "; - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1369,19 +1369,19 @@ static async Task Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorAsync).WithSpan(12, 65, 12, 76).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task TaskReturningNonAsyncMethod() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorAsync).WithSpan(12, 65, 12, 76).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task TaskReturningNonAsyncMethod() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1399,7 +1399,7 @@ static Task Foo() { } "; #pragma warning disable CS0219 // Variable is assigned but its value is never used - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1418,15 +1418,15 @@ static async Task Foo() { " #pragma warning restore CS0219 // Variable is assigned but its value is never used ; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(13, 59, 13, 70).WithArguments("IVsShell", "Test.VerifyOnUIThread"); - await Verify.VerifyCodeFixAsync(test, expected, test); // till we have it implemented. - ////await Verify.VerifyCodeFixAsync(test, expected, fix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(13, 59, 13, 70).WithArguments("IVsShell", "Test.VerifyOnUIThread"); + await CSVerify.VerifyCodeFixAsync(test, expected, test); // till we have it implemented. + ////await Verify.VerifyCodeFixAsync(test, expected, fix); + } - [Fact] - public async Task CodeFixAddsSwitchCallWithCancellationToken() - { - var test = @" + [Fact] + public async Task CodeFixAddsSwitchCallWithCancellationToken() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1442,7 +1442,7 @@ protected override async Task InitializeAsync(System.Threading.CancellationToken } } "; - var fix = @" + var fix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -1459,19 +1459,19 @@ protected override async Task InitializeAsync(System.Threading.CancellationToken } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorAsync).WithSpan(13, 65, 13, 76).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.NotThreadHelper, - }.RunAsync(); - } - - [Fact] - public async Task CodeFixAddsSwitchCallWithCancellationTokenAsNamedParameter() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorAsync).WithSpan(13, 65, 13, 76).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.NotThreadHelper, + }.RunAsync(); + } + + [Fact] + public async Task CodeFixAddsSwitchCallWithCancellationTokenAsNamedParameter() + { + var test = @" using System; using System.Threading; using System.Threading.Tasks; @@ -1491,7 +1491,7 @@ protected override async Task InitializeAsync(System.Threading.CancellationToken } } "; - var fix = @" + var fix = @" using System; using System.Threading; using System.Threading.Tasks; @@ -1512,19 +1512,19 @@ protected override async Task InitializeAsync(System.Threading.CancellationToken } } "; - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { Verify.Diagnostic(DescriptorAsync).WithSpan(17, 65, 17, 76).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync") }, - FixedCode = fix, - CodeActionIndex = CodeFixIndex.MySwitchingMethodAsync, - }.RunAsync(); - } - - [Fact] - public async Task InterfaceAccessByClassMethod_OffUIThread_ProducesDiagnostic() + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { CSVerify.Diagnostic(DescriptorAsync).WithSpan(17, 65, 17, 76).WithArguments("IVsShell", "JoinableTaskFactory.SwitchToMainThreadAsync") }, + FixedCode = fix, + CodeActionIndex = CodeFixIndex.MySwitchingMethodAsync, + }.RunAsync(); + } + + [Fact] + public async Task InterfaceAccessByClassMethod_OffUIThread_ProducesDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -1542,14 +1542,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(15, 14, 15, 26).WithArguments("IServiceProvider", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(15, 14, 15, 26).WithArguments("IServiceProvider", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task MainThreadRequiringTypes_SupportsExclusionFromWildcard() - { - var test = @" + [Fact] + public async Task MainThreadRequiringTypes_SupportsExclusionFromWildcard() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -1575,18 +1575,18 @@ interface SingleThreadedType { void Foo(); } interface FreeThreadedType { void Foo(); } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic(DescriptorSync).WithSpan(9, 41, 9, 44).WithArguments("SingleThreadedType", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(11, 42, 11, 45).WithArguments("SingleThreadedType", "Test.VerifyOnUIThread"), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task NegatedMethodOverridesMatchingWildcardType() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic(DescriptorSync).WithSpan(9, 41, 9, 44).WithArguments("SingleThreadedType", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(11, 42, 11, 45).WithArguments("SingleThreadedType", "Test.VerifyOnUIThread"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task NegatedMethodOverridesMatchingWildcardType() + { + var test = @" namespace TestNS2 { class A // this type inherits thread affinity from a wildcard match on TestNS2.* @@ -1603,14 +1603,14 @@ void Foo() } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(13, 18, 13, 41).WithArguments("A", "Test.VerifyOnUIThread"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(13, 18, 13, 41).WithArguments("A", "Test.VerifyOnUIThread"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task Properties() - { - var test = @" + [Fact] + public async Task Properties() + { + var test = @" class A { string UIPropertyName { get; set; } @@ -1622,18 +1622,18 @@ void Foo() } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic(DescriptorSync).WithSpan(8, 25, 8, 39).WithArguments("A", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(9, 14, 9, 28).WithArguments("A", "Test.VerifyOnUIThread"), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task Events() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 25, 8, 39).WithArguments("A", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(9, 14, 9, 28).WithArguments("A", "Test.VerifyOnUIThread"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task Events() + { + var test = @" namespace TestNS { interface SomeInterface @@ -1655,22 +1655,22 @@ void Test(TestNS.SomeInterface i) } } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic(DescriptorSync).WithSpan(18, 11, 18, 22).WithArguments("SomeInterface", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(19, 11, 19, 22).WithArguments("SomeInterface", "Test.VerifyOnUIThread"), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } - - /// - /// Field initializers should never have thread affinity since the thread cannot be enforced before the code is executed, - /// since initializers run before the user-defined constructor. - /// - [Fact] - public async Task FieldInitializers() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic(DescriptorSync).WithSpan(18, 11, 18, 22).WithArguments("SomeInterface", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(19, 11, 19, 22).WithArguments("SomeInterface", "Test.VerifyOnUIThread"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + /// + /// Field initializers should never have thread affinity since the thread cannot be enforced before the code is executed, + /// since initializers run before the user-defined constructor. + /// + [Fact] + public async Task FieldInitializers() + { + var test = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1679,14 +1679,14 @@ class A IVsSolution solution = Package.GetGlobalService(typeof(SVsSolution)) as IVsSolution; } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(7, 74, 7, 88).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyCodeFixAsync(test, expected, test); // the fix (if ever implemented) will be to move the initializer to a ctor, after a thread check. - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(7, 74, 7, 88).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyCodeFixAsync(test, expected, test); // the fix (if ever implemented) will be to move the initializer to a ctor, after a thread check. + } - [Fact] - public async Task StaticFieldInitializers() - { - var test = @" + [Fact] + public async Task StaticFieldInitializers() + { + var test = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1695,14 +1695,14 @@ class A static IVsSolution solution = Package.GetGlobalService(typeof(SVsSolution)) as IVsSolution; } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(7, 81, 7, 95).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await Verify.VerifyCodeFixAsync(test, expected, test); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(7, 81, 7, 95).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await CSVerify.VerifyCodeFixAsync(test, expected, test); + } - [Fact] - public async Task FieldAnonymousFunction() - { - var test = @" + [Fact] + public async Task FieldAnonymousFunction() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1712,7 +1712,7 @@ class A Func solutionFunc = () => Package.GetGlobalService(typeof(SVsSolution)) as IVsSolution; } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1726,19 +1726,19 @@ class A }; } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 90, 8, 104).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task OperatorOverload() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 90, 8, 104).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task OperatorOverload() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1754,7 +1754,7 @@ class A public static bool operator !=(A item1, A item2) => !(item1 == item2); } "; - var fix = @" + var fix = @" using System; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1771,19 +1771,19 @@ class A public static bool operator !=(A item1, A item2) => !(item1 == item2); } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(10, 63, 10, 77).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task ArgumentExpressionEntirelyMadeOfViolatingCast() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(10, 63, 10, 77).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task ArgumentExpressionEntirelyMadeOfViolatingCast() + { + var test = @" using Microsoft.VisualStudio.Shell.Interop; class A @@ -1796,7 +1796,7 @@ void Foo() { void Bar(IVsSolution solution) { } } "; - var fix = @" + var fix = @" using Microsoft.VisualStudio.Shell.Interop; class A @@ -1810,19 +1810,19 @@ void Foo() { void Bar(IVsSolution solution) { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 27).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - FixedCode = fix, - }.RunAsync(); - } - - [Fact] - public async Task AffinityPropagationExtendsToAllCallersOfSyncMethods() + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorSync).WithSpan(8, 13, 8, 27).WithArguments("IVsSolution", "Test.VerifyOnUIThread"); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + FixedCode = fix, + }.RunAsync(); + } + + [Fact] + public async Task AffinityPropagationExtendsToAllCallersOfSyncMethods() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1850,19 +1850,19 @@ async void SecondAsync() } } "; - var expected = new DiagnosticResult[] - { - Verify.Diagnostic(DescriptorSync).WithSpan(11, 9, 11, 12).WithArguments("Test.Foo", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorAsync).WithSpan(21, 9, 21, 14).WithArguments("Test.Reset", "JoinableTaskFactory.SwitchToMainThreadAsync"), - }; + var expected = new DiagnosticResult[] + { + CSVerify.Diagnostic(DescriptorSync).WithSpan(11, 9, 11, 12).WithArguments("Test.Foo", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorAsync).WithSpan(21, 9, 21, 14).WithArguments("Test.Reset", "JoinableTaskFactory.SwitchToMainThreadAsync"), + }; - await Verify.VerifyAnalyzerAsync(test, expected); - } + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AffinityPropagationDoesNotExtendBeyondProperAsyncSwitch() - { - var test = @" + [Fact] + public async Task AffinityPropagationDoesNotExtendBeyondProperAsyncSwitch() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -1890,17 +1890,17 @@ async void SecondAsync() } } "; - var expect = new DiagnosticResult[] - { - Verify.Diagnostic(DescriptorSync).WithSpan(11, 9, 11, 12).WithArguments("Test.Foo", "Test.VerifyOnUIThread"), - }; - await Verify.VerifyAnalyzerAsync(test, expect); - } - - [Fact] - public async Task StructMembers() + var expect = new DiagnosticResult[] { - var test = @" + CSVerify.Diagnostic(DescriptorSync).WithSpan(11, 9, 11, 12).WithArguments("Test.Foo", "Test.VerifyOnUIThread"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expect); + } + + [Fact] + public async Task StructMembers() + { + var test = @" namespace TestNS { struct SomeStruct @@ -1928,23 +1928,22 @@ static void Main() } } "; - var expect = new DiagnosticResult[] - { - Verify.Diagnostic(DescriptorSync).WithSpan(20, 31, 20, 42).WithArguments("SomeStruct", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(23, 16, 23, 20).WithArguments("SomeStruct", "Test.VerifyOnUIThread"), - Verify.Diagnostic(DescriptorSync).WithSpan(24, 29, 24, 33).WithArguments("SomeStruct", "Test.VerifyOnUIThread"), - }; - await Verify.VerifyAnalyzerAsync(test, expect); - } - - private static class CodeFixIndex + var expect = new DiagnosticResult[] { - public const int SwitchToMainThreadAsync = 0; - public const int ThrowIfNotOnUIThreadIndex0 = 0; - public const int ThrowIfNotOnUIThreadIndex1 = 1; - public const int VerifyOnUIThread = 0; - public const int NotThreadHelper = 0; - public const int MySwitchingMethodAsync = 0; - } + CSVerify.Diagnostic(DescriptorSync).WithSpan(20, 31, 20, 42).WithArguments("SomeStruct", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(23, 16, 23, 20).WithArguments("SomeStruct", "Test.VerifyOnUIThread"), + CSVerify.Diagnostic(DescriptorSync).WithSpan(24, 29, 24, 33).WithArguments("SomeStruct", "Test.VerifyOnUIThread"), + }; + await CSVerify.VerifyAnalyzerAsync(test, expect); + } + + private static class CodeFixIndex + { + public const int SwitchToMainThreadAsync = 0; + public const int ThrowIfNotOnUIThreadIndex0 = 0; + public const int ThrowIfNotOnUIThreadIndex1 = 1; + public const int VerifyOnUIThread = 0; + public const int NotThreadHelper = 0; + public const int MySwitchingMethodAsync = 0; } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs index a2d0da7ae..19ae3b689 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; - public class VSTHRD011UseAsyncLazyAnalyzerTests +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD011UseAsyncLazyAnalyzerTests +{ + [Fact] + public async Task ReportErrorOnLazyOfTConstructionInFieldValueTypeArg() { - [Fact] - public async Task ReportErrorOnLazyOfTConstructionInFieldValueTypeArg() - { - var test = @" + var test = @" using System; using System.Threading.Tasks; @@ -24,14 +24,14 @@ class Test { Lazy tInt = new Lazy(); } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportErrorOnLazyOfTConstructionInFieldRefTypeArg() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportErrorOnLazyOfTConstructionInFieldRefTypeArg() + { + var test = @" using System; using System.Threading.Tasks; @@ -39,14 +39,14 @@ class Test { Lazy> t3 = new {|#0:Lazy>|}(); } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportErrorOnLazyOfTConstructionInFieldNoTypeArg() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportErrorOnLazyOfTConstructionInFieldNoTypeArg() + { + var test = @" using System; using System.Threading.Tasks; @@ -54,14 +54,14 @@ class Test { Lazy t3 = new {|#0:Lazy|}(); } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task JTFRunInLazyValueFactory_Delegate() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task JTFRunInLazyValueFactory_Delegate() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -80,14 +80,14 @@ void Foo() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.SyncBlockInValueFactoryDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task JTFRunInLazyValueFactory_Lambda() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.SyncBlockInValueFactoryDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task JTFRunInLazyValueFactory_Lambda() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -106,14 +106,14 @@ void Foo() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.SyncBlockInValueFactoryDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task JTFRunAsyncInLazyValueFactory_Lambda() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.SyncBlockInValueFactoryDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task JTFRunAsyncInLazyValueFactory_Lambda() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -132,14 +132,14 @@ await jtf.RunAsync(async delegate { } } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task JTFRunInLazyValueFactory_MethodGroup() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task JTFRunInLazyValueFactory_MethodGroup() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -161,14 +161,14 @@ int LazyValueFactory() { } "; - // We can change this to verify a diagnostic is reported if we ever implement this. - await Verify.VerifyAnalyzerAsync(test); - } + // We can change this to verify a diagnostic is reported if we ever implement this. + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportErrorOnLazyOfTConstructionInLocalVariable() - { - var test = @" + [Fact] + public async Task ReportErrorOnLazyOfTConstructionInLocalVariable() + { + var test = @" using System; using System.Threading.Tasks; @@ -178,11 +178,10 @@ void Foo() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - private DiagnosticResult CreateDiagnostic(DiagnosticDescriptor descriptor, int location) - => Verify.Diagnostic(descriptor).WithLocation(location); + DiagnosticResult expected = this.CreateDiagnostic(AbstractVSTHRD011UseAsyncLazyAnalyzer.LazyOfTaskDescriptor, 0); + await CSVerify.VerifyAnalyzerAsync(test, expected); } + + private DiagnosticResult CreateDiagnostic(DiagnosticDescriptor descriptor, int location) + => CSVerify.Diagnostic(descriptor).WithLocation(location); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs index 2258e7ef7..ab361cc79 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD012SpecifyJtfWhereAllowedTests +public class VSTHRD012SpecifyJtfWhereAllowedTests +{ + [Fact] + public async Task SiblingMethodOverloads_WithoutJTF_GeneratesWarning() { - [Fact] - public async Task SiblingMethodOverloads_WithoutJTF_GeneratesWarning() - { - var test = @" + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -27,19 +27,19 @@ void G(JoinableTaskFactory jtf) { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, - }.RunAsync(); - } - - [Fact] - public async Task SiblingMethodOverloads_WithoutJTC_GeneratesWarning() + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, + }.RunAsync(); + } + + [Fact] + public async Task SiblingMethodOverloads_WithoutJTC_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -53,19 +53,19 @@ void G(JoinableTaskContext jtc) { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, - }.RunAsync(); - } - - [Fact] - public async Task SiblingMethodOverloadsWithOptionalAttribute_WithoutJTC_GeneratesNoWarning() + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, + }.RunAsync(); + } + + [Fact] + public async Task SiblingMethodOverloadsWithOptionalAttribute_WithoutJTC_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; using System.Runtime.InteropServices; using Microsoft.VisualStudio.Threading; @@ -80,13 +80,13 @@ void G([Optional] JoinableTaskContext jtc) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task SiblingMethodOverloadsWithObsoleteAttribute_WithoutJTC_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task SiblingMethodOverloadsWithObsoleteAttribute_WithoutJTC_GeneratesNoWarning() + { + var test = @" using System; using Microsoft.VisualStudio.Threading; @@ -101,13 +101,13 @@ void G(JoinableTaskContext jtc) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task SiblingCtorOverloads_WithoutJTF_GeneratesWarning() - { - var test = @" + [Fact] + public async Task SiblingCtorOverloads_WithoutJTF_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -123,19 +123,19 @@ internal Apple(JoinableTaskFactory jtf) { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, - }.RunAsync(); - } - - [Fact] - public async Task SiblingMethodOverloads_WithJTF_GeneratesNoWarning() + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, + }.RunAsync(); + } + + [Fact] + public async Task SiblingMethodOverloads_WithJTF_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -152,13 +152,13 @@ void G(JoinableTaskContext jtc) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncLazy_WithoutJTF_GeneratesWarning() - { - var test = @" + [Fact] + public async Task AsyncLazy_WithoutJTF_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -169,19 +169,19 @@ void F() { } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, - }.RunAsync(); - } - - [Fact] - public async Task AsyncLazy_WithNullJTF_GeneratesNoWarning() + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, + }.RunAsync(); + } + + [Fact] + public async Task AsyncLazy_WithNullJTF_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -192,13 +192,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncLazy_WithJTF_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task AsyncLazy_WithJTF_GeneratesNoWarning() + { + var test = @" using Microsoft.VisualStudio.Threading; using System.Threading.Tasks; @@ -211,13 +211,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JTF_RunAsync_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task JTF_RunAsync_GeneratesNoWarning() + { + var test = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; using System.Threading.Tasks; @@ -236,13 +236,13 @@ async delegate { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JTF_Ctor_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task JTF_Ctor_GeneratesNoWarning() + { + var test = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Threading; using System.Threading.Tasks; @@ -257,7 +257,6 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs index 3c642cdc0..ef848194c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD100AsyncVoidMethodAnalyzerTests +public class VSTHRD100AsyncVoidMethodAnalyzerTests +{ + [Fact] + public async Task ReportWarningOnAsyncVoidMethod() { - [Fact] - public async Task ReportWarningOnAsyncVoidMethod() - { - var test = @" + var test = @" using System; class Test { @@ -20,14 +20,14 @@ async void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(5, 16); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportWarningOnAsyncVoidLocalFunction() - { - var test = @" + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportWarningOnAsyncVoidLocalFunction() + { + var test = @" using System; class Test { @@ -38,14 +38,14 @@ async void F() {} } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 20); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportWarningOnAsyncVoidMethodSimilarToAsyncEventHandler() - { - var test = @" + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 20); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportWarningOnAsyncVoidMethodSimilarToAsyncEventHandler() + { + var test = @" using System; class Test { @@ -53,14 +53,14 @@ async void F(object sender, object e) { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(5, 16); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportWarningOnAsyncVoidEventHandlerSimilarToAsyncEventHandler2() - { - var test = @" + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportWarningOnAsyncVoidEventHandlerSimilarToAsyncEventHandler2() + { + var test = @" using System; class Test { @@ -68,14 +68,14 @@ async void F(string sender, EventArgs e) { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(5, 16); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task ReportWarningOnAsyncVoidEventHandler() - { - var test = @" + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task ReportWarningOnAsyncVoidEventHandler() + { + var test = @" using System; class Test { @@ -83,7 +83,7 @@ async void F(object sender, EventArgs e) { } } "; - var withFix = @" + var withFix = @" using System; class Test { @@ -91,14 +91,14 @@ async System.Threading.Tasks.Task F(object sender, EventArgs e) { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(5, 16); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } - - [Fact] - public async Task ReportWarningOnAsyncVoidEventHandlerWithMyEventArgs() - { - var test = @" + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } + + [Fact] + public async Task ReportWarningOnAsyncVoidEventHandlerWithMyEventArgs() + { + var test = @" using System; class Test { @@ -108,7 +108,7 @@ async void F(object sender, MyEventArgs e) { class MyEventArgs : EventArgs {} "; - var withFix = @" + var withFix = @" using System; class Test { @@ -118,8 +118,7 @@ async System.Threading.Tasks.Task F(object sender, MyEventArgs e) { class MyEventArgs : EventArgs {} "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(5, 16); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs index 7ea8520bf..071b8ed2f 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD100AsyncVoidMethodCodeFixTests +public class VSTHRD100AsyncVoidMethodCodeFixTests +{ + [Fact] + public async Task ApplyFixesOnAsyncVoidMethod() { - [Fact] - public async Task ApplyFixesOnAsyncVoidMethod() - { - var test = @" + var test = @" using System; class Test { @@ -21,7 +21,7 @@ async void F() { } } "; - var withFix = @" + var withFix = @" using System; class Test { @@ -30,14 +30,14 @@ async System.Threading.Tasks.Task F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(5, 16); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task ApplyFixesOnAsyncVoidMethod2() - { - var test = @" + [Fact] + public async Task ApplyFixesOnAsyncVoidMethod2() + { + var test = @" using System; using System.Threading.Tasks; @@ -47,7 +47,7 @@ async void F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -57,8 +57,7 @@ async Task F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(6, 16); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(6, 16); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs index 56034a259..ebd2415f2 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD101AsyncVoidLambdaAnalyzerTests +public class VSTHRD101AsyncVoidLambdaAnalyzerTests +{ + [Fact] + public async Task ReportWarningOnAsyncVoidLambda() { - [Fact] - public async Task ReportWarningOnAsyncVoidLambda() - { - var test = @" + var test = @" using System; class Test { @@ -26,14 +26,14 @@ void T() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningOnAsyncVoidLambdaWithOneParameter() - { - var test = @" + [Fact] + public async Task ReportWarningOnAsyncVoidLambdaWithOneParameter() + { + var test = @" using System; class Test { @@ -46,14 +46,14 @@ void T() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningOnAsyncVoidLambdaWithOneParameter2() - { - var test = @" + [Fact] + public async Task ReportWarningOnAsyncVoidLambdaWithOneParameter2() + { + var test = @" using System; class Test { @@ -66,14 +66,14 @@ void T() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningOnAsyncVoidAnonymousDelegateWithOneParameter() - { - var test = @" + [Fact] + public async Task ReportWarningOnAsyncVoidAnonymousDelegateWithOneParameter() + { + var test = @" using System; class Test { @@ -86,14 +86,14 @@ void T() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningOnAsyncVoidLambdaSetToVariable() - { - var test = @" + [Fact] + public async Task ReportWarningOnAsyncVoidLambdaSetToVariable() + { + var test = @" using System; class Test { @@ -102,14 +102,14 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningOnAsyncVoidLambdaWithOneParameterSetToVariable() - { - var test = @" + [Fact] + public async Task ReportWarningOnAsyncVoidLambdaWithOneParameterSetToVariable() + { + var test = @" using System; class Test { @@ -118,14 +118,14 @@ void F() { } } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ReportWarningOnAsyncVoidLambdaBeingUsedAsEventHandler() - { - var test = @" + [Fact] + public async Task ReportWarningOnAsyncVoidLambdaBeingUsedAsEventHandler() + { + var test = @" using System; class Test { @@ -137,12 +137,11 @@ void F() { class MyEventArgs : EventArgs {} } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic().WithLocation(0), - Verify.Diagnostic().WithLocation(1), - }; - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult[] expected = + { + CSVerify.Diagnostic().WithLocation(0), + CSVerify.Diagnostic().WithLocation(1), + }; + await CSVerify.VerifyAnalyzerAsync(test, expected); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs index 5605802c8..91486115d 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; - public class VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests +{ + [Fact] + public async Task JtfRunInPublicMethodsOfInternalType_ProducesDiagnostic() { - [Fact] - public async Task JtfRunInPublicMethodsOfInternalType_ProducesDiagnostic() - { - var test = @" + var test = @" using Microsoft.VisualStudio.Threading; class Test { @@ -24,14 +24,14 @@ public void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunInPublicMethodsOfPublicType_DoesNotProduceDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInPublicMethodsOfPublicType_DoesNotProduceDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; public class Test { @@ -42,13 +42,13 @@ public void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunInTaskReturningMethod_DoesNotProduceDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInTaskReturningMethod_DoesNotProduceDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -61,13 +61,13 @@ public Task F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunInProtectedMethodsOfInternalType_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInProtectedMethodsOfInternalType_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; class Test { @@ -78,14 +78,14 @@ protected void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunInProtectedMethodsOfPublicType_DoesNotProduceDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInProtectedMethodsOfPublicType_DoesNotProduceDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; public class Test { @@ -96,13 +96,13 @@ protected void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunInExplicitlyInternalMethods_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInExplicitlyInternalMethods_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; class Test { @@ -113,14 +113,14 @@ internal void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunInImplicitlyInternalMethods_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInImplicitlyInternalMethods_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; class Test { @@ -131,14 +131,14 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunAllowedInMainMethod_DoesNotProduceDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunAllowedInMainMethod_DoesNotProduceDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; class Program { @@ -149,20 +149,20 @@ static void Main() { } } "; - await new Verify.Test - { - TestState = - { - Sources = { test }, - OutputKind = OutputKind.ConsoleApplication, - }, - }.RunAsync(); - } - - [Fact] - public async Task JtfRunInExplicitInterfaceImplementationOfInternalInterface_ProducesDiagnostic() + await new CSVerify.Test { - var test = @" + TestState = + { + Sources = { test }, + OutputKind = OutputKind.ConsoleApplication, + }, + }.RunAsync(); + } + + [Fact] + public async Task JtfRunInExplicitInterfaceImplementationOfInternalInterface_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; interface IFoo @@ -178,14 +178,14 @@ void IFoo.F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(13, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(13, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunInImplicitInterfaceImplementationOfInternalInterface_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInImplicitInterfaceImplementationOfInternalInterface_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; interface IFoo @@ -201,14 +201,14 @@ public void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(13, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(13, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunInExplicitInterfaceImplementationOfPublicInterface_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInExplicitInterfaceImplementationOfPublicInterface_ProducesNoDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; public interface IFoo @@ -224,13 +224,13 @@ void IFoo.F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunInImplicitInterfaceImplementationOfPublicInterface_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInImplicitInterfaceImplementationOfPublicInterface_ProducesNoDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; public interface IFoo @@ -246,13 +246,13 @@ public void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunInPublicConstructorOfInternalType_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInPublicConstructorOfInternalType_ProducesDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; class Test { @@ -263,14 +263,14 @@ public Test() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(8, 13); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JtfRunInPublicConstructorOfPublicType_DoesNotProduceDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInPublicConstructorOfPublicType_DoesNotProduceDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Threading; public class Test { @@ -281,13 +281,13 @@ public Test() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunAndPropertyGetterInLambda_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunAndPropertyGetterInLambda_ProducesNoDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -304,13 +304,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunAndPropertyGetterInAnonymousDelegate_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunAndPropertyGetterInAnonymousDelegate_ProducesNoDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -327,13 +327,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact(Skip = "Unattainable given Roslyn analyzers are sync and find all references is async")] - public async Task JtfRunAndPropertyGetterPrivateMethodUsedAsDelegate_ProducesNoDiagnostic() - { - var test = @" + [Fact(Skip = "Unattainable given Roslyn analyzers are sync and find all references is async")] + public async Task JtfRunAndPropertyGetterPrivateMethodUsedAsDelegate_ProducesNoDiagnostic() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -354,13 +354,13 @@ void SomeSyncMethod(int x) { public void Advise(Action foo) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JtfRunInPrivateMethod__WithMultiMemberAccessExpression_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task JtfRunInPrivateMethod__WithMultiMemberAccessExpression_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -384,7 +384,6 @@ class Foo { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index d046cab77..b5221a695 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -1,20 +1,20 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using static Microsoft.VisualStudio.Threading.Analyzers.VSTHRD103UseAsyncOptionAnalyzer; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using static Microsoft.VisualStudio.Threading.Analyzers.VSTHRD103UseAsyncOptionAnalyzer; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; - public class VSTHRD103UseAsyncOptionAnalyzerTests +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD103UseAsyncOptionAnalyzerTests +{ + [Fact] + public async Task JTFRunInTaskReturningMethodGeneratesWarning() { - [Fact] - public async Task JTFRunInTaskReturningMethodGeneratesWarning() - { - var test = @" + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -30,7 +30,7 @@ void Run() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -44,14 +44,14 @@ async Task T() { void Run() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithLocation(8, 13).WithArguments("Run", "RunAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithLocation(8, 13).WithArguments("Run", "RunAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task JTFRunInTaskReturningMethod_WithExtraReturn_GeneratesWarning() - { - var test = @" + [Fact] + public async Task JTFRunInTaskReturningMethod_WithExtraReturn_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -71,7 +71,7 @@ void Run() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -89,14 +89,14 @@ async Task T() { void Run() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithLocation(8, 13).WithArguments("Run", "RunAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithLocation(8, 13).WithArguments("Run", "RunAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task JTFRunInAsyncMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task JTFRunInAsyncMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -111,7 +111,7 @@ void Run() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -125,14 +125,14 @@ async Task T() { void Run() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithLocation(8, 13).WithArguments("Run", "RunAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithLocation(8, 13).WithArguments("Run", "RunAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task JTFRunOfTInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task JTFRunOfTInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -148,7 +148,7 @@ void Run() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -163,14 +163,14 @@ void Run() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithLocation(8, 26).WithArguments("Run", "RunAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithLocation(8, 26).WithArguments("Run", "RunAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task JTJoinOfTInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task JTJoinOfTInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -187,7 +187,7 @@ void Join() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -203,14 +203,14 @@ void Join() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithLocation(9, 12).WithArguments("Join", "JoinAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithLocation(9, 12).WithArguments("Join", "JoinAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskWaitInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWaitInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -222,7 +222,7 @@ Task T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -232,14 +232,14 @@ async Task T() { } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 11).WithArguments("Wait"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 11).WithArguments("Wait"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskWaitInValueTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskWaitInValueTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -251,7 +251,7 @@ ValueTask T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -261,13 +261,13 @@ async ValueTask T() { } } "; - await Verify.VerifyCodeFixAsync(test, Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Wait"), withFix); - } + await CSVerify.VerifyCodeFixAsync(test, CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Wait"), withFix); + } - [Fact] - public async Task TaskWait_InIAsyncEnumerableAsyncMethod_ShouldReportWarning() - { - var test = @" + [Fact] + public async Task TaskWait_InIAsyncEnumerableAsyncMethod_ShouldReportWarning() + { + var test = @" using System; using System.Collections.Generic; using System.Linq; @@ -281,7 +281,7 @@ async IAsyncEnumerable FooAsync() } } "; - var withFix = @" + var withFix = @" using System; using System.Collections.Generic; using System.Linq; @@ -295,13 +295,13 @@ async IAsyncEnumerable FooAsync() } } "; - await Verify.VerifyCodeFixAsync(test, Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Wait"), withFix); - } + await CSVerify.VerifyCodeFixAsync(test, CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Wait"), withFix); + } - [Fact] - public async Task IVsTaskWaitInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task IVsTaskWaitInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -316,7 +316,7 @@ Task T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -329,14 +329,14 @@ async Task T() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(10, 11, 4, "Wait"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 11, 4, "Wait"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task IVsTaskGetResultInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task IVsTaskGetResultInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -351,7 +351,7 @@ Task T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -364,17 +364,17 @@ async Task T() { } } "; - DiagnosticResult expected = this.CreateDiagnostic(10, 27, 9, "GetResult"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = this.CreateDiagnostic(10, 27, 9, "GetResult"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - /// - /// Ensures we don't offer a code fix when the required using directive is not already present. - /// - [Fact] - public async Task IVsTaskGetResultInTaskReturningMethod_WithoutUsing_OffersNoFix() - { - var test = @" + /// + /// Ensures we don't offer a code fix when the required using directive is not already present. + /// + [Fact] + public async Task IVsTaskGetResultInTaskReturningMethod_WithoutUsing_OffersNoFix() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell.Interop; @@ -387,28 +387,28 @@ Task T() { } "; - string withFix = test; - //// var withFix = @" - //// using System.Threading.Tasks; - //// using Microsoft.VisualStudio.Shell; - //// using Microsoft.VisualStudio.Shell.Interop; - //// using Task = System.Threading.Tasks.Task; - //// - //// class Test { - //// async Task T() { - //// IVsTask t = null; - //// object result = await t; - //// } - //// } - //// "; - DiagnosticResult expected = this.CreateDiagnostic(8, 27, 9, "GetResult"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + string withFix = test; + //// var withFix = @" + //// using System.Threading.Tasks; + //// using Microsoft.VisualStudio.Shell; + //// using Microsoft.VisualStudio.Shell.Interop; + //// using Task = System.Threading.Tasks.Task; + //// + //// class Test { + //// async Task T() { + //// IVsTask t = null; + //// object result = await t; + //// } + //// } + //// "; + DiagnosticResult expected = this.CreateDiagnostic(8, 27, 9, "GetResult"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -420,7 +420,7 @@ Task T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -432,14 +432,14 @@ async Task T() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 24).WithArguments("Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 24).WithArguments("Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_FixPreservesCall() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_FixPreservesCall() + { + var test = @" using System.Threading.Tasks; class Test { @@ -455,7 +455,7 @@ static class Assert { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -470,14 +470,14 @@ static class Assert { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 26).WithArguments("Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 26).WithArguments("Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_FixRewritesCorrectExpression() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_FixRewritesCorrectExpression() + { + var test = @" using System; using System.Threading.Tasks; @@ -488,7 +488,7 @@ async Task T() { } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -499,14 +499,14 @@ async Task T() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 45).WithArguments("Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 45).WithArguments("Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningAnonymousMethodWithinSyncMethod_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningAnonymousMethodWithinSyncMethod_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -521,7 +521,7 @@ void T() { } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -536,14 +536,14 @@ void T() { } "; - DiagnosticResult expected = this.CreateDiagnostic(9, 28, 6, "Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = this.CreateDiagnostic(9, 28, 6, "Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningSimpleLambdaWithinSyncMethod_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningSimpleLambdaWithinSyncMethod_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -558,7 +558,7 @@ void T() { } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -573,14 +573,14 @@ void T() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(9, 28, 9, 34).WithArguments("Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(9, 28, 9, 34).WithArguments("Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningSimpleLambdaExpressionWithinSyncMethod_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningSimpleLambdaExpressionWithinSyncMethod_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -592,7 +592,7 @@ void T() { } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -604,14 +604,14 @@ void T() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(8, 57, 8, 63).WithArguments("Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(8, 57, 8, 63).WithArguments("Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningParentheticalLambdaWithinSyncMethod_GeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningParentheticalLambdaWithinSyncMethod_GeneratesWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -626,7 +626,7 @@ void T() { } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -641,14 +641,14 @@ void T() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(9, 28, 9, 34).WithArguments("Result"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(9, 28, 9, 34).WithArguments("Result"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskOfTResultInTaskReturningMethodAnonymousDelegate_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task TaskOfTResultInTaskReturningMethodAnonymousDelegate_GeneratesNoWarning() + { + var test = @" using System; using System.Threading.Tasks; @@ -661,13 +661,13 @@ Task T() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task TaskGetAwaiterGetResultInTaskReturningMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task TaskGetAwaiterGetResultInTaskReturningMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -679,7 +679,7 @@ Task T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -690,14 +690,14 @@ async Task T() { } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 24).WithArguments("GetResult"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 24).WithArguments("GetResult"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionExistsInSameTypeGeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionExistsInSameTypeGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -711,7 +711,7 @@ internal static void Foo(int x, int y) { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -724,14 +724,14 @@ internal static void Foo(int x, int y) { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(6, 9, 6, 12).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(6, 9, 6, 12).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionIsObsolete_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionIsObsolete_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -746,13 +746,13 @@ internal static void Foo(int x, int y) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionIsPartlyObsolete_GeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionIsPartlyObsolete_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -769,7 +769,7 @@ internal static void Foo(int x, double y) { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -785,14 +785,14 @@ internal static void Foo(int x, double y) { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(6, 9, 6, 12).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(6, 9, 6, 12).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionExistsInSubExpressionGeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionExistsInSubExpressionGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -806,7 +806,7 @@ Task T() { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -819,14 +819,14 @@ async Task T() { } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(6, 17, 6, 20).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(6, 17, 6, 20).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionExistsInOtherTypeGeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionExistsInOtherTypeGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -842,7 +842,7 @@ internal static void Foo() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -857,14 +857,14 @@ internal static void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(6, 14, 6, 17).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(6, 14, 6, 17).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionExistsAsPrivateInOtherTypeGeneratesNoWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionExistsAsPrivateInOtherTypeGeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -880,13 +880,13 @@ internal static void Foo() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionExistsInOtherBaseTypeGeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionExistsInOtherBaseTypeGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -906,7 +906,7 @@ internal void Foo() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -925,14 +925,14 @@ internal void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(7, 11, 7, 14).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(7, 11, 7, 14).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationWhereAsyncOptionExistsInExtensionMethodGeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationWhereAsyncOptionExistsInExtensionMethodGeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -952,7 +952,7 @@ static class FruitUtils { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -971,14 +971,14 @@ static class FruitUtils { } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(7, 11, 7, 14).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(7, 11, 7, 14).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationUsingStaticGeneratesWarning() - { - var test = @" + [Fact] + public async Task SyncInvocationUsingStaticGeneratesWarning() + { + var test = @" using System.Threading.Tasks; using static FruitUtils; @@ -995,7 +995,7 @@ internal static void Foo() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using static FruitUtils; @@ -1011,14 +1011,14 @@ internal static void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(7, 9, 7, 12).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(7, 9, 7, 12).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task SyncInvocationUsingStaticGeneratesNoWarningAcrossTypes() - { - var test = @" + [Fact] + public async Task SyncInvocationUsingStaticGeneratesNoWarningAcrossTypes() + { + var test = @" using System.Threading.Tasks; using static FruitUtils; using static PlateUtils; @@ -1042,13 +1042,13 @@ static class PlateUtils { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AwaitingAsyncMethodWithoutSuffixProducesNoWarningWhereSuffixVersionExists() - { - var test = @" + [Fact] + public async Task AwaitingAsyncMethodWithoutSuffixProducesNoWarningWhereSuffixVersionExists() + { + var test = @" using System.Threading.Tasks; class Test { @@ -1061,20 +1061,20 @@ async Task BarAsync() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - /// - /// Verifies that when method invocations and member access happens in properties - /// (which can never be async), nothing bad happens. - /// - /// - /// This may like a trivially simple case. But guess why we had to add a test for it? (it failed). - /// - [Fact] - public async Task NoDiagnosticAndNoExceptionForProperties() - { - var test = @" + /// + /// Verifies that when method invocations and member access happens in properties + /// (which can never be async), nothing bad happens. + /// + /// + /// This may like a trivially simple case. But guess why we had to add a test for it? (it failed). + /// + [Fact] + public async Task NoDiagnosticAndNoExceptionForProperties() + { + var test = @" using System.Threading.Tasks; class Test { @@ -1083,13 +1083,13 @@ class Test { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task GenericMethodName() - { - var test = @" + [Fact] + public async Task GenericMethodName() + { + var test = @" using System.Threading.Tasks; using static FruitUtils; @@ -1106,7 +1106,7 @@ internal static void Foo() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using static FruitUtils; @@ -1122,14 +1122,14 @@ internal static void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(7, 9, 7, 17).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(7, 9, 7, 17).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task AsyncAlternative_CodeFixRespectsTrivia() - { - var test = @" + [Fact] + public async Task AsyncAlternative_CodeFixRespectsTrivia() + { + var test = @" using System; using System.Threading.Tasks; @@ -1147,7 +1147,7 @@ async Task DoWorkAsync() } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -1165,14 +1165,14 @@ async Task DoWorkAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic(Descriptor).WithSpan(15, 9, 15, 12).WithArguments("Foo", "FooAsync"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithSpan(15, 9, 15, 12).WithArguments("Foo", "FooAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task AwaitRatherThanWait_CodeFixRespectsTrivia() - { - var test = @" + [Fact] + public async Task AwaitRatherThanWait_CodeFixRespectsTrivia() + { + var test = @" using System; using System.Threading.Tasks; @@ -1190,7 +1190,7 @@ async Task DoWorkAsync() } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; @@ -1208,14 +1208,14 @@ async Task DoWorkAsync() } } "; - DiagnosticResult expected = Verify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(15, 34, 15, 38).WithArguments("Wait"); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(15, 34, 15, 38).WithArguments("Wait"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task XunitThrowAsyncNotSuggestedInAsyncTestMethod() - { - var test = @" + [Fact] + public async Task XunitThrowAsyncNotSuggestedInAsyncTestMethod() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -1231,13 +1231,13 @@ void Throws(Action action) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotSuggestAsyncAlternativeWhenItIsSelf() - { - var test = @" + [Fact] + public async Task DoNotSuggestAsyncAlternativeWhenItIsSelf() + { + var test = @" using System; using System.Threading.Tasks; @@ -1256,13 +1256,13 @@ public void CallMain() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotSuggestAsyncAlternativeWhenItReturnsVoid() - { - var test = @" + [Fact] + public async Task DoNotSuggestAsyncAlternativeWhenItReturnsVoid() + { + var test = @" using System; using System.Threading.Tasks; @@ -1278,13 +1278,12 @@ Task MethodAsync() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName) - => Verify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(line, column, line, column + length).WithArguments(methodName); + private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName) + => CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(line, column, line, column + length).WithArguments(methodName); - private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName, string alternativeMethodName) - => Verify.Diagnostic(Descriptor).WithSpan(line, column, line, column + length).WithArguments(methodName, alternativeMethodName); - } + private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName, string alternativeMethodName) + => CSVerify.Diagnostic(Descriptor).WithSpan(line, column, line, column + length).WithArguments(methodName, alternativeMethodName); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs index 7aefaa5d2..faa1f1660 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD104OfferAsyncOptionAnalyzerTests +public class VSTHRD104OfferAsyncOptionAnalyzerTests +{ + [Fact] + public async Task JTFRunFromPublicVoidMethod_GeneratesWarning() { - [Fact] - public async Task JTFRunFromPublicVoidMethod_GeneratesWarning() - { - var test = @" + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -27,14 +27,14 @@ public void Foo() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 13, 9, 16); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 13, 9, 16); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task JTFRunFromInternalVoidMethod_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task JTFRunFromInternalVoidMethod_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -49,13 +49,13 @@ internal void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JTFRunFromPublicVoidMethod_GeneratesNoWarningWhenAsyncMethodPresent() - { - var test = @" + [Fact] + public async Task JTFRunFromPublicVoidMethod_GeneratesNoWarningWhenAsyncMethodPresent() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -74,13 +74,13 @@ public async Task FooAsync() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task JTFRunFromPublicVoidMethod_GeneratesWarningWhenInternalAsyncMethodPresent() - { - var test = @" + [Fact] + public async Task JTFRunFromPublicVoidMethod_GeneratesWarningWhenInternalAsyncMethodPresent() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -99,8 +99,7 @@ internal async Task FooAsync() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 13, 9, 16); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 13, 9, 16); + await CSVerify.VerifyAnalyzerAsync(test, expected); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs index 4a8a2287a..faa14decb 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests +public class VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests +{ + [Fact] + public async Task ContinueWith_NoTaskScheduler_GeneratesWarning() { - [Fact] - public async Task ContinueWith_NoTaskScheduler_GeneratesWarning() - { - var test = @" + var test = @" using System.Threading.Tasks; class Test { @@ -24,19 +24,19 @@ void F() { } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, - }.RunAsync(); - } - - [Fact] - public async Task StartNew_NoTaskScheduler_GeneratesWarning() + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, + }.RunAsync(); + } + + [Fact] + public async Task StartNew_NoTaskScheduler_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -46,19 +46,19 @@ void F() { } "; - DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await new Verify.Test - { - TestCode = test, - ExpectedDiagnostics = { expected }, - TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, - }.RunAsync(); - } - - [Fact] - public async Task StartNew_NoTaskScheduler_GeneratesNoWarningOnCustomTaskFactory() + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await new CSVerify.Test { - var test = @" + TestCode = test, + ExpectedDiagnostics = { expected }, + TestBehaviors = TestBehaviors.SkipGeneratedCodeCheck, + }.RunAsync(); + } + + [Fact] + public async Task StartNew_NoTaskScheduler_GeneratesNoWarningOnCustomTaskFactory() + { + var test = @" using System.Threading.Tasks; class Test { @@ -70,13 +70,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ContinueWith_WithTaskScheduler_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task ContinueWith_WithTaskScheduler_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -88,13 +88,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task StartNew_WithTaskScheduler_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task StartNew_WithTaskScheduler_GeneratesNoWarning() + { + var test = @" using System.Threading; using System.Threading.Tasks; @@ -106,7 +106,6 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs index 275df1763..87ac9993e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests +public class VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests +{ + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectly() { - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectly() - { - var test = @" + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -30,13 +30,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningIfAsyncEventHandlerIsInvokedByInvokeAsync() - { - var test = @" + [Fact] + public async Task DoNotReportWarningIfAsyncEventHandlerIsInvokedByInvokeAsync() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -49,13 +49,13 @@ static void InvokeAsync(AsyncEventHandler handler2, AsyncEventHandler } }} "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyViaInvoke() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyViaInvoke() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -73,13 +73,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAsDelegateViaInvoke() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAsDelegateViaInvoke() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -97,13 +97,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyAreLocalVariables() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyAreLocalVariables() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -121,13 +121,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyAreProperties() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyAreProperties() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -145,13 +145,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerViaInvocationList() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerViaInvocationList() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -169,13 +169,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerAsDelegate() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerAsDelegate() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -193,13 +193,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeLazyAsyncEventHandlerAsDelegate() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeLazyAsyncEventHandlerAsDelegate() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -217,13 +217,13 @@ void F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyArePassedAsParameters() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyArePassedAsParameters() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -237,13 +237,13 @@ void F(AsyncEventHandler handler1, AsyncEventHandler handler2, Asy } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyArePassedAsArray() - { - var test = @" + [Fact] + public async Task ReportWarningIfInvokeAsyncEventHandlerDirectlyAndTheyArePassedAsArray() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -257,13 +257,13 @@ void F(AsyncEventHandler[] handlers1, AsyncEventHandler[] handlers } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningIfInvokeAsyncEventHandlerUsingInvokeAsync() - { - var test = @" + [Fact] + public async Task DoNotReportWarningIfInvokeAsyncEventHandlerUsingInvokeAsync() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -280,13 +280,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningIfNonInvokeMethodsAreUsed() - { - var test = @" + [Fact] + public async Task DoNotReportWarningIfNonInvokeMethodsAreUsed() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -303,13 +303,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningIfInvokeAsyncEventHandlerUsingInvokeAsyncAndTheyArePassedAsParameters() - { - var test = @" + [Fact] + public async Task DoNotReportWarningIfInvokeAsyncEventHandlerUsingInvokeAsyncAndTheyArePassedAsParameters() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -322,13 +322,13 @@ void F(AsyncEventHandler handler1, AsyncEventHandler handler2, Asy } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task DoNotReportWarningIfInvokeAsyncEventHandlerUsingInvokeAsyncAndTheyArePassedAsArray() - { - var test = @" + [Fact] + public async Task DoNotReportWarningIfInvokeAsyncEventHandlerUsingInvokeAsyncAndTheyArePassedAsArray() + { + var test = @" using System; using System.Linq; using Microsoft.VisualStudio.Threading; @@ -341,7 +341,6 @@ void F(AsyncEventHandler[] handlers1, AsyncEventHandler[] handlers } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs index f2ac58783..11966d8b3 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests +public class VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests +{ + [Fact] + public async Task UsingTaskOfTReturningMethodInSyncMethod_GeneratesError() { - [Fact] - public async Task UsingTaskOfTReturningMethodInSyncMethod_GeneratesError() - { - var test = @" + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -25,7 +25,7 @@ void F() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -39,14 +39,14 @@ async Task FAsync() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 16, 8, 32); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task UsingTaskOfTReturningMethodInIntReturningMethod_GeneratesError() - { - var test = @" + [Fact] + public async Task UsingTaskOfTReturningMethodInIntReturningMethod_GeneratesError() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -61,7 +61,7 @@ int F() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -77,14 +77,14 @@ async Task FAsync() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 16, 8, 32); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task UsingTaskOfTReturningMethodInTaskReturningMethod_GeneratesError() - { - var test = @" + [Fact] + public async Task UsingTaskOfTReturningMethodInTaskReturningMethod_GeneratesError() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -99,7 +99,7 @@ Task F() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -113,14 +113,14 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 16, 8, 32); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task UsingTaskOfTReturningMethodInAsyncMethod_GeneratesError() - { - var test = @" + [Fact] + public async Task UsingTaskOfTReturningMethodInAsyncMethod_GeneratesError() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -133,7 +133,7 @@ async Task F() { } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -147,14 +147,14 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(8, 16, 8, 32); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task UsingTaskOfTCompoundExpressionInAsyncMethod_GeneratesError() - { - var test = @" + [Fact] + public async Task UsingTaskOfTCompoundExpressionInAsyncMethod_GeneratesError() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -168,7 +168,7 @@ async Task F() { } } "; - var withFix = @" + var withFix = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -183,14 +183,14 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 16, 9, 24); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 24); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task UsingAwaitTaskOfTReturningMethod_GeneratesNoError() - { - var test = @" + [Fact] + public async Task UsingAwaitTaskOfTReturningMethod_GeneratesNoError() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -204,13 +204,13 @@ async Task F() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task UsingAwaitTaskOfTask_GeneratesError() - { - var test = @" + [Fact] + public async Task UsingAwaitTaskOfTask_GeneratesError() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -225,14 +225,14 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 16, 9, 27); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 27); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task UsingTaskOfTLocal_GeneratesError() - { - var test = @" + [Fact] + public async Task UsingTaskOfTLocal_GeneratesError() + { + var test = @" using System; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -247,8 +247,7 @@ void F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithSpan(9, 16, 9, 19); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 19); + await CSVerify.VerifyAnalyzerAsync(test, expected); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs index 0ede3bae0..758afb9d0 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD108AssertThreadRequirementUnconditionallyTests +public class VSTHRD108AssertThreadRequirementUnconditionallyTests +{ + [Fact] + public async Task AffinityAssertion_Unconditional_ProducesNoDiagnostic() { - [Fact] - public async Task AffinityAssertion_Unconditional_ProducesNoDiagnostic() - { - var test = @" + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -22,13 +22,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AffinityAssertion_WithinIfBlock_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinIfBlock_ProducesDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -43,14 +43,14 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AffinityAssertion_WithinDelegateHostedWithinIfBlock_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinDelegateHostedWithinIfBlock_ProducesNoDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -65,13 +65,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AffinityAssertion_WithinIfBlockWithinDelegate_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinIfBlockWithinDelegate_ProducesDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -89,14 +89,14 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AffinityAssertion_WithinWhileBlock_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinWhileBlock_ProducesDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -111,14 +111,14 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AffinityAssertion_WithinForBlock_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinForBlock_ProducesDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -133,14 +133,14 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AffinityAssertion_WithinDoWhileBlock_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinDoWhileBlock_ProducesNoDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -154,13 +154,13 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AffinityAssertion_WithinDebugAssert_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinDebugAssert_ProducesDiagnostic() + { + var test = @" using System; using System.Diagnostics; using Microsoft.VisualStudio.Shell; @@ -171,14 +171,14 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AffinityAssertion_WithinAnyConditionalMethodArg_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task AffinityAssertion_WithinAnyConditionalMethodArg_ProducesDiagnostic() + { + var test = @" using System; using System.Diagnostics; using Microsoft.VisualStudio.Shell; @@ -195,14 +195,14 @@ private void ThrowIfNot(bool expr) } } "; - CodeAnalysis.Testing.DiagnosticResult expected = Verify.Diagnostic().WithLocation(0); - await Verify.VerifyAnalyzerAsync(test, expected); - } + CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ThreadCheckWithinIfExpression_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task ThreadCheckWithinIfExpression_ProducesNoDiagnostic() + { + var test = @" using System; using Microsoft.VisualStudio.Shell; @@ -216,7 +216,6 @@ void F() { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs index 9118480b2..af9ec2064 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs @@ -1,18 +1,18 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests +public class VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests +{ + [Fact] + public async Task AsyncMethodAsserts_GeneratesDiagnostic() { - [Fact] - public async Task AsyncMethodAsserts_GeneratesDiagnostic() - { - var test = @" + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -25,7 +25,7 @@ async Task FooAsync() { } "; - var fix = @" + var fix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -38,13 +38,13 @@ async Task FooAsync() { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task AsyncMethodAsserts_CodeFixReusesCancellationToken() - { - var test = @" + [Fact] + public async Task AsyncMethodAsserts_CodeFixReusesCancellationToken() + { + var test = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -58,7 +58,7 @@ async Task FooAsync(CancellationToken ct) { } "; - var fix = @" + var fix = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -72,13 +72,13 @@ async Task FooAsync(CancellationToken ct) { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task TaskReturningNonAsyncMethodAsserts_GeneratesDiagnostic() - { - var test = @" + [Fact] + public async Task TaskReturningNonAsyncMethodAsserts_GeneratesDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -91,7 +91,7 @@ Task FooAsync() { } "; - var fix = @" + var fix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -104,13 +104,13 @@ async Task FooAsync() { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task VoidNonAsyncMethodAsserts_GeneratesNoDiagnostic() - { - var test = @" + [Fact] + public async Task VoidNonAsyncMethodAsserts_GeneratesNoDiagnostic() + { + var test = @" using Microsoft.VisualStudio.Shell; class Test { @@ -120,13 +120,13 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task VoidAnonymousFunctionInsideAsyncMethod_GeneratesNoDiagnostic() - { - var test = @" + [Fact] + public async Task VoidAnonymousFunctionInsideAsyncMethod_GeneratesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -140,13 +140,13 @@ await Task.Run(delegate { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AsyncAnonymousFunctionInsideVoidMethod_GeneratesDiagnostic() - { - var test = @" + [Fact] + public async Task AsyncAnonymousFunctionInsideVoidMethod_GeneratesDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -161,7 +161,7 @@ void Foo() { } "; - var fix = @" + var fix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -176,13 +176,13 @@ void Foo() { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task AsyncAnonymousFunctionInsideVoidMethod_CodeFixReusesCancellationToken() - { - var test = @" + [Fact] + public async Task AsyncAnonymousFunctionInsideVoidMethod_CodeFixReusesCancellationToken() + { + var test = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -198,7 +198,7 @@ void Foo(CancellationToken ct) { } "; - var fix = @" + var fix = @" using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; @@ -214,13 +214,13 @@ void Foo(CancellationToken ct) { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task TaskReturningLambdaInsideVoidMethod_GeneratesDiagnostic() - { - var test = @" + [Fact] + public async Task TaskReturningLambdaInsideVoidMethod_GeneratesDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -235,7 +235,7 @@ void Foo() { } "; - var fix = @" + var fix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -250,13 +250,13 @@ void Foo() { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task TaskReturningLambdaInsideVoidMethod_NoTypeArg_GeneratesDiagnostic() - { - var test = @" + [Fact] + public async Task TaskReturningLambdaInsideVoidMethod_NoTypeArg_GeneratesDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -271,7 +271,7 @@ void Foo() { } "; - var fix = @" + var fix = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -286,13 +286,13 @@ void Foo() { } "; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task IntReturningLambdaInsideVoidMethod_GeneratesNoDiagnostic() - { - var test = @" + [Fact] + public async Task IntReturningLambdaInsideVoidMethod_GeneratesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Shell; using Task = System.Threading.Tasks.Task; @@ -307,7 +307,6 @@ void Foo() { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index 224d392bc..4f8f990a4 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests +public class VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests +{ + [Fact] + public async Task SyncMethod_ProducesDiagnostic() { - [Fact] - public async Task SyncMethod_ProducesDiagnostic() - { - var test = @" + var test = @" using System.Threading.Tasks; class Test { @@ -26,14 +26,14 @@ void Foo() } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 9, 8); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 9, 8); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task SyncDelegateWithinAsyncMethod_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task SyncDelegateWithinAsyncMethod_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -48,14 +48,14 @@ await Task.Run(delegate { } "; - DiagnosticResult expected = this.CreateDiagnostic(8, 13, 8); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(8, 13, 8); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AssignToLocal_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task AssignToLocal_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -68,13 +68,13 @@ void Foo() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ForgetExtension_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task ForgetExtension_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; @@ -88,13 +88,13 @@ void Foo() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task AssignToField_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task AssignToField_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -109,13 +109,13 @@ void Foo() } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task PassToOtherMethod_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task PassToOtherMethod_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -130,13 +130,13 @@ void OtherMethod(Task t) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ReturnStatement_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task ReturnStatement_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -151,13 +151,13 @@ void OtherMethod(Task t) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ContinueWith_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task ContinueWith_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -172,14 +172,14 @@ void OtherMethod(Task t) { } } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, 12); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 20, 12); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task AsyncMethod_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task AsyncMethod_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -192,13 +192,13 @@ async Task FooAsync() } "; - await Verify.VerifyAnalyzerAsync(test); // CS4014 should already take care of this case. - } + await CSVerify.VerifyAnalyzerAsync(test); // CS4014 should already take care of this case. + } - [Fact] - public async Task CallToNonExistentMethod() - { - var test = @" + [Fact] + public async Task CallToNonExistentMethod() + { + var test = @" using System; class Test { @@ -210,14 +210,14 @@ void Bar() { } } "; - DiagnosticResult expected = DiagnosticResult.CompilerError("CS0103").WithLocation(6, 9).WithArguments("a"); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = DiagnosticResult.CompilerError("CS0103").WithLocation(6, 9).WithArguments("a"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ConfigureAwait_ProducesDiagnostics() - { - var test = @" + [Fact] + public async Task ConfigureAwait_ProducesDiagnostics() + { + var test = @" using System.Threading.Tasks; class Test { @@ -230,14 +230,14 @@ void Foo() } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ConfigureAwaitGenerics_ProducesDiagnostics() - { - var test = @" + [Fact] + public async Task ConfigureAwaitGenerics_ProducesDiagnostics() + { + var test = @" using System.Threading.Tasks; class Test { @@ -250,14 +250,14 @@ void Foo() } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task CustomAwaitable_ProducesDiagnostics() - { - var test = @" + [Fact] + public async Task CustomAwaitable_ProducesDiagnostics() + { + var test = @" using System; using System.Runtime.CompilerServices; @@ -288,14 +288,14 @@ public void GetResult() } } "; - DiagnosticResult expected = this.CreateDiagnostic(8, 9, 8); - await Verify.VerifyAnalyzerAsync(test, expected); - } - - [Fact] - public async Task CustomAwaitableLikeType_ProducesNoDiagnostic() - { - var test = @" + DiagnosticResult expected = this.CreateDiagnostic(8, 9, 8); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task CustomAwaitableLikeType_ProducesNoDiagnostic() + { + var test = @" using System; class Test { @@ -320,13 +320,13 @@ class NotAwaitable } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task SyncMethodWithValueTask_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task SyncMethodWithValueTask_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -339,14 +339,14 @@ void Foo() } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 9, 8); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 9, 8); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ConfigureAwaitValueTask_ProducesDiagnostics() - { - var test = @" + [Fact] + public async Task ConfigureAwaitValueTask_ProducesDiagnostics() + { + var test = @" using System.Threading.Tasks; class Test { @@ -359,14 +359,14 @@ void Foo() } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ConditionalAccess_ProducesDiagnostic() - { - var test = @" + [Fact] + public async Task ConditionalAccess_ProducesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -379,14 +379,14 @@ void Foo(Test? tester) } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 17, 8); - await Verify.VerifyAnalyzerAsync(test, expected); - } + DiagnosticResult expected = this.CreateDiagnostic(7, 17, 8); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } - [Fact] - public async Task ConditionalAccessAwaited_ProducesNoDiagnostic() - { - var test = @" + [Fact] + public async Task ConditionalAccessAwaited_ProducesNoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -399,10 +399,9 @@ async Task Foo(Test? tester) } "; - await Verify.VerifyAnalyzerAsync(test); - } - - private DiagnosticResult CreateDiagnostic(int line, int column, int length) - => Verify.Diagnostic().WithSpan(line, column, line, column + length); + await CSVerify.VerifyAnalyzerAsync(test); } + + private DiagnosticResult CreateDiagnostic(int line, int column, int length) + => CSVerify.Diagnostic().WithSpan(line, column, line, column + length); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs index a36fe10f9..ffcc93e75 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; - public class VSTHRD111UseConfigureAwaitAnalyzerTests +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD111UseConfigureAwaitAnalyzerTests +{ + [Fact] + public async Task AwaitOnTask_NoSuffix_GeneratesDiagnostic() { - [Fact] - public async Task AwaitOnTask_NoSuffix_GeneratesDiagnostic() - { - var test = @" + var test = @" using System.Threading.Tasks; class Test { @@ -25,7 +25,7 @@ async Task Foo() Task BarAsync() => default; } "; - var fixFalse = @" + var fixFalse = @" using System.Threading.Tasks; class Test { @@ -37,7 +37,7 @@ async Task Foo() Task BarAsync() => default; } "; - var fixTrue = @" + var fixTrue = @" using System.Threading.Tasks; class Test { @@ -50,24 +50,24 @@ async Task Foo() } "; - await new Verify.Test - { - TestCode = test, - FixedCode = fixFalse, - CodeActionEquivalenceKey = false.ToString(), - }.RunAsync(); - await new Verify.Test - { - TestCode = test, - FixedCode = fixTrue, - CodeActionEquivalenceKey = true.ToString(), - }.RunAsync(); - } - - [Fact] - public async Task AwaitOnValueTask_NoSuffix_GeneratesDiagnostic() + await new CSVerify.Test + { + TestCode = test, + FixedCode = fixFalse, + CodeActionEquivalenceKey = false.ToString(), + }.RunAsync(); + await new CSVerify.Test { - var test = @" + TestCode = test, + FixedCode = fixTrue, + CodeActionEquivalenceKey = true.ToString(), + }.RunAsync(); + } + + [Fact] + public async Task AwaitOnValueTask_NoSuffix_GeneratesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -79,7 +79,7 @@ async Task Foo() ValueTask BarAsync() => default; } "; - var fixFalse = @" + var fixFalse = @" using System.Threading.Tasks; class Test { @@ -91,7 +91,7 @@ async Task Foo() ValueTask BarAsync() => default; } "; - var fixTrue = @" + var fixTrue = @" using System.Threading.Tasks; class Test { @@ -104,24 +104,24 @@ async Task Foo() } "; - await new Verify.Test - { - TestCode = test, - FixedCode = fixFalse, - CodeActionEquivalenceKey = false.ToString(), - }.RunAsync(); - await new Verify.Test - { - TestCode = test, - FixedCode = fixTrue, - CodeActionEquivalenceKey = true.ToString(), - }.RunAsync(); - } - - [Fact] - public async Task AwaitOnTaskOfT_NoSuffix_GeneratesDiagnostic() + await new CSVerify.Test + { + TestCode = test, + FixedCode = fixFalse, + CodeActionEquivalenceKey = false.ToString(), + }.RunAsync(); + await new CSVerify.Test { - var test = @" + TestCode = test, + FixedCode = fixTrue, + CodeActionEquivalenceKey = true.ToString(), + }.RunAsync(); + } + + [Fact] + public async Task AwaitOnTaskOfT_NoSuffix_GeneratesDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test { @@ -133,7 +133,7 @@ async Task Foo() Task BarAsync() => default; } "; - var fixFalse = @" + var fixFalse = @" using System.Threading.Tasks; class Test { @@ -145,7 +145,7 @@ async Task Foo() Task BarAsync() => default; } "; - var fixTrue = @" + var fixTrue = @" using System.Threading.Tasks; class Test { @@ -158,18 +158,17 @@ async Task Foo() } "; - await new Verify.Test - { - TestCode = test, - FixedCode = fixFalse, - CodeActionEquivalenceKey = false.ToString(), - }.RunAsync(); - await new Verify.Test - { - TestCode = test, - FixedCode = fixTrue, - CodeActionEquivalenceKey = true.ToString(), - }.RunAsync(); - } + await new CSVerify.Test + { + TestCode = test, + FixedCode = fixFalse, + CodeActionEquivalenceKey = false.ToString(), + }.RunAsync(); + await new CSVerify.Test + { + TestCode = test, + FixedCode = fixTrue, + CodeActionEquivalenceKey = true.ToString(), + }.RunAsync(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs index 66e23e6f1..2962a15a6 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs @@ -1,31 +1,31 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using VBVerify = VisualBasicCodeFixVerifier; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; +using VBVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; - public class VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests - { - private const string Preamble = @" +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests +{ + private const string Preamble = @" using System.Threading.Tasks; using BclAsyncDisposable = System.IAsyncDisposable; using VsThreadingAsyncDisposable = Microsoft.VisualStudio.Threading.IAsyncDisposable; "; - private const string VBPreamble = @" + private const string VBPreamble = @" Imports System.Threading.Tasks Imports BclAsyncDisposable = System.IAsyncDisposable Imports VsThreadingAsyncDisposable = Microsoft.VisualStudio.Threading.IAsyncDisposable "; - [Fact] - public async Task ClassImplementsBoth() - { - var test = Preamble + @" + [Fact] + public async Task ClassImplementsBoth() + { + var test = Preamble + @" class Test : BclAsyncDisposable, VsThreadingAsyncDisposable { Task Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() @@ -38,25 +38,25 @@ Task Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() ValueTask System.IAsyncDisposable.DisposeAsync() => default; }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ClassImplementsOnlyBclType() - { - var test = Preamble + @" + [Fact] + public async Task ClassImplementsOnlyBclType() + { + var test = Preamble + @" class Test : BclAsyncDisposable { ValueTask System.IAsyncDisposable.DisposeAsync() => default; }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task ClassImplementsOnlyVsThreadingType() - { - var test = Preamble + @" + [Fact] + public async Task ClassImplementsOnlyVsThreadingType() + { + var test = Preamble + @" class Test : [|VsThreadingAsyncDisposable|] { public async Task DisposeAsync() @@ -65,7 +65,7 @@ public async Task DisposeAsync() } }"; - var fix = Preamble + @" + var fix = Preamble + @" class Test : VsThreadingAsyncDisposable, BclAsyncDisposable { public async Task DisposeAsync() @@ -79,13 +79,13 @@ ValueTask BclAsyncDisposable.DisposeAsync() } }"; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo() - { - var test = Preamble + @" + [Fact] + public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo() + { + var test = Preamble + @" class Test : object, [|VsThreadingAsyncDisposable|] { public async Task DisposeAsync() @@ -94,7 +94,7 @@ public async Task DisposeAsync() } }"; - var fix = Preamble + @" + var fix = Preamble + @" class Test : object, VsThreadingAsyncDisposable, BclAsyncDisposable { public async Task DisposeAsync() @@ -108,18 +108,18 @@ ValueTask BclAsyncDisposable.DisposeAsync() } }"; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo_PartialClass() - { - var source1 = Preamble + @" + [Fact] + public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo_PartialClass() + { + var source1 = Preamble + @" partial class Test { }"; - var source2 = Preamble + @" + var source2 = Preamble + @" partial class Test : [|VsThreadingAsyncDisposable|] { public async Task DisposeAsync() @@ -128,12 +128,12 @@ public async Task DisposeAsync() } }"; - var fix1 = Preamble + @" + var fix1 = Preamble + @" partial class Test { }"; - var fix2 = Preamble + @" + var fix2 = Preamble + @" partial class Test : VsThreadingAsyncDisposable, BclAsyncDisposable { public async Task DisposeAsync() @@ -147,19 +147,19 @@ ValueTask BclAsyncDisposable.DisposeAsync() } }"; - var test = new Verify.Test - { - TestState = { Sources = { source1, source2 } }, - FixedState = { Sources = { fix1, fix2 } }, - }; + var test = new CSVerify.Test + { + TestState = { Sources = { source1, source2 } }, + FixedState = { Sources = { fix1, fix2 } }, + }; - await test.RunAsync(); - } + await test.RunAsync(); + } - [Fact] - public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo_VB() + { + var test = VBPreamble + @" Class Test Inherits Object Implements [|VsThreadingAsyncDisposable|] @@ -169,7 +169,7 @@ Await Task.Yield End Function End Class"; - var fix = VBPreamble + @" + var fix = VBPreamble + @" Class Test Inherits Object Implements VsThreadingAsyncDisposable, BclAsyncDisposable @@ -183,17 +183,17 @@ Return New ValueTask(DisposeAsync()) End Function End Class"; - await VBVerify.VerifyCodeFixAsync(test, fix); - } + await VBVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo_PartialClass_VB() - { - var source1 = VBPreamble + @" + [Fact] + public async Task ClassImplementsOnlyVsThreadingType_WithBaseClassToo_PartialClass_VB() + { + var source1 = VBPreamble + @" Partial Class Test End Class"; - var source2 = VBPreamble + @" + var source2 = VBPreamble + @" Partial Class Test Inherits Object Implements [|VsThreadingAsyncDisposable|] @@ -203,11 +203,11 @@ Await Task.Yield End Function End Class"; - var fix1 = VBPreamble + @" + var fix1 = VBPreamble + @" Partial Class Test End Class"; - var fix2 = VBPreamble + @" + var fix2 = VBPreamble + @" Partial Class Test Inherits Object Implements VsThreadingAsyncDisposable, BclAsyncDisposable @@ -221,19 +221,19 @@ Return New ValueTask(DisposeAsync()) End Function End Class"; - var test = new VBVerify.Test - { - TestState = { Sources = { source1, source2 } }, - FixedState = { Sources = { fix1, fix2 } }, - }; + var test = new VBVerify.Test + { + TestState = { Sources = { source1, source2 } }, + FixedState = { Sources = { fix1, fix2 } }, + }; - await test.RunAsync(); - } + await test.RunAsync(); + } - [Fact] - public async Task StructImplementsBoth() - { - var test = Preamble + @" + [Fact] + public async Task StructImplementsBoth() + { + var test = Preamble + @" struct Test : BclAsyncDisposable, VsThreadingAsyncDisposable { public Task DisposeAsync() @@ -249,25 +249,25 @@ ValueTask BclAsyncDisposable.DisposeAsync() } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task StructImplementsOnlyBclType() - { - var test = Preamble + @" + [Fact] + public async Task StructImplementsOnlyBclType() + { + var test = Preamble + @" struct Test : BclAsyncDisposable { ValueTask System.IAsyncDisposable.DisposeAsync() => default; }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task StructImplementsOnlyVsThreadingType() - { - var test = Preamble + @" + [Fact] + public async Task StructImplementsOnlyVsThreadingType() + { + var test = Preamble + @" struct Test : [|VsThreadingAsyncDisposable|] { public async Task DisposeAsync() @@ -276,7 +276,7 @@ public async Task DisposeAsync() } }"; - var fix = Preamble + @" + var fix = Preamble + @" struct Test : VsThreadingAsyncDisposable, BclAsyncDisposable { public async Task DisposeAsync() @@ -290,13 +290,13 @@ ValueTask BclAsyncDisposable.DisposeAsync() } }"; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task StructImplementsOnlyVsThreadingType_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task StructImplementsOnlyVsThreadingType_VB() + { + var test = VBPreamble + @" Public Structure Test Implements [|VsThreadingAsyncDisposable|] @@ -305,7 +305,7 @@ Await Task.Yield End Function End Structure"; - var fix = VBPreamble + @" + var fix = VBPreamble + @" Public Structure Test Implements VsThreadingAsyncDisposable, BclAsyncDisposable @@ -318,24 +318,24 @@ Return New ValueTask(DisposeAsync()) End Function End Structure"; - await VBVerify.VerifyCodeFixAsync(test, fix); - } + await VBVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task InterfaceImplementsBoth() - { - var test = Preamble + @" + [Fact] + public async Task InterfaceImplementsBoth() + { + var test = Preamble + @" interface Test : BclAsyncDisposable, VsThreadingAsyncDisposable { }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InterfaceImplementsBoth_AcrossTypeHierarchy() - { - var test = Preamble + @" + [Fact] + public async Task InterfaceImplementsBoth_AcrossTypeHierarchy() + { + var test = Preamble + @" interface Test1 : BclAsyncDisposable { } @@ -345,50 +345,49 @@ interface Test2 : Test1, VsThreadingAsyncDisposable } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InterfaceImplementsOnlyBclType() - { - var test = Preamble + @" + [Fact] + public async Task InterfaceImplementsOnlyBclType() + { + var test = Preamble + @" interface Test : BclAsyncDisposable { }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task InterfaceImplementsOnlyVsThreadingType() - { - var test = Preamble + @" + [Fact] + public async Task InterfaceImplementsOnlyVsThreadingType() + { + var test = Preamble + @" interface Test : [|VsThreadingAsyncDisposable|] { }"; - var fix = Preamble + @" + var fix = Preamble + @" interface Test : VsThreadingAsyncDisposable, BclAsyncDisposable { }"; - await Verify.VerifyCodeFixAsync(test, fix); - } + await CSVerify.VerifyCodeFixAsync(test, fix); + } - [Fact] - public async Task InterfaceImplementsOnlyVsThreadingType_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task InterfaceImplementsOnlyVsThreadingType_VB() + { + var test = VBPreamble + @" Interface ITest Inherits [|VsThreadingAsyncDisposable|] End Interface"; - var fix = VBPreamble + @" + var fix = VBPreamble + @" Interface ITest Inherits VsThreadingAsyncDisposable, BclAsyncDisposable End Interface"; - await VBVerify.VerifyCodeFixAsync(test, fix); - } + await VBVerify.VerifyCodeFixAsync(test, fix); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs index eea14d0e1..65e921445 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs @@ -1,31 +1,31 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using VBVerify = VisualBasicCodeFixVerifier; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; +using VBVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; - public class VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests - { - private const string Preamble = @" +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; + +public class VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests +{ + private const string Preamble = @" using System.Threading.Tasks; using BclAsyncDisposable = System.IAsyncDisposable; using VsThreadingAsyncDisposable = Microsoft.VisualStudio.Threading.IAsyncDisposable; "; - private const string VBPreamble = @" + private const string VBPreamble = @" Imports System.Threading.Tasks Imports BclAsyncDisposable = System.IAsyncDisposable Imports VsThreadingAsyncDisposable = Microsoft.VisualStudio.Threading.IAsyncDisposable "; - [Fact] - public async Task MethodChecksBoth_WithIsCast() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksBoth_WithIsCast() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { if (o is BclAsyncDisposable bcl) { @@ -37,13 +37,13 @@ async Task CheckAndDispose(object o) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBoth_WithIsCheck() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksBoth_WithIsCheck() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { if (o is BclAsyncDisposable) { @@ -55,13 +55,13 @@ async Task CheckAndDispose(object o) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksVsThreadingOnly_WithIsCheck() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksVsThreadingOnly_WithIsCheck() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { if ([|o is VsThreadingAsyncDisposable|]) { @@ -70,13 +70,13 @@ async Task CheckAndDispose(object o) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksVsThreadingOnly_WithIsCast() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksVsThreadingOnly_WithIsCast() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { if ([|o is VsThreadingAsyncDisposable vs|]) { @@ -85,13 +85,13 @@ async Task CheckAndDispose(object o) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact(Skip = "Too complex to support")] - public async Task MethodChecksVsThreadingOnly_WithIsCast_MultiBlock() - { - var test = Preamble + @" + [Fact(Skip = "Too complex to support")] + public async Task MethodChecksVsThreadingOnly_WithIsCast_MultiBlock() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o, bool flag) { if (flag) { @@ -109,13 +109,13 @@ async Task CheckAndDispose(object o, bool flag) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBclOnly_WithIsCast() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksBclOnly_WithIsCast() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { if (o is BclAsyncDisposable bcl) { @@ -124,13 +124,13 @@ async Task CheckAndDispose(object o) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBoth_WithAsCast() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksBoth_WithAsCast() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { await ((o as BclAsyncDisposable)?.DisposeAsync() ?? default); @@ -138,26 +138,26 @@ async Task CheckAndDispose(object o) { } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksVsThreadingOnly_WithAsCast() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksVsThreadingOnly_WithAsCast() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { await (([|o as VsThreadingAsyncDisposable|])?.DisposeAsync() ?? Task.CompletedTask); } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBoth_WithTryCast_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task MethodChecksBoth_WithTryCast_VB() + { + var test = VBPreamble + @" Class Test Async Function CheckAndDispose(o) As Task Dim bcl = TryCast(o, BclAsyncDisposable) @@ -171,13 +171,13 @@ End If End Function End Class"; - await VBVerify.VerifyAnalyzerAsync(test); - } + await VBVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksVsThreadingOnly_WithTypeOf_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task MethodChecksVsThreadingOnly_WithTypeOf_VB() + { + var test = VBPreamble + @" Class Test Async Function CheckAndDispose(o) As Task If ([|TypeOf o Is VsThreadingAsyncDisposable|]) Then @@ -185,13 +185,13 @@ End If End Function End Class"; - await VBVerify.VerifyAnalyzerAsync(test); - } + await VBVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksVsThreadingOnly_WithTryCast_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task MethodChecksVsThreadingOnly_WithTryCast_VB() + { + var test = VBPreamble + @" Class Test Async Function CheckAndDispose(o) As Task Dim vs = [|TryCast(o, VsThreadingAsyncDisposable)|] @@ -201,13 +201,13 @@ End If End Function End Class"; - await VBVerify.VerifyAnalyzerAsync(test); - } + await VBVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksVsThreadingOnly_WithCType_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task MethodChecksVsThreadingOnly_WithCType_VB() + { + var test = VBPreamble + @" Class Test Async Function CheckAndDispose(o) As Task Dim vs = [|CType(o, VsThreadingAsyncDisposable)|] @@ -215,13 +215,13 @@ Await vs.DisposeAsync End Function End Class"; - await VBVerify.VerifyAnalyzerAsync(test); - } + await VBVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBoth_WithCType_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task MethodChecksBoth_WithCType_VB() + { + var test = VBPreamble + @" Class Test Async Function CheckAndDispose(o) As Task If (TypeOf o Is VsThreadingAsyncDisposable) Then @@ -234,13 +234,13 @@ End If End Function End Class"; - await VBVerify.VerifyAnalyzerAsync(test); - } + await VBVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBoth_WithDirectCast_VB() - { - var test = VBPreamble + @" + [Fact] + public async Task MethodChecksBoth_WithDirectCast_VB() + { + var test = VBPreamble + @" Class Test Async Function CheckAndDispose(o) As Task If (TypeOf o Is VsThreadingAsyncDisposable) Then @@ -253,20 +253,19 @@ End If End Function End Class"; - await VBVerify.VerifyAnalyzerAsync(test); - } + await VBVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task MethodChecksBclOnly_WithAsCast() - { - var test = Preamble + @" + [Fact] + public async Task MethodChecksBclOnly_WithAsCast() + { + var test = Preamble + @" class Test { async Task CheckAndDispose(object o) { await ((o as BclAsyncDisposable)?.DisposeAsync() ?? default); } }"; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs index 784c305da..649d66c38 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using VerifyCS = CSharpCodeFixVerifier; - using VerifyVB = VisualBasicCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; +using VerifyVB = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD114AvoidReturningNullTaskAnalyzerTests +public class VSTHRD114AvoidReturningNullTaskAnalyzerTests +{ + [Fact] + public async Task TaskOfTReturnsNull_Diagnostic() { - [Fact] - public async Task TaskOfTReturnsNull_Diagnostic() - { - var csharpTest = @" + var csharpTest = @" using System.Threading.Tasks; class Test @@ -24,12 +24,12 @@ public Task GetTaskObj() } } "; - await new VerifyCS.Test - { - TestCode = csharpTest, - }.RunAsync(); + await new CSVerify.Test + { + TestCode = csharpTest, + }.RunAsync(); - var vbTest = @" + var vbTest = @" Imports System.Threading.Tasks Friend Class Test @@ -38,16 +38,16 @@ Return [|Nothing|] End Function End Class "; - await new VerifyVB.Test - { - TestCode = vbTest, - }.RunAsync(); - } - - [Fact] - public async Task TaskReturnsNull_Diagnostic() + await new VerifyVB.Test { - var csharpTest = @" + TestCode = vbTest, + }.RunAsync(); + } + + [Fact] + public async Task TaskReturnsNull_Diagnostic() + { + var csharpTest = @" using System.Threading.Tasks; class Test @@ -58,12 +58,12 @@ public Task GetTask() } } "; - await new VerifyCS.Test - { - TestCode = csharpTest, - }.RunAsync(); + await new CSVerify.Test + { + TestCode = csharpTest, + }.RunAsync(); - var vbTest = @" + var vbTest = @" Imports System.Threading.Tasks Friend Class Test @@ -72,16 +72,16 @@ Return [|Nothing|] End Function End Class "; - await new VerifyVB.Test - { - TestCode = vbTest, - }.RunAsync(); - } - - [Fact] - public async Task TaskArrowReturnsNull_Diagnostic() + await new VerifyVB.Test { - var test = @" + TestCode = vbTest, + }.RunAsync(); + } + + [Fact] + public async Task TaskArrowReturnsNull_Diagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -89,16 +89,16 @@ class Test public Task GetTask() => [|null|]; } "; - await new VerifyCS.Test - { - TestCode = test, - }.RunAsync(); - } - - [Fact] - public async Task AsyncReturnsNull_NoDiagnostic() + await new CSVerify.Test { - var csharpTest = @" + TestCode = test, + }.RunAsync(); + } + + [Fact] + public async Task AsyncReturnsNull_NoDiagnostic() + { + var csharpTest = @" using System.Threading.Tasks; class Test @@ -109,12 +109,12 @@ public async Task GetTaskObj() } } "; - await new VerifyCS.Test - { - TestCode = csharpTest, - }.RunAsync(); + await new CSVerify.Test + { + TestCode = csharpTest, + }.RunAsync(); - var vbTest = @" + var vbTest = @" Imports System.Threading.Tasks Friend Class Test @@ -123,16 +123,16 @@ Return Nothing End Function End Class "; - await new VerifyVB.Test - { - TestCode = vbTest, - }.RunAsync(); - } - - [Fact] - public async Task VariableIsNullAndReturned_NoDiagnostic_FalseNegative() + await new VerifyVB.Test { - var test = @" + TestCode = vbTest, + }.RunAsync(); + } + + [Fact] + public async Task VariableIsNullAndReturned_NoDiagnostic_FalseNegative() + { + var test = @" using System.Threading.Tasks; class Test @@ -144,16 +144,16 @@ public Task GetTaskObj() } } "; - await new VerifyCS.Test - { - TestCode = test, - }.RunAsync(); - } - - [Fact] - public async Task NullInTernary_NoDiagnostic_FalseNegative() + await new CSVerify.Test { - var test = @" + TestCode = test, + }.RunAsync(); + } + + [Fact] + public async Task NullInTernary_NoDiagnostic_FalseNegative() + { + var test = @" using System.Threading.Tasks; class Test @@ -164,16 +164,16 @@ public Task GetTaskObj(bool b) } } "; - await new VerifyCS.Test - { - TestCode = test, - }.RunAsync(); - } - - [Fact] - public async Task MultipleFaultyReturns_MultipleDiagnostics() + await new CSVerify.Test { - var test = @" + TestCode = test, + }.RunAsync(); + } + + [Fact] + public async Task MultipleFaultyReturns_MultipleDiagnostics() + { + var test = @" using System.Threading.Tasks; class Test @@ -189,16 +189,16 @@ public Task GetTaskObj(string s) } } "; - await new VerifyCS.Test - { - TestCode = test, - }.RunAsync(); - } - - [Fact] - public async Task AsyncAnonymousDelegateReturnsNull_NoDiagnostic() + await new CSVerify.Test { - var test = @" + TestCode = test, + }.RunAsync(); + } + + [Fact] + public async Task AsyncAnonymousDelegateReturnsNull_NoDiagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -212,16 +212,16 @@ public Task Foo() } } "; - await new VerifyCS.Test - { - TestCode = test, - }.RunAsync(); - } - - [Fact] - public async Task NonAsyncAnonymousDelegateReturnsNull_Diagnostic() + await new CSVerify.Test { - var test = @" + TestCode = test, + }.RunAsync(); + } + + [Fact] + public async Task NonAsyncAnonymousDelegateReturnsNull_Diagnostic() + { + var test = @" using System.Threading.Tasks; class Test @@ -235,16 +235,16 @@ public void Foo() } } "; - await new VerifyCS.Test - { - TestCode = test, - }.RunAsync(); - } - - [Fact] - public async Task LocalFunctionNonAsyncReturnsNull_Diagnostic() + await new CSVerify.Test { - var csharpTest = @" + TestCode = test, + }.RunAsync(); + } + + [Fact] + public async Task LocalFunctionNonAsyncReturnsNull_Diagnostic() + { + var csharpTest = @" using System.Threading.Tasks; class Test @@ -258,16 +258,16 @@ Task GetTaskObj() } } "; - await new VerifyCS.Test - { - TestCode = csharpTest, - }.RunAsync(); - } - - [Fact] - public async Task LocalFunctionAsyncReturnsNull_NoDiagnostic() + await new CSVerify.Test { - var csharpTest = @" + TestCode = csharpTest, + }.RunAsync(); + } + + [Fact] + public async Task LocalFunctionAsyncReturnsNull_NoDiagnostic() + { + var csharpTest = @" using System.Threading.Tasks; class Test @@ -281,16 +281,16 @@ async Task GetTaskObj() } } "; - await new VerifyCS.Test - { - TestCode = csharpTest, - }.RunAsync(); - } - - [Fact] - public async Task ReturnNullableTask_NoDiagnostic() + await new CSVerify.Test { - var csharpTest = @" + TestCode = csharpTest, + }.RunAsync(); + } + + [Fact] + public async Task ReturnNullableTask_NoDiagnostic() + { + var csharpTest = @" using System; using System.Threading.Tasks; @@ -320,10 +320,9 @@ public void LocalFunc() } } "; - await new VerifyCS.Test - { - TestCode = csharpTest, - }.RunAsync(); - } + await new CSVerify.Test + { + TestCode = csharpTest, + }.RunAsync(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs index 7a052bc85..2edb0cac5 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs @@ -1,19 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Xunit; - using VerifyCS = CSharpCodeFixVerifier; - using VerifyVB = VisualBasicCodeFixVerifier; +using System.Threading.Tasks; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; +using VerifyVB = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; + +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD114AvoidReturningNullTaskCodeFixTests +public class VSTHRD114AvoidReturningNullTaskCodeFixTests +{ + [Fact] + public async Task MethodTaskOfTReturnsNull() { - [Fact] - public async Task MethodTaskOfTReturnsNull() - { - var test = @" + var test = @" class Test { public System.Threading.Tasks.Task GetTaskObj() @@ -22,7 +22,7 @@ public System.Threading.Tasks.Task GetTaskObj() } }"; - var withFix = @" + var withFix = @" class Test { public System.Threading.Tasks.Task GetTaskObj() @@ -31,33 +31,33 @@ public System.Threading.Tasks.Task GetTaskObj() } }"; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task MethodTaskOfTReturnsNothing_VB() - { - var test = @" + [Fact] + public async Task MethodTaskOfTReturnsNothing_VB() + { + var test = @" Class Test Function GetTaskObj As System.Threading.Tasks.Task(Of object) Return [|Nothing|] End Function End Class"; - var withFix = @" + var withFix = @" Class Test Function GetTaskObj As System.Threading.Tasks.Task(Of object) Return System.Threading.Tasks.Task.FromResult(Of Object)(Nothing) End Function End Class"; - await VerifyVB.VerifyCodeFixAsync(test, withFix); - } + await VerifyVB.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task MethodTaskReturnsNull() - { - var test = @" + [Fact] + public async Task MethodTaskReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -68,7 +68,7 @@ public Task GetTask() } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -80,13 +80,13 @@ public Task GetTask() } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task ArrowedMethodTaskReturnsNull() - { - var test = @" + [Fact] + public async Task ArrowedMethodTaskReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -94,7 +94,7 @@ class Test public Task GetTask() => [|null|]; } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -103,13 +103,13 @@ class Test } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task ArrowedMethodTaskOfTReturnsNull() - { - var test = @" + [Fact] + public async Task ArrowedMethodTaskOfTReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -117,7 +117,7 @@ class Test public Task GetTaskObj() => [|null|]; } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -126,13 +126,13 @@ class Test } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task MultipleFaultyReturns() - { - var test = @" + [Fact] + public async Task MultipleFaultyReturns() + { + var test = @" using System.Threading.Tasks; class Test @@ -148,7 +148,7 @@ public Task GetTaskObj(string s) } } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -165,13 +165,13 @@ public Task GetTaskObj(string s) } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task MethodComplexTaskOfTReturnsNull() - { - var test = @" + [Fact] + public async Task MethodComplexTaskOfTReturnsNull() + { + var test = @" using System.Collections.Generic; using System.Threading.Tasks; @@ -183,7 +183,7 @@ public Task>> GetTaskObj() } }"; - var withFix = @" + var withFix = @" using System.Collections.Generic; using System.Threading.Tasks; @@ -195,13 +195,13 @@ public Task>> GetTaskObj() } }"; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task AnonymousDelegateTaskOfTReturnsNull() - { - var test = @" + [Fact] + public async Task AnonymousDelegateTaskOfTReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -216,7 +216,7 @@ public void Foo() } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -230,13 +230,13 @@ public void Foo() } } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - [Fact] - public async Task LambdaTaskOfTReturnsNull() - { - var test = @" + [Fact] + public async Task LambdaTaskOfTReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -251,7 +251,7 @@ public void Foo() } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -265,12 +265,13 @@ public void Foo() } } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - public async Task AnonymousDelegateTaskReturnsNull() - { - var test = @" + [Fact] + public async Task AnonymousDelegateTaskReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -285,7 +286,7 @@ public void Foo() } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -299,12 +300,13 @@ public void Foo() } } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); + } - public async Task LambdaTaskReturnsNull() - { - var test = @" + [Fact] + public async Task LambdaTaskReturnsNull() + { + var test = @" using System.Threading.Tasks; class Test @@ -319,7 +321,7 @@ public void Foo() } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test @@ -333,7 +335,6 @@ public void Foo() } } "; - await VerifyCS.VerifyCodeFixAsync(test, withFix); - } + await CSVerify.VerifyCodeFixAsync(test, withFix); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs index b741445d4..f7ea5d252 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs @@ -1,24 +1,24 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests -{ - using System.Threading.Tasks; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Testing; - using Xunit; - using Verify = CSharpCodeFixVerifier; +using System.Threading.Tasks; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Testing; +using Xunit; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; - public class VSTHRD200UseAsyncNamingConventionAnalyzerTests - { - private static readonly DiagnosticDescriptor AddSuffixDescriptor = VSTHRD200UseAsyncNamingConventionAnalyzer.AddAsyncDescriptor; +namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - private static readonly DiagnosticDescriptor RemoveSuffixDescriptor = VSTHRD200UseAsyncNamingConventionAnalyzer.RemoveAsyncDescriptor; +public class VSTHRD200UseAsyncNamingConventionAnalyzerTests +{ + private static readonly DiagnosticDescriptor AddSuffixDescriptor = VSTHRD200UseAsyncNamingConventionAnalyzer.AddAsyncDescriptor; - [Fact] - public async Task TaskReturningMethodWithoutSuffix_GeneratesWarning() - { - var test = @" + private static readonly DiagnosticDescriptor RemoveSuffixDescriptor = VSTHRD200UseAsyncNamingConventionAnalyzer.RemoveAsyncDescriptor; + + [Fact] + public async Task TaskReturningMethodWithoutSuffix_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -26,7 +26,7 @@ class Test { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -34,18 +34,18 @@ class Test { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - /// - /// Verifies that methods that return awaitable types (but without associated async method builders) - /// are allowed to include or omit the Async suffix. - /// - [Fact] - public async Task IVsTaskReturningMethod_WithGetAwaiter_GeneratesNoWarning() - { - var test = @" + /// + /// Verifies that methods that return awaitable types (but without associated async method builders) + /// are allowed to include or omit the Async suffix. + /// + [Fact] + public async Task IVsTaskReturningMethod_WithGetAwaiter_GeneratesNoWarning() + { + var test = @" using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; @@ -55,13 +55,13 @@ class Test { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task IVsTaskReturningMethodWithSuffix_NoGetAwaiter_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task IVsTaskReturningMethodWithSuffix_NoGetAwaiter_GeneratesNoWarning() + { + var test = @" using Microsoft.VisualStudio.Shell.Interop; class Test { @@ -70,13 +70,13 @@ class Test { } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task HomemadeAwaitableReturningMethodWithSuffix_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task HomemadeAwaitableReturningMethodWithSuffix_GeneratesNoWarning() + { + var test = @" using System; class Test { @@ -95,13 +95,13 @@ public void OnCompleted(Action a) { } } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task BadAwaitableReturningMethodWithSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task BadAwaitableReturningMethodWithSuffix_GeneratesWarning() + { + var test = @" class Test { string T() => null; string T2Async() => null; @@ -112,7 +112,7 @@ static class AwaitExtensions { } "; - var withFix = @" + var withFix = @" class Test { string T() => null; string T2() => null; @@ -123,14 +123,14 @@ static class AwaitExtensions { } "; - DiagnosticResult expected = Verify.Diagnostic(RemoveSuffixDescriptor).WithSpan(4, 12, 4, 19); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(RemoveSuffixDescriptor).WithSpan(4, 12, 4, 19); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task ValueTaskReturningMethodWithoutSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task ValueTaskReturningMethodWithoutSuffix_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -138,7 +138,7 @@ class Test { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -146,14 +146,14 @@ class Test { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 15, 5, 18); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 15, 5, 18); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task ValueTaskOfTReturningMethodWithoutSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task ValueTaskOfTReturningMethodWithoutSuffix_GeneratesWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -161,7 +161,7 @@ class Test { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -169,14 +169,14 @@ class Test { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 20, 5, 23); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 20, 5, 23); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task IAsyncEnumerableOfTReturningMethodWithoutSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task IAsyncEnumerableOfTReturningMethodWithoutSuffix_GeneratesWarning() + { + var test = @" using System.Collections.Generic; class Test { @@ -184,7 +184,7 @@ class Test { } "; - var withFix = @" + var withFix = @" using System.Collections.Generic; class Test { @@ -192,14 +192,14 @@ class Test { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 27, 5, 30); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 27, 5, 30); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task HomemadeIAsyncEnumerableOfTReturningMethodWithoutSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task HomemadeIAsyncEnumerableOfTReturningMethodWithoutSuffix_GeneratesWarning() + { + var test = @" using System.Collections.Generic; using System.Threading; @@ -212,7 +212,7 @@ class Test { } "; - var withFix = @" + var withFix = @" using System.Collections.Generic; using System.Threading; @@ -225,14 +225,14 @@ class Test { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(10, 28, 10, 31); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(10, 28, 10, 31); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskReturningMainMethodWithoutSuffix_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task TaskReturningMainMethodWithoutSuffix_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -243,20 +243,20 @@ static async Task Main() } "; - await new Verify.Test - { - TestState = - { - Sources = { test }, - OutputKind = OutputKind.ConsoleApplication, - }, - }.RunAsync(); - } - - [Fact] - public async Task TaskReturningMainMethodWithArgsWithoutSuffix_GeneratesNoWarning() + await new CSVerify.Test { - var test = @" + TestState = + { + Sources = { test }, + OutputKind = OutputKind.ConsoleApplication, + }, + }.RunAsync(); + } + + [Fact] + public async Task TaskReturningMainMethodWithArgsWithoutSuffix_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -267,20 +267,20 @@ static async Task Main(string[] args) } "; - await new Verify.Test - { - TestState = - { - Sources = { test }, - OutputKind = OutputKind.ConsoleApplication, - }, - }.RunAsync(); - } - - [Fact] - public async Task TaskOfIntReturningMainMethodWithoutSuffix_GeneratesNoWarning() + await new CSVerify.Test { - var test = @" + TestState = + { + Sources = { test }, + OutputKind = OutputKind.ConsoleApplication, + }, + }.RunAsync(); + } + + [Fact] + public async Task TaskOfIntReturningMainMethodWithoutSuffix_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { @@ -292,20 +292,20 @@ static async Task Main() } "; - await new Verify.Test - { - TestState = - { - Sources = { test }, - OutputKind = OutputKind.ConsoleApplication, - }, - }.RunAsync(); - } - - [Fact] - public async Task TaskReturningMethodWithoutSuffix_CodeFixUpdatesCallers() + await new CSVerify.Test { - var test = @" + TestState = + { + Sources = { test }, + OutputKind = OutputKind.ConsoleApplication, + }, + }.RunAsync(); + } + + [Fact] + public async Task TaskReturningMethodWithoutSuffix_CodeFixUpdatesCallers() + { + var test = @" using System.Threading.Tasks; class Test { @@ -317,7 +317,7 @@ async Task BarAsync() } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -329,14 +329,14 @@ async Task BarAsync() } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskReturningMethodWithoutSuffixWithMultipleOverloads_CodeFixUpdatesCallers() - { - var test = @" + [Fact] + public async Task TaskReturningMethodWithoutSuffixWithMultipleOverloads_CodeFixUpdatesCallers() + { + var test = @" using System.Threading.Tasks; class Test { @@ -350,7 +350,7 @@ async Task BarAsync() } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; class Test { @@ -364,44 +364,44 @@ async Task BarAsync() } "; - DiagnosticResult[] expected = - { - Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13), - Verify.Diagnostic(AddSuffixDescriptor).WithSpan(6, 10, 6, 13), - }; - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } - - [Fact] - public async Task TaskReturningMethodWithSuffix_GeneratesNoWarning() + DiagnosticResult[] expected = { - var test = @" + CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13), + CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(6, 10, 6, 13), + }; + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } + + [Fact] + public async Task TaskReturningMethodWithSuffix_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { Task FooAsync() => null; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task IAsyncEnumerableOfTReturningMethodWithSuffix_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task IAsyncEnumerableOfTReturningMethodWithSuffix_GeneratesNoWarning() + { + var test = @" using System.Collections.Generic; class Test { IAsyncEnumerable FooAsync() => null; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task HomemadeIAsyncEnumerableOfTReturningMethodWithSuffix_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task HomemadeIAsyncEnumerableOfTReturningMethodWithSuffix_GeneratesNoWarning() + { + var test = @" using System.Collections.Generic; using System.Threading; @@ -413,13 +413,13 @@ class Test { MyAsyncEnumerable FooAsync() => default; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); + } - [Fact] - public async Task VoidReturningMethodWithSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task VoidReturningMethodWithSuffix_GeneratesWarning() + { + var test = @" class Test { void FooAsync() { } @@ -427,7 +427,7 @@ void FooAsync() { } } "; - var withFix = @" + var withFix = @" class Test { void Foo() { } @@ -435,14 +435,14 @@ void Foo() { } } "; - DiagnosticResult expected = Verify.Diagnostic(RemoveSuffixDescriptor).WithSpan(3, 10, 3, 18); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(RemoveSuffixDescriptor).WithSpan(3, 10, 3, 18); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task BoolReturningMethodWithSuffix_GeneratesWarning() - { - var test = @" + [Fact] + public async Task BoolReturningMethodWithSuffix_GeneratesWarning() + { + var test = @" class Test { bool FooAsync() => false; @@ -450,7 +450,7 @@ class Test { } "; - var withFix = @" + var withFix = @" class Test { bool Foo() => false; @@ -458,14 +458,14 @@ class Test { } "; - DiagnosticResult expected = Verify.Diagnostic(RemoveSuffixDescriptor).WithSpan(3, 10, 3, 18); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(RemoveSuffixDescriptor).WithSpan(3, 10, 3, 18); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskReturningMethodWithoutSuffix_ImplementsInterface_GeneratesWarningOnlyOnInterface() - { - var test = @" + [Fact] + public async Task TaskReturningMethodWithoutSuffix_ImplementsInterface_GeneratesWarningOnlyOnInterface() + { + var test = @" using System.Threading.Tasks; interface IFoo { @@ -477,7 +477,7 @@ class Test : IFoo { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; interface IFoo { @@ -489,14 +489,14 @@ class Test : IFoo { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskReturningMethodWithoutSuffix_ImplementsInterfaceExplicitly_GeneratesWarningOnlyOnInterface() - { - var test = @" + [Fact] + public async Task TaskReturningMethodWithoutSuffix_ImplementsInterfaceExplicitly_GeneratesWarningOnlyOnInterface() + { + var test = @" using System.Threading.Tasks; interface IFoo { @@ -508,7 +508,7 @@ class Test : IFoo { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; interface IFoo { @@ -520,14 +520,14 @@ class Test : IFoo { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 10, 5, 13); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskReturningMethodWithoutSuffix_OverridesAbstract_GeneratesWarningOnlyOnInterface() - { - var test = @" + [Fact] + public async Task TaskReturningMethodWithoutSuffix_OverridesAbstract_GeneratesWarningOnlyOnInterface() + { + var test = @" using System.Threading.Tasks; abstract class MyBase { @@ -539,7 +539,7 @@ class Test : MyBase { } "; - var withFix = @" + var withFix = @" using System.Threading.Tasks; abstract class MyBase { @@ -551,21 +551,20 @@ class Test : MyBase { } "; - DiagnosticResult expected = Verify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 26, 5, 29); - await Verify.VerifyCodeFixAsync(test, expected, withFix); - } + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 26, 5, 29); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } - [Fact] - public async Task TaskReturningPropertyWithoutSuffix_GeneratesNoWarning() - { - var test = @" + [Fact] + public async Task TaskReturningPropertyWithoutSuffix_GeneratesNoWarning() + { + var test = @" using System.Threading.Tasks; class Test { Task Foo => null; } "; - await Verify.VerifyAnalyzerAsync(test); - } + await CSVerify.VerifyAnalyzerAsync(test); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs index 220aca346..f422dd62b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs @@ -1,10 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Microsoft.Win32; + namespace Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher { - using Microsoft.Win32; - internal static class Program { private static void Main() diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index 7ed1d5d38..7b615f24d 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -108,13 +108,13 @@ public void SwitchToMainThreadAsyncContributesToHangReportsAndCollections() // Verify here that pendingTasks includes one task. Assert.Equal(1, this.GetPendingTasksCount()); - Assert.Single(this.joinableCollection); + Assert.Single(this.joinableCollection!); // Now let the request proceed through. this.PushFrame(); Assert.Equal(0, this.GetPendingTasksCount()); - Assert.Empty(this.joinableCollection); + Assert.Empty(this.joinableCollection!); if (delegateFailure is object) { @@ -4425,7 +4425,7 @@ private void RunFuncOfTaskOfTHelper() /// /// Writes out a DGML graph of pending tasks and collections to the test context. /// - /// A specific context to collect data from; null will use this.context. + /// A specific context to collect data from; will use this.context. private void PrintActiveTasksReport(JoinableTaskContext? context = null) { context = context ?? this.context; diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs index 8cddb7b10..8e58d4317 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs @@ -341,7 +341,7 @@ await this.semaphore.ExecuteAsync(delegate await this.semaphore.ExecuteAsync(async delegate { releaseInheritor.Set(); - await Assert.ThrowsAnyAsync(() => innerOperation); + await Assert.ThrowsAnyAsync(() => innerOperation!); }); }); @@ -387,7 +387,7 @@ await this.semaphore.ExecuteAsync( async delegate { releaseInheritor2.Set(); - await Assert.ThrowsAnyAsync(() => innerOperation2); + await Assert.ThrowsAnyAsync(() => innerOperation2!); }, this.TimeoutToken); } @@ -540,7 +540,7 @@ public void Stack_ViolationCaughtAtBothSites() // Release the nested one last, which should similarly throw because its parent is already released. release2.Set(); - await Assert.ThrowsAsync(() => operation2); + await Assert.ThrowsAsync(() => operation2!); // Verify that the semaphore is still in a faulted state, and will reject new calls. Assert.Throws(() => this.semaphore.CurrentCount); @@ -695,7 +695,7 @@ await semaphore.ExecuteAsync( await Assert.ThrowsAsync(() => pendingSemaphoreTask).WithCancellation(this.TimeoutToken); releaser1.Set(); - await Assert.ThrowsAsync(() => innerFaulterSemaphoreTask).WithCancellation(this.TimeoutToken); + await Assert.ThrowsAsync(() => innerFaulterSemaphoreTask!).WithCancellation(this.TimeoutToken); await Assert.ThrowsAsync(() => semaphore.ExecuteAsync(() => Task.CompletedTask)).WithCancellation(this.TimeoutToken); }); } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs index 94c03a888..5b7b6ff4d 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs @@ -130,7 +130,7 @@ protected void CheckGCPressure(Action scenario, int maxBytesAllocated, int itera /// The maximum number of bytes allowed to be allocated by one run of the scenario. Use -1 to indicate no limit. /// The number of times to invoke in a row before measuring average memory impact. /// The number of times the (scenario * iterations) loop repeats with a failing result before ultimately giving up. - /// true to synchronously complete instead of yielding. + /// to synchronously complete instead of yielding. /// A task that captures the result of the operation. protected async Task CheckGCPressureAsync(Func scenario, int maxBytesAllocated, int iterations = 100, int allowedAttempts = GCAllocationAttempts, bool completeSynchronously = false) { @@ -336,8 +336,8 @@ protected void ExecuteOnDispatcher(Func action) /// /// The name of the test method. /// - /// A task whose result is true if test execution is already isolated and should therefore proceed with the body of the test, - /// or false after the isolated instance of the test has completed execution. + /// A task whose result is if test execution is already isolated and should therefore proceed with the body of the test, + /// or after the isolated instance of the test has completed execution. /// /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. @@ -352,8 +352,8 @@ protected Task ExecuteInIsolationAsync([CallerMemberName] string testMetho /// /// The name of the test method. /// - /// true if test execution is already isolated and should therefore proceed with the body of the test, - /// or false after the isolated instance of the test has completed execution. + /// if test execution is already isolated and should therefore proceed with the body of the test, + /// or after the isolated instance of the test has completed execution. /// /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs index 8ed816b7a..28844c1a1 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs @@ -167,8 +167,8 @@ internal static IDisposable StarveThreadpool() /// The name of the test method. /// An optional logger to forward any output to from the isolated test runner. /// - /// A task whose result is true if test execution is already isolated and should therefore proceed with the body of the test, - /// or false after the isolated instance of the test has completed execution. + /// A task whose result is if test execution is already isolated and should therefore proceed with the body of the test, + /// or after the isolated instance of the test has completed execution. /// /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. @@ -186,8 +186,8 @@ internal static Task ExecuteInIsolationAsync(object testClass, string test /// The name of the test method. /// An optional logger to forward any output to from the isolated test runner. /// - /// A task whose result is true if test execution is already isolated and should therefore proceed with the body of the test, - /// or false after the isolated instance of the test has completed execution. + /// A task whose result is if test execution is already isolated and should therefore proceed with the body of the test, + /// or after the isolated instance of the test has completed execution. /// /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. @@ -267,8 +267,8 @@ internal static Task ExecuteInIsolationAsync(string testClassName, string /// Wait on a task without possibly inlining it to the current thread. /// /// The task to wait on. - /// true to throw the original (inner) exception when the faults; false to throw . - /// Thrown if completes in a faulted state if is false. + /// to throw the original (inner) exception when the faults; to throw . + /// Thrown if completes in a faulted state if is . internal static void WaitWithoutInlining(this Task task, bool throwOriginalException) { Requires.NotNull(task, nameof(task)); @@ -295,9 +295,9 @@ internal static void WaitWithoutInlining(this Task task, bool throwOriginalExcep /// /// The type of result returned from the . /// The task to wait on. - /// true to throw the original (inner) exception when the faults; false to throw . + /// to throw the original (inner) exception when the faults; to throw . /// The result of the . - /// Thrown if completes in a faulted state if is false. + /// Thrown if completes in a faulted state if is . internal static T GetResultWithoutInlining(this Task task, bool throwOriginalException = true) { WaitWithoutInlining(task, throwOriginalException); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs index 881257808..839c15bfc 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs @@ -36,14 +36,14 @@ public void ApplyChangeOptimisticallyWithItem() public void WithCancellationNull() { Assert.Throws(new Action(() => - ThreadingTools.WithCancellation(null!, CancellationToken.None))); + ThreadingTools.WithCancellation(null!, CancellationToken.None).Forget())); } [Fact] public void WithCancellationOfTNull() { Assert.Throws(new Action(() => - ThreadingTools.WithCancellation(null!, CancellationToken.None))); + ThreadingTools.WithCancellation(null!, CancellationToken.None).Forget())); } /// From af4a7e5d65ebad167c534c7dc7605063cca61c93 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 10:21:56 -0600 Subject: [PATCH 0598/1753] Convert namespace blocks to statements --- .../CSharpCommonInterest.cs | 423 +- .../CSharpUtils.cs | 379 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 11 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 11 +- .../CSharpVSTHRD011UseAsyncLazyAnalyzer.cs | 11 +- .../CSharpVSTHRD012SpecifyJtfWhereAllowed.cs | 11 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 11 +- ...8AssertThreadRequirementUnconditionally.cs | 11 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 11 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 11 +- .../VSTHRD002UseJtfRunAnalyzer.cs | 235 +- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 437 +- .../VSTHRD010MainThreadUsageAnalyzer.cs | 725 ++- ...02AvoidJtfRunInNonPublicMembersAnalyzer.cs | 95 +- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 331 +- .../VSTHRD104OfferAsyncOptionAnalyzer.cs | 137 +- ...7AwaitTaskWithinUsingExpressionAnalyzer.cs | 99 +- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 79 +- .../CommonFixes.cs | 63 +- .../FixUtils.cs | 681 ++- .../NullableHelpers.cs | 33 +- .../SyntaxGeneratorExtensions.cs | 75 +- .../VSTHRD002UseJtfRunCodeFixWithAwait.cs | 209 +- .../VSTHRD010MainThreadUsageCodeFix.cs | 195 +- .../VSTHRD100AsyncVoidMethodCodeFix.cs | 119 +- .../VSTHRD103UseAsyncOptionCodeFix.cs | 347 +- ...07AwaitTaskWithinUsingExpressionCodeFix.cs | 119 +- ...THRD109AvoidAssertInAsyncMethodsCodeFix.cs | 209 +- .../VSTHRD111UseConfigureAwaitCodeFix.cs | 63 +- ...2ImplementSystemIAsyncDisposableCodeFix.cs | 125 +- .../VSTHRD114AvoidReturningNullTaskCodeFix.cs | 87 +- ...STHRD200UseAsyncNamingConventionCodeFix.cs | 95 +- .../VisualBasicUtils.cs | 103 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 11 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 11 +- ...isualBasicVSTHRD011UseAsyncLazyAnalyzer.cs | 11 +- ...ualBasicVSTHRD012SpecifyJtfWhereAllowed.cs | 11 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 11 +- ...8AssertThreadRequirementUnconditionally.cs | 11 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 11 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 11 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 11 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 95 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 71 +- .../AbstractVSTHRD011UseAsyncLazyAnalyzer.cs | 117 +- ...AbstractVSTHRD012SpecifyJtfWhereAllowed.cs | 161 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 109 +- ...8AssertThreadRequirementUnconditionally.cs | 193 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 97 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 83 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 99 +- .../CommonInterest.cs | 483 +- .../DiagnosticAnalyzerState.cs | 177 +- .../LanguageUtils.cs | 15 +- .../Namespaces.cs | 131 +- .../Strings.Designer.cs | 1139 ++--- .../Types.cs | 347 +- .../Utils.cs | 1107 ++-- .../VSTHRD100AsyncVoidMethodAnalyzer.cs | 117 +- .../VSTHRD101AsyncVoidLambdaAnalyzer.cs | 117 +- ...106UseInvokeAsyncForAsyncEventsAnalyzer.cs | 121 +- .../VSTHRD111UseConfigureAwaitAnalyzer.cs | 79 +- ...3CheckForSystemIAsyncDisposableAnalyzer.cs | 141 +- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 161 +- .../AsyncAutoResetEvent.cs | 275 +- .../AsyncBarrier.cs | 105 +- .../AsyncCountdownEvent.cs | 165 +- .../AsyncEventHandler.cs | 35 +- .../AsyncLazyInitializer.cs | 99 +- .../AsyncLazy`1.cs | 389 +- .../AsyncLocal`1.cs | 51 +- .../AsyncManualResetEvent.cs | 385 +- .../AsyncQueue`1.cs | 675 ++- .../AsyncReaderWriterLock.cs | 4553 ++++++++--------- .../AsyncReaderWriterResourceLock`2.cs | 1363 +++-- .../AsyncSemaphore.cs | 563 +- .../AwaitExtensions.cs | 1541 +++--- src/Microsoft.VisualStudio.Threading/Boxed.cs | 35 +- .../CancellableJoinComputation.cs | 569 +- .../CancellationTokenExtensions.cs | 301 +- .../DelegatingJoinableTaskFactory.cs | 125 +- src/Microsoft.VisualStudio.Threading/Dgml.cs | 421 +- .../DispatcherExtensions.cs | 99 +- .../EmptyStruct.cs | 25 +- .../EnumerateOneOrMany`1.cs | 209 +- .../HangReportContribution.cs | 91 +- .../IAsyncDisposable.cs | 25 +- .../IHangReportContributor.cs | 19 +- .../IJoinableTaskDependent.cs | 77 +- .../IllegalSemaphoreUsageException.cs | 19 +- .../InlineResumable.cs | 133 +- .../InternalUtilities.cs | 429 +- .../JoinableTask+ExecutionQueue.cs | 109 +- .../JoinableTask.cs | 1821 ++++--- .../JoinableTaskCollection.cs | 431 +- ...inableTaskContext+HangReportContributor.cs | 307 +- .../JoinableTaskContext.cs | 1147 +++-- .../JoinableTaskContextException.cs | 75 +- .../JoinableTaskContextNode.cs | 331 +- .../JoinableTaskCreationOptions.cs | 31 +- .../JoinableTaskDependencyGraph.cs | 1677 +++--- .../JoinableTaskFactory.cs | 2103 ++++---- .../LightUps.cs | 43 +- .../ListOfOftenOne`1.cs | 383 +- .../NoMessagePumpSyncContext.cs | 97 +- .../NonConcurrentSynchronizationContext.cs | 269 +- .../NullableHelpers.cs | 53 +- .../ProgressWithCompletion`1.cs | 389 +- .../RarelyRemoveItemSet`1.cs | 351 +- .../ReentrantSemaphore.cs | 1725 ++++--- .../RegistryChangeNotificationFilters.cs | 55 +- .../RoslynDebug.cs | 23 +- .../SemaphoreFaultedException.cs | 19 +- .../SingleThreadedSynchronizationContext.cs | 359 +- .../SpecializedSyncContext.cs | 97 +- .../Strings.Designer.cs | 487 +- .../TaskCompletionSourceWithoutInlining`1.cs | 95 +- .../ThreadingEventSource.cs | 367 +- .../ThreadingTools.cs | 593 ++- .../TplExtensions.cs | 1423 +++--- .../WeakKeyDictionary`2.cs | 775 ++- src/SosThreadingTools/Commands.cs | 61 +- src/SosThreadingTools/DebuggerContext.cs | 159 +- src/SosThreadingTools/DebuggerOutput.cs | 91 +- src/SosThreadingTools/DumpAsyncCommand.cs | 733 ++- src/SosThreadingTools/ExtensionContext.cs | 53 +- src/SosThreadingTools/ICommandHandler.cs | 9 +- src/SosThreadingTools/Utilities.cs | 85 +- test/IsolatedTestHost/ExitCode.cs | 89 +- test/IsolatedTestHost/Program.cs | 163 +- test/IsolatedTestHost/TestOutputHelper.cs | 19 +- .../Program.cs | 19 +- 132 files changed, 20285 insertions(+), 20417 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs index fdcb5194b..d72dcd915 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs @@ -11,281 +11,280 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class CSharpCommonInterest { - internal static class CSharpCommonInterest + internal static readonly IImmutableSet MethodSyntaxKinds = ImmutableHashSet.Create( + SyntaxKind.ConstructorDeclaration, + SyntaxKind.MethodDeclaration, + SyntaxKind.OperatorDeclaration, + SyntaxKind.AnonymousMethodExpression, + SyntaxKind.SimpleLambdaExpression, + SyntaxKind.ParenthesizedLambdaExpression, + SyntaxKind.GetAccessorDeclaration, + SyntaxKind.SetAccessorDeclaration, + SyntaxKind.AddAccessorDeclaration, + SyntaxKind.RemoveAccessorDeclaration); + + /// + /// This is an explicit rule to ignore the code that was generated by Xaml2CS. + /// + /// + /// The generated code has the comments like this: + /// + /// ]]> + /// This rule is based on the fact the keyword "<auto-generated>" should be found in the comments. + /// + internal static bool ShouldIgnoreContext(SyntaxNodeAnalysisContext context) { - internal static readonly IImmutableSet MethodSyntaxKinds = ImmutableHashSet.Create( - SyntaxKind.ConstructorDeclaration, - SyntaxKind.MethodDeclaration, - SyntaxKind.OperatorDeclaration, - SyntaxKind.AnonymousMethodExpression, - SyntaxKind.SimpleLambdaExpression, - SyntaxKind.ParenthesizedLambdaExpression, - SyntaxKind.GetAccessorDeclaration, - SyntaxKind.SetAccessorDeclaration, - SyntaxKind.AddAccessorDeclaration, - SyntaxKind.RemoveAccessorDeclaration); - - /// - /// This is an explicit rule to ignore the code that was generated by Xaml2CS. - /// - /// - /// The generated code has the comments like this: - /// - /// ]]> - /// This rule is based on the fact the keyword "<auto-generated>" should be found in the comments. - /// - internal static bool ShouldIgnoreContext(SyntaxNodeAnalysisContext context) + NamespaceDeclarationSyntax? namespaceDeclaration = context.Node.FirstAncestorOrSelf(); + if (namespaceDeclaration is object) { - NamespaceDeclarationSyntax? namespaceDeclaration = context.Node.FirstAncestorOrSelf(); - if (namespaceDeclaration is object) + foreach (SyntaxTrivia trivia in namespaceDeclaration.NamespaceKeyword.GetAllTrivia()) { - foreach (SyntaxTrivia trivia in namespaceDeclaration.NamespaceKeyword.GetAllTrivia()) + const string autoGeneratedKeyword = @""; + if (trivia.FullSpan.Length > autoGeneratedKeyword.Length + && trivia.ToString().Contains(autoGeneratedKeyword)) { - const string autoGeneratedKeyword = @""; - if (trivia.FullSpan.Length > autoGeneratedKeyword.Length - && trivia.ToString().Contains(autoGeneratedKeyword)) - { - return true; - } + return true; } } - - return false; } - internal static void InspectMemberAccess( - SyntaxNodeAnalysisContext context, - MemberAccessExpressionSyntax? memberAccessSyntax, - DiagnosticDescriptor descriptor, - IEnumerable problematicMethods, - bool ignoreIfInsideAnonymousDelegate = false) + return false; + } + + internal static void InspectMemberAccess( + SyntaxNodeAnalysisContext context, + MemberAccessExpressionSyntax? memberAccessSyntax, + DiagnosticDescriptor descriptor, + IEnumerable problematicMethods, + bool ignoreIfInsideAnonymousDelegate = false) + { + if (descriptor is null) { - if (descriptor is null) - { - throw new ArgumentNullException(nameof(descriptor)); - } + throw new ArgumentNullException(nameof(descriptor)); + } - if (memberAccessSyntax is null) - { - return; - } + if (memberAccessSyntax is null) + { + return; + } - if (ShouldIgnoreContext(context)) - { - return; - } + if (ShouldIgnoreContext(context)) + { + return; + } - if (ignoreIfInsideAnonymousDelegate && context.Node.FirstAncestorOrSelf() is object) - { - // We do not analyze JTF.Run inside anonymous functions because - // they are so often used as callbacks where the signature is constrained. - return; - } + if (ignoreIfInsideAnonymousDelegate && context.Node.FirstAncestorOrSelf() is object) + { + // We do not analyze JTF.Run inside anonymous functions because + // they are so often used as callbacks where the signature is constrained. + return; + } - if (CSharpUtils.IsWithinNameOf(context.Node as ExpressionSyntax)) - { - // We do not consider arguments to nameof( ) because they do not represent invocations of code. - return; - } + if (CSharpUtils.IsWithinNameOf(context.Node as ExpressionSyntax)) + { + // We do not consider arguments to nameof( ) because they do not represent invocations of code. + return; + } - ITypeSymbol? typeReceiver = context.SemanticModel.GetTypeInfo(memberAccessSyntax.Expression).Type; - if (typeReceiver is object) + ITypeSymbol? typeReceiver = context.SemanticModel.GetTypeInfo(memberAccessSyntax.Expression).Type; + if (typeReceiver is object) + { + foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) { - foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) + if (memberAccessSyntax.Name.Identifier.Text == item.Method.Name && + typeReceiver.Name == item.Method.ContainingType.Name && + typeReceiver.BelongsToNamespace(item.Method.ContainingType.Namespace)) { - if (memberAccessSyntax.Name.Identifier.Text == item.Method.Name && - typeReceiver.Name == item.Method.ContainingType.Name && - typeReceiver.BelongsToNamespace(item.Method.ContainingType.Namespace)) + if (HasTaskCompleted(context, memberAccessSyntax)) { - if (HasTaskCompleted(context, memberAccessSyntax)) - { - return; - } - - Location? location = memberAccessSyntax.Name.GetLocation(); - context.ReportDiagnostic(Diagnostic.Create(descriptor, location)); + return; } + + Location? location = memberAccessSyntax.Name.GetLocation(); + context.ReportDiagnostic(Diagnostic.Create(descriptor, location)); } } } + } - private static SyntaxNode? GetEnclosingBlock(SyntaxNode node) + private static SyntaxNode? GetEnclosingBlock(SyntaxNode node) + { + while (node is not null) { - while (node is not null) + if (node.IsKind(SyntaxKind.Block)) { - if (node.IsKind(SyntaxKind.Block)) - { - return node; - } - - node = node.Parent; + return node; } - return null; + node = node.Parent; } - private static bool IsVariablePassedToInvocation(InvocationExpressionSyntax invocationExpr, string variableName, bool byRef) + return null; + } + + private static bool IsVariablePassedToInvocation(InvocationExpressionSyntax invocationExpr, string variableName, bool byRef) + { + ArgumentListSyntax? argList = invocationExpr.ChildNodes().OfType().FirstOrDefault(); + if (argList is null) { - ArgumentListSyntax? argList = invocationExpr.ChildNodes().OfType().FirstOrDefault(); - if (argList is null) + return false; + } + + foreach (ArgumentSyntax arg in argList.ChildNodes().OfType()) + { + // `byRef` includes `out` parameters because they are the same as `ref` except don't require initialization first. + if (byRef && !arg.RefKindKeyword.IsKind(SyntaxKind.RefKeyword) && !arg.RefKindKeyword.IsKind(SyntaxKind.OutKeyword)) { - return false; + continue; } - foreach (ArgumentSyntax arg in argList.ChildNodes().OfType()) + IdentifierNameSyntax identiferName = arg.ChildNodes().OfType().FirstOrDefault(); + if (identiferName is null) { - // `byRef` includes `out` parameters because they are the same as `ref` except don't require initialization first. - if (byRef && !arg.RefKindKeyword.IsKind(SyntaxKind.RefKeyword) && !arg.RefKindKeyword.IsKind(SyntaxKind.OutKeyword)) - { - continue; - } - - IdentifierNameSyntax identiferName = arg.ChildNodes().OfType().FirstOrDefault(); - if (identiferName is null) - { - return false; - } + return false; + } - if (identiferName.Identifier.ValueText == variableName) - { - return true; - } + if (identiferName.Identifier.ValueText == variableName) + { + return true; } + } + return false; + } + + private static bool IsTaskCompletedWithWhenAll(SyntaxNodeAnalysisContext context, InvocationExpressionSyntax invocationExpr, string taskVariableName) + { + // We only care about awaited invocations, because an un-awaited Task.WhenAll will be an error. + if (invocationExpr.Parent is not AwaitExpressionSyntax) + { return false; } - private static bool IsTaskCompletedWithWhenAll(SyntaxNodeAnalysisContext context, InvocationExpressionSyntax invocationExpr, string taskVariableName) + IEnumerable? memberAccessList = invocationExpr.ChildNodes().OfType(); + if (memberAccessList.Count() != 1) { - // We only care about awaited invocations, because an un-awaited Task.WhenAll will be an error. - if (invocationExpr.Parent is not AwaitExpressionSyntax) - { - return false; - } + return false; + } - IEnumerable? memberAccessList = invocationExpr.ChildNodes().OfType(); - if (memberAccessList.Count() != 1) - { - return false; - } + MemberAccessExpressionSyntax? memberAccess = memberAccessList.First(); - MemberAccessExpressionSyntax? memberAccess = memberAccessList.First(); + // Does the invocation have the expected `Task.WhenAll` syntax? This is cheaper to verify before looking up its semantic type. + bool correctSyntax = memberAccess.Expression is IdentifierNameSyntax { Identifier.ValueText: Types.Task.TypeName } + && memberAccess.Name is IdentifierNameSyntax { Identifier.ValueText: Types.Task.WhenAll }; - // Does the invocation have the expected `Task.WhenAll` syntax? This is cheaper to verify before looking up its semantic type. - bool correctSyntax = memberAccess.Expression is IdentifierNameSyntax { Identifier.ValueText: Types.Task.TypeName } - && memberAccess.Name is IdentifierNameSyntax { Identifier.ValueText: Types.Task.WhenAll }; + if (!correctSyntax) + { + return false; + } - if (!correctSyntax) - { - return false; - } + // Is this `Task.WhenAll` invocation from the System.Threading.Tasks.Task type? + ITypeSymbol? classType = context.SemanticModel.GetTypeInfo(memberAccess.Expression).Type; + var correctType = classType.Name == Types.Task.TypeName && classType.BelongsToNamespace(Types.Task.Namespace); + if (!correctType) + { + return false; + } - // Is this `Task.WhenAll` invocation from the System.Threading.Tasks.Task type? - ITypeSymbol? classType = context.SemanticModel.GetTypeInfo(memberAccess.Expression).Type; - var correctType = classType.Name == Types.Task.TypeName && classType.BelongsToNamespace(Types.Task.Namespace); - if (!correctType) - { - return false; - } + // Is the task variable passed as an argument to `Task.WhenAll`? + return IsVariablePassedToInvocation(invocationExpr, taskVariableName, byRef: false); + } - // Is the task variable passed as an argument to `Task.WhenAll`? - return IsVariablePassedToInvocation(invocationExpr, taskVariableName, byRef: false); + private static bool HasTaskCompleted(SyntaxNodeAnalysisContext context, MemberAccessExpressionSyntax memberAccessSyntax) + { + SyntaxNode? enclosingBlock = GetEnclosingBlock(memberAccessSyntax); + if (enclosingBlock is null) + { + return false; } - private static bool HasTaskCompleted(SyntaxNodeAnalysisContext context, MemberAccessExpressionSyntax memberAccessSyntax) + // Get the task variable name from the problematic member access expression so that we can later try + // and determine if it has been used in a `Task.WhenAll` invocation. + // Examples: + // task1.Result; + // task2.GetAwaiter().GetResult(); + string? taskVariableName = null; + ExpressionSyntax parentExpr = memberAccessSyntax.Expression; + while (parentExpr is not null) { - SyntaxNode? enclosingBlock = GetEnclosingBlock(memberAccessSyntax); - if (enclosingBlock is null) + if (parentExpr is IdentifierNameSyntax identifierExpr) { - return false; + taskVariableName = identifierExpr.Identifier.ValueText; + break; } - - // Get the task variable name from the problematic member access expression so that we can later try - // and determine if it has been used in a `Task.WhenAll` invocation. - // Examples: - // task1.Result; - // task2.GetAwaiter().GetResult(); - string? taskVariableName = null; - ExpressionSyntax parentExpr = memberAccessSyntax.Expression; - while (parentExpr is not null) + else if (parentExpr is MemberAccessExpressionSyntax memberAccessExpr) { - if (parentExpr is IdentifierNameSyntax identifierExpr) - { - taskVariableName = identifierExpr.Identifier.ValueText; - break; - } - else if (parentExpr is MemberAccessExpressionSyntax memberAccessExpr) - { - parentExpr = memberAccessExpr.Expression; - } - else if (parentExpr is InvocationExpressionSyntax invocExpr) - { - parentExpr = invocExpr.Expression; - } - else - { - break; - } + parentExpr = memberAccessExpr.Expression; } - - if (taskVariableName is null) + else if (parentExpr is InvocationExpressionSyntax invocExpr) { - return false; + parentExpr = invocExpr.Expression; } - - // Find all `Task.WhenAll` invocations that precede the problematic member access, which are also in the same enclosing block. - IEnumerable? taskWhenAllInvocationList = - from invoc in enclosingBlock.DescendantNodes().OfType() - where memberAccessSyntax.SpanStart > invoc.Span.End && - IsTaskCompletedWithWhenAll(context, invoc, taskVariableName) - select invoc; - - if (!taskWhenAllInvocationList.Any()) + else { - return false; + break; } + } - // If a `Task.WhenAll` invocation precedes the problematic member access, and the task variable has not been - // invalidated in between, then we consider the task to be completed. - // Example: - // await Task.WhenAll(task1, task2, task3); - // task1 = Task.Run(...); // Invalidates `task1` - // DoSomething(ref task2); // Invalidates `task2` - // task1.Result; // Warn - // task2.Result; // Warn - // task3.Result; // No warning, task3 has not been invalidated in between WhenAll and this problematic member access - foreach (InvocationExpressionSyntax? taskWhenAllInvocation in taskWhenAllInvocationList) - { - // Has the task variable been assigned to a new task? - IEnumerable? assignmentList = - from assign in enclosingBlock.DescendantNodes().OfType() - where assign.SpanStart > taskWhenAllInvocation.Span.End && - assign.SpanStart < memberAccessSyntax.SpanStart && - ((IdentifierNameSyntax)assign.Left).Identifier.ValueText == taskVariableName - select assign; - - if (assignmentList.Any()) - { - return false; - } + if (taskVariableName is null) + { + return false; + } + + // Find all `Task.WhenAll` invocations that precede the problematic member access, which are also in the same enclosing block. + IEnumerable? taskWhenAllInvocationList = + from invoc in enclosingBlock.DescendantNodes().OfType() + where memberAccessSyntax.SpanStart > invoc.Span.End && + IsTaskCompletedWithWhenAll(context, invoc, taskVariableName) + select invoc; - // Has the task variable been passed by ref to a method? - // If so, we must assume the worst case that the method has assigned it to a new task. - IEnumerable? invocationList = - from invoc in enclosingBlock.DescendantNodes().OfType() - where invoc.SpanStart > taskWhenAllInvocation.Span.End && - invoc.SpanStart < memberAccessSyntax.SpanStart && - IsVariablePassedToInvocation(invoc, taskVariableName, byRef: true) - select invoc; + if (!taskWhenAllInvocationList.Any()) + { + return false; + } - return !invocationList.Any(); + // If a `Task.WhenAll` invocation precedes the problematic member access, and the task variable has not been + // invalidated in between, then we consider the task to be completed. + // Example: + // await Task.WhenAll(task1, task2, task3); + // task1 = Task.Run(...); // Invalidates `task1` + // DoSomething(ref task2); // Invalidates `task2` + // task1.Result; // Warn + // task2.Result; // Warn + // task3.Result; // No warning, task3 has not been invalidated in between WhenAll and this problematic member access + foreach (InvocationExpressionSyntax? taskWhenAllInvocation in taskWhenAllInvocationList) + { + // Has the task variable been assigned to a new task? + IEnumerable? assignmentList = + from assign in enclosingBlock.DescendantNodes().OfType() + where assign.SpanStart > taskWhenAllInvocation.Span.End && + assign.SpanStart < memberAccessSyntax.SpanStart && + ((IdentifierNameSyntax)assign.Left).Identifier.ValueText == taskVariableName + select assign; + + if (assignmentList.Any()) + { + return false; } - return false; + // Has the task variable been passed by ref to a method? + // If so, we must assume the worst case that the method has assigned it to a new task. + IEnumerable? invocationList = + from invoc in enclosingBlock.DescendantNodes().OfType() + where invoc.SpanStart > taskWhenAllInvocation.Span.End && + invoc.SpanStart < memberAccessSyntax.SpanStart && + IsVariablePassedToInvocation(invoc, taskVariableName, byRef: true) + select invoc; + + return !invocationList.Any(); } + + return false; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index 98bd90f5f..132a38250 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -11,271 +11,270 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal sealed class CSharpUtils : LanguageUtils { - internal sealed class CSharpUtils : LanguageUtils + public static readonly CSharpUtils Instance = new CSharpUtils(); + + private CSharpUtils() { - public static readonly CSharpUtils Instance = new CSharpUtils(); + } - private CSharpUtils() + internal static ExpressionSyntax IsolateMethodName(InvocationExpressionSyntax invocation) + { + if (invocation is null) { + throw new ArgumentNullException(nameof(invocation)); } - internal static ExpressionSyntax IsolateMethodName(InvocationExpressionSyntax invocation) - { - if (invocation is null) - { - throw new ArgumentNullException(nameof(invocation)); - } - - var memberAccessExpression = invocation.Expression as MemberAccessExpressionSyntax; + var memberAccessExpression = invocation.Expression as MemberAccessExpressionSyntax; #pragma warning disable CA1508 // Avoid dead conditional code - ExpressionSyntax invokedMethodName = memberAccessExpression?.Name ?? invocation.Expression as IdentifierNameSyntax ?? (invocation.Expression as MemberBindingExpressionSyntax)?.Name ?? invocation.Expression; + ExpressionSyntax invokedMethodName = memberAccessExpression?.Name ?? invocation.Expression as IdentifierNameSyntax ?? (invocation.Expression as MemberBindingExpressionSyntax)?.Name ?? invocation.Expression; #pragma warning restore CA1508 // Avoid dead conditional code - return invokedMethodName; - } + return invokedMethodName; + } - /// - /// Finds the local function, anonymous function, method, accessor, or ctor that most directly owns a given syntax node. - /// - /// The syntax node to begin the search from. - /// The containing function, and metadata for it. - internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode syntaxNode) + /// + /// Finds the local function, anonymous function, method, accessor, or ctor that most directly owns a given syntax node. + /// + /// The syntax node to begin the search from. + /// The containing function, and metadata for it. + internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode syntaxNode) + { + while (syntaxNode is object) { - while (syntaxNode is object) + if (syntaxNode is SimpleLambdaExpressionSyntax simpleLambda) { - if (syntaxNode is SimpleLambdaExpressionSyntax simpleLambda) - { - return new ContainingFunctionData(simpleLambda, simpleLambda.AsyncKeyword != default(SyntaxToken), SyntaxFactory.ParameterList().AddParameters(simpleLambda.Parameter), simpleLambda.Body, simpleLambda.WithBody); - } + return new ContainingFunctionData(simpleLambda, simpleLambda.AsyncKeyword != default(SyntaxToken), SyntaxFactory.ParameterList().AddParameters(simpleLambda.Parameter), simpleLambda.Body, simpleLambda.WithBody); + } - if (syntaxNode is AnonymousMethodExpressionSyntax anonymousMethod) - { - return new ContainingFunctionData(anonymousMethod, anonymousMethod.AsyncKeyword != default(SyntaxToken), anonymousMethod.ParameterList, anonymousMethod.Body, anonymousMethod.WithBody); - } + if (syntaxNode is AnonymousMethodExpressionSyntax anonymousMethod) + { + return new ContainingFunctionData(anonymousMethod, anonymousMethod.AsyncKeyword != default(SyntaxToken), anonymousMethod.ParameterList, anonymousMethod.Body, anonymousMethod.WithBody); + } + + if (syntaxNode is ParenthesizedLambdaExpressionSyntax lambda) + { + return new ContainingFunctionData(lambda, lambda.AsyncKeyword != default(SyntaxToken), lambda.ParameterList, lambda.Body, lambda.WithBody); + } - if (syntaxNode is ParenthesizedLambdaExpressionSyntax lambda) + if (syntaxNode is AccessorDeclarationSyntax accessor) + { + Func bodyReplacement = newBody => newBody switch { - return new ContainingFunctionData(lambda, lambda.AsyncKeyword != default(SyntaxToken), lambda.ParameterList, lambda.Body, lambda.WithBody); - } + BlockSyntax block => accessor.WithBody(block), + ArrowExpressionClauseSyntax expression => accessor.WithExpressionBody(expression), + _ => throw new NotSupportedException(), + }; + return new ContainingFunctionData(accessor, false, SyntaxFactory.ParameterList(), accessor.Body, bodyReplacement); + } - if (syntaxNode is AccessorDeclarationSyntax accessor) + if (syntaxNode is BaseMethodDeclarationSyntax method) + { + Func bodyReplacement = method switch { - Func bodyReplacement = newBody => newBody switch + MethodDeclarationSyntax m => (CSharpSyntaxNode newBody) => newBody switch { - BlockSyntax block => accessor.WithBody(block), - ArrowExpressionClauseSyntax expression => accessor.WithExpressionBody(expression), + ArrowExpressionClauseSyntax expr => m.WithExpressionBody(expr), + BlockSyntax block => m.WithBody(block), _ => throw new NotSupportedException(), - }; - return new ContainingFunctionData(accessor, false, SyntaxFactory.ParameterList(), accessor.Body, bodyReplacement); - } - - if (syntaxNode is BaseMethodDeclarationSyntax method) - { - Func bodyReplacement = method switch + }, + ConstructorDeclarationSyntax c => (CSharpSyntaxNode newBody) => newBody switch { - MethodDeclarationSyntax m => (CSharpSyntaxNode newBody) => newBody switch - { - ArrowExpressionClauseSyntax expr => m.WithExpressionBody(expr), - BlockSyntax block => m.WithBody(block), - _ => throw new NotSupportedException(), - }, - ConstructorDeclarationSyntax c => (CSharpSyntaxNode newBody) => newBody switch - { - ArrowExpressionClauseSyntax expr => c.WithExpressionBody(expr), - BlockSyntax block => c.WithBody(block), - _ => throw new NotSupportedException(), - }, - OperatorDeclarationSyntax o => (CSharpSyntaxNode newBody) => newBody switch - { - ArrowExpressionClauseSyntax expr => o.WithExpressionBody(expr), - BlockSyntax block => o.WithBody(block), - _ => throw new NotSupportedException(), - }, + ArrowExpressionClauseSyntax expr => c.WithExpressionBody(expr), + BlockSyntax block => c.WithBody(block), _ => throw new NotSupportedException(), - }; - return new ContainingFunctionData(method, method.Modifiers.Any(SyntaxKind.AsyncKeyword), method.ParameterList, method.Body, bodyReplacement); - } - - syntaxNode = (CSharpSyntaxNode)syntaxNode.Parent; + }, + OperatorDeclarationSyntax o => (CSharpSyntaxNode newBody) => newBody switch + { + ArrowExpressionClauseSyntax expr => o.WithExpressionBody(expr), + BlockSyntax block => o.WithBody(block), + _ => throw new NotSupportedException(), + }, + _ => throw new NotSupportedException(), + }; + return new ContainingFunctionData(method, method.Modifiers.Any(SyntaxKind.AsyncKeyword), method.ParameterList, method.Body, bodyReplacement); } - return default(ContainingFunctionData); + syntaxNode = (CSharpSyntaxNode)syntaxNode.Parent; } - internal static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode) + return default(ContainingFunctionData); + } + + internal static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode) + { + SyntaxNode? parent = null; + while ((parent = syntaxNode.Parent) is object) { - SyntaxNode? parent = null; - while ((parent = syntaxNode.Parent) is object) + if (parent is AssignmentExpressionSyntax assignment) { - if (parent is AssignmentExpressionSyntax assignment) - { - return assignment.Left == syntaxNode; - } - - syntaxNode = parent; + return assignment.Left == syntaxNode; } - return false; + syntaxNode = parent; } - internal static bool IsAssignedWithin(SyntaxNode container, SemanticModel semanticModel, ISymbol variable, CancellationToken cancellationToken) - { - if (semanticModel is null) - { - throw new ArgumentNullException(nameof(semanticModel)); - } - - if (variable is null) - { - throw new ArgumentNullException(nameof(variable)); - } + return false; + } - if (container is null) - { - return false; - } + internal static bool IsAssignedWithin(SyntaxNode container, SemanticModel semanticModel, ISymbol variable, CancellationToken cancellationToken) + { + if (semanticModel is null) + { + throw new ArgumentNullException(nameof(semanticModel)); + } - foreach (SyntaxNode? node in container.DescendantNodesAndSelf(n => !(n is AnonymousFunctionExpressionSyntax))) - { - if (node is AssignmentExpressionSyntax assignment) - { - ISymbol? assignedSymbol = semanticModel.GetSymbolInfo(assignment.Left, cancellationToken).Symbol; - if (variable.Equals(assignedSymbol)) - { - return true; - } - } - } + if (variable is null) + { + throw new ArgumentNullException(nameof(variable)); + } + if (container is null) + { return false; } - internal static MemberAccessExpressionSyntax MemberAccess(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) + foreach (SyntaxNode? node in container.DescendantNodesAndSelf(n => !(n is AnonymousFunctionExpressionSyntax))) { - if (qualifiers is null) + if (node is AssignmentExpressionSyntax assignment) { - throw new ArgumentNullException(nameof(qualifiers)); + ISymbol? assignedSymbol = semanticModel.GetSymbolInfo(assignment.Left, cancellationToken).Symbol; + if (variable.Equals(assignedSymbol)) + { + return true; + } } + } - if (simpleName is null) - { - throw new ArgumentNullException(nameof(simpleName)); - } + return false; + } - if (qualifiers.Count == 0) - { - throw new ArgumentException("At least one qualifier required."); - } + internal static MemberAccessExpressionSyntax MemberAccess(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) + { + if (qualifiers is null) + { + throw new ArgumentNullException(nameof(qualifiers)); + } - ExpressionSyntax result = SyntaxFactory.IdentifierName(qualifiers[0]); - for (int i = 1; i < qualifiers.Count; i++) - { - IdentifierNameSyntax? rightSide = SyntaxFactory.IdentifierName(qualifiers[i]); - result = SyntaxFactory.MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, result, rightSide); - } + if (simpleName is null) + { + throw new ArgumentNullException(nameof(simpleName)); + } - return SyntaxFactory.MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, result, simpleName); + if (qualifiers.Count == 0) + { + throw new ArgumentException("At least one qualifier required."); } - /// - /// Determines whether an expression appears inside a C# "nameof" pseudo-method. - /// - internal static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) + ExpressionSyntax result = SyntaxFactory.IdentifierName(qualifiers[0]); + for (int i = 1; i < qualifiers.Count; i++) { - InvocationExpressionSyntax? invocation = syntaxNode?.FirstAncestorOrSelf(); - return invocation is object - && (invocation.Expression as IdentifierNameSyntax)?.Identifier.Text == "nameof" - && invocation.ArgumentList.Arguments.Count == 1; + IdentifierNameSyntax? rightSide = SyntaxFactory.IdentifierName(qualifiers[i]); + result = SyntaxFactory.MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, result, rightSide); } - internal override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) + return SyntaxFactory.MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, result, simpleName); + } + + /// + /// Determines whether an expression appears inside a C# "nameof" pseudo-method. + /// + internal static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) + { + InvocationExpressionSyntax? invocation = syntaxNode?.FirstAncestorOrSelf(); + return invocation is object + && (invocation.Expression as IdentifierNameSyntax)?.Identifier.Text == "nameof" + && invocation.ArgumentList.Arguments.Count == 1; + } + + internal override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) + { + foreach (SyntaxReference? syntaxReference in symbol.DeclaringSyntaxReferences) { - foreach (SyntaxReference? syntaxReference in symbol.DeclaringSyntaxReferences) + SyntaxNode? syntaxNode = syntaxReference.GetSyntax(cancellationToken); + if (syntaxNode is TypeDeclarationSyntax { BaseList: { } } typeDeclarationSyntax) { - SyntaxNode? syntaxNode = syntaxReference.GetSyntax(cancellationToken); - if (syntaxNode is TypeDeclarationSyntax { BaseList: { } } typeDeclarationSyntax) + if (compilation.GetSemanticModel(typeDeclarationSyntax.SyntaxTree) is { } semanticModel) { - if (compilation.GetSemanticModel(typeDeclarationSyntax.SyntaxTree) is { } semanticModel) + foreach (BaseTypeSyntax? baseTypeSyntax in typeDeclarationSyntax.BaseList.Types) { - foreach (BaseTypeSyntax? baseTypeSyntax in typeDeclarationSyntax.BaseList.Types) + SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(baseTypeSyntax.Type, cancellationToken); + if (Equals(baseTypeSymbolInfo.Symbol, baseType)) { - SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(baseTypeSyntax.Type, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) - { - return baseTypeSyntax.GetLocation(); - } + return baseTypeSyntax.GetLocation(); } } } } - - return symbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax(cancellationToken)?.GetLocation(); } - internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) - { - if (invocation.Syntax is InvocationExpressionSyntax invocationExpression) - { - return IsolateMethodName(invocationExpression); - } + return symbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax(cancellationToken)?.GetLocation(); + } - return invocation.Syntax; + internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) + { + if (invocation.Syntax is InvocationExpressionSyntax invocationExpression) + { + return IsolateMethodName(invocationExpression); } - internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) - { - if (objectCreation.Syntax is ObjectCreationExpressionSyntax { Type: { } type }) - { - return type; - } + return invocation.Syntax; + } - return objectCreation.Syntax; + internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) + { + if (objectCreation.Syntax is ObjectCreationExpressionSyntax { Type: { } type }) + { + return type; } - internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) - { - SyntaxReference? syntaxReference = methodSymbol.DeclaringSyntaxReferences.FirstOrDefault(); - if (syntaxReference is null) - { - return false; - } + return objectCreation.Syntax; + } - SyntaxNode syntaxNode = syntaxReference.GetSyntax(); - TypeSyntax? returnType = null; + internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) + { + SyntaxReference? syntaxReference = methodSymbol.DeclaringSyntaxReferences.FirstOrDefault(); + if (syntaxReference is null) + { + return false; + } - if (syntaxNode is MethodDeclarationSyntax methodDeclSyntax) - { - returnType = methodDeclSyntax.ReturnType; - } - else if (syntaxNode is LocalFunctionStatementSyntax localFunc) - { - returnType = localFunc.ReturnType; - } + SyntaxNode syntaxNode = syntaxReference.GetSyntax(); + TypeSyntax? returnType = null; - return returnType is not null && returnType.IsKind(SyntaxKind.NullableType); + if (syntaxNode is MethodDeclarationSyntax methodDeclSyntax) + { + returnType = methodDeclSyntax.ReturnType; + } + else if (syntaxNode is LocalFunctionStatementSyntax localFunc) + { + returnType = localFunc.ReturnType; } - internal readonly struct ContainingFunctionData + return returnType is not null && returnType.IsKind(SyntaxKind.NullableType); + } + + internal readonly struct ContainingFunctionData + { + internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax parameterList, CSharpSyntaxNode blockOrExpression, Func bodyReplacement) { - internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax parameterList, CSharpSyntaxNode blockOrExpression, Func bodyReplacement) - { - this.Function = function; - this.IsAsync = isAsync; - this.ParameterList = parameterList; - this.BlockOrExpression = blockOrExpression; - this.BodyReplacement = bodyReplacement; - } + this.Function = function; + this.IsAsync = isAsync; + this.ParameterList = parameterList; + this.BlockOrExpression = blockOrExpression; + this.BodyReplacement = bodyReplacement; + } - internal CSharpSyntaxNode Function { get; } + internal CSharpSyntaxNode Function { get; } - internal bool IsAsync { get; } + internal bool IsAsync { get; } - internal ParameterListSyntax ParameterList { get; } + internal ParameterListSyntax ParameterList { get; } - internal CSharpSyntaxNode BlockOrExpression { get; } + internal CSharpSyntaxNode BlockOrExpression { get; } - internal Func BodyReplacement { get; } - } + internal Func BodyReplacement { get; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 02e96d15a..347387f22 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 71b8b03fc..475722005 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs index 1edaea200..fbbf1136d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs index 357282782..0686763b9 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 3a7dad291..4d4c320b5 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs index 3022c6f31..f9cd6b899 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 69256510c..261f7d404 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs index b49889fc0..d03c6e926 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public sealed class CSharpVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer - { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs index 241299d7f..7ba3d2a46 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs @@ -12,148 +12,147 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Report warnings when detect the code that is waiting on tasks or awaiters synchronously. +/// +/// +/// [Background] or will often deadlock if +/// they are called on main thread, because now it is synchronously blocking the main thread for the +/// completion of a task that may need the main thread to complete. Even if they are called on a threadpool +/// thread, it is occupying a threadpool thread to do nothing but block, which is not good either. +/// +/// i.e. +/// +/// var task = Task.Run(DoSomethingOnBackground); +/// task.Wait(); /* This analyzer will report warning on this synchronous wait. */ +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD002UseJtfRunAnalyzer : DiagnosticAnalyzer { - /// - /// Report warnings when detect the code that is waiting on tasks or awaiters synchronously. - /// - /// - /// [Background] or will often deadlock if - /// they are called on main thread, because now it is synchronously blocking the main thread for the - /// completion of a task that may need the main thread to complete. Even if they are called on a threadpool - /// thread, it is occupying a threadpool thread to do nothing but block, which is not good either. - /// - /// i.e. - /// - /// var task = Task.Run(DoSomethingOnBackground); - /// task.Wait(); /* This analyzer will report warning on this synchronous wait. */ - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD002UseJtfRunAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD002"; + public const string Id = "VSTHRD002"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD002_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD002_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD002_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD002_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics + /// + public override ImmutableArray SupportedDiagnostics + { + get { - get - { - return ImmutableArray.Create(Descriptor); - } + return ImmutableArray.Create(Descriptor); } + } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterCompilationStartAction(compilationContext => + context.RegisterCompilationStartAction(compilationContext => + { + INamedTypeSymbol? taskSymbol = compilationContext.Compilation.GetTypeByMetadataName(Types.Task.FullName); + if (taskSymbol is object) { - INamedTypeSymbol? taskSymbol = compilationContext.Compilation.GetTypeByMetadataName(Types.Task.FullName); - if (taskSymbol is object) + compilationContext.RegisterCodeBlockStartAction(codeBlockContext => { - compilationContext.RegisterCodeBlockStartAction(codeBlockContext => + // We want to scan properties and methods that do not return Task or Task. + var methodSymbol = codeBlockContext.OwningSymbol as IMethodSymbol; + var propertySymbol = codeBlockContext.OwningSymbol as IPropertySymbol; + if (propertySymbol is object || (methodSymbol is object && !methodSymbol.HasAsyncCompatibleReturnType())) { - // We want to scan properties and methods that do not return Task or Task. - var methodSymbol = codeBlockContext.OwningSymbol as IMethodSymbol; - var propertySymbol = codeBlockContext.OwningSymbol as IPropertySymbol; - if (propertySymbol is object || (methodSymbol is object && !methodSymbol.HasAsyncCompatibleReturnType())) - { - codeBlockContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(c => AnalyzeInvocation(c, taskSymbol)), SyntaxKind.InvocationExpression); - codeBlockContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(c => AnalyzeMemberAccess(c, taskSymbol)), SyntaxKind.SimpleMemberAccessExpression); - } - }); - } - }); - } - - private static ParameterSyntax? GetFirstParameter(AnonymousFunctionExpressionSyntax? anonymousFunctionSyntax) - { - switch (anonymousFunctionSyntax) - { - case SimpleLambdaExpressionSyntax lambda: - return lambda.Parameter; - case ParenthesizedLambdaExpressionSyntax lambda: - return lambda.ParameterList.Parameters.FirstOrDefault(); - case AnonymousMethodExpressionSyntax anonymousMethod: - return anonymousMethod.ParameterList?.Parameters.FirstOrDefault(); + codeBlockContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(c => AnalyzeInvocation(c, taskSymbol)), SyntaxKind.InvocationExpression); + codeBlockContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(c => AnalyzeMemberAccess(c, taskSymbol)), SyntaxKind.SimpleMemberAccessExpression); + } + }); } + }); + } - return null; + private static ParameterSyntax? GetFirstParameter(AnonymousFunctionExpressionSyntax? anonymousFunctionSyntax) + { + switch (anonymousFunctionSyntax) + { + case SimpleLambdaExpressionSyntax lambda: + return lambda.Parameter; + case ParenthesizedLambdaExpressionSyntax lambda: + return lambda.ParameterList.Parameters.FirstOrDefault(); + case AnonymousMethodExpressionSyntax anonymousMethod: + return anonymousMethod.ParameterList?.Parameters.FirstOrDefault(); } - private static void InspectMemberAccess( - SyntaxNodeAnalysisContext context, - MemberAccessExpressionSyntax? memberAccessSyntax, - IEnumerable problematicMethods, - INamedTypeSymbol taskSymbol) + return null; + } + + private static void InspectMemberAccess( + SyntaxNodeAnalysisContext context, + MemberAccessExpressionSyntax? memberAccessSyntax, + IEnumerable problematicMethods, + INamedTypeSymbol taskSymbol) + { + if (memberAccessSyntax is null) { - if (memberAccessSyntax is null) - { - return; - } + return; + } - // Are we in the context of an anonymous function that is passed directly in as an argument to another method? - AnonymousFunctionExpressionSyntax? anonymousFunctionSyntax = context.Node.FirstAncestorOrSelf(); - var anonFuncAsArgument = anonymousFunctionSyntax?.Parent as ArgumentSyntax; - var invocationPassingExpression = anonFuncAsArgument?.Parent?.Parent as InvocationExpressionSyntax; - var invokedMemberAccess = invocationPassingExpression?.Expression as MemberAccessExpressionSyntax; - if (invokedMemberAccess?.Name is object) + // Are we in the context of an anonymous function that is passed directly in as an argument to another method? + AnonymousFunctionExpressionSyntax? anonymousFunctionSyntax = context.Node.FirstAncestorOrSelf(); + var anonFuncAsArgument = anonymousFunctionSyntax?.Parent as ArgumentSyntax; + var invocationPassingExpression = anonFuncAsArgument?.Parent?.Parent as InvocationExpressionSyntax; + var invokedMemberAccess = invocationPassingExpression?.Expression as MemberAccessExpressionSyntax; + if (invokedMemberAccess?.Name is object) + { + // Does the anonymous function appear as the first argument to Task.ContinueWith? + var invokedMemberSymbol = context.SemanticModel.GetSymbolInfo(invokedMemberAccess.Name, context.CancellationToken).Symbol as IMethodSymbol; + if (invokedMemberSymbol?.Name == nameof(Task.ContinueWith) && + Utils.IsEqualToOrDerivedFrom(invokedMemberSymbol?.ContainingType, taskSymbol) && + invocationPassingExpression?.ArgumentList?.Arguments.FirstOrDefault() == anonFuncAsArgument) { - // Does the anonymous function appear as the first argument to Task.ContinueWith? - var invokedMemberSymbol = context.SemanticModel.GetSymbolInfo(invokedMemberAccess.Name, context.CancellationToken).Symbol as IMethodSymbol; - if (invokedMemberSymbol?.Name == nameof(Task.ContinueWith) && - Utils.IsEqualToOrDerivedFrom(invokedMemberSymbol?.ContainingType, taskSymbol) && - invocationPassingExpression?.ArgumentList?.Arguments.FirstOrDefault() == anonFuncAsArgument) + // Does the member access being analyzed belong to the Task that just completed? + ParameterSyntax? firstParameter = GetFirstParameter(anonymousFunctionSyntax); + if (firstParameter is object) { - // Does the member access being analyzed belong to the Task that just completed? - ParameterSyntax? firstParameter = GetFirstParameter(anonymousFunctionSyntax); - if (firstParameter is object) + // Are we accessing a member of the completed task? + ISymbol invokedObjectSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax.Expression, context.CancellationToken).Symbol; + IParameterSymbol completedTask = context.SemanticModel.GetDeclaredSymbol(firstParameter); + if (EqualityComparer.Default.Equals(invokedObjectSymbol, completedTask)) { - // Are we accessing a member of the completed task? - ISymbol invokedObjectSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax.Expression, context.CancellationToken).Symbol; - IParameterSymbol completedTask = context.SemanticModel.GetDeclaredSymbol(firstParameter); - if (EqualityComparer.Default.Equals(invokedObjectSymbol, completedTask)) - { - // Skip analysis since Task.Result (et. al) of a completed Task is fair game. - return; - } + // Skip analysis since Task.Result (et. al) of a completed Task is fair game. + return; } } } - - CSharpCommonInterest.InspectMemberAccess(context, memberAccessSyntax, Descriptor, problematicMethods); } - private static void AnalyzeInvocation(SyntaxNodeAnalysisContext context, INamedTypeSymbol taskSymbol) - { - var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; - InspectMemberAccess( - context, - invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax, - CommonInterest.ProblematicSyncBlockingMethods, - taskSymbol); - } + CSharpCommonInterest.InspectMemberAccess(context, memberAccessSyntax, Descriptor, problematicMethods); + } - private static void AnalyzeMemberAccess(SyntaxNodeAnalysisContext context, INamedTypeSymbol taskSymbol) - { - var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; - InspectMemberAccess( - context, - memberAccessSyntax, - CommonInterest.SyncBlockingProperties, - taskSymbol); - } + private static void AnalyzeInvocation(SyntaxNodeAnalysisContext context, INamedTypeSymbol taskSymbol) + { + var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; + InspectMemberAccess( + context, + invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax, + CommonInterest.ProblematicSyncBlockingMethods, + taskSymbol); + } + + private static void AnalyzeMemberAccess(SyntaxNodeAnalysisContext context, INamedTypeSymbol taskSymbol) + { + var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; + InspectMemberAccess( + context, + memberAccessSyntax, + CommonInterest.SyncBlockingProperties, + taskSymbol); } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index d0a16d39f..1f7191d9f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -13,296 +13,295 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Detects await Task inside JoinableTaskFactory.Run or RunAsync. +/// +/// +/// [Background] Calling await on a Task inside a JoinableTaskFactory.Run, when the task is initialized outside the delegate can cause potential deadlocks. +/// This problem can be avoided by ensuring the task is initialized within the delegate or by using JoinableTask instead of Task.", +/// +/// i.e. +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD003UseJtfRunAsyncAnalyzer : DiagnosticAnalyzer { - /// - /// Detects await Task inside JoinableTaskFactory.Run or RunAsync. - /// - /// - /// [Background] Calling await on a Task inside a JoinableTaskFactory.Run, when the task is initialized outside the delegate can cause potential deadlocks. - /// This problem can be avoided by ensuring the task is initialized within the delegate or by using JoinableTask instead of Task.", - /// - /// i.e. - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD003UseJtfRunAsyncAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD003"; + public const string Id = "VSTHRD003"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD003_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD003_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD003_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD003_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics + /// + public override ImmutableArray SupportedDiagnostics + { + get { - get - { - return ImmutableArray.Create(Descriptor); - } + return ImmutableArray.Create(Descriptor); } + } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeAwaitExpression), SyntaxKind.AwaitExpression); - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeReturnStatement), SyntaxKind.ReturnStatement); - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeArrowExpressionClause), SyntaxKind.ArrowExpressionClause); - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeLambdaExpression), SyntaxKind.SimpleLambdaExpression); - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeLambdaExpression), SyntaxKind.ParenthesizedLambdaExpression); - } + context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeAwaitExpression), SyntaxKind.AwaitExpression); + context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeReturnStatement), SyntaxKind.ReturnStatement); + context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeArrowExpressionClause), SyntaxKind.ArrowExpressionClause); + context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeLambdaExpression), SyntaxKind.SimpleLambdaExpression); + context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeLambdaExpression), SyntaxKind.ParenthesizedLambdaExpression); + } - private void AnalyzeArrowExpressionClause(SyntaxNodeAnalysisContext context) + private void AnalyzeArrowExpressionClause(SyntaxNodeAnalysisContext context) + { + var arrowExpressionClause = (ArrowExpressionClauseSyntax)context.Node; + if (arrowExpressionClause.Parent is MethodDeclarationSyntax) { - var arrowExpressionClause = (ArrowExpressionClauseSyntax)context.Node; - if (arrowExpressionClause.Parent is MethodDeclarationSyntax) + Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(arrowExpressionClause.Expression, context, context.CancellationToken); + if (diagnostic is object) { - Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(arrowExpressionClause.Expression, context, context.CancellationToken); - if (diagnostic is object) - { - context.ReportDiagnostic(diagnostic); - } + context.ReportDiagnostic(diagnostic); } } + } - private void AnalyzeLambdaExpression(SyntaxNodeAnalysisContext context) + private void AnalyzeLambdaExpression(SyntaxNodeAnalysisContext context) + { + var lambdaExpression = (LambdaExpressionSyntax)context.Node; + if (lambdaExpression.Body is ExpressionSyntax expression) { - var lambdaExpression = (LambdaExpressionSyntax)context.Node; - if (lambdaExpression.Body is ExpressionSyntax expression) + Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(expression, context, context.CancellationToken); + if (diagnostic is object) { - Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(expression, context, context.CancellationToken); - if (diagnostic is object) - { - context.ReportDiagnostic(diagnostic); - } + context.ReportDiagnostic(diagnostic); } } + } - private void AnalyzeReturnStatement(SyntaxNodeAnalysisContext context) + private void AnalyzeReturnStatement(SyntaxNodeAnalysisContext context) + { + var returnStatement = (ReturnStatementSyntax)context.Node; + Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(returnStatement.Expression, context, context.CancellationToken); + if (diagnostic is object) { - var returnStatement = (ReturnStatementSyntax)context.Node; - Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(returnStatement.Expression, context, context.CancellationToken); - if (diagnostic is object) - { - context.ReportDiagnostic(diagnostic); - } + context.ReportDiagnostic(diagnostic); } + } - private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) + private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) + { + AwaitExpressionSyntax awaitExpressionSyntax = (AwaitExpressionSyntax)context.Node; + Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(awaitExpressionSyntax.Expression, context, context.CancellationToken); + if (diagnostic is object) { - AwaitExpressionSyntax awaitExpressionSyntax = (AwaitExpressionSyntax)context.Node; - Diagnostic? diagnostic = this.AnalyzeAwaitedOrReturnedExpression(awaitExpressionSyntax.Expression, context, context.CancellationToken); - if (diagnostic is object) - { - context.ReportDiagnostic(diagnostic); - } + context.ReportDiagnostic(diagnostic); } + } - private Diagnostic? AnalyzeAwaitedOrReturnedExpression(ExpressionSyntax expressionSyntax, SyntaxNodeAnalysisContext context, CancellationToken cancellationToken) + private Diagnostic? AnalyzeAwaitedOrReturnedExpression(ExpressionSyntax expressionSyntax, SyntaxNodeAnalysisContext context, CancellationToken cancellationToken) + { + if (expressionSyntax is null) { - if (expressionSyntax is null) - { - return null; - } + return null; + } - // Get the semantic model for the SyntaxTree for the given ExpressionSyntax, since it *may* not be in the same syntax tree - // as the original context.Node. - if (!context.TryGetNewOrExistingSemanticModel(expressionSyntax.SyntaxTree, out SemanticModel? semanticModel)) - { - return null; - } + // Get the semantic model for the SyntaxTree for the given ExpressionSyntax, since it *may* not be in the same syntax tree + // as the original context.Node. + if (!context.TryGetNewOrExistingSemanticModel(expressionSyntax.SyntaxTree, out SemanticModel? semanticModel)) + { + return null; + } - SymbolInfo symbolToConsider = semanticModel.GetSymbolInfo(expressionSyntax, cancellationToken); - if (CommonInterest.TaskConfigureAwait.Any(configureAwait => configureAwait.IsMatch(symbolToConsider.Symbol))) + SymbolInfo symbolToConsider = semanticModel.GetSymbolInfo(expressionSyntax, cancellationToken); + if (CommonInterest.TaskConfigureAwait.Any(configureAwait => configureAwait.IsMatch(symbolToConsider.Symbol))) + { + // If the invocation is wrapped inside parentheses then drill down to get the invocation. + while (expressionSyntax is ParenthesizedExpressionSyntax parenthesizedExprSyntax) { - // If the invocation is wrapped inside parentheses then drill down to get the invocation. - while (expressionSyntax is ParenthesizedExpressionSyntax parenthesizedExprSyntax) - { - expressionSyntax = parenthesizedExprSyntax.Expression; - } + expressionSyntax = parenthesizedExprSyntax.Expression; + } - Debug.Assert(expressionSyntax is InvocationExpressionSyntax, "expressionSyntax should be an invocation"); + Debug.Assert(expressionSyntax is InvocationExpressionSyntax, "expressionSyntax should be an invocation"); - if (((InvocationExpressionSyntax)expressionSyntax).Expression is MemberAccessExpressionSyntax memberAccessExpression) - { - symbolToConsider = semanticModel.GetSymbolInfo(memberAccessExpression.Expression, cancellationToken); - } + if (((InvocationExpressionSyntax)expressionSyntax).Expression is MemberAccessExpressionSyntax memberAccessExpression) + { + symbolToConsider = semanticModel.GetSymbolInfo(memberAccessExpression.Expression, cancellationToken); } + } - ITypeSymbol symbolType; - bool dataflowAnalysisCompatibleVariable = false; - switch (symbolToConsider.Symbol) - { - case ILocalSymbol localSymbol: - symbolType = localSymbol.Type; - dataflowAnalysisCompatibleVariable = true; - break; - case IParameterSymbol parameterSymbol: - symbolType = parameterSymbol.Type; - dataflowAnalysisCompatibleVariable = true; - break; - case IFieldSymbol fieldSymbol: - symbolType = fieldSymbol.Type; + ITypeSymbol symbolType; + bool dataflowAnalysisCompatibleVariable = false; + switch (symbolToConsider.Symbol) + { + case ILocalSymbol localSymbol: + symbolType = localSymbol.Type; + dataflowAnalysisCompatibleVariable = true; + break; + case IParameterSymbol parameterSymbol: + symbolType = parameterSymbol.Type; + dataflowAnalysisCompatibleVariable = true; + break; + case IFieldSymbol fieldSymbol: + symbolType = fieldSymbol.Type; - // If the field is readonly and initialized with Task.FromResult, it's OK. - if (fieldSymbol.IsReadOnly) + // If the field is readonly and initialized with Task.FromResult, it's OK. + if (fieldSymbol.IsReadOnly) + { + // If we can find the source code for the field, we can check whether it has a field initializer + // that stores the result of a Task.FromResult invocation. + if (!fieldSymbol.DeclaringSyntaxReferences.Any()) { - // If we can find the source code for the field, we can check whether it has a field initializer - // that stores the result of a Task.FromResult invocation. - if (!fieldSymbol.DeclaringSyntaxReferences.Any()) - { - // No syntax for it at all. So outside the compilation. It *probably* is a precompleted cached task, so don't create a diagnostic. - return null; - } + // No syntax for it at all. So outside the compilation. It *probably* is a precompleted cached task, so don't create a diagnostic. + return null; + } - foreach (SyntaxReference? syntaxReference in fieldSymbol.DeclaringSyntaxReferences) + foreach (SyntaxReference? syntaxReference in fieldSymbol.DeclaringSyntaxReferences) + { + if (syntaxReference.GetSyntax(cancellationToken) is VariableDeclaratorSyntax declarationSyntax) { - if (syntaxReference.GetSyntax(cancellationToken) is VariableDeclaratorSyntax declarationSyntax) + if (declarationSyntax.Initializer?.Value is InvocationExpressionSyntax invocationSyntax && + invocationSyntax.Expression is object) { - if (declarationSyntax.Initializer?.Value is InvocationExpressionSyntax invocationSyntax && - invocationSyntax.Expression is object) + if (!context.Compilation.ContainsSyntaxTree(invocationSyntax.SyntaxTree)) { - if (!context.Compilation.ContainsSyntaxTree(invocationSyntax.SyntaxTree)) - { - // We can't look up the definition of the field. It *probably* is a precompleted cached task, so don't create a diagnostic. - return null; - } + // We can't look up the definition of the field. It *probably* is a precompleted cached task, so don't create a diagnostic. + return null; + } - // Whitelist Task.From*() methods. - if (!context.TryGetNewOrExistingSemanticModel(invocationSyntax.SyntaxTree, out SemanticModel? declarationSemanticModel)) - { - return null; - } + // Whitelist Task.From*() methods. + if (!context.TryGetNewOrExistingSemanticModel(invocationSyntax.SyntaxTree, out SemanticModel? declarationSemanticModel)) + { + return null; + } + + if (declarationSemanticModel.GetSymbolInfo(invocationSyntax.Expression, cancellationToken).Symbol is IMethodSymbol invokedMethod && + invokedMethod.ContainingType.Name == nameof(Task) && + invokedMethod.ContainingType.BelongsToNamespace(Types.Task.Namespace) && + (invokedMethod.Name == nameof(Task.FromResult) || invokedMethod.Name == nameof(Task.FromCanceled) || invokedMethod.Name == nameof(Task.FromException))) + { + return null; + } + } + else if (declarationSyntax.Initializer?.Value is MemberAccessExpressionSyntax memberAccessSyntax && memberAccessSyntax.Expression is object) + { + if (!context.TryGetNewOrExistingSemanticModel(memberAccessSyntax.SyntaxTree, out SemanticModel? declarationSemanticModel)) + { + return null; + } - if (declarationSemanticModel.GetSymbolInfo(invocationSyntax.Expression, cancellationToken).Symbol is IMethodSymbol invokedMethod && - invokedMethod.ContainingType.Name == nameof(Task) && - invokedMethod.ContainingType.BelongsToNamespace(Types.Task.Namespace) && - (invokedMethod.Name == nameof(Task.FromResult) || invokedMethod.Name == nameof(Task.FromCanceled) || invokedMethod.Name == nameof(Task.FromException))) + ISymbol? definition = declarationSemanticModel.GetSymbolInfo(memberAccessSyntax, cancellationToken).Symbol; + if (definition is IFieldSymbol field) + { + // Whitelist the TplExtensions.CompletedTask and related fields. + if (field.ContainingType.Name == Types.TplExtensions.TypeName && field.BelongsToNamespace(Types.TplExtensions.Namespace) && + (field.Name == Types.TplExtensions.CompletedTask || field.Name == Types.TplExtensions.CanceledTask || field.Name == Types.TplExtensions.TrueTask || field.Name == Types.TplExtensions.FalseTask)) { return null; } } - else if (declarationSyntax.Initializer?.Value is MemberAccessExpressionSyntax memberAccessSyntax && memberAccessSyntax.Expression is object) + else if (definition is IPropertySymbol property) { - if (!context.TryGetNewOrExistingSemanticModel(memberAccessSyntax.SyntaxTree, out SemanticModel? declarationSemanticModel)) + // Explicitly allow Task.CompletedTask + if (property.ContainingType.Name == Types.Task.TypeName && property.BelongsToNamespace(Types.Task.Namespace) && + property.Name == Types.Task.CompletedTask) { return null; } - - ISymbol? definition = declarationSemanticModel.GetSymbolInfo(memberAccessSyntax, cancellationToken).Symbol; - if (definition is IFieldSymbol field) - { - // Whitelist the TplExtensions.CompletedTask and related fields. - if (field.ContainingType.Name == Types.TplExtensions.TypeName && field.BelongsToNamespace(Types.TplExtensions.Namespace) && - (field.Name == Types.TplExtensions.CompletedTask || field.Name == Types.TplExtensions.CanceledTask || field.Name == Types.TplExtensions.TrueTask || field.Name == Types.TplExtensions.FalseTask)) - { - return null; - } - } - else if (definition is IPropertySymbol property) - { - // Explicitly allow Task.CompletedTask - if (property.ContainingType.Name == Types.Task.TypeName && property.BelongsToNamespace(Types.Task.Namespace) && - property.Name == Types.Task.CompletedTask) - { - return null; - } - } } } } } + } - break; - case IMethodSymbol methodSymbol: - if (Utils.IsTask(methodSymbol.ReturnType) && expressionSyntax is InvocationExpressionSyntax invocationExpressionSyntax) - { - // Consider all arguments - IEnumerable? expressionsToConsider = invocationExpressionSyntax.ArgumentList.Arguments.Select(a => a.Expression); + break; + case IMethodSymbol methodSymbol: + if (Utils.IsTask(methodSymbol.ReturnType) && expressionSyntax is InvocationExpressionSyntax invocationExpressionSyntax) + { + // Consider all arguments + IEnumerable? expressionsToConsider = invocationExpressionSyntax.ArgumentList.Arguments.Select(a => a.Expression); - // Consider the implicit first argument when this method is invoked as an extension method. - if (methodSymbol.IsExtensionMethod && invocationExpressionSyntax.Expression is MemberAccessExpressionSyntax invokedMember) + // Consider the implicit first argument when this method is invoked as an extension method. + if (methodSymbol.IsExtensionMethod && invocationExpressionSyntax.Expression is MemberAccessExpressionSyntax invokedMember) + { + if (!methodSymbol.ContainingType.Equals(semanticModel.GetSymbolInfo(invokedMember.Expression, cancellationToken).Symbol)) { - if (!methodSymbol.ContainingType.Equals(semanticModel.GetSymbolInfo(invokedMember.Expression, cancellationToken).Symbol)) - { - expressionsToConsider = new ExpressionSyntax[] { invokedMember.Expression }.Concat(expressionsToConsider); - } + expressionsToConsider = new ExpressionSyntax[] { invokedMember.Expression }.Concat(expressionsToConsider); } - - return expressionsToConsider.Select(e => this.AnalyzeAwaitedOrReturnedExpression(e, context, cancellationToken)).FirstOrDefault(r => r is object); } - return null; - default: - return null; - } + return expressionsToConsider.Select(e => this.AnalyzeAwaitedOrReturnedExpression(e, context, cancellationToken)).FirstOrDefault(r => r is object); + } - if (symbolType?.Name != nameof(Task) || !symbolType.BelongsToNamespace(Namespaces.SystemThreadingTasks)) - { return null; - } + default: + return null; + } - // Report warning if the task was not initialized within the current delegate or lambda expression - CSharpUtils.ContainingFunctionData containingFunc = CSharpUtils.GetContainingFunction(expressionSyntax); - if (containingFunc.BlockOrExpression is BlockSyntax delegateBlock) - { - if (dataflowAnalysisCompatibleVariable) - { - // Run data flow analysis to understand where the task was defined - DataFlowAnalysis dataFlowAnalysis; + if (symbolType?.Name != nameof(Task) || !symbolType.BelongsToNamespace(Namespaces.SystemThreadingTasks)) + { + return null; + } - // When possible (await is direct child of the block and not a field), execute data flow analysis by passing first and last statement to capture only what happens before the await - // Check if the await is direct child of the code block (first parent is ExpressionStantement, second parent is the block itself) - if (delegateBlock.Equals(expressionSyntax.Parent.Parent?.Parent)) - { - dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock.ChildNodes().First(), expressionSyntax.Parent.Parent); - } - else - { - // Otherwise analyze the data flow for the entire block. One caveat: it doesn't distinguish if the initalization happens after the await. - dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock); - } + // Report warning if the task was not initialized within the current delegate or lambda expression + CSharpUtils.ContainingFunctionData containingFunc = CSharpUtils.GetContainingFunction(expressionSyntax); + if (containingFunc.BlockOrExpression is BlockSyntax delegateBlock) + { + if (dataflowAnalysisCompatibleVariable) + { + // Run data flow analysis to understand where the task was defined + DataFlowAnalysis dataFlowAnalysis; - if (!dataFlowAnalysis.WrittenInside.Contains(symbolToConsider.Symbol)) - { - return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); - } + // When possible (await is direct child of the block and not a field), execute data flow analysis by passing first and last statement to capture only what happens before the await + // Check if the await is direct child of the code block (first parent is ExpressionStantement, second parent is the block itself) + if (delegateBlock.Equals(expressionSyntax.Parent.Parent?.Parent)) + { + dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock.ChildNodes().First(), expressionSyntax.Parent.Parent); } else { - // Do the best we can searching for assignment statements. - if (!CSharpUtils.IsAssignedWithin(containingFunc.BlockOrExpression, semanticModel, symbolToConsider.Symbol, cancellationToken)) - { - return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); - } + // Otherwise analyze the data flow for the entire block. One caveat: it doesn't distinguish if the initalization happens after the await. + dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock); + } + + if (!dataFlowAnalysis.WrittenInside.Contains(symbolToConsider.Symbol)) + { + return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); } } else { - // It's not a block, it's just a lambda expression, so the variable must be external. - return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); + // Do the best we can searching for assignment statements. + if (!CSharpUtils.IsAssignedWithin(containingFunc.BlockOrExpression, semanticModel, symbolToConsider.Symbol, cancellationToken)) + { + return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); + } } - - return null; } + else + { + // It's not a block, it's just a lambda expression, so the variable must be external. + return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); + } + + return null; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs index bf9d35685..43ec46b3d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs @@ -13,483 +13,482 @@ using Microsoft.CodeAnalysis.Operations; using Microsoft.CodeAnalysis.Text; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Flag usage of objects that must only be invoked while on the main thread (e.g. STA COM objects) +/// without having first verified that the current thread is main thread either by throwing if on +/// the wrong thread or asynchronously switching to the main thread. +/// +/// +/// [Background] Most of Visual Studio services especially the legacy services which are implemented in native code +/// are living in STA. Invoking such STA services from background thread would do COM marshaling. The calling background +/// thread will block and wait until the invocation is processed by the STA service on the main thread. It is not only about +/// inefficiency. Such COM marshaling might lead to dead lock if the method occupying the main thread is also waiting for +/// that calling background task and the main thread does not allow COM marshaling to reenter the main thread. To avoid potential +/// dead lock and the expensive COM marshaling, this analyzer would ask the caller of Visual Studio services to verify the +/// current thread is main thread, or switch to main thread prior invocation explicitly. +/// +/// i.e. +/// +/// IVsSolution sln = GetIVsSolution(); +/// sln.SetProperty(); /* This analyzer will report warning on this invocation. */ +/// +/// +/// i.e. +/// +/// ThreadHelper.ThrowIfNotOnUIThread(); +/// IVsSolution sln = GetIVsSolution(); +/// sln.SetProperty(); /* Good */ +/// +/// +/// i.e. +/// +/// await joinableTaskFactory.SwitchToMainThreadAsync(); +/// IVsSolution sln = GetIVsSolution(); +/// sln.SetProperty(); /* Good */ +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD010MainThreadUsageAnalyzer : DiagnosticAnalyzer { + public const string Id = "VSTHRD010"; + /// - /// Flag usage of objects that must only be invoked while on the main thread (e.g. STA COM objects) - /// without having first verified that the current thread is main thread either by throwing if on - /// the wrong thread or asynchronously switching to the main thread. + /// The descriptor to use for diagnostics reported in synchronous methods. /// - /// - /// [Background] Most of Visual Studio services especially the legacy services which are implemented in native code - /// are living in STA. Invoking such STA services from background thread would do COM marshaling. The calling background - /// thread will block and wait until the invocation is processed by the STA service on the main thread. It is not only about - /// inefficiency. Such COM marshaling might lead to dead lock if the method occupying the main thread is also waiting for - /// that calling background task and the main thread does not allow COM marshaling to reenter the main thread. To avoid potential - /// dead lock and the expensive COM marshaling, this analyzer would ask the caller of Visual Studio services to verify the - /// current thread is main thread, or switch to main thread prior invocation explicitly. - /// - /// i.e. - /// - /// IVsSolution sln = GetIVsSolution(); - /// sln.SetProperty(); /* This analyzer will report warning on this invocation. */ - /// - /// - /// i.e. - /// - /// ThreadHelper.ThrowIfNotOnUIThread(); - /// IVsSolution sln = GetIVsSolution(); - /// sln.SetProperty(); /* Good */ - /// - /// - /// i.e. - /// - /// await joinableTaskFactory.SwitchToMainThreadAsync(); - /// IVsSolution sln = GetIVsSolution(); - /// sln.SetProperty(); /* Good */ - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD010MainThreadUsageAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD010"; + internal static readonly DiagnosticDescriptor DescriptorSync = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD010_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD010_MessageFormat_Sync), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + /// + /// The descriptor to use for diagnostics reported in async methods. + /// + internal static readonly DiagnosticDescriptor DescriptorAsync = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD010_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD010_MessageFormat_Async), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + /// + /// A reusable value to return from . + /// + private static readonly ImmutableArray ReusableSupportedDescriptors = ImmutableArray.Create( + DescriptorSync, + DescriptorAsync); + + private readonly LanguageUtils languageUtils = CSharpUtils.Instance; + private enum ThreadingContext + { /// - /// The descriptor to use for diagnostics reported in synchronous methods. + /// The context is not known, either because it was never asserted or switched to, + /// or because a branch in the method exists which changed the context conditionally. /// - internal static readonly DiagnosticDescriptor DescriptorSync = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD010_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD010_MessageFormat_Sync), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + Unknown, /// - /// The descriptor to use for diagnostics reported in async methods. + /// The context is definitely on the main thread. /// - internal static readonly DiagnosticDescriptor DescriptorAsync = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD010_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD010_MessageFormat_Async), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + MainThread, /// - /// A reusable value to return from . + /// The context is definitely on a non-UI thread. /// - private static readonly ImmutableArray ReusableSupportedDescriptors = ImmutableArray.Create( - DescriptorSync, - DescriptorAsync); + NotMainThread, + } - private readonly LanguageUtils languageUtils = CSharpUtils.Instance; + /// + public override ImmutableArray SupportedDiagnostics => ReusableSupportedDescriptors; + + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - private enum ThreadingContext + context.RegisterCompilationStartAction(compilationStartContext => { - /// - /// The context is not known, either because it was never asserted or switched to, - /// or because a branch in the method exists which changed the context conditionally. - /// - Unknown, - - /// - /// The context is definitely on the main thread. - /// - MainThread, - - /// - /// The context is definitely on a non-UI thread. - /// - NotMainThread, - } + var mainThreadAssertingMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); + var mainThreadSwitchingMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); + var membersRequiringMainThread = CommonInterest.ReadTypesAndMembers(compilationStartContext.Options, CommonInterest.FileNamePatternForMembersRequiringMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); + ImmutableDictionary? diagnosticProperties = ImmutableDictionary.Empty + .Add(CommonInterest.FileNamePatternForMethodsThatAssertMainThread.ToString(), string.Join("\n", mainThreadAssertingMethods)) + .Add(CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread.ToString(), string.Join("\n", mainThreadSwitchingMethods)); + + var methodsDeclaringUIThreadRequirement = new HashSet(); + var methodsAssertingUIThreadRequirement = new HashSet(); + var callerToCalleeMap = new Dictionary>(); + + compilationStartContext.RegisterCodeBlockStartAction(codeBlockStartContext => + { + var methodAnalyzer = new MethodAnalyzer( + mainThreadAssertingMethods: mainThreadAssertingMethods, + mainThreadSwitchingMethods: mainThreadSwitchingMethods, + membersRequiringMainThread: membersRequiringMainThread, + methodsDeclaringUIThreadRequirement: methodsDeclaringUIThreadRequirement, + methodsAssertingUIThreadRequirement: methodsAssertingUIThreadRequirement, + diagnosticProperties: diagnosticProperties); + codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); + codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeMemberAccess), SyntaxKind.SimpleMemberAccessExpression); + codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeCast), SyntaxKind.CastExpression); + codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeAs), SyntaxKind.AsExpression); + codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeAs), SyntaxKind.IsExpression); + codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeIsPattern), SyntaxKind.IsPatternExpression); + }); - /// - public override ImmutableArray SupportedDiagnostics => ReusableSupportedDescriptors; + compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AddToCallerCalleeMap(c, callerToCalleeMap)), OperationKind.Invocation); + compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AddToCallerCalleeMap(c, callerToCalleeMap)), OperationKind.PropertyReference); - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + // Strictly speaking, this will miss access to the underlying field, but there's no method to put in the map in that case + compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AddToCallerCalleeMap(c, callerToCalleeMap)), OperationKind.EventAssignment); - context.RegisterCompilationStartAction(compilationStartContext => + compilationStartContext.RegisterCompilationEndAction(compilationEndContext => { - var mainThreadAssertingMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); - var mainThreadSwitchingMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); - var membersRequiringMainThread = CommonInterest.ReadTypesAndMembers(compilationStartContext.Options, CommonInterest.FileNamePatternForMembersRequiringMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); - ImmutableDictionary? diagnosticProperties = ImmutableDictionary.Empty - .Add(CommonInterest.FileNamePatternForMethodsThatAssertMainThread.ToString(), string.Join("\n", mainThreadAssertingMethods)) - .Add(CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread.ToString(), string.Join("\n", mainThreadSwitchingMethods)); - - var methodsDeclaringUIThreadRequirement = new HashSet(); - var methodsAssertingUIThreadRequirement = new HashSet(); - var callerToCalleeMap = new Dictionary>(); - - compilationStartContext.RegisterCodeBlockStartAction(codeBlockStartContext => + Dictionary>? calleeToCallerMap = CreateCalleeToCallerMap(callerToCalleeMap); + HashSet? transitiveClosureOfMainThreadRequiringMethods = GetTransitiveClosureOfMainThreadRequiringMethods(methodsAssertingUIThreadRequirement, calleeToCallerMap); + foreach (IMethodSymbol? implicitUserMethod in transitiveClosureOfMainThreadRequiringMethods.Except(methodsDeclaringUIThreadRequirement)) { - var methodAnalyzer = new MethodAnalyzer( - mainThreadAssertingMethods: mainThreadAssertingMethods, - mainThreadSwitchingMethods: mainThreadSwitchingMethods, - membersRequiringMainThread: membersRequiringMainThread, - methodsDeclaringUIThreadRequirement: methodsDeclaringUIThreadRequirement, - methodsAssertingUIThreadRequirement: methodsAssertingUIThreadRequirement, - diagnosticProperties: diagnosticProperties); - codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); - codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeMemberAccess), SyntaxKind.SimpleMemberAccessExpression); - codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeCast), SyntaxKind.CastExpression); - codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeAs), SyntaxKind.AsExpression); - codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeAs), SyntaxKind.IsExpression); - codeBlockStartContext.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeIsPattern), SyntaxKind.IsPatternExpression); - }); - - compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AddToCallerCalleeMap(c, callerToCalleeMap)), OperationKind.Invocation); - compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AddToCallerCalleeMap(c, callerToCalleeMap)), OperationKind.PropertyReference); - - // Strictly speaking, this will miss access to the underlying field, but there's no method to put in the map in that case - compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AddToCallerCalleeMap(c, callerToCalleeMap)), OperationKind.EventAssignment); - - compilationStartContext.RegisterCompilationEndAction(compilationEndContext => - { - Dictionary>? calleeToCallerMap = CreateCalleeToCallerMap(callerToCalleeMap); - HashSet? transitiveClosureOfMainThreadRequiringMethods = GetTransitiveClosureOfMainThreadRequiringMethods(methodsAssertingUIThreadRequirement, calleeToCallerMap); - foreach (IMethodSymbol? implicitUserMethod in transitiveClosureOfMainThreadRequiringMethods.Except(methodsDeclaringUIThreadRequirement)) + var reportSites = from info in callerToCalleeMap[implicitUserMethod] + where transitiveClosureOfMainThreadRequiringMethods.Contains(info.MethodSymbol) + group info by info.MethodSymbol into bySymbol + select new { Location = bySymbol.First().InvocationSyntax.GetLocation(), CalleeMethod = bySymbol.Key }; + foreach (var site in reportSites) { - var reportSites = from info in callerToCalleeMap[implicitUserMethod] - where transitiveClosureOfMainThreadRequiringMethods.Contains(info.MethodSymbol) - group info by info.MethodSymbol into bySymbol - select new { Location = bySymbol.First().InvocationSyntax.GetLocation(), CalleeMethod = bySymbol.Key }; - foreach (var site in reportSites) - { - bool isAsync = Utils.IsAsyncReady(implicitUserMethod); - DiagnosticDescriptor? descriptor = isAsync ? DescriptorAsync : DescriptorSync; - string calleeName = Utils.GetFullName(site.CalleeMethod); - var formattingArgs = isAsync ? new object[] { calleeName } : new object[] { calleeName, mainThreadAssertingMethods.FirstOrDefault() }; - Diagnostic diagnostic = Diagnostic.Create( - descriptor, - site.Location, - diagnosticProperties, - formattingArgs); - compilationEndContext.ReportDiagnostic(diagnostic); - } + bool isAsync = Utils.IsAsyncReady(implicitUserMethod); + DiagnosticDescriptor? descriptor = isAsync ? DescriptorAsync : DescriptorSync; + string calleeName = Utils.GetFullName(site.CalleeMethod); + var formattingArgs = isAsync ? new object[] { calleeName } : new object[] { calleeName, mainThreadAssertingMethods.FirstOrDefault() }; + Diagnostic diagnostic = Diagnostic.Create( + descriptor, + site.Location, + diagnosticProperties, + formattingArgs); + compilationEndContext.ReportDiagnostic(diagnostic); } - }); + } }); - } + }); + } - private static HashSet GetTransitiveClosureOfMainThreadRequiringMethods(HashSet methodsRequiringUIThread, Dictionary> calleeToCallerMap) - { - var result = new HashSet(); + private static HashSet GetTransitiveClosureOfMainThreadRequiringMethods(HashSet methodsRequiringUIThread, Dictionary> calleeToCallerMap) + { + var result = new HashSet(); - void MarkMethod(IMethodSymbol method) + void MarkMethod(IMethodSymbol method) + { + if (result.Add(method) && calleeToCallerMap.TryGetValue(method, out List? callers)) { - if (result.Add(method) && calleeToCallerMap.TryGetValue(method, out List? callers)) + // If this is an async method, do *not* propagate its thread affinity to its callers. + if (!Utils.IsAsyncCompatibleReturnType(method.ReturnType)) { - // If this is an async method, do *not* propagate its thread affinity to its callers. - if (!Utils.IsAsyncCompatibleReturnType(method.ReturnType)) + foreach (CallInfo caller in callers) { - foreach (CallInfo caller in callers) - { - MarkMethod(caller.MethodSymbol); - } + MarkMethod(caller.MethodSymbol); } } } - - foreach (IMethodSymbol? method in methodsRequiringUIThread) - { - MarkMethod(method); - } - - return result; } - private static Dictionary> CreateCalleeToCallerMap(Dictionary> callerToCalleeMap) + foreach (IMethodSymbol? method in methodsRequiringUIThread) { - var result = new Dictionary>(); + MarkMethod(method); + } - foreach (KeyValuePair> item in callerToCalleeMap) + return result; + } + + private static Dictionary> CreateCalleeToCallerMap(Dictionary> callerToCalleeMap) + { + var result = new Dictionary>(); + + foreach (KeyValuePair> item in callerToCalleeMap) + { + IMethodSymbol? caller = item.Key; + foreach (CallInfo callee in item.Value) { - IMethodSymbol? caller = item.Key; - foreach (CallInfo callee in item.Value) + if (!result.TryGetValue(callee.MethodSymbol, out List? callers)) { - if (!result.TryGetValue(callee.MethodSymbol, out List? callers)) - { - result[callee.MethodSymbol] = callers = new List(); - } - - callers.Add(new CallInfo(methodSymbol: caller, callee.InvocationSyntax)); + result[callee.MethodSymbol] = callers = new List(); } + + callers.Add(new CallInfo(methodSymbol: caller, callee.InvocationSyntax)); } + } + + return result; + } - return result; + private void AddToCallerCalleeMap(OperationAnalysisContext context, Dictionary> callerToCalleeMap) + { + if (CSharpUtils.IsWithinNameOf(context.Operation.Syntax)) + { + return; } - private void AddToCallerCalleeMap(OperationAnalysisContext context, Dictionary> callerToCalleeMap) + IMethodSymbol? GetPropertyAccessor(IPropertySymbol? propertySymbol) { - if (CSharpUtils.IsWithinNameOf(context.Operation.Syntax)) + if (propertySymbol is object) { - return; + return CSharpUtils.IsOnLeftHandOfAssignment(context.Operation.Syntax) + ? propertySymbol.SetMethod + : propertySymbol.GetMethod; } - IMethodSymbol? GetPropertyAccessor(IPropertySymbol? propertySymbol) - { - if (propertySymbol is object) + return null; + } + + ISymbol? targetMethod = null; + SyntaxNode locationToBlame = context.Operation.Syntax; + switch (context.Operation) + { + case IInvocationOperation invocationOperation: + targetMethod = invocationOperation.TargetMethod; + locationToBlame = this.languageUtils.IsolateMethodName(invocationOperation); + break; + case IPropertyReferenceOperation propertyReference: + targetMethod = GetPropertyAccessor(propertyReference.Property); + break; + case IEventAssignmentOperation eventAssignmentOperation: + IOperation eventReferenceOp = eventAssignmentOperation.EventReference; + if (eventReferenceOp is IEventReferenceOperation eventReference) { - return CSharpUtils.IsOnLeftHandOfAssignment(context.Operation.Syntax) - ? propertySymbol.SetMethod - : propertySymbol.GetMethod; + targetMethod = eventAssignmentOperation.Adds + ? eventReference.Event.AddMethod + : eventReference.Event.RemoveMethod; + locationToBlame = eventReference.Syntax; } - return null; - } - - ISymbol? targetMethod = null; - SyntaxNode locationToBlame = context.Operation.Syntax; - switch (context.Operation) - { - case IInvocationOperation invocationOperation: - targetMethod = invocationOperation.TargetMethod; - locationToBlame = this.languageUtils.IsolateMethodName(invocationOperation); - break; - case IPropertyReferenceOperation propertyReference: - targetMethod = GetPropertyAccessor(propertyReference.Property); - break; - case IEventAssignmentOperation eventAssignmentOperation: - IOperation eventReferenceOp = eventAssignmentOperation.EventReference; - if (eventReferenceOp is IEventReferenceOperation eventReference) - { - targetMethod = eventAssignmentOperation.Adds - ? eventReference.Event.AddMethod - : eventReference.Event.RemoveMethod; - locationToBlame = eventReference.Syntax; - } - - break; - } + break; + } - if (context.ContainingSymbol is IMethodSymbol caller && targetMethod is IMethodSymbol callee) + if (context.ContainingSymbol is IMethodSymbol caller && targetMethod is IMethodSymbol callee) + { + lock (callerToCalleeMap) { - lock (callerToCalleeMap) + if (!callerToCalleeMap.TryGetValue(caller, out List callees)) { - if (!callerToCalleeMap.TryGetValue(caller, out List callees)) - { - callerToCalleeMap[caller] = callees = new List(); - } - - callees.Add(new CallInfo(methodSymbol: callee, invocationSyntax: locationToBlame)); + callerToCalleeMap[caller] = callees = new List(); } + + callees.Add(new CallInfo(methodSymbol: callee, invocationSyntax: locationToBlame)); } } + } - private readonly struct CallInfo + private readonly struct CallInfo + { + public CallInfo(IMethodSymbol methodSymbol, SyntaxNode invocationSyntax) { - public CallInfo(IMethodSymbol methodSymbol, SyntaxNode invocationSyntax) - { - this.MethodSymbol = methodSymbol; - this.InvocationSyntax = invocationSyntax; - } + this.MethodSymbol = methodSymbol; + this.InvocationSyntax = invocationSyntax; + } - public IMethodSymbol MethodSymbol { get; } + public IMethodSymbol MethodSymbol { get; } - public SyntaxNode InvocationSyntax { get; } - } + public SyntaxNode InvocationSyntax { get; } + } - private class MethodAnalyzer + private class MethodAnalyzer + { + private ImmutableDictionary methodDeclarationNodes = ImmutableDictionary.Empty; + + public MethodAnalyzer( + ImmutableArray mainThreadAssertingMethods, + ImmutableArray mainThreadSwitchingMethods, + ImmutableArray membersRequiringMainThread, + HashSet methodsDeclaringUIThreadRequirement, + HashSet methodsAssertingUIThreadRequirement, + ImmutableDictionary diagnosticProperties) { - private ImmutableDictionary methodDeclarationNodes = ImmutableDictionary.Empty; - - public MethodAnalyzer( - ImmutableArray mainThreadAssertingMethods, - ImmutableArray mainThreadSwitchingMethods, - ImmutableArray membersRequiringMainThread, - HashSet methodsDeclaringUIThreadRequirement, - HashSet methodsAssertingUIThreadRequirement, - ImmutableDictionary diagnosticProperties) - { - this.MainThreadAssertingMethods = mainThreadAssertingMethods; - this.MainThreadSwitchingMethods = mainThreadSwitchingMethods; - this.MembersRequiringMainThread = membersRequiringMainThread; - this.MethodsDeclaringUIThreadRequirement = methodsDeclaringUIThreadRequirement; - this.MethodsAssertingUIThreadRequirement = methodsAssertingUIThreadRequirement; - this.DiagnosticProperties = diagnosticProperties; - } + this.MainThreadAssertingMethods = mainThreadAssertingMethods; + this.MainThreadSwitchingMethods = mainThreadSwitchingMethods; + this.MembersRequiringMainThread = membersRequiringMainThread; + this.MethodsDeclaringUIThreadRequirement = methodsDeclaringUIThreadRequirement; + this.MethodsAssertingUIThreadRequirement = methodsAssertingUIThreadRequirement; + this.DiagnosticProperties = diagnosticProperties; + } - internal ImmutableArray MainThreadAssertingMethods { get; } + internal ImmutableArray MainThreadAssertingMethods { get; } - internal ImmutableArray MainThreadSwitchingMethods { get; } + internal ImmutableArray MainThreadSwitchingMethods { get; } - internal ImmutableArray MembersRequiringMainThread { get; } + internal ImmutableArray MembersRequiringMainThread { get; } - internal HashSet MethodsDeclaringUIThreadRequirement { get; } + internal HashSet MethodsDeclaringUIThreadRequirement { get; } - internal HashSet MethodsAssertingUIThreadRequirement { get; } + internal HashSet MethodsAssertingUIThreadRequirement { get; } - internal ImmutableDictionary DiagnosticProperties { get; } + internal ImmutableDictionary DiagnosticProperties { get; } - internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + { + var invocationSyntax = (InvocationExpressionSyntax)context.Node; + var invokedMethod = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IMethodSymbol; + if (invokedMethod is object) { - var invocationSyntax = (InvocationExpressionSyntax)context.Node; - var invokedMethod = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IMethodSymbol; - if (invokedMethod is object) + SyntaxNode? methodDeclaration = context.Node.FirstAncestorOrSelf(n => CSharpCommonInterest.MethodSyntaxKinds.Contains(n.Kind())); + if (methodDeclaration is object) { - SyntaxNode? methodDeclaration = context.Node.FirstAncestorOrSelf(n => CSharpCommonInterest.MethodSyntaxKinds.Contains(n.Kind())); - if (methodDeclaration is object) + bool assertsMainThread = this.MainThreadAssertingMethods.Contains(invokedMethod); + bool switchesToMainThread = this.MainThreadSwitchingMethods.Contains(invokedMethod); + if (assertsMainThread || switchesToMainThread) { - bool assertsMainThread = this.MainThreadAssertingMethods.Contains(invokedMethod); - bool switchesToMainThread = this.MainThreadSwitchingMethods.Contains(invokedMethod); - if (assertsMainThread || switchesToMainThread) + if (context.ContainingSymbol is IMethodSymbol callingMethod) { - if (context.ContainingSymbol is IMethodSymbol callingMethod) + lock (this.MethodsDeclaringUIThreadRequirement) { - lock (this.MethodsDeclaringUIThreadRequirement) - { - this.MethodsDeclaringUIThreadRequirement.Add(callingMethod); - } + this.MethodsDeclaringUIThreadRequirement.Add(callingMethod); + } - if (assertsMainThread) + if (assertsMainThread) + { + lock (this.MethodsAssertingUIThreadRequirement) { - lock (this.MethodsAssertingUIThreadRequirement) - { - this.MethodsAssertingUIThreadRequirement.Add(callingMethod); - } + this.MethodsAssertingUIThreadRequirement.Add(callingMethod); } } - - this.methodDeclarationNodes = this.methodDeclarationNodes.SetItem(methodDeclaration, ThreadingContext.MainThread); - return; } + + this.methodDeclarationNodes = this.methodDeclarationNodes.SetItem(methodDeclaration, ThreadingContext.MainThread); + return; } + } - // The diagnostic (if any) should underline the method name only. - ExpressionSyntax? focusedNode = invocationSyntax.Expression; - focusedNode = (focusedNode as MemberAccessExpressionSyntax)?.Name ?? focusedNode; - if (!this.AnalyzeMemberWithinContext(invokedMethod.ContainingType, invokedMethod, context, focusedNode.GetLocation())) + // The diagnostic (if any) should underline the method name only. + ExpressionSyntax? focusedNode = invocationSyntax.Expression; + focusedNode = (focusedNode as MemberAccessExpressionSyntax)?.Name ?? focusedNode; + if (!this.AnalyzeMemberWithinContext(invokedMethod.ContainingType, invokedMethod, context, focusedNode.GetLocation())) + { + foreach (ITypeSymbol? iface in invokedMethod.FindInterfacesImplemented()) { - foreach (ITypeSymbol? iface in invokedMethod.FindInterfacesImplemented()) + if (this.AnalyzeMemberWithinContext(iface, invokedMethod, context, focusedNode.GetLocation())) { - if (this.AnalyzeMemberWithinContext(iface, invokedMethod, context, focusedNode.GetLocation())) - { - // Just report the first diagnostic. - break; - } + // Just report the first diagnostic. + break; } } } } + } - internal void AnalyzeMemberAccess(SyntaxNodeAnalysisContext context) + internal void AnalyzeMemberAccess(SyntaxNodeAnalysisContext context) + { + var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; + var property = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IPropertySymbol; + if (property is object) { - var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; - var property = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IPropertySymbol; - if (property is object) - { - this.AnalyzeMemberWithinContext(property.ContainingType, property, context, memberAccessSyntax.Name.GetLocation()); - } - else + this.AnalyzeMemberWithinContext(property.ContainingType, property, context, memberAccessSyntax.Name.GetLocation()); + } + else + { + var @event = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IEventSymbol; + if (@event is object) { - var @event = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IEventSymbol; - if (@event is object) - { - this.AnalyzeMemberWithinContext(@event.ContainingType, @event, context, memberAccessSyntax.Name.GetLocation()); - } + this.AnalyzeMemberWithinContext(@event.ContainingType, @event, context, memberAccessSyntax.Name.GetLocation()); } } + } - internal void AnalyzeCast(SyntaxNodeAnalysisContext context) + internal void AnalyzeCast(SyntaxNodeAnalysisContext context) + { + var castSyntax = (CastExpressionSyntax)context.Node; + var type = context.SemanticModel.GetSymbolInfo(castSyntax.Type, context.CancellationToken).Symbol as ITypeSymbol; + if (type is object && IsObjectLikelyToBeCOMObject(type)) { - var castSyntax = (CastExpressionSyntax)context.Node; - var type = context.SemanticModel.GetSymbolInfo(castSyntax.Type, context.CancellationToken).Symbol as ITypeSymbol; - if (type is object && IsObjectLikelyToBeCOMObject(type)) - { - this.AnalyzeMemberWithinContext(type, null, context); - } + this.AnalyzeMemberWithinContext(type, null, context); } + } - internal void AnalyzeAs(SyntaxNodeAnalysisContext context) + internal void AnalyzeAs(SyntaxNodeAnalysisContext context) + { + var asSyntax = (BinaryExpressionSyntax)context.Node; + var type = context.SemanticModel.GetSymbolInfo(asSyntax.Right, context.CancellationToken).Symbol as ITypeSymbol; + if (type is object && IsObjectLikelyToBeCOMObject(type)) { - var asSyntax = (BinaryExpressionSyntax)context.Node; - var type = context.SemanticModel.GetSymbolInfo(asSyntax.Right, context.CancellationToken).Symbol as ITypeSymbol; - if (type is object && IsObjectLikelyToBeCOMObject(type)) - { - Location asAndRightSide = Location.Create(context.Node.SyntaxTree, TextSpan.FromBounds(asSyntax.OperatorToken.Span.Start, asSyntax.Right.Span.End)); - this.AnalyzeMemberWithinContext(type, null, context, asAndRightSide); - } + Location asAndRightSide = Location.Create(context.Node.SyntaxTree, TextSpan.FromBounds(asSyntax.OperatorToken.Span.Start, asSyntax.Right.Span.End)); + this.AnalyzeMemberWithinContext(type, null, context, asAndRightSide); } + } - internal void AnalyzeIsPattern(SyntaxNodeAnalysisContext context) + internal void AnalyzeIsPattern(SyntaxNodeAnalysisContext context) + { + var patternSyntax = (IsPatternExpressionSyntax)context.Node; + if (patternSyntax.Pattern is DeclarationPatternSyntax declarationPatternSyntax && declarationPatternSyntax.Type is object) { - var patternSyntax = (IsPatternExpressionSyntax)context.Node; - if (patternSyntax.Pattern is DeclarationPatternSyntax declarationPatternSyntax && declarationPatternSyntax.Type is object) + var type = context.SemanticModel.GetSymbolInfo(declarationPatternSyntax.Type, context.CancellationToken).Symbol as ITypeSymbol; + if (type is object && IsObjectLikelyToBeCOMObject(type)) { - var type = context.SemanticModel.GetSymbolInfo(declarationPatternSyntax.Type, context.CancellationToken).Symbol as ITypeSymbol; - if (type is object && IsObjectLikelyToBeCOMObject(type)) - { - Location isAndTypeSide = Location.Create( - context.Node.SyntaxTree, - TextSpan.FromBounds( - patternSyntax.IsKeyword.SpanStart, - declarationPatternSyntax.Type.Span.End)); - this.AnalyzeMemberWithinContext(type, null, context, isAndTypeSide); - } + Location isAndTypeSide = Location.Create( + context.Node.SyntaxTree, + TextSpan.FromBounds( + patternSyntax.IsKeyword.SpanStart, + declarationPatternSyntax.Type.Span.End)); + this.AnalyzeMemberWithinContext(type, null, context, isAndTypeSide); } } + } - /// - /// Determines whether a given type is likely to be (or implemented by) a COM object. - /// - /// if the type appears to be a COM object; if a managed object. - /// - /// Type casts and type checks are thread-affinitized for (STA) COM objects, and free-threaded for managed ones. - /// - private static bool IsObjectLikelyToBeCOMObject(ITypeSymbol typeSymbol) + /// + /// Determines whether a given type is likely to be (or implemented by) a COM object. + /// + /// if the type appears to be a COM object; if a managed object. + /// + /// Type casts and type checks are thread-affinitized for (STA) COM objects, and free-threaded for managed ones. + /// + private static bool IsObjectLikelyToBeCOMObject(ITypeSymbol typeSymbol) + { + if (typeSymbol is null) { - if (typeSymbol is null) - { - throw new ArgumentNullException(nameof(typeSymbol)); - } + throw new ArgumentNullException(nameof(typeSymbol)); + } + + return typeSymbol.GetAttributes().Any(ad => + (ad.AttributeClass.Name == Types.CoClassAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.CoClassAttribute.Namespace)) || + (ad.AttributeClass.Name == Types.ComImportAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.ComImportAttribute.Namespace)) || + (ad.AttributeClass.Name == Types.InterfaceTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.InterfaceTypeAttribute.Namespace)) || + (ad.AttributeClass.Name == Types.TypeLibTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.TypeLibTypeAttribute.Namespace))); + } - return typeSymbol.GetAttributes().Any(ad => - (ad.AttributeClass.Name == Types.CoClassAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.CoClassAttribute.Namespace)) || - (ad.AttributeClass.Name == Types.ComImportAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.ComImportAttribute.Namespace)) || - (ad.AttributeClass.Name == Types.InterfaceTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.InterfaceTypeAttribute.Namespace)) || - (ad.AttributeClass.Name == Types.TypeLibTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.TypeLibTypeAttribute.Namespace))); + private bool AnalyzeMemberWithinContext(ITypeSymbol type, ISymbol? symbol, SyntaxNodeAnalysisContext context, Location? focusDiagnosticOn = null) + { + if (type is null) + { + throw new ArgumentNullException(nameof(type)); } - private bool AnalyzeMemberWithinContext(ITypeSymbol type, ISymbol? symbol, SyntaxNodeAnalysisContext context, Location? focusDiagnosticOn = null) + bool requiresUIThread = (type.TypeKind == TypeKind.Interface || type.TypeKind == TypeKind.Class || type.TypeKind == TypeKind.Struct) + && this.MembersRequiringMainThread.Contains(type, symbol); + + if (requiresUIThread) { - if (type is null) + ThreadingContext threadingContext = ThreadingContext.Unknown; + SyntaxNode? methodDeclaration = context.Node.FirstAncestorOrSelf(n => CSharpCommonInterest.MethodSyntaxKinds.Contains(n.Kind())); + if (methodDeclaration is object) { - throw new ArgumentNullException(nameof(type)); + threadingContext = this.methodDeclarationNodes.GetValueOrDefault(methodDeclaration); } - bool requiresUIThread = (type.TypeKind == TypeKind.Interface || type.TypeKind == TypeKind.Class || type.TypeKind == TypeKind.Struct) - && this.MembersRequiringMainThread.Contains(type, symbol); - - if (requiresUIThread) + if (threadingContext != ThreadingContext.MainThread) { - ThreadingContext threadingContext = ThreadingContext.Unknown; - SyntaxNode? methodDeclaration = context.Node.FirstAncestorOrSelf(n => CSharpCommonInterest.MethodSyntaxKinds.Contains(n.Kind())); - if (methodDeclaration is object) - { - threadingContext = this.methodDeclarationNodes.GetValueOrDefault(methodDeclaration); - } - - if (threadingContext != ThreadingContext.MainThread) - { - CSharpUtils.ContainingFunctionData function = CSharpUtils.GetContainingFunction((CSharpSyntaxNode)context.Node); - Location location = focusDiagnosticOn ?? context.Node.GetLocation(); - DiagnosticDescriptor? descriptor = function.IsAsync ? DescriptorAsync : DescriptorSync; - var formattingArgs = function.IsAsync ? new object[] { type.Name } : new object[] { type.Name, this.MainThreadAssertingMethods.FirstOrDefault() }; - context.ReportDiagnostic(Diagnostic.Create(descriptor, location, this.DiagnosticProperties, formattingArgs)); - return true; - } + CSharpUtils.ContainingFunctionData function = CSharpUtils.GetContainingFunction((CSharpSyntaxNode)context.Node); + Location location = focusDiagnosticOn ?? context.Node.GetLocation(); + DiagnosticDescriptor? descriptor = function.IsAsync ? DescriptorAsync : DescriptorSync; + var formattingArgs = function.IsAsync ? new object[] { type.Name } : new object[] { type.Name, this.MainThreadAssertingMethods.FirstOrDefault() }; + context.ReportDiagnostic(Diagnostic.Create(descriptor, location, this.DiagnosticProperties, formattingArgs)); + return true; } - - return false; } + + return false; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs index 0f824bee8..6f9b79c0d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs @@ -12,62 +12,61 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers -{ - /// - /// Discourages use of JTF.Run except in public members where the author presumably - /// has limited opportunity to make the method async due to API impact and breaking changes. - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD102"; +namespace Microsoft.VisualStudio.Threading.Analyzers; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD102_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD102_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Info, - isEnabledByDefault: true); +/// +/// Discourages use of JTF.Run except in public members where the author presumably +/// has limited opportunity to make the method async due to API impact and breaking changes. +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer : DiagnosticAnalyzer +{ + public const string Id = "VSTHRD102"; - /// - public override ImmutableArray SupportedDiagnostics - { - get { return ImmutableArray.Create(Descriptor); } - } + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD102_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD102_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Info, + isEnabledByDefault: true); - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override ImmutableArray SupportedDiagnostics + { + get { return ImmutableArray.Create(Descriptor); } + } - context.RegisterCodeBlockStartAction(ctxt => - { - // We want to scan invocations that occur inside internal, synchronous methods - // for calls to JTF.Run or JT.Join. - var methodSymbol = ctxt.OwningSymbol as IMethodSymbol; - if (!methodSymbol.HasAsyncCompatibleReturnType() && !Utils.IsPublic(methodSymbol) && !Utils.IsEntrypointMethod(methodSymbol, ctxt.SemanticModel, ctxt.CancellationToken) && !methodSymbol.FindInterfacesImplemented().Any(Utils.IsPublic)) - { - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); - } - }); - } + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - private static class MethodAnalyzer + context.RegisterCodeBlockStartAction(ctxt => { - internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + // We want to scan invocations that occur inside internal, synchronous methods + // for calls to JTF.Run or JT.Join. + var methodSymbol = ctxt.OwningSymbol as IMethodSymbol; + if (!methodSymbol.HasAsyncCompatibleReturnType() && !Utils.IsPublic(methodSymbol) && !Utils.IsEntrypointMethod(methodSymbol, ctxt.SemanticModel, ctxt.CancellationToken) && !methodSymbol.FindInterfacesImplemented().Any(Utils.IsPublic)) { - var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; - CSharpCommonInterest.InspectMemberAccess( - context, - invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax, - Descriptor, - CommonInterest.JTFSyncBlockers, - ignoreIfInsideAnonymousDelegate: true); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); } + }); + } + + private static class MethodAnalyzer + { + internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + { + var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; + CSharpCommonInterest.InspectMemberAccess( + context, + invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax, + Descriptor, + CommonInterest.JTFSyncBlockers, + ignoreIfInsideAnonymousDelegate: true); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index 3f66fbe73..8f655edf7 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -13,208 +13,207 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// This analyzer recognizes invocations of JoinableTaskFactory.Run(Func{Task}), JoinableTask.Join(), and variants +/// that occur within an async method, thus defeating a perfect opportunity to be asynchronous. +/// +/// +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD103UseAsyncOptionAnalyzer : DiagnosticAnalyzer { - /// - /// This analyzer recognizes invocations of JoinableTaskFactory.Run(Func{Task}), JoinableTask.Join(), and variants - /// that occur within an async method, thus defeating a perfect opportunity to be asynchronous. - /// - /// - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD103UseAsyncOptionAnalyzer : DiagnosticAnalyzer + public const string Id = "VSTHRD103"; + + internal const string AsyncMethodKeyName = "AsyncMethodName"; + + internal const string ExtensionMethodNamespaceKeyName = "ExtensionMethodNamespace"; + + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD103_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD103_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + internal static readonly DiagnosticDescriptor DescriptorNoAlternativeMethod = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD103_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD103_MessageFormat_UseAwaitInstead), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create( + Descriptor, + DescriptorNoAlternativeMethod); + + /// + public override void Initialize(AnalysisContext context) { - public const string Id = "VSTHRD103"; - - internal const string AsyncMethodKeyName = "AsyncMethodName"; - - internal const string ExtensionMethodNamespaceKeyName = "ExtensionMethodNamespace"; - - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD103_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD103_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); - - internal static readonly DiagnosticDescriptor DescriptorNoAlternativeMethod = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD103_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD103_MessageFormat_UseAwaitInstead), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); - - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create( - Descriptor, - DescriptorNoAlternativeMethod); - - /// - public override void Initialize(AnalysisContext context) + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + + context.RegisterCodeBlockStartAction(ctxt => { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); + }); + } - context.RegisterCodeBlockStartAction(ctxt => + private class MethodAnalyzer + { + internal static void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) + { + var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; + if (IsInTaskReturningMethodOrDelegate(context)) { - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); - }); + InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingProperties); + } } - private class MethodAnalyzer + internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) { - internal static void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) + if (IsInTaskReturningMethodOrDelegate(context)) { - var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; - if (IsInTaskReturningMethodOrDelegate(context)) + var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; + var memberAccessSyntax = invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax; + if (InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingMethods)) { - InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingProperties); + // Don't return double-diagnostics. + return; } - } - internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) - { - if (IsInTaskReturningMethodOrDelegate(context)) + // Also consider all method calls to check for Async-suffixed alternatives. + SymbolInfo symbolInfo = context.SemanticModel.GetSymbolInfo(invocationExpressionSyntax, context.CancellationToken); + if (symbolInfo.Symbol is IMethodSymbol methodSymbol && !methodSymbol.Name.EndsWith(VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix, StringComparison.CurrentCulture) && + !methodSymbol.HasAsyncCompatibleReturnType()) { - var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; - var memberAccessSyntax = invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax; - if (InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingMethods)) - { - // Don't return double-diagnostics. - return; - } - - // Also consider all method calls to check for Async-suffixed alternatives. - SymbolInfo symbolInfo = context.SemanticModel.GetSymbolInfo(invocationExpressionSyntax, context.CancellationToken); - if (symbolInfo.Symbol is IMethodSymbol methodSymbol && !methodSymbol.Name.EndsWith(VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix, StringComparison.CurrentCulture) && - !methodSymbol.HasAsyncCompatibleReturnType()) + string asyncMethodName = methodSymbol.Name + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix; + ImmutableArray symbols = context.SemanticModel.LookupSymbols( + invocationExpressionSyntax.Expression.GetLocation().SourceSpan.Start, + methodSymbol.ContainingType, + asyncMethodName, + includeReducedExtensionMethods: true); + + MethodDeclarationSyntax invocationDeclaringMethod = invocationExpressionSyntax.FirstAncestorOrSelf(); + ExpressionSyntax invokedMethodName = CSharpUtils.IsolateMethodName(invocationExpressionSyntax); + foreach (IMethodSymbol m in symbols.OfType()) { - string asyncMethodName = methodSymbol.Name + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix; - ImmutableArray symbols = context.SemanticModel.LookupSymbols( - invocationExpressionSyntax.Expression.GetLocation().SourceSpan.Start, - methodSymbol.ContainingType, - asyncMethodName, - includeReducedExtensionMethods: true); - - MethodDeclarationSyntax invocationDeclaringMethod = invocationExpressionSyntax.FirstAncestorOrSelf(); - ExpressionSyntax invokedMethodName = CSharpUtils.IsolateMethodName(invocationExpressionSyntax); - foreach (IMethodSymbol m in symbols.OfType()) + if (!m.IsObsolete() + && HasSupersetOfParameterTypes(m, methodSymbol) + && m.Name != invocationDeclaringMethod?.Identifier.Text + && m.HasAsyncCompatibleReturnType()) { - if (!m.IsObsolete() - && HasSupersetOfParameterTypes(m, methodSymbol) - && m.Name != invocationDeclaringMethod?.Identifier.Text - && m.HasAsyncCompatibleReturnType()) - { - // An async alternative exists. - ImmutableDictionary? properties = ImmutableDictionary.Empty - .Add(AsyncMethodKeyName, asyncMethodName); - - Diagnostic diagnostic = Diagnostic.Create( - Descriptor, - invokedMethodName.GetLocation(), - properties, - invokedMethodName.ToString(), - asyncMethodName); - context.ReportDiagnostic(diagnostic); - - return; - } + // An async alternative exists. + ImmutableDictionary? properties = ImmutableDictionary.Empty + .Add(AsyncMethodKeyName, asyncMethodName); + + Diagnostic diagnostic = Diagnostic.Create( + Descriptor, + invokedMethodName.GetLocation(), + properties, + invokedMethodName.ToString(), + asyncMethodName); + context.ReportDiagnostic(diagnostic); + + return; } } } } + } + + /// + /// Determines whether the given method has parameters to cover all the parameter types in another method. + /// + /// The candidate method. + /// The baseline method. + /// + /// if has a superset of parameter types found in ; otherwise . + /// + private static bool HasSupersetOfParameterTypes(IMethodSymbol candidateMethod, IMethodSymbol baselineMethod) + { + return candidateMethod.Parameters.All(candidateParameter => baselineMethod.Parameters.Any(baselineParameter => baselineParameter.Type?.Equals(candidateParameter.Type) ?? false)); + } - /// - /// Determines whether the given method has parameters to cover all the parameter types in another method. - /// - /// The candidate method. - /// The baseline method. - /// - /// if has a superset of parameter types found in ; otherwise . - /// - private static bool HasSupersetOfParameterTypes(IMethodSymbol candidateMethod, IMethodSymbol baselineMethod) + private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext context) + { + // We want to scan invocations that occur inside Task and Task-returning delegates or methods. + // That is: methods that either are or could be made async. + IMethodSymbol? methodSymbol = null; + AnonymousFunctionExpressionSyntax? anonymousFunc = context.Node.FirstAncestorOrSelf(); + if (anonymousFunc is object) { - return candidateMethod.Parameters.All(candidateParameter => baselineMethod.Parameters.Any(baselineParameter => baselineParameter.Type?.Equals(candidateParameter.Type) ?? false)); + SymbolInfo symbolInfo = context.SemanticModel.GetSymbolInfo(anonymousFunc, context.CancellationToken); + methodSymbol = symbolInfo.Symbol as IMethodSymbol; } - - private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext context) + else { - // We want to scan invocations that occur inside Task and Task-returning delegates or methods. - // That is: methods that either are or could be made async. - IMethodSymbol? methodSymbol = null; - AnonymousFunctionExpressionSyntax? anonymousFunc = context.Node.FirstAncestorOrSelf(); - if (anonymousFunc is object) - { - SymbolInfo symbolInfo = context.SemanticModel.GetSymbolInfo(anonymousFunc, context.CancellationToken); - methodSymbol = symbolInfo.Symbol as IMethodSymbol; - } - else + MethodDeclarationSyntax? methodDecl = context.Node.FirstAncestorOrSelf(); + if (methodDecl is object) { - MethodDeclarationSyntax? methodDecl = context.Node.FirstAncestorOrSelf(); - if (methodDecl is object) - { - methodSymbol = context.SemanticModel.GetDeclaredSymbol(methodDecl, context.CancellationToken); - } + methodSymbol = context.SemanticModel.GetDeclaredSymbol(methodDecl, context.CancellationToken); } - - return methodSymbol.HasAsyncCompatibleReturnType(); } - private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, [NotNullWhen(true)] MemberAccessExpressionSyntax? memberAccessSyntax, IEnumerable problematicMethods) + return methodSymbol.HasAsyncCompatibleReturnType(); + } + + private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, [NotNullWhen(true)] MemberAccessExpressionSyntax? memberAccessSyntax, IEnumerable problematicMethods) + { + if (memberAccessSyntax is null) { - if (memberAccessSyntax is null) - { - return false; - } + return false; + } - ISymbol? memberSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax, context.CancellationToken).Symbol; - if (memberSymbol is object) + ISymbol? memberSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax, context.CancellationToken).Symbol; + if (memberSymbol is object) + { + foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) { - foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) + if (item.Method.IsMatch(memberSymbol)) { - if (item.Method.IsMatch(memberSymbol)) + Location? location = memberAccessSyntax.Name.GetLocation(); + ImmutableDictionary? properties = ImmutableDictionary.Empty + .Add(ExtensionMethodNamespaceKeyName, item.ExtensionMethodNamespace is object ? string.Join(".", item.ExtensionMethodNamespace) : string.Empty); + DiagnosticDescriptor descriptor; + var messageArgs = new List(2); + messageArgs.Add(item.Method.Name); + if (item.AsyncAlternativeMethodName is object) { - Location? location = memberAccessSyntax.Name.GetLocation(); - ImmutableDictionary? properties = ImmutableDictionary.Empty - .Add(ExtensionMethodNamespaceKeyName, item.ExtensionMethodNamespace is object ? string.Join(".", item.ExtensionMethodNamespace) : string.Empty); - DiagnosticDescriptor descriptor; - var messageArgs = new List(2); - messageArgs.Add(item.Method.Name); - if (item.AsyncAlternativeMethodName is object) - { - properties = properties.Add(AsyncMethodKeyName, item.AsyncAlternativeMethodName); - descriptor = Descriptor; - messageArgs.Add(item.AsyncAlternativeMethodName); - } - else - { - properties = properties.Add(AsyncMethodKeyName, string.Empty); - descriptor = DescriptorNoAlternativeMethod; - } - - Diagnostic diagnostic = Diagnostic.Create(descriptor, location, properties, messageArgs.ToArray()); - context.ReportDiagnostic(diagnostic); - return true; + properties = properties.Add(AsyncMethodKeyName, item.AsyncAlternativeMethodName); + descriptor = Descriptor; + messageArgs.Add(item.AsyncAlternativeMethodName); + } + else + { + properties = properties.Add(AsyncMethodKeyName, string.Empty); + descriptor = DescriptorNoAlternativeMethod; } + + Diagnostic diagnostic = Diagnostic.Create(descriptor, location, properties, messageArgs.ToArray()); + context.ReportDiagnostic(diagnostic); + return true; } } - - return false; } + + return false; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs index e3aa6f4ff..c89bf1dab 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD104OfferAsyncOptionAnalyzer.cs @@ -12,96 +12,95 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD104OfferAsyncOptionAnalyzer : DiagnosticAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD104OfferAsyncOptionAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD104"; + public const string Id = "VSTHRD104"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD104_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD104_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Info, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD104_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD104_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Info, + isEnabledByDefault: true); - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterCodeBlockStartAction(ctxt => + context.RegisterCodeBlockStartAction(ctxt => + { + // We want to scan invocations that occur inside internal, synchronous methods + // for calls to JTF.Run or JT.Join. + var methodSymbol = ctxt.OwningSymbol as IMethodSymbol; + if (!methodSymbol.HasAsyncCompatibleReturnType() && Utils.IsPublic(methodSymbol) && !Utils.IsEntrypointMethod(methodSymbol, ctxt.SemanticModel, ctxt.CancellationToken) && !methodSymbol.HasAsyncAlternative(ctxt.CancellationToken)) { - // We want to scan invocations that occur inside internal, synchronous methods - // for calls to JTF.Run or JT.Join. - var methodSymbol = ctxt.OwningSymbol as IMethodSymbol; - if (!methodSymbol.HasAsyncCompatibleReturnType() && Utils.IsPublic(methodSymbol) && !Utils.IsEntrypointMethod(methodSymbol, ctxt.SemanticModel, ctxt.CancellationToken) && !methodSymbol.HasAsyncAlternative(ctxt.CancellationToken)) - { - var methodAnalyzer = new MethodAnalyzer(); - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); - } - }); + var methodAnalyzer = new MethodAnalyzer(); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); + } + }); + } + + private class MethodAnalyzer + { + private bool diagnosticReported; + + internal void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) + { + var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; + this.InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingProperties); } - private class MethodAnalyzer + internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) { - private bool diagnosticReported; + var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; + this.InspectMemberAccess(context, invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax, CommonInterest.JTFSyncBlockers); + } - internal void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) + private void InspectMemberAccess(SyntaxNodeAnalysisContext context, MemberAccessExpressionSyntax? memberAccessSyntax, IEnumerable problematicMethods) + { + if (memberAccessSyntax is null) { - var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; - this.InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingProperties); + return; } - internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + if (this.diagnosticReported) { - var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; - this.InspectMemberAccess(context, invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax, CommonInterest.JTFSyncBlockers); + // Don't report more than once per method. + return; } - private void InspectMemberAccess(SyntaxNodeAnalysisContext context, MemberAccessExpressionSyntax? memberAccessSyntax, IEnumerable problematicMethods) + if (context.Node.FirstAncestorOrSelf() is object) { - if (memberAccessSyntax is null) - { - return; - } - - if (this.diagnosticReported) - { - // Don't report more than once per method. - return; - } - - if (context.Node.FirstAncestorOrSelf() is object) - { - // We do not analyze JTF.Run inside anonymous functions because - // they are so often used as callbacks where the signature is constrained. - return; - } + // We do not analyze JTF.Run inside anonymous functions because + // they are so often used as callbacks where the signature is constrained. + return; + } - if (CSharpUtils.IsWithinNameOf(context.Node as ExpressionSyntax)) - { - // We do not consider arguments to nameof( ) because they do not represent invocations of code. - return; - } + if (CSharpUtils.IsWithinNameOf(context.Node as ExpressionSyntax)) + { + // We do not consider arguments to nameof( ) because they do not represent invocations of code. + return; + } - ISymbol? invokedMember = context.SemanticModel.GetSymbolInfo(memberAccessSyntax, context.CancellationToken).Symbol; - if (invokedMember is object) + ISymbol? invokedMember = context.SemanticModel.GetSymbolInfo(memberAccessSyntax, context.CancellationToken).Symbol; + if (invokedMember is object) + { + foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) { - foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) + if (item.Method.IsMatch(invokedMember)) { - if (item.Method.IsMatch(invokedMember)) - { - Location? location = memberAccessSyntax.Name.GetLocation(); - context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); - this.diagnosticReported = true; - } + Location? location = memberAccessSyntax.Name.GetLocation(); + context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); + this.diagnosticReported = true; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs index a7e1386ed..642a81a13 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs @@ -12,64 +12,63 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Analyzes expressions of `using` statements and creates a diagnostic when the expression +/// is of type . +/// +/// +/// An example of a flagged issue: +/// +/// +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer : DiagnosticAnalyzer { - /// - /// Analyzes expressions of `using` statements and creates a diagnostic when the expression - /// is of type . - /// - /// - /// An example of a flagged issue: - /// - /// - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD107"; + public const string Id = "VSTHRD107"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD107_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD107_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Error, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD107_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD107_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Error, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); - context.RegisterSyntaxNodeAction( - Utils.DebuggableWrapper(this.AnalyzeNode), - SyntaxKind.UsingStatement); - } + context.RegisterSyntaxNodeAction( + Utils.DebuggableWrapper(this.AnalyzeNode), + SyntaxKind.UsingStatement); + } - private void AnalyzeNode(SyntaxNodeAnalysisContext context) + private void AnalyzeNode(SyntaxNodeAnalysisContext context) + { + var usingStatement = (UsingStatementSyntax)context.Node; + if (usingStatement.Expression is object) { - var usingStatement = (UsingStatementSyntax)context.Node; - if (usingStatement.Expression is object) + TypeInfo expressionTypeInfo = context.SemanticModel.GetTypeInfo(usingStatement.Expression, context.CancellationToken); + ITypeSymbol expressionType = expressionTypeInfo.Type; + if (expressionType?.Name == nameof(Task) && + expressionType.BelongsToNamespace(Namespaces.SystemThreadingTasks)) { - TypeInfo expressionTypeInfo = context.SemanticModel.GetTypeInfo(usingStatement.Expression, context.CancellationToken); - ITypeSymbol expressionType = expressionTypeInfo.Type; - if (expressionType?.Name == nameof(Task) && - expressionType.BelongsToNamespace(Namespaces.SystemThreadingTasks)) - { - context.ReportDiagnostic( - Diagnostic.Create(Descriptor, usingStatement.Expression.GetLocation())); - } + context.ReportDiagnostic( + Diagnostic.Create(Descriptor, usingStatement.Expression.GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index 8dc31fdeb..63f205adc 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -7,55 +7,54 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Report errors when async methods calls are not awaited or the result used in some way within a synchronous method. +/// +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public class VSTHRD110ObserveResultOfAsyncCallsAnalyzer : DiagnosticAnalyzer { - /// - /// Report errors when async methods calls are not awaited or the result used in some way within a synchronous method. - /// - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class VSTHRD110ObserveResultOfAsyncCallsAnalyzer : DiagnosticAnalyzer + public const string Id = "VSTHRD110"; + + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD110_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD110_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + + /// + public override void Initialize(AnalysisContext context) { - public const string Id = "VSTHRD110"; - - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD110_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD110_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(new PerCompilation().AnalyzeInvocation), SyntaxKind.InvocationExpression); + } - /// - public override void Initialize(AnalysisContext context) + private class PerCompilation : DiagnosticAnalyzerState + { + internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + var invocation = (InvocationExpressionSyntax)context.Node; - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(new PerCompilation().AnalyzeInvocation), SyntaxKind.InvocationExpression); - } - - private class PerCompilation : DiagnosticAnalyzerState - { - internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + // Only consider invocations that are direct statements. Otherwise, we assume their + // result is awaited, assigned, or otherwise consumed. + if (invocation.Parent is ExpressionStatementSyntax || invocation.Parent is ConditionalAccessExpressionSyntax) { - var invocation = (InvocationExpressionSyntax)context.Node; - - // Only consider invocations that are direct statements. Otherwise, we assume their - // result is awaited, assigned, or otherwise consumed. - if (invocation.Parent is ExpressionStatementSyntax || invocation.Parent is ConditionalAccessExpressionSyntax) + var methodSymbol = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IMethodSymbol; + if (this.IsAwaitableType(methodSymbol?.ReturnType, context.Compilation, context.CancellationToken)) { - var methodSymbol = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IMethodSymbol; - if (this.IsAwaitableType(methodSymbol?.ReturnType, context.Compilation, context.CancellationToken)) + if (!CSharpUtils.GetContainingFunction(invocation).IsAsync) { - if (!CSharpUtils.GetContainingFunction(invocation).IsAsync) - { - Location? location = (CSharpUtils.IsolateMethodName(invocation) ?? invocation.Expression).GetLocation(); - context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); - } + Location? location = (CSharpUtils.IsolateMethodName(invocation) ?? invocation.Expression).GetLocation(); + context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs index b890e617b..c4c7b1838 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs @@ -19,45 +19,44 @@ using Microsoft.CodeAnalysis.Text; using static Microsoft.VisualStudio.Threading.Analyzers.CommonInterest; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class CommonFixes { - internal static class CommonFixes + internal static async Task> ReadMethodsAsync(CodeFixContext codeFixContext, Regex fileNamePattern, CancellationToken cancellationToken) + { + ImmutableArray.Builder? result = ImmutableArray.CreateBuilder(); + foreach (string line in await ReadAdditionalFilesAsync(codeFixContext.Document.Project.AdditionalDocuments, fileNamePattern, cancellationToken)) + { + result.Add(ParseAdditionalFileMethodLine(line)); + } + + return result.ToImmutable(); + } + + internal static async Task> ReadAdditionalFilesAsync(IEnumerable additionalFiles, Regex fileNamePattern, CancellationToken cancellationToken) { - internal static async Task> ReadMethodsAsync(CodeFixContext codeFixContext, Regex fileNamePattern, CancellationToken cancellationToken) + if (additionalFiles is null) { - ImmutableArray.Builder? result = ImmutableArray.CreateBuilder(); - foreach (string line in await ReadAdditionalFilesAsync(codeFixContext.Document.Project.AdditionalDocuments, fileNamePattern, cancellationToken)) - { - result.Add(ParseAdditionalFileMethodLine(line)); - } + throw new ArgumentNullException(nameof(additionalFiles)); + } - return result.ToImmutable(); + if (fileNamePattern is null) + { + throw new ArgumentNullException(nameof(fileNamePattern)); } - internal static async Task> ReadAdditionalFilesAsync(IEnumerable additionalFiles, Regex fileNamePattern, CancellationToken cancellationToken) + IEnumerable? docs = from doc in additionalFiles.OrderBy(x => x.FilePath, StringComparer.Ordinal) + let fileName = Path.GetFileName(doc.Name) + where fileNamePattern.IsMatch(fileName) + select doc; + ImmutableArray.Builder? result = ImmutableArray.CreateBuilder(); + foreach (TextDocument? doc in docs) { - if (additionalFiles is null) - { - throw new ArgumentNullException(nameof(additionalFiles)); - } - - if (fileNamePattern is null) - { - throw new ArgumentNullException(nameof(fileNamePattern)); - } - - IEnumerable? docs = from doc in additionalFiles.OrderBy(x => x.FilePath, StringComparer.Ordinal) - let fileName = Path.GetFileName(doc.Name) - where fileNamePattern.IsMatch(fileName) - select doc; - ImmutableArray.Builder? result = ImmutableArray.CreateBuilder(); - foreach (TextDocument? doc in docs) - { - SourceText? text = await doc.GetTextAsync(cancellationToken); - result.AddRange(ReadLinesFromAdditionalFile(text)); - } - - return result.ToImmutable(); + SourceText? text = await doc.GetTextAsync(cancellationToken); + result.AddRange(ReadLinesFromAdditionalFile(text)); } + + return result.ToImmutable(); } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs index 77a181a4d..9a412a9c4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs @@ -13,431 +13,430 @@ using Microsoft.CodeAnalysis.Rename; using Microsoft.CodeAnalysis.Simplification; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class FixUtils { - internal static class FixUtils + internal const string BookmarkAnnotationName = "Bookmark"; + + internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this AnonymousFunctionExpressionSyntax method, bool hasReturnValue, SemanticModel semanticModel, CancellationToken cancellationToken) { - internal const string BookmarkAnnotationName = "Bookmark"; + if (method.AsyncKeyword.IsKind(SyntaxKind.AsyncKeyword)) + { + // already async + return method; + } + + AnonymousFunctionExpressionSyntax? updated = null; - internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this AnonymousFunctionExpressionSyntax method, bool hasReturnValue, SemanticModel semanticModel, CancellationToken cancellationToken) + var simpleLambda = method as SimpleLambdaExpressionSyntax; + if (simpleLambda is object) { - if (method.AsyncKeyword.IsKind(SyntaxKind.AsyncKeyword)) - { - // already async - return method; - } + updated = simpleLambda + .WithAsyncKeyword(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) + .WithBody(UpdateStatementsForAsyncMethod(simpleLambda.Body, semanticModel, hasReturnValue, cancellationToken)); + } - AnonymousFunctionExpressionSyntax? updated = null; + var parentheticalLambda = method as ParenthesizedLambdaExpressionSyntax; + if (parentheticalLambda is object) + { + updated = parentheticalLambda + .WithAsyncKeyword(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) + .WithBody(UpdateStatementsForAsyncMethod(parentheticalLambda.Body, semanticModel, hasReturnValue, cancellationToken)); + } - var simpleLambda = method as SimpleLambdaExpressionSyntax; - if (simpleLambda is object) - { - updated = simpleLambda - .WithAsyncKeyword(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) - .WithBody(UpdateStatementsForAsyncMethod(simpleLambda.Body, semanticModel, hasReturnValue, cancellationToken)); - } + var anonymousMethod = method as AnonymousMethodExpressionSyntax; + if (anonymousMethod is object) + { + updated = anonymousMethod + .WithAsyncKeyword(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) + .WithBody(UpdateStatementsForAsyncMethod(anonymousMethod.Body, semanticModel, hasReturnValue, cancellationToken)); + } - var parentheticalLambda = method as ParenthesizedLambdaExpressionSyntax; - if (parentheticalLambda is object) - { - updated = parentheticalLambda - .WithAsyncKeyword(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) - .WithBody(UpdateStatementsForAsyncMethod(parentheticalLambda.Body, semanticModel, hasReturnValue, cancellationToken)); - } + if (updated is null) + { + throw new NotSupportedException(); + } - var anonymousMethod = method as AnonymousMethodExpressionSyntax; - if (anonymousMethod is object) - { - updated = anonymousMethod - .WithAsyncKeyword(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) - .WithBody(UpdateStatementsForAsyncMethod(anonymousMethod.Body, semanticModel, hasReturnValue, cancellationToken)); - } + return updated; + } - if (updated is null) - { - throw new NotSupportedException(); - } + /// + /// Converts a synchronous method to be asynchronous, if it is not already async. + /// + /// The method to convert. + /// The document. + /// The cancellation token. + /// + /// The new Document and method syntax, or the original if it was already async. + /// + /// + /// If is null. + /// -or- + /// If is null. + /// + internal static async Task> MakeMethodAsync(this MethodDeclarationSyntax method, Document document, CancellationToken cancellationToken = default(CancellationToken)) + { + if (method is null) + { + throw new ArgumentNullException(nameof(method)); + } - return updated; + if (document is null) + { + throw new ArgumentNullException(nameof(document)); } - /// - /// Converts a synchronous method to be asynchronous, if it is not already async. - /// - /// The method to convert. - /// The document. - /// The cancellation token. - /// - /// The new Document and method syntax, or the original if it was already async. - /// - /// - /// If is null. - /// -or- - /// If is null. - /// - internal static async Task> MakeMethodAsync(this MethodDeclarationSyntax method, Document document, CancellationToken cancellationToken = default(CancellationToken)) + if (method.Modifiers.Any(SyntaxKind.AsyncKeyword)) { - if (method is null) - { - throw new ArgumentNullException(nameof(method)); - } + // Already asynchronous. + return Tuple.Create(document, method); + } - if (document is null) - { - throw new ArgumentNullException(nameof(document)); - } + DocumentId documentId = document.Id; + SemanticModel? semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); + IMethodSymbol? methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); - if (method.Modifiers.Any(SyntaxKind.AsyncKeyword)) + bool hasReturnValue; + TypeSyntax returnType = method.ReturnType; + if (!Utils.HasAsyncCompatibleReturnType(methodSymbol)) + { + hasReturnValue = (method.ReturnType as PredefinedTypeSyntax)?.Keyword.IsKind(SyntaxKind.VoidKeyword) is not true; + + // Determine new return type. + returnType = hasReturnValue + ? QualifyName( + Namespaces.SystemThreadingTasks, + SyntaxFactory.GenericName(SyntaxFactory.Identifier(nameof(Task))) + .AddTypeArgumentListArguments(method.ReturnType)) + : SyntaxFactory.ParseTypeName(typeof(Task).FullName); + returnType = returnType + .WithAdditionalAnnotations(Simplifier.Annotation) + .WithTrailingTrivia(method.ReturnType.GetTrailingTrivia()); + } + else + { + TypeSyntax t = method.ReturnType; + while (t is QualifiedNameSyntax q) { - // Already asynchronous. - return Tuple.Create(document, method); + t = q.Right; } - DocumentId documentId = document.Id; - SemanticModel? semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - IMethodSymbol? methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); + hasReturnValue = t is GenericNameSyntax; + } - bool hasReturnValue; - TypeSyntax returnType = method.ReturnType; - if (!Utils.HasAsyncCompatibleReturnType(methodSymbol)) - { - hasReturnValue = (method.ReturnType as PredefinedTypeSyntax)?.Keyword.IsKind(SyntaxKind.VoidKeyword) is not true; - - // Determine new return type. - returnType = hasReturnValue - ? QualifyName( - Namespaces.SystemThreadingTasks, - SyntaxFactory.GenericName(SyntaxFactory.Identifier(nameof(Task))) - .AddTypeArgumentListArguments(method.ReturnType)) - : SyntaxFactory.ParseTypeName(typeof(Task).FullName); - returnType = returnType - .WithAdditionalAnnotations(Simplifier.Annotation) - .WithTrailingTrivia(method.ReturnType.GetTrailingTrivia()); - } - else - { - TypeSyntax t = method.ReturnType; - while (t is QualifiedNameSyntax q) - { - t = q.Right; - } + // Fix up any return statements to await on the Task it would have returned. + bool returnTypeChanged = method.ReturnType != returnType; + BlockSyntax updatedBody = UpdateStatementsForAsyncMethod( + method.Body, + semanticModel, + hasReturnValue, + returnTypeChanged, + cancellationToken); + + // Apply the changes to the document, and null out stale data. + SyntaxAnnotation methodBookmark; + (document, method, methodBookmark) = await UpdateDocumentAsync( + document, + method, + m => m + .WithBody(updatedBody) + .AddModifiers(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) + .WithReturnType(returnType), + cancellationToken).ConfigureAwait(false); + semanticModel = null; + methodSymbol = null; + + // Rename the method to have an Async suffix if we changed the return type, + // and it doesn't already have that suffix. + if (returnTypeChanged && !method.Identifier.ValueText.EndsWith(VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix, StringComparison.Ordinal)) + { + string newName = method.Identifier.ValueText + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix; - hasReturnValue = t is GenericNameSyntax; - } + semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); + methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); - // Fix up any return statements to await on the Task it would have returned. - bool returnTypeChanged = method.ReturnType != returnType; - BlockSyntax updatedBody = UpdateStatementsForAsyncMethod( - method.Body, - semanticModel, - hasReturnValue, - returnTypeChanged, - cancellationToken); - - // Apply the changes to the document, and null out stale data. - SyntaxAnnotation methodBookmark; - (document, method, methodBookmark) = await UpdateDocumentAsync( - document, - method, - m => m - .WithBody(updatedBody) - .AddModifiers(SyntaxFactory.Token(SyntaxKind.AsyncKeyword)) - .WithReturnType(returnType), - cancellationToken).ConfigureAwait(false); - semanticModel = null; - methodSymbol = null; - - // Rename the method to have an Async suffix if we changed the return type, - // and it doesn't already have that suffix. - if (returnTypeChanged && !method.Identifier.ValueText.EndsWith(VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix, StringComparison.Ordinal)) + // Don't rename entrypoint (i.e. "Main") methods. + if (!Utils.IsEntrypointMethod(methodSymbol, semanticModel, cancellationToken)) { - string newName = method.Identifier.ValueText + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix; - - semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); - - // Don't rename entrypoint (i.e. "Main") methods. - if (!Utils.IsEntrypointMethod(methodSymbol, semanticModel, cancellationToken)) - { - Solution? solution = await Renamer.RenameSymbolAsync( - document.Project.Solution, - methodSymbol, - newName, - document.Project.Solution.Workspace.Options, - cancellationToken).ConfigureAwait(false); - document = solution.GetDocument(document.Id); - semanticModel = null; - methodSymbol = null; - SyntaxNode? root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - method = (MethodDeclarationSyntax)root.GetAnnotatedNodes(methodBookmark).Single(); - } + Solution? solution = await Renamer.RenameSymbolAsync( + document.Project.Solution, + methodSymbol, + newName, + document.Project.Solution.Workspace.Options, + cancellationToken).ConfigureAwait(false); + document = solution.GetDocument(document.Id); + semanticModel = null; + methodSymbol = null; + SyntaxNode? root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + method = (MethodDeclarationSyntax)root.GetAnnotatedNodes(methodBookmark).Single(); } + } - // Update callers to await calls to this method if we made it awaitable. - if (returnTypeChanged) + // Update callers to await calls to this method if we made it awaitable. + if (returnTypeChanged) + { + semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); + methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); + SyntaxAnnotation callerAnnotation; + Solution solution = document.Project.Solution; + List annotatedDocumentIds; + (solution, callerAnnotation, annotatedDocumentIds) = await AnnotateAllCallersAsync(solution, methodSymbol, cancellationToken).ConfigureAwait(false); + foreach (DocumentId docId in annotatedDocumentIds) { - semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); - SyntaxAnnotation callerAnnotation; - Solution solution = document.Project.Solution; - List annotatedDocumentIds; - (solution, callerAnnotation, annotatedDocumentIds) = await AnnotateAllCallersAsync(solution, methodSymbol, cancellationToken).ConfigureAwait(false); - foreach (DocumentId docId in annotatedDocumentIds) - { - document = solution.GetDocument(docId); - SyntaxTree? tree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); - SyntaxNode? root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); - var rewriter = new AwaitCallRewriter(callerAnnotation); - root = rewriter.Visit(root); - solution = solution.GetDocument(tree).WithSyntaxRoot(root).Project.Solution; - } + document = solution.GetDocument(docId); + SyntaxTree? tree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode? root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); + var rewriter = new AwaitCallRewriter(callerAnnotation); + root = rewriter.Visit(root); + solution = solution.GetDocument(tree).WithSyntaxRoot(root).Project.Solution; + } - foreach (DocumentId docId in annotatedDocumentIds) + foreach (DocumentId docId in annotatedDocumentIds) + { + document = solution.GetDocument(docId); + SyntaxTree? tree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode? root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); + for (SyntaxNode? node = root.GetAnnotatedNodes(callerAnnotation).FirstOrDefault(); node is object; node = root.GetAnnotatedNodes(callerAnnotation).FirstOrDefault()) { - document = solution.GetDocument(docId); - SyntaxTree? tree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); - SyntaxNode? root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); - for (SyntaxNode? node = root.GetAnnotatedNodes(callerAnnotation).FirstOrDefault(); node is object; node = root.GetAnnotatedNodes(callerAnnotation).FirstOrDefault()) + MethodDeclarationSyntax? callingMethod = node.FirstAncestorOrSelf(); + if (callingMethod is object) { - MethodDeclarationSyntax? callingMethod = node.FirstAncestorOrSelf(); - if (callingMethod is object) - { - (document, callingMethod) = await MakeMethodAsync(callingMethod, document, cancellationToken).ConfigureAwait(false); - - // Clear all annotations of callers from this method so we don't revisit it. - root = await callingMethod.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); - var annotationRemover = new RemoveAnnotationRewriter(callerAnnotation); - root = root.ReplaceNode(callingMethod, annotationRemover.Visit(callingMethod)); - document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - } - else - { - // Clear all annotations of callers from this method so we don't revisit it. - root = await node.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); - root = root.ReplaceNode(node, node.WithoutAnnotations(callerAnnotation)); - document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - } + (document, callingMethod) = await MakeMethodAsync(callingMethod, document, cancellationToken).ConfigureAwait(false); + + // Clear all annotations of callers from this method so we don't revisit it. + root = await callingMethod.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); + var annotationRemover = new RemoveAnnotationRewriter(callerAnnotation); + root = root.ReplaceNode(callingMethod, annotationRemover.Visit(callingMethod)); + document = document.WithSyntaxRoot(root); + root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + } + else + { + // Clear all annotations of callers from this method so we don't revisit it. + root = await node.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); + root = root.ReplaceNode(node, node.WithoutAnnotations(callerAnnotation)); + document = document.WithSyntaxRoot(root); + root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); } - - solution = document.Project.Solution; } - // Make sure we return the latest of everything. - document = solution.GetDocument(documentId); - SyntaxTree? finalTree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); - SyntaxNode? finalRoot = await finalTree.GetRootAsync(cancellationToken).ConfigureAwait(false); - method = (MethodDeclarationSyntax)finalRoot.GetAnnotatedNodes(methodBookmark).Single(); + solution = document.Project.Solution; } - return Tuple.Create(document, method); + // Make sure we return the latest of everything. + document = solution.GetDocument(documentId); + SyntaxTree? finalTree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode? finalRoot = await finalTree.GetRootAsync(cancellationToken).ConfigureAwait(false); + method = (MethodDeclarationSyntax)finalRoot.GetAnnotatedNodes(methodBookmark).Single(); } - internal static async Task>> AnnotateAllCallersAsync(Solution solution, ISymbol symbol, CancellationToken cancellationToken) + return Tuple.Create(document, method); + } + + internal static async Task>> AnnotateAllCallersAsync(Solution solution, ISymbol symbol, CancellationToken cancellationToken) + { + var bookmark = new SyntaxAnnotation(); + IEnumerable? callers = await SymbolFinder.FindCallersAsync(symbol, solution, cancellationToken).ConfigureAwait(false); + IEnumerable>? callersByFile = from caller in callers + from location in caller.Locations + group location by location.SourceTree into file + select file; + var updatedDocs = new List(); + foreach (IGrouping? callerByFile in callersByFile) { - var bookmark = new SyntaxAnnotation(); - IEnumerable? callers = await SymbolFinder.FindCallersAsync(symbol, solution, cancellationToken).ConfigureAwait(false); - IEnumerable>? callersByFile = from caller in callers - from location in caller.Locations - group location by location.SourceTree into file - select file; - var updatedDocs = new List(); - foreach (IGrouping? callerByFile in callersByFile) + SyntaxNode? root = await callerByFile.Key.GetRootAsync(cancellationToken).ConfigureAwait(false); + foreach (Location? caller in callerByFile) { - SyntaxNode? root = await callerByFile.Key.GetRootAsync(cancellationToken).ConfigureAwait(false); - foreach (Location? caller in callerByFile) + SyntaxNode? node = root.FindNode(caller.SourceSpan); + InvocationExpressionSyntax? invocation = node.FirstAncestorOrSelf(); + if (invocation is object) { - SyntaxNode? node = root.FindNode(caller.SourceSpan); - InvocationExpressionSyntax? invocation = node.FirstAncestorOrSelf(); - if (invocation is object) - { - root = root.ReplaceNode(invocation, invocation.WithAdditionalAnnotations(bookmark)); - } + root = root.ReplaceNode(invocation, invocation.WithAdditionalAnnotations(bookmark)); } - - Document updatedDocument = solution.GetDocument(callerByFile.Key) - .WithSyntaxRoot(root); - updatedDocs.Add(updatedDocument.Id); - solution = updatedDocument.Project.Solution; } - return Tuple.Create(solution, bookmark, updatedDocs); + Document updatedDocument = solution.GetDocument(callerByFile.Key) + .WithSyntaxRoot(root); + updatedDocs.Add(updatedDocument.Id); + solution = updatedDocument.Project.Solution; } - internal static async Task> UpdateDocumentAsync(Document document, T syntaxNode, Func syntaxNodeTransform, CancellationToken cancellationToken) - where T : SyntaxNode + return Tuple.Create(solution, bookmark, updatedDocs); + } + + internal static async Task> UpdateDocumentAsync(Document document, T syntaxNode, Func syntaxNodeTransform, CancellationToken cancellationToken) + where T : SyntaxNode + { + SyntaxAnnotation bookmark; + SyntaxNode root; + (bookmark, document, syntaxNode, root) = await BookmarkSyntaxAsync(document, syntaxNode, cancellationToken).ConfigureAwait(false); + + T? newSyntaxNode = syntaxNodeTransform(syntaxNode); + if (!newSyntaxNode.HasAnnotation(bookmark)) { - SyntaxAnnotation bookmark; - SyntaxNode root; - (bookmark, document, syntaxNode, root) = await BookmarkSyntaxAsync(document, syntaxNode, cancellationToken).ConfigureAwait(false); + newSyntaxNode = syntaxNode.CopyAnnotationsTo(newSyntaxNode); + } - T? newSyntaxNode = syntaxNodeTransform(syntaxNode); - if (!newSyntaxNode.HasAnnotation(bookmark)) - { - newSyntaxNode = syntaxNode.CopyAnnotationsTo(newSyntaxNode); - } + root = root.ReplaceNode(syntaxNode, newSyntaxNode); + document = document.WithSyntaxRoot(root); + root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + newSyntaxNode = (T)root.GetAnnotatedNodes(bookmark).Single(); - root = root.ReplaceNode(syntaxNode, newSyntaxNode); - document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - newSyntaxNode = (T)root.GetAnnotatedNodes(bookmark).Single(); + return Tuple.Create(document, newSyntaxNode, bookmark); + } - return Tuple.Create(document, newSyntaxNode, bookmark); - } + internal static async Task> BookmarkSyntaxAsync(Document document, T syntaxNode, CancellationToken cancellationToken) + where T : SyntaxNode + { + var bookmark = new SyntaxAnnotation(BookmarkAnnotationName); + SyntaxNode? root = await syntaxNode.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); + root = root.ReplaceNode(syntaxNode, syntaxNode.WithAdditionalAnnotations(bookmark)); + document = document.WithSyntaxRoot(root); + root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + syntaxNode = (T)root.GetAnnotatedNodes(bookmark).Single(); + + return Tuple.Create(bookmark, document, syntaxNode, root); + } - internal static async Task> BookmarkSyntaxAsync(Document document, T syntaxNode, CancellationToken cancellationToken) - where T : SyntaxNode + internal static NameSyntax QualifyName(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) + { + if (qualifiers is null) { - var bookmark = new SyntaxAnnotation(BookmarkAnnotationName); - SyntaxNode? root = await syntaxNode.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); - root = root.ReplaceNode(syntaxNode, syntaxNode.WithAdditionalAnnotations(bookmark)); - document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - syntaxNode = (T)root.GetAnnotatedNodes(bookmark).Single(); - - return Tuple.Create(bookmark, document, syntaxNode, root); + throw new ArgumentNullException(nameof(qualifiers)); } - internal static NameSyntax QualifyName(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) + if (simpleName is null) { - if (qualifiers is null) - { - throw new ArgumentNullException(nameof(qualifiers)); - } + throw new ArgumentNullException(nameof(simpleName)); + } - if (simpleName is null) - { - throw new ArgumentNullException(nameof(simpleName)); - } + if (qualifiers.Count == 0) + { + throw new ArgumentException("At least one qualifier required."); + } - if (qualifiers.Count == 0) - { - throw new ArgumentException("At least one qualifier required."); - } + NameSyntax result = SyntaxFactory.IdentifierName(qualifiers[0]); + for (int i = 1; i < qualifiers.Count; i++) + { + IdentifierNameSyntax? rightSide = SyntaxFactory.IdentifierName(qualifiers[i]); + result = SyntaxFactory.QualifiedName(result, rightSide); + } - NameSyntax result = SyntaxFactory.IdentifierName(qualifiers[0]); - for (int i = 1; i < qualifiers.Count; i++) - { - IdentifierNameSyntax? rightSide = SyntaxFactory.IdentifierName(qualifiers[i]); - result = SyntaxFactory.QualifiedName(result, rightSide); - } + return SyntaxFactory.QualifiedName(result, simpleName); + } - return SyntaxFactory.QualifiedName(result, simpleName); + private static CSharpSyntaxNode UpdateStatementsForAsyncMethod(CSharpSyntaxNode body, SemanticModel semanticModel, bool hasResultValue, CancellationToken cancellationToken) + { + var blockBody = body as BlockSyntax; + if (blockBody is object) + { + bool returnTypeChanged = false; // probably not right, but we don't have a failing test yet. + return UpdateStatementsForAsyncMethod(blockBody, semanticModel, hasResultValue, returnTypeChanged, cancellationToken); } - private static CSharpSyntaxNode UpdateStatementsForAsyncMethod(CSharpSyntaxNode body, SemanticModel semanticModel, bool hasResultValue, CancellationToken cancellationToken) + var expressionBody = body as ExpressionSyntax; + if (expressionBody is object) { - var blockBody = body as BlockSyntax; - if (blockBody is object) - { - bool returnTypeChanged = false; // probably not right, but we don't have a failing test yet. - return UpdateStatementsForAsyncMethod(blockBody, semanticModel, hasResultValue, returnTypeChanged, cancellationToken); - } + return SyntaxFactory.AwaitExpression(expressionBody).TrySimplify(expressionBody, semanticModel, cancellationToken); + } - var expressionBody = body as ExpressionSyntax; - if (expressionBody is object) - { - return SyntaxFactory.AwaitExpression(expressionBody).TrySimplify(expressionBody, semanticModel, cancellationToken); - } + throw new NotSupportedException(); + } - throw new NotSupportedException(); - } + private static BlockSyntax UpdateStatementsForAsyncMethod(BlockSyntax body, SemanticModel semanticModel, bool hasResultValue, bool returnTypeChanged, CancellationToken cancellationToken) + { + BlockSyntax? fixedUpBlock = body.ReplaceNodes( + body.DescendantNodes().OfType(), + (f, n) => + { + if (hasResultValue) + { + return returnTypeChanged + ? n + : n.WithExpression(SyntaxFactory.AwaitExpression(n.Expression).TrySimplify(f.Expression, semanticModel, cancellationToken)); + } - private static BlockSyntax UpdateStatementsForAsyncMethod(BlockSyntax body, SemanticModel semanticModel, bool hasResultValue, bool returnTypeChanged, CancellationToken cancellationToken) - { - BlockSyntax? fixedUpBlock = body.ReplaceNodes( - body.DescendantNodes().OfType(), - (f, n) => + if (body.Statements.Last() == f) { - if (hasResultValue) - { - return returnTypeChanged - ? n - : n.WithExpression(SyntaxFactory.AwaitExpression(n.Expression).TrySimplify(f.Expression, semanticModel, cancellationToken)); - } + // If it is the last statement in the method, we can remove it since a return is implied. + return null; + } - if (body.Statements.Last() == f) - { - // If it is the last statement in the method, we can remove it since a return is implied. - return null; - } + return n + .WithExpression(null) // don't return any value + .WithReturnKeyword(n.ReturnKeyword.WithTrailingTrivia(SyntaxFactory.TriviaList())); // remove the trailing space after the keyword + }); - return n - .WithExpression(null) // don't return any value - .WithReturnKeyword(n.ReturnKeyword.WithTrailingTrivia(SyntaxFactory.TriviaList())); // remove the trailing space after the keyword - }); + return fixedUpBlock; + } - return fixedUpBlock; + private static ExpressionSyntax TrySimplify(this AwaitExpressionSyntax awaitExpression, ExpressionSyntax originalSyntax, SemanticModel semanticModel, CancellationToken cancellationToken) + { + if (awaitExpression is null) + { + throw new ArgumentNullException(nameof(awaitExpression)); } - private static ExpressionSyntax TrySimplify(this AwaitExpressionSyntax awaitExpression, ExpressionSyntax originalSyntax, SemanticModel semanticModel, CancellationToken cancellationToken) + // await Task.FromResult(x) => x. + if (semanticModel is object) { - if (awaitExpression is null) - { - throw new ArgumentNullException(nameof(awaitExpression)); - } - - // await Task.FromResult(x) => x. - if (semanticModel is object) + if (awaitExpression.Expression is InvocationExpressionSyntax awaitedInvocation + && awaitedInvocation.Expression is MemberAccessExpressionSyntax awaitedInvocationMemberAccess + && awaitedInvocationMemberAccess.Name.Identifier.Text == nameof(Task.FromResult)) { - if (awaitExpression.Expression is InvocationExpressionSyntax awaitedInvocation - && awaitedInvocation.Expression is MemberAccessExpressionSyntax awaitedInvocationMemberAccess - && awaitedInvocationMemberAccess.Name.Identifier.Text == nameof(Task.FromResult)) + // Is the FromResult method on the Task or Task class? + ISymbol? memberOwnerSymbol = semanticModel.GetSymbolInfo(originalSyntax, cancellationToken).Symbol; + if (Utils.IsTask(memberOwnerSymbol?.ContainingType)) { - // Is the FromResult method on the Task or Task class? - ISymbol? memberOwnerSymbol = semanticModel.GetSymbolInfo(originalSyntax, cancellationToken).Symbol; - if (Utils.IsTask(memberOwnerSymbol?.ContainingType)) - { - ExpressionSyntax? simplified = awaitedInvocation.ArgumentList.Arguments.Single().Expression; - return simplified; - } + ExpressionSyntax? simplified = awaitedInvocation.ArgumentList.Arguments.Single().Expression; + return simplified; } } - - return awaitExpression; } - private class AwaitCallRewriter : CSharpSyntaxRewriter + return awaitExpression; + } + + private class AwaitCallRewriter : CSharpSyntaxRewriter + { + private readonly SyntaxAnnotation callAnnotation; + + public AwaitCallRewriter(SyntaxAnnotation callAnnotation) + : base(visitIntoStructuredTrivia: false) { - private readonly SyntaxAnnotation callAnnotation; + this.callAnnotation = callAnnotation ?? throw new ArgumentNullException(nameof(callAnnotation)); + } - public AwaitCallRewriter(SyntaxAnnotation callAnnotation) - : base(visitIntoStructuredTrivia: false) + public override SyntaxNode VisitInvocationExpression(InvocationExpressionSyntax node) + { + if (node.HasAnnotation(this.callAnnotation)) { - this.callAnnotation = callAnnotation ?? throw new ArgumentNullException(nameof(callAnnotation)); + return SyntaxFactory.ParenthesizedExpression( + SyntaxFactory.AwaitExpression(node)) + .WithAdditionalAnnotations(Simplifier.Annotation); } - public override SyntaxNode VisitInvocationExpression(InvocationExpressionSyntax node) - { - if (node.HasAnnotation(this.callAnnotation)) - { - return SyntaxFactory.ParenthesizedExpression( - SyntaxFactory.AwaitExpression(node)) - .WithAdditionalAnnotations(Simplifier.Annotation); - } - - return base.VisitInvocationExpression(node); - } + return base.VisitInvocationExpression(node); } + } - private class RemoveAnnotationRewriter : CSharpSyntaxRewriter - { - private readonly SyntaxAnnotation annotationToRemove; + private class RemoveAnnotationRewriter : CSharpSyntaxRewriter + { + private readonly SyntaxAnnotation annotationToRemove; - public RemoveAnnotationRewriter(SyntaxAnnotation annotationToRemove) - : base(visitIntoStructuredTrivia: false) - { - this.annotationToRemove = annotationToRemove ?? throw new ArgumentNullException(nameof(annotationToRemove)); - } + public RemoveAnnotationRewriter(SyntaxAnnotation annotationToRemove) + : base(visitIntoStructuredTrivia: false) + { + this.annotationToRemove = annotationToRemove ?? throw new ArgumentNullException(nameof(annotationToRemove)); + } - public override SyntaxNode Visit(SyntaxNode node) - { - return base.Visit( - (node?.HasAnnotation(this.annotationToRemove) ?? false) - ? node.WithoutAnnotations(this.annotationToRemove) - : node); - } + public override SyntaxNode Visit(SyntaxNode node) + { + return base.Visit( + (node?.HasAnnotation(this.annotationToRemove) ?? false) + ? node.WithoutAnnotations(this.annotationToRemove) + : node); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs index 278bed254..79c7d256e 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/NullableHelpers.cs @@ -3,24 +3,23 @@ using System; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class NullableHelpers { - internal static class NullableHelpers + /// + /// Converts a delegate which can return to a delegate which does not return + /// . The safety of the conversion is not checked, so callers are required to ensure the + /// conditions are met so the delegate does not produce a result in practice. + /// + /// The type of the first parameter of the method that the delegate encapsulates. + /// The type of the second parameter of the method that the delegate encapsulates. + /// The type of the return value of the method that the delegate encapsulates. + /// The delegate which, according to the signature, can return . + /// A copy of with a signature that does not return . + internal static Func AsNonNullReturnUnchecked(Func func) + where TResult : class { - /// - /// Converts a delegate which can return to a delegate which does not return - /// . The safety of the conversion is not checked, so callers are required to ensure the - /// conditions are met so the delegate does not produce a result in practice. - /// - /// The type of the first parameter of the method that the delegate encapsulates. - /// The type of the second parameter of the method that the delegate encapsulates. - /// The type of the return value of the method that the delegate encapsulates. - /// The delegate which, according to the signature, can return . - /// A copy of with a signature that does not return . - internal static Func AsNonNullReturnUnchecked(Func func) - where TResult : class - { - return func!; - } + return func!; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs index aa630b181..d272fc0d8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/SyntaxGeneratorExtensions.cs @@ -5,58 +5,57 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Editing; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class SyntaxGeneratorExtensions { - internal static class SyntaxGeneratorExtensions + /// + /// Creates a reference to a named type suitable for use in accessing a static member of the type. + /// + /// The used to create the type reference. + /// The named type to reference. + /// A representing the type reference expression. + internal static SyntaxNode TypeExpressionForStaticMemberAccess(this SyntaxGenerator generator, INamedTypeSymbol typeSymbol) { - /// - /// Creates a reference to a named type suitable for use in accessing a static member of the type. - /// - /// The used to create the type reference. - /// The named type to reference. - /// A representing the type reference expression. - internal static SyntaxNode TypeExpressionForStaticMemberAccess(this SyntaxGenerator generator, INamedTypeSymbol typeSymbol) - { - var qualifiedNameSyntaxKind = generator.QualifiedName(generator.IdentifierName("ignored"), generator.IdentifierName("ignored")).RawKind; - var memberAccessExpressionSyntaxKind = generator.MemberAccessExpression(generator.IdentifierName("ignored"), "ignored").RawKind; + var qualifiedNameSyntaxKind = generator.QualifiedName(generator.IdentifierName("ignored"), generator.IdentifierName("ignored")).RawKind; + var memberAccessExpressionSyntaxKind = generator.MemberAccessExpression(generator.IdentifierName("ignored"), "ignored").RawKind; - SyntaxNode? typeExpression = generator.TypeExpression(typeSymbol); - return QualifiedNameToMemberAccess(qualifiedNameSyntaxKind, memberAccessExpressionSyntaxKind, typeExpression, generator); + SyntaxNode? typeExpression = generator.TypeExpression(typeSymbol); + return QualifiedNameToMemberAccess(qualifiedNameSyntaxKind, memberAccessExpressionSyntaxKind, typeExpression, generator); - // Local function - static SyntaxNode QualifiedNameToMemberAccess(int qualifiedNameSyntaxKind, int memberAccessExpressionSyntaxKind, SyntaxNode expression, SyntaxGenerator generator) + // Local function + static SyntaxNode QualifiedNameToMemberAccess(int qualifiedNameSyntaxKind, int memberAccessExpressionSyntaxKind, SyntaxNode expression, SyntaxGenerator generator) + { + if (expression.RawKind == qualifiedNameSyntaxKind) { - if (expression.RawKind == qualifiedNameSyntaxKind) - { - SyntaxNode? left = QualifiedNameToMemberAccess(qualifiedNameSyntaxKind, memberAccessExpressionSyntaxKind, expression.ChildNodes().First(), generator); - SyntaxNode? right = expression.ChildNodes().Last(); - return generator.MemberAccessExpression(left, right); - } - - return expression; + SyntaxNode? left = QualifiedNameToMemberAccess(qualifiedNameSyntaxKind, memberAccessExpressionSyntaxKind, expression.ChildNodes().First(), generator); + SyntaxNode? right = expression.ChildNodes().Last(); + return generator.MemberAccessExpression(left, right); } + + return expression; + } + } + + internal static SyntaxNode? TryGetContainingDeclaration(this SyntaxGenerator generator, SyntaxNode? node, DeclarationKind? kind = null) + { + if (node is null) + { + return null; } - internal static SyntaxNode? TryGetContainingDeclaration(this SyntaxGenerator generator, SyntaxNode? node, DeclarationKind? kind = null) + DeclarationKind declarationKind = generator.GetDeclarationKind(node); + while ((kind.HasValue && declarationKind != kind) || (!kind.HasValue && declarationKind == DeclarationKind.None)) { + node = generator.GetDeclaration(node.Parent); if (node is null) { return null; } - DeclarationKind declarationKind = generator.GetDeclarationKind(node); - while ((kind.HasValue && declarationKind != kind) || (!kind.HasValue && declarationKind == DeclarationKind.None)) - { - node = generator.GetDeclaration(node.Parent); - if (node is null) - { - return null; - } - - declarationKind = generator.GetDeclarationKind(node); - } - - return node; + declarationKind = generator.GetDeclarationKind(node); } + + return node; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs index 8b9fe6be0..5bce204ea 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs @@ -17,129 +17,128 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD002UseJtfRunCodeFixWithAwait : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD002UseJtfRunCodeFixWithAwait : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD002UseJtfRunAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD002UseJtfRunAnalyzer.Id); - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - public override async Task RegisterCodeFixesAsync(CodeFixContext context) - { - Diagnostic? diagnostic = context.Diagnostics.First(); + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + Diagnostic? diagnostic = context.Diagnostics.First(); - SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - if (TryFindNodeAtSource(diagnostic, root, out _, out _)) - { - context.RegisterCodeFix( - CodeAction.Create( - Strings.VSTHRD002_CodeFix_Await_Title, - async ct => + if (TryFindNodeAtSource(diagnostic, root, out _, out _)) + { + context.RegisterCodeFix( + CodeAction.Create( + Strings.VSTHRD002_CodeFix_Await_Title, + async ct => + { + Document? document = context.Document; + if (TryFindNodeAtSource(diagnostic, root, out ExpressionSyntax? node, out Func? transform)) { - Document? document = context.Document; - if (TryFindNodeAtSource(diagnostic, root, out ExpressionSyntax? node, out Func? transform)) + (document, node, _) = await FixUtils.UpdateDocumentAsync( + document, + node, + n => SyntaxFactory.AwaitExpression(transform(n, ct)), + ct).ConfigureAwait(false); + MethodDeclarationSyntax? method = node.FirstAncestorOrSelf(); + if (method is object) { - (document, node, _) = await FixUtils.UpdateDocumentAsync( - document, - node, - n => SyntaxFactory.AwaitExpression(transform(n, ct)), - ct).ConfigureAwait(false); - MethodDeclarationSyntax? method = node.FirstAncestorOrSelf(); - if (method is object) - { - (document, method) = await FixUtils.MakeMethodAsync(method, document, ct).ConfigureAwait(false); - } + (document, method) = await FixUtils.MakeMethodAsync(method, document, ct).ConfigureAwait(false); } + } - return document.Project.Solution; - }, - "only action"), - diagnostic); - } + return document.Project.Solution; + }, + "only action"), + diagnostic); } + } + + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + private static bool TryFindNodeAtSource(Diagnostic diagnostic, SyntaxNode root, [NotNullWhen(true)] out ExpressionSyntax? target, [NotNullWhen(true)] out Func? transform) + { + transform = null; + target = null; - private static bool TryFindNodeAtSource(Diagnostic diagnostic, SyntaxNode root, [NotNullWhen(true)] out ExpressionSyntax? target, [NotNullWhen(true)] out Func? transform) + var syntaxNode = (ExpressionSyntax)root.FindNode(diagnostic.Location.SourceSpan); + if (syntaxNode.FirstAncestorOrSelf() is object) { - transform = null; - target = null; + // We don't support converting anonymous delegates to async. + return false; + } - var syntaxNode = (ExpressionSyntax)root.FindNode(diagnostic.Location.SourceSpan); - if (syntaxNode.FirstAncestorOrSelf() is object) + SimpleNameSyntax? FindStaticWaitInvocation(ExpressionSyntax from) + { + SimpleNameSyntax? name = ((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Name; + return name?.Identifier.ValueText switch { - // We don't support converting anonymous delegates to async. - return false; - } + nameof(Task.WaitAny) => name, + nameof(Task.WaitAll) => name, + _ => null, + }; + } - SimpleNameSyntax? FindStaticWaitInvocation(ExpressionSyntax from) - { - SimpleNameSyntax? name = ((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Name; - return name?.Identifier.ValueText switch - { - nameof(Task.WaitAny) => name, - nameof(Task.WaitAll) => name, - _ => null, - }; - } - - ExpressionSyntax? TransformStaticWhatInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) - { - SimpleNameSyntax? name = FindStaticWaitInvocation(from); - var newIdentifier = name!.Identifier.ValueText switch - { - nameof(Task.WaitAny) => nameof(Task.WhenAny), - nameof(Task.WaitAll) => nameof(Task.WhenAll), - _ => throw new InvalidOperationException(), - }; - - return from.ReplaceToken(name.Identifier, SyntaxFactory.Identifier(newIdentifier)).WithoutAnnotations(FixUtils.BookmarkAnnotationName); - } - - ExpressionSyntax? FindTwoLevelDeepIdentifierInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => - ((((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression; - ExpressionSyntax? FindOneLevelDeepIdentifierInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => - ((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression; - ExpressionSyntax? FindParentMemberAccess(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => - (from as MemberAccessExpressionSyntax)?.Expression; - - InvocationExpressionSyntax? parentInvocation = syntaxNode.FirstAncestorOrSelf(); - MemberAccessExpressionSyntax? parentMemberAccess = syntaxNode.FirstAncestorOrSelf(); - if (FindTwoLevelDeepIdentifierInvocation(parentInvocation) is object) - { - // This method will not return null for the provided 'target' argument - transform = NullableHelpers.AsNonNullReturnUnchecked(FindTwoLevelDeepIdentifierInvocation); - target = parentInvocation; - } - else if (FindStaticWaitInvocation(parentInvocation) is object) - { - // This method will not return null for the provided 'target' argument - transform = NullableHelpers.AsNonNullReturnUnchecked(TransformStaticWhatInvocation); - target = parentInvocation; - } - else if (FindOneLevelDeepIdentifierInvocation(parentInvocation) is object) - { - // This method will not return null for the provided 'target' argument - transform = NullableHelpers.AsNonNullReturnUnchecked(FindOneLevelDeepIdentifierInvocation); - target = parentInvocation; - } - else if (FindParentMemberAccess(parentMemberAccess) is object) - { - // This method will not return null for the provided 'target' argument - transform = NullableHelpers.AsNonNullReturnUnchecked(FindParentMemberAccess); - target = parentMemberAccess; - } - else + ExpressionSyntax? TransformStaticWhatInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) + { + SimpleNameSyntax? name = FindStaticWaitInvocation(from); + var newIdentifier = name!.Identifier.ValueText switch { - return false; - } + nameof(Task.WaitAny) => nameof(Task.WhenAny), + nameof(Task.WaitAll) => nameof(Task.WhenAll), + _ => throw new InvalidOperationException(), + }; + + return from.ReplaceToken(name.Identifier, SyntaxFactory.Identifier(newIdentifier)).WithoutAnnotations(FixUtils.BookmarkAnnotationName); + } + + ExpressionSyntax? FindTwoLevelDeepIdentifierInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => + ((((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression; + ExpressionSyntax? FindOneLevelDeepIdentifierInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => + ((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression; + ExpressionSyntax? FindParentMemberAccess(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => + (from as MemberAccessExpressionSyntax)?.Expression; - return true; + InvocationExpressionSyntax? parentInvocation = syntaxNode.FirstAncestorOrSelf(); + MemberAccessExpressionSyntax? parentMemberAccess = syntaxNode.FirstAncestorOrSelf(); + if (FindTwoLevelDeepIdentifierInvocation(parentInvocation) is object) + { + // This method will not return null for the provided 'target' argument + transform = NullableHelpers.AsNonNullReturnUnchecked(FindTwoLevelDeepIdentifierInvocation); + target = parentInvocation; + } + else if (FindStaticWaitInvocation(parentInvocation) is object) + { + // This method will not return null for the provided 'target' argument + transform = NullableHelpers.AsNonNullReturnUnchecked(TransformStaticWhatInvocation); + target = parentInvocation; + } + else if (FindOneLevelDeepIdentifierInvocation(parentInvocation) is object) + { + // This method will not return null for the provided 'target' argument + transform = NullableHelpers.AsNonNullReturnUnchecked(FindOneLevelDeepIdentifierInvocation); + target = parentInvocation; + } + else if (FindParentMemberAccess(parentMemberAccess) is object) + { + // This method will not return null for the provided 'target' argument + transform = NullableHelpers.AsNonNullReturnUnchecked(FindParentMemberAccess); + target = parentMemberAccess; + } + else + { + return false; } + + return true; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs index b455aa075..704ead1c8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs @@ -18,130 +18,129 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD010MainThreadUsageCodeFix : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD010MainThreadUsageCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD010MainThreadUsageAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD010MainThreadUsageAnalyzer.Id); - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - public override async Task RegisterCodeFixesAsync(CodeFixContext context) - { - Diagnostic? diagnostic = context.Diagnostics.First(); + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + Diagnostic? diagnostic = context.Diagnostics.First(); - SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - var syntaxNode = (ExpressionSyntax)root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true); + SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + var syntaxNode = (ExpressionSyntax)root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true); - CSharpUtils.ContainingFunctionData container = CSharpUtils.GetContainingFunction(syntaxNode); - if (container.BlockOrExpression is null) - { - return; - } + CSharpUtils.ContainingFunctionData container = CSharpUtils.GetContainingFunction(syntaxNode); + if (container.BlockOrExpression is null) + { + return; + } - SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); - if (enclosingSymbol is null) - { - return; - } + SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); + ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); + if (enclosingSymbol is null) + { + return; + } - bool convertToAsync = !container.IsAsync && Utils.HasAsyncCompatibleReturnType(enclosingSymbol as IMethodSymbol); - if (convertToAsync) - { - // We don't support this yet, and we don't want to take the sync method path in this case. - // The user will have to fix this themselves. - return; - } + bool convertToAsync = !container.IsAsync && Utils.HasAsyncCompatibleReturnType(enclosingSymbol as IMethodSymbol); + if (convertToAsync) + { + // We don't support this yet, and we don't want to take the sync method path in this case. + // The user will have to fix this themselves. + return; + } - Regex lookupKey = (container.IsAsync || convertToAsync) - ? CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread - : CommonInterest.FileNamePatternForMethodsThatAssertMainThread; - string[] options = diagnostic.Properties[lookupKey.ToString()].Split('\n'); - if (options.Length > 0) - { - // For any symbol lookups, we want to consider the position of the very first statement in the block. - int positionForLookup = container.BlockOrExpression.GetLocation().SourceSpan.Start + 1; + Regex lookupKey = (container.IsAsync || convertToAsync) + ? CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread + : CommonInterest.FileNamePatternForMethodsThatAssertMainThread; + string[] options = diagnostic.Properties[lookupKey.ToString()].Split('\n'); + if (options.Length > 0) + { + // For any symbol lookups, we want to consider the position of the very first statement in the block. + int positionForLookup = container.BlockOrExpression.GetLocation().SourceSpan.Start + 1; - Lazy cancellationTokenSymbol = new Lazy(() => Utils.FindCancellationToken(semanticModel, positionForLookup, context.CancellationToken).FirstOrDefault()); - foreach (var option in options) + Lazy cancellationTokenSymbol = new Lazy(() => Utils.FindCancellationToken(semanticModel, positionForLookup, context.CancellationToken).FirstOrDefault()); + foreach (var option in options) + { + // We're looking for methods that either require no parameters, + // or (if we have one to give) that have just one parameter that is a CancellationToken. + IMethodSymbol? proposedMethod = Utils.FindMethodGroup(semanticModel, option) + .FirstOrDefault(m => !m.Parameters.Any(p => !p.HasExplicitDefaultValue) || + (cancellationTokenSymbol.Value is object && m.Parameters.Length == 1 && Utils.IsCancellationTokenParameter(m.Parameters[0]))); + if (proposedMethod is null) { - // We're looking for methods that either require no parameters, - // or (if we have one to give) that have just one parameter that is a CancellationToken. - IMethodSymbol? proposedMethod = Utils.FindMethodGroup(semanticModel, option) - .FirstOrDefault(m => !m.Parameters.Any(p => !p.HasExplicitDefaultValue) || - (cancellationTokenSymbol.Value is object && m.Parameters.Length == 1 && Utils.IsCancellationTokenParameter(m.Parameters[0]))); - if (proposedMethod is null) - { - // We can't find it, so don't offer to use it. - continue; - } + // We can't find it, so don't offer to use it. + continue; + } - if (proposedMethod.IsStatic) - { - OfferFix(option); - } - else + if (proposedMethod.IsStatic) + { + OfferFix(option); + } + else + { + foreach (Tuple? candidate in Utils.FindInstanceOf(proposedMethod.ContainingType, semanticModel, positionForLookup, context.CancellationToken)) { - foreach (Tuple? candidate in Utils.FindInstanceOf(proposedMethod.ContainingType, semanticModel, positionForLookup, context.CancellationToken)) + if (candidate.Item1) { - if (candidate.Item1) - { - OfferFix($"{candidate.Item2.Name}.{proposedMethod.Name}"); - } - else - { - OfferFix($"{candidate.Item2.ContainingNamespace}.{candidate.Item2.ContainingType.Name}.{candidate.Item2.Name}.{proposedMethod.Name}"); - } + OfferFix($"{candidate.Item2.Name}.{proposedMethod.Name}"); + } + else + { + OfferFix($"{candidate.Item2.ContainingNamespace}.{candidate.Item2.ContainingType.Name}.{candidate.Item2.Name}.{proposedMethod.Name}"); } } + } - void OfferFix(string fullyQualifiedMethod) - { - context.RegisterCodeFix(CodeAction.Create($"Add call to {fullyQualifiedMethod}", ct => Fix(fullyQualifiedMethod, proposedMethod, cancellationTokenSymbol), fullyQualifiedMethod), context.Diagnostics); - } + void OfferFix(string fullyQualifiedMethod) + { + context.RegisterCodeFix(CodeAction.Create($"Add call to {fullyQualifiedMethod}", ct => Fix(fullyQualifiedMethod, proposedMethod, cancellationTokenSymbol), fullyQualifiedMethod), context.Diagnostics); } } + } - Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol, Lazy cancellationTokenSymbol) + Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol, Lazy cancellationTokenSymbol) + { + int typeAndMethodDelimiterIndex = fullyQualifiedMethod.LastIndexOf('.'); + IdentifierNameSyntax methodName = SyntaxFactory.IdentifierName(fullyQualifiedMethod.Substring(typeAndMethodDelimiterIndex + 1)); + ExpressionSyntax invokedMethod = CSharpUtils.MemberAccess(fullyQualifiedMethod.Substring(0, typeAndMethodDelimiterIndex).Split('.'), methodName); + InvocationExpressionSyntax? invocationExpression = SyntaxFactory.InvocationExpression(invokedMethod); + IParameterSymbol? cancellationTokenParameter = methodSymbol.Parameters.FirstOrDefault(Utils.IsCancellationTokenParameter); + if (cancellationTokenParameter is object && cancellationTokenSymbol.Value is object) { - int typeAndMethodDelimiterIndex = fullyQualifiedMethod.LastIndexOf('.'); - IdentifierNameSyntax methodName = SyntaxFactory.IdentifierName(fullyQualifiedMethod.Substring(typeAndMethodDelimiterIndex + 1)); - ExpressionSyntax invokedMethod = CSharpUtils.MemberAccess(fullyQualifiedMethod.Substring(0, typeAndMethodDelimiterIndex).Split('.'), methodName); - InvocationExpressionSyntax? invocationExpression = SyntaxFactory.InvocationExpression(invokedMethod); - IParameterSymbol? cancellationTokenParameter = methodSymbol.Parameters.FirstOrDefault(Utils.IsCancellationTokenParameter); - if (cancellationTokenParameter is object && cancellationTokenSymbol.Value is object) + ArgumentSyntax? arg = SyntaxFactory.Argument(SyntaxFactory.IdentifierName(cancellationTokenSymbol.Value.Name)); + if (methodSymbol.Parameters.IndexOf(cancellationTokenParameter) > 0) { - ArgumentSyntax? arg = SyntaxFactory.Argument(SyntaxFactory.IdentifierName(cancellationTokenSymbol.Value.Name)); - if (methodSymbol.Parameters.IndexOf(cancellationTokenParameter) > 0) - { - arg = arg.WithNameColon(SyntaxFactory.NameColon(SyntaxFactory.IdentifierName(cancellationTokenParameter.Name))); - } - - invocationExpression = invocationExpression.AddArgumentListArguments(arg); + arg = arg.WithNameColon(SyntaxFactory.NameColon(SyntaxFactory.IdentifierName(cancellationTokenParameter.Name))); } - ExpressionSyntax? awaitExpression = container.IsAsync ? SyntaxFactory.AwaitExpression(invocationExpression) : null; - ExpressionStatementSyntax? addedStatement = SyntaxFactory.ExpressionStatement(awaitExpression ?? invocationExpression) - .WithAdditionalAnnotations(Simplifier.Annotation, Formatter.Annotation); - var initialBlockSyntax = container.BlockOrExpression as BlockSyntax; - if (initialBlockSyntax is null) - { - SyntaxToken openBrace = SyntaxFactory.Token(SyntaxFactory.TriviaList(), SyntaxKind.OpenBraceToken, SyntaxFactory.TriviaList(SyntaxFactory.EndOfLine("\r\n"))); - SyntaxToken closeBrace = SyntaxFactory.Token(SyntaxKind.CloseBraceToken); - SyntaxList statementList = SyntaxFactory.List(new[] { SyntaxFactory.ReturnStatement((ExpressionSyntax)container.BlockOrExpression) }); - initialBlockSyntax = SyntaxFactory.Block(openBrace, statementList, closeBrace) - .WithAdditionalAnnotations(Formatter.Annotation); - } + invocationExpression = invocationExpression.AddArgumentListArguments(arg); + } - BlockSyntax? newBlock = initialBlockSyntax.WithStatements(initialBlockSyntax.Statements.Insert(0, addedStatement)); - return Task.FromResult(context.Document.WithSyntaxRoot(root.ReplaceNode(container.BlockOrExpression.Parent, container.BodyReplacement(newBlock)))); + ExpressionSyntax? awaitExpression = container.IsAsync ? SyntaxFactory.AwaitExpression(invocationExpression) : null; + ExpressionStatementSyntax? addedStatement = SyntaxFactory.ExpressionStatement(awaitExpression ?? invocationExpression) + .WithAdditionalAnnotations(Simplifier.Annotation, Formatter.Annotation); + var initialBlockSyntax = container.BlockOrExpression as BlockSyntax; + if (initialBlockSyntax is null) + { + SyntaxToken openBrace = SyntaxFactory.Token(SyntaxFactory.TriviaList(), SyntaxKind.OpenBraceToken, SyntaxFactory.TriviaList(SyntaxFactory.EndOfLine("\r\n"))); + SyntaxToken closeBrace = SyntaxFactory.Token(SyntaxKind.CloseBraceToken); + SyntaxList statementList = SyntaxFactory.List(new[] { SyntaxFactory.ReturnStatement((ExpressionSyntax)container.BlockOrExpression) }); + initialBlockSyntax = SyntaxFactory.Block(openBrace, statementList, closeBrace) + .WithAdditionalAnnotations(Formatter.Annotation); } + + BlockSyntax? newBlock = initialBlockSyntax.WithStatements(initialBlockSyntax.Statements.Insert(0, addedStatement)); + return Task.FromResult(context.Document.WithSyntaxRoot(root.ReplaceNode(container.BlockOrExpression.Parent, container.BodyReplacement(newBlock)))); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs index c1c4c5555..2c85f189a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs @@ -16,76 +16,75 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Provides a code action to fix the Async Void Method by changing the return type to Task. +/// +/// +/// [Background] Async void methods have different error-handling semantics. +/// When an exception is thrown out of an async Task or async method/lambda, +/// that exception is captured and placed on the Task object. With async void methods, +/// there is no Task object, so any exceptions thrown out of an async void method will +/// be raised directly on the SynchronizationContext that was active when the async +/// void method started, and it would crash the process. +/// Refer to Stephen's article https://msdn.microsoft.com/en-us/magazine/jj991977.aspx for more info. +/// +/// i.e. +/// +/// +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD100AsyncVoidMethodCodeFix : CodeFixProvider { - /// - /// Provides a code action to fix the Async Void Method by changing the return type to Task. - /// - /// - /// [Background] Async void methods have different error-handling semantics. - /// When an exception is thrown out of an async Task or async method/lambda, - /// that exception is captured and placed on the Task object. With async void methods, - /// there is no Task object, so any exceptions thrown out of an async void method will - /// be raised directly on the SynchronizationContext that was active when the async - /// void method started, and it would crash the process. - /// Refer to Stephen's article https://msdn.microsoft.com/en-us/magazine/jj991977.aspx for more info. - /// - /// i.e. - /// - /// - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD100AsyncVoidMethodCodeFix : CodeFixProvider + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD100AsyncVoidMethodAnalyzer.Descriptor.Id); + + /// + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + + /// + public override Task RegisterCodeFixesAsync(CodeFixContext context) { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD100AsyncVoidMethodAnalyzer.Descriptor.Id); + Diagnostic? diagnostic = context.Diagnostics.First(); + context.RegisterCodeFix(new VoidToTaskCodeAction(context.Document, diagnostic), diagnostic); + return Task.FromResult(null); + } - /// - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - /// - public override Task RegisterCodeFixesAsync(CodeFixContext context) + private class VoidToTaskCodeAction : CodeAction + { + private Document document; + private Diagnostic diagnostic; + + internal VoidToTaskCodeAction(Document document, Diagnostic diagnostic) { - Diagnostic? diagnostic = context.Diagnostics.First(); - context.RegisterCodeFix(new VoidToTaskCodeAction(context.Document, diagnostic), diagnostic); - return Task.FromResult(null); + this.document = document; + this.diagnostic = diagnostic; } /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - - private class VoidToTaskCodeAction : CodeAction - { - private Document document; - private Diagnostic diagnostic; - - internal VoidToTaskCodeAction(Document document, Diagnostic diagnostic) - { - this.document = document; - this.diagnostic = diagnostic; - } + public override string Title => Strings.VSTHRD100_CodeFix_Title; - /// - public override string Title => Strings.VSTHRD100_CodeFix_Title; - - /// - public override string? EquivalenceKey => null; + /// + public override string? EquivalenceKey => null; - protected override async Task GetChangedDocumentAsync(CancellationToken cancellationToken) - { - SyntaxNode? root = await this.document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - MethodDeclarationSyntax? methodDeclaration = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); - TypeSyntax? taskType = SyntaxFactory.ParseTypeName(typeof(Task).FullName) - .WithAdditionalAnnotations(Simplifier.Annotation) - .WithTrailingTrivia(methodDeclaration.ReturnType.GetTrailingTrivia()); - MethodDeclarationSyntax? newMethodDeclaration = methodDeclaration.WithReturnType(taskType); - SyntaxNode? newRoot = root.ReplaceNode(methodDeclaration, newMethodDeclaration); - Document? newDocument = this.document.WithSyntaxRoot(newRoot); - return newDocument; - } + protected override async Task GetChangedDocumentAsync(CancellationToken cancellationToken) + { + SyntaxNode? root = await this.document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + MethodDeclarationSyntax? methodDeclaration = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + TypeSyntax? taskType = SyntaxFactory.ParseTypeName(typeof(Task).FullName) + .WithAdditionalAnnotations(Simplifier.Annotation) + .WithTrailingTrivia(methodDeclaration.ReturnType.GetTrailingTrivia()); + MethodDeclarationSyntax? newMethodDeclaration = methodDeclaration.WithReturnType(taskType); + SyntaxNode? newRoot = root.ReplaceNode(methodDeclaration, newMethodDeclaration); + Document? newDocument = this.document.WithSyntaxRoot(newRoot); + return newDocument; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs index 4febbde48..226f499f6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs @@ -17,217 +17,216 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Provides a code action to fix calls to synchronous methods from async methods when async options exist. +/// +/// +/// +/// +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD103UseAsyncOptionCodeFix : CodeFixProvider { - /// - /// Provides a code action to fix calls to synchronous methods from async methods when async options exist. - /// - /// - /// - /// - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD103UseAsyncOptionCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD103UseAsyncOptionAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD103UseAsyncOptionAnalyzer.Id); - /// - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + /// + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override async Task RegisterCodeFixesAsync(CodeFixContext context) + /// + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + Diagnostic? diagnostic = context.Diagnostics.FirstOrDefault(d => d.Properties.ContainsKey(VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName)); + if (diagnostic is object) { - Diagnostic? diagnostic = context.Diagnostics.FirstOrDefault(d => d.Properties.ContainsKey(VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName)); - if (diagnostic is object) + // Check that the method we're replacing the sync blocking call with actually exists. + // This is particularly useful when the method is an extension method, since the using directive + // would need to be present (or the namespace imply it) and we don't yet add missing using directives. + bool asyncAlternativeExists = false; + string asyncMethodName = diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; + if (string.IsNullOrEmpty(asyncMethodName)) { - // Check that the method we're replacing the sync blocking call with actually exists. - // This is particularly useful when the method is an extension method, since the using directive - // would need to be present (or the namespace imply it) and we don't yet add missing using directives. - bool asyncAlternativeExists = false; - string asyncMethodName = diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; - if (string.IsNullOrEmpty(asyncMethodName)) - { - asyncMethodName = "GetAwaiter"; - } + asyncMethodName = "GetAwaiter"; + } - SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - var blockingIdentifier = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as IdentifierNameSyntax; - var memberAccessExpression = blockingIdentifier?.Parent as MemberAccessExpressionSyntax; + SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + var blockingIdentifier = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as IdentifierNameSyntax; + var memberAccessExpression = blockingIdentifier?.Parent as MemberAccessExpressionSyntax; - // Check whether this code was already calling the awaiter (in a synchronous fashion). - asyncAlternativeExists |= memberAccessExpression?.Expression is InvocationExpressionSyntax invoke && invoke.Expression is MemberAccessExpressionSyntax parentMemberAccess && parentMemberAccess.Name.Identifier.Text == nameof(Task.GetAwaiter); + // Check whether this code was already calling the awaiter (in a synchronous fashion). + asyncAlternativeExists |= memberAccessExpression?.Expression is InvocationExpressionSyntax invoke && invoke.Expression is MemberAccessExpressionSyntax parentMemberAccess && parentMemberAccess.Name.Identifier.Text == nameof(Task.GetAwaiter); - if (!asyncAlternativeExists) - { - // If we fail to recognize the container, assume it exists since the analyzer thought it would. - ITypeSymbol? container = memberAccessExpression is object ? semanticModel.GetTypeInfo(memberAccessExpression.Expression, context.CancellationToken).ConvertedType : null; - asyncAlternativeExists = container is null || semanticModel.LookupSymbols(diagnostic.Location.SourceSpan.Start, name: asyncMethodName, container: container, includeReducedExtensionMethods: true).Any(); - } + if (!asyncAlternativeExists) + { + // If we fail to recognize the container, assume it exists since the analyzer thought it would. + ITypeSymbol? container = memberAccessExpression is object ? semanticModel.GetTypeInfo(memberAccessExpression.Expression, context.CancellationToken).ConvertedType : null; + asyncAlternativeExists = container is null || semanticModel.LookupSymbols(diagnostic.Location.SourceSpan.Start, name: asyncMethodName, container: container, includeReducedExtensionMethods: true).Any(); + } - if (asyncAlternativeExists) - { - context.RegisterCodeFix(new ReplaceSyncMethodCallWithAwaitAsync(context.Document, diagnostic), diagnostic); - } + if (asyncAlternativeExists) + { + context.RegisterCodeFix(new ReplaceSyncMethodCallWithAwaitAsync(context.Document, diagnostic), diagnostic); } } + } - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - private class ReplaceSyncMethodCallWithAwaitAsync : CodeAction - { - private readonly Document document; - private readonly Diagnostic diagnostic; + private class ReplaceSyncMethodCallWithAwaitAsync : CodeAction + { + private readonly Document document; + private readonly Diagnostic diagnostic; - internal ReplaceSyncMethodCallWithAwaitAsync(Document document, Diagnostic diagnostic) - { - this.document = document; - this.diagnostic = diagnostic; - } + internal ReplaceSyncMethodCallWithAwaitAsync(Document document, Diagnostic diagnostic) + { + this.document = document; + this.diagnostic = diagnostic; + } - public override string Title + public override string Title + { + get { - get - { - return !string.IsNullOrEmpty(this.AlternativeAsyncMethod) - ? string.Format(CultureInfo.CurrentCulture, Strings.AwaitXInstead, this.AlternativeAsyncMethod) - : Strings.UseAwaitInstead; - } + return !string.IsNullOrEmpty(this.AlternativeAsyncMethod) + ? string.Format(CultureInfo.CurrentCulture, Strings.AwaitXInstead, this.AlternativeAsyncMethod) + : Strings.UseAwaitInstead; } + } - /// - public override string? EquivalenceKey => null; + /// + public override string? EquivalenceKey => null; - private string AlternativeAsyncMethod => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; + private string AlternativeAsyncMethod => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; - private string ExtensionMethodNamespace => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.ExtensionMethodNamespaceKeyName]; + private string ExtensionMethodNamespace => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.ExtensionMethodNamespaceKeyName]; - protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) + protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) + { + Document? document = this.document; + SyntaxNode? root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + + // Find the synchronously blocking call member, + // and bookmark it so we can find it again after some mutations have taken place. + var syncAccessBookmark = new SyntaxAnnotation(); + SimpleNameSyntax syncMethodName = (SimpleNameSyntax)root.FindNode(this.diagnostic.Location.SourceSpan); + if (syncMethodName is null) { - Document? document = this.document; - SyntaxNode? root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - - // Find the synchronously blocking call member, - // and bookmark it so we can find it again after some mutations have taken place. - var syncAccessBookmark = new SyntaxAnnotation(); - SimpleNameSyntax syncMethodName = (SimpleNameSyntax)root.FindNode(this.diagnostic.Location.SourceSpan); - if (syncMethodName is null) - { - MemberAccessExpressionSyntax? syncMemberAccess = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); - syncMethodName = syncMemberAccess.Name; - } + MemberAccessExpressionSyntax? syncMemberAccess = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + syncMethodName = syncMemberAccess.Name; + } - // When we give the Document a modified SyntaxRoot, yet another is created. So we first assign it to the Document, - // then we query for the SyntaxRoot from the Document. - document = document.WithSyntaxRoot( - root.ReplaceNode(syncMethodName, syncMethodName.WithAdditionalAnnotations(syncAccessBookmark))); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - syncMethodName = (SimpleNameSyntax)root.GetAnnotatedNodes(syncAccessBookmark).Single(); - - // We'll need the semantic model later. But because we've annotated a node, that changes the SyntaxRoot - // and that renders the default semantic model broken (even though we've already updated the document's SyntaxRoot?!). - // So after acquiring the semantic model, update it with the new method body. - SemanticModel? semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - AnonymousFunctionExpressionSyntax? originalAnonymousMethodContainerIfApplicable = syncMethodName.FirstAncestorOrSelf(); - MethodDeclarationSyntax? originalMethodDeclaration = syncMethodName.FirstAncestorOrSelf(); - - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(this.diagnostic.Location.SourceSpan.Start, cancellationToken); - var hasReturnValue = ((enclosingSymbol as IMethodSymbol)?.ReturnType as INamedTypeSymbol)?.IsGenericType ?? false; - - // Ensure that the method or anonymous delegate is using the async keyword. - MethodDeclarationSyntax updatedMethod; - if (originalAnonymousMethodContainerIfApplicable is object) - { - updatedMethod = originalMethodDeclaration.ReplaceNode( - originalAnonymousMethodContainerIfApplicable, - originalAnonymousMethodContainerIfApplicable.MakeMethodAsync(hasReturnValue, semanticModel, cancellationToken)); - } - else - { - (document, updatedMethod) = await originalMethodDeclaration.MakeMethodAsync(document, cancellationToken).ConfigureAwait(false); - semanticModel = null; // out-dated - } + // When we give the Document a modified SyntaxRoot, yet another is created. So we first assign it to the Document, + // then we query for the SyntaxRoot from the Document. + document = document.WithSyntaxRoot( + root.ReplaceNode(syncMethodName, syncMethodName.WithAdditionalAnnotations(syncAccessBookmark))); + root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + syncMethodName = (SimpleNameSyntax)root.GetAnnotatedNodes(syncAccessBookmark).Single(); + + // We'll need the semantic model later. But because we've annotated a node, that changes the SyntaxRoot + // and that renders the default semantic model broken (even though we've already updated the document's SyntaxRoot?!). + // So after acquiring the semantic model, update it with the new method body. + SemanticModel? semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); + AnonymousFunctionExpressionSyntax? originalAnonymousMethodContainerIfApplicable = syncMethodName.FirstAncestorOrSelf(); + MethodDeclarationSyntax? originalMethodDeclaration = syncMethodName.FirstAncestorOrSelf(); + + ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(this.diagnostic.Location.SourceSpan.Start, cancellationToken); + var hasReturnValue = ((enclosingSymbol as IMethodSymbol)?.ReturnType as INamedTypeSymbol)?.IsGenericType ?? false; + + // Ensure that the method or anonymous delegate is using the async keyword. + MethodDeclarationSyntax updatedMethod; + if (originalAnonymousMethodContainerIfApplicable is object) + { + updatedMethod = originalMethodDeclaration.ReplaceNode( + originalAnonymousMethodContainerIfApplicable, + originalAnonymousMethodContainerIfApplicable.MakeMethodAsync(hasReturnValue, semanticModel, cancellationToken)); + } + else + { + (document, updatedMethod) = await originalMethodDeclaration.MakeMethodAsync(document, cancellationToken).ConfigureAwait(false); + semanticModel = null; // out-dated + } - if (updatedMethod != originalMethodDeclaration) - { - // Re-discover our synchronously blocking member. - syncMethodName = (SimpleNameSyntax)updatedMethod.GetAnnotatedNodes(syncAccessBookmark).Single(); - } + if (updatedMethod != originalMethodDeclaration) + { + // Re-discover our synchronously blocking member. + syncMethodName = (SimpleNameSyntax)updatedMethod.GetAnnotatedNodes(syncAccessBookmark).Single(); + } - ExpressionSyntax? syncExpression = GetSynchronousExpression(syncMethodName); + ExpressionSyntax? syncExpression = GetSynchronousExpression(syncMethodName); - ExpressionSyntax awaitExpression; - if (!string.IsNullOrEmpty(this.AlternativeAsyncMethod)) - { - // Replace the member being called and await the invocation expression. - // While doing so, move leading trivia to the surrounding await expression. - SimpleNameSyntax? asyncMethodName = syncMethodName.WithIdentifier(SyntaxFactory.Identifier(this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName])); - awaitExpression = SyntaxFactory.AwaitExpression( - syncExpression.ReplaceNode(syncMethodName, asyncMethodName).WithoutLeadingTrivia()) - .WithLeadingTrivia(syncExpression.GetLeadingTrivia()); - } - else - { - // Remove the member being accessed that causes a synchronous block and simply await the object. - MemberAccessExpressionSyntax? syncMemberAccess = syncMethodName.FirstAncestorOrSelf(); - ExpressionSyntax? syncMemberStrippedExpression = syncMemberAccess.Expression; - - // Special case a common pattern of calling task.GetAwaiter().GetResult() and remove both method calls. - var expressionMethodCall = (syncMemberStrippedExpression as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax; - if (expressionMethodCall?.Name.Identifier.Text == nameof(Task.GetAwaiter)) - { - syncMemberStrippedExpression = expressionMethodCall.Expression; - } - - awaitExpression = SyntaxFactory.AwaitExpression(syncMemberStrippedExpression.WithoutLeadingTrivia()) - .WithLeadingTrivia(syncMemberStrippedExpression.GetLeadingTrivia()); - } + ExpressionSyntax awaitExpression; + if (!string.IsNullOrEmpty(this.AlternativeAsyncMethod)) + { + // Replace the member being called and await the invocation expression. + // While doing so, move leading trivia to the surrounding await expression. + SimpleNameSyntax? asyncMethodName = syncMethodName.WithIdentifier(SyntaxFactory.Identifier(this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName])); + awaitExpression = SyntaxFactory.AwaitExpression( + syncExpression.ReplaceNode(syncMethodName, asyncMethodName).WithoutLeadingTrivia()) + .WithLeadingTrivia(syncExpression.GetLeadingTrivia()); + } + else + { + // Remove the member being accessed that causes a synchronous block and simply await the object. + MemberAccessExpressionSyntax? syncMemberAccess = syncMethodName.FirstAncestorOrSelf(); + ExpressionSyntax? syncMemberStrippedExpression = syncMemberAccess.Expression; - if (!(syncExpression.Parent is ExpressionStatementSyntax)) + // Special case a common pattern of calling task.GetAwaiter().GetResult() and remove both method calls. + var expressionMethodCall = (syncMemberStrippedExpression as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax; + if (expressionMethodCall?.Name.Identifier.Text == nameof(Task.GetAwaiter)) { - awaitExpression = SyntaxFactory.ParenthesizedExpression(awaitExpression) - .WithAdditionalAnnotations(Simplifier.Annotation); + syncMemberStrippedExpression = expressionMethodCall.Expression; } - updatedMethod = updatedMethod - .ReplaceNode(syncExpression, awaitExpression); + awaitExpression = SyntaxFactory.AwaitExpression(syncMemberStrippedExpression.WithoutLeadingTrivia()) + .WithLeadingTrivia(syncMemberStrippedExpression.GetLeadingTrivia()); + } - SyntaxNode? newRoot = root.ReplaceNode(originalMethodDeclaration, updatedMethod); - Document? newDocument = document.WithSyntaxRoot(newRoot); - return newDocument.Project.Solution; + if (!(syncExpression.Parent is ExpressionStatementSyntax)) + { + awaitExpression = SyntaxFactory.ParenthesizedExpression(awaitExpression) + .WithAdditionalAnnotations(Simplifier.Annotation); } - private static ExpressionSyntax GetSynchronousExpression(SimpleNameSyntax syncMethodName) + updatedMethod = updatedMethod + .ReplaceNode(syncExpression, awaitExpression); + + SyntaxNode? newRoot = root.ReplaceNode(originalMethodDeclaration, updatedMethod); + Document? newDocument = document.WithSyntaxRoot(newRoot); + return newDocument.Project.Solution; + } + + private static ExpressionSyntax GetSynchronousExpression(SimpleNameSyntax syncMethodName) + { + SyntaxNode current = syncMethodName; + while (true) { - SyntaxNode current = syncMethodName; - while (true) + switch (current.Kind()) { - switch (current.Kind()) - { - case SyntaxKind.InvocationExpression: + case SyntaxKind.InvocationExpression: + return (ExpressionSyntax)current; + + case SyntaxKind.SimpleMemberAccessExpression: + if (current.Parent.IsKind(SyntaxKind.InvocationExpression)) + { + return (ExpressionSyntax)current.Parent; + } + else + { return (ExpressionSyntax)current; + } - case SyntaxKind.SimpleMemberAccessExpression: - if (current.Parent.IsKind(SyntaxKind.InvocationExpression)) - { - return (ExpressionSyntax)current.Parent; - } - else - { - return (ExpressionSyntax)current; - } - - default: - current = current.Parent; - break; - } + default: + current = current.Parent; + break; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs index 190e66a1b..d416427f8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs @@ -17,72 +17,71 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers -{ - /// - /// Offers a code fix for diagnostics produced by the - /// . - /// - /// - /// The code fix changes code like this as described: - /// - /// - /// - /// - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD107AwaitTaskWithinUsingExpressionCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.Id); +namespace Microsoft.VisualStudio.Threading.Analyzers; - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; +/// +/// Offers a code fix for diagnostics produced by the +/// . +/// +/// +/// The code fix changes code like this as described: +/// +/// +/// +/// +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD107AwaitTaskWithinUsingExpressionCodeFix : CodeFixProvider +{ + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.Id); - public override Task RegisterCodeFixesAsync(CodeFixContext context) - { - Diagnostic? diagnostic = context.Diagnostics.First(); + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - context.RegisterCodeFix( - CodeAction.Create( - Strings.VSTHRD107_CodeFix_Title, - async ct => - { - Document? document = context.Document; - SyntaxNode? root = await document.GetSyntaxRootAsync(ct).ConfigureAwait(false); - MethodDeclarationSyntax? method = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + public override Task RegisterCodeFixesAsync(CodeFixContext context) + { + Diagnostic? diagnostic = context.Diagnostics.First(); - (document, method, _) = await FixUtils.UpdateDocumentAsync( - document, - method, - m => - { - root = m.SyntaxTree.GetRoot(ct); - UsingStatementSyntax usingStatement = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); - AwaitExpressionSyntax awaitExpression = SyntaxFactory.AwaitExpression( - SyntaxFactory.ParenthesizedExpression(usingStatement.Expression)); - UsingStatementSyntax modifiedUsingStatement = usingStatement.WithExpression(awaitExpression) - .WithAdditionalAnnotations(Simplifier.Annotation); - return m.ReplaceNode(usingStatement, modifiedUsingStatement); - }, - ct).ConfigureAwait(false); - (document, method) = await method.MakeMethodAsync(document, ct).ConfigureAwait(false); + context.RegisterCodeFix( + CodeAction.Create( + Strings.VSTHRD107_CodeFix_Title, + async ct => + { + Document? document = context.Document; + SyntaxNode? root = await document.GetSyntaxRootAsync(ct).ConfigureAwait(false); + MethodDeclarationSyntax? method = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); - return document.Project.Solution; - }, - "only action"), - diagnostic); + (document, method, _) = await FixUtils.UpdateDocumentAsync( + document, + method, + m => + { + root = m.SyntaxTree.GetRoot(ct); + UsingStatementSyntax usingStatement = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + AwaitExpressionSyntax awaitExpression = SyntaxFactory.AwaitExpression( + SyntaxFactory.ParenthesizedExpression(usingStatement.Expression)); + UsingStatementSyntax modifiedUsingStatement = usingStatement.WithExpression(awaitExpression) + .WithAdditionalAnnotations(Simplifier.Annotation); + return m.ReplaceNode(usingStatement, modifiedUsingStatement); + }, + ct).ConfigureAwait(false); + (document, method) = await method.MakeMethodAsync(document, ct).ConfigureAwait(false); - return Task.FromResult(null); - } + return document.Project.Solution; + }, + "only action"), + diagnostic); - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + return Task.FromResult(null); } + + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs index 9443dec36..4b2667a6b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs @@ -18,142 +18,141 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD109AvoidAssertInAsyncMethodsCodeFix : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD109AvoidAssertInAsyncMethodsCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.Id); - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - public override async Task RegisterCodeFixesAsync(CodeFixContext context) + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + foreach (Diagnostic? diagnostic in context.Diagnostics) { - foreach (Diagnostic? diagnostic in context.Diagnostics) + SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + ExpressionSyntax? syntaxNode = root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true) as ExpressionSyntax; + if (syntaxNode is null) { - SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - ExpressionSyntax? syntaxNode = root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true) as ExpressionSyntax; - if (syntaxNode is null) - { - continue; - } + continue; + } + + CSharpUtils.ContainingFunctionData container = CSharpUtils.GetContainingFunction(syntaxNode); + if (container.BlockOrExpression is null) + { + return; + } - CSharpUtils.ContainingFunctionData container = CSharpUtils.GetContainingFunction(syntaxNode); - if (container.BlockOrExpression is null) + if (!container.IsAsync) + { + if (!(container.Function is MethodDeclarationSyntax || container.Function is AnonymousFunctionExpressionSyntax)) { + // We don't support converting whatever this is into an async method. return; } + } - if (!container.IsAsync) + SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); + ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); + if (enclosingSymbol is null) + { + return; + } + + var hasReturnValue = ((enclosingSymbol as IMethodSymbol)?.ReturnType as INamedTypeSymbol)?.IsGenericType ?? false; + ImmutableArray options = await CommonFixes.ReadMethodsAsync(context, CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread, context.CancellationToken); + int positionForLookup = diagnostic.Location.SourceSpan.Start; + ISymbol cancellationTokenSymbol = Utils.FindCancellationToken(semanticModel, positionForLookup, context.CancellationToken).FirstOrDefault(); + foreach (CommonInterest.QualifiedMember option in options) + { + // We're looking for methods that either require no parameters, + // or (if we have one to give) that have just one parameter that is a CancellationToken. + IMethodSymbol? proposedMethod = Utils.FindMethodGroup(semanticModel, option) + .FirstOrDefault(m => !m.Parameters.Any(p => !p.HasExplicitDefaultValue) || + (cancellationTokenSymbol is object && m.Parameters.Length == 1 && Utils.IsCancellationTokenParameter(m.Parameters[0]))); + if (proposedMethod is null) { - if (!(container.Function is MethodDeclarationSyntax || container.Function is AnonymousFunctionExpressionSyntax)) - { - // We don't support converting whatever this is into an async method. - return; - } + // We can't find it, so don't offer to use it. + continue; } - SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); - if (enclosingSymbol is null) + if (proposedMethod.IsStatic) { - return; + OfferFix(option.ToString()); } - - var hasReturnValue = ((enclosingSymbol as IMethodSymbol)?.ReturnType as INamedTypeSymbol)?.IsGenericType ?? false; - ImmutableArray options = await CommonFixes.ReadMethodsAsync(context, CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread, context.CancellationToken); - int positionForLookup = diagnostic.Location.SourceSpan.Start; - ISymbol cancellationTokenSymbol = Utils.FindCancellationToken(semanticModel, positionForLookup, context.CancellationToken).FirstOrDefault(); - foreach (CommonInterest.QualifiedMember option in options) + else { - // We're looking for methods that either require no parameters, - // or (if we have one to give) that have just one parameter that is a CancellationToken. - IMethodSymbol? proposedMethod = Utils.FindMethodGroup(semanticModel, option) - .FirstOrDefault(m => !m.Parameters.Any(p => !p.HasExplicitDefaultValue) || - (cancellationTokenSymbol is object && m.Parameters.Length == 1 && Utils.IsCancellationTokenParameter(m.Parameters[0]))); - if (proposedMethod is null) + foreach (Tuple? candidate in Utils.FindInstanceOf(proposedMethod.ContainingType, semanticModel, positionForLookup, context.CancellationToken)) { - // We can't find it, so don't offer to use it. - continue; - } - - if (proposedMethod.IsStatic) - { - OfferFix(option.ToString()); - } - else - { - foreach (Tuple? candidate in Utils.FindInstanceOf(proposedMethod.ContainingType, semanticModel, positionForLookup, context.CancellationToken)) + if (candidate.Item1) { - if (candidate.Item1) - { - OfferFix($"{candidate.Item2.Name}.{proposedMethod.Name}"); - } - else - { - OfferFix($"{candidate.Item2.ContainingNamespace}.{candidate.Item2.ContainingType.Name}.{candidate.Item2.Name}.{proposedMethod.Name}"); - } + OfferFix($"{candidate.Item2.Name}.{proposedMethod.Name}"); + } + else + { + OfferFix($"{candidate.Item2.ContainingNamespace}.{candidate.Item2.ContainingType.Name}.{candidate.Item2.Name}.{proposedMethod.Name}"); } } + } - void OfferFix(string fullyQualifiedMethod) - { - context.RegisterCodeFix(CodeAction.Create($"Use 'await {fullyQualifiedMethod}'", ct => Fix(fullyQualifiedMethod, proposedMethod, hasReturnValue, ct), fullyQualifiedMethod), context.Diagnostics); - } + void OfferFix(string fullyQualifiedMethod) + { + context.RegisterCodeFix(CodeAction.Create($"Use 'await {fullyQualifiedMethod}'", ct => Fix(fullyQualifiedMethod, proposedMethod, hasReturnValue, ct), fullyQualifiedMethod), context.Diagnostics); } + } - async Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol, bool hasReturnValue, CancellationToken cancellationToken) + async Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol, bool hasReturnValue, CancellationToken cancellationToken) + { + StatementSyntax? assertionStatementToRemove = syntaxNode!.FirstAncestorOrSelf(); + + int typeAndMethodDelimiterIndex = fullyQualifiedMethod.LastIndexOf('.'); + IdentifierNameSyntax methodName = SyntaxFactory.IdentifierName(fullyQualifiedMethod.Substring(typeAndMethodDelimiterIndex + 1)); + ExpressionSyntax invokedMethod = CSharpUtils.MemberAccess(fullyQualifiedMethod.Substring(0, typeAndMethodDelimiterIndex).Split('.'), methodName) + .WithAdditionalAnnotations(Simplifier.Annotation); + InvocationExpressionSyntax? invocationExpression = SyntaxFactory.InvocationExpression(invokedMethod); + IParameterSymbol? cancellationTokenParameter = methodSymbol.Parameters.FirstOrDefault(Utils.IsCancellationTokenParameter); + if (cancellationTokenParameter is object && cancellationTokenSymbol is object) { - StatementSyntax? assertionStatementToRemove = syntaxNode!.FirstAncestorOrSelf(); - - int typeAndMethodDelimiterIndex = fullyQualifiedMethod.LastIndexOf('.'); - IdentifierNameSyntax methodName = SyntaxFactory.IdentifierName(fullyQualifiedMethod.Substring(typeAndMethodDelimiterIndex + 1)); - ExpressionSyntax invokedMethod = CSharpUtils.MemberAccess(fullyQualifiedMethod.Substring(0, typeAndMethodDelimiterIndex).Split('.'), methodName) - .WithAdditionalAnnotations(Simplifier.Annotation); - InvocationExpressionSyntax? invocationExpression = SyntaxFactory.InvocationExpression(invokedMethod); - IParameterSymbol? cancellationTokenParameter = methodSymbol.Parameters.FirstOrDefault(Utils.IsCancellationTokenParameter); - if (cancellationTokenParameter is object && cancellationTokenSymbol is object) + ArgumentSyntax? arg = SyntaxFactory.Argument(SyntaxFactory.IdentifierName(cancellationTokenSymbol.Name)); + if (methodSymbol.Parameters.IndexOf(cancellationTokenParameter) > 0) { - ArgumentSyntax? arg = SyntaxFactory.Argument(SyntaxFactory.IdentifierName(cancellationTokenSymbol.Name)); - if (methodSymbol.Parameters.IndexOf(cancellationTokenParameter) > 0) - { - arg = arg.WithNameColon(SyntaxFactory.NameColon(SyntaxFactory.IdentifierName(cancellationTokenParameter.Name))); - } - - invocationExpression = invocationExpression.AddArgumentListArguments(arg); + arg = arg.WithNameColon(SyntaxFactory.NameColon(SyntaxFactory.IdentifierName(cancellationTokenParameter.Name))); } - ExpressionSyntax awaitExpression = SyntaxFactory.AwaitExpression(invocationExpression); - ExpressionStatementSyntax? addedStatement = SyntaxFactory.ExpressionStatement(awaitExpression) - .WithAdditionalAnnotations(Simplifier.Annotation, Formatter.Annotation); - - var methodAnnotation = new SyntaxAnnotation(); - CSharpSyntaxNode methodSyntax = container.Function.ReplaceNode(assertionStatementToRemove, addedStatement) - .WithAdditionalAnnotations(methodAnnotation); - Document newDocument = context.Document.WithSyntaxRoot(root.ReplaceNode(container.Function, methodSyntax)); - SyntaxNode? newSyntaxRoot = await newDocument.GetSyntaxRootAsync(cancellationToken); - methodSyntax = (CSharpSyntaxNode)newSyntaxRoot.GetAnnotatedNodes(methodAnnotation).Single(); - if (!container.IsAsync) + invocationExpression = invocationExpression.AddArgumentListArguments(arg); + } + + ExpressionSyntax awaitExpression = SyntaxFactory.AwaitExpression(invocationExpression); + ExpressionStatementSyntax? addedStatement = SyntaxFactory.ExpressionStatement(awaitExpression) + .WithAdditionalAnnotations(Simplifier.Annotation, Formatter.Annotation); + + var methodAnnotation = new SyntaxAnnotation(); + CSharpSyntaxNode methodSyntax = container.Function.ReplaceNode(assertionStatementToRemove, addedStatement) + .WithAdditionalAnnotations(methodAnnotation); + Document newDocument = context.Document.WithSyntaxRoot(root.ReplaceNode(container.Function, methodSyntax)); + SyntaxNode? newSyntaxRoot = await newDocument.GetSyntaxRootAsync(cancellationToken); + methodSyntax = (CSharpSyntaxNode)newSyntaxRoot.GetAnnotatedNodes(methodAnnotation).Single(); + if (!container.IsAsync) + { + switch (methodSyntax) { - switch (methodSyntax) - { - case AnonymousFunctionExpressionSyntax anonFunc: - semanticModel = await newDocument.GetSemanticModelAsync(cancellationToken); - methodSyntax = FixUtils.MakeMethodAsync(anonFunc, hasReturnValue, semanticModel, cancellationToken); - newDocument = newDocument.WithSyntaxRoot(newSyntaxRoot.ReplaceNode(anonFunc, methodSyntax)); - break; - case MethodDeclarationSyntax methodDecl: - (newDocument, methodSyntax) = await FixUtils.MakeMethodAsync(methodDecl, newDocument, cancellationToken); - break; - } + case AnonymousFunctionExpressionSyntax anonFunc: + semanticModel = await newDocument.GetSemanticModelAsync(cancellationToken); + methodSyntax = FixUtils.MakeMethodAsync(anonFunc, hasReturnValue, semanticModel, cancellationToken); + newDocument = newDocument.WithSyntaxRoot(newSyntaxRoot.ReplaceNode(anonFunc, methodSyntax)); + break; + case MethodDeclarationSyntax methodDecl: + (newDocument, methodSyntax) = await FixUtils.MakeMethodAsync(methodDecl, newDocument, cancellationToken); + break; } - - return newDocument.Project.Solution; } + + return newDocument.Project.Solution; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs index 39ffa2151..a9e79d33f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs @@ -17,45 +17,44 @@ using Microsoft.CodeAnalysis.Simplification; using Microsoft.VisualStudio.Threading; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD111UseConfigureAwaitCodeFix : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD111UseConfigureAwaitCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD111UseConfigureAwaitAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD111UseConfigureAwaitAnalyzer.Id); - /// - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + /// + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - public override async Task RegisterCodeFixesAsync(CodeFixContext context) + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + foreach (Diagnostic? diagnostic in context.Diagnostics) { - foreach (Diagnostic? diagnostic in context.Diagnostics) + SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + var awaitedExpression = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as ExpressionSyntax; + + Task ApplyFix(bool captureContext) { - SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - var awaitedExpression = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as ExpressionSyntax; - - Task ApplyFix(bool captureContext) - { - ExpressionSyntax configuredAwaitExpression = SyntaxFactory.ParenthesizedExpression( - SyntaxFactory.InvocationExpression( - SyntaxFactory.MemberAccessExpression( - SyntaxKind.SimpleMemberAccessExpression, - SyntaxFactory.ParenthesizedExpression(awaitedExpression).WithAdditionalAnnotations(Simplifier.Annotation), - SyntaxFactory.IdentifierName("ConfigureAwait"))) - .AddArgumentListArguments(SyntaxFactory.Argument(SyntaxFactory.LiteralExpression(captureContext ? SyntaxKind.TrueLiteralExpression : SyntaxKind.FalseLiteralExpression)))) - .WithAdditionalAnnotations(Simplifier.Annotation); - - return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(awaitedExpression, configuredAwaitExpression))); - } - - context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_True_Title, ct => ApplyFix(true), true.ToString()), diagnostic); - context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_False_Title, ct => ApplyFix(false), false.ToString()), diagnostic); + ExpressionSyntax configuredAwaitExpression = SyntaxFactory.ParenthesizedExpression( + SyntaxFactory.InvocationExpression( + SyntaxFactory.MemberAccessExpression( + SyntaxKind.SimpleMemberAccessExpression, + SyntaxFactory.ParenthesizedExpression(awaitedExpression).WithAdditionalAnnotations(Simplifier.Annotation), + SyntaxFactory.IdentifierName("ConfigureAwait"))) + .AddArgumentListArguments(SyntaxFactory.Argument(SyntaxFactory.LiteralExpression(captureContext ? SyntaxKind.TrueLiteralExpression : SyntaxKind.FalseLiteralExpression)))) + .WithAdditionalAnnotations(Simplifier.Annotation); + + return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(awaitedExpression, configuredAwaitExpression))); } + + context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_True_Title, ct => ApplyFix(true), true.ToString()), diagnostic); + context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_False_Title, ct => ApplyFix(false), false.ToString()), diagnostic); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs index 10e94f23d..5d277500b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs @@ -9,81 +9,80 @@ using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.Editing; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD112ImplementSystemIAsyncDisposableCodeFix : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD112ImplementSystemIAsyncDisposableCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.Id); - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - public override async Task RegisterCodeFixesAsync(CodeFixContext context) + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + foreach (Diagnostic? diagnostic in context.Diagnostics) { - foreach (Diagnostic? diagnostic in context.Diagnostics) + SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken); + Compilation? compilation = await context.Document.Project.GetCompilationAsync(context.CancellationToken); + if (compilation is null) { - SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken); - Compilation? compilation = await context.Document.Project.GetCompilationAsync(context.CancellationToken); - if (compilation is null) - { - continue; - } + continue; + } - INamedTypeSymbol? bclAsyncDisposableType = compilation.GetTypeByMetadataName(Types.BclAsyncDisposable.FullName); - if (bclAsyncDisposableType is null) - { - continue; - } + INamedTypeSymbol? bclAsyncDisposableType = compilation.GetTypeByMetadataName(Types.BclAsyncDisposable.FullName); + if (bclAsyncDisposableType is null) + { + continue; + } - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken); - var generator = SyntaxGenerator.GetGenerator(context.Document); - SyntaxNode? originalTypeDeclaration = generator.TryGetContainingDeclaration(syntaxRoot.FindNode(diagnostic.Location.SourceSpan)); - if (originalTypeDeclaration is null) - { - continue; - } + SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken); + var generator = SyntaxGenerator.GetGenerator(context.Document); + SyntaxNode? originalTypeDeclaration = generator.TryGetContainingDeclaration(syntaxRoot.FindNode(diagnostic.Location.SourceSpan)); + if (originalTypeDeclaration is null) + { + continue; + } - context.RegisterCodeFix( - CodeAction.Create( - Strings.VSTHRD112_CodeFix_Title, - ct => - { - // Declare that the type implements the System.IAsyncDisposable interface. - SyntaxNode? newBaseType = generator.TypeExpression(bclAsyncDisposableType); - SyntaxNode? typeDeclaration = generator.AddInterfaceType(originalTypeDeclaration, newBaseType); + context.RegisterCodeFix( + CodeAction.Create( + Strings.VSTHRD112_CodeFix_Title, + ct => + { + // Declare that the type implements the System.IAsyncDisposable interface. + SyntaxNode? newBaseType = generator.TypeExpression(bclAsyncDisposableType); + SyntaxNode? typeDeclaration = generator.AddInterfaceType(originalTypeDeclaration, newBaseType); - // Implement the interface, if we're on a non-interface type. - if (semanticModel.GetDeclaredSymbol(originalTypeDeclaration, ct) is ITypeSymbol changedSymbol && changedSymbol.TypeKind != TypeKind.Interface) + // Implement the interface, if we're on a non-interface type. + if (semanticModel.GetDeclaredSymbol(originalTypeDeclaration, ct) is ITypeSymbol changedSymbol && changedSymbol.TypeKind != TypeKind.Interface) + { + var disposeAsyncMethod = (IMethodSymbol)bclAsyncDisposableType.GetMembers().Single(); + var statements = new SyntaxNode[] { - var disposeAsyncMethod = (IMethodSymbol)bclAsyncDisposableType.GetMembers().Single(); - var statements = new SyntaxNode[] - { - generator.ReturnStatement( - generator.ObjectCreationExpression( - disposeAsyncMethod.ReturnType, - generator.InvocationExpression( - generator.MemberAccessExpression(generator.ThisExpression(), "DisposeAsync")))), - }; - typeDeclaration = generator.AddMembers( - typeDeclaration, - generator.AsPrivateInterfaceImplementation( - generator.MethodDeclaration( - disposeAsyncMethod.Name, - returnType: generator.TypeExpression(disposeAsyncMethod.ReturnType), - accessibility: Accessibility.Public, - statements: statements), - generator.TypeExpression(bclAsyncDisposableType))); - } + generator.ReturnStatement( + generator.ObjectCreationExpression( + disposeAsyncMethod.ReturnType, + generator.InvocationExpression( + generator.MemberAccessExpression(generator.ThisExpression(), "DisposeAsync")))), + }; + typeDeclaration = generator.AddMembers( + typeDeclaration, + generator.AsPrivateInterfaceImplementation( + generator.MethodDeclaration( + disposeAsyncMethod.Name, + returnType: generator.TypeExpression(disposeAsyncMethod.ReturnType), + accessibility: Accessibility.Public, + statements: statements), + generator.TypeExpression(bclAsyncDisposableType))); + } - return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(originalTypeDeclaration, typeDeclaration))); - }, - "AddBaseType"), - diagnostic); - } + return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(originalTypeDeclaration, typeDeclaration))); + }, + "AddBaseType"), + diagnostic); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs index 0acac449b..860bd6634 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs @@ -10,63 +10,62 @@ using Microsoft.CodeAnalysis.Editing; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD114AvoidReturningNullTaskCodeFix : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD114AvoidReturningNullTaskCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.Id); - /// - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + /// + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - public override async Task RegisterCodeFixesAsync(CodeFixContext context) + public override async Task RegisterCodeFixesAsync(CodeFixContext context) + { + foreach (Diagnostic? diagnostic in context.Diagnostics) { - foreach (Diagnostic? diagnostic in context.Diagnostics) + SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode? nullLiteral = syntaxRoot.FindNode(diagnostic.Location.SourceSpan); + if (semanticModel.GetOperation(nullLiteral, context.CancellationToken) is ILiteralOperation { ConstantValue: { HasValue: true, Value: null } }) { - SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? nullLiteral = syntaxRoot.FindNode(diagnostic.Location.SourceSpan); - if (semanticModel.GetOperation(nullLiteral, context.CancellationToken) is ILiteralOperation { ConstantValue: { HasValue: true, Value: null } }) + TypeInfo typeInfo = semanticModel.GetTypeInfo(nullLiteral, context.CancellationToken); + if (typeInfo.ConvertedType is INamedTypeSymbol returnType) { - TypeInfo typeInfo = semanticModel.GetTypeInfo(nullLiteral, context.CancellationToken); - if (typeInfo.ConvertedType is INamedTypeSymbol returnType) + if (returnType.IsGenericType) { - if (returnType.IsGenericType) - { - context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD114_CodeFix_FromResult, ct => ApplyTaskFromResultFix(returnType), nameof(Task.FromResult)), diagnostic); - } - else - { - context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD114_CodeFix_CompletedTask, ct => ApplyTaskCompletedTaskFix(returnType), nameof(Task.CompletedTask)), diagnostic); - } + context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD114_CodeFix_FromResult, ct => ApplyTaskFromResultFix(returnType), nameof(Task.FromResult)), diagnostic); } - - Task ApplyTaskCompletedTaskFix(INamedTypeSymbol returnType) + else { - var generator = SyntaxGenerator.GetGenerator(context.Document); - SyntaxNode completedTaskExpression = generator.MemberAccessExpression( - generator.TypeExpressionForStaticMemberAccess(returnType), - generator.IdentifierName(nameof(Task.CompletedTask))); - - return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(nullLiteral, completedTaskExpression))); + context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD114_CodeFix_CompletedTask, ct => ApplyTaskCompletedTaskFix(returnType), nameof(Task.CompletedTask)), diagnostic); } + } - Task ApplyTaskFromResultFix(INamedTypeSymbol returnType) - { - var generator = SyntaxGenerator.GetGenerator(context.Document); - SyntaxNode taskFromResultExpression = generator.InvocationExpression( - generator.MemberAccessExpression( - generator.TypeExpressionForStaticMemberAccess(returnType.BaseType), - generator.GenericName(nameof(Task.FromResult), returnType.TypeArguments[0])), - generator.NullLiteralExpression()); + Task ApplyTaskCompletedTaskFix(INamedTypeSymbol returnType) + { + var generator = SyntaxGenerator.GetGenerator(context.Document); + SyntaxNode completedTaskExpression = generator.MemberAccessExpression( + generator.TypeExpressionForStaticMemberAccess(returnType), + generator.IdentifierName(nameof(Task.CompletedTask))); - return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(nullLiteral, taskFromResultExpression))); - } + return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(nullLiteral, completedTaskExpression))); + } + + Task ApplyTaskFromResultFix(INamedTypeSymbol returnType) + { + var generator = SyntaxGenerator.GetGenerator(context.Document); + SyntaxNode taskFromResultExpression = generator.InvocationExpression( + generator.MemberAccessExpression( + generator.TypeExpressionForStaticMemberAccess(returnType.BaseType), + generator.GenericName(nameof(Task.FromResult), returnType.TypeArguments[0])), + generator.NullLiteralExpression()); + + return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(nullLiteral, taskFromResultExpression))); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index edf65e2b6..d43e9fa07 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -16,67 +16,66 @@ using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Rename; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[ExportCodeFixProvider(LanguageNames.CSharp)] +public class VSTHRD200UseAsyncNamingConventionCodeFix : CodeFixProvider { - [ExportCodeFixProvider(LanguageNames.CSharp)] - public class VSTHRD200UseAsyncNamingConventionCodeFix : CodeFixProvider - { - private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD200UseAsyncNamingConventionAnalyzer.Id); + private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( + VSTHRD200UseAsyncNamingConventionAnalyzer.Id); - /// - public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; + /// + public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; - /// - public override Task RegisterCodeFixesAsync(CodeFixContext context) - { - Diagnostic? diagnostic = context.Diagnostics.First(); - context.RegisterCodeFix(new AddAsyncSuffixCodeAction(context.Document, diagnostic), diagnostic); - return Task.FromResult(null); - } + /// + public override Task RegisterCodeFixesAsync(CodeFixContext context) + { + Diagnostic? diagnostic = context.Diagnostics.First(); + context.RegisterCodeFix(new AddAsyncSuffixCodeAction(context.Document, diagnostic), diagnostic); + return Task.FromResult(null); + } - /// - public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; + /// + public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer; - private class AddAsyncSuffixCodeAction : CodeAction - { - private readonly Diagnostic diagnostic; - private readonly Document document; + private class AddAsyncSuffixCodeAction : CodeAction + { + private readonly Diagnostic diagnostic; + private readonly Document document; - public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic) - { - this.document = document; - this.diagnostic = diagnostic; - } + public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic) + { + this.document = document; + this.diagnostic = diagnostic; + } - public override string Title => string.Format( - CultureInfo.CurrentCulture, - Strings.VSTHRD200_CodeFix_Title, - this.NewName); + public override string Title => string.Format( + CultureInfo.CurrentCulture, + Strings.VSTHRD200_CodeFix_Title, + this.NewName); - /// - public override string? EquivalenceKey => null; + /// + public override string? EquivalenceKey => null; - private string NewName => this.diagnostic.Properties[VSTHRD200UseAsyncNamingConventionAnalyzer.NewNameKey]; + private string NewName => this.diagnostic.Properties[VSTHRD200UseAsyncNamingConventionAnalyzer.NewNameKey]; - protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) - { - SyntaxNode? root = await this.document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - var methodDeclaration = (MethodDeclarationSyntax)root.FindNode(this.diagnostic.Location.SourceSpan); + protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) + { + SyntaxNode? root = await this.document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + var methodDeclaration = (MethodDeclarationSyntax)root.FindNode(this.diagnostic.Location.SourceSpan); - SemanticModel? semanticModel = await this.document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - IMethodSymbol? methodSymbol = semanticModel.GetDeclaredSymbol(methodDeclaration, cancellationToken); + SemanticModel? semanticModel = await this.document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); + IMethodSymbol? methodSymbol = semanticModel.GetDeclaredSymbol(methodDeclaration, cancellationToken); - Solution? solution = this.document.Project.Solution; - Solution? updatedSolution = await Renamer.RenameSymbolAsync( - solution, - methodSymbol, - this.NewName, - solution.Workspace.Options, - cancellationToken).ConfigureAwait(false); + Solution? solution = this.document.Project.Solution; + Solution? updatedSolution = await Renamer.RenameSymbolAsync( + solution, + methodSymbol, + this.NewName, + solution.Workspace.Options, + cancellationToken).ConfigureAwait(false); - return updatedSolution; - } + return updatedSolution; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs index b436a54fe..acb406632 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs @@ -7,91 +7,90 @@ using Microsoft.CodeAnalysis.Operations; using Microsoft.CodeAnalysis.VisualBasic.Syntax; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal sealed class VisualBasicUtils : LanguageUtils { - internal sealed class VisualBasicUtils : LanguageUtils - { - public static readonly VisualBasicUtils Instance = new VisualBasicUtils(); + public static readonly VisualBasicUtils Instance = new VisualBasicUtils(); - private VisualBasicUtils() - { - } + private VisualBasicUtils() + { + } - internal override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) + internal override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) + { + foreach (SyntaxReference? syntaxReference in symbol.DeclaringSyntaxReferences) { - foreach (SyntaxReference? syntaxReference in symbol.DeclaringSyntaxReferences) + SyntaxNode? syntaxNode = syntaxReference.GetSyntax(cancellationToken); + if (syntaxNode is InterfaceStatementSyntax { Parent: InterfaceBlockSyntax vbInterface }) { - SyntaxNode? syntaxNode = syntaxReference.GetSyntax(cancellationToken); - if (syntaxNode is InterfaceStatementSyntax { Parent: InterfaceBlockSyntax vbInterface }) + if (compilation.GetSemanticModel(vbInterface.SyntaxTree) is { } semanticModel) { - if (compilation.GetSemanticModel(vbInterface.SyntaxTree) is { } semanticModel) + foreach (InheritsStatementSyntax? inheritStatement in vbInterface.Inherits) { - foreach (InheritsStatementSyntax? inheritStatement in vbInterface.Inherits) + foreach (TypeSyntax? typeSyntax in inheritStatement.Types) { - foreach (TypeSyntax? typeSyntax in inheritStatement.Types) + SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); + if (Equals(baseTypeSymbolInfo.Symbol, baseType)) { - SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) - { - return typeSyntax.GetLocation(); - } + return typeSyntax.GetLocation(); } } } } - else if (syntaxNode is ClassStatementSyntax { Parent: ClassBlockSyntax vbClass }) + } + else if (syntaxNode is ClassStatementSyntax { Parent: ClassBlockSyntax vbClass }) + { + if (compilation.GetSemanticModel(vbClass.SyntaxTree) is { } semanticModel) { - if (compilation.GetSemanticModel(vbClass.SyntaxTree) is { } semanticModel) + foreach (ImplementsStatementSyntax? implementStatement in vbClass.Implements) { - foreach (ImplementsStatementSyntax? implementStatement in vbClass.Implements) + foreach (TypeSyntax? typeSyntax in implementStatement.Types) { - foreach (TypeSyntax? typeSyntax in implementStatement.Types) + SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); + if (Equals(baseTypeSymbolInfo.Symbol, baseType)) { - SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) - { - return typeSyntax.GetLocation(); - } + return typeSyntax.GetLocation(); } } } } - else if (syntaxNode is StructureStatementSyntax { Parent: StructureBlockSyntax vbStruct }) + } + else if (syntaxNode is StructureStatementSyntax { Parent: StructureBlockSyntax vbStruct }) + { + if (compilation.GetSemanticModel(vbStruct.SyntaxTree) is { } semanticModel) { - if (compilation.GetSemanticModel(vbStruct.SyntaxTree) is { } semanticModel) + foreach (ImplementsStatementSyntax? implementStatement in vbStruct.Implements) { - foreach (ImplementsStatementSyntax? implementStatement in vbStruct.Implements) + foreach (TypeSyntax? typeSyntax in implementStatement.Types) { - foreach (TypeSyntax? typeSyntax in implementStatement.Types) + SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); + if (Equals(baseTypeSymbolInfo.Symbol, baseType)) { - SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) - { - return typeSyntax.GetLocation(); - } + return typeSyntax.GetLocation(); } } } } } - - return symbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax(cancellationToken)?.GetLocation(); } - internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) - { - return invocation.Syntax; - } + return symbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax(cancellationToken)?.GetLocation(); + } - internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) - { - return objectCreation.Syntax; - } + internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) + { + return invocation.Syntax; + } - internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) - { - // VB.NET doesn't support nullable reference types - return false; - } + internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) + { + return objectCreation.Syntax; + } + + internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) + { + // VB.NET doesn't support nullable reference types + return false; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index d6dd74522..9a2515b91 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 8e27f0212..fa1606292 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs index 1ee77539f..4116a98ad 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs index 496895f53..234eadb7b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index a473e94be..957efce3b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs index f7b4e7e1c..1e3d5b11b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 2dacd0ab8..8f5b0fcda 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index b0cb3a249..5eb55ec7c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs index 48c7c8020..2f5f3a395 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -4,11 +4,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer { - [DiagnosticAnalyzer(LanguageNames.VisualBasic)] - public sealed class VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer - { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; - } + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 888f98d1b..5545967f6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -6,67 +6,66 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +public abstract class AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : DiagnosticAnalyzer { - public abstract class AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD001"; + public const string Id = "VSTHRD001"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD001_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD001_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD001_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD001_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } + + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - public override void Initialize(AnalysisContext context) + context.RegisterCompilationStartAction(compilationStartContext => { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + var legacyThreadSwitchingMembers = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForLegacyThreadSwitchingMembers, compilationStartContext.CancellationToken).ToImmutableArray(); + var analyzer = new Analyzer(this.LanguageUtils, legacyThreadSwitchingMembers); + compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(analyzer.AnalyzeInvocation), OperationKind.Invocation); + }); + } - context.RegisterCompilationStartAction(compilationStartContext => - { - var legacyThreadSwitchingMembers = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForLegacyThreadSwitchingMembers, compilationStartContext.CancellationToken).ToImmutableArray(); - var analyzer = new Analyzer(this.LanguageUtils, legacyThreadSwitchingMembers); - compilationStartContext.RegisterOperationAction(Utils.DebuggableWrapper(analyzer.AnalyzeInvocation), OperationKind.Invocation); - }); - } + private class Analyzer + { + private readonly LanguageUtils languageUtils; + private readonly ImmutableArray legacyThreadSwitchingMembers; - private class Analyzer + internal Analyzer(LanguageUtils languageUtils, ImmutableArray legacyThreadSwitchingMembers) { - private readonly LanguageUtils languageUtils; - private readonly ImmutableArray legacyThreadSwitchingMembers; - - internal Analyzer(LanguageUtils languageUtils, ImmutableArray legacyThreadSwitchingMembers) - { - this.languageUtils = languageUtils; - this.legacyThreadSwitchingMembers = legacyThreadSwitchingMembers; - } + this.languageUtils = languageUtils; + this.legacyThreadSwitchingMembers = legacyThreadSwitchingMembers; + } - internal void AnalyzeInvocation(OperationAnalysisContext context) + internal void AnalyzeInvocation(OperationAnalysisContext context) + { + var invocation = (IInvocationOperation)context.Operation; + IMethodSymbol? invokeMethod = invocation.TargetMethod; + if (invokeMethod is object) { - var invocation = (IInvocationOperation)context.Operation; - IMethodSymbol? invokeMethod = invocation.TargetMethod; - if (invokeMethod is object) + foreach (CommonInterest.QualifiedMember legacyMethod in this.legacyThreadSwitchingMembers) { - foreach (CommonInterest.QualifiedMember legacyMethod in this.legacyThreadSwitchingMembers) - { - context.CancellationToken.ThrowIfCancellationRequested(); + context.CancellationToken.ThrowIfCancellationRequested(); - if (legacyMethod.IsMatch(invokeMethod)) - { - var diagnostic = Diagnostic.Create( - Descriptor, - this.languageUtils.IsolateMethodName(invocation).GetLocation()); - context.ReportDiagnostic(diagnostic); - break; - } + if (legacyMethod.IsMatch(invokeMethod)) + { + var diagnostic = Diagnostic.Create( + Descriptor, + this.languageUtils.IsolateMethodName(invocation).GetLocation()); + context.ReportDiagnostic(diagnostic); + break; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 7852e90c1..5156134d1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -6,51 +6,50 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Detects invocations of JoinableTaskFactory.SwitchToMainThreadAsync that are not awaited. +/// +public abstract class AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : DiagnosticAnalyzer { - /// - /// Detects invocations of JoinableTaskFactory.SwitchToMainThreadAsync that are not awaited. - /// - public abstract class AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD004"; + public const string Id = "VSTHRD004"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD004_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD004_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Error, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD004_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD004_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Error, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); - } + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); + } - private void AnalyzeInvocation(OperationAnalysisContext context) + private void AnalyzeInvocation(OperationAnalysisContext context) + { + var invocation = (IInvocationOperation)context.Operation; + IMethodSymbol? methodSymbol = invocation.TargetMethod; + if (methodSymbol.Name == Types.JoinableTaskFactory.SwitchToMainThreadAsync && + methodSymbol.ContainingType.Name == Types.JoinableTaskFactory.TypeName && + methodSymbol.ContainingType.BelongsToNamespace(Types.JoinableTaskFactory.Namespace)) { - var invocation = (IInvocationOperation)context.Operation; - IMethodSymbol? methodSymbol = invocation.TargetMethod; - if (methodSymbol.Name == Types.JoinableTaskFactory.SwitchToMainThreadAsync && - methodSymbol.ContainingType.Name == Types.JoinableTaskFactory.TypeName && - methodSymbol.ContainingType.BelongsToNamespace(Types.JoinableTaskFactory.Namespace)) + // This is a call to JTF.SwitchToMainThreadAsync(). Is it being (directly) awaited? + if (!(invocation.Parent is IAwaitOperation)) { - // This is a call to JTF.SwitchToMainThreadAsync(). Is it being (directly) awaited? - if (!(invocation.Parent is IAwaitOperation)) - { - Location? location = (this.LanguageUtils.IsolateMethodName(invocation) ?? invocation.Syntax).GetLocation(); - context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); - } + Location? location = (this.LanguageUtils.IsolateMethodName(invocation) ?? invocation.Syntax).GetLocation(); + context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs index f7a631ac5..44a599998 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs @@ -8,77 +8,76 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +public abstract class AbstractVSTHRD011UseAsyncLazyAnalyzer : DiagnosticAnalyzer { - public abstract class AbstractVSTHRD011UseAsyncLazyAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD011"; + public const string Id = "VSTHRD011"; - internal static readonly DiagnosticDescriptor LazyOfTaskDescriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD011_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD011_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Error, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor LazyOfTaskDescriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD011_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD011_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Error, + isEnabledByDefault: true); - internal static readonly DiagnosticDescriptor SyncBlockInValueFactoryDescriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD011_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD011b_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Error, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor SyncBlockInValueFactoryDescriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD011_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD011b_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Error, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics - { - get { return ImmutableArray.Create(LazyOfTaskDescriptor, SyncBlockInValueFactoryDescriptor); } - } + /// + public override ImmutableArray SupportedDiagnostics + { + get { return ImmutableArray.Create(LazyOfTaskDescriptor, SyncBlockInValueFactoryDescriptor); } + } - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterOperationAction( - Utils.DebuggableWrapper(this.AnalyzeNode), - OperationKind.ObjectCreation); - } + context.RegisterOperationAction( + Utils.DebuggableWrapper(this.AnalyzeNode), + OperationKind.ObjectCreation); + } - private void AnalyzeNode(OperationAnalysisContext context) + private void AnalyzeNode(OperationAnalysisContext context) + { + var objectCreation = (IObjectCreationOperation)context.Operation; + IMethodSymbol? methodSymbol = objectCreation.Constructor; + var constructedType = methodSymbol?.ReceiverType as INamedTypeSymbol; + if (Utils.IsLazyOfT(constructedType)) { - var objectCreation = (IObjectCreationOperation)context.Operation; - IMethodSymbol? methodSymbol = objectCreation.Constructor; - var constructedType = methodSymbol?.ReceiverType as INamedTypeSymbol; - if (Utils.IsLazyOfT(constructedType)) + ITypeSymbol? typeArg = constructedType.TypeArguments.FirstOrDefault(); + bool typeArgIsTask = typeArg?.Name == nameof(Task) + && typeArg.BelongsToNamespace(Namespaces.SystemThreadingTasks); + if (typeArgIsTask) { - ITypeSymbol? typeArg = constructedType.TypeArguments.FirstOrDefault(); - bool typeArgIsTask = typeArg?.Name == nameof(Task) - && typeArg.BelongsToNamespace(Namespaces.SystemThreadingTasks); - if (typeArgIsTask) - { - context.ReportDiagnostic(Diagnostic.Create(LazyOfTaskDescriptor, this.LanguageUtils.IsolateMethodName(objectCreation).GetLocation())); - } - else + context.ReportDiagnostic(Diagnostic.Create(LazyOfTaskDescriptor, this.LanguageUtils.IsolateMethodName(objectCreation).GetLocation())); + } + else + { + IOperation? firstArgExpression = objectCreation.Arguments.FirstOrDefault()?.Value; + if (firstArgExpression is IDelegateCreationOperation { Target: IAnonymousFunctionOperation anonFunc }) { - IOperation? firstArgExpression = objectCreation.Arguments.FirstOrDefault()?.Value; - if (firstArgExpression is IDelegateCreationOperation { Target: IAnonymousFunctionOperation anonFunc }) + System.Collections.Generic.IEnumerable? problems = from invocation in anonFunc.Descendants().OfType() + let invokedSymbol = invocation.TargetMethod + where invokedSymbol is object && CommonInterest.SyncBlockingMethods.Any(m => m.Method.IsMatch(invokedSymbol)) + select invocation; + IInvocationOperation? firstProblem = problems.FirstOrDefault(); + if (firstProblem is object) { - System.Collections.Generic.IEnumerable? problems = from invocation in anonFunc.Descendants().OfType() - let invokedSymbol = invocation.TargetMethod - where invokedSymbol is object && CommonInterest.SyncBlockingMethods.Any(m => m.Method.IsMatch(invokedSymbol)) - select invocation; - IInvocationOperation? firstProblem = problems.FirstOrDefault(); - if (firstProblem is object) - { - context.ReportDiagnostic(Diagnostic.Create(SyncBlockInValueFactoryDescriptor, this.LanguageUtils.IsolateMethodName(firstProblem).GetLocation())); - } + context.ReportDiagnostic(Diagnostic.Create(SyncBlockInValueFactoryDescriptor, this.LanguageUtils.IsolateMethodName(firstProblem).GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs index d45749590..6f906064c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs @@ -8,82 +8,66 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +public abstract class AbstractVSTHRD012SpecifyJtfWhereAllowed : DiagnosticAnalyzer { - public abstract class AbstractVSTHRD012SpecifyJtfWhereAllowed : DiagnosticAnalyzer - { - public const string Id = "VSTHRD012"; + public const string Id = "VSTHRD012"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD012_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD012_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD012_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD012_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzerObjectCreation), OperationKind.ObjectCreation); - } + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzerObjectCreation), OperationKind.ObjectCreation); + } - private static bool IsImportantJtfParameter(IParameterSymbol ps) - { - return (ps.Type.Name == Types.JoinableTaskContext.TypeName - || ps.Type.Name == Types.JoinableTaskFactory.TypeName - || ps.Type.Name == Types.JoinableTaskCollection.TypeName) - && ps.Type.BelongsToNamespace(Namespaces.MicrosoftVisualStudioThreading) - && !ps.GetAttributes().Any(a => a.AttributeClass.Name == "OptionalAttribute"); - } + private static bool IsImportantJtfParameter(IParameterSymbol ps) + { + return (ps.Type.Name == Types.JoinableTaskContext.TypeName + || ps.Type.Name == Types.JoinableTaskFactory.TypeName + || ps.Type.Name == Types.JoinableTaskCollection.TypeName) + && ps.Type.BelongsToNamespace(Namespaces.MicrosoftVisualStudioThreading) + && !ps.GetAttributes().Any(a => a.AttributeClass.Name == "OptionalAttribute"); + } - private static IArgumentOperation? GetArgumentForParameter(ImmutableArray arguments, IParameterSymbol parameter) + private static IArgumentOperation? GetArgumentForParameter(ImmutableArray arguments, IParameterSymbol parameter) + { + foreach (IArgumentOperation? argument in arguments) { - foreach (IArgumentOperation? argument in arguments) + if (Equals(argument.Parameter, parameter)) { - if (Equals(argument.Parameter, parameter)) - { - return argument; - } + return argument; } - - return null; } - private static void AnalyzeCall(OperationAnalysisContext context, Location location, ImmutableArray argList, IMethodSymbol methodSymbol, IEnumerable otherOverloads) + return null; + } + + private static void AnalyzeCall(OperationAnalysisContext context, Location location, ImmutableArray argList, IMethodSymbol methodSymbol, IEnumerable otherOverloads) + { + IParameterSymbol? firstJtfParameter = methodSymbol.Parameters.FirstOrDefault(IsImportantJtfParameter); + if (firstJtfParameter is object) { - IParameterSymbol? firstJtfParameter = methodSymbol.Parameters.FirstOrDefault(IsImportantJtfParameter); - if (firstJtfParameter is object) + // Verify that if the JTF/JTC parameter is optional, it is actually specified in the caller's syntax. + if (firstJtfParameter.HasExplicitDefaultValue) { - // Verify that if the JTF/JTC parameter is optional, it is actually specified in the caller's syntax. - if (firstJtfParameter.HasExplicitDefaultValue) - { - IArgumentOperation? argument = GetArgumentForParameter(argList, firstJtfParameter); - if (argument is null || argument.IsImplicit) - { - Diagnostic diagnostic = Diagnostic.Create( - Descriptor, - location); - context.ReportDiagnostic(diagnostic); - } - } - } - else - { - // The method being invoked doesn't take any JTC/JTF parameters. - // Look for an overload that does. - bool preferableAlternativesExist = otherOverloads - .Where(m => !m.IsObsolete()) - .Any(m => m.Parameters.Skip(m.IsExtensionMethod ? 1 : 0).Any(IsImportantJtfParameter)); - if (preferableAlternativesExist) + IArgumentOperation? argument = GetArgumentForParameter(argList, firstJtfParameter); + if (argument is null || argument.IsImplicit) { Diagnostic diagnostic = Diagnostic.Create( Descriptor, @@ -92,28 +76,43 @@ private static void AnalyzeCall(OperationAnalysisContext context, Location locat } } } - - private void AnalyzeInvocation(OperationAnalysisContext context) + else { - var invocation = (IInvocationOperation)context.Operation; - SyntaxNode? invokedMethodName = this.LanguageUtils.IsolateMethodName(invocation); - ImmutableArray argList = invocation.Arguments; - IMethodSymbol? methodSymbol = invocation.TargetMethod; - - IEnumerable? otherOverloads = methodSymbol.ContainingType.GetMembers(methodSymbol.Name).OfType(); - AnalyzeCall(context, invokedMethodName.GetLocation(), argList, methodSymbol, otherOverloads); + // The method being invoked doesn't take any JTC/JTF parameters. + // Look for an overload that does. + bool preferableAlternativesExist = otherOverloads + .Where(m => !m.IsObsolete()) + .Any(m => m.Parameters.Skip(m.IsExtensionMethod ? 1 : 0).Any(IsImportantJtfParameter)); + if (preferableAlternativesExist) + { + Diagnostic diagnostic = Diagnostic.Create( + Descriptor, + location); + context.ReportDiagnostic(diagnostic); + } } + } - private void AnalyzerObjectCreation(OperationAnalysisContext context) - { - var objectCreation = (IObjectCreationOperation)context.Operation; - IMethodSymbol? methodSymbol = objectCreation.Constructor; - AnalyzeCall( - context, - this.LanguageUtils.IsolateMethodName(objectCreation).GetLocation(), - objectCreation.Arguments, - methodSymbol, - methodSymbol.ContainingType.Constructors); - } + private void AnalyzeInvocation(OperationAnalysisContext context) + { + var invocation = (IInvocationOperation)context.Operation; + SyntaxNode? invokedMethodName = this.LanguageUtils.IsolateMethodName(invocation); + ImmutableArray argList = invocation.Arguments; + IMethodSymbol? methodSymbol = invocation.TargetMethod; + + IEnumerable? otherOverloads = methodSymbol.ContainingType.GetMembers(methodSymbol.Name).OfType(); + AnalyzeCall(context, invokedMethodName.GetLocation(), argList, methodSymbol, otherOverloads); + } + + private void AnalyzerObjectCreation(OperationAnalysisContext context) + { + var objectCreation = (IObjectCreationOperation)context.Operation; + IMethodSymbol? methodSymbol = objectCreation.Constructor; + AnalyzeCall( + context, + this.LanguageUtils.IsolateMethodName(objectCreation).GetLocation(), + objectCreation.Arguments, + methodSymbol, + methodSymbol.ContainingType.Constructors); } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 482247590..5e3b2a94f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -9,74 +9,73 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Report errors when or +/// overloads are invoked that do not accept an explicit . +/// +/// +/// Not specifying the explicitly is problematic because +/// will then be used. While this is normally (the thread pool), it may not always be. +/// For example, when the calling code is itself running as a scheduled task on a different , +/// then that will be inherited, leading to the calling code to run in an unexpected context. +/// Explicitly specifying will ensure that the behavior is always to run the +/// on the thread pool. Of course any is fine, so long as it is explicitly given (including +/// itself). +/// +public abstract class AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : DiagnosticAnalyzer { - /// - /// Report errors when or - /// overloads are invoked that do not accept an explicit . - /// - /// - /// Not specifying the explicitly is problematic because - /// will then be used. While this is normally (the thread pool), it may not always be. - /// For example, when the calling code is itself running as a scheduled task on a different , - /// then that will be inherited, leading to the calling code to run in an unexpected context. - /// Explicitly specifying will ensure that the behavior is always to run the - /// on the thread pool. Of course any is fine, so long as it is explicitly given (including - /// itself). - /// - public abstract class AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD105"; + public const string Id = "VSTHRD105"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD105_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD105_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD105_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD105_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); - } + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); + } - private void AnalyzeInvocation(OperationAnalysisContext context) + private void AnalyzeInvocation(OperationAnalysisContext context) + { + var operation = (IInvocationOperation)context.Operation; + IMethodSymbol? invokeMethod = operation.TargetMethod; + if (invokeMethod?.ContainingType.BelongsToNamespace(Namespaces.SystemThreadingTasks) ?? false) { - var operation = (IInvocationOperation)context.Operation; - IMethodSymbol? invokeMethod = operation.TargetMethod; - if (invokeMethod?.ContainingType.BelongsToNamespace(Namespaces.SystemThreadingTasks) ?? false) - { - bool reportDiagnostic = false; - bool isContinueWith = invokeMethod.Name == nameof(Task.ContinueWith) && invokeMethod.ContainingType.Name == nameof(Task); - bool isTaskFactoryStartNew = invokeMethod.Name == nameof(TaskFactory.StartNew) && invokeMethod.ContainingType.Name == nameof(TaskFactory); + bool reportDiagnostic = false; + bool isContinueWith = invokeMethod.Name == nameof(Task.ContinueWith) && invokeMethod.ContainingType.Name == nameof(Task); + bool isTaskFactoryStartNew = invokeMethod.Name == nameof(TaskFactory.StartNew) && invokeMethod.ContainingType.Name == nameof(TaskFactory); - if (isContinueWith || isTaskFactoryStartNew) + if (isContinueWith || isTaskFactoryStartNew) + { + if (!invokeMethod.Parameters.Any(p => p.Type.Name == nameof(TaskScheduler) && p.Type.BelongsToNamespace(Namespaces.SystemThreadingTasks))) { - if (!invokeMethod.Parameters.Any(p => p.Type.Name == nameof(TaskScheduler) && p.Type.BelongsToNamespace(Namespaces.SystemThreadingTasks))) - { - reportDiagnostic |= isContinueWith; + reportDiagnostic |= isContinueWith; - // Only notice uses of TaskFactory on the static instance (since custom instances may have a non-problematic default TaskScheduler set). - reportDiagnostic |= isTaskFactoryStartNew - && operation.Instance is IPropertyReferenceOperation { Property: { } factoryProperty } - && factoryProperty.ContainingType.Name == Types.Task.TypeName && factoryProperty.ContainingType.BelongsToNamespace(Namespaces.SystemThreadingTasks) - && factoryProperty.Name == nameof(Task.Factory); - } + // Only notice uses of TaskFactory on the static instance (since custom instances may have a non-problematic default TaskScheduler set). + reportDiagnostic |= isTaskFactoryStartNew + && operation.Instance is IPropertyReferenceOperation { Property: { } factoryProperty } + && factoryProperty.ContainingType.Name == Types.Task.TypeName && factoryProperty.ContainingType.BelongsToNamespace(Namespaces.SystemThreadingTasks) + && factoryProperty.Name == nameof(Task.Factory); } + } - if (reportDiagnostic) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, this.LanguageUtils.IsolateMethodName(operation).GetLocation())); - } + if (reportDiagnostic) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, this.LanguageUtils.IsolateMethodName(operation).GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs index 28960e31f..37f8b6ba1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -8,131 +8,130 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Report warnings when methods that assert their thread affinity only do so under a condition, +/// leaving its true thread requirements less discoverable to the caller. +/// +/// +/// When you have code like this: +/// +/// It's problematic because callers usually aren't prepared for thread affinity sometimes. +/// As a result, code that happens to not execute the conditional logic of the method will +/// temporarily get away with it but then get stung by it later. We want to front-load discovery +/// of such bugs as early as possible by making synchronous methods unconditionally thread affinitized. +/// So a new analyzer should require that the thread-asserting statement appear near the top of the method, and outside of any conditional blocks. +/// +public abstract class AbstractVSTHRD108AssertThreadRequirementUnconditionally : DiagnosticAnalyzer { - /// - /// Report warnings when methods that assert their thread affinity only do so under a condition, - /// leaving its true thread requirements less discoverable to the caller. - /// - /// - /// When you have code like this: - /// - /// It's problematic because callers usually aren't prepared for thread affinity sometimes. - /// As a result, code that happens to not execute the conditional logic of the method will - /// temporarily get away with it but then get stung by it later. We want to front-load discovery - /// of such bugs as early as possible by making synchronous methods unconditionally thread affinitized. - /// So a new analyzer should require that the thread-asserting statement appear near the top of the method, and outside of any conditional blocks. - /// - public abstract class AbstractVSTHRD108AssertThreadRequirementUnconditionally : DiagnosticAnalyzer - { - public const string Id = "VSTHRD108"; + public const string Id = "VSTHRD108"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD108_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD108_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD108_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD108_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterCompilationStartAction(ctxt => - { - var mainThreadAssertingMethods = CommonInterest.ReadMethods(ctxt.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, ctxt.CancellationToken).ToImmutableArray(); + context.RegisterCompilationStartAction(ctxt => + { + var mainThreadAssertingMethods = CommonInterest.ReadMethods(ctxt.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, ctxt.CancellationToken).ToImmutableArray(); - ctxt.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AnalyzeInvocation(c, mainThreadAssertingMethods)), OperationKind.Invocation); - }); - } + ctxt.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AnalyzeInvocation(c, mainThreadAssertingMethods)), OperationKind.Invocation); + }); + } - private static bool IsInConditional(IOperation operation) + private static bool IsInConditional(IOperation operation) + { + foreach (IOperation? ancestor in GetAncestorsWithinMethod(operation)) { - foreach (IOperation? ancestor in GetAncestorsWithinMethod(operation)) + if (ancestor is IConditionalOperation || + ancestor is IWhileLoopOperation { ConditionIsTop: true } || + ancestor is IForLoopOperation) { - if (ancestor is IConditionalOperation || - ancestor is IWhileLoopOperation { ConditionIsTop: true } || - ancestor is IForLoopOperation) - { - return true; - } + return true; } - - return false; } - private static IEnumerable GetAncestorsWithinMethod(IOperation operation) + return false; + } + + private static IEnumerable GetAncestorsWithinMethod(IOperation operation) + { + for (IOperation current = operation; current is object; current = current.Parent) { - for (IOperation current = operation; current is object; current = current.Parent) + if (current is ILocalFunctionOperation || current is IAnonymousFunctionOperation) { - if (current is ILocalFunctionOperation || current is IAnonymousFunctionOperation) - { - yield break; - } - - yield return current; + yield break; } + + yield return current; } + } - private static bool IsArgInInvocationToConditionalMethod(OperationAnalysisContext context) + private static bool IsArgInInvocationToConditionalMethod(OperationAnalysisContext context) + { + IArgumentOperation? argument = GetAncestorsWithinMethod(context.Operation).OfType().FirstOrDefault(); + var containingInvocation = argument?.Parent as IInvocationOperation; + if (containingInvocation is object) { - IArgumentOperation? argument = GetAncestorsWithinMethod(context.Operation).OfType().FirstOrDefault(); - var containingInvocation = argument?.Parent as IInvocationOperation; - if (containingInvocation is object) - { - IMethodSymbol? symbolOfContainingMethodInvocation = containingInvocation.TargetMethod; - return symbolOfContainingMethodInvocation?.GetAttributes().Any(a => - a.AttributeClass.BelongsToNamespace(Namespaces.SystemDiagnostics) && - a.AttributeClass.Name == nameof(System.Diagnostics.ConditionalAttribute)) ?? false; - } - - return false; + IMethodSymbol? symbolOfContainingMethodInvocation = containingInvocation.TargetMethod; + return symbolOfContainingMethodInvocation?.GetAttributes().Any(a => + a.AttributeClass.BelongsToNamespace(Namespaces.SystemDiagnostics) && + a.AttributeClass.Name == nameof(System.Diagnostics.ConditionalAttribute)) ?? false; } - private void AnalyzeInvocation(OperationAnalysisContext context, ImmutableArray mainThreadAssertingMethods) + return false; + } + + private void AnalyzeInvocation(OperationAnalysisContext context, ImmutableArray mainThreadAssertingMethods) + { + var invocation = (IInvocationOperation)context.Operation; + IMethodSymbol? symbol = invocation.TargetMethod; + if (symbol is object) { - var invocation = (IInvocationOperation)context.Operation; - IMethodSymbol? symbol = invocation.TargetMethod; - if (symbol is object) + bool reportDiagnostic = false; + if (mainThreadAssertingMethods.Contains(symbol)) { - bool reportDiagnostic = false; - if (mainThreadAssertingMethods.Contains(symbol)) + if (IsInConditional(invocation)) { - if (IsInConditional(invocation)) - { - reportDiagnostic = true; - } + reportDiagnostic = true; } - else if (CommonInterest.ThreadAffinityTestingMethods.Any(m => m.IsMatch(symbol))) + } + else if (CommonInterest.ThreadAffinityTestingMethods.Any(m => m.IsMatch(symbol))) + { + if (IsArgInInvocationToConditionalMethod(context)) { - if (IsArgInInvocationToConditionalMethod(context)) - { - reportDiagnostic = true; - } + reportDiagnostic = true; } + } - if (reportDiagnostic) - { - SyntaxNode? nodeToLocate = this.LanguageUtils.IsolateMethodName(invocation); - context.ReportDiagnostic(Diagnostic.Create(Descriptor, nodeToLocate.GetLocation())); - } + if (reportDiagnostic) + { + SyntaxNode? nodeToLocate = this.LanguageUtils.IsolateMethodName(invocation); + context.ReportDiagnostic(Diagnostic.Create(Descriptor, nodeToLocate.GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 304cc92bd..05c6263fb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -6,66 +6,65 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Report errors when async methods throw when not on the main thread instead of switching to it. +/// +/// +/// When you have code like this: +/// +/// It's problematic because callers except that async methods can be called from any thread, per the 1st rule. +/// +public abstract class AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : DiagnosticAnalyzer { - /// - /// Report errors when async methods throw when not on the main thread instead of switching to it. - /// - /// - /// When you have code like this: - /// - /// It's problematic because callers except that async methods can be called from any thread, per the 1st rule. - /// - public abstract class AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD109"; + public const string Id = "VSTHRD109"; + + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD109_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD109_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Error, + isEnabledByDefault: true); - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD109_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD109_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Error, - isEnabledByDefault: true); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + private protected abstract LanguageUtils LanguageUtils { get; } - private protected abstract LanguageUtils LanguageUtils { get; } + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - /// - public override void Initialize(AnalysisContext context) + context.RegisterCompilationStartAction(ctxt => { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + var mainThreadAssertingMethods = CommonInterest.ReadMethods(ctxt.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, ctxt.CancellationToken).ToImmutableArray(); + ctxt.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AnalyzeInvocation(c, mainThreadAssertingMethods)), OperationKind.Invocation); + }); + } - context.RegisterCompilationStartAction(ctxt => - { - var mainThreadAssertingMethods = CommonInterest.ReadMethods(ctxt.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, ctxt.CancellationToken).ToImmutableArray(); - ctxt.RegisterOperationAction(Utils.DebuggableWrapper(c => this.AnalyzeInvocation(c, mainThreadAssertingMethods)), OperationKind.Invocation); - }); + private void AnalyzeInvocation(OperationAnalysisContext context, ImmutableArray mainThreadAssertingMethods) + { + if (!(Utils.GetContainingFunction(context.Operation, context.ContainingSymbol) is IMethodSymbol methodSymbol)) + { + return; } - private void AnalyzeInvocation(OperationAnalysisContext context, ImmutableArray mainThreadAssertingMethods) + if (methodSymbol.IsAsync || Utils.HasAsyncCompatibleReturnType(methodSymbol) || Utils.IsAsyncCompatibleReturnType(methodSymbol.ReturnType)) { - if (!(Utils.GetContainingFunction(context.Operation, context.ContainingSymbol) is IMethodSymbol methodSymbol)) - { - return; - } - - if (methodSymbol.IsAsync || Utils.HasAsyncCompatibleReturnType(methodSymbol) || Utils.IsAsyncCompatibleReturnType(methodSymbol.ReturnType)) + var invocation = (IInvocationOperation)context.Operation; + if (mainThreadAssertingMethods.Contains(invocation.TargetMethod)) { - var invocation = (IInvocationOperation)context.Operation; - if (mainThreadAssertingMethods.Contains(invocation.TargetMethod)) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, this.LanguageUtils.IsolateMethodName(invocation).GetLocation())); - } + context.ReportDiagnostic(Diagnostic.Create(Descriptor, this.LanguageUtils.IsolateMethodName(invocation).GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index 3cc7ca1cb..d5d13878f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -5,58 +5,57 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Verifies that types that implement vs-threading's IAsyncDisposable interface also implement System.IAsyncDisposable. +/// +public abstract class AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : DiagnosticAnalyzer { - /// - /// Verifies that types that implement vs-threading's IAsyncDisposable interface also implement System.IAsyncDisposable. - /// - public abstract class AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD112"; + public const string Id = "VSTHRD112"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD112_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD112_MessageFormat), Strings.ResourceManager, typeof(Strings)), - description: new LocalizableResourceString(nameof(Strings.SystemIAsyncDisposablePackageNote), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Info, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD112_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD112_MessageFormat), Strings.ResourceManager, typeof(Strings)), + description: new LocalizableResourceString(nameof(Strings.SystemIAsyncDisposablePackageNote), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Info, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterCompilationStartAction(startCompilation => + context.RegisterCompilationStartAction(startCompilation => + { + INamedTypeSymbol? vsThreadingAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.IAsyncDisposable.FullName); + INamedTypeSymbol? bclAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.BclAsyncDisposable.FullName); + if (vsThreadingAsyncDisposableType is object) { - INamedTypeSymbol? vsThreadingAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.IAsyncDisposable.FullName); - INamedTypeSymbol? bclAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.BclAsyncDisposable.FullName); - if (vsThreadingAsyncDisposableType is object) - { - startCompilation.RegisterSymbolAction(Utils.DebuggableWrapper(c => this.AnalyzeType(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), SymbolKind.NamedType); - } - }); - } + startCompilation.RegisterSymbolAction(Utils.DebuggableWrapper(c => this.AnalyzeType(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), SymbolKind.NamedType); + } + }); + } - private void AnalyzeType(SymbolAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + private void AnalyzeType(SymbolAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + { + var symbol = (INamedTypeSymbol)context.Symbol; + if (symbol.Interfaces.Contains(vsThreadingAsyncDisposableType)) { - var symbol = (INamedTypeSymbol)context.Symbol; - if (symbol.Interfaces.Contains(vsThreadingAsyncDisposableType)) + if (bclAsyncDisposableType is null || !symbol.AllInterfaces.Contains(bclAsyncDisposableType)) { - if (bclAsyncDisposableType is null || !symbol.AllInterfaces.Contains(bclAsyncDisposableType)) - { - context.ReportDiagnostic( - Diagnostic.Create( - Descriptor, - this.LanguageUtils.GetLocationOfBaseTypeName(symbol, vsThreadingAsyncDisposableType, context.Compilation, context.CancellationToken))); - } + context.ReportDiagnostic( + Diagnostic.Create( + Descriptor, + this.LanguageUtils.GetLocationOfBaseTypeName(symbol, vsThreadingAsyncDisposableType, context.Compilation, context.CancellationToken))); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs index f90d1a466..0affd5c59 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -7,68 +7,67 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Finds await expressions on that do not use . +/// Also works on . +/// +public abstract class AbstractVSTHRD114AvoidReturningNullTaskAnalyzer : DiagnosticAnalyzer { - /// - /// Finds await expressions on that do not use . - /// Also works on . - /// - public abstract class AbstractVSTHRD114AvoidReturningNullTaskAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD114"; + public const string Id = "VSTHRD114"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD114_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD114_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD114_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD114_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + private protected abstract LanguageUtils LanguageUtils { get; } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterOperationAction(Utils.DebuggableWrapper(context => this.AnalyzerReturnOperation(context)), OperationKind.Return); - } + context.RegisterOperationAction(Utils.DebuggableWrapper(context => this.AnalyzerReturnOperation(context)), OperationKind.Return); + } - private static IMethodSymbol? FindOwningSymbol(IBlockOperation block, ISymbol containingSymbol) + private static IMethodSymbol? FindOwningSymbol(IBlockOperation block, ISymbol containingSymbol) + { + return block.Parent switch { - return block.Parent switch - { - ILocalFunctionOperation localFunction => localFunction.Symbol, - IAnonymousFunctionOperation anonymousFunction => anonymousFunction.Symbol, + ILocalFunctionOperation localFunction => localFunction.Symbol, + IAnonymousFunctionOperation anonymousFunction => anonymousFunction.Symbol, - // Block parent is the method declaration, for vbnet this means a null parent but for C# it's a IMethodBodyOperation - null => containingSymbol as IMethodSymbol, - IMethodBodyOperation _ => containingSymbol as IMethodSymbol, + // Block parent is the method declaration, for vbnet this means a null parent but for C# it's a IMethodBodyOperation + null => containingSymbol as IMethodSymbol, + IMethodBodyOperation _ => containingSymbol as IMethodSymbol, - _ => null, - }; - } + _ => null, + }; + } - private void AnalyzerReturnOperation(OperationAnalysisContext context) - { - var returnOperation = (IReturnOperation)context.Operation; + private void AnalyzerReturnOperation(OperationAnalysisContext context) + { + var returnOperation = (IReturnOperation)context.Operation; - if (returnOperation.ReturnedValue is { ConstantValue: { HasValue: true, Value: null } } && // could be null for implicit returns - returnOperation.ReturnedValue.Syntax is { } returnedValueSyntax && - Utils.GetContainingFunctionBlock(returnOperation) is { } block && - FindOwningSymbol(block, context.ContainingSymbol) is { } method && - !method.IsAsync && - Utils.IsTask(method.ReturnType) && - !this.LanguageUtils.MethodReturnsNullableReferenceType(method)) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, returnedValueSyntax.GetLocation())); - } + if (returnOperation.ReturnedValue is { ConstantValue: { HasValue: true, Value: null } } && // could be null for implicit returns + returnOperation.ReturnedValue.Syntax is { } returnedValueSyntax && + Utils.GetContainingFunctionBlock(returnOperation) is { } block && + FindOwningSymbol(block, context.ContainingSymbol) is { } method && + !method.IsAsync && + Utils.IsTask(method.ReturnType) && + !this.LanguageUtils.MethodReturnsNullableReferenceType(method)) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, returnedValueSyntax.GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index 0b3c33b13..e20572416 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -16,328 +16,327 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Text; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class CommonInterest { - internal static class CommonInterest - { - internal static readonly Regex FileNamePatternForLegacyThreadSwitchingMembers = new Regex(@"^vs-threading\.LegacyThreadSwitchingMembers(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly Regex FileNamePatternForMembersRequiringMainThread = new Regex(@"^vs-threading\.MembersRequiringMainThread(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly Regex FileNamePatternForMethodsThatAssertMainThread = new Regex(@"^vs-threading\.MainThreadAssertingMethods(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly Regex FileNamePatternForMethodsThatSwitchToMainThread = new Regex(@"^vs-threading\.MainThreadSwitchingMethods(\..*)?.txt$", FileNamePatternRegexOptions); + internal static readonly Regex FileNamePatternForLegacyThreadSwitchingMembers = new Regex(@"^vs-threading\.LegacyThreadSwitchingMembers(\..*)?.txt$", FileNamePatternRegexOptions); + internal static readonly Regex FileNamePatternForMembersRequiringMainThread = new Regex(@"^vs-threading\.MembersRequiringMainThread(\..*)?.txt$", FileNamePatternRegexOptions); + internal static readonly Regex FileNamePatternForMethodsThatAssertMainThread = new Regex(@"^vs-threading\.MainThreadAssertingMethods(\..*)?.txt$", FileNamePatternRegexOptions); + internal static readonly Regex FileNamePatternForMethodsThatSwitchToMainThread = new Regex(@"^vs-threading\.MainThreadSwitchingMethods(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly IEnumerable JTFSyncBlockers = new[] - { - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTaskFactory.TypeName), Types.JoinableTaskFactory.Run), Types.JoinableTaskFactory.RunAsync), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTask.TypeName), Types.JoinableTask.Join), Types.JoinableTask.JoinAsync), - }; + internal static readonly IEnumerable JTFSyncBlockers = new[] + { + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTaskFactory.TypeName), Types.JoinableTaskFactory.Run), Types.JoinableTaskFactory.RunAsync), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTask.TypeName), Types.JoinableTask.Join), Types.JoinableTask.JoinAsync), + }; - internal static readonly IEnumerable ProblematicSyncBlockingMethods = new[] - { - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Wait)), null), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAll)), null), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAny)), null), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(TaskAwaiter)), nameof(TaskAwaiter.GetResult)), null), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(ValueTaskAwaiter)), nameof(ValueTaskAwaiter.GetResult)), null), - }; - - internal static readonly IEnumerable SyncBlockingMethods = JTFSyncBlockers.Concat(ProblematicSyncBlockingMethods).Concat(new[] - { - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "Wait"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "GetResult"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), - }); + internal static readonly IEnumerable ProblematicSyncBlockingMethods = new[] + { + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Wait)), null), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAll)), null), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAny)), null), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(TaskAwaiter)), nameof(TaskAwaiter.GetResult)), null), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(ValueTaskAwaiter)), nameof(ValueTaskAwaiter.GetResult)), null), + }; + + internal static readonly IEnumerable SyncBlockingMethods = JTFSyncBlockers.Concat(ProblematicSyncBlockingMethods).Concat(new[] + { + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "Wait"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "GetResult"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), + }); - internal static readonly IReadOnlyList SyncBlockingProperties = new[] - { - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Result)), null), - new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(ValueTask)), nameof(ValueTask.Result)), null), - }; + internal static readonly IReadOnlyList SyncBlockingProperties = new[] + { + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Result)), null), + new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(ValueTask)), nameof(ValueTask.Result)), null), + }; - internal static readonly IEnumerable ThreadAffinityTestingMethods = new[] - { - new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShell, Types.ThreadHelper.TypeName), Types.ThreadHelper.CheckAccess), - }; + internal static readonly IEnumerable ThreadAffinityTestingMethods = new[] + { + new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShell, Types.ThreadHelper.TypeName), Types.ThreadHelper.CheckAccess), + }; - internal static readonly ImmutableArray TaskConfigureAwait = ImmutableArray.Create( - new QualifiedMember(new QualifiedType(Types.Task.Namespace, Types.Task.TypeName), nameof(Task.ConfigureAwait)), - new QualifiedMember(new QualifiedType(Types.AwaitExtensions.Namespace, Types.AwaitExtensions.TypeName), Types.AwaitExtensions.ConfigureAwaitRunInline)); + internal static readonly ImmutableArray TaskConfigureAwait = ImmutableArray.Create( + new QualifiedMember(new QualifiedType(Types.Task.Namespace, Types.Task.TypeName), nameof(Task.ConfigureAwait)), + new QualifiedMember(new QualifiedType(Types.AwaitExtensions.Namespace, Types.AwaitExtensions.TypeName), Types.AwaitExtensions.ConfigureAwaitRunInline)); - private const RegexOptions FileNamePatternRegexOptions = RegexOptions.IgnoreCase | RegexOptions.Singleline; + private const RegexOptions FileNamePatternRegexOptions = RegexOptions.IgnoreCase | RegexOptions.Singleline; - private static readonly TimeSpan RegexMatchTimeout = TimeSpan.FromSeconds(5); // Prevent expensive CPU hang in Regex.Match if backtracking occurs due to pathological input (see #485). + private static readonly TimeSpan RegexMatchTimeout = TimeSpan.FromSeconds(5); // Prevent expensive CPU hang in Regex.Match if backtracking occurs due to pathological input (see #485). - private static readonly Regex NegatableTypeOrMemberReferenceRegex = new Regex(@"^(?!)?\[(?[^\[\]\:]+)+\](?:\:\:(?\S+))?\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); + private static readonly Regex NegatableTypeOrMemberReferenceRegex = new Regex(@"^(?!)?\[(?[^\[\]\:]+)+\](?:\:\:(?\S+))?\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); - private static readonly Regex MemberReferenceRegex = new Regex(@"^\[(?[^\[\]\:]+)+\]::(?\S+)\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); + private static readonly Regex MemberReferenceRegex = new Regex(@"^\[(?[^\[\]\:]+)+\]::(?\S+)\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); - /// - /// An array with '.' as its only element. - /// - private static readonly char[] QualifiedIdentifierSeparators = new[] { '.' }; + /// + /// An array with '.' as its only element. + /// + private static readonly char[] QualifiedIdentifierSeparators = new[] { '.' }; - internal static IEnumerable ReadMethods(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + internal static IEnumerable ReadMethods(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + { + foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) { - foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) - { - yield return ParseAdditionalFileMethodLine(line); - } + yield return ParseAdditionalFileMethodLine(line); } + } - internal static IEnumerable ReadTypesAndMembers(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + internal static IEnumerable ReadTypesAndMembers(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + { + foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) { - foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) + Match? match = null; + try { - Match? match = null; - try - { - match = NegatableTypeOrMemberReferenceRegex.Match(line); - } - catch (RegexMatchTimeoutException) - { - throw new InvalidOperationException($"Regex.Match timeout when parsing line: {line}"); - } - - if (!match.Success) - { - throw new InvalidOperationException($"Parsing error on line: {line}"); - } - - bool inverted = match.Groups["negated"].Success; - string[] typeNameElements = match.Groups["typeName"].Value.Split(QualifiedIdentifierSeparators); - string typeName = typeNameElements[typeNameElements.Length - 1]; - var containingNamespace = typeNameElements.Take(typeNameElements.Length - 1).ToImmutableArray(); - var type = new QualifiedType(containingNamespace, typeName); - QualifiedMember member = match.Groups["memberName"].Success ? new QualifiedMember(type, match.Groups["memberName"].Value) : default(QualifiedMember); - yield return new TypeMatchSpec(type, member, inverted); + match = NegatableTypeOrMemberReferenceRegex.Match(line); } - } - - internal static IEnumerable ReadAdditionalFiles(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) - { - if (analyzerOptions is null) + catch (RegexMatchTimeoutException) { - throw new ArgumentNullException(nameof(analyzerOptions)); + throw new InvalidOperationException($"Regex.Match timeout when parsing line: {line}"); } - if (fileNamePattern is null) + if (!match.Success) { - throw new ArgumentNullException(nameof(fileNamePattern)); + throw new InvalidOperationException($"Parsing error on line: {line}"); } - IEnumerable? docs = from file in analyzerOptions.AdditionalFiles.OrderBy(x => x.Path, StringComparer.Ordinal) - let fileName = Path.GetFileName(file.Path) - where fileNamePattern.IsMatch(fileName) - let text = file.GetText(cancellationToken) - select text; - return docs.SelectMany(ReadLinesFromAdditionalFile); + bool inverted = match.Groups["negated"].Success; + string[] typeNameElements = match.Groups["typeName"].Value.Split(QualifiedIdentifierSeparators); + string typeName = typeNameElements[typeNameElements.Length - 1]; + var containingNamespace = typeNameElements.Take(typeNameElements.Length - 1).ToImmutableArray(); + var type = new QualifiedType(containingNamespace, typeName); + QualifiedMember member = match.Groups["memberName"].Success ? new QualifiedMember(type, match.Groups["memberName"].Value) : default(QualifiedMember); + yield return new TypeMatchSpec(type, member, inverted); + } + } + + internal static IEnumerable ReadAdditionalFiles(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + { + if (analyzerOptions is null) + { + throw new ArgumentNullException(nameof(analyzerOptions)); } - internal static bool Contains(this ImmutableArray methods, ISymbol symbol) + if (fileNamePattern is null) { - foreach (QualifiedMember method in methods) + throw new ArgumentNullException(nameof(fileNamePattern)); + } + + IEnumerable? docs = from file in analyzerOptions.AdditionalFiles.OrderBy(x => x.Path, StringComparer.Ordinal) + let fileName = Path.GetFileName(file.Path) + where fileNamePattern.IsMatch(fileName) + let text = file.GetText(cancellationToken) + select text; + return docs.SelectMany(ReadLinesFromAdditionalFile); + } + + internal static bool Contains(this ImmutableArray methods, ISymbol symbol) + { + foreach (QualifiedMember method in methods) + { + if (method.IsMatch(symbol)) { - if (method.IsMatch(symbol)) - { - return true; - } + return true; } - - return false; } - internal static bool Contains(this ImmutableArray types, [NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) + return false; + } + + internal static bool Contains(this ImmutableArray types, [NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) + { + TypeMatchSpec matching = default(TypeMatchSpec); + foreach (TypeMatchSpec type in types) { - TypeMatchSpec matching = default(TypeMatchSpec); - foreach (TypeMatchSpec type in types) + if (type.IsMatch(typeSymbol, memberSymbol)) { - if (type.IsMatch(typeSymbol, memberSymbol)) + if (matching.IsEmpty || matching.IsWildcard) { - if (matching.IsEmpty || matching.IsWildcard) + matching = type; + if (!matching.IsWildcard) { - matching = type; - if (!matching.IsWildcard) - { - // It's an exact match, so return it immediately. - return !matching.InvertedLogic; - } + // It's an exact match, so return it immediately. + return !matching.InvertedLogic; } } } + } - return !matching.IsEmpty && !matching.InvertedLogic; + return !matching.IsEmpty && !matching.InvertedLogic; + } + + internal static IEnumerable ReadLinesFromAdditionalFile(SourceText text) + { + if (text is null) + { + throw new ArgumentNullException(nameof(text)); } - internal static IEnumerable ReadLinesFromAdditionalFile(SourceText text) + foreach (TextLine line in text.Lines) { - if (text is null) + string lineText = line.ToString(); + + if (!string.IsNullOrWhiteSpace(lineText) && !lineText.StartsWith("#", StringComparison.OrdinalIgnoreCase)) { - throw new ArgumentNullException(nameof(text)); + yield return lineText; } + } + } - foreach (TextLine line in text.Lines) - { - string lineText = line.ToString(); + internal static QualifiedMember ParseAdditionalFileMethodLine(string line) + { + Match? match = null; + try + { + match = MemberReferenceRegex.Match(line); + } + catch (RegexMatchTimeoutException) + { + throw new InvalidOperationException($"Regex.Match timeout when parsing line: {line}"); + } - if (!string.IsNullOrWhiteSpace(lineText) && !lineText.StartsWith("#", StringComparison.OrdinalIgnoreCase)) - { - yield return lineText; - } - } + if (!match.Success) + { + throw new InvalidOperationException($"Parsing error on line: {line}"); } - internal static QualifiedMember ParseAdditionalFileMethodLine(string line) + string methodName = match.Groups["memberName"].Value; + string[] typeNameElements = match.Groups["typeName"].Value.Split(QualifiedIdentifierSeparators); + string typeName = typeNameElements[typeNameElements.Length - 1]; + var containingType = new QualifiedType(typeNameElements.Take(typeNameElements.Length - 1).ToImmutableArray(), typeName); + return new QualifiedMember(containingType, methodName); + } + + internal readonly struct TypeMatchSpec + { + internal TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) { - Match? match = null; - try - { - match = MemberReferenceRegex.Match(line); - } - catch (RegexMatchTimeoutException) - { - throw new InvalidOperationException($"Regex.Match timeout when parsing line: {line}"); - } + this.InvertedLogic = inverted; + this.Type = type; + this.Member = member; - if (!match.Success) + if (this.IsWildcard && this.Member.Name is object) { - throw new InvalidOperationException($"Parsing error on line: {line}"); + throw new ArgumentException("Wildcard use is not allowed when member of type is specified."); } - - string methodName = match.Groups["memberName"].Value; - string[] typeNameElements = match.Groups["typeName"].Value.Split(QualifiedIdentifierSeparators); - string typeName = typeNameElements[typeNameElements.Length - 1]; - var containingType = new QualifiedType(typeNameElements.Take(typeNameElements.Length - 1).ToImmutableArray(), typeName); - return new QualifiedMember(containingType, methodName); } - internal readonly struct TypeMatchSpec - { - internal TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) - { - this.InvertedLogic = inverted; - this.Type = type; - this.Member = member; + /// + /// Gets a value indicating whether this entry appeared in a file with a leading "!" character. + /// + internal bool InvertedLogic { get; } - if (this.IsWildcard && this.Member.Name is object) - { - throw new ArgumentException("Wildcard use is not allowed when member of type is specified."); - } - } + /// + /// Gets the type described by this entry. + /// + internal QualifiedType Type { get; } - /// - /// Gets a value indicating whether this entry appeared in a file with a leading "!" character. - /// - internal bool InvertedLogic { get; } - - /// - /// Gets the type described by this entry. - /// - internal QualifiedType Type { get; } - - /// - /// Gets the member described by this entry. - /// - internal QualifiedMember Member { get; } - - /// - /// Gets a value indicating whether a member match is reuqired. - /// - internal bool IsMember => this.Member.Name is object; - - /// - /// Gets a value indicating whether the typename is a wildcard. - /// - internal bool IsWildcard => this.Type.Name == "*"; - - /// - /// Gets a value indicating whether this is an uninitialized (default) instance. - /// - internal bool IsEmpty => this.Type.Namespace is null; - - /// - /// Tests whether a given symbol matches the description of a type (independent of its property). - /// - internal bool IsMatch([NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) - { - if (typeSymbol is null) - { - return false; - } + /// + /// Gets the member described by this entry. + /// + internal QualifiedMember Member { get; } - if (!this.IsMember - && (this.IsWildcard || typeSymbol.Name == this.Type.Name) - && typeSymbol.BelongsToNamespace(this.Type.Namespace)) - { - return true; - } + /// + /// Gets a value indicating whether a member match is reuqired. + /// + internal bool IsMember => this.Member.Name is object; - if (this.IsMember - && memberSymbol?.Name == this.Member.Name - && typeSymbol.Name == this.Type.Name - && typeSymbol.BelongsToNamespace(this.Type.Namespace)) - { - return true; - } + /// + /// Gets a value indicating whether the typename is a wildcard. + /// + internal bool IsWildcard => this.Type.Name == "*"; - return false; - } - } + /// + /// Gets a value indicating whether this is an uninitialized (default) instance. + /// + internal bool IsEmpty => this.Type.Namespace is null; - internal readonly struct QualifiedType + /// + /// Tests whether a given symbol matches the description of a type (independent of its property). + /// + internal bool IsMatch([NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) { - public QualifiedType(IReadOnlyList containingTypeNamespace, string typeName) + if (typeSymbol is null) { - this.Namespace = containingTypeNamespace; - this.Name = typeName; + return false; } - public IReadOnlyList Namespace { get; } - - public string Name { get; } + if (!this.IsMember + && (this.IsWildcard || typeSymbol.Name == this.Type.Name) + && typeSymbol.BelongsToNamespace(this.Type.Namespace)) + { + return true; + } - public bool IsMatch(ISymbol symbol) + if (this.IsMember + && memberSymbol?.Name == this.Member.Name + && typeSymbol.Name == this.Type.Name + && typeSymbol.BelongsToNamespace(this.Type.Namespace)) { - return symbol?.Name == this.Name - && symbol.BelongsToNamespace(this.Namespace); + return true; } - public override string ToString() => string.Join(".", this.Namespace.Concat(new[] { this.Name })); + return false; } + } - internal readonly struct QualifiedMember + internal readonly struct QualifiedType + { + public QualifiedType(IReadOnlyList containingTypeNamespace, string typeName) { - public QualifiedMember(QualifiedType containingType, string methodName) - { - this.ContainingType = containingType; - this.Name = methodName; - } + this.Namespace = containingTypeNamespace; + this.Name = typeName; + } - public QualifiedType ContainingType { get; } + public IReadOnlyList Namespace { get; } - public string Name { get; } + public string Name { get; } - public bool IsMatch(ISymbol symbol) - { - return symbol?.Name == this.Name - && this.ContainingType.IsMatch(symbol.ContainingType); - } - - public override string ToString() => this.ContainingType.ToString() + "." + this.Name; + public bool IsMatch(ISymbol symbol) + { + return symbol?.Name == this.Name + && symbol.BelongsToNamespace(this.Namespace); } - [DebuggerDisplay("{" + nameof(Method) + "} -> {" + nameof(AsyncAlternativeMethodName) + "}")] - internal readonly struct SyncBlockingMethod + public override string ToString() => string.Join(".", this.Namespace.Concat(new[] { this.Name })); + } + + internal readonly struct QualifiedMember + { + public QualifiedMember(QualifiedType containingType, string methodName) { - public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethodName = null, IReadOnlyList? extensionMethodNamespace = null) - { - this.Method = method; - this.AsyncAlternativeMethodName = asyncAlternativeMethodName; - this.ExtensionMethodNamespace = extensionMethodNamespace; - } + this.ContainingType = containingType; + this.Name = methodName; + } + + public QualifiedType ContainingType { get; } - public QualifiedMember Method { get; } + public string Name { get; } - public string? AsyncAlternativeMethodName { get; } + public bool IsMatch(ISymbol symbol) + { + return symbol?.Name == this.Name + && this.ContainingType.IsMatch(symbol.ContainingType); + } - public IReadOnlyList? ExtensionMethodNamespace { get; } + public override string ToString() => this.ContainingType.ToString() + "." + this.Name; + } + + [DebuggerDisplay("{" + nameof(Method) + "} -> {" + nameof(AsyncAlternativeMethodName) + "}")] + internal readonly struct SyncBlockingMethod + { + public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethodName = null, IReadOnlyList? extensionMethodNamespace = null) + { + this.Method = method; + this.AsyncAlternativeMethodName = asyncAlternativeMethodName; + this.ExtensionMethodNamespace = extensionMethodNamespace; } + + public QualifiedMember Method { get; } + + public string? AsyncAlternativeMethodName { get; } + + public IReadOnlyList? ExtensionMethodNamespace { get; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs index 9369534b5..c6bcd4c56 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs @@ -11,121 +11,120 @@ using System.Threading.Tasks; using Microsoft.CodeAnalysis; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// A class for our analyzers that provide per-compilation caching by way of its private fields +/// to support common utility methods. +/// +internal abstract class DiagnosticAnalyzerState { - /// - /// A class for our analyzers that provide per-compilation caching by way of its private fields - /// to support common utility methods. - /// - internal abstract class DiagnosticAnalyzerState - { - private const string GetAwaiterMethodName = nameof(Task.GetAwaiter); + private const string GetAwaiterMethodName = nameof(Task.GetAwaiter); - private readonly ConcurrentDictionary customAwaitableTypes = new ConcurrentDictionary(); + private readonly ConcurrentDictionary customAwaitableTypes = new ConcurrentDictionary(); - internal bool IsAwaitableType(ITypeSymbol? typeSymbol, Compilation compilation, CancellationToken cancellationToken) + internal bool IsAwaitableType(ITypeSymbol? typeSymbol, Compilation compilation, CancellationToken cancellationToken) + { + if (typeSymbol is null) { - if (typeSymbol is null) + return false; + } + + if (!this.customAwaitableTypes.TryGetValue(typeSymbol, out bool isAwaitable)) + { + IMethodSymbol? getAwaiterMethod = typeSymbol.GetMembers(nameof(Task.GetAwaiter)).OfType().FirstOrDefault(m => m.Parameters.IsEmpty); + if (getAwaiterMethod is object) { - return false; + isAwaitable = ConformsToAwaiterPattern(getAwaiterMethod.ReturnType); } - - if (!this.customAwaitableTypes.TryGetValue(typeSymbol, out bool isAwaitable)) + else { - IMethodSymbol? getAwaiterMethod = typeSymbol.GetMembers(nameof(Task.GetAwaiter)).OfType().FirstOrDefault(m => m.Parameters.IsEmpty); - if (getAwaiterMethod is object) - { - isAwaitable = ConformsToAwaiterPattern(getAwaiterMethod.ReturnType); - } - else - { - IEnumerable? awaitableTypesFromThisAssembly = from candidateAwaiterMethod in compilation.GetSymbolsWithName(m => m == GetAwaiterMethodName, SymbolFilter.Member, cancellationToken).OfType() - where candidateAwaiterMethod.IsExtensionMethod && !candidateAwaiterMethod.Parameters.IsEmpty - where ConformsToAwaiterPattern(candidateAwaiterMethod.ReturnType) - select candidateAwaiterMethod.Parameters[0].Type; - IEnumerable? awaitableTypesPerAssembly = from assembly in compilation.Assembly.Modules.First().ReferencedAssemblySymbols - from awaitableType in GetAwaitableTypes(assembly) - select awaitableType; - isAwaitable = awaitableTypesFromThisAssembly.Concat(awaitableTypesPerAssembly).Contains(typeSymbol); - } - - this.customAwaitableTypes.TryAdd(typeSymbol, isAwaitable); + IEnumerable? awaitableTypesFromThisAssembly = from candidateAwaiterMethod in compilation.GetSymbolsWithName(m => m == GetAwaiterMethodName, SymbolFilter.Member, cancellationToken).OfType() + where candidateAwaiterMethod.IsExtensionMethod && !candidateAwaiterMethod.Parameters.IsEmpty + where ConformsToAwaiterPattern(candidateAwaiterMethod.ReturnType) + select candidateAwaiterMethod.Parameters[0].Type; + IEnumerable? awaitableTypesPerAssembly = from assembly in compilation.Assembly.Modules.First().ReferencedAssemblySymbols + from awaitableType in GetAwaitableTypes(assembly) + select awaitableType; + isAwaitable = awaitableTypesFromThisAssembly.Concat(awaitableTypesPerAssembly).Contains(typeSymbol); } - return isAwaitable; + this.customAwaitableTypes.TryAdd(typeSymbol, isAwaitable); } - private static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) + return isAwaitable; + } + + private static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) + { + if (typeSymbol is null) { - if (typeSymbol is null) - { - return false; - } + return false; + } - var hasGetResultMethod = false; - var hasOnCompletedMethod = false; - var hasIsCompletedProperty = false; + var hasGetResultMethod = false; + var hasOnCompletedMethod = false; + var hasIsCompletedProperty = false; + + foreach (ISymbol? member in typeSymbol.GetMembers()) + { + hasGetResultMethod |= member.Name == nameof(TaskAwaiter.GetResult) && member is IMethodSymbol m && m.Parameters.IsEmpty; + hasOnCompletedMethod |= member.Name == nameof(TaskAwaiter.OnCompleted) && member is IMethodSymbol; + hasIsCompletedProperty |= member.Name == nameof(TaskAwaiter.IsCompleted) && member is IPropertySymbol; - foreach (ISymbol? member in typeSymbol.GetMembers()) + if (hasGetResultMethod && hasOnCompletedMethod && hasIsCompletedProperty) { - hasGetResultMethod |= member.Name == nameof(TaskAwaiter.GetResult) && member is IMethodSymbol m && m.Parameters.IsEmpty; - hasOnCompletedMethod |= member.Name == nameof(TaskAwaiter.OnCompleted) && member is IMethodSymbol; - hasIsCompletedProperty |= member.Name == nameof(TaskAwaiter.IsCompleted) && member is IPropertySymbol; - - if (hasGetResultMethod && hasOnCompletedMethod && hasIsCompletedProperty) - { - return true; - } + return true; } + } - return false; + return false; + } + + private static IEnumerable GetAwaitableTypes(IAssemblySymbol assembly) + { + if (assembly is null) + { + throw new ArgumentNullException(nameof(assembly)); } - private static IEnumerable GetAwaitableTypes(IAssemblySymbol assembly) + if (!assembly.MightContainExtensionMethods) { - if (assembly is null) - { - throw new ArgumentNullException(nameof(assembly)); - } + return Enumerable.Empty(); + } - if (!assembly.MightContainExtensionMethods) - { - return Enumerable.Empty(); - } + return GetAwaitableTypes(assembly.GlobalNamespace); + } - return GetAwaitableTypes(assembly.GlobalNamespace); + private static IEnumerable GetAwaitableTypes(INamespaceOrTypeSymbol namespaceOrTypeSymbol) + { + if (namespaceOrTypeSymbol is null || namespaceOrTypeSymbol.DeclaredAccessibility != Accessibility.Public) + { + yield break; } - private static IEnumerable GetAwaitableTypes(INamespaceOrTypeSymbol namespaceOrTypeSymbol) + foreach (ISymbol? member in namespaceOrTypeSymbol.GetMembers()) { - if (namespaceOrTypeSymbol is null || namespaceOrTypeSymbol.DeclaredAccessibility != Accessibility.Public) - { - yield break; - } - - foreach (ISymbol? member in namespaceOrTypeSymbol.GetMembers()) + switch (member) { - switch (member) - { - case INamespaceOrTypeSymbol nsOrType: - foreach (ITypeSymbol? nested in GetAwaitableTypes(nsOrType)) - { - yield return nested; - } - - break; - case IMethodSymbol method: - if (method.DeclaredAccessibility == Accessibility.Public && - method.IsExtensionMethod && - method.Name == GetAwaiterMethodName && - !method.Parameters.IsEmpty && - ConformsToAwaiterPattern(method.ReturnType)) - { - yield return method.Parameters[0].Type; - } - - break; - } + case INamespaceOrTypeSymbol nsOrType: + foreach (ITypeSymbol? nested in GetAwaitableTypes(nsOrType)) + { + yield return nested; + } + + break; + case IMethodSymbol method: + if (method.DeclaredAccessibility == Accessibility.Public && + method.IsExtensionMethod && + method.Name == GetAwaiterMethodName && + !method.Parameters.IsEmpty && + ConformsToAwaiterPattern(method.ReturnType)) + { + yield return method.Parameters[0].Type; + } + + break; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs index b79661f29..a48261e63 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs @@ -5,16 +5,15 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal abstract class LanguageUtils { - internal abstract class LanguageUtils - { - internal abstract Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken); + internal abstract Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken); - internal abstract SyntaxNode IsolateMethodName(IInvocationOperation invocation); + internal abstract SyntaxNode IsolateMethodName(IInvocationOperation invocation); - internal abstract SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation); + internal abstract SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation); - internal abstract bool MethodReturnsNullableReferenceType(IMethodSymbol method); - } + internal abstract bool MethodReturnsNullableReferenceType(IMethodSymbol method); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs index cea3ad84b..be5b1a654 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs @@ -3,82 +3,81 @@ using System.Collections.Generic; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class Namespaces { - internal static class Namespaces + internal static readonly IReadOnlyList System = new[] { - internal static readonly IReadOnlyList System = new[] - { - nameof(System), - }; + nameof(System), + }; - internal static readonly IReadOnlyList SystemCollectionsGeneric = new[] - { - nameof(System), - nameof(global::System.Collections), - nameof(global::System.Collections.Generic), - }; + internal static readonly IReadOnlyList SystemCollectionsGeneric = new[] + { + nameof(System), + nameof(global::System.Collections), + nameof(global::System.Collections.Generic), + }; - internal static readonly IReadOnlyList SystemThreading = new[] - { - nameof(System), - nameof(global::System.Threading), - }; + internal static readonly IReadOnlyList SystemThreading = new[] + { + nameof(System), + nameof(global::System.Threading), + }; - internal static readonly IReadOnlyList SystemDiagnostics = new[] - { - nameof(System), - nameof(global::System.Diagnostics), - }; + internal static readonly IReadOnlyList SystemDiagnostics = new[] + { + nameof(System), + nameof(global::System.Diagnostics), + }; - internal static readonly IReadOnlyList SystemThreadingTasks = new[] - { - nameof(System), - nameof(global::System.Threading), - nameof(global::System.Threading.Tasks), - }; + internal static readonly IReadOnlyList SystemThreadingTasks = new[] + { + nameof(System), + nameof(global::System.Threading), + nameof(global::System.Threading.Tasks), + }; - internal static readonly IReadOnlyList SystemRuntimeCompilerServices = new[] - { - nameof(System), - nameof(global::System.Runtime), - nameof(global::System.Runtime.CompilerServices), - }; + internal static readonly IReadOnlyList SystemRuntimeCompilerServices = new[] + { + nameof(System), + nameof(global::System.Runtime), + nameof(global::System.Runtime.CompilerServices), + }; - internal static readonly IReadOnlyList SystemRuntimeInteropServices = new[] - { - nameof(System), - nameof(global::System.Runtime), - nameof(global::System.Runtime.InteropServices), - }; + internal static readonly IReadOnlyList SystemRuntimeInteropServices = new[] + { + nameof(System), + nameof(global::System.Runtime), + nameof(global::System.Runtime.InteropServices), + }; - internal static readonly IReadOnlyList SystemWindowsThreading = new[] - { - nameof(System), - nameof(global::System.Windows), - "Threading", - }; + internal static readonly IReadOnlyList SystemWindowsThreading = new[] + { + nameof(System), + nameof(global::System.Windows), + "Threading", + }; - internal static readonly IReadOnlyList MicrosoftVisualStudioThreading = new[] - { - "Microsoft", - "VisualStudio", - "Threading", - }; + internal static readonly IReadOnlyList MicrosoftVisualStudioThreading = new[] + { + "Microsoft", + "VisualStudio", + "Threading", + }; - internal static readonly IReadOnlyList MicrosoftVisualStudioShell = new[] - { - "Microsoft", - "VisualStudio", - "Shell", - }; + internal static readonly IReadOnlyList MicrosoftVisualStudioShell = new[] + { + "Microsoft", + "VisualStudio", + "Shell", + }; - internal static readonly IReadOnlyList MicrosoftVisualStudioShellInterop = new[] - { - "Microsoft", - "VisualStudio", - "Shell", - "Interop", - }; - } + internal static readonly IReadOnlyList MicrosoftVisualStudioShellInterop = new[] + { + "Microsoft", + "VisualStudio", + "Shell", + "Interop", + }; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs index 99f4bbc2f..3ac90eeb4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs @@ -8,643 +8,642 @@ // //------------------------------------------------------------------------------ -namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - using System.Reflection; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class Strings { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal Strings() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Analyzers.Strings", typeof(Strings).GetTypeInfo().Assembly); - resourceMan = temp; - } - return resourceMan; +namespace Microsoft.VisualStudio.Threading.Analyzers; +using System; +using System.Reflection; + + +/// +/// A strongly-typed resource class, for looking up localized strings, etc. +/// +// This class was auto-generated by the StronglyTypedResourceBuilder +// class via a tool like ResGen or Visual Studio. +// To add or remove a member, edit your .ResX file then rerun ResGen +// with the /str option, or rebuild your VS project. +[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] +[global::System.Diagnostics.DebuggerNonUserCodeAttribute()] +[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] +internal class Strings { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Strings() { + } + + /// + /// Returns the cached ResourceManager instance used by this class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Analyzers.Strings", typeof(Strings).GetTypeInfo().Assembly); + resourceMan = temp; } + return resourceMan; } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } + } + + /// + /// Overrides the current thread's CurrentUICulture property for all + /// resource lookups using this strongly typed resource class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; } - - /// - /// Looks up a localized string similar to Await {0} instead. - /// - internal static string AwaitXInstead { - get { - return ResourceManager.GetString("AwaitXInstead", resourceCulture); - } + set { + resourceCulture = value; } - - /// - /// Looks up a localized string similar to The System.IAsyncDisposable interface is defined in the Microsoft.Bcl.AsyncInterfaces NuGet package.. - /// - internal static string SystemIAsyncDisposablePackageNote { - get { - return ResourceManager.GetString("SystemIAsyncDisposablePackageNote", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Await {0} instead. + /// + internal static string AwaitXInstead { + get { + return ResourceManager.GetString("AwaitXInstead", resourceCulture); } - - /// - /// Looks up a localized string similar to Use await instead. - /// - internal static string UseAwaitInstead { - get { - return ResourceManager.GetString("UseAwaitInstead", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to The System.IAsyncDisposable interface is defined in the Microsoft.Bcl.AsyncInterfaces NuGet package.. + /// + internal static string SystemIAsyncDisposablePackageNote { + get { + return ResourceManager.GetString("SystemIAsyncDisposablePackageNote", resourceCulture); } - - /// - /// Looks up a localized string similar to Await JoinableTaskFactory.SwitchToMainThreadAsync() to switch to the UI thread instead of APIs that can deadlock or require specifying a priority. - /// - internal static string VSTHRD001_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD001_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use await instead. + /// + internal static string UseAwaitInstead { + get { + return ResourceManager.GetString("UseAwaitInstead", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid legacy thread switching APIs. - /// - internal static string VSTHRD001_Title { - get { - return ResourceManager.GetString("VSTHRD001_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Await JoinableTaskFactory.SwitchToMainThreadAsync() to switch to the UI thread instead of APIs that can deadlock or require specifying a priority. + /// + internal static string VSTHRD001_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD001_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Use await instead. - /// - internal static string VSTHRD002_CodeFix_Await_Title { - get { - return ResourceManager.GetString("VSTHRD002_CodeFix_Await_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid legacy thread switching APIs. + /// + internal static string VSTHRD001_Title { + get { + return ResourceManager.GetString("VSTHRD001_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.. - /// - internal static string VSTHRD002_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD002_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use await instead. + /// + internal static string VSTHRD002_CodeFix_Await_Title { + get { + return ResourceManager.GetString("VSTHRD002_CodeFix_Await_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid problematic synchronous waits. - /// - internal static string VSTHRD002_Title { - get { - return ResourceManager.GetString("VSTHRD002_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.. + /// + internal static string VSTHRD002_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD002_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid awaiting or returning a Task representing work that was not started within your context as that can lead to deadlocks. - ///Start the work within this context, or use JoinableTaskFactory.RunAsync to start the task and await the returned JoinableTask instead.. - /// - internal static string VSTHRD003_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD003_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid problematic synchronous waits. + /// + internal static string VSTHRD002_Title { + get { + return ResourceManager.GetString("VSTHRD002_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid awaiting foreign Tasks. - /// - internal static string VSTHRD003_Title { - get { - return ResourceManager.GetString("VSTHRD003_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid awaiting or returning a Task representing work that was not started within your context as that can lead to deadlocks. + ///Start the work within this context, or use JoinableTaskFactory.RunAsync to start the task and await the returned JoinableTask instead.. + /// + internal static string VSTHRD003_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD003_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Calls to JoinableTaskFactory.SwitchToMainThreadAsync() must be awaited. - /// - internal static string VSTHRD004_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD004_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid awaiting foreign Tasks. + /// + internal static string VSTHRD003_Title { + get { + return ResourceManager.GetString("VSTHRD003_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Await SwitchToMainThreadAsync. - /// - internal static string VSTHRD004_Title { - get { - return ResourceManager.GetString("VSTHRD004_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Calls to JoinableTaskFactory.SwitchToMainThreadAsync() must be awaited. + /// + internal static string VSTHRD004_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD004_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Await JoinableTaskFactory.SwitchToMainThreadAsync() first.. - /// - internal static string VSTHRD010_MessageFormat_Async { - get { - return ResourceManager.GetString("VSTHRD010_MessageFormat_Async", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Await SwitchToMainThreadAsync. + /// + internal static string VSTHRD004_Title { + get { + return ResourceManager.GetString("VSTHRD004_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Call {1}() first.. - /// - internal static string VSTHRD010_MessageFormat_Sync { - get { - return ResourceManager.GetString("VSTHRD010_MessageFormat_Sync", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Await JoinableTaskFactory.SwitchToMainThreadAsync() first.. + /// + internal static string VSTHRD010_MessageFormat_Async { + get { + return ResourceManager.GetString("VSTHRD010_MessageFormat_Async", resourceCulture); } - - /// - /// Looks up a localized string similar to Invoke single-threaded types on Main thread. - /// - internal static string VSTHRD010_Title { - get { - return ResourceManager.GetString("VSTHRD010_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Call {1}() first.. + /// + internal static string VSTHRD010_MessageFormat_Sync { + get { + return ResourceManager.GetString("VSTHRD010_MessageFormat_Sync", resourceCulture); } - - /// - /// Looks up a localized string similar to Lazy<Task<T>>.Value can deadlock. Use AsyncLazy<T> instead.. - /// - internal static string VSTHRD011_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD011_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Invoke single-threaded types on Main thread. + /// + internal static string VSTHRD010_Title { + get { + return ResourceManager.GetString("VSTHRD010_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Use AsyncLazy<T>. - /// - internal static string VSTHRD011_Title { - get { - return ResourceManager.GetString("VSTHRD011_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Lazy<Task<T>>.Value can deadlock. Use AsyncLazy<T> instead.. + /// + internal static string VSTHRD011_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD011_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Invoking or blocking on async code in a Lazy<T> value factory can deadlock. Use AsyncLazy<T> instead.. - /// - internal static string VSTHRD011b_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD011b_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use AsyncLazy<T>. + /// + internal static string VSTHRD011_Title { + get { + return ResourceManager.GetString("VSTHRD011_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Provide an instance of JoinableTaskFactory in this call (or another overload) to avoid deadlocks with the main thread. - /// - internal static string VSTHRD012_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD012_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Invoking or blocking on async code in a Lazy<T> value factory can deadlock. Use AsyncLazy<T> instead.. + /// + internal static string VSTHRD011b_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD011b_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Provide JoinableTaskFactory where allowed. - /// - internal static string VSTHRD012_Title { - get { - return ResourceManager.GetString("VSTHRD012_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Provide an instance of JoinableTaskFactory in this call (or another overload) to avoid deadlocks with the main thread. + /// + internal static string VSTHRD012_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD012_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Change return type to Task. - /// - internal static string VSTHRD100_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD100_CodeFix_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Provide JoinableTaskFactory where allowed. + /// + internal static string VSTHRD012_Title { + get { + return ResourceManager.GetString("VSTHRD012_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid "async void" methods, because any exceptions not handled by the method will crash the process. - /// - internal static string VSTHRD100_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD100_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Change return type to Task. + /// + internal static string VSTHRD100_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD100_CodeFix_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid async void methods. - /// - internal static string VSTHRD100_Title { - get { - return ResourceManager.GetString("VSTHRD100_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid "async void" methods, because any exceptions not handled by the method will crash the process. + /// + internal static string VSTHRD100_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD100_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process. - /// - internal static string VSTHRD101_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD101_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid async void methods. + /// + internal static string VSTHRD100_Title { + get { + return ResourceManager.GetString("VSTHRD100_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid unsupported async delegates. - /// - internal static string VSTHRD101_Title { - get { - return ResourceManager.GetString("VSTHRD101_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process. + /// + internal static string VSTHRD101_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD101_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Limit use of synchronously blocking method calls such as JoinableTaskFactory.Run or Task.Result to public entrypoint members where you must be synchronous. Using it for internal members can needlessly add synchronous frames between asynchronous frames, leading to threadpool exhaustion.. - /// - internal static string VSTHRD102_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD102_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid unsupported async delegates. + /// + internal static string VSTHRD101_Title { + get { + return ResourceManager.GetString("VSTHRD101_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Implement internal logic asynchronously. - /// - internal static string VSTHRD102_Title { - get { - return ResourceManager.GetString("VSTHRD102_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Limit use of synchronously blocking method calls such as JoinableTaskFactory.Run or Task.Result to public entrypoint members where you must be synchronous. Using it for internal members can needlessly add synchronous frames between asynchronous frames, leading to threadpool exhaustion.. + /// + internal static string VSTHRD102_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD102_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to {0} synchronously blocks. Await {1} instead.. - /// - internal static string VSTHRD103_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD103_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Implement internal logic asynchronously. + /// + internal static string VSTHRD102_Title { + get { + return ResourceManager.GetString("VSTHRD102_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to {0} synchronously blocks. Use await instead.. - /// - internal static string VSTHRD103_MessageFormat_UseAwaitInstead { - get { - return ResourceManager.GetString("VSTHRD103_MessageFormat_UseAwaitInstead", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to {0} synchronously blocks. Await {1} instead.. + /// + internal static string VSTHRD103_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD103_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Call async methods when in an async method. - /// - internal static string VSTHRD103_Title { - get { - return ResourceManager.GetString("VSTHRD103_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to {0} synchronously blocks. Use await instead.. + /// + internal static string VSTHRD103_MessageFormat_UseAwaitInstead { + get { + return ResourceManager.GetString("VSTHRD103_MessageFormat_UseAwaitInstead", resourceCulture); } - - /// - /// Looks up a localized string similar to Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.. - /// - internal static string VSTHRD104_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD104_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Call async methods when in an async method. + /// + internal static string VSTHRD103_Title { + get { + return ResourceManager.GetString("VSTHRD103_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Offer async methods. - /// - internal static string VSTHRD104_Title { - get { - return ResourceManager.GetString("VSTHRD104_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.. + /// + internal static string VSTHRD104_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD104_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. Use an overload that accepts a TaskScheduler and specify TaskScheduler.Default (or any other) explicitly.. - /// - internal static string VSTHRD105_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD105_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Offer async methods. + /// + internal static string VSTHRD104_Title { + get { + return ResourceManager.GetString("VSTHRD104_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. - /// - internal static string VSTHRD105_Title { - get { - return ResourceManager.GetString("VSTHRD105_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. Use an overload that accepts a TaskScheduler and specify TaskScheduler.Default (or any other) explicitly.. + /// + internal static string VSTHRD105_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD105_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to AsyncEventHandler delegates should be invoked via the extension method "TplExtensions.InvokeAsync()" defined in Microsoft.VisualStudio.Threading assembly. - /// - internal static string VSTHRD106_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD106_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. + /// + internal static string VSTHRD105_Title { + get { + return ResourceManager.GetString("VSTHRD105_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Use InvokeAsync to raise async events. - /// - internal static string VSTHRD106_Title { - get { - return ResourceManager.GetString("VSTHRD106_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to AsyncEventHandler delegates should be invoked via the extension method "TplExtensions.InvokeAsync()" defined in Microsoft.VisualStudio.Threading assembly. + /// + internal static string VSTHRD106_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD106_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Await using expression. - /// - internal static string VSTHRD107_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD107_CodeFix_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use InvokeAsync to raise async events. + /// + internal static string VSTHRD106_Title { + get { + return ResourceManager.GetString("VSTHRD106_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Missing await operator for "using" expression. - /// - internal static string VSTHRD107_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD107_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Await using expression. + /// + internal static string VSTHRD107_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD107_CodeFix_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Await Task within using expression. - /// - internal static string VSTHRD107_Title { - get { - return ResourceManager.GetString("VSTHRD107_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Missing await operator for "using" expression. + /// + internal static string VSTHRD107_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD107_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Thread affinity checks should be unconditional. - /// - internal static string VSTHRD108_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD108_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Await Task within using expression. + /// + internal static string VSTHRD107_Title { + get { + return ResourceManager.GetString("VSTHRD107_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Assert thread affinity unconditionally. - /// - internal static string VSTHRD108_Title { - get { - return ResourceManager.GetString("VSTHRD108_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Thread affinity checks should be unconditional. + /// + internal static string VSTHRD108_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD108_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid throwing when not on the main thread while in an async or Task-returning method. Switch to the thread required instead.. - /// - internal static string VSTHRD109_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD109_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Assert thread affinity unconditionally. + /// + internal static string VSTHRD108_Title { + get { + return ResourceManager.GetString("VSTHRD108_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Switch instead of assert in async methods. - /// - internal static string VSTHRD109_Title { - get { - return ResourceManager.GetString("VSTHRD109_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid throwing when not on the main thread while in an async or Task-returning method. Switch to the thread required instead.. + /// + internal static string VSTHRD109_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD109_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method.. - /// - internal static string VSTHRD110_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD110_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Switch instead of assert in async methods. + /// + internal static string VSTHRD109_Title { + get { + return ResourceManager.GetString("VSTHRD109_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Observe result of async calls. - /// - internal static string VSTHRD110_Title { - get { - return ResourceManager.GetString("VSTHRD110_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method.. + /// + internal static string VSTHRD110_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD110_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(false). - /// - internal static string VSTHRD111_CodeFix_False_Title { - get { - return ResourceManager.GetString("VSTHRD111_CodeFix_False_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Observe result of async calls. + /// + internal static string VSTHRD110_Title { + get { + return ResourceManager.GetString("VSTHRD110_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(true). - /// - internal static string VSTHRD111_CodeFix_True_Title { - get { - return ResourceManager.GetString("VSTHRD111_CodeFix_True_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Add .ConfigureAwait(false). + /// + internal static string VSTHRD111_CodeFix_False_Title { + get { + return ResourceManager.GetString("VSTHRD111_CodeFix_False_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(bool) to your await expression. - /// - internal static string VSTHRD111_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD111_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Add .ConfigureAwait(true). + /// + internal static string VSTHRD111_CodeFix_True_Title { + get { + return ResourceManager.GetString("VSTHRD111_CodeFix_True_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Use ConfigureAwait(bool). - /// - internal static string VSTHRD111_Title { - get { - return ResourceManager.GetString("VSTHRD111_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Add .ConfigureAwait(bool) to your await expression. + /// + internal static string VSTHRD111_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD111_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Add implementation of System.IAsyncDisposable.. - /// - internal static string VSTHRD112_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD112_CodeFix_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use ConfigureAwait(bool). + /// + internal static string VSTHRD111_Title { + get { + return ResourceManager.GetString("VSTHRD111_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Implement the System.IAsyncDisposable interface when implementing the obsolete Microsoft.VisualStudio.Threading.IAsyncDisposable interface. - /// - internal static string VSTHRD112_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD112_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Add implementation of System.IAsyncDisposable.. + /// + internal static string VSTHRD112_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD112_CodeFix_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Implement System.IAsyncDisposable. - /// - internal static string VSTHRD112_Title { - get { - return ResourceManager.GetString("VSTHRD112_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Implement the System.IAsyncDisposable interface when implementing the obsolete Microsoft.VisualStudio.Threading.IAsyncDisposable interface. + /// + internal static string VSTHRD112_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD112_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Add a check for System.IAsyncDisposable in the same code block that checks for Microsoft.VisualStudio.Threading.IAsyncDisposable that behaves similarly. - /// - internal static string VSTHRD113_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD113_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Implement System.IAsyncDisposable. + /// + internal static string VSTHRD112_Title { + get { + return ResourceManager.GetString("VSTHRD112_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Check for System.IAsyncDisposable. - /// - internal static string VSTHRD113_Title { - get { - return ResourceManager.GetString("VSTHRD113_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Add a check for System.IAsyncDisposable in the same code block that checks for Microsoft.VisualStudio.Threading.IAsyncDisposable that behaves similarly. + /// + internal static string VSTHRD113_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD113_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Use 'Task.CompletedTask' instead. - /// - internal static string VSTHRD114_CodeFix_CompletedTask { - get { - return ResourceManager.GetString("VSTHRD114_CodeFix_CompletedTask", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Check for System.IAsyncDisposable. + /// + internal static string VSTHRD113_Title { + get { + return ResourceManager.GetString("VSTHRD113_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Use 'Task.FromResult' instead. - /// - internal static string VSTHRD114_CodeFix_FromResult { - get { - return ResourceManager.GetString("VSTHRD114_CodeFix_FromResult", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use 'Task.CompletedTask' instead. + /// + internal static string VSTHRD114_CodeFix_CompletedTask { + get { + return ResourceManager.GetString("VSTHRD114_CodeFix_CompletedTask", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid returning null from a Task-returning method. - /// - internal static string VSTHRD114_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD114_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use 'Task.FromResult' instead. + /// + internal static string VSTHRD114_CodeFix_FromResult { + get { + return ResourceManager.GetString("VSTHRD114_CodeFix_FromResult", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid returning a null Task. - /// - internal static string VSTHRD114_Title { - get { - return ResourceManager.GetString("VSTHRD114_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid returning null from a Task-returning method. + /// + internal static string VSTHRD114_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD114_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Use "Async" suffix in names of methods that return an awaitable type. - /// - internal static string VSTHRD200_AddAsync_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD200_AddAsync_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid returning a null Task. + /// + internal static string VSTHRD114_Title { + get { + return ResourceManager.GetString("VSTHRD114_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Rename to {0}. - /// - internal static string VSTHRD200_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD200_CodeFix_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use "Async" suffix in names of methods that return an awaitable type. + /// + internal static string VSTHRD200_AddAsync_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD200_AddAsync_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Avoid "Async" suffix in names of methods that do not return an awaitable type. - /// - internal static string VSTHRD200_RemoveAsync_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD200_RemoveAsync_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Rename to {0}. + /// + internal static string VSTHRD200_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD200_CodeFix_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Use "Async" suffix for async methods. - /// - internal static string VSTHRD200_Title { - get { - return ResourceManager.GetString("VSTHRD200_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Avoid "Async" suffix in names of methods that do not return an awaitable type. + /// + internal static string VSTHRD200_RemoveAsync_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD200_RemoveAsync_MessageFormat", resourceCulture); } - - /// - /// Looks up a localized string similar to Call ThrowIfCancellationRequested(). - /// - internal static string VSTHRD201_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD201_CodeFix_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Use "Async" suffix for async methods. + /// + internal static string VSTHRD200_Title { + get { + return ResourceManager.GetString("VSTHRD200_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Check for cancellation after calling SwitchToMainThreadAsync(CancellationToken).. - /// - internal static string VSTHRD201_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD201_MessageFormat", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Call ThrowIfCancellationRequested(). + /// + internal static string VSTHRD201_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD201_CodeFix_Title", resourceCulture); } - - /// - /// Looks up a localized string similar to Check cancellation after SwitchToMainThreadAsync. - /// - internal static string VSTHRD201_Title { - get { - return ResourceManager.GetString("VSTHRD201_Title", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Check for cancellation after calling SwitchToMainThreadAsync(CancellationToken).. + /// + internal static string VSTHRD201_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD201_MessageFormat", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to Check cancellation after SwitchToMainThreadAsync. + /// + internal static string VSTHRD201_Title { + get { + return ResourceManager.GetString("VSTHRD201_Title", resourceCulture); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs index d1ac3e588..54ec2acdc 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs @@ -3,244 +3,243 @@ using System.Collections.Generic; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Identifiers used to identify various types so that we can avoid adding dependency only if absolutely needed. +/// For each predefine value here, please update the unit test to detect if values go out of sync with the real types they represent. +/// +internal static class Types { - /// - /// Identifiers used to identify various types so that we can avoid adding dependency only if absolutely needed. - /// For each predefine value here, please update the unit test to detect if values go out of sync with the real types they represent. - /// - internal static class Types + internal static class BclAsyncDisposable { - internal static class BclAsyncDisposable - { - internal const string FullName = "System.IAsyncDisposable"; + internal const string FullName = "System.IAsyncDisposable"; - internal const string PackageId = "Microsoft.Bcl.AsyncInterfaces"; - } + internal const string PackageId = "Microsoft.Bcl.AsyncInterfaces"; + } - internal static class IAsyncDisposable - { - internal const string FullName = "Microsoft.VisualStudio.Threading.IAsyncDisposable"; - } + internal static class IAsyncDisposable + { + internal const string FullName = "Microsoft.VisualStudio.Threading.IAsyncDisposable"; + } - internal static class AwaitExtensions - { - /// - /// The full name of the AwaitExtensions type. - /// - internal const string TypeName = "AwaitExtensions"; + internal static class AwaitExtensions + { + /// + /// The full name of the AwaitExtensions type. + /// + internal const string TypeName = "AwaitExtensions"; - /// - /// The name of the ConfigureAwaitRunInline method. - /// - internal const string ConfigureAwaitRunInline = "ConfigureAwaitRunInline"; + /// + /// The name of the ConfigureAwaitRunInline method. + /// + internal const string ConfigureAwaitRunInline = "ConfigureAwaitRunInline"; - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; - } + internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + } + /// + /// Contains the names of types and members within TplExtensions. + /// + internal static class TplExtensions + { /// - /// Contains the names of types and members within TplExtensions. + /// The full name of the TplExtensions type. /// - internal static class TplExtensions - { - /// - /// The full name of the TplExtensions type. - /// - internal const string TypeName = "TplExtensions"; - - /// - /// The name of the InvokeAsync method. - /// - internal const string InvokeAsync = "InvokeAsync"; - - /// - /// The name of the CompletedTask field. - /// - internal const string CompletedTask = "CompletedTask"; - - /// - /// The name of the CanceledTask field. - /// - internal const string CanceledTask = "CanceledTask"; - - /// - /// The name of the TrueTask field. - /// - internal const string TrueTask = "TrueTask"; - - /// - /// The name of the FalseTask field. - /// - internal const string FalseTask = "FalseTask"; - - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; - } + internal const string TypeName = "TplExtensions"; /// - /// Contains descriptors for the AsyncEventHandler type. + /// The name of the InvokeAsync method. /// - internal static class AsyncEventHandler - { - /// - /// The full name of the AsyncEventHandler type. - /// - internal const string TypeName = "AsyncEventHandler"; + internal const string InvokeAsync = "InvokeAsync"; - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; - } + /// + /// The name of the CompletedTask field. + /// + internal const string CompletedTask = "CompletedTask"; - internal static class AsyncMethodBuilderAttribute - { - internal const string TypeName = nameof(System.Runtime.CompilerServices.AsyncMethodBuilderAttribute); + /// + /// The name of the CanceledTask field. + /// + internal const string CanceledTask = "CanceledTask"; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; - } + /// + /// The name of the TrueTask field. + /// + internal const string TrueTask = "TrueTask"; /// - /// Contains descriptors for the JoinableTaskFactory type. + /// The name of the FalseTask field. /// - internal static class JoinableTaskFactory - { - internal const string TypeName = "JoinableTaskFactory"; + internal const string FalseTask = "FalseTask"; - internal const string FullName = "Microsoft.VisualStudio.Threading." + TypeName; + internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + } + + /// + /// Contains descriptors for the AsyncEventHandler type. + /// + internal static class AsyncEventHandler + { + /// + /// The full name of the AsyncEventHandler type. + /// + internal const string TypeName = "AsyncEventHandler"; - /// - /// The name of the SwitchToMainThreadAsync method. - /// - internal const string SwitchToMainThreadAsync = "SwitchToMainThreadAsync"; + internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + } - internal const string Run = "Run"; + internal static class AsyncMethodBuilderAttribute + { + internal const string TypeName = nameof(System.Runtime.CompilerServices.AsyncMethodBuilderAttribute); - internal const string RunAsync = "RunAsync"; + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + } - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; - } + /// + /// Contains descriptors for the JoinableTaskFactory type. + /// + internal static class JoinableTaskFactory + { + internal const string TypeName = "JoinableTaskFactory"; - /// - /// Contains descriptors for the JoinableTaskCollection type. - /// - internal static class JoinableTaskCollection - { - internal const string TypeName = "JoinableTaskCollection"; - } + internal const string FullName = "Microsoft.VisualStudio.Threading." + TypeName; /// - /// Contains descriptors for the JoinableTaskContext type. + /// The name of the SwitchToMainThreadAsync method. /// - internal static class JoinableTaskContext - { - internal const string TypeName = "JoinableTaskContext"; - } + internal const string SwitchToMainThreadAsync = "SwitchToMainThreadAsync"; - internal static class JoinableTask - { - internal const string TypeName = "JoinableTask"; + internal const string Run = "Run"; - internal const string Join = "Join"; + internal const string RunAsync = "RunAsync"; - internal const string JoinAsync = "JoinAsync"; - } + internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + } - internal static class SynchronizationContext - { - internal const string TypeName = nameof(System.Threading.SynchronizationContext); + /// + /// Contains descriptors for the JoinableTaskCollection type. + /// + internal static class JoinableTaskCollection + { + internal const string TypeName = "JoinableTaskCollection"; + } + + /// + /// Contains descriptors for the JoinableTaskContext type. + /// + internal static class JoinableTaskContext + { + internal const string TypeName = "JoinableTaskContext"; + } - internal const string Post = nameof(System.Threading.SynchronizationContext.Post); + internal static class JoinableTask + { + internal const string TypeName = "JoinableTask"; + + internal const string Join = "Join"; - internal const string Send = nameof(System.Threading.SynchronizationContext.Send); - } + internal const string JoinAsync = "JoinAsync"; + } + + internal static class SynchronizationContext + { + internal const string TypeName = nameof(System.Threading.SynchronizationContext); - internal static class ThreadHelper - { - internal const string TypeName = "ThreadHelper"; + internal const string Post = nameof(System.Threading.SynchronizationContext.Post); + + internal const string Send = nameof(System.Threading.SynchronizationContext.Send); + } + + internal static class ThreadHelper + { + internal const string TypeName = "ThreadHelper"; - internal const string Invoke = "Invoke"; + internal const string Invoke = "Invoke"; - internal const string InvokeAsync = "InvokeAsync"; + internal const string InvokeAsync = "InvokeAsync"; - internal const string BeginInvoke = "BeginInvoke"; + internal const string BeginInvoke = "BeginInvoke"; - internal const string CheckAccess = "CheckAccess"; - } + internal const string CheckAccess = "CheckAccess"; + } - internal static class Dispatcher - { - internal const string TypeName = "Dispatcher"; + internal static class Dispatcher + { + internal const string TypeName = "Dispatcher"; - internal const string Invoke = "Invoke"; + internal const string Invoke = "Invoke"; - internal const string BeginInvoke = "BeginInvoke"; + internal const string BeginInvoke = "BeginInvoke"; - internal const string InvokeAsync = "InvokeAsync"; - } + internal const string InvokeAsync = "InvokeAsync"; + } - internal static class Task - { - internal const string TypeName = nameof(System.Threading.Tasks.Task); + internal static class Task + { + internal const string TypeName = nameof(System.Threading.Tasks.Task); - internal const string FullName = "System.Threading.Tasks." + TypeName; + internal const string FullName = "System.Threading.Tasks." + TypeName; - internal const string CompletedTask = nameof(System.Threading.Tasks.Task.CompletedTask); + internal const string CompletedTask = nameof(System.Threading.Tasks.Task.CompletedTask); - internal const string WhenAll = "WhenAll"; + internal const string WhenAll = "WhenAll"; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; + } - internal static class ConfiguredTaskAwaitable - { - internal const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredTaskAwaitable); + internal static class ConfiguredTaskAwaitable + { + internal const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredTaskAwaitable); - internal const string FullName = "System.Runtime.CompilerServices." + TypeName; + internal const string FullName = "System.Runtime.CompilerServices." + TypeName; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + } - internal static class ValueTask - { - internal const string TypeName = nameof(ValueTask); + internal static class ValueTask + { + internal const string TypeName = nameof(ValueTask); - internal const string FullName = "System.Threading.Tasks." + TypeName; + internal const string FullName = "System.Threading.Tasks." + TypeName; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; + } - internal static class ConfiguredValueTaskAwaitable - { - internal const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable); + internal static class ConfiguredValueTaskAwaitable + { + internal const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable); - internal const string FullName = "System.Runtime.CompilerServices." + TypeName; + internal const string FullName = "System.Runtime.CompilerServices." + TypeName; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + } - internal static class CoClassAttribute - { - internal const string TypeName = nameof(System.Runtime.InteropServices.CoClassAttribute); + internal static class CoClassAttribute + { + internal const string TypeName = nameof(System.Runtime.InteropServices.CoClassAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + } - internal static class ComImportAttribute - { - internal const string TypeName = nameof(System.Runtime.InteropServices.ComImportAttribute); + internal static class ComImportAttribute + { + internal const string TypeName = nameof(System.Runtime.InteropServices.ComImportAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + } - internal static class InterfaceTypeAttribute - { - internal const string TypeName = nameof(System.Runtime.InteropServices.InterfaceTypeAttribute); + internal static class InterfaceTypeAttribute + { + internal const string TypeName = nameof(System.Runtime.InteropServices.InterfaceTypeAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + } - internal static class TypeLibTypeAttribute - { - internal const string TypeName = "TypeLibTypeAttribute"; + internal static class TypeLibTypeAttribute + { + internal const string TypeName = "TypeLibTypeAttribute"; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; - } + internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index 876a47697..739dabd5f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -13,717 +13,716 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +internal static class Utils { - internal static class Utils + internal static Action DebuggableWrapper(Action handler) { - internal static Action DebuggableWrapper(Action handler) + return ctxt => { - return ctxt => + try { - try - { - handler(ctxt); - } - catch (OperationCanceledException) - { - throw; - } - catch (Exception ex) when (LaunchDebuggerExceptionFilter()) - { - throw new Exception($"Analyzer failure while processing syntax at {ctxt.Node.SyntaxTree.FilePath}({ctxt.Node.GetLocation()?.GetLineSpan().StartLinePosition.Line + 1},{ctxt.Node.GetLocation()?.GetLineSpan().StartLinePosition.Character + 1}): {ex.GetType()} {ex.Message}. Syntax: {ctxt.Node}", ex); - } - }; - } + handler(ctxt); + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) when (LaunchDebuggerExceptionFilter()) + { + throw new Exception($"Analyzer failure while processing syntax at {ctxt.Node.SyntaxTree.FilePath}({ctxt.Node.GetLocation()?.GetLineSpan().StartLinePosition.Line + 1},{ctxt.Node.GetLocation()?.GetLineSpan().StartLinePosition.Character + 1}): {ex.GetType()} {ex.Message}. Syntax: {ctxt.Node}", ex); + } + }; + } - internal static Action DebuggableWrapper(Action handler) + internal static Action DebuggableWrapper(Action handler) + { + return ctxt => { - return ctxt => + try { - try - { - handler(ctxt); - } - catch (OperationCanceledException) - { - throw; - } - catch (Exception ex) when (LaunchDebuggerExceptionFilter()) - { - throw new Exception($"Analyzer failure while processing symbol {ctxt.Symbol} at {ctxt.Symbol.Locations.FirstOrDefault()?.SourceTree?.FilePath}({ctxt.Symbol.Locations.FirstOrDefault()?.GetLineSpan().StartLinePosition.Line},{ctxt.Symbol.Locations.FirstOrDefault()?.GetLineSpan().StartLinePosition.Character}): {ex.GetType()} {ex.Message}", ex); - } - }; - } + handler(ctxt); + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) when (LaunchDebuggerExceptionFilter()) + { + throw new Exception($"Analyzer failure while processing symbol {ctxt.Symbol} at {ctxt.Symbol.Locations.FirstOrDefault()?.SourceTree?.FilePath}({ctxt.Symbol.Locations.FirstOrDefault()?.GetLineSpan().StartLinePosition.Line},{ctxt.Symbol.Locations.FirstOrDefault()?.GetLineSpan().StartLinePosition.Character}): {ex.GetType()} {ex.Message}", ex); + } + }; + } - internal static Action DebuggableWrapper(Action handler) + internal static Action DebuggableWrapper(Action handler) + { + return ctxt => { - return ctxt => + try { - try - { - handler(ctxt); - } - catch (OperationCanceledException) - { - throw; - } - catch (Exception ex) when (LaunchDebuggerExceptionFilter()) - { - throw new Exception($"Analyzer failure while processing syntax at {ctxt.CodeBlock.SyntaxTree.FilePath}({ctxt.CodeBlock.GetLocation()?.GetLineSpan().StartLinePosition.Line + 1},{ctxt.CodeBlock.GetLocation()?.GetLineSpan().StartLinePosition.Character + 1}): {ex.GetType()} {ex.Message}. Syntax: {ctxt.CodeBlock}", ex); - } - }; - } + handler(ctxt); + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) when (LaunchDebuggerExceptionFilter()) + { + throw new Exception($"Analyzer failure while processing syntax at {ctxt.CodeBlock.SyntaxTree.FilePath}({ctxt.CodeBlock.GetLocation()?.GetLineSpan().StartLinePosition.Line + 1},{ctxt.CodeBlock.GetLocation()?.GetLineSpan().StartLinePosition.Character + 1}): {ex.GetType()} {ex.Message}. Syntax: {ctxt.CodeBlock}", ex); + } + }; + } - internal static Action DebuggableWrapper(Action handler) + internal static Action DebuggableWrapper(Action handler) + { + return ctxt => { - return ctxt => + try { - try - { - handler(ctxt); - } - catch (OperationCanceledException) - { - throw; - } - catch (Exception ex) when (LaunchDebuggerExceptionFilter()) - { - throw new Exception($"Analyzer failure while processing syntax at {ctxt.Operation.Syntax.SyntaxTree.FilePath}({ctxt.Operation.Syntax.GetLocation()?.GetLineSpan().StartLinePosition.Line + 1},{ctxt.Operation.Syntax.GetLocation()?.GetLineSpan().StartLinePosition.Character + 1}): {ex.GetType()} {ex.Message}. Syntax: {ctxt.Operation.Syntax}", ex); - } - }; - } + handler(ctxt); + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) when (LaunchDebuggerExceptionFilter()) + { + throw new Exception($"Analyzer failure while processing syntax at {ctxt.Operation.Syntax.SyntaxTree.FilePath}({ctxt.Operation.Syntax.GetLocation()?.GetLineSpan().StartLinePosition.Line + 1},{ctxt.Operation.Syntax.GetLocation()?.GetLineSpan().StartLinePosition.Character + 1}): {ex.GetType()} {ex.Message}. Syntax: {ctxt.Operation.Syntax}", ex); + } + }; + } - internal static Action DebuggableWrapper(Action handler) + internal static Action DebuggableWrapper(Action handler) + { + return ctxt => { - return ctxt => + try { - try - { - handler(ctxt); - } - catch (OperationCanceledException) - { - throw; - } - catch (Exception ex) when (LaunchDebuggerExceptionFilter()) + handler(ctxt); + } + catch (OperationCanceledException) + { + throw; + } + catch (Exception ex) when (LaunchDebuggerExceptionFilter()) + { + var messageBuilder = new StringBuilder(); + messageBuilder.Append("Analyzer failure while processing syntax(es) at "); + + for (int i = 0; i < ctxt.OperationBlocks.Length; i++) { - var messageBuilder = new StringBuilder(); - messageBuilder.Append("Analyzer failure while processing syntax(es) at "); + IOperation? operation = ctxt.OperationBlocks[i]; + FileLinePositionSpan? lineSpan = operation.Syntax.GetLocation()?.GetLineSpan(); - for (int i = 0; i < ctxt.OperationBlocks.Length; i++) + if (i > 0) { - IOperation? operation = ctxt.OperationBlocks[i]; - FileLinePositionSpan? lineSpan = operation.Syntax.GetLocation()?.GetLineSpan(); - - if (i > 0) - { - messageBuilder.Append(", "); - } - - messageBuilder.Append($"{operation.Syntax.SyntaxTree.FilePath}({lineSpan?.StartLinePosition.Line + 1},{lineSpan?.StartLinePosition.Character + 1}). Syntax: {operation.Syntax}."); + messageBuilder.Append(", "); } - messageBuilder.Append($". {ex.GetType()} {ex.Message}"); - - throw new Exception(messageBuilder.ToString(), ex); + messageBuilder.Append($"{operation.Syntax.SyntaxTree.FilePath}({lineSpan?.StartLinePosition.Line + 1},{lineSpan?.StartLinePosition.Character + 1}). Syntax: {operation.Syntax}."); } - }; - } - - /// - /// Gets a semantic model for the given . - /// - internal static bool TryGetNewOrExistingSemanticModel(this SyntaxNodeAnalysisContext context, SyntaxTree syntaxTree, [NotNullWhen(true)] out SemanticModel? semanticModel) - { - // Avoid calling GetSemanticModel unless we need it since it's much more expensive to create a new one than to reuse one. - semanticModel = - context.Node.SyntaxTree == syntaxTree ? context.SemanticModel : - context.Compilation.ContainsSyntaxTree(syntaxTree) ? context.Compilation.GetSemanticModel(syntaxTree) : - null; - return semanticModel is object; - } - - internal static bool IsEqualToOrDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) - { - return EqualityComparer.Default.Equals(type?.OriginalDefinition, expectedType) || IsDerivedFrom(type, expectedType); - } - internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) - { - type = type?.BaseType; - while (type is object) - { - if (EqualityComparer.Default.Equals(type.OriginalDefinition, expectedType)) - { - return true; - } + messageBuilder.Append($". {ex.GetType()} {ex.Message}"); - type = type.BaseType; + throw new Exception(messageBuilder.ToString(), ex); } + }; + } - return false; - } + /// + /// Gets a semantic model for the given . + /// + internal static bool TryGetNewOrExistingSemanticModel(this SyntaxNodeAnalysisContext context, SyntaxTree syntaxTree, [NotNullWhen(true)] out SemanticModel? semanticModel) + { + // Avoid calling GetSemanticModel unless we need it since it's much more expensive to create a new one than to reuse one. + semanticModel = + context.Node.SyntaxTree == syntaxTree ? context.SemanticModel : + context.Compilation.ContainsSyntaxTree(syntaxTree) ? context.Compilation.GetSemanticModel(syntaxTree) : + null; + return semanticModel is object; + } - /// - /// Resolve the type from the given symbol if possible. - /// For instance, if the symbol represents a property in a class, this method will return the type of that property. - /// - /// The input symbol. - /// The type represented by the input symbol; or if could not figure out the type. - internal static ITypeSymbol? ResolveTypeFromSymbol(ISymbol symbol) + internal static bool IsEqualToOrDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) + { + return EqualityComparer.Default.Equals(type?.OriginalDefinition, expectedType) || IsDerivedFrom(type, expectedType); + } + + internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) + { + type = type?.BaseType; + while (type is object) { - ITypeSymbol? type = null; - switch (symbol?.Kind) + if (EqualityComparer.Default.Equals(type.OriginalDefinition, expectedType)) { - case SymbolKind.Local: - type = ((ILocalSymbol)symbol).Type; - break; - - case SymbolKind.Field: - type = ((IFieldSymbol)symbol).Type; - break; - - case SymbolKind.Parameter: - type = ((IParameterSymbol)symbol).Type; - break; - - case SymbolKind.Property: - type = ((IPropertySymbol)symbol).Type; - break; - - case SymbolKind.Method: - var method = (IMethodSymbol)symbol; - type = method.MethodKind == MethodKind.Constructor ? method.ContainingType : method.ReturnType; - break; - - case SymbolKind.Event: - type = ((IEventSymbol)symbol).Type; - break; + return true; } - return type; + type = type.BaseType; } - /// - /// Tests whether a symbol belongs to a given namespace. - /// - /// The symbol whose namespace membership is being tested. - /// A sequence of namespaces from global to most precise. For example: [System, Threading, Tasks]. - /// if the symbol belongs to the given namespace; otherwise . - internal static bool BelongsToNamespace(this ISymbol symbol, IReadOnlyList namespaces) + return false; + } + + /// + /// Resolve the type from the given symbol if possible. + /// For instance, if the symbol represents a property in a class, this method will return the type of that property. + /// + /// The input symbol. + /// The type represented by the input symbol; or if could not figure out the type. + internal static ITypeSymbol? ResolveTypeFromSymbol(ISymbol symbol) + { + ITypeSymbol? type = null; + switch (symbol?.Kind) { - if (namespaces is null) - { - throw new ArgumentNullException(nameof(namespaces)); - } + case SymbolKind.Local: + type = ((ILocalSymbol)symbol).Type; + break; - if (symbol is null) - { - return false; - } + case SymbolKind.Field: + type = ((IFieldSymbol)symbol).Type; + break; - INamespaceSymbol currentNamespace = symbol.ContainingNamespace; - for (int i = namespaces.Count - 1; i >= 0; i--) - { - if (currentNamespace?.Name != namespaces[i]) - { - return false; - } + case SymbolKind.Parameter: + type = ((IParameterSymbol)symbol).Type; + break; - currentNamespace = currentNamespace.ContainingNamespace; - } + case SymbolKind.Property: + type = ((IPropertySymbol)symbol).Type; + break; - return currentNamespace?.IsGlobalNamespace ?? false; + case SymbolKind.Method: + var method = (IMethodSymbol)symbol; + type = method.MethodKind == MethodKind.Constructor ? method.ContainingType : method.ReturnType; + break; + + case SymbolKind.Event: + type = ((IEventSymbol)symbol).Type; + break; } - internal static IBlockOperation? GetContainingFunctionBlock(IOperation operation) - { - IOperation? previousAncestor = operation; - IOperation? ancestor = previousAncestor; - do - { - if (previousAncestor != ancestor) - { - previousAncestor = ancestor; - } + return type; + } - ancestor = ancestor.Parent; - } - while (ancestor is object && ancestor.Kind != OperationKind.MethodBodyOperation && ancestor.Kind != OperationKind.AnonymousFunction && - ancestor.Kind != OperationKind.LocalFunction); + /// + /// Tests whether a symbol belongs to a given namespace. + /// + /// The symbol whose namespace membership is being tested. + /// A sequence of namespaces from global to most precise. For example: [System, Threading, Tasks]. + /// if the symbol belongs to the given namespace; otherwise . + internal static bool BelongsToNamespace(this ISymbol symbol, IReadOnlyList namespaces) + { + if (namespaces is null) + { + throw new ArgumentNullException(nameof(namespaces)); + } - return previousAncestor as IBlockOperation; + if (symbol is null) + { + return false; } - internal static ISymbol GetContainingFunction(IOperation operation, ISymbol operationBlockContainingSymbol) + INamespaceSymbol currentNamespace = symbol.ContainingNamespace; + for (int i = namespaces.Count - 1; i >= 0; i--) { - for (IOperation? current = operation; current is object; current = current.Parent) + if (currentNamespace?.Name != namespaces[i]) { - if (current.Kind == OperationKind.AnonymousFunction) - { - return ((IAnonymousFunctionOperation)current).Symbol; - } - else if (current.Kind == OperationKind.LocalFunction) - { - return ((ILocalFunctionOperation)current).Symbol; - } + return false; } - return operationBlockContainingSymbol; + currentNamespace = currentNamespace.ContainingNamespace; } - internal static bool HasAsyncCompatibleReturnType([NotNullWhen(true)] this IMethodSymbol? methodSymbol) => IsAsyncCompatibleReturnType(methodSymbol?.ReturnType); + return currentNamespace?.IsGlobalNamespace ?? false; + } - /// - /// Determines whether a type could be used with the async modifier as a method return type. - /// - /// The type returned from a method. - /// if the type can be returned from an async method. - /// - /// This is not the same thing as being an *awaitable* type, which is a much lower bar. Any type can be made awaitable by offering a GetAwaiter method - /// that follows the proper pattern. But being an async-compatible type in this sense is a type that can be returned from a method carrying the async keyword modifier, - /// in that the type is either the special Task type, or offers an async method builder of its own. - /// - internal static bool IsAsyncCompatibleReturnType([NotNullWhen(true)] this ITypeSymbol? typeSymbol) + internal static IBlockOperation? GetContainingFunctionBlock(IOperation operation) + { + IOperation? previousAncestor = operation; + IOperation? ancestor = previousAncestor; + do { - if (typeSymbol is null) + if (previousAncestor != ancestor) { - return false; + previousAncestor = ancestor; } - // ValueTask and ValueTask have the AsyncMethodBuilderAttribute. - return (typeSymbol.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks)) - || IsIAsyncEnumerable(typeSymbol) || typeSymbol.AllInterfaces.Any(IsIAsyncEnumerable) - || typeSymbol.GetAttributes().Any(ad => ad.AttributeClass?.Name == Types.AsyncMethodBuilderAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.AsyncMethodBuilderAttribute.Namespace)); + ancestor = ancestor.Parent; + } + while (ancestor is object && ancestor.Kind != OperationKind.MethodBodyOperation && ancestor.Kind != OperationKind.AnonymousFunction && + ancestor.Kind != OperationKind.LocalFunction); - static bool IsIAsyncEnumerable(ITypeSymbol symbol) - => symbol.Name == "IAsyncEnumerable" // TODO: Use nameof(IAsyncEnumerable) after upgrade to netstandard2.1 - && symbol.BelongsToNamespace(Namespaces.SystemCollectionsGeneric); + return previousAncestor as IBlockOperation; + } + + internal static ISymbol GetContainingFunction(IOperation operation, ISymbol operationBlockContainingSymbol) + { + for (IOperation? current = operation; current is object; current = current.Parent) + { + if (current.Kind == OperationKind.AnonymousFunction) + { + return ((IAnonymousFunctionOperation)current).Symbol; + } + else if (current.Kind == OperationKind.LocalFunction) + { + return ((ILocalFunctionOperation)current).Symbol; + } } - internal static bool IsLazyOfT([NotNullWhen(true)] INamedTypeSymbol? constructedType) + return operationBlockContainingSymbol; + } + + internal static bool HasAsyncCompatibleReturnType([NotNullWhen(true)] this IMethodSymbol? methodSymbol) => IsAsyncCompatibleReturnType(methodSymbol?.ReturnType); + + /// + /// Determines whether a type could be used with the async modifier as a method return type. + /// + /// The type returned from a method. + /// if the type can be returned from an async method. + /// + /// This is not the same thing as being an *awaitable* type, which is a much lower bar. Any type can be made awaitable by offering a GetAwaiter method + /// that follows the proper pattern. But being an async-compatible type in this sense is a type that can be returned from a method carrying the async keyword modifier, + /// in that the type is either the special Task type, or offers an async method builder of its own. + /// + internal static bool IsAsyncCompatibleReturnType([NotNullWhen(true)] this ITypeSymbol? typeSymbol) + { + if (typeSymbol is null) { - return constructedType is object - && constructedType.ContainingNamespace?.Name == nameof(System) - && (constructedType.ContainingNamespace.ContainingNamespace?.IsGlobalNamespace ?? false) - && constructedType.Name == nameof(Lazy) - && constructedType.Arity > 0; // could be Lazy or Lazy + return false; } - internal static bool IsTask([NotNullWhen(true)] ITypeSymbol? typeSymbol) => typeSymbol?.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks); + // ValueTask and ValueTask have the AsyncMethodBuilderAttribute. + return (typeSymbol.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks)) + || IsIAsyncEnumerable(typeSymbol) || typeSymbol.AllInterfaces.Any(IsIAsyncEnumerable) + || typeSymbol.GetAttributes().Any(ad => ad.AttributeClass?.Name == Types.AsyncMethodBuilderAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.AsyncMethodBuilderAttribute.Namespace)); + + static bool IsIAsyncEnumerable(ITypeSymbol symbol) + => symbol.Name == "IAsyncEnumerable" // TODO: Use nameof(IAsyncEnumerable) after upgrade to netstandard2.1 + && symbol.BelongsToNamespace(Namespaces.SystemCollectionsGeneric); + } + + internal static bool IsLazyOfT([NotNullWhen(true)] INamedTypeSymbol? constructedType) + { + return constructedType is object + && constructedType.ContainingNamespace?.Name == nameof(System) + && (constructedType.ContainingNamespace.ContainingNamespace?.IsGlobalNamespace ?? false) + && constructedType.Name == nameof(Lazy) + && constructedType.Arity > 0; // could be Lazy or Lazy + } + + internal static bool IsTask([NotNullWhen(true)] ITypeSymbol? typeSymbol) => typeSymbol?.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks); - /// - /// Gets a value indicating whether a method is async or is ready to be async by having an async-compatible return type. - /// - /// - /// A method might be async but not have an async compatible return type if it returns void and is an "async void" method. - /// However, a non-async void method is *not* considered async ready and gets a false value returned from this method. - /// - internal static bool IsAsyncReady(this IMethodSymbol methodSymbol) => methodSymbol.IsAsync || methodSymbol.HasAsyncCompatibleReturnType(); + /// + /// Gets a value indicating whether a method is async or is ready to be async by having an async-compatible return type. + /// + /// + /// A method might be async but not have an async compatible return type if it returns void and is an "async void" method. + /// However, a non-async void method is *not* considered async ready and gets a false value returned from this method. + /// + internal static bool IsAsyncReady(this IMethodSymbol methodSymbol) => methodSymbol.IsAsync || methodSymbol.HasAsyncCompatibleReturnType(); - internal static bool HasAsyncAlternative(this IMethodSymbol methodSymbol, CancellationToken cancellationToken) + internal static bool HasAsyncAlternative(this IMethodSymbol methodSymbol, CancellationToken cancellationToken) + { + cancellationToken.ThrowIfCancellationRequested(); + return methodSymbol.ContainingType.GetMembers(methodSymbol.Name + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix) + .Any(alt => IsXAtLeastAsPublicAsY(alt, methodSymbol)); + } + + internal static bool IsXAtLeastAsPublicAsY(ISymbol x, ISymbol y) + { + if (y.DeclaredAccessibility == x.DeclaredAccessibility || + x.DeclaredAccessibility == Accessibility.Public) { - cancellationToken.ThrowIfCancellationRequested(); - return methodSymbol.ContainingType.GetMembers(methodSymbol.Name + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix) - .Any(alt => IsXAtLeastAsPublicAsY(alt, methodSymbol)); + return true; } - internal static bool IsXAtLeastAsPublicAsY(ISymbol x, ISymbol y) + switch (y.DeclaredAccessibility) { - if (y.DeclaredAccessibility == x.DeclaredAccessibility || - x.DeclaredAccessibility == Accessibility.Public) - { + case Accessibility.Private: return true; - } + case Accessibility.ProtectedAndInternal: + case Accessibility.Protected: + case Accessibility.Internal: + return x.DeclaredAccessibility == Accessibility.ProtectedOrInternal; + case Accessibility.ProtectedOrInternal: + case Accessibility.Public: + case Accessibility.NotApplicable: + default: + return false; + } + } - switch (y.DeclaredAccessibility) - { - case Accessibility.Private: - return true; - case Accessibility.ProtectedAndInternal: - case Accessibility.Protected: - case Accessibility.Internal: - return x.DeclaredAccessibility == Accessibility.ProtectedOrInternal; - case Accessibility.ProtectedOrInternal: - case Accessibility.Public: - case Accessibility.NotApplicable: - default: - return false; - } + /// + /// Determines whether a given symbol's declaration is visible outside the assembly + /// (and thus refactoring it may introduce breaking changes.) + /// + /// The symbol to be tested. + /// + /// if the symbol is a public type or member, + /// or a protected member inside a public type, + /// or an explicit interface implementation of a public interface; + /// otherwise . + /// + internal static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) + { + if (symbol is null) + { + return false; } - /// - /// Determines whether a given symbol's declaration is visible outside the assembly - /// (and thus refactoring it may introduce breaking changes.) - /// - /// The symbol to be tested. - /// - /// if the symbol is a public type or member, - /// or a protected member inside a public type, - /// or an explicit interface implementation of a public interface; - /// otherwise . - /// - internal static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) - { - if (symbol is null) - { + if (symbol is INamespaceSymbol) + { + return true; + } + + // The only member that is public without saying so are explicit interface implementations; + // and only when the interfaces implemented are themselves public. + var methodSymbol = symbol as IMethodSymbol; + if (methodSymbol?.ExplicitInterfaceImplementations.Any(IsPublic) ?? false) + { + return true; + } + + switch (symbol.DeclaredAccessibility) + { + case Accessibility.Internal: + case Accessibility.Private: + case Accessibility.ProtectedAndInternal: return false; - } + case Accessibility.Protected: + case Accessibility.ProtectedOrInternal: + case Accessibility.Public: + return symbol.ContainingType is null || IsPublic(symbol.ContainingType); + case Accessibility.NotApplicable: + default: + return false; + } + } - if (symbol is INamespaceSymbol) - { - return true; - } + internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, SemanticModel semanticModel, CancellationToken cancellationToken) + { + return semanticModel.Compilation is object && IsEntrypointMethod(symbol, semanticModel.Compilation, cancellationToken); + } - // The only member that is public without saying so are explicit interface implementations; - // and only when the interfaces implemented are themselves public. - var methodSymbol = symbol as IMethodSymbol; - if (methodSymbol?.ExplicitInterfaceImplementations.Any(IsPublic) ?? false) - { - return true; - } + internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, Compilation compilation, CancellationToken cancellationToken) + { + return compilation.GetEntryPoint(cancellationToken)?.Equals(symbol) ?? false; + } - switch (symbol.DeclaredAccessibility) - { - case Accessibility.Internal: - case Accessibility.Private: - case Accessibility.ProtectedAndInternal: - return false; - case Accessibility.Protected: - case Accessibility.ProtectedOrInternal: - case Accessibility.Public: - return symbol.ContainingType is null || IsPublic(symbol.ContainingType); - case Accessibility.NotApplicable: - default: - return false; - } - } + internal static bool IsObsolete(this ISymbol symbol) + { + return symbol.GetAttributes().Any(a => a.AttributeClass.Name == nameof(ObsoleteAttribute) && a.AttributeClass.BelongsToNamespace(Namespaces.System)); + } - internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, SemanticModel semanticModel, CancellationToken cancellationToken) + internal static IEnumerable FindInterfacesImplemented(this ISymbol? symbol) + { + if (symbol is null) { - return semanticModel.Compilation is object && IsEntrypointMethod(symbol, semanticModel.Compilation, cancellationToken); + return Enumerable.Empty(); } - internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, Compilation compilation, CancellationToken cancellationToken) + IEnumerable? interfaceImplementations = from iface in symbol.ContainingType.AllInterfaces + from member in iface.GetMembers() + let implementingMember = symbol.ContainingType.FindImplementationForInterfaceMember(member) + where implementingMember?.Equals(symbol) ?? false + select iface; + + return interfaceImplementations; + } + + internal static string GetFullName(ISymbol symbol) + { + if (symbol is null) { - return compilation.GetEntryPoint(cancellationToken)?.Equals(symbol) ?? false; + throw new ArgumentNullException(nameof(symbol)); } - internal static bool IsObsolete(this ISymbol symbol) + var sb = new StringBuilder(); + sb.Append(symbol.Name); + while (symbol.ContainingType is object) { - return symbol.GetAttributes().Any(a => a.AttributeClass.Name == nameof(ObsoleteAttribute) && a.AttributeClass.BelongsToNamespace(Namespaces.System)); + sb.Insert(0, symbol.ContainingType.Name + "."); + symbol = symbol.ContainingType; } - internal static IEnumerable FindInterfacesImplemented(this ISymbol? symbol) + while (symbol.ContainingNamespace is object) { - if (symbol is null) + if (!string.IsNullOrEmpty(symbol.ContainingNamespace.Name)) { - return Enumerable.Empty(); + sb.Insert(0, symbol.ContainingNamespace.Name + "."); } - IEnumerable? interfaceImplementations = from iface in symbol.ContainingType.AllInterfaces - from member in iface.GetMembers() - let implementingMember = symbol.ContainingType.FindImplementationForInterfaceMember(member) - where implementingMember?.Equals(symbol) ?? false - select iface; - - return interfaceImplementations; + symbol = symbol.ContainingNamespace; } - internal static string GetFullName(ISymbol symbol) - { - if (symbol is null) - { - throw new ArgumentNullException(nameof(symbol)); - } + return sb.ToString(); + } - var sb = new StringBuilder(); - sb.Append(symbol.Name); - while (symbol.ContainingType is object) - { - sb.Insert(0, symbol.ContainingType.Name + "."); - symbol = symbol.ContainingType; - } + internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2) + { + item1 = tuple.Item1; + item2 = tuple.Item2; + } - while (symbol.ContainingNamespace is object) - { - if (!string.IsNullOrEmpty(symbol.ContainingNamespace.Name)) - { - sb.Insert(0, symbol.ContainingNamespace.Name + "."); - } + internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3) + { + item1 = tuple.Item1; + item2 = tuple.Item2; + item3 = tuple.Item3; + } - symbol = symbol.ContainingNamespace; - } + internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3, out T4 item4) + { + item1 = tuple.Item1; + item2 = tuple.Item2; + item3 = tuple.Item3; + item4 = tuple.Item4; + } - return sb.ToString(); - } + internal static string GetHelpLink(string analyzerId) + { + return $"https://github.com/Microsoft/vs-threading/blob/main/doc/analyzers/{analyzerId}.md"; + } - internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2) + /// + /// Looks for a symbol that represents a near + /// some document location that might be consumed in some generated invocation. + /// + /// The semantic model of the document. + /// The position in the document that must have access to any candidate . + /// A token that represents lost interest in this inquiry. + /// Candidate symbols. + internal static IEnumerable? FindCancellationToken(SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) + { + if (semanticModel is null) { - item1 = tuple.Item1; - item2 = tuple.Item2; + throw new ArgumentNullException(nameof(semanticModel)); } - internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3) + ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(positionForLookup, cancellationToken); + if (enclosingSymbol is null) { - item1 = tuple.Item1; - item2 = tuple.Item2; - item3 = tuple.Item3; + return null; } - internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3, out T4 item4) - { - item1 = tuple.Item1; - item2 = tuple.Item2; - item3 = tuple.Item3; - item4 = tuple.Item4; - } + IOrderedEnumerable? cancellationTokenSymbols = semanticModel.LookupSymbols(positionForLookup) + .Where(s => (s.IsStatic || !enclosingSymbol.IsStatic) && s.CanBeReferencedByName && IsSymbolTheRightType(s, nameof(CancellationToken), Namespaces.SystemThreading)) + .OrderBy(s => s.ContainingSymbol.Equals(enclosingSymbol) ? 1 : s.ContainingType.Equals(enclosingSymbol.ContainingType) ? 2 : 3); // prefer locality + return cancellationTokenSymbols; + } - internal static string GetHelpLink(string analyzerId) + /// + /// Find a set of methods that match a given method's fully qualified name. + /// + /// The semantic model of the document that must be able to access the methods. + /// The fully-qualified name of the method. + /// An enumeration of method symbols with a matching name. + internal static IEnumerable FindMethodGroup(SemanticModel semanticModel, string methodAsString) + { + if (semanticModel is null) { - return $"https://github.com/Microsoft/vs-threading/blob/main/doc/analyzers/{analyzerId}.md"; + throw new ArgumentNullException(nameof(semanticModel)); } - /// - /// Looks for a symbol that represents a near - /// some document location that might be consumed in some generated invocation. - /// - /// The semantic model of the document. - /// The position in the document that must have access to any candidate . - /// A token that represents lost interest in this inquiry. - /// Candidate symbols. - internal static IEnumerable? FindCancellationToken(SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) + if (string.IsNullOrEmpty(methodAsString)) { - if (semanticModel is null) - { - throw new ArgumentNullException(nameof(semanticModel)); - } - - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(positionForLookup, cancellationToken); - if (enclosingSymbol is null) - { - return null; - } - - IOrderedEnumerable? cancellationTokenSymbols = semanticModel.LookupSymbols(positionForLookup) - .Where(s => (s.IsStatic || !enclosingSymbol.IsStatic) && s.CanBeReferencedByName && IsSymbolTheRightType(s, nameof(CancellationToken), Namespaces.SystemThreading)) - .OrderBy(s => s.ContainingSymbol.Equals(enclosingSymbol) ? 1 : s.ContainingType.Equals(enclosingSymbol.ContainingType) ? 2 : 3); // prefer locality - return cancellationTokenSymbols; + throw new ArgumentException("A non-empty value is required.", nameof(methodAsString)); } - /// - /// Find a set of methods that match a given method's fully qualified name. - /// - /// The semantic model of the document that must be able to access the methods. - /// The fully-qualified name of the method. - /// An enumeration of method symbols with a matching name. - internal static IEnumerable FindMethodGroup(SemanticModel semanticModel, string methodAsString) + (string? fullTypeName, string? methodName) = SplitOffLastElement(methodAsString); + (string? ns, string? leafTypeName) = SplitOffLastElement(fullTypeName); + string[]? namespaces = ns?.Split('.'); + if (fullTypeName is null) { - if (semanticModel is null) - { - throw new ArgumentNullException(nameof(semanticModel)); - } - - if (string.IsNullOrEmpty(methodAsString)) - { - throw new ArgumentException("A non-empty value is required.", nameof(methodAsString)); - } + return Enumerable.Empty(); + } - (string? fullTypeName, string? methodName) = SplitOffLastElement(methodAsString); - (string? ns, string? leafTypeName) = SplitOffLastElement(fullTypeName); - string[]? namespaces = ns?.Split('.'); - if (fullTypeName is null) - { - return Enumerable.Empty(); - } + INamedTypeSymbol? proposedType = semanticModel.Compilation.GetTypeByMetadataName(fullTypeName); - INamedTypeSymbol? proposedType = semanticModel.Compilation.GetTypeByMetadataName(fullTypeName); + return proposedType?.GetMembers(methodName).OfType() ?? Enumerable.Empty(); + } - return proposedType?.GetMembers(methodName).OfType() ?? Enumerable.Empty(); + /// + /// Find a set of methods that match a given method's fully qualified name. + /// + /// The semantic model of the document that must be able to access the methods. + /// The fully-qualified name of the method. + /// An enumeration of method symbols with a matching name. + internal static IEnumerable FindMethodGroup(SemanticModel semanticModel, CommonInterest.QualifiedMember method) + { + if (semanticModel is null) + { + throw new ArgumentNullException(nameof(semanticModel)); } - /// - /// Find a set of methods that match a given method's fully qualified name. - /// - /// The semantic model of the document that must be able to access the methods. - /// The fully-qualified name of the method. - /// An enumeration of method symbols with a matching name. - internal static IEnumerable FindMethodGroup(SemanticModel semanticModel, CommonInterest.QualifiedMember method) - { - if (semanticModel is null) - { - throw new ArgumentNullException(nameof(semanticModel)); - } + INamedTypeSymbol? proposedType = semanticModel.Compilation.GetTypeByMetadataName(method.ContainingType.ToString()); + return proposedType?.GetMembers(method.Name).OfType() ?? Enumerable.Empty(); + } - INamedTypeSymbol? proposedType = semanticModel.Compilation.GetTypeByMetadataName(method.ContainingType.ToString()); - return proposedType?.GetMembers(method.Name).OfType() ?? Enumerable.Empty(); + /// + /// Finds a local variable, field, property, or static member on another type + /// that is typed to return a value of a given type. + /// + /// The type of value required. + /// The semantic model of the document that must be able to access the value. + /// The position in the document where the value must be accessible. + /// A cancellation token. + /// An enumeration of symbols that can provide a value of the required type, together with a flag indicating whether they are accessible using "local" syntax (i.e. the symbol is a local variable or a field on the enclosing type). + internal static IEnumerable> FindInstanceOf(INamedTypeSymbol typeSymbol, SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) + { + if (typeSymbol is null) + { + throw new ArgumentNullException(nameof(typeSymbol)); } - /// - /// Finds a local variable, field, property, or static member on another type - /// that is typed to return a value of a given type. - /// - /// The type of value required. - /// The semantic model of the document that must be able to access the value. - /// The position in the document where the value must be accessible. - /// A cancellation token. - /// An enumeration of symbols that can provide a value of the required type, together with a flag indicating whether they are accessible using "local" syntax (i.e. the symbol is a local variable or a field on the enclosing type). - internal static IEnumerable> FindInstanceOf(INamedTypeSymbol typeSymbol, SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) + if (semanticModel is null) { - if (typeSymbol is null) - { - throw new ArgumentNullException(nameof(typeSymbol)); - } - - if (semanticModel is null) - { - throw new ArgumentNullException(nameof(semanticModel)); - } - - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(positionForLookup, cancellationToken); + throw new ArgumentNullException(nameof(semanticModel)); + } - // Search fields on the declaring type. - // Consider local variables too, if they're captured in a closure from some surrounding code block - // such that they would presumably be initialized by the time the first statement in our own code block runs. - ITypeSymbol enclosingTypeSymbol = enclosingSymbol as ITypeSymbol ?? enclosingSymbol.ContainingType; - if (enclosingTypeSymbol is object) - { - IEnumerable? candidateMembers = from symbol in semanticModel.LookupSymbols(positionForLookup, enclosingTypeSymbol) - where symbol.IsStatic || !enclosingSymbol.IsStatic - where IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) - select symbol; - foreach (ISymbol? candidate in candidateMembers) - { - yield return Tuple.Create(true, candidate); - } - } + ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(positionForLookup, cancellationToken); - // Find static fields/properties that return the matching type from other public, non-generic types. - IEnumerable? candidateStatics = from offering in semanticModel.LookupStaticMembers(positionForLookup).OfType() - from symbol in offering.GetMembers() - where symbol.IsStatic && symbol.CanBeReferencedByName && IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) + // Search fields on the declaring type. + // Consider local variables too, if they're captured in a closure from some surrounding code block + // such that they would presumably be initialized by the time the first statement in our own code block runs. + ITypeSymbol enclosingTypeSymbol = enclosingSymbol as ITypeSymbol ?? enclosingSymbol.ContainingType; + if (enclosingTypeSymbol is object) + { + IEnumerable? candidateMembers = from symbol in semanticModel.LookupSymbols(positionForLookup, enclosingTypeSymbol) + where symbol.IsStatic || !enclosingSymbol.IsStatic + where IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) select symbol; - foreach (ISymbol? candidate in candidateStatics) + foreach (ISymbol? candidate in candidateMembers) { - yield return Tuple.Create(false, candidate); + yield return Tuple.Create(true, candidate); } } - internal static T? FirstAncestor(this SyntaxNode startingNode, IReadOnlyCollection doNotPassNodeTypes) - where T : SyntaxNode + // Find static fields/properties that return the matching type from other public, non-generic types. + IEnumerable? candidateStatics = from offering in semanticModel.LookupStaticMembers(positionForLookup).OfType() + from symbol in offering.GetMembers() + where symbol.IsStatic && symbol.CanBeReferencedByName && IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) + select symbol; + foreach (ISymbol? candidate in candidateStatics) { - if (doNotPassNodeTypes is null) - { - throw new ArgumentNullException(nameof(doNotPassNodeTypes)); - } - - SyntaxNode? syntaxNode = startingNode; - while (syntaxNode is object) - { - if (syntaxNode is T result) - { - return result; - } - - if (doNotPassNodeTypes.Any(disallowed => disallowed.GetTypeInfo().IsAssignableFrom(syntaxNode.GetType().GetTypeInfo()))) - { - return default(T); - } - - syntaxNode = syntaxNode.Parent; - } + yield return Tuple.Create(false, candidate); + } + } - return default(T); + internal static T? FirstAncestor(this SyntaxNode startingNode, IReadOnlyCollection doNotPassNodeTypes) + where T : SyntaxNode + { + if (doNotPassNodeTypes is null) + { + throw new ArgumentNullException(nameof(doNotPassNodeTypes)); } - internal static Tuple SplitOffLastElement(string? qualifiedName) + SyntaxNode? syntaxNode = startingNode; + while (syntaxNode is object) { - if (qualifiedName is null) + if (syntaxNode is T result) { - return Tuple.Create(null, null); + return result; } - int lastPeriod = qualifiedName.LastIndexOf('.'); - if (lastPeriod < 0) + if (doNotPassNodeTypes.Any(disallowed => disallowed.GetTypeInfo().IsAssignableFrom(syntaxNode.GetType().GetTypeInfo()))) { - return Tuple.Create(null, qualifiedName); + return default(T); } - return Tuple.Create(qualifiedName.Substring(0, lastPeriod), qualifiedName.Substring(lastPeriod + 1)); + syntaxNode = syntaxNode.Parent; } - /// - /// Determines whether a given parameter accepts a . - /// - /// The parameter. - /// if the parameter takes a ; otherwise. - internal static bool IsCancellationTokenParameter(IParameterSymbol parameterSymbol) => parameterSymbol?.Type.Name == nameof(CancellationToken) && parameterSymbol.Type.BelongsToNamespace(Namespaces.SystemThreading); + return default(T); + } - internal static ISymbol? GetUnderlyingSymbol(IOperation? operation) + internal static Tuple SplitOffLastElement(string? qualifiedName) + { + if (qualifiedName is null) { - return operation switch - { - IParameterReferenceOperation paramRef => paramRef.Parameter, - ILocalReferenceOperation localRef => localRef.Local, - IMemberReferenceOperation memberRef => memberRef.Member, - _ => null, - }; + return Tuple.Create(null, null); } - internal static bool IsSameSymbol(IOperation? op1, IOperation? op2) => GetUnderlyingSymbol(op1)?.Equals(GetUnderlyingSymbol(op2)) ?? false; + int lastPeriod = qualifiedName.LastIndexOf('.'); + if (lastPeriod < 0) + { + return Tuple.Create(null, qualifiedName); + } + + return Tuple.Create(qualifiedName.Substring(0, lastPeriod), qualifiedName.Substring(lastPeriod + 1)); + } + + /// + /// Determines whether a given parameter accepts a . + /// + /// The parameter. + /// if the parameter takes a ; otherwise. + internal static bool IsCancellationTokenParameter(IParameterSymbol parameterSymbol) => parameterSymbol?.Type.Name == nameof(CancellationToken) && parameterSymbol.Type.BelongsToNamespace(Namespaces.SystemThreading); - internal static IOperation FindFinalAncestor(IOperation operation) + internal static ISymbol? GetUnderlyingSymbol(IOperation? operation) + { + return operation switch { - while (operation.Parent is object) - { - operation = operation.Parent; - } + IParameterReferenceOperation paramRef => paramRef.Parameter, + ILocalReferenceOperation localRef => localRef.Local, + IMemberReferenceOperation memberRef => memberRef.Member, + _ => null, + }; + } + + internal static bool IsSameSymbol(IOperation? op1, IOperation? op2) => GetUnderlyingSymbol(op1)?.Equals(GetUnderlyingSymbol(op2)) ?? false; - return operation; + internal static IOperation FindFinalAncestor(IOperation operation) + { + while (operation.Parent is object) + { + operation = operation.Parent; } - internal static T? FindAncestor(IOperation? operation) - where T : class, IOperation + return operation; + } + + internal static T? FindAncestor(IOperation? operation) + where T : class, IOperation + { + while (operation is object) { - while (operation is object) + if (operation.Parent is T parent) { - if (operation.Parent is T parent) - { - return parent; - } - - operation = operation.Parent; + return parent; } - return default; + operation = operation.Parent; } - private static bool IsSymbolTheRightType(ISymbol symbol, string typeName, IReadOnlyList namespaces) - { - var fieldSymbol = symbol as IFieldSymbol; - var propertySymbol = symbol as IPropertySymbol; - var parameterSymbol = symbol as IParameterSymbol; - var localSymbol = symbol as ILocalSymbol; - ITypeSymbol? memberType = fieldSymbol?.Type ?? propertySymbol?.Type ?? parameterSymbol?.Type ?? localSymbol?.Type; - return memberType?.Name == typeName && memberType.BelongsToNamespace(namespaces); - } + return default; + } - private static bool IsSymbolTheRightType(ISymbol symbol, string typeName, INamespaceSymbol namespaces) - { - var fieldSymbol = symbol as IFieldSymbol; - var propertySymbol = symbol as IPropertySymbol; - var parameterSymbol = symbol as IParameterSymbol; - var localSymbol = symbol as ILocalSymbol; - ITypeSymbol? memberType = fieldSymbol?.Type ?? propertySymbol?.Type ?? parameterSymbol?.Type ?? localSymbol?.Type; - return memberType?.Name == typeName && memberType.ContainingNamespace.Equals(namespaces); - } + private static bool IsSymbolTheRightType(ISymbol symbol, string typeName, IReadOnlyList namespaces) + { + var fieldSymbol = symbol as IFieldSymbol; + var propertySymbol = symbol as IPropertySymbol; + var parameterSymbol = symbol as IParameterSymbol; + var localSymbol = symbol as ILocalSymbol; + ITypeSymbol? memberType = fieldSymbol?.Type ?? propertySymbol?.Type ?? parameterSymbol?.Type ?? localSymbol?.Type; + return memberType?.Name == typeName && memberType.BelongsToNamespace(namespaces); + } - private static bool LaunchDebuggerExceptionFilter() - { + private static bool IsSymbolTheRightType(ISymbol symbol, string typeName, INamespaceSymbol namespaces) + { + var fieldSymbol = symbol as IFieldSymbol; + var propertySymbol = symbol as IPropertySymbol; + var parameterSymbol = symbol as IParameterSymbol; + var localSymbol = symbol as ILocalSymbol; + ITypeSymbol? memberType = fieldSymbol?.Type ?? propertySymbol?.Type ?? parameterSymbol?.Type ?? localSymbol?.Type; + return memberType?.Name == typeName && memberType.ContainingNamespace.Equals(namespaces); + } + + private static bool LaunchDebuggerExceptionFilter() + { #if DEBUG - System.Diagnostics.Debugger.Launch(); + System.Diagnostics.Debugger.Launch(); #endif - return true; - } + return true; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs index cc7cf1001..023d39afc 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs @@ -7,78 +7,77 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Detects the Async Void methods which are NOT used as asynchronous event handlers. +/// +/// +/// [Background] Async void methods have different error-handling semantics. +/// When an exception is thrown out of an async Task or async method/lambda, +/// that exception is captured and placed on the Task object. With async void methods, +/// there is no Task object, so any exceptions thrown out of an async void method will +/// be raised directly on the SynchronizationContext that was active when the async +/// void method started, and it would crash the process. +/// Refer to Stephen's article https://msdn.microsoft.com/en-us/magazine/jj991977.aspx for more info. +/// +/// i.e. +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD100AsyncVoidMethodAnalyzer : DiagnosticAnalyzer { - /// - /// Detects the Async Void methods which are NOT used as asynchronous event handlers. - /// - /// - /// [Background] Async void methods have different error-handling semantics. - /// When an exception is thrown out of an async Task or async method/lambda, - /// that exception is captured and placed on the Task object. With async void methods, - /// there is no Task object, so any exceptions thrown out of an async void method will - /// be raised directly on the SynchronizationContext that was active when the async - /// void method started, and it would crash the process. - /// Refer to Stephen's article https://msdn.microsoft.com/en-us/magazine/jj991977.aspx for more info. - /// - /// i.e. - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD100AsyncVoidMethodAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD100"; + public const string Id = "VSTHRD100"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD100_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD100_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD100_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD100_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics + /// + public override ImmutableArray SupportedDiagnostics + { + get { - get - { - return ImmutableArray.Create(Descriptor); - } + return ImmutableArray.Create(Descriptor); } + } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterSymbolAction(Utils.DebuggableWrapper(AnalyzeNode), SymbolKind.Method); - context.RegisterOperationAction(Utils.DebuggableWrapper(AnalyzeOperation), OperationKind.LocalFunction); - } + context.RegisterSymbolAction(Utils.DebuggableWrapper(AnalyzeNode), SymbolKind.Method); + context.RegisterOperationAction(Utils.DebuggableWrapper(AnalyzeOperation), OperationKind.LocalFunction); + } - private static void AnalyzeNode(SymbolAnalysisContext context) + private static void AnalyzeNode(SymbolAnalysisContext context) + { + var methodSymbol = (IMethodSymbol)context.Symbol; + if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) { - var methodSymbol = (IMethodSymbol)context.Symbol; - if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); - } + context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); } + } - private static void AnalyzeOperation(OperationAnalysisContext context) + private static void AnalyzeOperation(OperationAnalysisContext context) + { + if (context.Operation is ILocalFunctionOperation localFunctionOperation) { - if (context.Operation is ILocalFunctionOperation localFunctionOperation) + IMethodSymbol methodSymbol = localFunctionOperation.Symbol; + if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) { - IMethodSymbol methodSymbol = localFunctionOperation.Symbol; - if (methodSymbol.IsAsync && methodSymbol.ReturnsVoid) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); - } + context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodSymbol.Locations[0])); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs index 54c94c135..669b10343 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs @@ -7,74 +7,73 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Analyzes the async lambdas and checks if they are being used as void-returning delegate types. +/// +/// +/// [Background] Async void methods/lambdas have different error-handling semantics. +/// When an exception is thrown out of an async Task or async method/lambda, +/// that exception is captured and placed on the Task object. With async void methods/lambdas, +/// there is no Task object, so any exceptions thrown out of an async void method/lambda will +/// be raised directly on the SynchronizationContext that was active when the async +/// void method/lambda started, and it would crash the process. +/// Refer to Stephen's article https://msdn.microsoft.com/en-us/magazine/jj991977.aspx for more info. +/// +/// i.e. +/// action) { +/// } +/// +/// void Test() { +/// F(async (x) => { /* This analyzer will report warning on this async lambda. */ +/// DoSomething(); +/// }); +/// } +/// ]]> +/// +[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD101AsyncVoidLambdaAnalyzer : DiagnosticAnalyzer { - /// - /// Analyzes the async lambdas and checks if they are being used as void-returning delegate types. - /// - /// - /// [Background] Async void methods/lambdas have different error-handling semantics. - /// When an exception is thrown out of an async Task or async method/lambda, - /// that exception is captured and placed on the Task object. With async void methods/lambdas, - /// there is no Task object, so any exceptions thrown out of an async void method/lambda will - /// be raised directly on the SynchronizationContext that was active when the async - /// void method/lambda started, and it would crash the process. - /// Refer to Stephen's article https://msdn.microsoft.com/en-us/magazine/jj991977.aspx for more info. - /// - /// i.e. - /// action) { - /// } - /// - /// void Test() { - /// F(async (x) => { /* This analyzer will report warning on this async lambda. */ - /// DoSomething(); - /// }); - /// } - /// ]]> - /// - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD101AsyncVoidLambdaAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD101"; + public const string Id = "VSTHRD101"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD101_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD101_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD101_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD101_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics + /// + public override ImmutableArray SupportedDiagnostics + { + get { - get - { - return ImmutableArray.Create(Descriptor); - } + return ImmutableArray.Create(Descriptor); } + } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterOperationAction( - Utils.DebuggableWrapper(this.AnalyzeOperation), - OperationKind.AnonymousFunction); - } + context.RegisterOperationAction( + Utils.DebuggableWrapper(this.AnalyzeOperation), + OperationKind.AnonymousFunction); + } - private void AnalyzeOperation(OperationAnalysisContext context) + private void AnalyzeOperation(OperationAnalysisContext context) + { + var operation = (IAnonymousFunctionOperation)context.Operation; + IMethodSymbol? methodSymbol = operation.Symbol; + if (methodSymbol is object && methodSymbol.IsAsync && methodSymbol.ReturnsVoid) { - var operation = (IAnonymousFunctionOperation)context.Operation; - IMethodSymbol? methodSymbol = operation.Symbol; - if (methodSymbol is object && methodSymbol.IsAsync && methodSymbol.ReturnsVoid) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, operation.Syntax.GetLocation())); - } + context.ReportDiagnostic(Diagnostic.Create(Descriptor, operation.Syntax.GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs index 0abce5f62..f7aba0c9b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer.cs @@ -7,77 +7,76 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Analyzes the usages on AsyncEventHandler delegates and reports warning if +/// they are invoked NOT using the extension method TplExtensions.InvokeAsync() +/// in Microsoft.VisualStudio.Threading assembly. +/// +/// +/// [Background] AsyncEventHandler returns a Task and the default invocation mechanism +/// does not handle the faults thrown from the Tasks. That is why TplExtensions.InvokeAsync() +/// was invented to solve that problem. TplExtensions.InvokeAsync() will ensure all the delegates +/// are executed, aggregate the thrown exceptions, and re-throw the aggregated exception. +/// It is always better to use TplExtensions.InvokeAsync() for AsyncEventHandler delegates. +/// +/// i.e. +/// +/// +[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer : DiagnosticAnalyzer { - /// - /// Analyzes the usages on AsyncEventHandler delegates and reports warning if - /// they are invoked NOT using the extension method TplExtensions.InvokeAsync() - /// in Microsoft.VisualStudio.Threading assembly. - /// - /// - /// [Background] AsyncEventHandler returns a Task and the default invocation mechanism - /// does not handle the faults thrown from the Tasks. That is why TplExtensions.InvokeAsync() - /// was invented to solve that problem. TplExtensions.InvokeAsync() will ensure all the delegates - /// are executed, aggregate the thrown exceptions, and re-throw the aggregated exception. - /// It is always better to use TplExtensions.InvokeAsync() for AsyncEventHandler delegates. - /// - /// i.e. - /// - /// - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD106"; + public const string Id = "VSTHRD106"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD106_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD106_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD106_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD106_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); - /// - public override ImmutableArray SupportedDiagnostics + /// + public override ImmutableArray SupportedDiagnostics + { + get { - get - { - return ImmutableArray.Create(Descriptor); - } + return ImmutableArray.Create(Descriptor); } + } - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - - context.RegisterOperationBlockStartAction(context => - { - // This is a very special case to check if this method is TplExtensions.InvokeAsync(). - // If it is, then do not run the analyzer inside that method. - if (!(context.OwningSymbol.Name == Types.TplExtensions.InvokeAsync && - context.OwningSymbol.ContainingType.Name == Types.TplExtensions.TypeName && - context.OwningSymbol.ContainingType.BelongsToNamespace(Types.TplExtensions.Namespace))) - { - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); - } - }); - } + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - private void AnalyzeInvocation(OperationAnalysisContext context) + context.RegisterOperationBlockStartAction(context => { - var invocation = (IInvocationOperation)context.Operation; - if (invocation.TargetMethod.ContainingType is { Name: Types.AsyncEventHandler.TypeName } type - && type.BelongsToNamespace(Types.AsyncEventHandler.Namespace)) + // This is a very special case to check if this method is TplExtensions.InvokeAsync(). + // If it is, then do not run the analyzer inside that method. + if (!(context.OwningSymbol.Name == Types.TplExtensions.InvokeAsync && + context.OwningSymbol.ContainingType.Name == Types.TplExtensions.TypeName && + context.OwningSymbol.ContainingType.BelongsToNamespace(Types.TplExtensions.Namespace))) { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, invocation.Syntax.GetLocation())); + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); } + }); + } + + private void AnalyzeInvocation(OperationAnalysisContext context) + { + var invocation = (IInvocationOperation)context.Operation; + if (invocation.TargetMethod.ContainingType is { Name: Types.AsyncEventHandler.TypeName } type + && type.BelongsToNamespace(Types.AsyncEventHandler.Namespace)) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, invocation.Syntax.GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs index e7de58379..dfb27c37a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD111UseConfigureAwaitAnalyzer.cs @@ -7,51 +7,50 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Finds await expressions on that do not use . +/// Also works on . +/// +[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD111UseConfigureAwaitAnalyzer : DiagnosticAnalyzer { - /// - /// Finds await expressions on that do not use . - /// Also works on . - /// - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD111UseConfigureAwaitAnalyzer : DiagnosticAnalyzer + public const string Id = "VSTHRD111"; + + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD111_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD111_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Hidden, // projects should opt IN to this policy + isEnabledByDefault: true); + + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + + /// + public override void Initialize(AnalysisContext context) { - public const string Id = "VSTHRD111"; - - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD111_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD111_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Hidden, // projects should opt IN to this policy - isEnabledByDefault: true); - - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeAwaitOperation), OperationKind.Await); - } + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeAwaitOperation), OperationKind.Await); + } - private void AnalyzeAwaitOperation(OperationAnalysisContext context) + private void AnalyzeAwaitOperation(OperationAnalysisContext context) + { + var awaitOperation = (IAwaitOperation)context.Operation; + + // Emit the diagnostic if the awaited expression is a Task or ValueTask. + // They obviously aren't using ConfigureAwait in that case since the awaited expression type would be a + // ConfiguredTaskAwaitable instead. + ITypeSymbol? awaitedTypeInfo = awaitOperation.Operation.Type; + if (awaitedTypeInfo is object && awaitedTypeInfo.BelongsToNamespace(Namespaces.SystemThreadingTasks) && + (awaitedTypeInfo.Name == Types.Task.TypeName || awaitedTypeInfo.Name == Types.ValueTask.TypeName)) { - var awaitOperation = (IAwaitOperation)context.Operation; - - // Emit the diagnostic if the awaited expression is a Task or ValueTask. - // They obviously aren't using ConfigureAwait in that case since the awaited expression type would be a - // ConfiguredTaskAwaitable instead. - ITypeSymbol? awaitedTypeInfo = awaitOperation.Operation.Type; - if (awaitedTypeInfo is object && awaitedTypeInfo.BelongsToNamespace(Namespaces.SystemThreadingTasks) && - (awaitedTypeInfo.Name == Types.Task.TypeName || awaitedTypeInfo.Name == Types.ValueTask.TypeName)) - { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, awaitOperation.Operation.Syntax.GetLocation())); - } + context.ReportDiagnostic(Diagnostic.Create(Descriptor, awaitOperation.Operation.Syntax.GetLocation())); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs index 72d0b0a04..879130aca 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs @@ -11,94 +11,93 @@ using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Operations; -namespace Microsoft.VisualStudio.Threading.Analyzers -{ - /// - /// Verifies that code that performs type checks for vs-threading's IAsyncDisposable interface also check for System.IAsyncDisposable. - /// - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD113CheckForSystemIAsyncDisposableAnalyzer : DiagnosticAnalyzer - { - public const string Id = "VSTHRD113"; +namespace Microsoft.VisualStudio.Threading.Analyzers; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD113_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD113_MessageFormat), Strings.ResourceManager, typeof(Strings)), - description: new LocalizableResourceString(nameof(Strings.SystemIAsyncDisposablePackageNote), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Info, - isEnabledByDefault: true); +/// +/// Verifies that code that performs type checks for vs-threading's IAsyncDisposable interface also check for System.IAsyncDisposable. +/// +[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD113CheckForSystemIAsyncDisposableAnalyzer : DiagnosticAnalyzer +{ + public const string Id = "VSTHRD113"; - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD113_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD113_MessageFormat), Strings.ResourceManager, typeof(Strings)), + description: new LocalizableResourceString(nameof(Strings.SystemIAsyncDisposablePackageNote), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Info, + isEnabledByDefault: true); - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - context.RegisterCompilationStartAction(startCompilation => - { - INamedTypeSymbol? vsThreadingAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.IAsyncDisposable.FullName); - INamedTypeSymbol? bclAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.BclAsyncDisposable.FullName); - if (vsThreadingAsyncDisposableType is object) - { - startCompilation.RegisterOperationAction(Utils.DebuggableWrapper(c => AnalyzeTypeCheck(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), OperationKind.IsType); - startCompilation.RegisterOperationAction(Utils.DebuggableWrapper(c => AnalyzeTypeCheck(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), OperationKind.IsPattern); - startCompilation.RegisterOperationAction(Utils.DebuggableWrapper(c => AnalyzeTypeCheck(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), OperationKind.Conversion); - } - }); - } + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - private static void AnalyzeTypeCheck(OperationAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + context.RegisterCompilationStartAction(startCompilation => { - switch (context.Operation) + INamedTypeSymbol? vsThreadingAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.IAsyncDisposable.FullName); + INamedTypeSymbol? bclAsyncDisposableType = startCompilation.Compilation.GetTypeByMetadataName(Types.BclAsyncDisposable.FullName); + if (vsThreadingAsyncDisposableType is object) { - case IIsTypeOperation { TypeOperand: { } operand }: - ConsiderTypeCheck(context, operand, vsThreadingAsyncDisposableType, bclAsyncDisposableType); - break; - case IIsPatternOperation { Pattern: IDeclarationPatternOperation { DeclaredSymbol: ILocalSymbol { Type: { } operand } } }: - ConsiderTypeCheck(context, operand, vsThreadingAsyncDisposableType, bclAsyncDisposableType); - break; - case IConversionOperation { Type: { } operand }: - ConsiderTypeCheck(context, operand, vsThreadingAsyncDisposableType, bclAsyncDisposableType); - break; + startCompilation.RegisterOperationAction(Utils.DebuggableWrapper(c => AnalyzeTypeCheck(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), OperationKind.IsType); + startCompilation.RegisterOperationAction(Utils.DebuggableWrapper(c => AnalyzeTypeCheck(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), OperationKind.IsPattern); + startCompilation.RegisterOperationAction(Utils.DebuggableWrapper(c => AnalyzeTypeCheck(c, vsThreadingAsyncDisposableType, bclAsyncDisposableType)), OperationKind.Conversion); } + }); + } - static void ConsiderTypeCheck(OperationAnalysisContext context, ITypeSymbol operand, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + private static void AnalyzeTypeCheck(OperationAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + { + switch (context.Operation) + { + case IIsTypeOperation { TypeOperand: { } operand }: + ConsiderTypeCheck(context, operand, vsThreadingAsyncDisposableType, bclAsyncDisposableType); + break; + case IIsPatternOperation { Pattern: IDeclarationPatternOperation { DeclaredSymbol: ILocalSymbol { Type: { } operand } } }: + ConsiderTypeCheck(context, operand, vsThreadingAsyncDisposableType, bclAsyncDisposableType); + break; + case IConversionOperation { Type: { } operand }: + ConsiderTypeCheck(context, operand, vsThreadingAsyncDisposableType, bclAsyncDisposableType); + break; + } + + static void ConsiderTypeCheck(OperationAnalysisContext context, ITypeSymbol operand, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + { + if (Equals(vsThreadingAsyncDisposableType, operand)) { - if (Equals(vsThreadingAsyncDisposableType, operand)) + // If the System.IAsyncDisposable type is defined, search for a check for that type and skip the diagnostic if we find one. + if (bclAsyncDisposableType is object) { - // If the System.IAsyncDisposable type is defined, search for a check for that type and skip the diagnostic if we find one. - if (bclAsyncDisposableType is object) + IOperation methodBlock = Utils.FindFinalAncestor(context.Operation); + if (methodBlock.Descendants().Any(op => IsTypeCheck(op, bclAsyncDisposableType))) { - IOperation methodBlock = Utils.FindFinalAncestor(context.Operation); - if (methodBlock.Descendants().Any(op => IsTypeCheck(op, bclAsyncDisposableType))) - { - // We found a matching check for the BCL type. No diagnostic to report. - return; - } + // We found a matching check for the BCL type. No diagnostic to report. + return; } - - context.ReportDiagnostic(Diagnostic.Create(Descriptor, context.Operation.Syntax.GetLocation())); } + + context.ReportDiagnostic(Diagnostic.Create(Descriptor, context.Operation.Syntax.GetLocation())); } + } - static bool IsTypeCheck(IOperation operation, INamedTypeSymbol typeChecked) + static bool IsTypeCheck(IOperation operation, INamedTypeSymbol typeChecked) + { + switch (operation) { - switch (operation) - { - case IIsTypeOperation { TypeOperand: { } operand }: - return Equals(typeChecked, operand); - case IDeclarationPatternOperation { DeclaredSymbol: ILocalSymbol { Type: { } operand } }: - return Equals(typeChecked, operand); - case IConversionOperation { Type: { } operand }: - return Equals(typeChecked, operand); - default: - return false; - } + case IIsTypeOperation { TypeOperand: { } operand }: + return Equals(typeChecked, operand); + case IDeclarationPatternOperation { DeclaredSymbol: ILocalSymbol { Type: { } operand } }: + return Equals(typeChecked, operand); + case IConversionOperation { Type: { } operand }: + return Equals(typeChecked, operand); + default: + return false; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index c0b83d33e..f22057db7 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -7,100 +7,99 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -namespace Microsoft.VisualStudio.Threading.Analyzers +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] +public class VSTHRD200UseAsyncNamingConventionAnalyzer : DiagnosticAnalyzer { - [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] - public class VSTHRD200UseAsyncNamingConventionAnalyzer : DiagnosticAnalyzer + public const string Id = "VSTHRD200"; + + internal const string NewNameKey = "NewName"; + + internal const string MandatoryAsyncSuffix = "Async"; + + internal static readonly DiagnosticDescriptor AddAsyncDescriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD200_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD200_AddAsync_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Style", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + internal static readonly DiagnosticDescriptor RemoveAsyncDescriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD200_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD200_RemoveAsync_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Style", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create( + AddAsyncDescriptor, + RemoveAsyncDescriptor); + + /// + public override void Initialize(AnalysisContext context) { - public const string Id = "VSTHRD200"; - - internal const string NewNameKey = "NewName"; - - internal const string MandatoryAsyncSuffix = "Async"; - - internal static readonly DiagnosticDescriptor AddAsyncDescriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD200_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD200_AddAsync_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Style", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); - - internal static readonly DiagnosticDescriptor RemoveAsyncDescriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD200_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD200_RemoveAsync_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Style", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); - - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create( - AddAsyncDescriptor, - RemoveAsyncDescriptor); - - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterSymbolAction(Utils.DebuggableWrapper(new PerCompilation().AnalyzeNode), SymbolKind.Method); - } + context.RegisterSymbolAction(Utils.DebuggableWrapper(new PerCompilation().AnalyzeNode), SymbolKind.Method); + } - private class PerCompilation : DiagnosticAnalyzerState + private class PerCompilation : DiagnosticAnalyzerState + { + internal void AnalyzeNode(SymbolAnalysisContext context) { - internal void AnalyzeNode(SymbolAnalysisContext context) + var methodSymbol = (IMethodSymbol)context.Symbol; + if (methodSymbol.AssociatedSymbol is IPropertySymbol) { - var methodSymbol = (IMethodSymbol)context.Symbol; - if (methodSymbol.AssociatedSymbol is IPropertySymbol) + // Skip accessor methods associated with properties. + return; + } + + // Skip entrypoint methods since their name is non-negotiable. + if (Utils.IsEntrypointMethod(methodSymbol, context.Compilation, context.CancellationToken)) + { + return; + } + + bool hasAsyncFocusedReturnType = Utils.HasAsyncCompatibleReturnType(methodSymbol); + + bool actuallyEndsWithAsync = methodSymbol.Name.EndsWith(MandatoryAsyncSuffix, StringComparison.CurrentCulture); + + if (hasAsyncFocusedReturnType != actuallyEndsWithAsync) + { + // Now that we have done the cheap checks to find that this method may deserve a diagnostic, + // Do deeper checks to skip over methods that implement API contracts that are controlled elsewhere. + if (methodSymbol.FindInterfacesImplemented().Any() || methodSymbol.IsOverride) { - // Skip accessor methods associated with properties. return; } - // Skip entrypoint methods since their name is non-negotiable. - if (Utils.IsEntrypointMethod(methodSymbol, context.Compilation, context.CancellationToken)) + if (hasAsyncFocusedReturnType) { - return; + // We actively encourage folks to use the Async keyword only for clearly async-focused types. + // Not just any awaitable, since some stray extension method shouldn't change the world for everyone. + ImmutableDictionary? properties = ImmutableDictionary.Empty + .Add(NewNameKey, methodSymbol.Name + MandatoryAsyncSuffix); + context.ReportDiagnostic(Diagnostic.Create( + AddAsyncDescriptor, + methodSymbol.Locations[0], + properties)); } - - bool hasAsyncFocusedReturnType = Utils.HasAsyncCompatibleReturnType(methodSymbol); - - bool actuallyEndsWithAsync = methodSymbol.Name.EndsWith(MandatoryAsyncSuffix, StringComparison.CurrentCulture); - - if (hasAsyncFocusedReturnType != actuallyEndsWithAsync) + else if (!this.IsAwaitableType(methodSymbol.ReturnType, context.Compilation, context.CancellationToken)) { - // Now that we have done the cheap checks to find that this method may deserve a diagnostic, - // Do deeper checks to skip over methods that implement API contracts that are controlled elsewhere. - if (methodSymbol.FindInterfacesImplemented().Any() || methodSymbol.IsOverride) - { - return; - } - - if (hasAsyncFocusedReturnType) - { - // We actively encourage folks to use the Async keyword only for clearly async-focused types. - // Not just any awaitable, since some stray extension method shouldn't change the world for everyone. - ImmutableDictionary? properties = ImmutableDictionary.Empty - .Add(NewNameKey, methodSymbol.Name + MandatoryAsyncSuffix); - context.ReportDiagnostic(Diagnostic.Create( - AddAsyncDescriptor, - methodSymbol.Locations[0], - properties)); - } - else if (!this.IsAwaitableType(methodSymbol.ReturnType, context.Compilation, context.CancellationToken)) - { - // Only warn about abusing the Async suffix if the return type is not awaitable. - ImmutableDictionary? properties = ImmutableDictionary.Empty - .Add(NewNameKey, methodSymbol.Name.Substring(0, methodSymbol.Name.Length - MandatoryAsyncSuffix.Length)); - context.ReportDiagnostic(Diagnostic.Create( - RemoveAsyncDescriptor, - methodSymbol.Locations[0], - properties)); - } + // Only warn about abusing the Async suffix if the return type is not awaitable. + ImmutableDictionary? properties = ImmutableDictionary.Empty + .Add(NewNameKey, methodSymbol.Name.Substring(0, methodSymbol.Name.Length - MandatoryAsyncSuffix.Length)); + context.ReportDiagnostic(Diagnostic.Create( + RemoveAsyncDescriptor, + methodSymbol.Locations[0], + properties)); } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs index c7f618f67..cb4e2e095 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs @@ -9,183 +9,182 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An asynchronous implementation of an AutoResetEvent. +/// +[DebuggerDisplay("Signaled: {signaled}")] +public class AsyncAutoResetEvent { /// - /// An asynchronous implementation of an AutoResetEvent. + /// A queue of folks awaiting signals. /// - [DebuggerDisplay("Signaled: {signaled}")] - public class AsyncAutoResetEvent - { - /// - /// A queue of folks awaiting signals. - /// - private readonly Queue signalAwaiters = new Queue(); + private readonly Queue signalAwaiters = new Queue(); - /// - /// Whether to complete the task synchronously in the method, - /// as opposed to asynchronously. - /// - private readonly bool allowInliningAwaiters; + /// + /// Whether to complete the task synchronously in the method, + /// as opposed to asynchronously. + /// + private readonly bool allowInliningAwaiters; - /// - /// A reusable delegate that points to the method. - /// - private readonly Action onCancellationRequestHandler; + /// + /// A reusable delegate that points to the method. + /// + private readonly Action onCancellationRequestHandler; - /// - /// A value indicating whether this event is already in a signaled state. - /// - /// - /// This should not need the volatile modifier because it is - /// always accessed within a lock. - /// - private bool signaled; + /// + /// A value indicating whether this event is already in a signaled state. + /// + /// + /// This should not need the volatile modifier because it is + /// always accessed within a lock. + /// + private bool signaled; - /// - /// Initializes a new instance of the class - /// that does not inline awaiters. - /// - public AsyncAutoResetEvent() - : this(allowInliningAwaiters: false) - { - } + /// + /// Initializes a new instance of the class + /// that does not inline awaiters. + /// + public AsyncAutoResetEvent() + : this(allowInliningAwaiters: false) + { + } - /// - /// Initializes a new instance of the class. - /// - /// - /// A value indicating whether to complete the task synchronously in the method, - /// as opposed to asynchronously. better simulates the behavior of the - /// class, but can result in slightly better performance. - /// - public AsyncAutoResetEvent(bool allowInliningAwaiters) - { - this.allowInliningAwaiters = allowInliningAwaiters; - this.onCancellationRequestHandler = this.OnCancellationRequest; - } + /// + /// Initializes a new instance of the class. + /// + /// + /// A value indicating whether to complete the task synchronously in the method, + /// as opposed to asynchronously. better simulates the behavior of the + /// class, but can result in slightly better performance. + /// + public AsyncAutoResetEvent(bool allowInliningAwaiters) + { + this.allowInliningAwaiters = allowInliningAwaiters; + this.onCancellationRequestHandler = this.OnCancellationRequest; + } - /// - /// Returns an awaitable that may be used to asynchronously acquire the next signal. - /// - /// An awaitable. - public Task WaitAsync() + /// + /// Returns an awaitable that may be used to asynchronously acquire the next signal. + /// + /// An awaitable. + public Task WaitAsync() + { + return this.WaitAsync(CancellationToken.None); + } + + /// + /// Returns an awaitable that may be used to asynchronously acquire the next signal. + /// + /// A token whose cancellation removes the caller from the queue of those waiting for the event. + /// An awaitable. + public Task WaitAsync(CancellationToken cancellationToken) + { + if (cancellationToken.IsCancellationRequested) { - return this.WaitAsync(CancellationToken.None); + return Task.FromCanceled(cancellationToken); } - /// - /// Returns an awaitable that may be used to asynchronously acquire the next signal. - /// - /// A token whose cancellation removes the caller from the queue of those waiting for the event. - /// An awaitable. - public Task WaitAsync(CancellationToken cancellationToken) + lock (this.signalAwaiters) { - if (cancellationToken.IsCancellationRequested) + if (this.signaled) { - return Task.FromCanceled(cancellationToken); + this.signaled = false; + return Task.CompletedTask; } - - lock (this.signalAwaiters) + else { - if (this.signaled) + var waiter = new WaiterCompletionSource(this, this.allowInliningAwaiters, cancellationToken); + if (cancellationToken.IsCancellationRequested) { - this.signaled = false; - return Task.CompletedTask; + waiter.TrySetCanceled(cancellationToken); } else { - var waiter = new WaiterCompletionSource(this, this.allowInliningAwaiters, cancellationToken); - if (cancellationToken.IsCancellationRequested) - { - waiter.TrySetCanceled(cancellationToken); - } - else - { - this.signalAwaiters.Enqueue(waiter); - } - - return waiter.Task; + this.signalAwaiters.Enqueue(waiter); } + + return waiter.Task; } } + } - /// - /// Unblocks one waiter or sets the signal if no waiters are present so the next waiter may proceed immediately. - /// - public void Set() + /// + /// Unblocks one waiter or sets the signal if no waiters are present so the next waiter may proceed immediately. + /// + public void Set() + { + WaiterCompletionSource? toRelease = null; + lock (this.signalAwaiters) { - WaiterCompletionSource? toRelease = null; - lock (this.signalAwaiters) + if (this.signalAwaiters.Count > 0) { - if (this.signalAwaiters.Count > 0) - { - toRelease = this.signalAwaiters.Dequeue(); - } - else if (!this.signaled) - { - this.signaled = true; - } + toRelease = this.signalAwaiters.Dequeue(); } - - if (toRelease is object) + else if (!this.signaled) { - toRelease.Registration.Dispose(); - toRelease.TrySetResult(default(EmptyStruct)); + this.signaled = true; } } - /// - /// Responds to cancellation requests by removing the request from the waiter queue. - /// - /// The passed in to the method. - private void OnCancellationRequest(object state) + if (toRelease is object) { - var tcs = (WaiterCompletionSource)state; - bool removed; - lock (this.signalAwaiters) - { - removed = this.signalAwaiters.RemoveMidQueue(tcs); - } + toRelease.Registration.Dispose(); + toRelease.TrySetResult(default(EmptyStruct)); + } + } - // We only cancel the task if we removed it from the queue. - // If it wasn't in the queue, either it has already been signaled - // or it hasn't even been added to the queue yet. If the latter, - // the Task will be canceled later so long as the signal hasn't been awarded - // to this Task yet. - if (removed) - { - tcs.TrySetCanceled(tcs.CancellationToken); - } + /// + /// Responds to cancellation requests by removing the request from the waiter queue. + /// + /// The passed in to the method. + private void OnCancellationRequest(object state) + { + var tcs = (WaiterCompletionSource)state; + bool removed; + lock (this.signalAwaiters) + { + removed = this.signalAwaiters.RemoveMidQueue(tcs); } + // We only cancel the task if we removed it from the queue. + // If it wasn't in the queue, either it has already been signaled + // or it hasn't even been added to the queue yet. If the latter, + // the Task will be canceled later so long as the signal hasn't been awarded + // to this Task yet. + if (removed) + { + tcs.TrySetCanceled(tcs.CancellationToken); + } + } + + /// + /// Tracks someone waiting for a signal from the event. + /// + private class WaiterCompletionSource : TaskCompletionSourceWithoutInlining + { /// - /// Tracks someone waiting for a signal from the event. + /// Initializes a new instance of the class. /// - private class WaiterCompletionSource : TaskCompletionSourceWithoutInlining + /// The event that is initializing this value. + /// to allow continuations to be inlined upon the completer's callstack. + /// The cancellation token associated with the waiter. + internal WaiterCompletionSource(AsyncAutoResetEvent owner, bool allowInliningContinuations, CancellationToken cancellationToken) + : base(allowInliningContinuations) { - /// - /// Initializes a new instance of the class. - /// - /// The event that is initializing this value. - /// to allow continuations to be inlined upon the completer's callstack. - /// The cancellation token associated with the waiter. - internal WaiterCompletionSource(AsyncAutoResetEvent owner, bool allowInliningContinuations, CancellationToken cancellationToken) - : base(allowInliningContinuations) - { - this.CancellationToken = cancellationToken; - this.Registration = cancellationToken.Register(NullableHelpers.AsNullableArgAction(owner.onCancellationRequestHandler), this); - } + this.CancellationToken = cancellationToken; + this.Registration = cancellationToken.Register(NullableHelpers.AsNullableArgAction(owner.onCancellationRequestHandler), this); + } - /// - /// Gets the provided by the waiter. - /// - internal CancellationToken CancellationToken { get; private set; } + /// + /// Gets the provided by the waiter. + /// + internal CancellationToken CancellationToken { get; private set; } - /// - /// Gets the registration to dispose of when the waiter receives their event. - /// - internal CancellationTokenRegistration Registration { get; private set; } - } + /// + /// Gets the registration to dispose of when the waiter receives their event. + /// + internal CancellationTokenRegistration Registration { get; private set; } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs b/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs index 0246654f7..292cf0430 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs @@ -9,70 +9,69 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An asynchronous barrier that blocks the signaler until all other participants have signaled. +/// +public class AsyncBarrier { /// - /// An asynchronous barrier that blocks the signaler until all other participants have signaled. + /// The number of participants being synchronized. /// - public class AsyncBarrier - { - /// - /// The number of participants being synchronized. - /// - private readonly int participantCount; + private readonly int participantCount; - /// - /// The set of participants who have reached the barrier, with their awaiters that can resume those participants. - /// - private readonly Stack> waiters; + /// + /// The set of participants who have reached the barrier, with their awaiters that can resume those participants. + /// + private readonly Stack> waiters; - /// - /// Initializes a new instance of the class. - /// - /// The number of participants. - public AsyncBarrier(int participants) - { - Requires.Range(participants > 0, nameof(participants)); - this.participantCount = participants; + /// + /// Initializes a new instance of the class. + /// + /// The number of participants. + public AsyncBarrier(int participants) + { + Requires.Range(participants > 0, nameof(participants)); + this.participantCount = participants; - // Allocate the stack so no resizing is necessary. - // We don't need space for the last participant, since we never have to store it. - this.waiters = new Stack>(participants - 1); - } + // Allocate the stack so no resizing is necessary. + // We don't need space for the last participant, since we never have to store it. + this.waiters = new Stack>(participants - 1); + } - /// - /// Signals that a participant is ready, and returns a Task - /// that completes when all other participants have also signaled ready. - /// - /// A Task, which will complete (or may already be completed) when the last participant calls this method. - public Task SignalAndWait() + /// + /// Signals that a participant is ready, and returns a Task + /// that completes when all other participants have also signaled ready. + /// + /// A Task, which will complete (or may already be completed) when the last participant calls this method. + public Task SignalAndWait() + { + lock (this.waiters) { - lock (this.waiters) + if (this.waiters.Count + 1 == this.participantCount) { - if (this.waiters.Count + 1 == this.participantCount) + // This is the last one we were waiting for. + // Unleash everyone that preceded this one. + while (this.waiters.Count > 0) { - // This is the last one we were waiting for. - // Unleash everyone that preceded this one. - while (this.waiters.Count > 0) - { - Task.Factory.StartNew( - state => ((TaskCompletionSource)state!).SetResult(default(EmptyStruct)), - this.waiters.Pop(), - CancellationToken.None, - TaskCreationOptions.None, - TaskScheduler.Default); - } - - // And allow this one to continue immediately. - return Task.CompletedTask; - } - else - { - // We need more folks. So suspend this caller. - var tcs = new TaskCompletionSource(); - this.waiters.Push(tcs); - return tcs.Task; + Task.Factory.StartNew( + state => ((TaskCompletionSource)state!).SetResult(default(EmptyStruct)), + this.waiters.Pop(), + CancellationToken.None, + TaskCreationOptions.None, + TaskScheduler.Default); } + + // And allow this one to continue immediately. + return Task.CompletedTask; + } + else + { + // We need more folks. So suspend this caller. + var tcs = new TaskCompletionSource(); + this.waiters.Push(tcs); + return tcs.Task; } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs index a57edbcee..fa9055659 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncCountdownEvent.cs @@ -9,106 +9,105 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An asynchronous style countdown event. +/// +public class AsyncCountdownEvent { /// - /// An asynchronous style countdown event. + /// The manual reset event we use to signal all awaiters. + /// + private readonly AsyncManualResetEvent manualEvent; + + /// + /// The remaining number of signals required before we can unblock waiters. + /// + private int remainingCount; + + /// + /// Initializes a new instance of the class. /// - public class AsyncCountdownEvent + /// The number of signals required to unblock awaiters. + public AsyncCountdownEvent(int initialCount) { - /// - /// The manual reset event we use to signal all awaiters. - /// - private readonly AsyncManualResetEvent manualEvent; + Requires.Range(initialCount >= 0, "initialCount"); + this.manualEvent = new AsyncManualResetEvent(initialCount == 0); + this.remainingCount = initialCount; + } - /// - /// The remaining number of signals required before we can unblock waiters. - /// - private int remainingCount; + /// + /// Returns an awaitable that executes the continuation when the countdown reaches zero. + /// + /// An awaitable. + public Task WaitAsync() + { + return this.manualEvent.WaitAsync(); + } - /// - /// Initializes a new instance of the class. - /// - /// The number of signals required to unblock awaiters. - public AsyncCountdownEvent(int initialCount) + /// + /// Decrements the counter by one. + /// + /// + /// A task that completes when the signal has been set if this call causes the count to reach zero. + /// If the count is not zero, a completed task is returned. + /// + /// + /// + /// On .NET versions prior to 4.6: + /// This method may return before the signal set has propagated. + /// The returned task completes when the signal has definitely been set. + /// + /// + /// On .NET 4.6 and later: + /// This method is not asynchronous. The returned Task is always completed. + /// + /// + [Obsolete("Use Signal() instead."), EditorBrowsable(EditorBrowsableState.Never)] + public async Task SignalAsync() + { + int newCount = Interlocked.Decrement(ref this.remainingCount); + if (newCount == 0) { - Requires.Range(initialCount >= 0, "initialCount"); - this.manualEvent = new AsyncManualResetEvent(initialCount == 0); - this.remainingCount = initialCount; + await this.manualEvent.SetAsync().ConfigureAwait(false); } - - /// - /// Returns an awaitable that executes the continuation when the countdown reaches zero. - /// - /// An awaitable. - public Task WaitAsync() + else if (newCount < 0) { - return this.manualEvent.WaitAsync(); + throw new InvalidOperationException(); } + } - /// - /// Decrements the counter by one. - /// - /// - /// A task that completes when the signal has been set if this call causes the count to reach zero. - /// If the count is not zero, a completed task is returned. - /// - /// - /// - /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated. - /// The returned task completes when the signal has definitely been set. - /// - /// - /// On .NET 4.6 and later: - /// This method is not asynchronous. The returned Task is always completed. - /// - /// - [Obsolete("Use Signal() instead."), EditorBrowsable(EditorBrowsableState.Never)] - public async Task SignalAsync() + /// + /// Decrements the counter by one. + /// + public void Signal() + { + int newCount = Interlocked.Decrement(ref this.remainingCount); + if (newCount == 0) { - int newCount = Interlocked.Decrement(ref this.remainingCount); - if (newCount == 0) - { - await this.manualEvent.SetAsync().ConfigureAwait(false); - } - else if (newCount < 0) - { - throw new InvalidOperationException(); - } + this.manualEvent.Set(); } - - /// - /// Decrements the counter by one. - /// - public void Signal() + else if (newCount < 0) { - int newCount = Interlocked.Decrement(ref this.remainingCount); - if (newCount == 0) - { - this.manualEvent.Set(); - } - else if (newCount < 0) - { - throw new InvalidOperationException(); - } + throw new InvalidOperationException(); } + } - /// - /// Decrements the counter by one and returns an awaitable that executes the continuation when the countdown reaches zero. - /// - /// An awaitable. - public Task SignalAndWaitAsync() + /// + /// Decrements the counter by one and returns an awaitable that executes the continuation when the countdown reaches zero. + /// + /// An awaitable. + public Task SignalAndWaitAsync() + { + try + { + this.Signal(); + return this.WaitAsync(); + } + catch (Exception ex) { - try - { - this.Signal(); - return this.WaitAsync(); - } - catch (Exception ex) - { - return Task.FromException(ex); - } + return Task.FromException(ex); } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs b/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs index cb65a246c..e5ef52010 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncEventHandler.cs @@ -7,22 +7,21 @@ using System.Text; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading -{ - /// - /// An asynchronous event handler. - /// - /// The sender of the event. - /// Event arguments. - /// A task whose completion signals handling is finished. - public delegate Task AsyncEventHandler(object? sender, EventArgs args); +namespace Microsoft.VisualStudio.Threading; - /// - /// An asynchronous event handler. - /// - /// The type of event arguments. - /// The sender of the event. - /// Event arguments. - /// A task whose completion signals handling is finished. - public delegate Task AsyncEventHandler(object? sender, TEventArgs args); -} +/// +/// An asynchronous event handler. +/// +/// The sender of the event. +/// Event arguments. +/// A task whose completion signals handling is finished. +public delegate Task AsyncEventHandler(object? sender, EventArgs args); + +/// +/// An asynchronous event handler. +/// +/// The type of event arguments. +/// The sender of the event. +/// Event arguments. +/// A task whose completion signals handling is finished. +public delegate Task AsyncEventHandler(object? sender, TEventArgs args); diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs index 3e145b39c..6e68a3610 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazyInitializer.cs @@ -5,59 +5,58 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Lazily executes a delegate that has some side effect (typically initializing something) +/// such that the delegate runs at most once. +/// +public class AsyncLazyInitializer { /// - /// Lazily executes a delegate that has some side effect (typically initializing something) - /// such that the delegate runs at most once. + /// The lazy instance we use internally for the bulk of the behavior we want. + /// + private readonly AsyncLazy lazy; + + /// + /// Initializes a new instance of the class. /// - public class AsyncLazyInitializer + /// The action to perform at most once, that has some desirable side-effect. + /// The factory to use when invoking the in to avoid deadlocks when the main thread is required by the . + public AsyncLazyInitializer(Func action, JoinableTaskFactory? joinableTaskFactory = null) { - /// - /// The lazy instance we use internally for the bulk of the behavior we want. - /// - private readonly AsyncLazy lazy; - - /// - /// Initializes a new instance of the class. - /// - /// The action to perform at most once, that has some desirable side-effect. - /// The factory to use when invoking the in to avoid deadlocks when the main thread is required by the . - public AsyncLazyInitializer(Func action, JoinableTaskFactory? joinableTaskFactory = null) - { - Requires.NotNull(action, nameof(action)); - this.lazy = new AsyncLazy( - async delegate - { - await action().ConfigureAwaitRunInline(); - return default; - }, - joinableTaskFactory); - } - - /// - /// Gets a value indicating whether the action has executed completely, regardless of whether it threw an exception. - /// - public bool IsCompleted => this.lazy.IsValueFactoryCompleted; - - /// - /// Gets a value indicating whether the action has executed completely without throwing an exception. - /// - public bool IsCompletedSuccessfully => this.lazy.IsValueFactoryCompleted && this.lazy.GetValueAsync().Status == TaskStatus.RanToCompletion; - - /// - /// Executes the action given in the constructor if it has not yet been executed, - /// or waits for it to complete if in progress from a prior call. - /// - /// Any exception thrown by the action is rethrown here. - public void Initialize(CancellationToken cancellationToken = default) => this.lazy.GetValue(cancellationToken); - - /// - /// Executes the action given in the constructor if it has not yet been executed, - /// or waits for it to complete if in progress from a prior call. - /// - /// A task that tracks completion of the action. - /// Any exception thrown by the action is rethrown here. - public Task InitializeAsync(CancellationToken cancellationToken = default) => this.lazy.GetValueAsync(cancellationToken); + Requires.NotNull(action, nameof(action)); + this.lazy = new AsyncLazy( + async delegate + { + await action().ConfigureAwaitRunInline(); + return default; + }, + joinableTaskFactory); } + + /// + /// Gets a value indicating whether the action has executed completely, regardless of whether it threw an exception. + /// + public bool IsCompleted => this.lazy.IsValueFactoryCompleted; + + /// + /// Gets a value indicating whether the action has executed completely without throwing an exception. + /// + public bool IsCompletedSuccessfully => this.lazy.IsValueFactoryCompleted && this.lazy.GetValueAsync().Status == TaskStatus.RanToCompletion; + + /// + /// Executes the action given in the constructor if it has not yet been executed, + /// or waits for it to complete if in progress from a prior call. + /// + /// Any exception thrown by the action is rethrown here. + public void Initialize(CancellationToken cancellationToken = default) => this.lazy.GetValue(cancellationToken); + + /// + /// Executes the action given in the constructor if it has not yet been executed, + /// or waits for it to complete if in progress from a prior call. + /// + /// A task that tracks completion of the action. + /// Any exception thrown by the action is rethrown here. + public Task InitializeAsync(CancellationToken cancellationToken = default) => this.lazy.GetValueAsync(cancellationToken); } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 63c38ff52..55a9448cc 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -6,242 +6,241 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A thread-safe, lazily and asynchronously evaluated value factory. +/// +/// The type of value generated by the value factory. +public class AsyncLazy { /// - /// A thread-safe, lazily and asynchronously evaluated value factory. + /// The value set to the field + /// while the value factory is executing. + /// + private static readonly object RecursiveCheckSentinel = new object(); + + /// + /// The object to lock to provide thread-safety. + /// + private readonly object syncObject = new object(); + + /// + /// The unique instance identifier. + /// + private readonly AsyncLocal recursiveFactoryCheck = new AsyncLocal(); + + /// + /// The function to invoke to produce the task. /// - /// The type of value generated by the value factory. - public class AsyncLazy + private Func>? valueFactory; + + /// + /// The async pump to Join on calls to . + /// + private JoinableTaskFactory? jobFactory; + + /// + /// The result of the value factory. + /// + private Task? value; + + /// + /// A joinable task whose result is the value to be cached. + /// + private JoinableTask? joinableTask; + + /// + /// Initializes a new instance of the class. + /// + /// The async function that produces the value. To be invoked at most once. + /// The factory to use when invoking the value factory in to avoid deadlocks when the main thread is required by the value factory. + public AsyncLazy(Func> valueFactory, JoinableTaskFactory? joinableTaskFactory = null) + { + Requires.NotNull(valueFactory, nameof(valueFactory)); + this.valueFactory = valueFactory; + this.jobFactory = joinableTaskFactory; + } + + /// + /// Gets a value indicating whether the value factory has been invoked. + /// + public bool IsValueCreated { - /// - /// The value set to the field - /// while the value factory is executing. - /// - private static readonly object RecursiveCheckSentinel = new object(); - - /// - /// The object to lock to provide thread-safety. - /// - private readonly object syncObject = new object(); - - /// - /// The unique instance identifier. - /// - private readonly AsyncLocal recursiveFactoryCheck = new AsyncLocal(); - - /// - /// The function to invoke to produce the task. - /// - private Func>? valueFactory; - - /// - /// The async pump to Join on calls to . - /// - private JoinableTaskFactory? jobFactory; - - /// - /// The result of the value factory. - /// - private Task? value; - - /// - /// A joinable task whose result is the value to be cached. - /// - private JoinableTask? joinableTask; - - /// - /// Initializes a new instance of the class. - /// - /// The async function that produces the value. To be invoked at most once. - /// The factory to use when invoking the value factory in to avoid deadlocks when the main thread is required by the value factory. - public AsyncLazy(Func> valueFactory, JoinableTaskFactory? joinableTaskFactory = null) + get { - Requires.NotNull(valueFactory, nameof(valueFactory)); - this.valueFactory = valueFactory; - this.jobFactory = joinableTaskFactory; + Interlocked.MemoryBarrier(); + return this.valueFactory is null; } + } - /// - /// Gets a value indicating whether the value factory has been invoked. - /// - public bool IsValueCreated + /// + /// Gets a value indicating whether the value factory has been invoked and has run to completion. + /// + public bool IsValueFactoryCompleted + { + get { - get - { - Interlocked.MemoryBarrier(); - return this.valueFactory is null; - } + Interlocked.MemoryBarrier(); + return this.value is object && this.value.IsCompleted; } + } - /// - /// Gets a value indicating whether the value factory has been invoked and has run to completion. - /// - public bool IsValueFactoryCompleted + /// + /// Gets the task that produces or has produced the value. + /// + /// A task whose result is the lazily constructed value. + /// + /// Thrown when the value factory calls on this instance. + /// + public Task GetValueAsync() => this.GetValueAsync(CancellationToken.None); + + /// + /// Gets the task that produces or has produced the value. + /// + /// + /// A token whose cancellation indicates that the caller no longer is interested in the result. + /// Note that this will not cancel the value factory (since other callers may exist). + /// But this token will result in an expediant cancellation of the returned Task, + /// and a dis-joining of any that may have occurred as a result of this call. + /// + /// A task whose result is the lazily constructed value. + /// + /// Thrown when the value factory calls on this instance. + /// + public Task GetValueAsync(CancellationToken cancellationToken) + { + if (!((this.value is object && this.value.IsCompleted) || this.recursiveFactoryCheck.Value is null)) { - get - { - Interlocked.MemoryBarrier(); - return this.value is object && this.value.IsCompleted; - } + // PERF: we check the condition and *then* retrieve the string resource only on failure + // because the string retrieval has shown up as significant on ETL traces. + Verify.FailOperation(Strings.ValueFactoryReentrancy); } - /// - /// Gets the task that produces or has produced the value. - /// - /// A task whose result is the lazily constructed value. - /// - /// Thrown when the value factory calls on this instance. - /// - public Task GetValueAsync() => this.GetValueAsync(CancellationToken.None); - - /// - /// Gets the task that produces or has produced the value. - /// - /// - /// A token whose cancellation indicates that the caller no longer is interested in the result. - /// Note that this will not cancel the value factory (since other callers may exist). - /// But this token will result in an expediant cancellation of the returned Task, - /// and a dis-joining of any that may have occurred as a result of this call. - /// - /// A task whose result is the lazily constructed value. - /// - /// Thrown when the value factory calls on this instance. - /// - public Task GetValueAsync(CancellationToken cancellationToken) + if (this.value is null) { - if (!((this.value is object && this.value.IsCompleted) || this.recursiveFactoryCheck.Value is null)) + if (Monitor.IsEntered(this.syncObject)) { // PERF: we check the condition and *then* retrieve the string resource only on failure // because the string retrieval has shown up as significant on ETL traces. Verify.FailOperation(Strings.ValueFactoryReentrancy); } - if (this.value is null) + InlineResumable? resumableAwaiter = null; + lock (this.syncObject) { - if (Monitor.IsEntered(this.syncObject)) + // Note that if multiple threads hit GetValueAsync() before + // the valueFactory has completed its synchronous execution, + // then only one thread will execute the valueFactory while the + // other threads synchronously block till the synchronous portion + // has completed. + if (this.value is null) { - // PERF: we check the condition and *then* retrieve the string resource only on failure - // because the string retrieval has shown up as significant on ETL traces. - Verify.FailOperation(Strings.ValueFactoryReentrancy); - } + RoslynDebug.Assert(this.valueFactory is object); - InlineResumable? resumableAwaiter = null; - lock (this.syncObject) - { - // Note that if multiple threads hit GetValueAsync() before - // the valueFactory has completed its synchronous execution, - // then only one thread will execute the valueFactory while the - // other threads synchronously block till the synchronous portion - // has completed. - if (this.value is null) + cancellationToken.ThrowIfCancellationRequested(); + resumableAwaiter = new InlineResumable(); + Func>? originalValueFactory = this.valueFactory; + this.valueFactory = null; + Func> valueFactory = async delegate { - RoslynDebug.Assert(this.valueFactory is object); - - cancellationToken.ThrowIfCancellationRequested(); - resumableAwaiter = new InlineResumable(); - Func>? originalValueFactory = this.valueFactory; - this.valueFactory = null; - Func> valueFactory = async delegate - { - try - { - await resumableAwaiter; - return await originalValueFactory().ConfigureAwaitRunInline(); - } - finally - { - this.jobFactory = null; - this.joinableTask = null; - } - }; - - this.recursiveFactoryCheck.Value = RecursiveCheckSentinel; try { - if (this.jobFactory is object) - { - // Wrapping with RunAsync allows a future caller - // to synchronously block the Main thread waiting for the result - // without leading to deadlocks. - this.joinableTask = this.jobFactory.RunAsync(valueFactory); - this.value = this.joinableTask.Task; - } - else - { - this.value = valueFactory(); - } + await resumableAwaiter; + return await originalValueFactory().ConfigureAwaitRunInline(); } finally { - this.recursiveFactoryCheck.Value = null; + this.jobFactory = null; + this.joinableTask = null; } + }; + + this.recursiveFactoryCheck.Value = RecursiveCheckSentinel; + try + { + if (this.jobFactory is object) + { + // Wrapping with RunAsync allows a future caller + // to synchronously block the Main thread waiting for the result + // without leading to deadlocks. + this.joinableTask = this.jobFactory.RunAsync(valueFactory); + this.value = this.joinableTask.Task; + } + else + { + this.value = valueFactory(); + } + } + finally + { + this.recursiveFactoryCheck.Value = null; } } - - // Allow the original value factory to actually run. - resumableAwaiter?.Resume(); } - if (!this.value.IsCompleted) - { - this.joinableTask?.JoinAsync(cancellationToken).Forget(); - } + // Allow the original value factory to actually run. + resumableAwaiter?.Resume(); + } - return this.value.WithCancellation(cancellationToken); + if (!this.value.IsCompleted) + { + this.joinableTask?.JoinAsync(cancellationToken).Forget(); } - /// - /// Gets the lazily computed value. - /// - /// The lazily constructed value. - /// - /// Thrown when the value factory calls on this instance. - /// - public T GetValue() => this.GetValue(CancellationToken.None); - - /// - /// Gets the lazily computed value. - /// - /// - /// A token whose cancellation indicates that the caller no longer is interested in the result. - /// Note that this will not cancel the value factory (since other callers may exist). - /// But when this token is canceled, the caller will experience an - /// immediately and a dis-joining of any that may have occurred as a result of this call. - /// - /// The lazily constructed value. - /// - /// Thrown when the value factory calls on this instance. - /// - /// Thrown when is canceled before the value is computed. - public T GetValue(CancellationToken cancellationToken) + return this.value.WithCancellation(cancellationToken); + } + + /// + /// Gets the lazily computed value. + /// + /// The lazily constructed value. + /// + /// Thrown when the value factory calls on this instance. + /// + public T GetValue() => this.GetValue(CancellationToken.None); + + /// + /// Gets the lazily computed value. + /// + /// + /// A token whose cancellation indicates that the caller no longer is interested in the result. + /// Note that this will not cancel the value factory (since other callers may exist). + /// But when this token is canceled, the caller will experience an + /// immediately and a dis-joining of any that may have occurred as a result of this call. + /// + /// The lazily constructed value. + /// + /// Thrown when the value factory calls on this instance. + /// + /// Thrown when is canceled before the value is computed. + public T GetValue(CancellationToken cancellationToken) + { + // As a perf optimization, avoid calling JTF or GetValueAsync if the value factory has already completed. + if (this.IsValueFactoryCompleted) { - // As a perf optimization, avoid calling JTF or GetValueAsync if the value factory has already completed. - if (this.IsValueFactoryCompleted) - { - RoslynDebug.Assert(this.value is object); + RoslynDebug.Assert(this.value is object); - return this.value.GetAwaiter().GetResult(); - } - else - { - // Capture the factory as a local before comparing and dereferencing it since - // the field can transition to null and we want to gracefully handle that race condition. - JoinableTaskFactory? factory = this.jobFactory; - return factory is object - ? factory.Run(() => this.GetValueAsync(cancellationToken)) - : this.GetValueAsync(cancellationToken).GetAwaiter().GetResult(); - } + return this.value.GetAwaiter().GetResult(); } - - /// - /// Renders a string describing an uncreated value, or the string representation of the created value. - /// - public override string ToString() + else { - return (this.value is object && this.value.IsCompleted) - ? (this.value.Status == TaskStatus.RanToCompletion ? $"{this.value.Result}" : Strings.LazyValueFaulted) - : Strings.LazyValueNotCreated; + // Capture the factory as a local before comparing and dereferencing it since + // the field can transition to null and we want to gracefully handle that race condition. + JoinableTaskFactory? factory = this.jobFactory; + return factory is object + ? factory.Run(() => this.GetValueAsync(cancellationToken)) + : this.GetValueAsync(cancellationToken).GetAwaiter().GetResult(); } } + + /// + /// Renders a string describing an uncreated value, or the string representation of the created value. + /// + public override string ToString() + { + return (this.value is object && this.value.IsCompleted) + ? (this.value.Status == TaskStatus.RanToCompletion ? $"{this.value.Result}" : Strings.LazyValueFaulted) + : Strings.LazyValueNotCreated; + } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLocal`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLocal`1.cs index fce0490d2..31c7126a2 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLocal`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLocal`1.cs @@ -1,36 +1,35 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Stores references such that they are available for retrieval +/// in the same call context. +/// +/// The type of value to store. +public partial class AsyncLocal + where T : class { /// - /// Stores references such that they are available for retrieval - /// in the same call context. + /// The framework version specific instance of AsyncLocal to use. /// - /// The type of value to store. - public partial class AsyncLocal - where T : class - { - /// - /// The framework version specific instance of AsyncLocal to use. - /// - private readonly System.Threading.AsyncLocal asyncLocal; + private readonly System.Threading.AsyncLocal asyncLocal; - /// - /// Initializes a new instance of the class. - /// - public AsyncLocal() - { - this.asyncLocal = new System.Threading.AsyncLocal(); - } + /// + /// Initializes a new instance of the class. + /// + public AsyncLocal() + { + this.asyncLocal = new System.Threading.AsyncLocal(); + } - /// - /// Gets or sets the value to associate with the current CallContext. - /// - public T? Value - { - get { return this.asyncLocal.Value; } - set { this.asyncLocal.Value = value; } - } + /// + /// Gets or sets the value to associate with the current CallContext. + /// + public T? Value + { + get { return this.asyncLocal.Value; } + set { this.asyncLocal.Value = value; } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs index 57531b5ec..4bbab53a0 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs @@ -11,233 +11,232 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A flavor of that can be asynchronously awaited on. +/// +[DebuggerDisplay("Signaled: {IsSet}")] +public class AsyncManualResetEvent { /// - /// A flavor of that can be asynchronously awaited on. + /// Whether the task completion source should allow executing continuations synchronously. /// - [DebuggerDisplay("Signaled: {IsSet}")] - public class AsyncManualResetEvent - { - /// - /// Whether the task completion source should allow executing continuations synchronously. - /// - private readonly bool allowInliningAwaiters; - - /// - /// The object to lock when accessing fields. - /// - private readonly object syncObject = new object(); - - /// - /// The source of the task to return from . - /// - /// - /// This should not need the volatile modifier because it is - /// always accessed within a lock. - /// - private TaskCompletionSourceWithoutInlining taskCompletionSource; - - /// - /// A flag indicating whether the event is signaled. - /// When this is set to true, it's possible that - /// .Task.IsCompleted is still false - /// if the completion has been scheduled asynchronously. - /// Thus, this field should be the definitive answer as to whether - /// the event is signaled because it is synchronously updated. - /// - /// - /// This should not need the volatile modifier because it is - /// always accessed within a lock. - /// - private bool isSet; - - /// - /// Initializes a new instance of the class. - /// - /// A value indicating whether the event should be initially signaled. - /// - /// A value indicating whether to allow callers' continuations to execute - /// on the thread that calls before the call returns. - /// callers should not hold private locks if this value is to avoid deadlocks. - /// When , the task returned from may not have fully transitioned to - /// its completed state by the time returns to its caller. - /// - public AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) - { - this.allowInliningAwaiters = allowInliningAwaiters; + private readonly bool allowInliningAwaiters; - this.taskCompletionSource = this.CreateTaskSource(); - this.isSet = initialState; - if (initialState) - { - this.taskCompletionSource.SetResult(EmptyStruct.Instance); - } - } + /// + /// The object to lock when accessing fields. + /// + private readonly object syncObject = new object(); + + /// + /// The source of the task to return from . + /// + /// + /// This should not need the volatile modifier because it is + /// always accessed within a lock. + /// + private TaskCompletionSourceWithoutInlining taskCompletionSource; - /// - /// Gets a value indicating whether the event is currently in a signaled state. - /// - public bool IsSet + /// + /// A flag indicating whether the event is signaled. + /// When this is set to true, it's possible that + /// .Task.IsCompleted is still false + /// if the completion has been scheduled asynchronously. + /// Thus, this field should be the definitive answer as to whether + /// the event is signaled because it is synchronously updated. + /// + /// + /// This should not need the volatile modifier because it is + /// always accessed within a lock. + /// + private bool isSet; + + /// + /// Initializes a new instance of the class. + /// + /// A value indicating whether the event should be initially signaled. + /// + /// A value indicating whether to allow callers' continuations to execute + /// on the thread that calls before the call returns. + /// callers should not hold private locks if this value is to avoid deadlocks. + /// When , the task returned from may not have fully transitioned to + /// its completed state by the time returns to its caller. + /// + public AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) + { + this.allowInliningAwaiters = allowInliningAwaiters; + + this.taskCompletionSource = this.CreateTaskSource(); + this.isSet = initialState; + if (initialState) { - get - { - lock (this.syncObject) - { - return this.isSet; - } - } + this.taskCompletionSource.SetResult(EmptyStruct.Instance); } + } - /// - /// Returns a task that will be completed when this event is set. - /// - public Task WaitAsync() + /// + /// Gets a value indicating whether the event is currently in a signaled state. + /// + public bool IsSet + { + get { lock (this.syncObject) { - return this.taskCompletionSource.Task; + return this.isSet; } } + } - /// - /// Returns a task that will be completed when this event is set. - /// - /// A cancellation token. - /// A task that completes when the event is set, or cancels with the . - public Task WaitAsync(CancellationToken cancellationToken) => this.WaitAsync().WithCancellation(cancellationToken); - - /// - /// Sets this event to unblock callers of . - /// - /// A task that completes when the signal has been set. - /// - /// - /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). - /// The returned task completes when the signal has definitely been set. - /// - /// - /// On .NET 4.6 and later: - /// This method is not asynchronous. The returned Task is always completed. - /// - /// - [Obsolete("Use Set() instead."), EditorBrowsable(EditorBrowsableState.Never)] - public Task SetAsync() + /// + /// Returns a task that will be completed when this event is set. + /// + public Task WaitAsync() + { + lock (this.syncObject) { - TaskCompletionSourceWithoutInlining? tcs = null; - bool transitionRequired = false; - lock (this.syncObject) - { - transitionRequired = !this.isSet; - tcs = this.taskCompletionSource; - this.isSet = true; - } - - // Snap the Task that is exposed to the outside so we return that one. - // Once we complete the TaskCompletionSourceWithoutInlinining's task, - // the Task property will return the inner Task. - // SetAsync should return the same Task that WaitAsync callers would have observed previously. - Task result = tcs.Task; - - if (transitionRequired) - { - tcs.TrySetResult(default(EmptyStruct)); - } - - return result; + return this.taskCompletionSource.Task; } + } + + /// + /// Returns a task that will be completed when this event is set. + /// + /// A cancellation token. + /// A task that completes when the event is set, or cancels with the . + public Task WaitAsync(CancellationToken cancellationToken) => this.WaitAsync().WithCancellation(cancellationToken); - /// - /// Sets this event to unblock callers of . - /// - public void Set() + /// + /// Sets this event to unblock callers of . + /// + /// A task that completes when the signal has been set. + /// + /// + /// On .NET versions prior to 4.6: + /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). + /// The returned task completes when the signal has definitely been set. + /// + /// + /// On .NET 4.6 and later: + /// This method is not asynchronous. The returned Task is always completed. + /// + /// + [Obsolete("Use Set() instead."), EditorBrowsable(EditorBrowsableState.Never)] + public Task SetAsync() + { + TaskCompletionSourceWithoutInlining? tcs = null; + bool transitionRequired = false; + lock (this.syncObject) { -#pragma warning disable CS0618 // Type or member is obsolete - this.SetAsync(); -#pragma warning restore CS0618 // Type or member is obsolete + transitionRequired = !this.isSet; + tcs = this.taskCompletionSource; + this.isSet = true; } - /// - /// Resets this event to a state that will block callers of . - /// - public void Reset() + // Snap the Task that is exposed to the outside so we return that one. + // Once we complete the TaskCompletionSourceWithoutInlinining's task, + // the Task property will return the inner Task. + // SetAsync should return the same Task that WaitAsync callers would have observed previously. + Task result = tcs.Task; + + if (transitionRequired) { - lock (this.syncObject) - { - if (this.isSet) - { - this.taskCompletionSource = this.CreateTaskSource(); - this.isSet = false; - } - } + tcs.TrySetResult(default(EmptyStruct)); } - /// - /// Sets and immediately resets this event, allowing all current waiters to unblock. - /// - /// A task that completes when the signal has been set. - /// - /// - /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). - /// The returned task completes when the signal has definitely been set. - /// - /// - /// On .NET 4.6 and later: - /// This method is not asynchronous. The returned Task is always completed. - /// - /// - [Obsolete("Use PulseAll() instead."), EditorBrowsable(EditorBrowsableState.Never)] - public Task PulseAllAsync() + return result; + } + + /// + /// Sets this event to unblock callers of . + /// + public void Set() + { +#pragma warning disable CS0618 // Type or member is obsolete + this.SetAsync(); +#pragma warning restore CS0618 // Type or member is obsolete + } + + /// + /// Resets this event to a state that will block callers of . + /// + public void Reset() + { + lock (this.syncObject) { - TaskCompletionSourceWithoutInlining? tcs = null; - lock (this.syncObject) + if (this.isSet) { - // Atomically replace the completion source with a new, uncompleted source - // while capturing the previous one so we can complete it. - // This ensures that we don't leave a gap in time where WaitAsync() will - // continue to return completed Tasks due to a Pulse method which should - // execute instantaneously. - tcs = this.taskCompletionSource; this.taskCompletionSource = this.CreateTaskSource(); this.isSet = false; } - - // Snap the Task that is exposed to the outside so we return that one. - // Once we complete the TaskCompletionSourceWithoutInlinining's task, - // the Task property will return the inner Task. - // PulseAllAsync should return the same Task that WaitAsync callers would have observed previously. - Task result = tcs.Task; - tcs.TrySetResult(default(EmptyStruct)); - return result; } + } - /// - /// Sets and immediately resets this event, allowing all current waiters to unblock. - /// - public void PulseAll() + /// + /// Sets and immediately resets this event, allowing all current waiters to unblock. + /// + /// A task that completes when the signal has been set. + /// + /// + /// On .NET versions prior to 4.6: + /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). + /// The returned task completes when the signal has definitely been set. + /// + /// + /// On .NET 4.6 and later: + /// This method is not asynchronous. The returned Task is always completed. + /// + /// + [Obsolete("Use PulseAll() instead."), EditorBrowsable(EditorBrowsableState.Never)] + public Task PulseAllAsync() + { + TaskCompletionSourceWithoutInlining? tcs = null; + lock (this.syncObject) { + // Atomically replace the completion source with a new, uncompleted source + // while capturing the previous one so we can complete it. + // This ensures that we don't leave a gap in time where WaitAsync() will + // continue to return completed Tasks due to a Pulse method which should + // execute instantaneously. + tcs = this.taskCompletionSource; + this.taskCompletionSource = this.CreateTaskSource(); + this.isSet = false; + } + + // Snap the Task that is exposed to the outside so we return that one. + // Once we complete the TaskCompletionSourceWithoutInlinining's task, + // the Task property will return the inner Task. + // PulseAllAsync should return the same Task that WaitAsync callers would have observed previously. + Task result = tcs.Task; + tcs.TrySetResult(default(EmptyStruct)); + return result; + } + + /// + /// Sets and immediately resets this event, allowing all current waiters to unblock. + /// + public void PulseAll() + { #pragma warning disable CS0618 // Type or member is obsolete - this.PulseAllAsync(); + this.PulseAllAsync(); #pragma warning restore CS0618 // Type or member is obsolete - } + } - /// - /// Gets an awaiter that completes when this event is signaled. - /// - [EditorBrowsable(EditorBrowsableState.Never)] - public TaskAwaiter GetAwaiter() - { - return this.WaitAsync().GetAwaiter(); - } + /// + /// Gets an awaiter that completes when this event is signaled. + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public TaskAwaiter GetAwaiter() + { + return this.WaitAsync().GetAwaiter(); + } - /// - /// Creates a new TaskCompletionSource to represent an unset event. - /// - private TaskCompletionSourceWithoutInlining CreateTaskSource() - { - return new TaskCompletionSourceWithoutInlining(this.allowInliningAwaiters); - } + /// + /// Creates a new TaskCompletionSource to represent an unset event. + /// + private TaskCompletionSourceWithoutInlining CreateTaskSource() + { + return new TaskCompletionSourceWithoutInlining(this.allowInliningAwaiters); } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs index d9ab19093..6a7a1b5ed 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs @@ -10,449 +10,448 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A thread-safe, asynchronously dequeuable queue. +/// +/// The type of values kept by the queue. +[DebuggerDisplay("Count = {Count}, Completed = {completeSignaled}")] +public class AsyncQueue : ThreadingTools.ICancellationNotification { /// - /// A thread-safe, asynchronously dequeuable queue. + /// The source of the task returned by . Lazily constructed. /// - /// The type of values kept by the queue. - [DebuggerDisplay("Count = {Count}, Completed = {completeSignaled}")] - public class AsyncQueue : ThreadingTools.ICancellationNotification + /// + /// Volatile to allow the check-lock-check pattern in to be reliable, + /// in the event that within the lock, one thread initializes the value and assigns the field + /// and the weak memory model allows the assignment prior to the initialization. Another thread + /// outside the lock might observe the non-null field and start accessing the Task property + /// before it is actually initialized. Volatile prevents CPU reordering of commands around + /// the assignment (or read) of this field. + /// + private volatile TaskCompletionSource? completedSource; + + /// + /// The internal queue of elements. Lazily constructed. + /// + private Queue? queueElements; + + /// + /// The internal queue of waiters. Lazily constructed. + /// + private Queue>? dequeuingWaiters; + + /// + /// A value indicating whether has been called. + /// + private bool completeSignaled; + + /// + /// A flag indicating whether the has been invoked. + /// + private bool onCompletedInvoked; + + /// + /// Initializes a new instance of the class. + /// + public AsyncQueue() { - /// - /// The source of the task returned by . Lazily constructed. - /// - /// - /// Volatile to allow the check-lock-check pattern in to be reliable, - /// in the event that within the lock, one thread initializes the value and assigns the field - /// and the weak memory model allows the assignment prior to the initialization. Another thread - /// outside the lock might observe the non-null field and start accessing the Task property - /// before it is actually initialized. Volatile prevents CPU reordering of commands around - /// the assignment (or read) of this field. - /// - private volatile TaskCompletionSource? completedSource; - - /// - /// The internal queue of elements. Lazily constructed. - /// - private Queue? queueElements; - - /// - /// The internal queue of waiters. Lazily constructed. - /// - private Queue>? dequeuingWaiters; - - /// - /// A value indicating whether has been called. - /// - private bool completeSignaled; - - /// - /// A flag indicating whether the has been invoked. - /// - private bool onCompletedInvoked; - - /// - /// Initializes a new instance of the class. - /// - public AsyncQueue() - { - } + } - /// - /// Gets a value indicating whether the queue is currently empty. - /// - public bool IsEmpty - { - get { return this.Count == 0; } - } + /// + /// Gets a value indicating whether the queue is currently empty. + /// + public bool IsEmpty + { + get { return this.Count == 0; } + } - /// - /// Gets the number of elements currently in the queue. - /// - public int Count + /// + /// Gets the number of elements currently in the queue. + /// + public int Count + { + get { - get + lock (this.SyncRoot) { - lock (this.SyncRoot) - { - return this.queueElements?.Count ?? 0; - } + return this.queueElements?.Count ?? 0; } } + } - /// - /// Gets a value indicating whether the queue has completed. - /// - /// - /// This is arguably redundant with .IsCompleted, but this property - /// won't cause the lazy instantiation of the Task that may if there - /// is no other reason for the Task to exist. - /// - public bool IsCompleted + /// + /// Gets a value indicating whether the queue has completed. + /// + /// + /// This is arguably redundant with .IsCompleted, but this property + /// won't cause the lazy instantiation of the Task that may if there + /// is no other reason for the Task to exist. + /// + public bool IsCompleted + { + get { - get + lock (this.SyncRoot) { - lock (this.SyncRoot) - { - return this.completeSignaled && this.IsEmpty; - } + return this.completeSignaled && this.IsEmpty; } } + } - /// - /// Gets a task that transitions to a completed state when is called. - /// - public Task Completion + /// + /// Gets a task that transitions to a completed state when is called. + /// + public Task Completion + { + get { - get + if (this.completedSource is null) { - if (this.completedSource is null) + lock (this.SyncRoot) { - lock (this.SyncRoot) + if (this.completedSource is null) { - if (this.completedSource is null) + if (this.IsCompleted) + { + return Task.CompletedTask; + } + else { - if (this.IsCompleted) - { - return Task.CompletedTask; - } - else - { - this.completedSource = new TaskCompletionSource(); - } + this.completedSource = new TaskCompletionSource(); } } } - - return this.completedSource.Task; } + + return this.completedSource.Task; } + } - /// - /// Gets the synchronization object used by this queue. - /// - protected object SyncRoot => this; // save allocations by using this instead of a new object. + /// + /// Gets the synchronization object used by this queue. + /// + protected object SyncRoot => this; // save allocations by using this instead of a new object. - /// - /// Gets the initial capacity for the queue. - /// - protected virtual int InitialCapacity => 4; + /// + /// Gets the initial capacity for the queue. + /// + protected virtual int InitialCapacity => 4; - /// - /// Signals that no further elements will be enqueued. - /// - public void Complete() + /// + /// Signals that no further elements will be enqueued. + /// + public void Complete() + { + lock (this.SyncRoot) { - lock (this.SyncRoot) - { - this.completeSignaled = true; - } - - this.CompleteIfNecessary(); + this.completeSignaled = true; } - /// - /// Adds an element to the tail of the queue. - /// - /// The value to add. - public void Enqueue(T value) + this.CompleteIfNecessary(); + } + + /// + /// Adds an element to the tail of the queue. + /// + /// The value to add. + public void Enqueue(T value) + { + if (!this.TryEnqueue(value)) { - if (!this.TryEnqueue(value)) - { - Verify.FailOperation(Strings.InvalidAfterCompleted); - } + Verify.FailOperation(Strings.InvalidAfterCompleted); } + } - /// - /// Adds an element to the tail of the queue if it has not yet completed. - /// - /// The value to add. - /// if the value was added to the queue; if the queue is already completed. - public bool TryEnqueue(T value) + /// + /// Adds an element to the tail of the queue if it has not yet completed. + /// + /// The value to add. + /// if the value was added to the queue; if the queue is already completed. + public bool TryEnqueue(T value) + { + bool alreadyDispatched = false; + lock (this.SyncRoot) { - bool alreadyDispatched = false; - lock (this.SyncRoot) + if (this.completeSignaled) { - if (this.completeSignaled) - { - return false; - } + return false; + } - // Is a dequeuer waiting for this? - while (this.dequeuingWaiters?.Count > 0) + // Is a dequeuer waiting for this? + while (this.dequeuingWaiters?.Count > 0) + { + TaskCompletionSource waitingDequeuer = this.dequeuingWaiters.Dequeue(); + if (waitingDequeuer.TrySetResult(value)) { - TaskCompletionSource waitingDequeuer = this.dequeuingWaiters.Dequeue(); - if (waitingDequeuer.TrySetResult(value)) - { - alreadyDispatched = true; - break; - } + alreadyDispatched = true; + break; } + } - this.FreeCanceledDequeuers(); + this.FreeCanceledDequeuers(); - if (!alreadyDispatched) + if (!alreadyDispatched) + { + if (this.queueElements is null) { - if (this.queueElements is null) - { - this.queueElements = new Queue(this.InitialCapacity); - } - - this.queueElements.Enqueue(value); + this.queueElements = new Queue(this.InitialCapacity); } + + this.queueElements.Enqueue(value); } + } - this.OnEnqueued(value, alreadyDispatched); + this.OnEnqueued(value, alreadyDispatched); - return true; - } + return true; + } - /// - /// Gets the value at the head of the queue without removing it from the queue, if it is non-empty. - /// - /// Receives the value at the head of the queue; or the default value for the element type if the queue is empty. - /// if the queue was non-empty; otherwise. - public bool TryPeek([MaybeNullWhen(false)] out T value) + /// + /// Gets the value at the head of the queue without removing it from the queue, if it is non-empty. + /// + /// Receives the value at the head of the queue; or the default value for the element type if the queue is empty. + /// if the queue was non-empty; otherwise. + public bool TryPeek([MaybeNullWhen(false)] out T value) + { + lock (this.SyncRoot) { - lock (this.SyncRoot) + if (this.queueElements is object && this.queueElements.Count > 0) { - if (this.queueElements is object && this.queueElements.Count > 0) - { - value = this.queueElements.Peek(); - return true; - } - else - { - value = default(T)!; - return false; - } + value = this.queueElements.Peek(); + return true; + } + else + { + value = default(T)!; + return false; } } + } - /// - /// Gets the value at the head of the queue without removing it from the queue. - /// - /// Thrown if the queue is empty. - public T Peek() - { + /// + /// Gets the value at the head of the queue without removing it from the queue. + /// + /// Thrown if the queue is empty. + public T Peek() + { #pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - if (!this.TryPeek(out T? value)) + if (!this.TryPeek(out T? value)) #pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - { - Verify.FailOperation(Strings.QueueEmpty); - } + { + Verify.FailOperation(Strings.QueueEmpty); + } - return value; + return value; + } + + /// + /// Gets a task whose result is the element at the head of the queue. + /// + /// + /// A token whose cancellation signals lost interest in the item. + /// Cancelling this token does *not* guarantee that the task will be canceled + /// before it is assigned a resulting element from the head of the queue. + /// It is the responsibility of the caller to ensure after cancellation that + /// either the task is canceled, or it has a result which the caller is responsible + /// for then handling. + /// + /// A task whose result is the head element. + /// + /// Thrown when this instance has an empty queue and has been called. + /// Also thrown when is canceled before a work item can be dequeued. + /// + public Task DequeueAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + if (cancellationToken.IsCancellationRequested) + { + return Task.FromCanceled(cancellationToken); } - /// - /// Gets a task whose result is the element at the head of the queue. - /// - /// - /// A token whose cancellation signals lost interest in the item. - /// Cancelling this token does *not* guarantee that the task will be canceled - /// before it is assigned a resulting element from the head of the queue. - /// It is the responsibility of the caller to ensure after cancellation that - /// either the task is canceled, or it has a result which the caller is responsible - /// for then handling. - /// - /// A task whose result is the head element. - /// - /// Thrown when this instance has an empty queue and has been called. - /// Also thrown when is canceled before a work item can be dequeued. - /// - public Task DequeueAsync(CancellationToken cancellationToken = default(CancellationToken)) + T result; + lock (this.SyncRoot) { - if (cancellationToken.IsCancellationRequested) + if (this.IsCompleted) { - return Task.FromCanceled(cancellationToken); + return TplExtensions.CanceledTaskOfT(); } - T result; - lock (this.SyncRoot) + if (this.queueElements?.Count > 0) { - if (this.IsCompleted) - { - return TplExtensions.CanceledTaskOfT(); - } - - if (this.queueElements?.Count > 0) + result = this.queueElements.Dequeue(); + } + else + { + if (this.dequeuingWaiters is null) { - result = this.queueElements.Dequeue(); + this.dequeuingWaiters = new Queue>(capacity: 2); } else { - if (this.dequeuingWaiters is null) - { - this.dequeuingWaiters = new Queue>(capacity: 2); - } - else - { - this.FreeCanceledDequeuers(); - } - - var waiterTcs = new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); - waiterTcs.AttachCancellation(cancellationToken, this); - this.dequeuingWaiters.Enqueue(waiterTcs); - return waiterTcs.Task; + this.FreeCanceledDequeuers(); } - } - this.CompleteIfNecessary(); - return Task.FromResult(result); + var waiterTcs = new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); + waiterTcs.AttachCancellation(cancellationToken, this); + this.dequeuingWaiters.Enqueue(waiterTcs); + return waiterTcs.Task; + } } - /// - /// Immediately dequeues the element from the head of the queue if one is available, - /// otherwise returns without an element. - /// - /// Receives the element from the head of the queue; or default(T) if the queue is empty. - /// if an element was dequeued; if the queue was empty. - public bool TryDequeue([MaybeNullWhen(false)] out T value) - { + this.CompleteIfNecessary(); + return Task.FromResult(result); + } + + /// + /// Immediately dequeues the element from the head of the queue if one is available, + /// otherwise returns without an element. + /// + /// Receives the element from the head of the queue; or default(T) if the queue is empty. + /// if an element was dequeued; if the queue was empty. + public bool TryDequeue([MaybeNullWhen(false)] out T value) + { #pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - bool result = this.TryDequeueInternal(null, out value); + bool result = this.TryDequeueInternal(null, out value); #pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - this.CompleteIfNecessary(); - return result; - } + this.CompleteIfNecessary(); + return result; + } - /// - void ThreadingTools.ICancellationNotification.OnCanceled() => this.FreeCanceledDequeuers(); + /// + void ThreadingTools.ICancellationNotification.OnCanceled() => this.FreeCanceledDequeuers(); - /// - /// Returns a copy of this queue as an array. - /// - public T[] ToArray() + /// + /// Returns a copy of this queue as an array. + /// + public T[] ToArray() + { + lock (this.SyncRoot) { - lock (this.SyncRoot) - { - return this.queueElements?.ToArray() ?? Array.Empty(); - } + return this.queueElements?.ToArray() ?? Array.Empty(); } + } - /// - /// Immediately dequeues the element from the head of the queue if one is available - /// that satisfies the specified check; - /// otherwise returns without an element. - /// - /// The test on the head element that must succeed to dequeue. - /// Receives the element from the head of the queue; or default(T) if the queue is empty. - /// if an element was dequeued; if the queue was empty. - protected bool TryDequeue(Predicate valueCheck, [MaybeNullWhen(false)] out T value) - { - Requires.NotNull(valueCheck, nameof(valueCheck)); + /// + /// Immediately dequeues the element from the head of the queue if one is available + /// that satisfies the specified check; + /// otherwise returns without an element. + /// + /// The test on the head element that must succeed to dequeue. + /// Receives the element from the head of the queue; or default(T) if the queue is empty. + /// if an element was dequeued; if the queue was empty. + protected bool TryDequeue(Predicate valueCheck, [MaybeNullWhen(false)] out T value) + { + Requires.NotNull(valueCheck, nameof(valueCheck)); #pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - bool result = this.TryDequeueInternal(valueCheck, out value); + bool result = this.TryDequeueInternal(valueCheck, out value); #pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - this.CompleteIfNecessary(); - return result; - } + this.CompleteIfNecessary(); + return result; + } - /// - /// Invoked when a value is enqueued. - /// - /// The enqueued value. - /// - /// if the item will skip the queue because a dequeuer was already waiting for an item; - /// if the item was actually added to the queue. - /// - protected virtual void OnEnqueued(T value, bool alreadyDispatched) - { - } + /// + /// Invoked when a value is enqueued. + /// + /// The enqueued value. + /// + /// if the item will skip the queue because a dequeuer was already waiting for an item; + /// if the item was actually added to the queue. + /// + protected virtual void OnEnqueued(T value, bool alreadyDispatched) + { + } - /// - /// Invoked when a value is dequeued. - /// - /// The dequeued value. - protected virtual void OnDequeued(T value) - { - } + /// + /// Invoked when a value is dequeued. + /// + /// The dequeued value. + protected virtual void OnDequeued(T value) + { + } - /// - /// Invoked when the queue is completed. - /// - protected virtual void OnCompleted() - { - } + /// + /// Invoked when the queue is completed. + /// + protected virtual void OnCompleted() + { + } - /// - /// Immediately dequeues the element from the head of the queue if one is available, - /// otherwise returns without an element. - /// - /// The test on the head element that must succeed to dequeue. - /// Receives the element from the head of the queue; or default(T) if the queue is empty. - /// if an element was dequeued; if the queue was empty. - private bool TryDequeueInternal(Predicate? valueCheck, [MaybeNullWhen(false)] out T value) + /// + /// Immediately dequeues the element from the head of the queue if one is available, + /// otherwise returns without an element. + /// + /// The test on the head element that must succeed to dequeue. + /// Receives the element from the head of the queue; or default(T) if the queue is empty. + /// if an element was dequeued; if the queue was empty. + private bool TryDequeueInternal(Predicate? valueCheck, [MaybeNullWhen(false)] out T value) + { + bool dequeued; + lock (this.SyncRoot) { - bool dequeued; - lock (this.SyncRoot) + if (this.queueElements is object && this.queueElements.Count > 0 && (valueCheck is null || valueCheck(this.queueElements.Peek()))) { - if (this.queueElements is object && this.queueElements.Count > 0 && (valueCheck is null || valueCheck(this.queueElements.Peek()))) - { - value = this.queueElements.Dequeue(); - dequeued = true; - } - else - { - value = default(T)!; - dequeued = false; - } + value = this.queueElements.Dequeue(); + dequeued = true; } - - if (dequeued) + else { - this.OnDequeued(value); + value = default(T)!; + dequeued = false; } - - return dequeued; } - /// - /// Transitions this queue to a completed state if signaled and the queue is empty. - /// - private void CompleteIfNecessary() + if (dequeued) { - Assumes.False(Monitor.IsEntered(this.SyncRoot)); // important because we'll transition a task to complete. + this.OnDequeued(value); + } - bool transitionTaskSource, invokeOnCompleted = false; - lock (this.SyncRoot) + return dequeued; + } + + /// + /// Transitions this queue to a completed state if signaled and the queue is empty. + /// + private void CompleteIfNecessary() + { + Assumes.False(Monitor.IsEntered(this.SyncRoot)); // important because we'll transition a task to complete. + + bool transitionTaskSource, invokeOnCompleted = false; + lock (this.SyncRoot) + { + transitionTaskSource = this.completeSignaled && (this.queueElements is null || this.queueElements.Count == 0); + if (transitionTaskSource) { - transitionTaskSource = this.completeSignaled && (this.queueElements is null || this.queueElements.Count == 0); - if (transitionTaskSource) + invokeOnCompleted = !this.onCompletedInvoked; + this.onCompletedInvoked = true; + while (this.dequeuingWaiters?.Count > 0) { - invokeOnCompleted = !this.onCompletedInvoked; - this.onCompletedInvoked = true; - while (this.dequeuingWaiters?.Count > 0) - { - this.dequeuingWaiters.Dequeue().TrySetCanceled(); - } + this.dequeuingWaiters.Dequeue().TrySetCanceled(); } } + } - if (transitionTaskSource) + if (transitionTaskSource) + { + this.completedSource?.TrySetResult(null); + if (invokeOnCompleted) { - this.completedSource?.TrySetResult(null); - if (invokeOnCompleted) - { - this.OnCompleted(); - } + this.OnCompleted(); } } + } - /// - /// Clears as many canceled dequeuers as we can from the head of the waiting queue. - /// - private void FreeCanceledDequeuers() + /// + /// Clears as many canceled dequeuers as we can from the head of the waiting queue. + /// + private void FreeCanceledDequeuers() + { + lock (this.SyncRoot) { - lock (this.SyncRoot) + while (this.dequeuingWaiters?.Count > 0 && this.dequeuingWaiters.Peek().Task.IsCompleted) { - while (this.dequeuingWaiters?.Count > 0 && this.dequeuingWaiters.Peek().Task.IsCompleted) - { - this.dequeuingWaiters.Dequeue(); - } + this.dequeuingWaiters.Dequeue(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index d5fa4c8ec..4960f2b84 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -11,2769 +11,2798 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A non-blocking lock that allows concurrent access, exclusive access, or concurrent with upgradeability to exclusive access. +/// +/// +/// We have to use a custom awaitable rather than simply returning Task{LockReleaser} because +/// we have to set CallContext data in the context of the person receiving the lock, +/// which requires that we get to execute code at the start of the continuation (whether we yield or not). +/// +/// +/// Considering this class to be a state machine, the states are: +/// +/// READERS +/// | IDLE | <-----> UPGRADEABLE READER + READERS -----> UPGRADED WRITER --\ +/// | NO LOCKS | ^ | +/// | | |--- RE-ENTER CONCURRENCY PREP <--/ +/// | | <-----> WRITER +/// ------------- +/// ]]> +/// +/// +public partial class AsyncReaderWriterLock : IDisposable { /// - /// A non-blocking lock that allows concurrent access, exclusive access, or concurrent with upgradeability to exclusive access. + /// A time delay to check whether pending writer lock and reader locks forms a deadlock. + /// + private static readonly TimeSpan DefaultDeadlockCheckTimeout = TimeSpan.FromSeconds(3); + + /// + /// The default SynchronizationContext to schedule work after issuing a lock. + /// + private static readonly SynchronizationContext DefaultSynchronizationContext = new SynchronizationContext(); + + /// + /// The object to acquire a Monitor-style lock on for all field access on this instance. + /// + private readonly object syncObject = new object(); + + /// + /// A JoinableTaskContext used to resolve dependencies between read locks to lead into deadlocks when there is a pending write lock. + /// + private readonly JoinableTaskContext? joinableTaskContext; + + /// + /// A CallContext-local reference to the Awaiter that is on the top of the stack (most recently acquired). + /// + private readonly AsyncLocal topAwaiter = new AsyncLocal(); + + /// + /// The set of read locks that are issued and active. /// /// - /// We have to use a custom awaitable rather than simply returning Task{LockReleaser} because - /// we have to set CallContext data in the context of the person receiving the lock, - /// which requires that we get to execute code at the start of the continuation (whether we yield or not). + /// Many readers are allowed concurrently. Also, readers may re-enter read locks (recursively) + /// each of which gets an element in this set. /// - /// - /// Considering this class to be a state machine, the states are: - /// - /// READERS - /// | IDLE | <-----> UPGRADEABLE READER + READERS -----> UPGRADED WRITER --\ - /// | NO LOCKS | ^ | - /// | | |--- RE-ENTER CONCURRENCY PREP <--/ - /// | | <-----> WRITER - /// ------------- - /// ]]> - /// - /// - public partial class AsyncReaderWriterLock : IDisposable - { - /// - /// A time delay to check whether pending writer lock and reader locks forms a deadlock. - /// - private static readonly TimeSpan DefaultDeadlockCheckTimeout = TimeSpan.FromSeconds(3); + private readonly HashSet issuedReadLocks = new HashSet(); - /// - /// The default SynchronizationContext to schedule work after issuing a lock. - /// - private static readonly SynchronizationContext DefaultSynchronizationContext = new SynchronizationContext(); + /// + /// The set of upgradeable read locks that are issued and active. + /// + /// + /// Although only one upgradeable read lock can be held at a time, this set may have more + /// than one element because that one lock holder may enter the lock it already possesses + /// multiple times. + /// + private readonly HashSet issuedUpgradeableReadLocks = new HashSet(); - /// - /// The object to acquire a Monitor-style lock on for all field access on this instance. - /// - private readonly object syncObject = new object(); + /// + /// The set of write locks that are issued and active. + /// + /// + /// Although only one write lock can be held at a time, this set may have more + /// than one element because that one lock holder may enter the lock it already possesses + /// multiple times. + /// Although this lock is mutually exclusive, there *may* be elements in the + /// set if the write lock was upgraded from a reader. + /// Also note that some elements in this may themselves be upgradeable readers if they have + /// the flag. + /// + private readonly HashSet issuedWriteLocks = new HashSet(); - /// - /// A JoinableTaskContext used to resolve dependencies between read locks to lead into deadlocks when there is a pending write lock. - /// - private readonly JoinableTaskContext? joinableTaskContext; + /// + /// A queue of readers waiting to obtain the concurrent read lock. + /// + private readonly Queue waitingReaders = new Queue(); - /// - /// A CallContext-local reference to the Awaiter that is on the top of the stack (most recently acquired). - /// - private readonly AsyncLocal topAwaiter = new AsyncLocal(); + /// + /// A queue of upgradeable readers waiting to obtain a lock. + /// + private readonly Queue waitingUpgradeableReaders = new Queue(); - /// - /// The set of read locks that are issued and active. - /// - /// - /// Many readers are allowed concurrently. Also, readers may re-enter read locks (recursively) - /// each of which gets an element in this set. - /// - private readonly HashSet issuedReadLocks = new HashSet(); + /// + /// A queue of writers waiting to obtain an exclusive lock. + /// + private readonly Queue waitingWriters = new Queue(); - /// - /// The set of upgradeable read locks that are issued and active. - /// - /// - /// Although only one upgradeable read lock can be held at a time, this set may have more - /// than one element because that one lock holder may enter the lock it already possesses - /// multiple times. - /// - private readonly HashSet issuedUpgradeableReadLocks = new HashSet(); + /// + /// The source of the task, which transitions to completed after + /// the method is called and all issued locks have been released. + /// + private readonly TaskCompletionSource completionSource = new TaskCompletionSource(); - /// - /// The set of write locks that are issued and active. - /// - /// - /// Although only one write lock can be held at a time, this set may have more - /// than one element because that one lock holder may enter the lock it already possesses - /// multiple times. - /// Although this lock is mutually exclusive, there *may* be elements in the - /// set if the write lock was upgraded from a reader. - /// Also note that some elements in this may themselves be upgradeable readers if they have - /// the flag. - /// - private readonly HashSet issuedWriteLocks = new HashSet(); + /// + /// The queue of callbacks to invoke when the currently held write lock is totally released. + /// + /// + /// If the write lock is released to an upgradeable read lock, these callbacks are fired synchronously + /// with respect to the writer who is releasing the lock. Otherwise, the callbacks are invoked + /// asynchronously with respect to the releasing thread. + /// + private readonly Queue> beforeWriteReleasedCallbacks = new Queue>(); - /// - /// A queue of readers waiting to obtain the concurrent read lock. - /// - private readonly Queue waitingReaders = new Queue(); + /// + /// A value indicating whether extra resources should be spent to collect diagnostic information + /// that may be useful in deadlock investigations. + /// + private bool captureDiagnostics; - /// - /// A queue of upgradeable readers waiting to obtain a lock. - /// - private readonly Queue waitingUpgradeableReaders = new Queue(); + /// + /// A flag indicating whether we're currently running code to prepare for re-entering concurrency mode + /// after releasing an exclusive lock. The Awaiter being released is the non-null value. + /// + private volatile Awaiter? reenterConcurrencyPrepRunning; - /// - /// A queue of writers waiting to obtain an exclusive lock. - /// - private readonly Queue waitingWriters = new Queue(); + /// + /// A flag indicating that the method has been called, indicating that no + /// new top-level lock requests should be serviced. + /// + private bool completeInvoked; + + /// + /// A helper class to produce ETW trace events. + /// + private EventsHelper etw; + + /// + /// A timer to recheck potential deadlock caused by pending writer locks. + /// + private Timer? pendingWriterLockDeadlockCheckTimer; + + /// + /// Initializes a new instance of the class. + /// + public AsyncReaderWriterLock() + : this(joinableTaskContext: null, captureDiagnostics: false) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// to spend additional resources capturing diagnostic details that can be used + /// to analyze deadlocks or other issues. + public AsyncReaderWriterLock(bool captureDiagnostics) + : this(joinableTaskContext: null, captureDiagnostics) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// A JoinableTaskContext to help resolve deadlocks caused by interdependency between top read lock tasks when there is a pending write lock blocking one of them. + /// + /// + /// to spend additional resources capturing diagnostic details that can be used + /// to analyze deadlocks or other issues. + public AsyncReaderWriterLock(JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) + { + this.etw = new EventsHelper(this); + this.joinableTaskContext = joinableTaskContext; + this.captureDiagnostics = captureDiagnostics; + } + + /// + /// Flags that modify default lock behavior. + /// + [Flags] + public enum LockFlags + { /// - /// The source of the task, which transitions to completed after - /// the method is called and all issued locks have been released. + /// The default behavior applies. /// - private readonly TaskCompletionSource completionSource = new TaskCompletionSource(); + None = 0x0, /// - /// The queue of callbacks to invoke when the currently held write lock is totally released. + /// Causes an upgradeable reader to remain in an upgraded-write state once upgraded, + /// even after the nested write lock has been released. /// /// - /// If the write lock is released to an upgradeable read lock, these callbacks are fired synchronously - /// with respect to the writer who is releasing the lock. Otherwise, the callbacks are invoked - /// asynchronously with respect to the releasing thread. + /// This is useful when you have a batch of possible write operations to apply, which + /// may or may not actually apply in the end, but if any of them change anything, + /// all of their changes should be seen atomically (within a single write lock). + /// This approach is preferable to simply acquiring a write lock around the batch of + /// potential changes because it doesn't defeat concurrent readers until it knows there + /// is a change to actually make. /// - private readonly Queue> beforeWriteReleasedCallbacks = new Queue>(); + StickyWrite = 0x1, + } + /// + /// An enumeration of the kinds of locks supported by this class. + /// + internal enum LockKind + { /// - /// A value indicating whether extra resources should be spent to collect diagnostic information - /// that may be useful in deadlock investigations. + /// A lock that supports concurrently executing threads that hold this same lock type. + /// Holders of this lock may not obtain a lock without first + /// releasing all their locks. /// - private bool captureDiagnostics; + Read, /// - /// A flag indicating whether we're currently running code to prepare for re-entering concurrency mode - /// after releasing an exclusive lock. The Awaiter being released is the non-null value. + /// A lock that may run concurrently with standard readers, but is exclusive of any other + /// upgradeable readers. Holders of this lock are allowed to obtain a write lock while + /// holding this lock to guarantee continuity of state between what they read and what they write. /// - private volatile Awaiter? reenterConcurrencyPrepRunning; + UpgradeableRead, /// - /// A flag indicating that the method has been called, indicating that no - /// new top-level lock requests should be serviced. + /// A mutually exclusive lock. /// - private bool completeInvoked; + Write, + } - /// - /// A helper class to produce ETW trace events. - /// - private EventsHelper etw; + /// + /// Gets a value indicating whether any kind of lock is held by the caller and can + /// be immediately used given the caller's context. + /// + public bool IsAnyLockHeld + { + get { return this.IsReadLockHeld || this.IsUpgradeableReadLockHeld || this.IsWriteLockHeld; } + } - /// - /// A timer to recheck potential deadlock caused by pending writer locks. - /// - private Timer? pendingWriterLockDeadlockCheckTimer; + /// + /// Gets a value indicating whether any kind of lock is held by the caller without regard + /// to the lock compatibility of the caller's context. + /// + public bool IsAnyPassiveLockHeld + { + get { return this.IsPassiveReadLockHeld || this.IsPassiveUpgradeableReadLockHeld || this.IsPassiveWriteLockHeld; } + } - /// - /// Initializes a new instance of the class. - /// - public AsyncReaderWriterLock() - : this(joinableTaskContext: null, captureDiagnostics: false) - { - } + /// + /// Gets a value indicating whether the caller holds a read lock. + /// + /// + /// This property returns if any other lock type is held, unless + /// within that alternate lock type this lock is also nested. + /// + public bool IsReadLockHeld + { + get { return this.IsLockHeld(LockKind.Read); } + } - /// - /// Initializes a new instance of the class. - /// - /// - /// to spend additional resources capturing diagnostic details that can be used - /// to analyze deadlocks or other issues. - public AsyncReaderWriterLock(bool captureDiagnostics) - : this(joinableTaskContext: null, captureDiagnostics) - { - } + /// + /// Gets a value indicating whether a read lock is held by the caller without regard + /// to the lock compatibility of the caller's context. + /// + /// + /// This property returns if any other lock type is held, unless + /// within that alternate lock type this lock is also nested. + /// + public bool IsPassiveReadLockHeld + { + get { return this.IsLockHeld(LockKind.Read, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true); } + } - /// - /// Initializes a new instance of the class. - /// - /// - /// A JoinableTaskContext to help resolve deadlocks caused by interdependency between top read lock tasks when there is a pending write lock blocking one of them. - /// - /// - /// to spend additional resources capturing diagnostic details that can be used - /// to analyze deadlocks or other issues. - public AsyncReaderWriterLock(JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) - { - this.etw = new EventsHelper(this); + /// + /// Gets a value indicating whether the caller holds an upgradeable read lock. + /// + /// + /// This property returns if any other lock type is held, unless + /// within that alternate lock type this lock is also nested. + /// + public bool IsUpgradeableReadLockHeld + { + get { return this.IsLockHeld(LockKind.UpgradeableRead); } + } - this.joinableTaskContext = joinableTaskContext; - this.captureDiagnostics = captureDiagnostics; - } + /// + /// Gets a value indicating whether an upgradeable read lock is held by the caller without regard + /// to the lock compatibility of the caller's context. + /// + /// + /// This property returns if any other lock type is held, unless + /// within that alternate lock type this lock is also nested. + /// + public bool IsPassiveUpgradeableReadLockHeld + { + get { return this.IsLockHeld(LockKind.UpgradeableRead, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true); } + } - /// - /// Flags that modify default lock behavior. - /// - [Flags] - public enum LockFlags - { - /// - /// The default behavior applies. - /// - None = 0x0, + /// + /// Gets a value indicating whether the caller holds a write lock. + /// + /// + /// This property returns if any other lock type is held, unless + /// within that alternate lock type this lock is also nested. + /// + public bool IsWriteLockHeld + { + get { return this.IsLockHeld(LockKind.Write); } + } - /// - /// Causes an upgradeable reader to remain in an upgraded-write state once upgraded, - /// even after the nested write lock has been released. - /// - /// - /// This is useful when you have a batch of possible write operations to apply, which - /// may or may not actually apply in the end, but if any of them change anything, - /// all of their changes should be seen atomically (within a single write lock). - /// This approach is preferable to simply acquiring a write lock around the batch of - /// potential changes because it doesn't defeat concurrent readers until it knows there - /// is a change to actually make. - /// - StickyWrite = 0x1, - } + /// + /// Gets a value indicating whether a write lock is held by the caller without regard + /// to the lock compatibility of the caller's context. + /// + /// + /// This property returns if any other lock type is held, unless + /// within that alternate lock type this lock is also nested. + /// + public bool IsPassiveWriteLockHeld + { + get { return this.IsLockHeld(LockKind.Write, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true); } + } - /// - /// An enumeration of the kinds of locks supported by this class. - /// - internal enum LockKind - { - /// - /// A lock that supports concurrently executing threads that hold this same lock type. - /// Holders of this lock may not obtain a lock without first - /// releasing all their locks. - /// - Read, + /// + /// Gets a task whose completion signals that this lock will no longer issue locks. + /// + /// + /// This task only transitions to a complete state after a call to . + /// + public Task Completion + { + get { return this.completionSource.Task; } + } - /// - /// A lock that may run concurrently with standard readers, but is exclusive of any other - /// upgradeable readers. Holders of this lock are allowed to obtain a write lock while - /// holding this lock to guarantee continuity of state between what they read and what they write. - /// - UpgradeableRead, + /// + /// Gets the object used to synchronize access to this instance's fields. + /// + protected object SyncObject + { + get { return this.syncObject; } + } - /// - /// A mutually exclusive lock. - /// - Write, - } + /// + /// Gets the lock held by the caller's execution context. + /// + protected LockHandle AmbientLock + { + get { return new LockHandle(this.GetFirstActiveSelfOrAncestor(this.topAwaiter.Value)); } + } - /// - /// Gets a value indicating whether any kind of lock is held by the caller and can - /// be immediately used given the caller's context. - /// - public bool IsAnyLockHeld + /// + /// Gets or sets a value indicating whether additional resources should be spent to collect + /// information that would be useful in diagnosing deadlocks, etc. + /// + protected bool CaptureDiagnostics + { + get { return this.captureDiagnostics; } + set { this.captureDiagnostics = value; } + } + + /// + /// Gets a time delay to check whether pending writer lock and reader locks forms a deadlock. + /// + protected virtual TimeSpan DeadlockCheckTimeout => DefaultDeadlockCheckTimeout; + + /// + /// Gets a value indicating whether the current thread is allowed to + /// hold an active lock. + /// + /// + /// The default implementation of this property returns + /// when the calling thread is NOT an STA thread. + /// This property may be overridden to return + /// on threads that may compromise the integrity of the lock. + /// + protected virtual bool CanCurrentThreadHoldActiveLock + { + get { return Thread.CurrentThread.GetApartmentState() != ApartmentState.STA; } + } + + /// + /// Gets a value indicating whether the current SynchronizationContext is one that is not supported + /// by this lock. + /// + protected virtual bool IsUnsupportedSynchronizationContext + { + get { - get { return this.IsReadLockHeld || this.IsUpgradeableReadLockHeld || this.IsWriteLockHeld; } + SynchronizationContext? ctxt = SynchronizationContext.Current; + bool supported = ctxt is null || ctxt is NonConcurrentSynchronizationContext; + return !supported; } + } - /// - /// Gets a value indicating whether any kind of lock is held by the caller without regard - /// to the lock compatibility of the caller's context. - /// - public bool IsAnyPassiveLockHeld + /// + /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public Awaitable ReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new Awaitable(this, LockKind.Read, LockFlags.None, cancellationToken); + } + + /// + /// Obtains an upgradeable read lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public Awaitable UpgradeableReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new Awaitable(this, LockKind.UpgradeableRead, LockFlags.None, cancellationToken); + } + + /// + /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// Modifications to normal lock behavior. + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public Awaitable UpgradeableReadLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + { + return new Awaitable(this, LockKind.UpgradeableRead, options, cancellationToken); + } + + /// + /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public Awaitable WriteLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new Awaitable(this, LockKind.Write, LockFlags.None, cancellationToken); + } + + /// + /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// Modifications to normal lock behavior. + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public Awaitable WriteLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + { + return new Awaitable(this, LockKind.Write, options, cancellationToken); + } + + /// + /// Prevents use or visibility of the caller's lock(s) until the returned value is disposed. + /// + /// The value to dispose to restore lock visibility. + /// + /// This can be used by a write lock holder that is about to fork execution to avoid + /// two threads simultaneously believing they hold the exclusive write lock. + /// The lock should be hidden just before kicking off the work and can be restored immediately + /// after kicking off the work. + /// + public Suppression HideLocks() + { + return new Suppression(this); + } + + /// + /// Causes new top-level lock requests to be rejected and the task to transition + /// to a completed state after any issued locks have been released. + /// + public void Complete() + { + lock (this.syncObject) { - get { return this.IsPassiveReadLockHeld || this.IsPassiveUpgradeableReadLockHeld || this.IsPassiveWriteLockHeld; } + this.completeInvoked = true; + this.CompleteIfAppropriate(); } + } - /// - /// Gets a value indicating whether the caller holds a read lock. - /// - /// - /// This property returns if any other lock type is held, unless - /// within that alternate lock type this lock is also nested. - /// - public bool IsReadLockHeld + /// + /// Registers a callback to be invoked when the write lock held by the caller is + /// about to be ultimately released (outermost write lock). + /// + /// + /// The asynchronous delegate to invoke. + /// Access to the write lock is provided throughout the asynchronous invocation. + /// + /// + /// This supports some scenarios VC++ has where change event handlers need to inspect changes, + /// or follow up with other changes to respond to earlier changes, at the conclusion of the lock. + /// This method is safe to call from within a previously registered callback, in which case the + /// registered callback will run when previously registered callbacks have completed execution. + /// If the write lock is released to an upgradeable read lock, these callbacks are fired synchronously + /// with respect to the writer who is releasing the lock. Otherwise, the callbacks are invoked + /// asynchronously with respect to the releasing thread. + /// + public void OnBeforeWriteLockReleased(Func action) + { + Requires.NotNull(action, nameof(action)); + + lock (this.syncObject) { - get { return this.IsLockHeld(LockKind.Read); } + if (!this.IsWriteLockHeld) + { + throw new InvalidOperationException(); + } + + this.beforeWriteReleasedCallbacks.Enqueue(action); } + } - /// - /// Gets a value indicating whether a read lock is held by the caller without regard - /// to the lock compatibility of the caller's context. - /// - /// - /// This property returns if any other lock type is held, unless - /// within that alternate lock type this lock is also nested. - /// - public bool IsPassiveReadLockHeld + /// + public void Dispose() + { + this.Dispose(true); + GC.SuppressFinalize(this); + } + + /// + /// Disposes managed and unmanaged resources held by this instance. + /// + /// if was called; if the object is being finalized. + protected virtual void Dispose(bool disposing) + { + if (disposing) { - get { return this.IsLockHeld(LockKind.Read, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true); } + Timer? timerToDispose = null; + + lock (this.syncObject) + { + timerToDispose = this.pendingWriterLockDeadlockCheckTimer; + this.pendingWriterLockDeadlockCheckTimer = null; + } + + timerToDispose?.Dispose(); } + } - /// - /// Gets a value indicating whether the caller holds an upgradeable read lock. - /// - /// - /// This property returns if any other lock type is held, unless - /// within that alternate lock type this lock is also nested. - /// - public bool IsUpgradeableReadLockHeld + /// + /// Checks whether the aggregated flags from all locks in the lock stack satisfy the specified flag(s). + /// + /// The flag(s) that must be specified for a result. + /// The head of the lock stack to consider. + /// if all the specified flags are found somewhere in the lock stack; otherwise. + protected bool LockStackContains(LockFlags flags, LockHandle handle) + { + LockFlags aggregateFlags = LockFlags.None; + Awaiter? awaiter = handle.Awaiter; + if (awaiter is object) { - get { return this.IsLockHeld(LockKind.UpgradeableRead); } + lock (this.syncObject) + { + while (awaiter is object) + { + if (this.IsLockActive(awaiter, considerStaActive: true, checkSyncContextCompatibility: true)) + { + aggregateFlags |= awaiter.Options; + if ((aggregateFlags & flags) == flags) + { + return true; + } + } + + awaiter = awaiter.NestingLock; + } + } } - /// - /// Gets a value indicating whether an upgradeable read lock is held by the caller without regard - /// to the lock compatibility of the caller's context. - /// - /// - /// This property returns if any other lock type is held, unless - /// within that alternate lock type this lock is also nested. - /// - public bool IsPassiveUpgradeableReadLockHeld + return (aggregateFlags & flags) == flags; + } + + /// + /// Returns the aggregate of the lock flags for all nested locks. + /// + /// + /// This is not redundant with because that returns fast + /// once the presence of certain flag(s) is determined, whereas this will aggregate all flags, + /// some of which may be defined by derived types. + /// + protected LockFlags GetAggregateLockFlags() + { + LockFlags aggregateFlags = LockFlags.None; + Awaiter? awaiter = this.topAwaiter.Value; + if (awaiter is object) { - get { return this.IsLockHeld(LockKind.UpgradeableRead, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true); } + lock (this.syncObject) + { + while (awaiter is object) + { + if (this.IsLockActive(awaiter, considerStaActive: true, checkSyncContextCompatibility: true)) + { + aggregateFlags |= awaiter.Options; + } + + awaiter = awaiter.NestingLock; + } + } } - /// - /// Gets a value indicating whether the caller holds a write lock. - /// - /// - /// This property returns if any other lock type is held, unless - /// within that alternate lock type this lock is also nested. - /// - public bool IsWriteLockHeld + return aggregateFlags; + } + + /// + /// Fired when any lock is being released. + /// + /// if the last write lock that the caller holds is being released; otherwise. + /// The lock being released. + /// A task whose completion signals the conclusion of the asynchronous operation. + protected virtual Task OnBeforeLockReleasedAsync(bool exclusiveLockRelease, LockHandle releasingLock) + { + // Raise the write release lock event if and only if this is the last write that is about to be released. + // Also check that issued read lock count is 0, because these callbacks themselves may acquire read locks + // on top of this write lock that hasn't quite gone away yet, and when they release their read lock, + // that shouldn't trigger a recursive call of the event. + if (exclusiveLockRelease) { - get { return this.IsLockHeld(LockKind.Write); } + return this.OnBeforeExclusiveLockReleasedAsync(); } - - /// - /// Gets a value indicating whether a write lock is held by the caller without regard - /// to the lock compatibility of the caller's context. - /// - /// - /// This property returns if any other lock type is held, unless - /// within that alternate lock type this lock is also nested. - /// - public bool IsPassiveWriteLockHeld + else { - get { return this.IsLockHeld(LockKind.Write, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true); } + return Task.CompletedTask; } + } - /// - /// Gets a task whose completion signals that this lock will no longer issue locks. - /// - /// - /// This task only transitions to a complete state after a call to . - /// - public Task Completion + /// + /// Fired when the last write lock is about to be released. + /// + /// A task whose completion signals the conclusion of the asynchronous operation. + protected virtual Task OnBeforeExclusiveLockReleasedAsync() + { + lock (this.SyncObject) { - get { return this.completionSource.Task; } + // While this method is called when the last write lock is about to be released, + // a derived type may override this method and have already taken an additional write lock, + // so only state our assumption in the non-derivation case. + Assumes.True(this.issuedWriteLocks.Count == 1 || !this.GetType().Equals(typeof(AsyncReaderWriterLock))); + + if (this.beforeWriteReleasedCallbacks.Count > 0) + { + return this.InvokeBeforeWriteLockReleaseHandlersAsync(); + } + else + { + return Task.CompletedTask; + } } + } + + /// + /// Get the task scheduler to execute the continuation when the lock is acquired. + /// AsyncReaderWriterLock uses a special to handle execusive locks, and will ignore task scheduler provided, so this is only used in a read lock scenario. + /// This method is called within the execution context to wait the read lock, so it can pick up based on the current execution context. + /// Note: the task scheduler is only used, when the lock is issued later. If the lock is issued immediately when returns true, it will be ignored. + /// + /// A task scheduler to schedule the continutation task when a lock is issued. + protected virtual TaskScheduler GetTaskSchedulerForReadLockRequest() + { + return TaskScheduler.Default; + } + + /// + /// Invoked after an exclusive lock is released but before anyone has a chance to enter the lock. + /// + /// + /// This method is called while holding a private lock in order to block future lock consumers till this method is finished. + /// + protected virtual Task OnExclusiveLockReleasedAsync() + { + return Task.CompletedTask; + } + + /// + /// Invoked when a top-level upgradeable read lock is released, leaving no remaining (write) lock. + /// + protected virtual void OnUpgradeableReadLockReleased() + { + } + + /// + /// Invoked when the lock detects an internal error or illegal usage pattern that + /// indicates a serious flaw that should be immediately reported to the application + /// and/or bring down the process to avoid hangs or data corruption. + /// + /// The exception that captures the details of the failure. + /// An exception that may be returned by some implementations of tis method for he caller to rethrow. + protected virtual Exception OnCriticalFailure(Exception ex) + { + Requires.NotNull(ex, nameof(ex)); - /// - /// Gets the object used to synchronize access to this instance's fields. - /// - protected object SyncObject - { - get { return this.syncObject; } - } + Report.Fail(ex.Message); + Environment.FailFast(ex.ToString(), ex); + throw Assumes.NotReachable(); + } - /// - /// Gets the lock held by the caller's execution context. - /// - protected LockHandle AmbientLock + /// + /// Invoked when the lock detects an internal error or illegal usage pattern that + /// indicates a serious flaw that should be immediately reported to the application + /// and/or bring down the process to avoid hangs or data corruption. + /// + /// The message to use for the exception. + /// An exception that may be returned by some implementations of tis method for he caller to rethrow. + protected Exception OnCriticalFailure(string message) + { + try { - get { return new LockHandle(this.GetFirstActiveSelfOrAncestor(this.topAwaiter.Value)); } + throw Assumes.Fail(message); } - - /// - /// Gets or sets a value indicating whether additional resources should be spent to collect - /// information that would be useful in diagnosing deadlocks, etc. - /// - protected bool CaptureDiagnostics + catch (Exception ex) { - get { return this.captureDiagnostics; } - set { this.captureDiagnostics = value; } + throw this.OnCriticalFailure(ex); } + } - /// - /// Gets a time delay to check whether pending writer lock and reader locks forms a deadlock. - /// - protected virtual TimeSpan DeadlockCheckTimeout => DefaultDeadlockCheckTimeout; - - /// - /// Gets a value indicating whether the current thread is allowed to - /// hold an active lock. - /// - /// - /// The default implementation of this property returns - /// when the calling thread is NOT an STA thread. - /// This property may be overridden to return - /// on threads that may compromise the integrity of the lock. - /// - protected virtual bool CanCurrentThreadHoldActiveLock - { - get { return Thread.CurrentThread.GetApartmentState() != ApartmentState.STA; } - } + /// + /// Checks whether the specified lock has any active nested locks. + /// + private static bool HasAnyNestedLocks(Awaiter lck, HashSet lockCollection) + { + Requires.NotNull(lck, nameof(lck)); + Requires.NotNull(lockCollection, nameof(lockCollection)); - /// - /// Gets a value indicating whether the current SynchronizationContext is one that is not supported - /// by this lock. - /// - protected virtual bool IsUnsupportedSynchronizationContext + if (lockCollection.Count > 0) { - get + foreach (Awaiter? nestedCandidate in lockCollection) { - SynchronizationContext? ctxt = SynchronizationContext.Current; - bool supported = ctxt is null || ctxt is NonConcurrentSynchronizationContext; - return !supported; + if (nestedCandidate == lck) + { + // This isn't nested -- it's the lock itself. + continue; + } + + for (Awaiter? a = nestedCandidate.NestingLock; a is object; a = a.NestingLock) + { + if (a == lck) + { + return true; + } + } } } - /// - /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. - /// - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public Awaitable ReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) - { - return new Awaitable(this, LockKind.Read, LockFlags.None, cancellationToken); - } + return false; + } - /// - /// Obtains an upgradeable read lock, asynchronously awaiting for the lock if it is not immediately available. - /// - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public Awaitable UpgradeableReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) - { - return new Awaitable(this, LockKind.UpgradeableRead, LockFlags.None, cancellationToken); - } + private static void PendingWriterLockDeadlockWatchingCallback(object? state) + { + var readerWriterLock = (AsyncReaderWriterLock?)state; + Assumes.NotNull(readerWriterLock); - /// - /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. - /// - /// Modifications to normal lock behavior. - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public Awaitable UpgradeableReadLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + readerWriterLock.TryInvokeAllDependentReadersIfAppropriate(); + + lock (readerWriterLock.syncObject) { - return new Awaitable(this, LockKind.UpgradeableRead, options, cancellationToken); + readerWriterLock.pendingWriterLockDeadlockCheckTimer?.Change((int)readerWriterLock.DeadlockCheckTimeout.TotalMilliseconds, -1); } + } - /// - /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. - /// - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public Awaitable WriteLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + /// + /// Throws an exception if called on an STA thread. + /// + private void ThrowIfUnsupportedThreadOrSyncContext() + { + if (!this.CanCurrentThreadHoldActiveLock) { - return new Awaitable(this, LockKind.Write, LockFlags.None, cancellationToken); + Verify.FailOperation(Strings.STAThreadCallerNotAllowed); } - /// - /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. - /// - /// Modifications to normal lock behavior. - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public Awaitable WriteLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + if (this.IsUnsupportedSynchronizationContext) { - return new Awaitable(this, LockKind.Write, options, cancellationToken); + Verify.FailOperation(Strings.AppliedSynchronizationContextNotAllowed); } + } - /// - /// Prevents use or visibility of the caller's lock(s) until the returned value is disposed. - /// - /// The value to dispose to restore lock visibility. - /// - /// This can be used by a write lock holder that is about to fork execution to avoid - /// two threads simultaneously believing they hold the exclusive write lock. - /// The lock should be hidden just before kicking off the work and can be restored immediately - /// after kicking off the work. - /// - public Suppression HideLocks() + /// + /// Gets a value indicating whether the caller's thread apartment model and SynchronizationContext + /// is compatible with a lock. + /// + private bool IsLockSupportingContext(Awaiter? awaiter = null) + { + if (!this.CanCurrentThreadHoldActiveLock || this.IsUnsupportedSynchronizationContext) { - return new Suppression(this); + return false; } - /// - /// Causes new top-level lock requests to be rejected and the task to transition - /// to a completed state after any issued locks have been released. - /// - public void Complete() + awaiter = awaiter ?? this.topAwaiter.Value; + if (this.IsLockHeld(LockKind.Write, awaiter, allowNonLockSupportingContext: true, checkSyncContextCompatibility: false) || + this.IsLockHeld(LockKind.UpgradeableRead, awaiter, allowNonLockSupportingContext: true, checkSyncContextCompatibility: false)) { - lock (this.syncObject) + if (!(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) { - this.completeInvoked = true; - this.CompleteIfAppropriate(); + // Upgradeable read and write locks *must* have the NonConcurrentSynchronizationContext applied. + return false; } } - /// - /// Registers a callback to be invoked when the write lock held by the caller is - /// about to be ultimately released (outermost write lock). - /// - /// - /// The asynchronous delegate to invoke. - /// Access to the write lock is provided throughout the asynchronous invocation. - /// - /// - /// This supports some scenarios VC++ has where change event handlers need to inspect changes, - /// or follow up with other changes to respond to earlier changes, at the conclusion of the lock. - /// This method is safe to call from within a previously registered callback, in which case the - /// registered callback will run when previously registered callbacks have completed execution. - /// If the write lock is released to an upgradeable read lock, these callbacks are fired synchronously - /// with respect to the writer who is releasing the lock. Otherwise, the callbacks are invoked - /// asynchronously with respect to the releasing thread. - /// - public void OnBeforeWriteLockReleased(Func action) - { - Requires.NotNull(action, nameof(action)); - - lock (this.syncObject) - { - if (!this.IsWriteLockHeld) - { - throw new InvalidOperationException(); - } + return true; + } - this.beforeWriteReleasedCallbacks.Enqueue(action); - } - } + /// + /// Transitions the task to a completed state + /// if appropriate. + /// + private void CompleteIfAppropriate() + { + Assumes.True(Monitor.IsEntered(this.syncObject)); - /// - public void Dispose() + if (this.completeInvoked && + !this.completionSource.Task.IsCompleted && + this.reenterConcurrencyPrepRunning is null && + this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0 && + this.waitingReaders.Count == 0 && this.waitingUpgradeableReaders.Count == 0 && this.waitingWriters.Count == 0) { - this.Dispose(true); - GC.SuppressFinalize(this); + // We must use another task to asynchronously transition this so we don't inadvertently execute continuations inline + // while we're holding a lock. + Task.Run(delegate { this.completionSource.TrySetResult(null); }); } + } - /// - /// Disposes managed and unmanaged resources held by this instance. - /// - /// if was called; if the object is being finalized. - protected virtual void Dispose(bool disposing) + /// + /// Detects which lock types the given lock holder has (including all nested locks). + /// + /// The most nested lock to be considered. + /// Receives a value indicating whether a read lock is held. + /// Receives a value indicating whether an upgradeable read lock is held. + /// Receives a value indicating whether a write lock is held. + private void AggregateLockStackKinds(Awaiter? awaiter, out bool read, out bool upgradeableRead, out bool write) + { + read = false; + upgradeableRead = false; + write = false; + + if (awaiter is object) { - if (disposing) + lock (this.syncObject) { - Timer? timerToDispose = null; - - lock (this.syncObject) + while (awaiter is object) { - timerToDispose = this.pendingWriterLockDeadlockCheckTimer; - this.pendingWriterLockDeadlockCheckTimer = null; - } + // It's possible that this lock has been released (even mid-stack, due to our async nature), + // so only consider locks that are still active. + switch (awaiter.Kind) + { + case LockKind.Read: + read |= this.issuedReadLocks.Contains(awaiter); + break; + case LockKind.UpgradeableRead: + upgradeableRead |= this.issuedUpgradeableReadLocks.Contains(awaiter); + write |= this.IsStickyWriteUpgradedLock(awaiter); + break; + case LockKind.Write: + write |= this.issuedWriteLocks.Contains(awaiter); + break; + } + + if (read && upgradeableRead && write) + { + // We've seen it all. Walking the stack further would not provide anything more. + return; + } - timerToDispose?.Dispose(); + awaiter = awaiter.NestingLock; + } } } + } - /// - /// Checks whether the aggregated flags from all locks in the lock stack satisfy the specified flag(s). - /// - /// The flag(s) that must be specified for a result. - /// The head of the lock stack to consider. - /// if all the specified flags are found somewhere in the lock stack; otherwise. - protected bool LockStackContains(LockFlags flags, LockHandle handle) + /// + /// Gets a value indicating whether all issued locks are merely the top-level lock or nesting locks of the specified lock. + /// + /// The most nested lock. + /// if all issued locks are the specified lock or nesting locks of it. + private bool AllHeldLocksAreByThisStack(Awaiter? awaiter) + { + Assumes.True(awaiter is null || !this.IsLockHeld(LockKind.Write, awaiter)); // this method doesn't yet handle sticky upgraded read locks (that appear in the write lock set). + lock (this.syncObject) { - LockFlags aggregateFlags = LockFlags.None; - Awaiter? awaiter = handle.Awaiter; if (awaiter is object) { - lock (this.syncObject) + int locksMatched = 0; + while (awaiter is object) { - while (awaiter is object) + if (this.GetActiveLockSet(awaiter.Kind).Contains(awaiter)) { - if (this.IsLockActive(awaiter, considerStaActive: true, checkSyncContextCompatibility: true)) - { - aggregateFlags |= awaiter.Options; - if ((aggregateFlags & flags) == flags) - { - return true; - } - } - - awaiter = awaiter.NestingLock; + locksMatched++; } + + awaiter = awaiter.NestingLock; } - } - return (aggregateFlags & flags) == flags; + return locksMatched == this.issuedReadLocks.Count + this.issuedUpgradeableReadLocks.Count + this.issuedWriteLocks.Count; + } + else + { + return this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0; + } } + } - /// - /// Returns the aggregate of the lock flags for all nested locks. - /// - /// - /// This is not redundant with because that returns fast - /// once the presence of certain flag(s) is determined, whereas this will aggregate all flags, - /// some of which may be defined by derived types. - /// - protected LockFlags GetAggregateLockFlags() + /// + /// Gets a value indicating whether the specified lock is, or is a nested lock of, a given type. + /// + /// The kind of lock being queried for. + /// The (possibly nested) lock. + /// if the lock holder (also) holds the specified kind of lock. + private bool LockStackContains(LockKind kind, Awaiter? awaiter) + { + if (awaiter is object) { - LockFlags aggregateFlags = LockFlags.None; - Awaiter? awaiter = this.topAwaiter.Value; - if (awaiter is object) + lock (this.syncObject) { - lock (this.syncObject) + HashSet? lockSet = this.GetActiveLockSet(kind); + while (awaiter is object) { - while (awaiter is object) + // It's possible that this lock has been released (even mid-stack, due to our async nature), + // so only consider locks that are still active. + if (awaiter.Kind == kind && lockSet.Contains(awaiter)) { - if (this.IsLockActive(awaiter, considerStaActive: true, checkSyncContextCompatibility: true)) - { - aggregateFlags |= awaiter.Options; - } + return true; + } - awaiter = awaiter.NestingLock; + if (kind == LockKind.Write && this.IsStickyWriteUpgradedLock(awaiter)) + { + return true; } + + awaiter = awaiter.NestingLock; } } - - return aggregateFlags; } - /// - /// Fired when any lock is being released. - /// - /// if the last write lock that the caller holds is being released; otherwise. - /// The lock being released. - /// A task whose completion signals the conclusion of the asynchronous operation. - protected virtual Task OnBeforeLockReleasedAsync(bool exclusiveLockRelease, LockHandle releasingLock) + return false; + } + + /// + /// Checks whether the specified lock is an upgradeable read lock, with a flag, + /// which has actually be upgraded. + /// + /// The lock to test. + /// if the test succeeds; otherwise. + private bool IsStickyWriteUpgradedLock(Awaiter awaiter) + { + if (awaiter.Kind == LockKind.UpgradeableRead && (awaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite) { - // Raise the write release lock event if and only if this is the last write that is about to be released. - // Also check that issued read lock count is 0, because these callbacks themselves may acquire read locks - // on top of this write lock that hasn't quite gone away yet, and when they release their read lock, - // that shouldn't trigger a recursive call of the event. - if (exclusiveLockRelease) - { - return this.OnBeforeExclusiveLockReleasedAsync(); - } - else + lock (this.syncObject) { - return Task.CompletedTask; + return this.issuedWriteLocks.Contains(awaiter); } } - /// - /// Fired when the last write lock is about to be released. - /// - /// A task whose completion signals the conclusion of the asynchronous operation. - protected virtual Task OnBeforeExclusiveLockReleasedAsync() + return false; + } + + /// + /// Checks whether the caller's held locks (or the specified lock stack) includes an active lock of the specified type. + /// Always when called on an STA thread. + /// + /// The type of lock to check for. + /// The most nested lock of the caller, or null to look up the caller's lock in the CallContext. + /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. + /// to return true when a lock is held but unusable because of the context of the caller. + /// if the caller holds active locks of the given type; otherwise. + private bool IsLockHeld(LockKind kind, Awaiter? awaiter = null, bool checkSyncContextCompatibility = true, bool allowNonLockSupportingContext = false) + { + if (allowNonLockSupportingContext || this.IsLockSupportingContext(awaiter)) { - lock (this.SyncObject) + lock (this.syncObject) { - // While this method is called when the last write lock is about to be released, - // a derived type may override this method and have already taken an additional write lock, - // so only state our assumption in the non-derivation case. - Assumes.True(this.issuedWriteLocks.Count == 1 || !this.GetType().Equals(typeof(AsyncReaderWriterLock))); - - if (this.beforeWriteReleasedCallbacks.Count > 0) - { - return this.InvokeBeforeWriteLockReleaseHandlersAsync(); - } - else + awaiter = awaiter ?? this.topAwaiter.Value; + if (checkSyncContextCompatibility) { - return Task.CompletedTask; + this.CheckSynchronizationContextAppropriateForLock(awaiter); } + + return this.LockStackContains(kind, awaiter); } } - /// - /// Get the task scheduler to execute the continuation when the lock is acquired. - /// AsyncReaderWriterLock uses a special to handle execusive locks, and will ignore task scheduler provided, so this is only used in a read lock scenario. - /// This method is called within the execution context to wait the read lock, so it can pick up based on the current execution context. - /// Note: the task scheduler is only used, when the lock is issued later. If the lock is issued immediately when returns true, it will be ignored. - /// - /// A task scheduler to schedule the continutation task when a lock is issued. - protected virtual TaskScheduler GetTaskSchedulerForReadLockRequest() - { - return TaskScheduler.Default; - } + return false; + } - /// - /// Invoked after an exclusive lock is released but before anyone has a chance to enter the lock. - /// - /// - /// This method is called while holding a private lock in order to block future lock consumers till this method is finished. - /// - protected virtual Task OnExclusiveLockReleasedAsync() - { - return Task.CompletedTask; - } + /// + /// Checks whether a given lock is active. + /// Always when called on an STA thread. + /// + /// The lock to check. + /// if the return value will always be if called on an STA thread. + /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. + /// if the lock is currently issued and the caller is not on an STA thread. + private bool IsLockActive(Awaiter awaiter, bool considerStaActive, bool checkSyncContextCompatibility = false) + { + Requires.NotNull(awaiter, nameof(awaiter)); - /// - /// Invoked when a top-level upgradeable read lock is released, leaving no remaining (write) lock. - /// - protected virtual void OnUpgradeableReadLockReleased() + if (considerStaActive || this.IsLockSupportingContext(awaiter)) { + lock (this.syncObject) + { + bool activeLock = this.GetActiveLockSet(awaiter.Kind).Contains(awaiter); + if (checkSyncContextCompatibility && activeLock) + { + this.CheckSynchronizationContextAppropriateForLock(awaiter); + } + + return activeLock; + } } - /// - /// Invoked when the lock detects an internal error or illegal usage pattern that - /// indicates a serious flaw that should be immediately reported to the application - /// and/or bring down the process to avoid hangs or data corruption. - /// - /// The exception that captures the details of the failure. - /// An exception that may be returned by some implementations of tis method for he caller to rethrow. - protected virtual Exception OnCriticalFailure(Exception ex) - { - Requires.NotNull(ex, nameof(ex)); + return false; + } - Report.Fail(ex.Message); - Environment.FailFast(ex.ToString(), ex); - throw Assumes.NotReachable(); - } + /// + /// Checks whether the specified awaiter's lock type has an associated SynchronizationContext if one is applicable. + /// + /// The awaiter whose lock should be considered. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] + private void CheckSynchronizationContextAppropriateForLock(Awaiter? awaiter) + { + ////bool syncContextRequired = this.LockStackContains(LockKind.UpgradeableRead, awaiter) || this.LockStackContains(LockKind.Write, awaiter); + ////if (syncContextRequired) { + //// if (!(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) { + //// Assumes.Fail(); + //// } + ////} + } - /// - /// Invoked when the lock detects an internal error or illegal usage pattern that - /// indicates a serious flaw that should be immediately reported to the application - /// and/or bring down the process to avoid hangs or data corruption. - /// - /// The message to use for the exception. - /// An exception that may be returned by some implementations of tis method for he caller to rethrow. - protected Exception OnCriticalFailure(string message) + /// + /// Immediately issues a lock to the specified awaiter if it is available. + /// + /// The awaiter to issue a lock to. + /// + /// A value indicating whether this lock was previously queued. if this is a new just received request. + /// The value is used to determine whether to reject it if has already been called and this + /// is a new top-level request. + /// + /// + /// Normally, new reader locks are no longer issued when there is a pending writer lock to allow existing reader lock to complete. + /// However, that can lead deadlocks, when tasks with issued lock depending on tasks requiring new read locks to complete. + /// When it is true, new reader locks will be issued even when there is a pending writer lock. + /// + /// A value indicating whether the lock was issued. + [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] + private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendingWriteLockCheck = false) + { + lock (this.syncObject) { - try + if (this.completeInvoked && !previouslyQueued) + { + // If this is a new top-level lock request, reject it completely. + if (awaiter.NestingLock is null) + { + awaiter.SetFault(new InvalidOperationException(Strings.LockCompletionAlreadyRequested)); + return false; + } + } + + bool issued = false; + if (this.reenterConcurrencyPrepRunning is null) + { + if (this.issuedWriteLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedReadLocks.Count == 0) + { + issued = true; + } + else + { + this.AggregateLockStackKinds(awaiter, out bool hasRead, out bool hasUpgradeableRead, out bool hasWrite); + switch (awaiter.Kind) + { + case LockKind.Read: + if (this.issuedWriteLocks.Count == 0 && (skipPendingWriteLockCheck || this.waitingWriters.Count == 0)) + { + issued = true; + } + else if (hasWrite) + { + // We allow STA threads to not have the sync context applied because it never has it applied, + // and a write lock holder is allowed to transition to an STA tread. + // But if an MTA thread has the write lock but not the sync context, then they're likely + // an accidental execution fork that is exposing concurrency inappropriately. + if (this.CanCurrentThreadHoldActiveLock && !(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) + { + Report.Fail("Dangerous request for read lock from fork of write lock."); + Verify.FailOperation(Strings.DangerousReadLockRequestFromWriteLockFork); + } + + issued = true; + } + else if (hasRead || hasUpgradeableRead) + { + issued = true; + } + + break; + case LockKind.UpgradeableRead: + if (hasUpgradeableRead || hasWrite) + { + issued = true; + } + else if (hasRead) + { + // We cannot issue an upgradeable read lock to folks who have (only) a read lock. + throw new InvalidOperationException(Strings.CannotUpgradeNonUpgradeableLock); + } +#pragma warning disable CA1508 // Avoid dead conditional code + else if (this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0) +#pragma warning restore CA1508 // Avoid dead conditional code + { + issued = true; + } + + break; + case LockKind.Write: + if (hasWrite) + { + issued = true; + } + else if (hasRead && !hasUpgradeableRead) + { + // We cannot issue a write lock when the caller already holds a read lock. + throw new InvalidOperationException(Strings.CannotUpgradeNonUpgradeableLock); + } + else if (this.AllHeldLocksAreByThisStack(awaiter.NestingLock)) + { + issued = true; + + Awaiter? stickyWriteAwaiter = this.FindRootUpgradeableReadWithStickyWrite(awaiter); + if (stickyWriteAwaiter is object) + { + // Add the upgradeable reader as a write lock as well. + this.issuedWriteLocks.Add(stickyWriteAwaiter); + } + } + + break; + default: + throw Assumes.NotReachable(); + } + } + } + + if (issued) { - throw Assumes.Fail(message); + this.GetActiveLockSet(awaiter.Kind).Add(awaiter); + this.etw.Issued(awaiter); } - catch (Exception ex) + + if (!issued) { - throw this.OnCriticalFailure(ex); + this.etw.WaitStart(awaiter); + + // If the lock is immediately available, we don't need to coordinate with other threads. + // But if it is NOT available, we'd have to wait potentially for other threads to do more work. + Debugger.NotifyOfCrossThreadDependency(); } + + return issued; } + } - /// - /// Checks whether the specified lock has any active nested locks. - /// - private static bool HasAnyNestedLocks(Awaiter lck, HashSet lockCollection) + /// + /// Finds the upgradeable reader with flag that is nearest + /// to the top-level lock request held by the given lock holder. + /// + /// The awaiter to start the search down the stack from. + /// The least nested upgradeable reader lock with sticky write flag; or if none was found. + private Awaiter? FindRootUpgradeableReadWithStickyWrite(Awaiter? headAwaiter) + { + if (headAwaiter is null) { - Requires.NotNull(lck, nameof(lck)); - Requires.NotNull(lockCollection, nameof(lockCollection)); + return null; + } + + Awaiter? lowerMatch = this.FindRootUpgradeableReadWithStickyWrite(headAwaiter.NestingLock); + if (lowerMatch is object) + { + return lowerMatch; + } - if (lockCollection.Count > 0) + if (headAwaiter.Kind == LockKind.UpgradeableRead && (headAwaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite) + { + lock (this.syncObject) { - foreach (Awaiter? nestedCandidate in lockCollection) + if (this.issuedUpgradeableReadLocks.Contains(headAwaiter)) { - if (nestedCandidate == lck) - { - // This isn't nested -- it's the lock itself. - continue; - } - - for (Awaiter? a = nestedCandidate.NestingLock; a is object; a = a.NestingLock) - { - if (a == lck) - { - return true; - } - } + return headAwaiter; } } - - return false; } - private static void PendingWriterLockDeadlockWatchingCallback(object? state) - { - var readerWriterLock = (AsyncReaderWriterLock?)state; - Assumes.NotNull(readerWriterLock); + return null; + } - readerWriterLock.TryInvokeAllDependentReadersIfAppropriate(); + /// + /// Gets the set of locks of a given kind. + /// + /// The kind of lock. + /// A set of locks. + private HashSet GetActiveLockSet(LockKind kind) + { + switch (kind) + { + case LockKind.Read: + return this.issuedReadLocks; + case LockKind.UpgradeableRead: + return this.issuedUpgradeableReadLocks; + case LockKind.Write: + return this.issuedWriteLocks; + default: + throw Assumes.NotReachable(); + } + } - lock (readerWriterLock.syncObject) - { - readerWriterLock.pendingWriterLockDeadlockCheckTimer?.Change((int)readerWriterLock.DeadlockCheckTimeout.TotalMilliseconds, -1); - } + /// + /// Gets the queue for a lock with a given type. + /// + /// The kind of lock. + /// A queue. + private Queue GetLockQueue(LockKind kind) + { + switch (kind) + { + case LockKind.Read: + return this.waitingReaders; + case LockKind.UpgradeableRead: + return this.waitingUpgradeableReaders; + case LockKind.Write: + return this.waitingWriters; + default: + throw Assumes.NotReachable(); } + } - /// - /// Throws an exception if called on an STA thread. - /// - private void ThrowIfUnsupportedThreadOrSyncContext() + /// + /// Walks the nested lock stack until it finds an active one. + /// + /// The most nested lock to consider. May be null. + /// The first active lock encountered, or if none. + private Awaiter? GetFirstActiveSelfOrAncestor(Awaiter? awaiter) + { + while (awaiter is object) { - if (!this.CanCurrentThreadHoldActiveLock) + if (this.IsLockActive(awaiter, considerStaActive: true)) { - Verify.FailOperation(Strings.STAThreadCallerNotAllowed); + break; } - if (this.IsUnsupportedSynchronizationContext) - { - Verify.FailOperation(Strings.AppliedSynchronizationContextNotAllowed); - } + awaiter = awaiter.NestingLock; } - /// - /// Gets a value indicating whether the caller's thread apartment model and SynchronizationContext - /// is compatible with a lock. - /// - private bool IsLockSupportingContext(Awaiter? awaiter = null) + return awaiter; + } + + /// + /// Issues a lock to the specified awaiter and executes its continuation. + /// The awaiter should have already been dequeued. + /// + /// The awaiter to issue a lock to and execute. + private void IssueAndExecute(Awaiter awaiter) + { + EventsHelper.WaitStop(awaiter); + Assumes.True(this.TryIssueLock(awaiter, previouslyQueued: true, skipPendingWriteLockCheck: true)); + Assumes.True(this.ExecuteOrHandleCancellation(awaiter, stillInQueue: false)); + } + + /// + /// Releases the lock held by the specified awaiter. + /// + /// The awaiter holding an active lock. + /// A value indicating whether the lock consumer ended up not executing any work. + /// + /// A task that should complete before the releasing thread accesses any resource protected by + /// a lock wrapping the lock being released. + /// The task will always be complete if is . + /// This method guarantees that the lock is effectively released from the caller, and the + /// can be safely recycled, before the synchronous portion of this method completes. + /// + [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] + private Task ReleaseAsync(Awaiter awaiter, bool lockConsumerCanceled = false) + { + // This method does NOT use the async keyword in its signature to avoid CallContext changes that we make + // causing a fork/clone of the CallContext, which defeats our alloc-free uncontested lock story. + + // No one should have any locks to release (and be executing code) if we're in our intermediate state. + // When this test fails, it's because someone had an exclusive lock and allowed concurrently executing + // code to fork off and acquire a read (or upgradeable read?) lock, then outlive the parent write lock. + // This is an illegal pattern both because it means an exclusive lock is used concurrently (while the + // parent write lock is active) and when the write lock is released, it means that the child "read" + // lock suddenly became a "concurrent" lock, but we can't transition all the resources from exclusive + // access to concurrent access while someone is actually holding a lock (as such transition requires + // the lock class itself to have the exclusive lock to protect the resources going through the transition). + Awaiter? illegalConcurrentLock = this.reenterConcurrencyPrepRunning; // capture to local to preserve evidence in a concurrently reset field. + if (illegalConcurrentLock is object) { - if (!this.CanCurrentThreadHoldActiveLock || this.IsUnsupportedSynchronizationContext) + try { - return false; + Assumes.Fail(string.Format(CultureInfo.CurrentCulture, "Illegal concurrent use of exclusive lock. Exclusive lock: {0}, Nested lock that outlived parent: {1}", illegalConcurrentLock, awaiter)); } - - awaiter = awaiter ?? this.topAwaiter.Value; - if (this.IsLockHeld(LockKind.Write, awaiter, allowNonLockSupportingContext: true, checkSyncContextCompatibility: false) || - this.IsLockHeld(LockKind.UpgradeableRead, awaiter, allowNonLockSupportingContext: true, checkSyncContextCompatibility: false)) + catch (Exception ex) { - if (!(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) - { - // Upgradeable read and write locks *must* have the NonConcurrentSynchronizationContext applied. - return false; - } + throw this.OnCriticalFailure(ex); } + } - return true; + if (!this.IsLockActive(awaiter, considerStaActive: true)) + { + return Task.CompletedTask; } - /// - /// Transitions the task to a completed state - /// if appropriate. - /// - private void CompleteIfAppropriate() + Task? reenterConcurrentOutsideCode = null; + Task? synchronousCallbackExecution = null; + bool synchronousRequired = false; + Awaiter? remainingAwaiter = null; + Awaiter? topAwaiterAtStart = this.topAwaiter.Value; // do this outside the lock because it's fairly expensive and doesn't require the lock. + + lock (this.syncObject) { - Assumes.True(Monitor.IsEntered(this.syncObject)); + // In case this is a sticky write lock, it may also belong to the write locks issued collection. + bool upgradedStickyWrite = awaiter.Kind == LockKind.UpgradeableRead + && (awaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite + && this.issuedWriteLocks.Contains(awaiter); - if (this.completeInvoked && - !this.completionSource.Task.IsCompleted && - this.reenterConcurrencyPrepRunning is null && - this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0 && - this.waitingReaders.Count == 0 && this.waitingUpgradeableReaders.Count == 0 && this.waitingWriters.Count == 0) + int writeLocksBefore = this.issuedWriteLocks.Count; + int upgradeableReadLocksBefore = this.issuedUpgradeableReadLocks.Count; + int writeLocksAfter = writeLocksBefore - ((awaiter.Kind == LockKind.Write || upgradedStickyWrite) ? 1 : 0); + int upgradeableReadLocksAfter = upgradeableReadLocksBefore - (awaiter.Kind == LockKind.UpgradeableRead ? 1 : 0); + bool finalExclusiveLockRelease = writeLocksBefore > 0 && writeLocksAfter == 0; + + Task callbackExecution = Task.CompletedTask; + if (!lockConsumerCanceled) { - // We must use another task to asynchronously transition this so we don't inadvertently execute continuations inline - // while we're holding a lock. - Task.Run(delegate { this.completionSource.TrySetResult(null); }); + // Callbacks should be fired synchronously iff the last write lock is being released and read locks are already issued. + // This can occur when upgradeable read locks are held and upgraded, and then downgraded back to an upgradeable read. + callbackExecution = this.OnBeforeLockReleasedAsync(finalExclusiveLockRelease, new LockHandle(awaiter)) ?? Task.CompletedTask; + synchronousRequired = finalExclusiveLockRelease && upgradeableReadLocksAfter > 0; + if (synchronousRequired) + { + synchronousCallbackExecution = callbackExecution; + } } - } - - /// - /// Detects which lock types the given lock holder has (including all nested locks). - /// - /// The most nested lock to be considered. - /// Receives a value indicating whether a read lock is held. - /// Receives a value indicating whether an upgradeable read lock is held. - /// Receives a value indicating whether a write lock is held. - private void AggregateLockStackKinds(Awaiter? awaiter, out bool read, out bool upgradeableRead, out bool write) - { - read = false; - upgradeableRead = false; - write = false; - if (awaiter is object) + if (!lockConsumerCanceled) { - lock (this.syncObject) + if (writeLocksAfter == 0) { - while (awaiter is object) + bool fireWriteLockReleased = writeLocksBefore > 0; + bool fireUpgradeableReadLockReleased = upgradeableReadLocksBefore > 0 && upgradeableReadLocksAfter == 0; + if (fireWriteLockReleased || fireUpgradeableReadLockReleased) { - // It's possible that this lock has been released (even mid-stack, due to our async nature), - // so only consider locks that are still active. - switch (awaiter.Kind) + // The Task.Run is invoked from another method so that C# doesn't allocate the anonymous delegate + // it uses unless we actually are going to invoke it -- + if (fireWriteLockReleased) { - case LockKind.Read: - read |= this.issuedReadLocks.Contains(awaiter); - break; - case LockKind.UpgradeableRead: - upgradeableRead |= this.issuedUpgradeableReadLocks.Contains(awaiter); - write |= this.IsStickyWriteUpgradedLock(awaiter); - break; - case LockKind.Write: - write |= this.issuedWriteLocks.Contains(awaiter); - break; + reenterConcurrentOutsideCode = this.DowngradeLockAsync(awaiter, upgradedStickyWrite, fireUpgradeableReadLockReleased, callbackExecution); } - - if (read && upgradeableRead && write) + else if (fireUpgradeableReadLockReleased) { - // We've seen it all. Walking the stack further would not provide anything more. - return; + this.OnUpgradeableReadLockReleased(); } - - awaiter = awaiter.NestingLock; } } } + + if (reenterConcurrentOutsideCode is null) + { + this.OnReleaseReenterConcurrencyComplete(awaiter, upgradedStickyWrite, searchAllWaiters: false); + } + + remainingAwaiter = this.GetFirstActiveSelfOrAncestor(topAwaiterAtStart); } - /// - /// Gets a value indicating whether all issued locks are merely the top-level lock or nesting locks of the specified lock. - /// - /// The most nested lock. - /// if all issued locks are the specified lock or nesting locks of it. - private bool AllHeldLocksAreByThisStack(Awaiter? awaiter) + // Updating the topAwaiter requires touching the CallContext, which significantly increases the perf/GC hit + // for releasing locks. So we prefer to leave a released lock in the context and walk up the lock stack when + // necessary. But we will clean it up if it's the last lock released. + if (remainingAwaiter is null) { - Assumes.True(awaiter is null || !this.IsLockHeld(LockKind.Write, awaiter)); // this method doesn't yet handle sticky upgraded read locks (that appear in the write lock set). - lock (this.syncObject) + // This assignment is outside the lock because it doesn't need the lock and it's a relatively expensive call + // that we needn't hold the lock for. + this.topAwaiter.Value = remainingAwaiter; + } + + if (synchronousRequired || true) + { // the "|| true" bit is to force us to always be synchronous when releasing locks until we can get all tests passing the other way. + if (reenterConcurrentOutsideCode is object && (synchronousCallbackExecution is object && !synchronousCallbackExecution.IsCompleted)) { - if (awaiter is object) - { - int locksMatched = 0; - while (awaiter is object) - { - if (this.GetActiveLockSet(awaiter.Kind).Contains(awaiter)) - { - locksMatched++; - } + return Task.WhenAll(reenterConcurrentOutsideCode, synchronousCallbackExecution); + } + else + { + return reenterConcurrentOutsideCode ?? synchronousCallbackExecution ?? Task.CompletedTask; + } + } + else + { + return Task.CompletedTask; + } + } - awaiter = awaiter.NestingLock; - } + /// + /// Schedules work on a background thread that will prepare protected resource(s) for concurrent access. + /// + private async Task DowngradeLockAsync(Awaiter awaiter, bool upgradedStickyWrite, bool fireUpgradeableReadLockReleased, Task beginAfterPrerequisite) + { + Requires.NotNull(awaiter, nameof(awaiter)); + Requires.NotNull(beginAfterPrerequisite, nameof(beginAfterPrerequisite)); - return locksMatched == this.issuedReadLocks.Count + this.issuedUpgradeableReadLocks.Count + this.issuedWriteLocks.Count; - } - else - { - return this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0; - } - } + Exception? prereqException = null; + try + { + await beginAfterPrerequisite.ConfigureAwait(SynchronizationContext.Current is NonConcurrentSynchronizationContext); + } + catch (Exception ex) + { + prereqException = ex; } - /// - /// Gets a value indicating whether the specified lock is, or is a nested lock of, a given type. - /// - /// The kind of lock being queried for. - /// The (possibly nested) lock. - /// if the lock holder (also) holds the specified kind of lock. - private bool LockStackContains(LockKind kind, Awaiter? awaiter) + Task onExclusiveLockReleasedTask; + lock (this.syncObject) { - if (awaiter is object) + // Check that no read locks are held. If they are, then that's a sign that + // within this write lock, someone took a read lock that is outliving the nesting + // write lock, which is a very dangerous situation. + if (this.issuedReadLocks.Count > 0) { - lock (this.syncObject) + if (this.HasAnyNestedLocks(awaiter)) { - HashSet? lockSet = this.GetActiveLockSet(kind); - while (awaiter is object) + try { - // It's possible that this lock has been released (even mid-stack, due to our async nature), - // so only consider locks that are still active. - if (awaiter.Kind == kind && lockSet.Contains(awaiter)) - { - return true; - } - - if (kind == LockKind.Write && this.IsStickyWriteUpgradedLock(awaiter)) - { - return true; - } - - awaiter = awaiter.NestingLock; + throw new InvalidOperationException(Strings.WriteLockOutlived); + } + catch (InvalidOperationException ex) + { + this.OnCriticalFailure(ex); } } } - return false; + this.reenterConcurrencyPrepRunning = awaiter; + onExclusiveLockReleasedTask = this.OnExclusiveLockReleasedAsync(); } - /// - /// Checks whether the specified lock is an upgradeable read lock, with a flag, - /// which has actually be upgraded. - /// - /// The lock to test. - /// if the test succeeds; otherwise. - private bool IsStickyWriteUpgradedLock(Awaiter awaiter) + Exception? onExclusiveLockReleasedTaskException = null; + try { - if (awaiter.Kind == LockKind.UpgradeableRead && (awaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite) - { - lock (this.syncObject) - { - return this.issuedWriteLocks.Contains(awaiter); - } - } + await onExclusiveLockReleasedTask.ConfigureAwait(false); + } + catch (Exception ex) + { + onExclusiveLockReleasedTaskException = ex; + } - return false; + if (fireUpgradeableReadLockReleased) + { + // This will only fire when the outermost upgradeable read is not itself nested by a write lock, + // and that's by design. + this.OnUpgradeableReadLockReleased(); } - /// - /// Checks whether the caller's held locks (or the specified lock stack) includes an active lock of the specified type. - /// Always when called on an STA thread. - /// - /// The type of lock to check for. - /// The most nested lock of the caller, or null to look up the caller's lock in the CallContext. - /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. - /// to return true when a lock is held but unusable because of the context of the caller. - /// if the caller holds active locks of the given type; otherwise. - private bool IsLockHeld(LockKind kind, Awaiter? awaiter = null, bool checkSyncContextCompatibility = true, bool allowNonLockSupportingContext = false) + lock (this.syncObject) { - if (allowNonLockSupportingContext || this.IsLockSupportingContext(awaiter)) - { - lock (this.syncObject) - { - awaiter = awaiter ?? this.topAwaiter.Value; - if (checkSyncContextCompatibility) - { - this.CheckSynchronizationContextAppropriateForLock(awaiter); - } + this.reenterConcurrencyPrepRunning = null; - return this.LockStackContains(kind, awaiter); - } - } + // Skip updating the call context because we're in a forked execution context that won't + // ever impact the client code, and changing the CallContext now would cause the data to be cloned, + // allocating more memory wastefully. + this.OnReleaseReenterConcurrencyComplete(awaiter, upgradedStickyWrite, searchAllWaiters: true); + } - return false; + if (prereqException is object) + { + // rethrow the exception we experienced before, such that it doesn't wipe out its callstack. + System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(prereqException).Throw(); } - /// - /// Checks whether a given lock is active. - /// Always when called on an STA thread. - /// - /// The lock to check. - /// if the return value will always be if called on an STA thread. - /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. - /// if the lock is currently issued and the caller is not on an STA thread. - private bool IsLockActive(Awaiter awaiter, bool considerStaActive, bool checkSyncContextCompatibility = false) + if (onExclusiveLockReleasedTaskException is object) { - Requires.NotNull(awaiter, nameof(awaiter)); + // rethrow the exception we experienced before, such that it doesn't wipe out its callstack. + System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(onExclusiveLockReleasedTaskException).Throw(); + } + } - if (considerStaActive || this.IsLockSupportingContext(awaiter)) - { - lock (this.syncObject) - { - bool activeLock = this.GetActiveLockSet(awaiter.Kind).Contains(awaiter); - if (checkSyncContextCompatibility && activeLock) - { - this.CheckSynchronizationContextAppropriateForLock(awaiter); - } + /// + /// Checks whether the specified lock has any active nested locks. + /// + private bool HasAnyNestedLocks(Awaiter lck) + { + Requires.NotNull(lck, nameof(lck)); + Assumes.True(Monitor.IsEntered(this.SyncObject)); - return activeLock; - } - } + return HasAnyNestedLocks(lck, this.issuedReadLocks) + || HasAnyNestedLocks(lck, this.issuedUpgradeableReadLocks) + || HasAnyNestedLocks(lck, this.issuedWriteLocks); + } - return false; - } + /// + /// Called at the conclusion of releasing an exclusive lock to complete the transition. + /// + /// The awaiter being released. + /// A flag indicating whether the lock being released was an upgraded read lock with the sticky write flag set. + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + private void OnReleaseReenterConcurrencyComplete(Awaiter awaiter, bool upgradedStickyWrite, bool searchAllWaiters) + { + Requires.NotNull(awaiter, nameof(awaiter)); - /// - /// Checks whether the specified awaiter's lock type has an associated SynchronizationContext if one is applicable. - /// - /// The awaiter whose lock should be considered. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic")] - private void CheckSynchronizationContextAppropriateForLock(Awaiter? awaiter) + lock (this.syncObject) { - ////bool syncContextRequired = this.LockStackContains(LockKind.UpgradeableRead, awaiter) || this.LockStackContains(LockKind.Write, awaiter); - ////if (syncContextRequired) { - //// if (!(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) { - //// Assumes.Fail(); - //// } - ////} + Assumes.True(this.GetActiveLockSet(awaiter.Kind).Remove(awaiter)); + if (upgradedStickyWrite) + { + Assumes.True(awaiter.Kind == LockKind.UpgradeableRead); + Assumes.True(this.issuedWriteLocks.Remove(awaiter)); + } + + this.CompleteIfAppropriate(); + this.TryInvokeLockConsumer(searchAllWaiters); } + } - /// - /// Immediately issues a lock to the specified awaiter if it is available. - /// - /// The awaiter to issue a lock to. - /// - /// A value indicating whether this lock was previously queued. if this is a new just received request. - /// The value is used to determine whether to reject it if has already been called and this - /// is a new top-level request. - /// - /// - /// Normally, new reader locks are no longer issued when there is a pending writer lock to allow existing reader lock to complete. - /// However, that can lead deadlocks, when tasks with issued lock depending on tasks requiring new read locks to complete. - /// When it is true, new reader locks will be issued even when there is a pending writer lock. - /// - /// A value indicating whether the lock was issued. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] - private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendingWriteLockCheck = false) + /// + /// Issues locks to one or more queued lock requests and executes their continuations + /// based on lock availability and policy-based prioritization (writer-friendly, etc.) + /// + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// if any locks were issued; otherwise. + private bool TryInvokeLockConsumer(bool searchAllWaiters) + { + return this.TryInvokeOneWriterIfAppropriate(searchAllWaiters) + || this.TryInvokeOneUpgradeableReaderIfAppropriate(searchAllWaiters) + || this.TryInvokeAllReadersIfAppropriate(searchAllWaiters); + } + + /// + /// Invokes the final write lock release callbacks, if appropriate. + /// + /// A task representing the work of sequentially invoking the callbacks. + private async Task InvokeBeforeWriteLockReleaseHandlersAsync() + { + Assumes.True(Monitor.IsEntered(this.syncObject)); + Assumes.True(this.beforeWriteReleasedCallbacks.Count > 0); + + await using ((await new Awaitable(this, LockKind.Write, LockFlags.None, CancellationToken.None, checkSyncContextCompatibility: false)).ConfigureAwait(false)) { - lock (this.syncObject) + await Task.Yield(); // ensure we've yielded to our caller, since the WriteLockAsync will not yield when on an MTA thread. + + // We sequentially loop over the callbacks rather than fire them concurrently because each callback + // gets visibility into the write lock, which of course provides exclusivity and concurrency would violate that. + // We also avoid executing the synchronous portions all in a row and awaiting them all + // because that too would violate an individual callback's sense of isolation in a write lock. + List? exceptions = null; + while (this.TryDequeueBeforeWriteReleasedCallback(out Func? callback)) { - if (this.completeInvoked && !previouslyQueued) + try { - // If this is a new top-level lock request, reject it completely. - if (awaiter.NestingLock is null) - { - awaiter.SetFault(new InvalidOperationException(Strings.LockCompletionAlreadyRequested)); - return false; - } + await callback().ConfigureAwait(true); } - - bool issued = false; - if (this.reenterConcurrencyPrepRunning is null) + catch (Exception ex) { - if (this.issuedWriteLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedReadLocks.Count == 0) + if (exceptions is null) { - issued = true; + exceptions = new List(); } - else - { - this.AggregateLockStackKinds(awaiter, out bool hasRead, out bool hasUpgradeableRead, out bool hasWrite); - switch (awaiter.Kind) - { - case LockKind.Read: - if (this.issuedWriteLocks.Count == 0 && (skipPendingWriteLockCheck || this.waitingWriters.Count == 0)) - { - issued = true; - } - else if (hasWrite) - { - // We allow STA threads to not have the sync context applied because it never has it applied, - // and a write lock holder is allowed to transition to an STA tread. - // But if an MTA thread has the write lock but not the sync context, then they're likely - // an accidental execution fork that is exposing concurrency inappropriately. - if (this.CanCurrentThreadHoldActiveLock && !(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) - { - Report.Fail("Dangerous request for read lock from fork of write lock."); - Verify.FailOperation(Strings.DangerousReadLockRequestFromWriteLockFork); - } - - issued = true; - } - else if (hasRead || hasUpgradeableRead) - { - issued = true; - } - - break; - case LockKind.UpgradeableRead: - if (hasUpgradeableRead || hasWrite) - { - issued = true; - } - else if (hasRead) - { - // We cannot issue an upgradeable read lock to folks who have (only) a read lock. - throw new InvalidOperationException(Strings.CannotUpgradeNonUpgradeableLock); - } -#pragma warning disable CA1508 // Avoid dead conditional code - else if (this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0) -#pragma warning restore CA1508 // Avoid dead conditional code - { - issued = true; - } - - break; - case LockKind.Write: - if (hasWrite) - { - issued = true; - } - else if (hasRead && !hasUpgradeableRead) - { - // We cannot issue a write lock when the caller already holds a read lock. - throw new InvalidOperationException(Strings.CannotUpgradeNonUpgradeableLock); - } - else if (this.AllHeldLocksAreByThisStack(awaiter.NestingLock)) - { - issued = true; - - Awaiter? stickyWriteAwaiter = this.FindRootUpgradeableReadWithStickyWrite(awaiter); - if (stickyWriteAwaiter is object) - { - // Add the upgradeable reader as a write lock as well. - this.issuedWriteLocks.Add(stickyWriteAwaiter); - } - } - break; - default: - throw Assumes.NotReachable(); - } - } + exceptions.Add(ex); } + } - if (issued) - { - this.GetActiveLockSet(awaiter.Kind).Add(awaiter); - this.etw.Issued(awaiter); - } + if (exceptions is object) + { + throw new AggregateException(exceptions); + } + } + } - if (!issued) - { - this.etw.WaitStart(awaiter); + /// + /// Dequeues a single write lock release callback if available. + /// + /// Receives the callback to invoke, if any. + /// A value indicating whether a callback was available to invoke. + private bool TryDequeueBeforeWriteReleasedCallback([NotNullWhen(true)] out Func? callback) + { + lock (this.syncObject) + { + if (this.beforeWriteReleasedCallbacks.Count > 0) + { + callback = this.beforeWriteReleasedCallbacks.Dequeue(); + return true; + } + else + { + callback = null; + return false; + } + } + } - // If the lock is immediately available, we don't need to coordinate with other threads. - // But if it is NOT available, we'd have to wait potentially for other threads to do more work. - Debugger.NotifyOfCrossThreadDependency(); - } + /// + /// Stores the specified lock in the CallContext dictionary. + /// + /// The awaiter that tracks the lock to grant to the caller. + private void ApplyLockToCallContext(Awaiter? topAwaiter) + { + Awaiter? awaiter = this.GetFirstActiveSelfOrAncestor(topAwaiter); + this.topAwaiter.Value = awaiter; + } - return issued; + /// + /// Issues locks to all queued reader lock requests if there are no issued write locks. + /// + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// A value indicating whether any readers were issued locks. + private bool TryInvokeAllReadersIfAppropriate(bool searchAllWaiters) + { + bool invoked = false; + if (this.issuedWriteLocks.Count == 0 && this.waitingWriters.Count == 0) + { + while (this.waitingReaders.Count > 0) + { + Awaiter? pendingReader = this.waitingReaders.Dequeue(); + Assumes.True(pendingReader.Kind == LockKind.Read); + this.IssueAndExecute(pendingReader); + invoked = true; } } - - /// - /// Finds the upgradeable reader with flag that is nearest - /// to the top-level lock request held by the given lock holder. - /// - /// The awaiter to start the search down the stack from. - /// The least nested upgradeable reader lock with sticky write flag; or if none was found. - private Awaiter? FindRootUpgradeableReadWithStickyWrite(Awaiter? headAwaiter) + else if (searchAllWaiters) { - if (headAwaiter is null) + if (this.TryInvokeAnyWaitersInQueue(this.waitingReaders, breakOnFirstIssue: false)) { - return null; + return true; } + } - Awaiter? lowerMatch = this.FindRootUpgradeableReadWithStickyWrite(headAwaiter.NestingLock); - if (lowerMatch is object) - { - return lowerMatch; - } + return invoked; + } - if (headAwaiter.Kind == LockKind.UpgradeableRead && (headAwaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite) + private void TryInvokeAllDependentReadersIfAppropriate() + { + lock (this.syncObject) + { + if (this.issuedWriteLocks.Count == 0 && this.waitingWriters.Count > 0 && this.waitingReaders.Count > 0 && (this.issuedReadLocks.Count > 0 || this.issuedUpgradeableReadLocks.Count > 0)) { - lock (this.syncObject) + HashSet? dependentTasks = JoinableTaskDependencyGraph.GetDependentTasksFromCandidates( + this.issuedReadLocks.Concat(this.issuedUpgradeableReadLocks).Where(w => w.AmbientJoinableTask is not null).Select(w => w.AmbientJoinableTask!), + this.waitingReaders.Where(w => w.AmbientJoinableTask is not null).Select(w => w.AmbientJoinableTask!)); + + if (dependentTasks.Count > 0) { - if (this.issuedUpgradeableReadLocks.Contains(headAwaiter)) + int pendingCount = this.waitingReaders.Count; + while (pendingCount-- != 0) { - return headAwaiter; + Awaiter pendingReader = this.waitingReaders.Dequeue(); + JoinableTask? readerContext = pendingReader.AmbientJoinableTask; + if (readerContext is not null && dependentTasks.Contains(readerContext)) + { + this.IssueAndExecute(pendingReader); + } + else + { + this.waitingReaders.Enqueue(pendingReader); + } } } } - - return null; } + } - /// - /// Gets the set of locks of a given kind. - /// - /// The kind of lock. - /// A set of locks. - private HashSet GetActiveLockSet(LockKind kind) + /// + /// Issues a lock to the next queued upgradeable reader, if no upgradeable read or write locks are currently issued. + /// + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// A value indicating whether any upgradeable readers were issued locks. + private bool TryInvokeOneUpgradeableReaderIfAppropriate(bool searchAllWaiters) + { + if (this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0) { - switch (kind) + if (this.waitingUpgradeableReaders.Count > 0) { - case LockKind.Read: - return this.issuedReadLocks; - case LockKind.UpgradeableRead: - return this.issuedUpgradeableReadLocks; - case LockKind.Write: - return this.issuedWriteLocks; - default: - throw Assumes.NotReachable(); + Awaiter? pendingUpgradeableReader = this.waitingUpgradeableReaders.Dequeue(); + Assumes.True(pendingUpgradeableReader.Kind == LockKind.UpgradeableRead); + this.IssueAndExecute(pendingUpgradeableReader); + return true; } } - - /// - /// Gets the queue for a lock with a given type. - /// - /// The kind of lock. - /// A queue. - private Queue GetLockQueue(LockKind kind) + else if (searchAllWaiters) { - switch (kind) + if (this.TryInvokeAnyWaitersInQueue(this.waitingUpgradeableReaders, breakOnFirstIssue: true)) { - case LockKind.Read: - return this.waitingReaders; - case LockKind.UpgradeableRead: - return this.waitingUpgradeableReaders; - case LockKind.Write: - return this.waitingWriters; - default: - throw Assumes.NotReachable(); + return true; } } - /// - /// Walks the nested lock stack until it finds an active one. - /// - /// The most nested lock to consider. May be null. - /// The first active lock encountered, or if none. - private Awaiter? GetFirstActiveSelfOrAncestor(Awaiter? awaiter) + return false; + } + + /// + /// Issues a lock to the next queued writer, if no other locks are currently issued + /// or the last contending read lock was removed allowing a waiting upgradeable reader to upgrade. + /// + /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. + /// A value indicating whether a writer was issued a lock. + private bool TryInvokeOneWriterIfAppropriate(bool searchAllWaiters) + { + if (this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0) { - while (awaiter is object) + if (this.waitingWriters.Count > 0) { - if (this.IsLockActive(awaiter, considerStaActive: true)) + Awaiter? pendingWriter = this.waitingWriters.Dequeue(); + if (this.waitingWriters.Count == 0) { - break; + this.StopPendingWriterLockDeadlockWatching(); } - awaiter = awaiter.NestingLock; + Assumes.True(pendingWriter.Kind == LockKind.Write); + this.IssueAndExecute(pendingWriter); + return true; } - - return awaiter; } - - /// - /// Issues a lock to the specified awaiter and executes its continuation. - /// The awaiter should have already been dequeued. - /// - /// The awaiter to issue a lock to and execute. - private void IssueAndExecute(Awaiter awaiter) + else if (this.issuedUpgradeableReadLocks.Count > 0 || searchAllWaiters) { - EventsHelper.WaitStop(awaiter); - Assumes.True(this.TryIssueLock(awaiter, previouslyQueued: true, skipPendingWriteLockCheck: true)); - Assumes.True(this.ExecuteOrHandleCancellation(awaiter, stillInQueue: false)); - } - - /// - /// Releases the lock held by the specified awaiter. - /// - /// The awaiter holding an active lock. - /// A value indicating whether the lock consumer ended up not executing any work. - /// - /// A task that should complete before the releasing thread accesses any resource protected by - /// a lock wrapping the lock being released. - /// The task will always be complete if is . - /// This method guarantees that the lock is effectively released from the caller, and the - /// can be safely recycled, before the synchronous portion of this method completes. - /// - [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] - private Task ReleaseAsync(Awaiter awaiter, bool lockConsumerCanceled = false) - { - // This method does NOT use the async keyword in its signature to avoid CallContext changes that we make - // causing a fork/clone of the CallContext, which defeats our alloc-free uncontested lock story. - - // No one should have any locks to release (and be executing code) if we're in our intermediate state. - // When this test fails, it's because someone had an exclusive lock and allowed concurrently executing - // code to fork off and acquire a read (or upgradeable read?) lock, then outlive the parent write lock. - // This is an illegal pattern both because it means an exclusive lock is used concurrently (while the - // parent write lock is active) and when the write lock is released, it means that the child "read" - // lock suddenly became a "concurrent" lock, but we can't transition all the resources from exclusive - // access to concurrent access while someone is actually holding a lock (as such transition requires - // the lock class itself to have the exclusive lock to protect the resources going through the transition). - Awaiter? illegalConcurrentLock = this.reenterConcurrencyPrepRunning; // capture to local to preserve evidence in a concurrently reset field. - if (illegalConcurrentLock is object) + if (this.TryInvokeAnyWaitersInQueue(this.waitingWriters, breakOnFirstIssue: true)) { - try - { - Assumes.Fail(string.Format(CultureInfo.CurrentCulture, "Illegal concurrent use of exclusive lock. Exclusive lock: {0}, Nested lock that outlived parent: {1}", illegalConcurrentLock, awaiter)); - } - catch (Exception ex) - { - throw this.OnCriticalFailure(ex); - } + return true; } + } - if (!this.IsLockActive(awaiter, considerStaActive: true)) - { - return Task.CompletedTask; - } + return false; + } - Task? reenterConcurrentOutsideCode = null; - Task? synchronousCallbackExecution = null; - bool synchronousRequired = false; - Awaiter? remainingAwaiter = null; - Awaiter? topAwaiterAtStart = this.topAwaiter.Value; // do this outside the lock because it's fairly expensive and doesn't require the lock. + /// + /// Scans a lock awaiter queue for any that can be issued locks now. + /// + /// The queue to scan. + /// to break out immediately after issuing the first lock. + /// if any lock was issued; otherwise. + private bool TryInvokeAnyWaitersInQueue(Queue waiters, bool breakOnFirstIssue) + { + Requires.NotNull(waiters, nameof(waiters)); - lock (this.syncObject) + bool invoked = false; + bool invokedThisLoop; + do + { + invokedThisLoop = false; + foreach (Awaiter? lockWaiter in waiters) { - // In case this is a sticky write lock, it may also belong to the write locks issued collection. - bool upgradedStickyWrite = awaiter.Kind == LockKind.UpgradeableRead - && (awaiter.Options & LockFlags.StickyWrite) == LockFlags.StickyWrite - && this.issuedWriteLocks.Contains(awaiter); - - int writeLocksBefore = this.issuedWriteLocks.Count; - int upgradeableReadLocksBefore = this.issuedUpgradeableReadLocks.Count; - int writeLocksAfter = writeLocksBefore - ((awaiter.Kind == LockKind.Write || upgradedStickyWrite) ? 1 : 0); - int upgradeableReadLocksAfter = upgradeableReadLocksBefore - (awaiter.Kind == LockKind.UpgradeableRead ? 1 : 0); - bool finalExclusiveLockRelease = writeLocksBefore > 0 && writeLocksAfter == 0; - - Task callbackExecution = Task.CompletedTask; - if (!lockConsumerCanceled) + if (this.TryIssueLock(lockWaiter, previouslyQueued: true)) { - // Callbacks should be fired synchronously iff the last write lock is being released and read locks are already issued. - // This can occur when upgradeable read locks are held and upgraded, and then downgraded back to an upgradeable read. - callbackExecution = this.OnBeforeLockReleasedAsync(finalExclusiveLockRelease, new LockHandle(awaiter)) ?? Task.CompletedTask; - synchronousRequired = finalExclusiveLockRelease && upgradeableReadLocksAfter > 0; - if (synchronousRequired) + // Run the continuation asynchronously (since this is called in OnCompleted, which is an async pattern). + Assumes.True(this.ExecuteOrHandleCancellation(lockWaiter, stillInQueue: true)); + invoked = true; + invokedThisLoop = true; + if (breakOnFirstIssue) { - synchronousCallbackExecution = callbackExecution; + return true; } - } - if (!lockConsumerCanceled) - { - if (writeLocksAfter == 0) - { - bool fireWriteLockReleased = writeLocksBefore > 0; - bool fireUpgradeableReadLockReleased = upgradeableReadLocksBefore > 0 && upgradeableReadLocksAfter == 0; - if (fireWriteLockReleased || fireUpgradeableReadLockReleased) - { - // The Task.Run is invoked from another method so that C# doesn't allocate the anonymous delegate - // it uses unless we actually are going to invoke it -- - if (fireWriteLockReleased) - { - reenterConcurrentOutsideCode = this.DowngradeLockAsync(awaiter, upgradedStickyWrite, fireUpgradeableReadLockReleased, callbackExecution); - } - else if (fireUpgradeableReadLockReleased) - { - this.OnUpgradeableReadLockReleased(); - } - } - } - } + EventsHelper.WaitStop(lockWaiter); - if (reenterConcurrentOutsideCode is null) - { - this.OnReleaseReenterConcurrencyComplete(awaiter, upgradedStickyWrite, searchAllWaiters: false); + // At this point, the waiter was removed from the queue, so we can't keep + // enumerating the queue or we'll get an InvalidOperationException. + // Break out of the foreach, but the while loop will re-enter and we'll + // examine other possibilities. + break; } - - remainingAwaiter = this.GetFirstActiveSelfOrAncestor(topAwaiterAtStart); } + } + while (invokedThisLoop); // keep looping while we find matching locks. - // Updating the topAwaiter requires touching the CallContext, which significantly increases the perf/GC hit - // for releasing locks. So we prefer to leave a released lock in the context and walk up the lock stack when - // necessary. But we will clean it up if it's the last lock released. - if (remainingAwaiter is null) + return invoked; + } + + /// + /// Issues a lock to a lock waiter and execute its code if the lock is immediately available, otherwise + /// queues the lock request. + /// + /// The lock request. + private void PendAwaiter(Awaiter awaiter) + { + lock (this.syncObject) + { + if (this.TryIssueLock(awaiter, previouslyQueued: true)) { - // This assignment is outside the lock because it doesn't need the lock and it's a relatively expensive call - // that we needn't hold the lock for. - this.topAwaiter.Value = remainingAwaiter; + // Run the continuation asynchronously (since this is called in OnCompleted, which is an async pattern). + Assumes.True(this.ExecuteOrHandleCancellation(awaiter, stillInQueue: false)); } + else + { + Queue? queue = this.GetLockQueue(awaiter.Kind); + queue.Enqueue(awaiter); - if (synchronousRequired || true) - { // the "|| true" bit is to force us to always be synchronous when releasing locks until we can get all tests passing the other way. - if (reenterConcurrentOutsideCode is object && (synchronousCallbackExecution is object && !synchronousCallbackExecution.IsCompleted)) + if (awaiter.Kind == LockKind.Write) { - return Task.WhenAll(reenterConcurrentOutsideCode, synchronousCallbackExecution); + this.StartPendingWriterDeadlockTimerIfNecessary(); } - else - { - return reenterConcurrentOutsideCode ?? synchronousCallbackExecution ?? Task.CompletedTask; - } - } - else - { - return Task.CompletedTask; } } + } - /// - /// Schedules work on a background thread that will prepare protected resource(s) for concurrent access. - /// - private async Task DowngradeLockAsync(Awaiter awaiter, bool upgradedStickyWrite, bool fireUpgradeableReadLockReleased, Task beginAfterPrerequisite) + private void StartPendingWriterDeadlockTimerIfNecessary() + { + if (this.joinableTaskContext is not null && + this.pendingWriterLockDeadlockCheckTimer is null && + this.waitingWriters.Count > 0 && + (this.issuedReadLocks.Count > 0 || this.issuedUpgradeableReadLocks.Count > 0)) { - Requires.NotNull(awaiter, nameof(awaiter)); - Requires.NotNull(beginAfterPrerequisite, nameof(beginAfterPrerequisite)); + this.pendingWriterLockDeadlockCheckTimer = new Timer(PendingWriterLockDeadlockWatchingCallback, this, (int)this.DeadlockCheckTimeout.TotalMilliseconds, -1); + } + } - Exception? prereqException = null; - try - { - await beginAfterPrerequisite.ConfigureAwait(SynchronizationContext.Current is NonConcurrentSynchronizationContext); - } - catch (Exception ex) - { - prereqException = ex; - } + private void StopPendingWriterLockDeadlockWatching() + { + if (this.pendingWriterLockDeadlockCheckTimer is not null) + { + this.pendingWriterLockDeadlockCheckTimer.Dispose(); + this.pendingWriterLockDeadlockCheckTimer = null; + } + } - Task onExclusiveLockReleasedTask; - lock (this.syncObject) + /// + /// Executes the lock receiver or releases the lock because the request for it was canceled before it was issued. + /// + /// The awaiter. + /// A value indicating whether the specified is expected to still be in the queue (and should be removed). + /// A value indicating whether a continuation delegate was actually invoked. + private bool ExecuteOrHandleCancellation(Awaiter awaiter, bool stillInQueue) + { + Requires.NotNull(awaiter, nameof(awaiter)); + + lock (this.SyncObject) + { + if (stillInQueue) { - // Check that no read locks are held. If they are, then that's a sign that - // within this write lock, someone took a read lock that is outliving the nesting - // write lock, which is a very dangerous situation. - if (this.issuedReadLocks.Count > 0) + // The lock class can't deal well with cancelled lock requests remaining in its queue. + // Remove the awaiter, wherever in the queue it happens to be. + Queue? queue = this.GetLockQueue(awaiter.Kind); + if (!queue.RemoveMidQueue(awaiter)) { - if (this.HasAnyNestedLocks(awaiter)) - { - try - { - throw new InvalidOperationException(Strings.WriteLockOutlived); - } - catch (InvalidOperationException ex) - { - this.OnCriticalFailure(ex); - } - } + // This can happen when the lock request is cancelled, but during a race + // condition where the lock was just about to be issued anyway. + Assumes.True(awaiter.CancellationToken.IsCancellationRequested); + return false; } - - this.reenterConcurrencyPrepRunning = awaiter; - onExclusiveLockReleasedTask = this.OnExclusiveLockReleasedAsync(); - } - - Exception? onExclusiveLockReleasedTaskException = null; - try - { - await onExclusiveLockReleasedTask.ConfigureAwait(false); - } - catch (Exception ex) - { - onExclusiveLockReleasedTaskException = ex; } - if (fireUpgradeableReadLockReleased) - { - // This will only fire when the outermost upgradeable read is not itself nested by a write lock, - // and that's by design. - this.OnUpgradeableReadLockReleased(); - } - - lock (this.syncObject) - { - this.reenterConcurrencyPrepRunning = null; + return awaiter.TryScheduleContinuationExecution(); + } + } - // Skip updating the call context because we're in a forked execution context that won't - // ever impact the client code, and changing the CallContext now would cause the data to be cloned, - // allocating more memory wastefully. - this.OnReleaseReenterConcurrencyComplete(awaiter, upgradedStickyWrite, searchAllWaiters: true); - } + /// + /// An awaitable that is returned from asynchronous lock requests. + /// + public readonly struct Awaitable + { + /// + /// The awaiter to return from the method. + /// + private readonly Awaiter? awaiter; - if (prereqException is object) + /// + /// Initializes a new instance of the struct. + /// + /// The lock class that created this instance. + /// The type of lock being requested. + /// Any flags applied to the lock request. + /// The cancellation token. + /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. + internal Awaitable(AsyncReaderWriterLock lck, LockKind kind, LockFlags options, CancellationToken cancellationToken, bool checkSyncContextCompatibility = true) + { + if (checkSyncContextCompatibility) { - // rethrow the exception we experienced before, such that it doesn't wipe out its callstack. - System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(prereqException).Throw(); + lck.CheckSynchronizationContextAppropriateForLock(lck.topAwaiter.Value); } - if (onExclusiveLockReleasedTaskException is object) + this.awaiter = new Awaiter(lck, kind, options, cancellationToken); + if (!cancellationToken.IsCancellationRequested) { - // rethrow the exception we experienced before, such that it doesn't wipe out its callstack. - System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(onExclusiveLockReleasedTaskException).Throw(); + lck.TryIssueLock(this.awaiter, previouslyQueued: false); } } /// - /// Checks whether the specified lock has any active nested locks. + /// Gets the awaiter value. /// - private bool HasAnyNestedLocks(Awaiter lck) + public Awaiter GetAwaiter() { - Requires.NotNull(lck, nameof(lck)); - Assumes.True(Monitor.IsEntered(this.SyncObject)); + if (this.awaiter is null) + { + throw new InvalidOperationException(); + } - return HasAnyNestedLocks(lck, this.issuedReadLocks) - || HasAnyNestedLocks(lck, this.issuedUpgradeableReadLocks) - || HasAnyNestedLocks(lck, this.issuedWriteLocks); + return this.awaiter; } + } + /// + /// A value whose disposal releases a held lock. + /// + [DebuggerDisplay("{awaiter.kind}")] + public readonly struct Releaser : IDisposable, System.IAsyncDisposable + { /// - /// Called at the conclusion of releasing an exclusive lock to complete the transition. + /// The awaiter who manages the lifetime of a lock. /// - /// The awaiter being released. - /// A flag indicating whether the lock being released was an upgraded read lock with the sticky write flag set. - /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. - private void OnReleaseReenterConcurrencyComplete(Awaiter awaiter, bool upgradedStickyWrite, bool searchAllWaiters) - { - Requires.NotNull(awaiter, nameof(awaiter)); - - lock (this.syncObject) - { - Assumes.True(this.GetActiveLockSet(awaiter.Kind).Remove(awaiter)); - if (upgradedStickyWrite) - { - Assumes.True(awaiter.Kind == LockKind.UpgradeableRead); - Assumes.True(this.issuedWriteLocks.Remove(awaiter)); - } - - this.CompleteIfAppropriate(); - this.TryInvokeLockConsumer(searchAllWaiters); - } - } + private readonly Awaiter? awaiter; /// - /// Issues locks to one or more queued lock requests and executes their continuations - /// based on lock availability and policy-based prioritization (writer-friendly, etc.) + /// Initializes a new instance of the struct. /// - /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. - /// if any locks were issued; otherwise. - private bool TryInvokeLockConsumer(bool searchAllWaiters) + /// The awaiter. + internal Releaser(Awaiter awaiter) { - return this.TryInvokeOneWriterIfAppropriate(searchAllWaiters) - || this.TryInvokeOneUpgradeableReaderIfAppropriate(searchAllWaiters) - || this.TryInvokeAllReadersIfAppropriate(searchAllWaiters); + this.awaiter = awaiter; } /// - /// Invokes the final write lock release callbacks, if appropriate. + /// Releases the lock. /// - /// A task representing the work of sequentially invoking the callbacks. - private async Task InvokeBeforeWriteLockReleaseHandlersAsync() + public void Dispose() { - Assumes.True(Monitor.IsEntered(this.syncObject)); - Assumes.True(this.beforeWriteReleasedCallbacks.Count > 0); - - await using ((await new Awaitable(this, LockKind.Write, LockFlags.None, CancellationToken.None, checkSyncContextCompatibility: false)).ConfigureAwait(false)) + if (this.awaiter is object) { - await Task.Yield(); // ensure we've yielded to our caller, since the WriteLockAsync will not yield when on an MTA thread. + var nonConcurrentSyncContext = SynchronizationContext.Current as NonConcurrentSynchronizationContext; - // We sequentially loop over the callbacks rather than fire them concurrently because each callback - // gets visibility into the write lock, which of course provides exclusivity and concurrency would violate that. - // We also avoid executing the synchronous portions all in a row and awaiting them all - // because that too would violate an individual callback's sense of isolation in a write lock. - List? exceptions = null; - while (this.TryDequeueBeforeWriteReleasedCallback(out Func? callback)) + // NOTE: when we have already called ReleaseAsync, and the lock has been released, + // we don't want to load the concurrent context and try to take it back immediately. If we do, it is possible + // that anther thread waiting for a write lock can take the concurrent context, so the current thread will be + // blocked and wait until it is done, and that makes it possible to run into the thread pool exhaustion trap. + if (!this.awaiter.IsReleased) { - try - { - await callback().ConfigureAwait(true); - } - catch (Exception ex) + using (nonConcurrentSyncContext is object ? nonConcurrentSyncContext.LoanBackAnyHeldResource(this.awaiter.OwningLock) : default(NonConcurrentSynchronizationContext.LoanBack)) { - if (exceptions is null) + Task? releaseTask = this.awaiter.ReleaseAsync(); + using (NoMessagePumpSyncContext.Default.Apply()) { - exceptions = new List(); + try + { + while (!releaseTask.Wait(1000)) + { // this loop allows us to break into the debugger and step into managed code to analyze a hang. + } + } + catch (AggregateException) + { + // We want to throw the inner exception itself -- not the AggregateException. + releaseTask.GetAwaiter().GetResult(); + } } - - exceptions.Add(ex); } } - if (exceptions is object) + if (nonConcurrentSyncContext is object && !this.awaiter.OwningLock.AmbientLock.IsValid) { - throw new AggregateException(exceptions); + // The lock holder is taking the synchronous path to release the last UR/W lock held. + // Since they may go synchronously on their merry way for a while, forcibly release + // the sync context's semaphore that they otherwise would hold until their synchronous + // method returns. + nonConcurrentSyncContext.EarlyExitSynchronizationContext(); } } } /// - /// Dequeues a single write lock release callback if available. + /// Releases the lock. /// - /// Receives the callback to invoke, if any. - /// A value indicating whether a callback was available to invoke. - private bool TryDequeueBeforeWriteReleasedCallback([NotNullWhen(true)] out Func? callback) + public async ValueTask DisposeAsync() { - lock (this.syncObject) + await this.ReleaseAsync().ConfigureAwaitRunInline(); + this.Dispose(); + } + + /// + /// Asynchronously releases the lock. Dispose should still be called after this. + /// + /// + /// A task that should complete before the releasing thread accesses any resource protected by + /// a lock wrapping the lock being released. + /// + /// + /// Rather than calling this method explicitly, use the C# 8 "await using" syntax instead. + /// + public Task ReleaseAsync() + { + if (this.awaiter is object) { - if (this.beforeWriteReleasedCallbacks.Count > 0) - { - callback = this.beforeWriteReleasedCallbacks.Dequeue(); - return true; - } - else + var nonConcurrentSyncContext = SynchronizationContext.Current as NonConcurrentSynchronizationContext; + using (nonConcurrentSyncContext is object ? nonConcurrentSyncContext.LoanBackAnyHeldResource(this.awaiter.OwningLock) : default(NonConcurrentSynchronizationContext.LoanBack)) { - callback = null; - return false; + return this.awaiter.ReleaseAsync(); } } + + return Task.CompletedTask; + } + } + + /// + /// A value whose disposal restores visibility of any locks held by the caller. + /// + public readonly struct Suppression : IDisposable + { + /// + /// The locking class. + /// + private readonly AsyncReaderWriterLock? lck; + + /// + /// The awaiter most recently acquired by the caller before hiding locks. + /// + private readonly Awaiter? awaiter; + + /// + /// Initializes a new instance of the struct. + /// + /// The lock class. + internal Suppression(AsyncReaderWriterLock lck) + { + this.lck = lck; + this.awaiter = this.lck.topAwaiter.Value; + if (this.awaiter is object) + { + this.lck.topAwaiter.Value = null; + } + } + + /// + /// Restores visibility of hidden locks. + /// + public void Dispose() + { + if (this.lck is object) + { + this.lck.ApplyLockToCallContext(this.awaiter); + } + } + } + + /// + /// A "public" representation of a specific lock. + /// + protected readonly struct LockHandle + { + /// + /// The awaiter this lock handle wraps. + /// + private readonly Awaiter? awaiter; + + /// + /// Initializes a new instance of the struct. + /// + internal LockHandle(Awaiter? awaiter) + { + this.awaiter = awaiter; + } + + /// + /// Gets a value indicating whether this handle is to a lock which was actually acquired. + /// + public bool IsValid + { + get { return this.awaiter is object; } + } + + /// + /// Gets a value indicating whether this lock is still active. + /// + public bool IsActive + { + get { return this.IsValid && this.awaiter!.OwningLock.IsLockActive(this.awaiter, considerStaActive: true); } + } + + /// + /// Gets a value indicating whether this lock represents a read lock. + /// + public bool IsReadLock + { + get { return this.IsValid ? this.awaiter!.Kind == LockKind.Read : false; } } /// - /// Stores the specified lock in the CallContext dictionary. + /// Gets a value indicating whether this lock represents an upgradeable read lock. /// - /// The awaiter that tracks the lock to grant to the caller. - private void ApplyLockToCallContext(Awaiter? topAwaiter) + public bool IsUpgradeableReadLock { - Awaiter? awaiter = this.GetFirstActiveSelfOrAncestor(topAwaiter); - this.topAwaiter.Value = awaiter; + get { return this.IsValid ? this.awaiter!.Kind == LockKind.UpgradeableRead : false; } } /// - /// Issues locks to all queued reader lock requests if there are no issued write locks. + /// Gets a value indicating whether this lock represents a write lock. /// - /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. - /// A value indicating whether any readers were issued locks. - private bool TryInvokeAllReadersIfAppropriate(bool searchAllWaiters) + public bool IsWriteLock { - bool invoked = false; - if (this.issuedWriteLocks.Count == 0 && this.waitingWriters.Count == 0) - { - while (this.waitingReaders.Count > 0) - { - Awaiter? pendingReader = this.waitingReaders.Dequeue(); - Assumes.True(pendingReader.Kind == LockKind.Read); - this.IssueAndExecute(pendingReader); - invoked = true; - } - } - else if (searchAllWaiters) - { - if (this.TryInvokeAnyWaitersInQueue(this.waitingReaders, breakOnFirstIssue: false)) - { - return true; - } - } - - return invoked; + get { return this.IsValid ? this.awaiter!.Kind == LockKind.Write : false; } } - private void TryInvokeAllDependentReadersIfAppropriate() + /// + /// Gets a value indicating whether this lock is an active read lock or is nested by one. + /// + public bool HasReadLock { - lock (this.syncObject) - { - if (this.issuedWriteLocks.Count == 0 && this.waitingWriters.Count > 0 && this.waitingReaders.Count > 0 && (this.issuedReadLocks.Count > 0 || this.issuedUpgradeableReadLocks.Count > 0)) - { - HashSet? dependentTasks = JoinableTaskDependencyGraph.GetDependentTasksFromCandidates( - this.issuedReadLocks.Concat(this.issuedUpgradeableReadLocks).Where(w => w.AmbientJoinableTask is not null).Select(w => w.AmbientJoinableTask!), - this.waitingReaders.Where(w => w.AmbientJoinableTask is not null).Select(w => w.AmbientJoinableTask!)); - - if (dependentTasks.Count > 0) - { - int pendingCount = this.waitingReaders.Count; - while (pendingCount-- != 0) - { - Awaiter pendingReader = this.waitingReaders.Dequeue(); - JoinableTask? readerContext = pendingReader.AmbientJoinableTask; - if (readerContext is not null && dependentTasks.Contains(readerContext)) - { - this.IssueAndExecute(pendingReader); - } - else - { - this.waitingReaders.Enqueue(pendingReader); - } - } - } - } - } + get { return this.IsValid ? this.awaiter!.OwningLock.IsLockHeld(LockKind.Read, this.awaiter, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true) : false; } } /// - /// Issues a lock to the next queued upgradeable reader, if no upgradeable read or write locks are currently issued. + /// Gets a value indicating whether this lock is an active upgradeable read lock or is nested by one. /// - /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. - /// A value indicating whether any upgradeable readers were issued locks. - private bool TryInvokeOneUpgradeableReaderIfAppropriate(bool searchAllWaiters) + public bool HasUpgradeableReadLock { - if (this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0) - { - if (this.waitingUpgradeableReaders.Count > 0) - { - Awaiter? pendingUpgradeableReader = this.waitingUpgradeableReaders.Dequeue(); - Assumes.True(pendingUpgradeableReader.Kind == LockKind.UpgradeableRead); - this.IssueAndExecute(pendingUpgradeableReader); - return true; - } - } - else if (searchAllWaiters) - { - if (this.TryInvokeAnyWaitersInQueue(this.waitingUpgradeableReaders, breakOnFirstIssue: true)) - { - return true; - } - } - - return false; + get { return this.IsValid ? this.awaiter!.OwningLock.IsLockHeld(LockKind.UpgradeableRead, this.awaiter, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true) : false; } } /// - /// Issues a lock to the next queued writer, if no other locks are currently issued - /// or the last contending read lock was removed allowing a waiting upgradeable reader to upgrade. + /// Gets a value indicating whether this lock is an active write lock or is nested by one. /// - /// to scan the entire queue for pending lock requests that might qualify; used when qualifying locks were delayed for some reason besides lock contention. - /// A value indicating whether a writer was issued a lock. - private bool TryInvokeOneWriterIfAppropriate(bool searchAllWaiters) + public bool HasWriteLock { - if (this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0) - { - if (this.waitingWriters.Count > 0) - { - Awaiter? pendingWriter = this.waitingWriters.Dequeue(); - if (this.waitingWriters.Count == 0) - { - this.StopPendingWriterLockDeadlockWatching(); - } - - Assumes.True(pendingWriter.Kind == LockKind.Write); - this.IssueAndExecute(pendingWriter); - return true; - } - } - else if (this.issuedUpgradeableReadLocks.Count > 0 || searchAllWaiters) - { - if (this.TryInvokeAnyWaitersInQueue(this.waitingWriters, breakOnFirstIssue: true)) - { - return true; - } - } - - return false; + get { return this.IsValid ? this.awaiter!.OwningLock.IsLockHeld(LockKind.Write, this.awaiter, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true) : false; } } /// - /// Scans a lock awaiter queue for any that can be issued locks now. + /// Gets the flags that were passed into this lock. /// - /// The queue to scan. - /// to break out immediately after issuing the first lock. - /// if any lock was issued; otherwise. - private bool TryInvokeAnyWaitersInQueue(Queue waiters, bool breakOnFirstIssue) + public LockFlags Flags { - Requires.NotNull(waiters, nameof(waiters)); - - bool invoked = false; - bool invokedThisLoop; - do - { - invokedThisLoop = false; - foreach (Awaiter? lockWaiter in waiters) - { - if (this.TryIssueLock(lockWaiter, previouslyQueued: true)) - { - // Run the continuation asynchronously (since this is called in OnCompleted, which is an async pattern). - Assumes.True(this.ExecuteOrHandleCancellation(lockWaiter, stillInQueue: true)); - invoked = true; - invokedThisLoop = true; - if (breakOnFirstIssue) - { - return true; - } - - EventsHelper.WaitStop(lockWaiter); - - // At this point, the waiter was removed from the queue, so we can't keep - // enumerating the queue or we'll get an InvalidOperationException. - // Break out of the foreach, but the while loop will re-enter and we'll - // examine other possibilities. - break; - } - } - } - while (invokedThisLoop); // keep looping while we find matching locks. - - return invoked; + get { return this.IsValid ? this.awaiter!.Options : LockFlags.None; } } /// - /// Issues a lock to a lock waiter and execute its code if the lock is immediately available, otherwise - /// queues the lock request. + /// Gets or sets some object associated to this specific lock. /// - /// The lock request. - private void PendAwaiter(Awaiter awaiter) + public object? Data { - lock (this.syncObject) + get { - if (this.TryIssueLock(awaiter, previouslyQueued: true)) - { - // Run the continuation asynchronously (since this is called in OnCompleted, which is an async pattern). - Assumes.True(this.ExecuteOrHandleCancellation(awaiter, stillInQueue: false)); - } - else - { - Queue? queue = this.GetLockQueue(awaiter.Kind); - queue.Enqueue(awaiter); - - if (awaiter.Kind == LockKind.Write) - { - this.StartPendingWriterDeadlockTimerIfNecessary(); - } - } + return this.IsValid ? this.awaiter!.Data : null; } - } - private void StartPendingWriterDeadlockTimerIfNecessary() - { - if (this.joinableTaskContext is not null && - this.pendingWriterLockDeadlockCheckTimer is null && - this.waitingWriters.Count > 0 && - (this.issuedReadLocks.Count > 0 || this.issuedUpgradeableReadLocks.Count > 0)) + set { - this.pendingWriterLockDeadlockCheckTimer = new Timer(PendingWriterLockDeadlockWatchingCallback, this, (int)this.DeadlockCheckTimeout.TotalMilliseconds, -1); + Verify.Operation(this.IsValid, Strings.InvalidLock); + this.awaiter!.Data = value; } } - private void StopPendingWriterLockDeadlockWatching() + /// + /// Gets the lock within which this lock was acquired. + /// + public LockHandle NestingLock { - if (this.pendingWriterLockDeadlockCheckTimer is not null) - { - this.pendingWriterLockDeadlockCheckTimer.Dispose(); - this.pendingWriterLockDeadlockCheckTimer = null; - } + get { return this.IsValid ? new LockHandle(this.awaiter!.NestingLock) : default(LockHandle); } } /// - /// Executes the lock receiver or releases the lock because the request for it was canceled before it was issued. + /// Gets the wrapped awaiter. /// - /// The awaiter. - /// A value indicating whether the specified is expected to still be in the queue (and should be removed). - /// A value indicating whether a continuation delegate was actually invoked. - private bool ExecuteOrHandleCancellation(Awaiter awaiter, bool stillInQueue) + internal Awaiter? Awaiter { - Requires.NotNull(awaiter, nameof(awaiter)); + get { return this.awaiter; } + } + } - lock (this.SyncObject) - { - if (stillInQueue) - { - // The lock class can't deal well with cancelled lock requests remaining in its queue. - // Remove the awaiter, wherever in the queue it happens to be. - Queue? queue = this.GetLockQueue(awaiter.Kind); - if (!queue.RemoveMidQueue(awaiter)) - { - // This can happen when the lock request is cancelled, but during a race - // condition where the lock was just about to be issued anyway. - Assumes.True(awaiter.CancellationToken.IsCancellationRequested); - return false; - } - } + /// + /// Manages asynchronous access to a lock. + /// + [DebuggerDisplay("{kind}")] + public class Awaiter : ICriticalNotifyCompletion + { + /// + /// A singleton delegate for use in cancellation token registration to avoid memory allocations for delegates each time. + /// + private static readonly Action CancellationResponseAction = CancellationResponder; - return awaiter.TryScheduleContinuationExecution(); - } - } + /// + /// The instance of the lock class to which this awaiter is affiliated. + /// + private AsyncReaderWriterLock lck; /// - /// An awaitable that is returned from asynchronous lock requests. + /// The type of lock requested. /// - public readonly struct Awaitable - { - /// - /// The awaiter to return from the method. - /// - private readonly Awaiter? awaiter; + private LockKind kind; - /// - /// Initializes a new instance of the struct. - /// - /// The lock class that created this instance. - /// The type of lock being requested. - /// Any flags applied to the lock request. - /// The cancellation token. - /// to throw an exception if the caller has an exclusive lock but not an associated SynchronizationContext. - internal Awaitable(AsyncReaderWriterLock lck, LockKind kind, LockFlags options, CancellationToken cancellationToken, bool checkSyncContextCompatibility = true) - { - if (checkSyncContextCompatibility) - { - lck.CheckSynchronizationContextAppropriateForLock(lck.topAwaiter.Value); - } + /// + /// The "parent" lock (i.e. the lock within which this lock is nested) if any. + /// + private Awaiter? nestingLock; - this.awaiter = new Awaiter(lck, kind, options, cancellationToken); - if (!cancellationToken.IsCancellationRequested) - { - lck.TryIssueLock(this.awaiter, previouslyQueued: false); - } - } + /// + /// The cancellation token that would terminate waiting for a lock that is not yet available. + /// + private CancellationToken cancellationToken; - /// - /// Gets the awaiter value. - /// - public Awaiter GetAwaiter() - { - if (this.awaiter is null) - { - throw new InvalidOperationException(); - } + /// + /// The cancellation token event that should be disposed of to free memory when we no longer need to receive cancellation notifications. + /// + private CancellationTokenRegistration cancellationRegistration; - return this.awaiter; - } - } + /// + /// The flags applied to this lock. + /// + private LockFlags options; /// - /// A value whose disposal releases a held lock. + /// Any exception to throw back to the lock requestor. /// - [DebuggerDisplay("{awaiter.kind}")] - public readonly struct Releaser : IDisposable, System.IAsyncDisposable - { - /// - /// The awaiter who manages the lifetime of a lock. - /// - private readonly Awaiter? awaiter; + private Exception? fault; - /// - /// Initializes a new instance of the struct. - /// - /// The awaiter. - internal Releaser(Awaiter awaiter) - { - this.awaiter = awaiter; - } + /// + /// The continuation to execute when the lock is available. + /// + private Action? continuation; - /// - /// Releases the lock. - /// - public void Dispose() - { - if (this.awaiter is object) - { - var nonConcurrentSyncContext = SynchronizationContext.Current as NonConcurrentSynchronizationContext; + /// + /// The continuation we invoked to an issued lock. + /// + /// + /// We retain this value simply so that in hang reports we can identify the method we issued the lock to. + /// + private Action? continuationAfterLockIssued; - // NOTE: when we have already called ReleaseAsync, and the lock has been released, - // we don't want to load the concurrent context and try to take it back immediately. If we do, it is possible - // that anther thread waiting for a write lock can take the concurrent context, so the current thread will be - // blocked and wait until it is done, and that makes it possible to run into the thread pool exhaustion trap. - if (!this.awaiter.IsReleased) - { - using (nonConcurrentSyncContext is object ? nonConcurrentSyncContext.LoanBackAnyHeldResource(this.awaiter.OwningLock) : default(NonConcurrentSynchronizationContext.LoanBack)) - { - Task? releaseTask = this.awaiter.ReleaseAsync(); - using (NoMessagePumpSyncContext.Default.Apply()) - { - try - { - while (!releaseTask.Wait(1000)) - { // this loop allows us to break into the debugger and step into managed code to analyze a hang. - } - } - catch (AggregateException) - { - // We want to throw the inner exception itself -- not the AggregateException. - releaseTask.GetAwaiter().GetResult(); - } - } - } - } + /// + /// The TaskScheduler to invoke the continuation. + /// + private TaskScheduler? continuationTaskScheduler; - if (nonConcurrentSyncContext is object && !this.awaiter.OwningLock.AmbientLock.IsValid) - { - // The lock holder is taking the synchronous path to release the last UR/W lock held. - // Since they may go synchronously on their merry way for a while, forcibly release - // the sync context's semaphore that they otherwise would hold until their synchronous - // method returns. - nonConcurrentSyncContext.EarlyExitSynchronizationContext(); - } - } - } + /// + /// The task from a prior call to , if any. + /// + private Task? releaseAsyncTask; - /// - /// Releases the lock. - /// - public async ValueTask DisposeAsync() - { - await this.ReleaseAsync().ConfigureAwaitRunInline(); - this.Dispose(); - } + /// + /// The synchronization context applied to folks who hold the lock. + /// + private SynchronizationContext? synchronizationContext; - /// - /// Asynchronously releases the lock. Dispose should still be called after this. - /// - /// - /// A task that should complete before the releasing thread accesses any resource protected by - /// a lock wrapping the lock being released. - /// - /// - /// Rather than calling this method explicitly, use the C# 8 "await using" syntax instead. - /// - public Task ReleaseAsync() - { - if (this.awaiter is object) - { - var nonConcurrentSyncContext = SynchronizationContext.Current as NonConcurrentSynchronizationContext; - using (nonConcurrentSyncContext is object ? nonConcurrentSyncContext.LoanBackAnyHeldResource(this.awaiter.OwningLock) : default(NonConcurrentSynchronizationContext.LoanBack)) - { - return this.awaiter.ReleaseAsync(); - } - } + /// + /// The stacktrace of the caller originally requesting the lock. + /// + /// + /// This field is initialized only when is constructed with + /// the captureDiagnostics parameter set to . + /// + private StackTrace? requestingStackTrace; - return Task.CompletedTask; - } - } + /// + /// An arbitrary object that may be set by a derived type of the containing lock class. + /// + private object? data; /// - /// A value whose disposal restores visibility of any locks held by the caller. + /// Initializes a new instance of the class. /// - public readonly struct Suppression : IDisposable + /// The lock class creating this instance. + /// The type of lock being requested. + /// The flags to apply to the lock. + /// The cancellation token. + internal Awaiter(AsyncReaderWriterLock lck, LockKind kind, LockFlags options, CancellationToken cancellationToken) { - /// - /// The locking class. - /// - private readonly AsyncReaderWriterLock? lck; + Requires.NotNull(lck, nameof(lck)); - /// - /// The awaiter most recently acquired by the caller before hiding locks. - /// - private readonly Awaiter? awaiter; + this.lck = lck; + this.kind = kind; + this.options = options; + this.cancellationToken = cancellationToken; + this.nestingLock = lck.GetFirstActiveSelfOrAncestor(lck.topAwaiter.Value); + this.requestingStackTrace = lck.captureDiagnostics ? new StackTrace(2, true) : null; + this.AmbientJoinableTask = (this.nestingLock is null && this.kind != LockKind.Write) ? this.lck.joinableTaskContext?.AmbientTask : null; + } - /// - /// Initializes a new instance of the struct. - /// - /// The lock class. - internal Suppression(AsyncReaderWriterLock lck) + /// + /// Gets a value indicating whether the lock has been issued. + /// + public bool IsCompleted + { + get { - this.lck = lck; - this.awaiter = this.lck.topAwaiter.Value; - if (this.awaiter is object) + if (this.fault is object) { - this.lck.topAwaiter.Value = null; + return true; } - } - /// - /// Restores visibility of hidden locks. - /// - public void Dispose() - { - if (this.lck is object) + // If lock has already been issued, we have to switch to the right context, and ignore the CancellationToken. + if (this.lck.IsLockActive(this, considerStaActive: true)) { - this.lck.ApplyLockToCallContext(this.awaiter); + return this.lck.IsLockSupportingContext(this); } + + return this.cancellationToken.IsCancellationRequested; } } /// - /// A "public" representation of a specific lock. + /// Gets the lock instance that owns this awaiter. /// - protected readonly struct LockHandle + internal AsyncReaderWriterLock OwningLock { - /// - /// The awaiter this lock handle wraps. - /// - private readonly Awaiter? awaiter; + get { return this.lck; } + } - /// - /// Initializes a new instance of the struct. - /// - internal LockHandle(Awaiter? awaiter) - { - this.awaiter = awaiter; - } + /// + /// Gets the stack trace of the requestor of this lock. + /// + /// + /// Used for diagnostic purposes only. + /// + internal StackTrace? RequestingStackTrace + { + get { return this.requestingStackTrace; } + } - /// - /// Gets a value indicating whether this handle is to a lock which was actually acquired. - /// - public bool IsValid - { - get { return this.awaiter is object; } - } + /// + /// Gets the delegate to invoke (or that was invoked) when the lock is/was issued, if available. + /// FOR DIAGNOSTIC PURPOSES ONLY. + /// + internal Delegate? LockRequestingContinuation + { + get { return this.continuation ?? this.continuationAfterLockIssued; } + } - /// - /// Gets a value indicating whether this lock is still active. - /// - public bool IsActive - { - get { return this.IsValid && this.awaiter!.OwningLock.IsLockActive(this.awaiter, considerStaActive: true); } - } + /// + /// Gets the lock that the caller held before requesting this lock. + /// + internal Awaiter? NestingLock + { + get { return this.nestingLock; } + } - /// - /// Gets a value indicating whether this lock represents a read lock. - /// - public bool IsReadLock - { - get { return this.IsValid ? this.awaiter!.Kind == LockKind.Read : false; } - } + /// + /// Gets or sets an arbitrary object that may be set by a derived type of the containing lock class. + /// + internal object? Data + { + get { return this.data; } + set { this.data = value; } + } - /// - /// Gets a value indicating whether this lock represents an upgradeable read lock. - /// - public bool IsUpgradeableReadLock - { - get { return this.IsValid ? this.awaiter!.Kind == LockKind.UpgradeableRead : false; } - } + /// + /// Gets the cancellation token. + /// + internal CancellationToken CancellationToken + { + get { return this.cancellationToken; } + } - /// - /// Gets a value indicating whether this lock represents a write lock. - /// - public bool IsWriteLock - { - get { return this.IsValid ? this.awaiter!.Kind == LockKind.Write : false; } - } + /// + /// Gets the kind of lock being requested. + /// + internal LockKind Kind + { + get { return this.kind; } + } - /// - /// Gets a value indicating whether this lock is an active read lock or is nested by one. - /// - public bool HasReadLock - { - get { return this.IsValid ? this.awaiter!.OwningLock.IsLockHeld(LockKind.Read, this.awaiter, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true) : false; } - } + /// + /// Gets the flags applied to this lock. + /// + internal LockFlags Options + { + get { return this.options; } + } - /// - /// Gets a value indicating whether this lock is an active upgradeable read lock or is nested by one. - /// - public bool HasUpgradeableReadLock + /// + /// Gets a value indicating whether the lock has already been released. + /// + internal bool IsReleased + { + get { - get { return this.IsValid ? this.awaiter!.OwningLock.IsLockHeld(LockKind.UpgradeableRead, this.awaiter, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true) : false; } + return this.releaseAsyncTask is object && this.releaseAsyncTask.Status == TaskStatus.RanToCompletion; } + } - /// - /// Gets a value indicating whether this lock is an active write lock or is nested by one. - /// - public bool HasWriteLock - { - get { return this.IsValid ? this.awaiter!.OwningLock.IsLockHeld(LockKind.Write, this.awaiter, checkSyncContextCompatibility: false, allowNonLockSupportingContext: true) : false; } - } + /// + /// Gets the ambient JoinableTask when the lock is requested. This is used to resolve deadlock caused by issued read lock depending on new read lock requests blocked by pending write locks. + /// + internal JoinableTask? AmbientJoinableTask { get; } - /// - /// Gets the flags that were passed into this lock. - /// - public LockFlags Flags - { - get { return this.IsValid ? this.awaiter!.Options : LockFlags.None; } - } + /// + /// Gets a value indicating whether the lock is active. + /// + /// iff the lock has bee issued, has not yet been released, and the caller is on an MTA thread. + private bool LockIssued + { + get { return this.lck.IsLockActive(this, considerStaActive: false); } + } + + /// + /// Sets the delegate to execute when the lock is available. + /// + /// The delegate. + public void OnCompleted(Action continuation) => this.OnCompleted(continuation, flowExecutionContext: true); + + /// + /// Sets the delegate to execute when the lock is available + /// without flowing ExecutionContext. + /// + /// The delegate. + public void UnsafeOnCompleted(Action continuation) => this.OnCompleted(continuation, flowExecutionContext: false); - /// - /// Gets or sets some object associated to this specific lock. - /// - public object? Data + /// + /// Applies the issued lock to the caller and returns the value used to release the lock. + /// + /// The value to dispose of to release the lock. + public Releaser GetResult() + { + try { - get + this.cancellationRegistration.Dispose(); + + if (!this.LockIssued && this.continuation is null && !this.cancellationToken.IsCancellationRequested) { - return this.IsValid ? this.awaiter!.Data : null; + using (var synchronousBlock = new ManualResetEventSlim()) + { + this.OnCompleted(synchronousBlock.Set); + synchronousBlock.Wait(this.cancellationToken); + } } - set + if (this.fault is object) { - Verify.Operation(this.IsValid, Strings.InvalidLock); - this.awaiter!.Data = value; + throw this.fault; } - } - - /// - /// Gets the lock within which this lock was acquired. - /// - public LockHandle NestingLock - { - get { return this.IsValid ? new LockHandle(this.awaiter!.NestingLock) : default(LockHandle); } - } - - /// - /// Gets the wrapped awaiter. - /// - internal Awaiter? Awaiter - { - get { return this.awaiter; } - } - } - /// - /// Manages asynchronous access to a lock. - /// - [DebuggerDisplay("{kind}")] - public class Awaiter : ICriticalNotifyCompletion - { - /// - /// A singleton delegate for use in cancellation token registration to avoid memory allocations for delegates each time. - /// - private static readonly Action CancellationResponseAction = CancellationResponder; - - /// - /// The instance of the lock class to which this awaiter is affiliated. - /// - private AsyncReaderWriterLock lck; - - /// - /// The type of lock requested. - /// - private LockKind kind; - - /// - /// The "parent" lock (i.e. the lock within which this lock is nested) if any. - /// - private Awaiter? nestingLock; - - /// - /// The cancellation token that would terminate waiting for a lock that is not yet available. - /// - private CancellationToken cancellationToken; - - /// - /// The cancellation token event that should be disposed of to free memory when we no longer need to receive cancellation notifications. - /// - private CancellationTokenRegistration cancellationRegistration; - - /// - /// The flags applied to this lock. - /// - private LockFlags options; - - /// - /// Any exception to throw back to the lock requestor. - /// - private Exception? fault; - - /// - /// The continuation to execute when the lock is available. - /// - private Action? continuation; - - /// - /// The continuation we invoked to an issued lock. - /// - /// - /// We retain this value simply so that in hang reports we can identify the method we issued the lock to. - /// - private Action? continuationAfterLockIssued; - - /// - /// The TaskScheduler to invoke the continuation. - /// - private TaskScheduler? continuationTaskScheduler; - - /// - /// The task from a prior call to , if any. - /// - private Task? releaseAsyncTask; - - /// - /// The synchronization context applied to folks who hold the lock. - /// - private SynchronizationContext? synchronizationContext; - - /// - /// The stacktrace of the caller originally requesting the lock. - /// - /// - /// This field is initialized only when is constructed with - /// the captureDiagnostics parameter set to . - /// - private StackTrace? requestingStackTrace; - - /// - /// An arbitrary object that may be set by a derived type of the containing lock class. - /// - private object? data; - - /// - /// Initializes a new instance of the class. - /// - /// The lock class creating this instance. - /// The type of lock being requested. - /// The flags to apply to the lock. - /// The cancellation token. - internal Awaiter(AsyncReaderWriterLock lck, LockKind kind, LockFlags options, CancellationToken cancellationToken) - { - Requires.NotNull(lck, nameof(lck)); - - this.lck = lck; - this.kind = kind; - this.options = options; - this.cancellationToken = cancellationToken; - this.nestingLock = lck.GetFirstActiveSelfOrAncestor(lck.topAwaiter.Value); - this.requestingStackTrace = lck.captureDiagnostics ? new StackTrace(2, true) : null; - this.AmbientJoinableTask = (this.nestingLock is null && this.kind != LockKind.Write) ? this.lck.joinableTaskContext?.AmbientTask : null; - } - - /// - /// Gets a value indicating whether the lock has been issued. - /// - public bool IsCompleted - { - get + if (this.LockIssued) { - if (this.fault is object) + this.lck.ThrowIfUnsupportedThreadOrSyncContext(); + if ((this.Kind & (LockKind.UpgradeableRead | LockKind.Write)) != 0) { - return true; + Assumes.True(SynchronizationContext.Current is NonConcurrentSynchronizationContext); } - // If lock has already been issued, we have to switch to the right context, and ignore the CancellationToken. - if (this.lck.IsLockActive(this, considerStaActive: true)) - { - return this.lck.IsLockSupportingContext(this); - } + this.lck.ApplyLockToCallContext(this); - return this.cancellationToken.IsCancellationRequested; + return new Releaser(this); + } + else if (this.cancellationToken.IsCancellationRequested) + { + // At this point, someone called GetResult who wasn't registered as a synchronous waiter, + // and before the lock was issued. + // If the cancellation token was signaled, we'll throw that because a canceled token is a + // legit reason to hit this path in the method. Otherwise it's an internal error. + throw new OperationCanceledException(); } - } - - /// - /// Gets the lock instance that owns this awaiter. - /// - internal AsyncReaderWriterLock OwningLock - { - get { return this.lck; } - } - /// - /// Gets the stack trace of the requestor of this lock. - /// - /// - /// Used for diagnostic purposes only. - /// - internal StackTrace? RequestingStackTrace - { - get { return this.requestingStackTrace; } + this.lck.ThrowIfUnsupportedThreadOrSyncContext(); + throw Assumes.NotReachable(); } - - /// - /// Gets the delegate to invoke (or that was invoked) when the lock is/was issued, if available. - /// FOR DIAGNOSTIC PURPOSES ONLY. - /// - internal Delegate? LockRequestingContinuation + catch (OperationCanceledException) { - get { return this.continuation ?? this.continuationAfterLockIssued; } + // Don't release at this point, or else it would recycle this instance prematurely + // (while it's still in the queue to receive a lock). + throw; } - - /// - /// Gets the lock that the caller held before requesting this lock. - /// - internal Awaiter? NestingLock + catch { - get { return this.nestingLock; } + this.ReleaseAsync(lockConsumerCanceled: true); + throw; } + } - /// - /// Gets or sets an arbitrary object that may be set by a derived type of the containing lock class. - /// - internal object? Data + /// + /// Releases the lock and recycles this instance. + /// + internal Task ReleaseAsync(bool lockConsumerCanceled = false) + { + if (this.releaseAsyncTask is null) { - get { return this.data; } - set { this.data = value; } + // This method does NOT use the async keyword in its signature to avoid CallContext changes that we make + // causing a fork/clone of the CallContext, which defeats our alloc-free uncontested lock story. + try + { + this.continuationAfterLockIssued = null; // clear field to defend against leaks if Awaiters live a long time. + this.releaseAsyncTask = this.lck.ReleaseAsync(this, lockConsumerCanceled); + } + catch (Exception ex) + { + // An exception here is *really* bad, because a project lock will get orphaned and + // a deadlock will soon result. + // Do what we can to save some evidence by capturing the exception in a faulted task. + // We don't need to rethrow the exception because we return the faulted task. + var tcs = new TaskCompletionSource(); + tcs.SetException(ex); + this.releaseAsyncTask = tcs.Task; + } } - /// - /// Gets the cancellation token. - /// - internal CancellationToken CancellationToken - { - get { return this.cancellationToken; } - } + return this.releaseAsyncTask; + } - /// - /// Gets the kind of lock being requested. - /// - internal LockKind Kind - { - get { return this.kind; } - } + /// + /// Executes the code that requires the lock. + /// + /// if the continuation was (asynchronously) invoked; if there was no continuation available to invoke. + internal bool TryScheduleContinuationExecution() + { + Action? continuation = Interlocked.Exchange(ref this.continuation, null); - /// - /// Gets the flags applied to this lock. - /// - internal LockFlags Options + if (continuation is object) { - get { return this.options; } - } + this.continuationAfterLockIssued = continuation; - /// - /// Gets a value indicating whether the lock has already been released. - /// - internal bool IsReleased - { - get + SynchronizationContext? synchronizationContext = this.GetEffectiveSynchronizationContext(); + if (this.continuationTaskScheduler is object && synchronizationContext == DefaultSynchronizationContext) { - return this.releaseAsyncTask is object && this.releaseAsyncTask.Status == TaskStatus.RanToCompletion; + Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.PreferFairness, this.continuationTaskScheduler); + } + else + { + synchronizationContext.Post(state => ((Action)state!)(), continuation); } - } - - /// - /// Gets the ambient JoinableTask when the lock is requested. This is used to resolve deadlock caused by issued read lock depending on new read lock requests blocked by pending write locks. - /// - internal JoinableTask? AmbientJoinableTask { get; } - /// - /// Gets a value indicating whether the lock is active. - /// - /// iff the lock has bee issued, has not yet been released, and the caller is on an MTA thread. - private bool LockIssued + return true; + } + else { - get { return this.lck.IsLockActive(this, considerStaActive: false); } + return false; } + } - /// - /// Sets the delegate to execute when the lock is available. - /// - /// The delegate. - public void OnCompleted(Action continuation) => this.OnCompleted(continuation, flowExecutionContext: true); + /// + /// Specifies the exception to throw from . + /// + internal void SetFault(Exception ex) + { + this.fault = ex; + } - /// - /// Sets the delegate to execute when the lock is available - /// without flowing ExecutionContext. - /// - /// The delegate. - public void UnsafeOnCompleted(Action continuation) => this.OnCompleted(continuation, flowExecutionContext: false); + /// + /// Responds to lock request cancellation. + /// + /// The instance being canceled. + private static void CancellationResponder(object state) + { + var awaiter = (Awaiter)state; - /// - /// Applies the issued lock to the caller and returns the value used to release the lock. - /// - /// The value to dispose of to release the lock. - public Releaser GetResult() + // We're in a race with the lock suddenly becoming available. + // Our control in the race is asking the lock class to execute for us (within their private lock). + // unblock the awaiter immediately (which will then experience an OperationCanceledException). + if (awaiter.lck.ExecuteOrHandleCancellation(awaiter, stillInQueue: true)) { - try + // A pending write lock can block read locks, so we need issue them when the request is cancelled. + if (awaiter.Kind == LockKind.Write) { - this.cancellationRegistration.Dispose(); - - if (!this.LockIssued && this.continuation is null && !this.cancellationToken.IsCancellationRequested) - { - using (var synchronousBlock = new ManualResetEventSlim()) - { - this.OnCompleted(synchronousBlock.Set); - synchronousBlock.Wait(this.cancellationToken); - } - } - - if (this.fault is object) - { - throw this.fault; - } - - if (this.LockIssued) - { - this.lck.ThrowIfUnsupportedThreadOrSyncContext(); - if ((this.Kind & (LockKind.UpgradeableRead | LockKind.Write)) != 0) - { - Assumes.True(SynchronizationContext.Current is NonConcurrentSynchronizationContext); - } - - this.lck.ApplyLockToCallContext(this); - - return new Releaser(this); - } - else if (this.cancellationToken.IsCancellationRequested) + lock (awaiter.OwningLock.SyncObject) { - // At this point, someone called GetResult who wasn't registered as a synchronous waiter, - // and before the lock was issued. - // If the cancellation token was signaled, we'll throw that because a canceled token is a - // legit reason to hit this path in the method. Otherwise it's an internal error. - throw new OperationCanceledException(); + awaiter.OwningLock.TryInvokeLockConsumer(searchAllWaiters: false); } - - this.lck.ThrowIfUnsupportedThreadOrSyncContext(); - throw Assumes.NotReachable(); - } - catch (OperationCanceledException) - { - // Don't release at this point, or else it would recycle this instance prematurely - // (while it's still in the queue to receive a lock). - throw; - } - catch - { - this.ReleaseAsync(lockConsumerCanceled: true); - throw; } } - /// - /// Releases the lock and recycles this instance. - /// - internal Task ReleaseAsync(bool lockConsumerCanceled = false) + // Release memory of the registered handler, since we only need it to fire once. + awaiter.cancellationRegistration.Dispose(); + } + + /// + /// Get the correct SynchronizationContext to execute code executing within the lock. + /// Note: we need get the NonConcurrentSynchronizationContext from the nesting exclusive lock, because the child lock is essentially under the same context. + /// When we don't have a valid nesting lock, we will create a new NonConcurrentSynchronizationContext for an exclusive lock. For read lock, we don't put it within a NonConcurrentSynchronizationContext, + /// we set it to DefaultSynchronizationContext to mark we have computed it. The result is cached. + /// + private SynchronizationContext GetEffectiveSynchronizationContext() + { + if (this.synchronizationContext is null) { - if (this.releaseAsyncTask is null) + // Only read locks can be executed trivially. The locks that have some level of exclusivity (upgradeable read and write) + // must be executed via the NonConcurrentSynchronizationContext. + SynchronizationContext? synchronizationContext = null; + + Awaiter? awaiter = this.NestingLock; + while (awaiter is object) { - // This method does NOT use the async keyword in its signature to avoid CallContext changes that we make - // causing a fork/clone of the CallContext, which defeats our alloc-free uncontested lock story. - try + if (this.lck.IsLockActive(awaiter, considerStaActive: true)) { - this.continuationAfterLockIssued = null; // clear field to defend against leaks if Awaiters live a long time. - this.releaseAsyncTask = this.lck.ReleaseAsync(this, lockConsumerCanceled); - } - catch (Exception ex) - { - // An exception here is *really* bad, because a project lock will get orphaned and - // a deadlock will soon result. - // Do what we can to save some evidence by capturing the exception in a faulted task. - // We don't need to rethrow the exception because we return the faulted task. - var tcs = new TaskCompletionSource(); - tcs.SetException(ex); - this.releaseAsyncTask = tcs.Task; + synchronizationContext = awaiter.GetEffectiveSynchronizationContext(); + break; } - } - - return this.releaseAsyncTask; - } - /// - /// Executes the code that requires the lock. - /// - /// if the continuation was (asynchronously) invoked; if there was no continuation available to invoke. - internal bool TryScheduleContinuationExecution() - { - Action? continuation = Interlocked.Exchange(ref this.continuation, null); + awaiter = awaiter.NestingLock; + } - if (continuation is object) + if (synchronizationContext is null) { - this.continuationAfterLockIssued = continuation; - - SynchronizationContext? synchronizationContext = this.GetEffectiveSynchronizationContext(); - if (this.continuationTaskScheduler is object && synchronizationContext == DefaultSynchronizationContext) + if (this.kind == LockKind.Read) { - Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.PreferFairness, this.continuationTaskScheduler); + // We use DefaultSynchronizationContext to indicate that we have already computed the synchronizationContext once, and prevent repeating this logic second time. + synchronizationContext = DefaultSynchronizationContext; } else { - synchronizationContext.Post(state => ((Action)state!)(), continuation); + synchronizationContext = new NonConcurrentSynchronizationContext(); } - - return true; - } - else - { - return false; } + + Interlocked.CompareExchange(ref this.synchronizationContext, synchronizationContext, null); } - /// - /// Specifies the exception to throw from . - /// - internal void SetFault(Exception ex) + return this.synchronizationContext; + } + + /// + /// Sets the delegate to execute when the lock is available. + /// + /// The delegate. + /// A value indicating whether to flow ExecutionContext. + private void OnCompleted(Action continuation, bool flowExecutionContext) + { + if (this.LockIssued) { - this.fault = ex; + throw new InvalidOperationException(); } - /// - /// Responds to lock request cancellation. - /// - /// The instance being canceled. - private static void CancellationResponder(object state) + if (Interlocked.CompareExchange(ref this.continuation, continuation, null) is object) { - var awaiter = (Awaiter)state; - - // We're in a race with the lock suddenly becoming available. - // Our control in the race is asking the lock class to execute for us (within their private lock). - // unblock the awaiter immediately (which will then experience an OperationCanceledException). - if (awaiter.lck.ExecuteOrHandleCancellation(awaiter, stillInQueue: true)) - { - // A pending write lock can block read locks, so we need issue them when the request is cancelled. - if (awaiter.Kind == LockKind.Write) - { - lock (awaiter.OwningLock.SyncObject) - { - awaiter.OwningLock.TryInvokeLockConsumer(searchAllWaiters: false); - } - } - } - - // Release memory of the registered handler, since we only need it to fire once. - awaiter.cancellationRegistration.Dispose(); + throw new NotSupportedException(Strings.MultipleContinuationsNotSupported); } - /// - /// Get the correct SynchronizationContext to execute code executing within the lock. - /// Note: we need get the NonConcurrentSynchronizationContext from the nesting exclusive lock, because the child lock is essentially under the same context. - /// When we don't have a valid nesting lock, we will create a new NonConcurrentSynchronizationContext for an exclusive lock. For read lock, we don't put it within a NonConcurrentSynchronizationContext, - /// we set it to DefaultSynchronizationContext to mark we have computed it. The result is cached. - /// - private SynchronizationContext GetEffectiveSynchronizationContext() + bool restoreFlow = !flowExecutionContext && !ExecutionContext.IsFlowSuppressed(); + AsyncFlowControl flowControl = default; + if (restoreFlow) { - if (this.synchronizationContext is null) - { - // Only read locks can be executed trivially. The locks that have some level of exclusivity (upgradeable read and write) - // must be executed via the NonConcurrentSynchronizationContext. - SynchronizationContext? synchronizationContext = null; - - Awaiter? awaiter = this.NestingLock; - while (awaiter is object) - { - if (this.lck.IsLockActive(awaiter, considerStaActive: true)) - { - synchronizationContext = awaiter.GetEffectiveSynchronizationContext(); - break; - } - - awaiter = awaiter.NestingLock; - } - - if (synchronizationContext is null) - { - if (this.kind == LockKind.Read) - { - // We use DefaultSynchronizationContext to indicate that we have already computed the synchronizationContext once, and prevent repeating this logic second time. - synchronizationContext = DefaultSynchronizationContext; - } - else - { - synchronizationContext = new NonConcurrentSynchronizationContext(); - } - } - - Interlocked.CompareExchange(ref this.synchronizationContext, synchronizationContext, null); - } - - return this.synchronizationContext; + flowControl = ExecutionContext.SuppressFlow(); } - /// - /// Sets the delegate to execute when the lock is available. - /// - /// The delegate. - /// A value indicating whether to flow ExecutionContext. - private void OnCompleted(Action continuation, bool flowExecutionContext) + try { - if (this.LockIssued) + if (this.Kind == LockKind.Read) { - throw new InvalidOperationException(); + this.continuationTaskScheduler = this.OwningLock.GetTaskSchedulerForReadLockRequest(); } - if (Interlocked.CompareExchange(ref this.continuation, continuation, null) is object) + this.cancellationRegistration = this.cancellationToken.Register(CancellationResponseAction!, this, useSynchronizationContext: false); + this.lck.PendAwaiter(this); + + if (this.cancellationToken.IsCancellationRequested && this.cancellationRegistration == default(CancellationTokenRegistration)) { - throw new NotSupportedException(Strings.MultipleContinuationsNotSupported); + CancellationResponder(this); } - - bool restoreFlow = !flowExecutionContext && !ExecutionContext.IsFlowSuppressed(); - AsyncFlowControl flowControl = default; + } + finally + { if (restoreFlow) { - flowControl = ExecutionContext.SuppressFlow(); + flowControl.Dispose(); } + } + } + } - try - { - if (this.Kind == LockKind.Read) - { - this.continuationTaskScheduler = this.OwningLock.GetTaskSchedulerForReadLockRequest(); - } + internal sealed class NonConcurrentSynchronizationContext : SynchronizationContext, IDisposable + { + private readonly SemaphoreSlim semaphore = new SemaphoreSlim(1); - this.cancellationRegistration = this.cancellationToken.Register(CancellationResponseAction!, this, useSynchronizationContext: false); - this.lck.PendAwaiter(this); + /// + /// The managed thread ID of the thread that has entered the semaphore. + /// + /// + /// No reason to lock around access to this field because it is only ever set to + /// or compared against the current thread, so the activity of other threads is irrelevant. + /// + private int? semaphoreHoldingManagedThreadId; - if (this.cancellationToken.IsCancellationRequested && this.cancellationRegistration == default(CancellationTokenRegistration)) - { - CancellationResponder(this); - } - } - finally - { - if (restoreFlow) - { - flowControl.Dispose(); - } - } + /// + /// Gets a value indicating whether the current thread holds the semaphore. + /// + private bool IsCurrentThreadHoldingSemaphore + { + get + { + // It is crucial that we capture the field in a local variable to guard against + // the scenario where this thread DOESN'T hold the semaphore but another has, and + // is in the process of clearing it, which would otherwise introduce a race condition + // where we check HasValue to be true, then try to call Value and it ends up throwing. + // Since int? is a value type, copying it to a local value guards against this race + // and we will simply return false in that case since our thread doesn't own it. + int? semaphoreHoldingManagedThreadId = this.semaphoreHoldingManagedThreadId; + return semaphoreHoldingManagedThreadId.HasValue + && semaphoreHoldingManagedThreadId.Value == Environment.CurrentManagedThreadId; } } - internal sealed class NonConcurrentSynchronizationContext : SynchronizationContext, IDisposable + public override void Send(SendOrPostCallback d, object? state) { - private readonly SemaphoreSlim semaphore = new SemaphoreSlim(1); - - /// - /// The managed thread ID of the thread that has entered the semaphore. - /// - /// - /// No reason to lock around access to this field because it is only ever set to - /// or compared against the current thread, so the activity of other threads is irrelevant. - /// - private int? semaphoreHoldingManagedThreadId; + throw new NotSupportedException(); + } - /// - /// Gets a value indicating whether the current thread holds the semaphore. - /// - private bool IsCurrentThreadHoldingSemaphore - { - get - { - // It is crucial that we capture the field in a local variable to guard against - // the scenario where this thread DOESN'T hold the semaphore but another has, and - // is in the process of clearing it, which would otherwise introduce a race condition - // where we check HasValue to be true, then try to call Value and it ends up throwing. - // Since int? is a value type, copying it to a local value guards against this race - // and we will simply return false in that case since our thread doesn't own it. - int? semaphoreHoldingManagedThreadId = this.semaphoreHoldingManagedThreadId; - return semaphoreHoldingManagedThreadId.HasValue - && semaphoreHoldingManagedThreadId.Value == Environment.CurrentManagedThreadId; - } - } + public override void Post(SendOrPostCallback d, object? state) + { + Requires.NotNull(d, nameof(d)); - public override void Send(SendOrPostCallback d, object? state) + if (ThreadingEventSource.Instance.IsEnabled()) { - throw new NotSupportedException(); + ThreadingEventSource.Instance.PostExecutionStart(d.GetHashCode(), false); } - public override void Post(SendOrPostCallback d, object? state) - { - Requires.NotNull(d, nameof(d)); - - if (ThreadingEventSource.Instance.IsEnabled()) + // Take special care to minimize allocations and overhead by avoiding implicit delegates and closures. + // The C# compiler caches this delegate in a static field because it never touches "this" + // nor any other local variables, which means the only allocations from this call + // are our Tuple and the ThreadPool's bare-minimum necessary to track the work. + ThreadPool.QueueUserWorkItem( + s => { - ThreadingEventSource.Instance.PostExecutionStart(d.GetHashCode(), false); - } + var tuple = (Tuple)s!; + tuple.Item1.PostHelper(tuple.Item2, tuple.Item3); + }, + Tuple.Create(this, d, state)); + } - // Take special care to minimize allocations and overhead by avoiding implicit delegates and closures. - // The C# compiler caches this delegate in a static field because it never touches "this" - // nor any other local variables, which means the only allocations from this call - // are our Tuple and the ThreadPool's bare-minimum necessary to track the work. - ThreadPool.QueueUserWorkItem( - s => - { - var tuple = (Tuple)s!; - tuple.Item1.PostHelper(tuple.Item2, tuple.Item3); - }, - Tuple.Create(this, d, state)); - } + /// + public void Dispose() + { + this.semaphore.Dispose(); + } - /// - public void Dispose() + internal LoanBack LoanBackAnyHeldResource(AsyncReaderWriterLock asyncLock) + { + return (this.semaphore.CurrentCount == 0 && this.IsCurrentThreadHoldingSemaphore) + ? new LoanBack(this, asyncLock) + : default(LoanBack); + } + + internal void EarlyExitSynchronizationContext() + { + if (this.IsCurrentThreadHoldingSemaphore) { - this.semaphore.Dispose(); + this.semaphoreHoldingManagedThreadId = null; + this.semaphore.Release(); } - internal LoanBack LoanBackAnyHeldResource(AsyncReaderWriterLock asyncLock) + if (SynchronizationContext.Current == this) { - return (this.semaphore.CurrentCount == 0 && this.IsCurrentThreadHoldingSemaphore) - ? new LoanBack(this, asyncLock) - : default(LoanBack); + SynchronizationContext.SetSynchronizationContext(null); } + } - internal void EarlyExitSynchronizationContext() + /// + /// Executes the specified delegate. + /// + /// + /// We use async void instead of async Task because the caller will never + /// use the result, and this way the compiler doesn't have to create the Task object. + /// + private async void PostHelper(SendOrPostCallback d, object state) + { + bool delegateInvoked = false; + try { - if (this.IsCurrentThreadHoldingSemaphore) + await this.semaphore.WaitAsync().ConfigureAwait(false); + this.semaphoreHoldingManagedThreadId = Environment.CurrentManagedThreadId; + try { - this.semaphoreHoldingManagedThreadId = null; - this.semaphore.Release(); - } + SynchronizationContext.SetSynchronizationContext(this); + if (ThreadingEventSource.Instance.IsEnabled()) + { + ThreadingEventSource.Instance.PostExecutionStop(d.GetHashCode()); + } - if (SynchronizationContext.Current == this) + delegateInvoked = true; // set now, before the delegate might throw. + d(state); + } + catch (Exception ex) { - SynchronizationContext.SetSynchronizationContext(null); + // We just eat these up to avoid crashing the process by throwing on a threadpool thread. + Report.Fail("An unhandled exception was thrown from within a posted message. {0}", ex); + } + finally + { + // The semaphore *may* have been released already, so take care to not release it again. + if (this.IsCurrentThreadHoldingSemaphore) + { + this.semaphoreHoldingManagedThreadId = null; + this.semaphore.Release(); + } } } - - /// - /// Executes the specified delegate. - /// - /// - /// We use async void instead of async Task because the caller will never - /// use the result, and this way the compiler doesn't have to create the Task object. - /// - private async void PostHelper(SendOrPostCallback d, object state) + catch (ObjectDisposedException) { - bool delegateInvoked = false; - try + // It can happen that this SynchronizationContext was disposed of + // but someone who captured it is still trying to use it. + // In that case, we're not protecting anything any more and we're obliged + // to execute the delegate, so just execute it. + if (!delegateInvoked) { - await this.semaphore.WaitAsync().ConfigureAwait(false); - this.semaphoreHoldingManagedThreadId = Environment.CurrentManagedThreadId; + SynchronizationContext.SetSynchronizationContext(null); try { - SynchronizationContext.SetSynchronizationContext(this); - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.PostExecutionStop(d.GetHashCode()); - } - delegateInvoked = true; // set now, before the delegate might throw. d(state); } @@ -2782,98 +2811,68 @@ private async void PostHelper(SendOrPostCallback d, object state) // We just eat these up to avoid crashing the process by throwing on a threadpool thread. Report.Fail("An unhandled exception was thrown from within a posted message. {0}", ex); } - finally - { - // The semaphore *may* have been released already, so take care to not release it again. - if (this.IsCurrentThreadHoldingSemaphore) - { - this.semaphoreHoldingManagedThreadId = null; - this.semaphore.Release(); - } - } - } - catch (ObjectDisposedException) - { - // It can happen that this SynchronizationContext was disposed of - // but someone who captured it is still trying to use it. - // In that case, we're not protecting anything any more and we're obliged - // to execute the delegate, so just execute it. - if (!delegateInvoked) - { - SynchronizationContext.SetSynchronizationContext(null); - try - { - delegateInvoked = true; // set now, before the delegate might throw. - d(state); - } - catch (Exception ex) - { - // We just eat these up to avoid crashing the process by throwing on a threadpool thread. - Report.Fail("An unhandled exception was thrown from within a posted message. {0}", ex); - } - } } } + } - internal readonly struct LoanBack : IDisposable - { - private readonly NonConcurrentSynchronizationContext syncContext; - private readonly AsyncReaderWriterLock asyncLock; + internal readonly struct LoanBack : IDisposable + { + private readonly NonConcurrentSynchronizationContext syncContext; + private readonly AsyncReaderWriterLock asyncLock; - internal LoanBack(NonConcurrentSynchronizationContext syncContext, AsyncReaderWriterLock asyncLock) - { - Requires.NotNull(syncContext, nameof(syncContext)); - Requires.NotNull(asyncLock, nameof(asyncLock)); - this.syncContext = syncContext; - this.asyncLock = asyncLock; - this.syncContext.semaphoreHoldingManagedThreadId = null; - this.syncContext.semaphore.Release(); - } + internal LoanBack(NonConcurrentSynchronizationContext syncContext, AsyncReaderWriterLock asyncLock) + { + Requires.NotNull(syncContext, nameof(syncContext)); + Requires.NotNull(asyncLock, nameof(asyncLock)); + this.syncContext = syncContext; + this.asyncLock = asyncLock; + this.syncContext.semaphoreHoldingManagedThreadId = null; + this.syncContext.semaphore.Release(); + } - public void Dispose() + public void Dispose() + { + if (this.syncContext is object) { - if (this.syncContext is object) - { - Assumes.False(Monitor.IsEntered(this.asyncLock.syncObject), "Should not wait on the Semaphore, when we hold the syncObject. This causes deadlocks"); - this.syncContext.semaphore.Wait(); - this.syncContext.semaphoreHoldingManagedThreadId = Environment.CurrentManagedThreadId; - } + Assumes.False(Monitor.IsEntered(this.asyncLock.syncObject), "Should not wait on the Semaphore, when we hold the syncObject. This causes deadlocks"); + this.syncContext.semaphore.Wait(); + this.syncContext.semaphoreHoldingManagedThreadId = Environment.CurrentManagedThreadId; } } } + } - internal class EventsHelper - { - private readonly AsyncReaderWriterLock lck; + internal class EventsHelper + { + private readonly AsyncReaderWriterLock lck; - internal EventsHelper(AsyncReaderWriterLock lck) - { - Requires.NotNull(lck, "lck"); - this.lck = lck; - } + internal EventsHelper(AsyncReaderWriterLock lck) + { + Requires.NotNull(lck, "lck"); + this.lck = lck; + } - internal static void WaitStop(Awaiter lckAwaiter) + internal static void WaitStop(Awaiter lckAwaiter) + { + if (ThreadingEventSource.Instance.IsEnabled()) { - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.WaitReaderWriterLockStop(lckAwaiter.GetHashCode(), lckAwaiter.Kind); - } + ThreadingEventSource.Instance.WaitReaderWriterLockStop(lckAwaiter.GetHashCode(), lckAwaiter.Kind); } + } - internal void Issued(Awaiter lckAwaiter) + internal void Issued(Awaiter lckAwaiter) + { + if (ThreadingEventSource.Instance.IsEnabled()) { - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.ReaderWriterLockIssued(lckAwaiter.GetHashCode(), lckAwaiter.Kind, this.lck.issuedUpgradeableReadLocks.Count, this.lck.issuedReadLocks.Count); - } + ThreadingEventSource.Instance.ReaderWriterLockIssued(lckAwaiter.GetHashCode(), lckAwaiter.Kind, this.lck.issuedUpgradeableReadLocks.Count, this.lck.issuedReadLocks.Count); } + } - internal void WaitStart(Awaiter lckAwaiter) + internal void WaitStart(Awaiter lckAwaiter) + { + if (ThreadingEventSource.Instance.IsEnabled()) { - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.WaitReaderWriterLockStart(lckAwaiter.GetHashCode(), lckAwaiter.Kind, this.lck.issuedWriteLocks.Count, this.lck.issuedUpgradeableReadLocks.Count, this.lck.issuedReadLocks.Count); - } + ThreadingEventSource.Instance.WaitReaderWriterLockStart(lckAwaiter.GetHashCode(), lckAwaiter.Kind, this.lck.issuedWriteLocks.Count, this.lck.issuedUpgradeableReadLocks.Count, this.lck.issuedReadLocks.Count); } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs index f216e4a8c..2a8379541 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs @@ -10,895 +10,894 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A non-blocking lock that allows concurrent access, exclusive access, or concurrent with upgradeability to exclusive access, +/// making special allowances for resources that must be prepared for concurrent or exclusive access. +/// +/// The type of the moniker that identifies a resource. +/// The type of resource issued for access by this lock. +public abstract class AsyncReaderWriterResourceLock : AsyncReaderWriterLock + where TResource : class { /// - /// A non-blocking lock that allows concurrent access, exclusive access, or concurrent with upgradeability to exclusive access, - /// making special allowances for resources that must be prepared for concurrent or exclusive access. + /// A private nested class we use to isolate some of the behavior. /// - /// The type of the moniker that identifies a resource. - /// The type of resource issued for access by this lock. - public abstract class AsyncReaderWriterResourceLock : AsyncReaderWriterLock - where TResource : class + private readonly Helper helper; + + /// + /// Initializes a new instance of the class. + /// + protected AsyncReaderWriterResourceLock() + { + this.helper = new Helper(this); + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// to spend additional resources capturing diagnostic details that can be used + /// to analyze deadlocks or other issues. + protected AsyncReaderWriterResourceLock(bool captureDiagnostics) + : base(captureDiagnostics) + { + this.helper = new Helper(this); + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// A JoinableTaskContext to help resolve dead locks caused by interdependency between top read lock tasks when there is a pending write lock blocking one of them. + /// + /// + /// to spend additional resources capturing diagnostic details that can be used + /// to analyze deadlocks or other issues. + protected AsyncReaderWriterResourceLock(JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) + : base(joinableTaskContext, captureDiagnostics) + { + this.helper = new Helper(this); + } + + /// + /// Flags that modify default lock behavior. + /// + [Flags] + public new enum LockFlags + { + /// + /// The default behavior applies. + /// + None = 0x0, + + /// + /// Causes an upgradeable reader to remain in an upgraded-write state once upgraded, + /// even after the nested write lock has been released. + /// + /// + /// This is useful when you have a batch of possible write operations to apply, which + /// may or may not actually apply in the end, but if any of them change anything, + /// all of their changes should be seen atomically (within a single write lock). + /// This approach is preferable to simply acquiring a write lock around the batch of + /// potential changes because it doesn't defeat concurrent readers until it knows there + /// is a change to actually make. + /// + StickyWrite = 0x1, + + /// + /// Skips a step to make sure that the resource is initially prepared when retrieved using GetResourceAsync. + /// + /// + /// This flag is dormant for non-write locks. But if present on an upgradeable read lock, + /// this flag will activate for a nested write lock. + /// + SkipInitialPreparation = 0x1000, + } + + /// + /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public new ResourceAwaitable ReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new ResourceAwaitable(base.ReadLockAsync(cancellationToken), this.helper); + } + + /// + /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// Modifications to normal lock behavior. + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public ResourceAwaitable UpgradeableReadLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + { + return new ResourceAwaitable(this.UpgradeableReadLockAsync((AsyncReaderWriterLock.LockFlags)options, cancellationToken), this.helper); + } + + /// + /// Obtains an upgradeable read lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public new ResourceAwaitable UpgradeableReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new ResourceAwaitable(base.UpgradeableReadLockAsync(cancellationToken), this.helper); + } + + /// + /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public new ResourceAwaitable WriteLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new ResourceAwaitable(base.WriteLockAsync(cancellationToken), this.helper); + } + + /// + /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. + /// + /// Modifications to normal lock behavior. + /// + /// A token whose cancellation indicates lost interest in obtaining the lock. + /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, + /// a canceled token will cause the code that is waiting for the lock to resume with an . + /// + /// An awaitable object whose result is the lock releaser. + public ResourceAwaitable WriteLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + { + return new ResourceAwaitable(this.WriteLockAsync((AsyncReaderWriterLock.LockFlags)options, cancellationToken), this.helper); + } + + /// + /// Retrieves the resource with the specified moniker. + /// + /// The identifier for the desired resource. + /// A token whose cancellation indicates lost interest in obtaining the resource. + /// A task whose result is the desired resource. + protected abstract Task GetResourceAsync(TMoniker resourceMoniker, CancellationToken cancellationToken); + + /// + /// Marks a resource as having been retrieved under a lock. + /// + protected void SetResourceAsAccessed(TResource resource) + { + this.helper.SetResourceAsAccessed(resource); + } + + /// + /// Marks any loaded resources as having been retrieved under a lock if they + /// satisfy some predicate. + /// + /// A function that returns if the provided resource should be considered retrieved. + /// The state object to pass as a second parameter to . + /// if the delegate returned on any of the invocations. + protected bool SetResourceAsAccessed(Func resourceCheck, object? state) + { + return this.helper.SetResourceAsAccessed(resourceCheck, state); + } + + /// + /// Sets all the resources to be considered in an unknown state. + /// + protected void SetAllResourcesToUnknownState() + { + Verify.Operation(this.IsWriteLockHeld, Strings.InvalidLock); + this.helper.SetAllResourcesToUnknownState(); + } + + /// + /// Returns the aggregate of the lock flags for all nested locks. + /// + protected new LockFlags GetAggregateLockFlags() + { + return (LockFlags)base.GetAggregateLockFlags(); + } + + /// + /// Prepares a resource for concurrent access. + /// + /// The resource to prepare. + /// The token whose cancellation signals lost interest in the resource. + /// A task whose completion signals the resource has been prepared. + /// + /// This is invoked on a resource when it is initially requested for concurrent access, + /// for both transitions from no access and exclusive access. + /// + protected abstract Task PrepareResourceForConcurrentAccessAsync(TResource resource, CancellationToken cancellationToken); + + /// + /// Prepares a resource for access by one thread. + /// + /// The resource to prepare. + /// The aggregate of all flags from the active and nesting locks. + /// The token whose cancellation signals lost interest in the resource. + /// A task whose completion signals the resource has been prepared. + /// + /// This is invoked on a resource when it is initially access for exclusive access, + /// but only when transitioning from no access -- it is not invoked when transitioning + /// from concurrent access to exclusive access. + /// + protected abstract Task PrepareResourceForExclusiveAccessAsync(TResource resource, LockFlags lockFlags, CancellationToken cancellationToken); + + /// + /// Invoked after an exclusive lock is released but before anyone has a chance to enter the lock. + /// + /// + /// This method is called while holding a private lock in order to block future lock consumers till this method is finished. + /// + protected override async Task OnExclusiveLockReleasedAsync() + { + await base.OnExclusiveLockReleasedAsync().ConfigureAwait(false); + await this.helper.OnExclusiveLockReleasedAsync().ConfigureAwait(false); + } + + /// + /// Invoked when a top-level upgradeable read lock is released, leaving no remaining (write) lock. + /// + protected override void OnUpgradeableReadLockReleased() + { + base.OnUpgradeableReadLockReleased(); + this.helper.OnUpgradeableReadLockReleased(); + } + + /// + /// An awaitable that is returned from asynchronous lock requests. + /// + public readonly struct ResourceAwaitable { /// - /// A private nested class we use to isolate some of the behavior. + /// The underlying lock awaitable. + /// + private readonly AsyncReaderWriterLock.Awaitable awaitable; + + /// + /// The helper class. /// private readonly Helper helper; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the struct. /// - protected AsyncReaderWriterResourceLock() + /// The underlying lock awaitable. + /// The helper class. + internal ResourceAwaitable(AsyncReaderWriterLock.Awaitable awaitable, Helper helper) { - this.helper = new Helper(this); + this.awaitable = awaitable; + this.helper = helper; } /// - /// Initializes a new instance of the class. + /// Gets the awaiter value. /// - /// - /// to spend additional resources capturing diagnostic details that can be used - /// to analyze deadlocks or other issues. - protected AsyncReaderWriterResourceLock(bool captureDiagnostics) - : base(captureDiagnostics) + public ResourceAwaiter GetAwaiter() { - this.helper = new Helper(this); + return new ResourceAwaiter(this.awaitable.GetAwaiter(), this.helper); } + } + /// + /// Manages asynchronous access to a lock. + /// + [DebuggerDisplay("{awaiter.kind}")] + public readonly struct ResourceAwaiter : ICriticalNotifyCompletion + { /// - /// Initializes a new instance of the class. + /// The underlying lock awaiter. /// - /// - /// A JoinableTaskContext to help resolve dead locks caused by interdependency between top read lock tasks when there is a pending write lock blocking one of them. - /// - /// - /// to spend additional resources capturing diagnostic details that can be used - /// to analyze deadlocks or other issues. - protected AsyncReaderWriterResourceLock(JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) - : base(joinableTaskContext, captureDiagnostics) - { - this.helper = new Helper(this); - } + private readonly AsyncReaderWriterLock.Awaiter awaiter; /// - /// Flags that modify default lock behavior. + /// The helper class. /// - [Flags] - public new enum LockFlags - { - /// - /// The default behavior applies. - /// - None = 0x0, + private readonly Helper helper; - /// - /// Causes an upgradeable reader to remain in an upgraded-write state once upgraded, - /// even after the nested write lock has been released. - /// - /// - /// This is useful when you have a batch of possible write operations to apply, which - /// may or may not actually apply in the end, but if any of them change anything, - /// all of their changes should be seen atomically (within a single write lock). - /// This approach is preferable to simply acquiring a write lock around the batch of - /// potential changes because it doesn't defeat concurrent readers until it knows there - /// is a change to actually make. - /// - StickyWrite = 0x1, + /// + /// Initializes a new instance of the struct. + /// + /// The underlying lock awaiter. + /// The helper class. + internal ResourceAwaiter(AsyncReaderWriterLock.Awaiter awaiter, Helper helper) + { + Requires.NotNull(awaiter, nameof(awaiter)); + Requires.NotNull(helper, nameof(helper)); - /// - /// Skips a step to make sure that the resource is initially prepared when retrieved using GetResourceAsync. - /// - /// - /// This flag is dormant for non-write locks. But if present on an upgradeable read lock, - /// this flag will activate for a nested write lock. - /// - SkipInitialPreparation = 0x1000, + this.awaiter = awaiter; + this.helper = helper; } /// - /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// Gets a value indicating whether the lock has been issued. /// - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public new ResourceAwaitable ReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + public bool IsCompleted { - return new ResourceAwaitable(base.ReadLockAsync(cancellationToken), this.helper); + get + { + if (this.awaiter is null) + { + throw new InvalidOperationException(); + } + + return this.awaiter.IsCompleted; + } } /// - /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// Sets the delegate to execute when the lock is available. /// - /// Modifications to normal lock behavior. - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public ResourceAwaitable UpgradeableReadLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) + /// The delegate. + public void OnCompleted(Action continuation) { - return new ResourceAwaitable(this.UpgradeableReadLockAsync((AsyncReaderWriterLock.LockFlags)options, cancellationToken), this.helper); + if (this.awaiter is null) + { + throw new InvalidOperationException(); + } + + this.awaiter.OnCompleted(continuation); } /// - /// Obtains an upgradeable read lock, asynchronously awaiting for the lock if it is not immediately available. + /// Sets the delegate to execute when the lock is available. /// - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public new ResourceAwaitable UpgradeableReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + /// The delegate. + public void UnsafeOnCompleted(Action continuation) { - return new ResourceAwaitable(base.UpgradeableReadLockAsync(cancellationToken), this.helper); + if (this.awaiter is null) + { + throw new InvalidOperationException(); + } + + this.awaiter.UnsafeOnCompleted(continuation); } /// - /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. + /// Applies the issued lock to the caller and returns the value used to release the lock. /// - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public new ResourceAwaitable WriteLockAsync(CancellationToken cancellationToken = default(CancellationToken)) + /// The value to dispose of to release the lock. + public ResourceReleaser GetResult() { - return new ResourceAwaitable(base.WriteLockAsync(cancellationToken), this.helper); + if (this.awaiter is null) + { + throw new InvalidOperationException(); + } + + return new ResourceReleaser(this.awaiter.GetResult(), this.helper); } + } + /// + /// A value whose disposal releases a held lock. + /// + [DebuggerDisplay("{releaser.awaiter.kind}")] + public readonly struct ResourceReleaser : IDisposable, System.IAsyncDisposable + { /// - /// Obtains a write lock, asynchronously awaiting for the lock if it is not immediately available. + /// The underlying lock releaser. /// - /// Modifications to normal lock behavior. - /// - /// A token whose cancellation indicates lost interest in obtaining the lock. - /// A canceled token does not release a lock that has already been issued. But if the lock isn't immediately available, - /// a canceled token will cause the code that is waiting for the lock to resume with an . - /// - /// An awaitable object whose result is the lock releaser. - public ResourceAwaitable WriteLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) - { - return new ResourceAwaitable(this.WriteLockAsync((AsyncReaderWriterLock.LockFlags)options, cancellationToken), this.helper); - } + private readonly AsyncReaderWriterLock.Releaser releaser; /// - /// Retrieves the resource with the specified moniker. + /// The helper class. /// - /// The identifier for the desired resource. - /// A token whose cancellation indicates lost interest in obtaining the resource. - /// A task whose result is the desired resource. - protected abstract Task GetResourceAsync(TMoniker resourceMoniker, CancellationToken cancellationToken); + private readonly Helper helper; /// - /// Marks a resource as having been retrieved under a lock. + /// Initializes a new instance of the struct. /// - protected void SetResourceAsAccessed(TResource resource) + /// The underlying lock releaser. + /// The helper class. + internal ResourceReleaser(AsyncReaderWriterLock.Releaser releaser, Helper helper) { - this.helper.SetResourceAsAccessed(resource); + this.releaser = releaser; + this.helper = helper; } /// - /// Marks any loaded resources as having been retrieved under a lock if they - /// satisfy some predicate. + /// Gets the underlying lock releaser. /// - /// A function that returns if the provided resource should be considered retrieved. - /// The state object to pass as a second parameter to . - /// if the delegate returned on any of the invocations. - protected bool SetResourceAsAccessed(Func resourceCheck, object? state) + internal AsyncReaderWriterLock.Releaser LockReleaser { - return this.helper.SetResourceAsAccessed(resourceCheck, state); + get { return this.releaser; } } /// - /// Sets all the resources to be considered in an unknown state. + /// Gets the lock protected resource. /// - protected void SetAllResourcesToUnknownState() + /// The identifier for the protected resource. + /// A token whose cancellation signals lost interest in the protected resource. + /// A task whose result is the resource. + public Task GetResourceAsync(TMoniker resourceMoniker, CancellationToken cancellationToken = default(CancellationToken)) { - Verify.Operation(this.IsWriteLockHeld, Strings.InvalidLock); - this.helper.SetAllResourcesToUnknownState(); + return this.helper.GetResourceAsync(resourceMoniker, cancellationToken); } /// - /// Returns the aggregate of the lock flags for all nested locks. + /// Releases the lock. /// - protected new LockFlags GetAggregateLockFlags() + public void Dispose() { - return (LockFlags)base.GetAggregateLockFlags(); + this.LockReleaser.Dispose(); } /// - /// Prepares a resource for concurrent access. + /// Releases the lock. /// - /// The resource to prepare. - /// The token whose cancellation signals lost interest in the resource. - /// A task whose completion signals the resource has been prepared. - /// - /// This is invoked on a resource when it is initially requested for concurrent access, - /// for both transitions from no access and exclusive access. - /// - protected abstract Task PrepareResourceForConcurrentAccessAsync(TResource resource, CancellationToken cancellationToken); + public ValueTask DisposeAsync() => this.LockReleaser.DisposeAsync(); /// - /// Prepares a resource for access by one thread. + /// Asynchronously releases the lock. Dispose should still be called after this. /// - /// The resource to prepare. - /// The aggregate of all flags from the active and nesting locks. - /// The token whose cancellation signals lost interest in the resource. - /// A task whose completion signals the resource has been prepared. /// - /// This is invoked on a resource when it is initially access for exclusive access, - /// but only when transitioning from no access -- it is not invoked when transitioning - /// from concurrent access to exclusive access. + /// Rather than calling this method explicitly, use the C# 8 "await using" syntax instead. /// - protected abstract Task PrepareResourceForExclusiveAccessAsync(TResource resource, LockFlags lockFlags, CancellationToken cancellationToken); + public Task ReleaseAsync() + { + return this.LockReleaser.ReleaseAsync(); + } + } + /// + /// A helper class to isolate some specific functionality in this outer class. + /// + internal class Helper + { /// - /// Invoked after an exclusive lock is released but before anyone has a chance to enter the lock. + /// The owning lock instance. /// - /// - /// This method is called while holding a private lock in order to block future lock consumers till this method is finished. - /// - protected override async Task OnExclusiveLockReleasedAsync() - { - await base.OnExclusiveLockReleasedAsync().ConfigureAwait(false); - await this.helper.OnExclusiveLockReleasedAsync().ConfigureAwait(false); - } + private readonly AsyncReaderWriterResourceLock service; /// - /// Invoked when a top-level upgradeable read lock is released, leaving no remaining (write) lock. + /// A reusable delegate that invokes the method. /// - protected override void OnUpgradeableReadLockReleased() - { - base.OnUpgradeableReadLockReleased(); - this.helper.OnUpgradeableReadLockReleased(); - } + private readonly Func prepareResourceConcurrentDelegate; /// - /// An awaitable that is returned from asynchronous lock requests. + /// A reusable delegate that invokes the method. /// - public readonly struct ResourceAwaitable - { - /// - /// The underlying lock awaitable. - /// - private readonly AsyncReaderWriterLock.Awaitable awaitable; + private readonly Func prepareResourceExclusiveDelegate; - /// - /// The helper class. - /// - private readonly Helper helper; + /// + /// A reusable delegate that invokes the method. + /// + private readonly Func prepareResourceConcurrentContinuationDelegate; - /// - /// Initializes a new instance of the struct. - /// - /// The underlying lock awaitable. - /// The helper class. - internal ResourceAwaitable(AsyncReaderWriterLock.Awaitable awaitable, Helper helper) - { - this.awaitable = awaitable; - this.helper = helper; - } + /// + /// A reusable delegate that invokes the method. + /// + private readonly Func prepareResourceExclusiveContinuationDelegate; - /// - /// Gets the awaiter value. - /// - public ResourceAwaiter GetAwaiter() - { - return new ResourceAwaiter(this.awaitable.GetAwaiter(), this.helper); - } - } + /// + /// A reusable delegate that invokes the method. + /// + private readonly Func prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate; /// - /// Manages asynchronous access to a lock. + /// A reusable delegate that invokes the method. /// - [DebuggerDisplay("{awaiter.kind}")] - public readonly struct ResourceAwaiter : ICriticalNotifyCompletion - { - /// - /// The underlying lock awaiter. - /// - private readonly AsyncReaderWriterLock.Awaiter awaiter; + private readonly Func prepareResourceExclusiveContinuationOnPossibleCancelledTaskDelegateDelegate; - /// - /// The helper class. - /// - private readonly Helper helper; + /// + /// A collection of all the resources requested within the outermost upgradeable read lock. + /// + private readonly HashSet resourcesAcquiredWithinUpgradeableRead = new HashSet(); - /// - /// Initializes a new instance of the struct. - /// - /// The underlying lock awaiter. - /// The helper class. - internal ResourceAwaiter(AsyncReaderWriterLock.Awaiter awaiter, Helper helper) - { - Requires.NotNull(awaiter, nameof(awaiter)); - Requires.NotNull(helper, nameof(helper)); + /// + /// A map of resources to the status of tasks that most recently began evaluating them. + /// + private WeakKeyDictionary resourcePreparationStates = new WeakKeyDictionary(capacity: 2); - this.awaiter = awaiter; - this.helper = helper; - } + /// + /// Initializes a new instance of the class. + /// + /// The owning lock instance. + internal Helper(AsyncReaderWriterResourceLock service) + { + Requires.NotNull(service, nameof(service)); - /// - /// Gets a value indicating whether the lock has been issued. - /// - public bool IsCompleted + this.service = service; + this.prepareResourceConcurrentDelegate = state => { - get - { - if (this.awaiter is null) - { - throw new InvalidOperationException(); - } + var tuple = (Tuple)state; + return this.service.PrepareResourceForConcurrentAccessAsync(tuple.Item1, tuple.Item2); + }; - return this.awaiter.IsCompleted; - } - } + this.prepareResourceExclusiveDelegate = state => + { + var tuple = (Tuple)state; + return this.service.PrepareResourceForExclusiveAccessAsync(tuple.Item1, tuple.Item2, tuple.Item3); + }; - /// - /// Sets the delegate to execute when the lock is available. - /// - /// The delegate. - public void OnCompleted(Action continuation) + this.prepareResourceConcurrentContinuationDelegate = (prev, state) => { - if (this.awaiter is null) - { - throw new InvalidOperationException(); - } + var tuple = (Tuple)state; + return this.service.PrepareResourceForConcurrentAccessAsync(tuple.Item1, tuple.Item2); + }; - this.awaiter.OnCompleted(continuation); - } + this.prepareResourceExclusiveContinuationDelegate = (prev, state) => + { + var tuple = (Tuple)state; + return this.service.PrepareResourceForExclusiveAccessAsync(tuple.Item1, tuple.Item2, tuple.Item3); + }; - /// - /// Sets the delegate to execute when the lock is available. - /// - /// The delegate. - public void UnsafeOnCompleted(Action continuation) + // this delegate is to handle the case that we prepare resource when the previous task might be cancelled. + // Because the previous task might not be cancelled, but actually finished. In that case, we will consider the work has done, and there is no need to prepare it again. + this.prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate = (prev, state) => { - if (this.awaiter is null) + if (!prev.IsFaulted && !prev.IsCanceled) { - throw new InvalidOperationException(); + return prev; } - this.awaiter.UnsafeOnCompleted(continuation); - } + var tuple = (Tuple)state; + return this.service.PrepareResourceForConcurrentAccessAsync(tuple.Item1, tuple.Item2); + }; - /// - /// Applies the issued lock to the caller and returns the value used to release the lock. - /// - /// The value to dispose of to release the lock. - public ResourceReleaser GetResult() + this.prepareResourceExclusiveContinuationOnPossibleCancelledTaskDelegateDelegate = (prev, state) => { - if (this.awaiter is null) + if (!prev.IsFaulted && !prev.IsCanceled) { - throw new InvalidOperationException(); + return prev; } - return new ResourceReleaser(this.awaiter.GetResult(), this.helper); - } + var tuple = (Tuple)state; + return this.service.PrepareResourceForExclusiveAccessAsync(tuple.Item1, tuple.Item2, tuple.Item3); + }; } /// - /// A value whose disposal releases a held lock. + /// Describes the states a resource can be in. /// - [DebuggerDisplay("{releaser.awaiter.kind}")] - public readonly struct ResourceReleaser : IDisposable, System.IAsyncDisposable + private enum ResourceState { /// - /// The underlying lock releaser. + /// The resource is neither prepared for concurrent nor exclusive access. /// - private readonly AsyncReaderWriterLock.Releaser releaser; + Unknown, /// - /// The helper class. + /// The resource is prepared for concurrent access. /// - private readonly Helper helper; + Concurrent, /// - /// Initializes a new instance of the struct. + /// The resource is prepared for exclusive access. /// - /// The underlying lock releaser. - /// The helper class. - internal ResourceReleaser(AsyncReaderWriterLock.Releaser releaser, Helper helper) - { - this.releaser = releaser; - this.helper = helper; - } - - /// - /// Gets the underlying lock releaser. - /// - internal AsyncReaderWriterLock.Releaser LockReleaser - { - get { return this.releaser; } - } + Exclusive, + } - /// - /// Gets the lock protected resource. - /// - /// The identifier for the protected resource. - /// A token whose cancellation signals lost interest in the protected resource. - /// A task whose result is the resource. - public Task GetResourceAsync(TMoniker resourceMoniker, CancellationToken cancellationToken = default(CancellationToken)) + /// + /// Marks a resource as having been retrieved under a lock. + /// + internal void SetResourceAsAccessed(TResource resource) + { + Requires.NotNull(resource, nameof(resource)); + + // Capture the ambient lock and use it for the two lock checks rather than + // call AsyncReaderWriterLock.IsWriteLockHeld and IsUpgradeableReadLockHeld + // to reduce the number of slow AsyncLocal.get_Value calls we make. + // Also do it before we acquire the lock, since a lock isn't necessary. + // (verified to be a perf bottleneck in ETL traces). + LockHandle ambientLock = this.service.AmbientLock; + lock (this.service.SyncObject) { - return this.helper.GetResourceAsync(resourceMoniker, cancellationToken); + if (!ambientLock.HasWriteLock && ambientLock.HasUpgradeableReadLock) + { + this.resourcesAcquiredWithinUpgradeableRead.Add(resource); + } } + } - /// - /// Releases the lock. - /// - public void Dispose() + /// + /// Marks any loaded resources as having been retrieved under a lock if they + /// satisfy some predicate. + /// + /// A function that returns if the provided resource should be considered retrieved. + /// The state object to pass as a second parameter to . + /// if the delegate returned on any of the invocations. + internal bool SetResourceAsAccessed(Func resourceCheck, object? state) + { + Requires.NotNull(resourceCheck, nameof(resourceCheck)); + + // Capture the ambient lock and use it for the two lock checks rather than + // call AsyncReaderWriterLock.IsWriteLockHeld and IsUpgradeableReadLockHeld + // to reduce the number of slow AsyncLocal.get_Value calls we make. + // Also do it before we acquire the lock, since a lock isn't necessary. + // (verified to be a perf bottleneck in ETL traces). + LockHandle ambientLock = this.service.AmbientLock; + bool match = false; + lock (this.service.SyncObject) { - this.LockReleaser.Dispose(); + if (ambientLock.HasWriteLock || ambientLock.HasUpgradeableReadLock) + { + foreach (KeyValuePair.Helper.ResourcePreparationTaskState> resource in this.resourcePreparationStates) + { + if (resourceCheck(resource.Key, state)) + { + match = true; + this.SetResourceAsAccessed(resource.Key); + } + } + } } - /// - /// Releases the lock. - /// - public ValueTask DisposeAsync() => this.LockReleaser.DisposeAsync(); - - /// - /// Asynchronously releases the lock. Dispose should still be called after this. - /// - /// - /// Rather than calling this method explicitly, use the C# 8 "await using" syntax instead. - /// - public Task ReleaseAsync() - { - return this.LockReleaser.ReleaseAsync(); - } + return match; } /// - /// A helper class to isolate some specific functionality in this outer class. + /// Ensures that all resources are marked as unprepared so at next request they are prepared again. /// - internal class Helper + internal Task OnExclusiveLockReleasedAsync() { - /// - /// The owning lock instance. - /// - private readonly AsyncReaderWriterResourceLock service; - - /// - /// A reusable delegate that invokes the method. - /// - private readonly Func prepareResourceConcurrentDelegate; - - /// - /// A reusable delegate that invokes the method. - /// - private readonly Func prepareResourceExclusiveDelegate; - - /// - /// A reusable delegate that invokes the method. - /// - private readonly Func prepareResourceConcurrentContinuationDelegate; - - /// - /// A reusable delegate that invokes the method. - /// - private readonly Func prepareResourceExclusiveContinuationDelegate; - - /// - /// A reusable delegate that invokes the method. - /// - private readonly Func prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate; - - /// - /// A reusable delegate that invokes the method. - /// - private readonly Func prepareResourceExclusiveContinuationOnPossibleCancelledTaskDelegateDelegate; - - /// - /// A collection of all the resources requested within the outermost upgradeable read lock. - /// - private readonly HashSet resourcesAcquiredWithinUpgradeableRead = new HashSet(); - - /// - /// A map of resources to the status of tasks that most recently began evaluating them. - /// - private WeakKeyDictionary resourcePreparationStates = new WeakKeyDictionary(capacity: 2); - - /// - /// Initializes a new instance of the class. - /// - /// The owning lock instance. - internal Helper(AsyncReaderWriterResourceLock service) + lock (this.service.SyncObject) { - Requires.NotNull(service, nameof(service)); - - this.service = service; - this.prepareResourceConcurrentDelegate = state => - { - var tuple = (Tuple)state; - return this.service.PrepareResourceForConcurrentAccessAsync(tuple.Item1, tuple.Item2); - }; - - this.prepareResourceExclusiveDelegate = state => - { - var tuple = (Tuple)state; - return this.service.PrepareResourceForExclusiveAccessAsync(tuple.Item1, tuple.Item2, tuple.Item3); - }; - - this.prepareResourceConcurrentContinuationDelegate = (prev, state) => - { - var tuple = (Tuple)state; - return this.service.PrepareResourceForConcurrentAccessAsync(tuple.Item1, tuple.Item2); - }; - - this.prepareResourceExclusiveContinuationDelegate = (prev, state) => - { - var tuple = (Tuple)state; - return this.service.PrepareResourceForExclusiveAccessAsync(tuple.Item1, tuple.Item2, tuple.Item3); - }; + // Reset ALL resources to an unknown state. Not just the ones explicitly requested + // because backdoors can and legitimately do (as in CPS) exist for tampering + // with a resource without going through our access methods. + this.SetAllResourcesToUnknownState(); - // this delegate is to handle the case that we prepare resource when the previous task might be cancelled. - // Because the previous task might not be cancelled, but actually finished. In that case, we will consider the work has done, and there is no need to prepare it again. - this.prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate = (prev, state) => + if (this.service.IsUpgradeableReadLockHeld && this.resourcesAcquiredWithinUpgradeableRead.Count > 0) { - if (!prev.IsFaulted && !prev.IsCanceled) + // We must also synchronously prepare all resources that were acquired within the upgradeable read lock + // because as soon as this method returns these resources may be access concurrently again. + var preparationTasks = new Task[this.resourcesAcquiredWithinUpgradeableRead.Count]; + int taskIndex = 0; + foreach (TResource? resource in this.resourcesAcquiredWithinUpgradeableRead) { - return prev; + preparationTasks[taskIndex++] = this.PrepareResourceAsync(resource, CancellationToken.None, forcePrepareConcurrent: true); } - var tuple = (Tuple)state; - return this.service.PrepareResourceForConcurrentAccessAsync(tuple.Item1, tuple.Item2); - }; - - this.prepareResourceExclusiveContinuationOnPossibleCancelledTaskDelegateDelegate = (prev, state) => - { - if (!prev.IsFaulted && !prev.IsCanceled) + if (preparationTasks.Length == 1) { - return prev; + return preparationTasks[0]; } - - var tuple = (Tuple)state; - return this.service.PrepareResourceForExclusiveAccessAsync(tuple.Item1, tuple.Item2, tuple.Item3); - }; - } - - /// - /// Describes the states a resource can be in. - /// - private enum ResourceState - { - /// - /// The resource is neither prepared for concurrent nor exclusive access. - /// - Unknown, - - /// - /// The resource is prepared for concurrent access. - /// - Concurrent, - - /// - /// The resource is prepared for exclusive access. - /// - Exclusive, - } - - /// - /// Marks a resource as having been retrieved under a lock. - /// - internal void SetResourceAsAccessed(TResource resource) - { - Requires.NotNull(resource, nameof(resource)); - - // Capture the ambient lock and use it for the two lock checks rather than - // call AsyncReaderWriterLock.IsWriteLockHeld and IsUpgradeableReadLockHeld - // to reduce the number of slow AsyncLocal.get_Value calls we make. - // Also do it before we acquire the lock, since a lock isn't necessary. - // (verified to be a perf bottleneck in ETL traces). - LockHandle ambientLock = this.service.AmbientLock; - lock (this.service.SyncObject) - { - if (!ambientLock.HasWriteLock && ambientLock.HasUpgradeableReadLock) + else if (preparationTasks.Length > 1) { - this.resourcesAcquiredWithinUpgradeableRead.Add(resource); + return Task.WhenAll(preparationTasks); } } } - /// - /// Marks any loaded resources as having been retrieved under a lock if they - /// satisfy some predicate. - /// - /// A function that returns if the provided resource should be considered retrieved. - /// The state object to pass as a second parameter to . - /// if the delegate returned on any of the invocations. - internal bool SetResourceAsAccessed(Func resourceCheck, object? state) - { - Requires.NotNull(resourceCheck, nameof(resourceCheck)); - - // Capture the ambient lock and use it for the two lock checks rather than - // call AsyncReaderWriterLock.IsWriteLockHeld and IsUpgradeableReadLockHeld - // to reduce the number of slow AsyncLocal.get_Value calls we make. - // Also do it before we acquire the lock, since a lock isn't necessary. - // (verified to be a perf bottleneck in ETL traces). - LockHandle ambientLock = this.service.AmbientLock; - bool match = false; - lock (this.service.SyncObject) - { - if (ambientLock.HasWriteLock || ambientLock.HasUpgradeableReadLock) - { - foreach (KeyValuePair.Helper.ResourcePreparationTaskState> resource in this.resourcePreparationStates) - { - if (resourceCheck(resource.Key, state)) - { - match = true; - this.SetResourceAsAccessed(resource.Key); - } - } - } - } + return Task.CompletedTask; + } - return match; - } + /// + /// Invoked when a top-level upgradeable read lock is released, leaving no remaining (write) lock. + /// + internal void OnUpgradeableReadLockReleased() + { + this.resourcesAcquiredWithinUpgradeableRead.Clear(); + } - /// - /// Ensures that all resources are marked as unprepared so at next request they are prepared again. - /// - internal Task OnExclusiveLockReleasedAsync() + /// + /// Retrieves the resource with the specified moniker. + /// + /// The identifier for the desired resource. + /// The token whose cancellation signals lost interest in this resource. + /// A task whose result is the desired resource. + internal async Task GetResourceAsync(TMoniker resourceMoniker, CancellationToken cancellationToken) + { + using (AsyncReaderWriterResourceLock.ResourceReleaser resourceLock = this.AcquirePreexistingLockOrThrow()) { + TResource? resource = await this.service.GetResourceAsync(resourceMoniker, cancellationToken).ConfigureAwait(false); + Task preparationTask; + lock (this.service.SyncObject) { - // Reset ALL resources to an unknown state. Not just the ones explicitly requested - // because backdoors can and legitimately do (as in CPS) exist for tampering - // with a resource without going through our access methods. - this.SetAllResourcesToUnknownState(); - - if (this.service.IsUpgradeableReadLockHeld && this.resourcesAcquiredWithinUpgradeableRead.Count > 0) - { - // We must also synchronously prepare all resources that were acquired within the upgradeable read lock - // because as soon as this method returns these resources may be access concurrently again. - var preparationTasks = new Task[this.resourcesAcquiredWithinUpgradeableRead.Count]; - int taskIndex = 0; - foreach (TResource? resource in this.resourcesAcquiredWithinUpgradeableRead) - { - preparationTasks[taskIndex++] = this.PrepareResourceAsync(resource, CancellationToken.None, forcePrepareConcurrent: true); - } + this.SetResourceAsAccessed(resource); - if (preparationTasks.Length == 1) - { - return preparationTasks[0]; - } - else if (preparationTasks.Length > 1) - { - return Task.WhenAll(preparationTasks); - } - } + preparationTask = this.PrepareResourceAsync(resource, cancellationToken); } - return Task.CompletedTask; + await preparationTask.ConfigureAwait(false); + return resource; } + } - /// - /// Invoked when a top-level upgradeable read lock is released, leaving no remaining (write) lock. - /// - internal void OnUpgradeableReadLockReleased() + /// + /// Sets all the resources to be considered in an unknown state. Any subsequent access (exclusive or concurrent) will prepare the resource. + /// + internal void SetAllResourcesToUnknownState() + { + this.SetUnknownResourceState(this.resourcePreparationStates.Select(rp => rp.Key).ToList()); + } + + /// + /// Sets the specified resource to be considered in an unknown state. Any subsequent access (exclusive or concurrent) will prepare the resource. + /// + private void SetUnknownResourceState(TResource resource) + { + Requires.NotNull(resource, nameof(resource)); + + lock (this.service.SyncObject) { - this.resourcesAcquiredWithinUpgradeableRead.Clear(); + this.resourcePreparationStates.TryGetValue(resource, out ResourcePreparationTaskState? previousState); + this.resourcePreparationStates[resource] = ResourcePreparationTaskState.Create( + _ => previousState?.InnerTask ?? Task.CompletedTask, + ResourceState.Unknown, + CancellationToken.None).PreparationState; } + } - /// - /// Retrieves the resource with the specified moniker. - /// - /// The identifier for the desired resource. - /// The token whose cancellation signals lost interest in this resource. - /// A task whose result is the desired resource. - internal async Task GetResourceAsync(TMoniker resourceMoniker, CancellationToken cancellationToken) + /// + /// Sets the specified resources to be considered in an unknown state. Any subsequent access (exclusive or concurrent) will prepare the resource. + /// + private void SetUnknownResourceState(IEnumerable resources) + { + Requires.NotNull(resources, nameof(resources)); + foreach (TResource? resource in resources) { - using (AsyncReaderWriterResourceLock.ResourceReleaser resourceLock = this.AcquirePreexistingLockOrThrow()) - { - TResource? resource = await this.service.GetResourceAsync(resourceMoniker, cancellationToken).ConfigureAwait(false); - Task preparationTask; + this.SetUnknownResourceState(resource); + } + } - lock (this.service.SyncObject) - { - this.SetResourceAsAccessed(resource); + /// + /// Prepares the specified resource for access by a lock holder. + /// + /// The resource to prepare. + /// The token whose cancellation signals lost interest in this resource. + /// Force preparation of the resource for concurrent access, even if an exclusive lock is currently held. + /// A task that is completed when preparation has completed. + private Task PrepareResourceAsync(TResource resource, CancellationToken cancellationToken, bool forcePrepareConcurrent = false) + { + Requires.NotNull(resource, nameof(resource)); + Assumes.True(Monitor.IsEntered(this.service.SyncObject)); - preparationTask = this.PrepareResourceAsync(resource, cancellationToken); - } + // We deliberately ignore the cancellation token in the tasks we create and save because the tasks can be shared + // across requests and we can't have task continuation chains where tasks within the chain get canceled + // as that can cause premature starting of the next task in the chain. + bool forConcurrentUse = forcePrepareConcurrent || !this.service.IsWriteLockHeld; + AsyncReaderWriterResourceLock.Helper.ResourceState finalState = forConcurrentUse ? ResourceState.Concurrent : ResourceState.Exclusive; - await preparationTask.ConfigureAwait(false); - return resource; - } - } + Task? preparationTask = null; - /// - /// Sets all the resources to be considered in an unknown state. Any subsequent access (exclusive or concurrent) will prepare the resource. - /// - internal void SetAllResourcesToUnknownState() + if (!this.resourcePreparationStates.TryGetValue(resource, out ResourcePreparationTaskState? preparationState)) { - this.SetUnknownResourceState(this.resourcePreparationStates.Select(rp => rp.Key).ToList()); - } - - /// - /// Sets the specified resource to be considered in an unknown state. Any subsequent access (exclusive or concurrent) will prepare the resource. - /// - private void SetUnknownResourceState(TResource resource) - { - Requires.NotNull(resource, nameof(resource)); - - lock (this.service.SyncObject) + Func? preparationDelegate = forConcurrentUse + ? this.prepareResourceConcurrentDelegate + : this.prepareResourceExclusiveDelegate; + + // We kick this off on a new task because we're currently holding a private lock + // and don't want to execute arbitrary code. + // Let's also hide the ARWL from the delegate if this is a shared lock request. + using (forConcurrentUse ? this.service.HideLocks() : default(Suppression)) { - this.resourcePreparationStates.TryGetValue(resource, out ResourcePreparationTaskState? previousState); - this.resourcePreparationStates[resource] = ResourcePreparationTaskState.Create( - _ => previousState?.InnerTask ?? Task.CompletedTask, - ResourceState.Unknown, - CancellationToken.None).PreparationState; + // We can't currently use the caller's cancellation token for this task because + // this task may be shared with others or call this method later, and we wouldn't + // want their requests to be cancelled as a result of this first caller cancelling. + (preparationState, preparationTask) = ResourcePreparationTaskState.Create( + combinedCancellationToken => Task.Factory.StartNew( + NullableHelpers.AsNullableArgFunc(preparationDelegate), + forConcurrentUse ? Tuple.Create(resource, combinedCancellationToken) : Tuple.Create(resource, this.service.GetAggregateLockFlags(), combinedCancellationToken), + combinedCancellationToken, + TaskCreationOptions.None, + TaskScheduler.Default).Unwrap(), + finalState, + cancellationToken); } } - - /// - /// Sets the specified resources to be considered in an unknown state. Any subsequent access (exclusive or concurrent) will prepare the resource. - /// - private void SetUnknownResourceState(IEnumerable resources) + else { - Requires.NotNull(resources, nameof(resources)); - foreach (TResource? resource in resources) + Func? preparationDelegate = null; + if (preparationState.State != finalState || preparationState.InnerTask.IsFaulted) { - this.SetUnknownResourceState(resource); + preparationDelegate = forConcurrentUse + ? this.prepareResourceConcurrentContinuationDelegate + : this.prepareResourceExclusiveContinuationDelegate; + } + else if (!preparationState.TryJoinPrepationTask(out preparationTask, cancellationToken)) + { + preparationDelegate = forConcurrentUse + ? this.prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate + : this.prepareResourceExclusiveContinuationOnPossibleCancelledTaskDelegateDelegate; } - } - - /// - /// Prepares the specified resource for access by a lock holder. - /// - /// The resource to prepare. - /// The token whose cancellation signals lost interest in this resource. - /// Force preparation of the resource for concurrent access, even if an exclusive lock is currently held. - /// A task that is completed when preparation has completed. - private Task PrepareResourceAsync(TResource resource, CancellationToken cancellationToken, bool forcePrepareConcurrent = false) - { - Requires.NotNull(resource, nameof(resource)); - Assumes.True(Monitor.IsEntered(this.service.SyncObject)); - - // We deliberately ignore the cancellation token in the tasks we create and save because the tasks can be shared - // across requests and we can't have task continuation chains where tasks within the chain get canceled - // as that can cause premature starting of the next task in the chain. - bool forConcurrentUse = forcePrepareConcurrent || !this.service.IsWriteLockHeld; - AsyncReaderWriterResourceLock.Helper.ResourceState finalState = forConcurrentUse ? ResourceState.Concurrent : ResourceState.Exclusive; - - Task? preparationTask = null; - if (!this.resourcePreparationStates.TryGetValue(resource, out ResourcePreparationTaskState? preparationState)) + if (preparationTask is null) { - Func? preparationDelegate = forConcurrentUse - ? this.prepareResourceConcurrentDelegate - : this.prepareResourceExclusiveDelegate; + Assumes.NotNull(preparationDelegate); // We kick this off on a new task because we're currently holding a private lock // and don't want to execute arbitrary code. // Let's also hide the ARWL from the delegate if this is a shared lock request. using (forConcurrentUse ? this.service.HideLocks() : default(Suppression)) { - // We can't currently use the caller's cancellation token for this task because - // this task may be shared with others or call this method later, and we wouldn't - // want their requests to be cancelled as a result of this first caller cancelling. (preparationState, preparationTask) = ResourcePreparationTaskState.Create( - combinedCancellationToken => Task.Factory.StartNew( - NullableHelpers.AsNullableArgFunc(preparationDelegate), + combinedCancellationToken => preparationState.InnerTask.ContinueWith( + preparationDelegate!, forConcurrentUse ? Tuple.Create(resource, combinedCancellationToken) : Tuple.Create(resource, this.service.GetAggregateLockFlags(), combinedCancellationToken), - combinedCancellationToken, - TaskCreationOptions.None, + CancellationToken.None, + TaskContinuationOptions.RunContinuationsAsynchronously, TaskScheduler.Default).Unwrap(), finalState, cancellationToken); } } - else - { - Func? preparationDelegate = null; - if (preparationState.State != finalState || preparationState.InnerTask.IsFaulted) - { - preparationDelegate = forConcurrentUse - ? this.prepareResourceConcurrentContinuationDelegate - : this.prepareResourceExclusiveContinuationDelegate; - } - else if (!preparationState.TryJoinPrepationTask(out preparationTask, cancellationToken)) - { - preparationDelegate = forConcurrentUse - ? this.prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate - : this.prepareResourceExclusiveContinuationOnPossibleCancelledTaskDelegateDelegate; - } - - if (preparationTask is null) - { - Assumes.NotNull(preparationDelegate); + } - // We kick this off on a new task because we're currently holding a private lock - // and don't want to execute arbitrary code. - // Let's also hide the ARWL from the delegate if this is a shared lock request. - using (forConcurrentUse ? this.service.HideLocks() : default(Suppression)) - { - (preparationState, preparationTask) = ResourcePreparationTaskState.Create( - combinedCancellationToken => preparationState.InnerTask.ContinueWith( - preparationDelegate!, - forConcurrentUse ? Tuple.Create(resource, combinedCancellationToken) : Tuple.Create(resource, this.service.GetAggregateLockFlags(), combinedCancellationToken), - CancellationToken.None, - TaskContinuationOptions.RunContinuationsAsynchronously, - TaskScheduler.Default).Unwrap(), - finalState, - cancellationToken); - } - } - } + Assumes.NotNull(preparationState); + this.resourcePreparationStates[resource] = preparationState; - Assumes.NotNull(preparationState); - this.resourcePreparationStates[resource] = preparationState; + return preparationTask; + } - return preparationTask; + /// + /// Reserves a read lock from a previously held lock. + /// + /// The releaser for the read lock. + /// Thrown if no lock is held by the caller. + private ResourceReleaser AcquirePreexistingLockOrThrow() + { + if (!this.service.IsAnyLockHeld) + { + Verify.FailOperation(Strings.InvalidWithoutLock); } + AsyncReaderWriterResourceLock.ResourceAwaiter awaiter = this.service.ReadLockAsync(CancellationToken.None).GetAwaiter(); + Assumes.True(awaiter.IsCompleted); + return awaiter.GetResult(); + } + + /// + /// Tracks a task that prepares a resource for either concurrent or exclusive use. + /// + private class ResourcePreparationTaskState : CancellableJoinComputation + { /// - /// Reserves a read lock from a previously held lock. + /// Initializes a new instance of the class. /// - /// The releaser for the read lock. - /// Thrown if no lock is held by the caller. - private ResourceReleaser AcquirePreexistingLockOrThrow() + internal ResourcePreparationTaskState(Func taskCreation, ResourceState finalState, bool canBeCancelled) + : base(taskCreation, canBeCancelled) { - if (!this.service.IsAnyLockHeld) - { - Verify.FailOperation(Strings.InvalidWithoutLock); - } - - AsyncReaderWriterResourceLock.ResourceAwaiter awaiter = this.service.ReadLockAsync(CancellationToken.None).GetAwaiter(); - Assumes.True(awaiter.IsCompleted); - return awaiter.GetResult(); + this.State = finalState; } /// - /// Tracks a task that prepares a resource for either concurrent or exclusive use. + /// Gets the state the resource will be in when inner task has completed. /// - private class ResourcePreparationTaskState : CancellableJoinComputation - { - /// - /// Initializes a new instance of the class. - /// - internal ResourcePreparationTaskState(Func taskCreation, ResourceState finalState, bool canBeCancelled) - : base(taskCreation, canBeCancelled) - { - this.State = finalState; - } + internal ResourceState State { get; } - /// - /// Gets the state the resource will be in when inner task has completed. - /// - internal ResourceState State { get; } - - /// - /// Creates a task to prepare the source and returns it with . - /// - /// A callback method to create the preparation task. - /// The final resource state when the preparation is done. - /// A cancellation token to abort the preparation task. - /// The preparation task and its status to be used to join more waiting tasks later. - internal static (ResourcePreparationTaskState PreparationState, Task InitialTask) Create(Func taskCreation, ResourceState finalState, CancellationToken cancellationToken) - { - var preparationState = new ResourcePreparationTaskState(taskCreation, finalState, cancellationToken.CanBeCanceled); - Assumes.True(preparationState.TryJoinComputation(isInitialTask: true, out Task? initialTask, cancellationToken)); + /// + /// Creates a task to prepare the source and returns it with . + /// + /// A callback method to create the preparation task. + /// The final resource state when the preparation is done. + /// A cancellation token to abort the preparation task. + /// The preparation task and its status to be used to join more waiting tasks later. + internal static (ResourcePreparationTaskState PreparationState, Task InitialTask) Create(Func taskCreation, ResourceState finalState, CancellationToken cancellationToken) + { + var preparationState = new ResourcePreparationTaskState(taskCreation, finalState, cancellationToken.CanBeCanceled); + Assumes.True(preparationState.TryJoinComputation(isInitialTask: true, out Task? initialTask, cancellationToken)); - return (preparationState, initialTask); - } + return (preparationState, initialTask); + } - /// - /// Try to join an existing preparation task. - /// - /// The new waiting task to be compeleted when the resource preparation is done. - /// A cancellation token to abandone the new waiting task. - /// True if it joins sucessfully, it return false, if the current task has been cancelled. - internal bool TryJoinPrepationTask([NotNullWhen(true)] out Task? task, CancellationToken cancellationToken) - { - return this.TryJoinComputation(isInitialTask: false, out task, cancellationToken); - } + /// + /// Try to join an existing preparation task. + /// + /// The new waiting task to be compeleted when the resource preparation is done. + /// A cancellation token to abandone the new waiting task. + /// True if it joins sucessfully, it return false, if the current task has been cancelled. + internal bool TryJoinPrepationTask([NotNullWhen(true)] out Task? task, CancellationToken cancellationToken) + { + return this.TryJoinComputation(isInitialTask: false, out task, cancellationToken); } } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs b/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs index 80aa1917e..faab0634f 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncSemaphore.cs @@ -6,375 +6,374 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An asynchronous like class with more convenient release syntax. +/// +/// +/// This semaphore guarantees FIFO ordering. +/// +/// This object does *not* need to be disposed of, as it does not hold unmanaged resources. +/// Disposing this object has no effect on current users of the semaphore, and they are allowed to release their hold on the semaphore without exception. +/// An is thrown back at anyone asking to or waiting to enter the semaphore after is called. +/// +/// +public class AsyncSemaphore : IDisposable { /// - /// An asynchronous like class with more convenient release syntax. + /// A task that is faulted with an . /// - /// - /// This semaphore guarantees FIFO ordering. - /// - /// This object does *not* need to be disposed of, as it does not hold unmanaged resources. - /// Disposing this object has no effect on current users of the semaphore, and they are allowed to release their hold on the semaphore without exception. - /// An is thrown back at anyone asking to or waiting to enter the semaphore after is called. - /// - /// - public class AsyncSemaphore : IDisposable - { - /// - /// A task that is faulted with an . - /// - private static readonly Task DisposedReleaserTask = TplExtensions.FaultedTask(new ObjectDisposedException(typeof(AsyncSemaphore).FullName)); + private static readonly Task DisposedReleaserTask = TplExtensions.FaultedTask(new ObjectDisposedException(typeof(AsyncSemaphore).FullName)); - /// - /// A task that is canceled without a specific token. - /// - private static readonly Task CanceledReleaser = Task.FromCanceled(new CancellationToken(true)); + /// + /// A task that is canceled without a specific token. + /// + private static readonly Task CanceledReleaser = Task.FromCanceled(new CancellationToken(true)); - /// - /// A task to return for any uncontested request for the lock. - /// - private readonly Task uncontestedReleaser; + /// + /// A task to return for any uncontested request for the lock. + /// + private readonly Task uncontestedReleaser; - /// - /// The sync object to lock on for mutable field access. - /// - private readonly object syncObject = new object(); + /// + /// The sync object to lock on for mutable field access. + /// + private readonly object syncObject = new object(); - /// - /// A queue of operations waiting to enter the semaphore. - /// - private readonly LinkedList waiters = new LinkedList(); + /// + /// A queue of operations waiting to enter the semaphore. + /// + private readonly LinkedList waiters = new LinkedList(); - /// - /// A pool of recycled nodes. - /// - private readonly Stack> nodePool = new Stack>(); + /// + /// A pool of recycled nodes. + /// + private readonly Stack> nodePool = new Stack>(); - /// - /// A value indicating whether this instance has been disposed. - /// - private bool disposed; + /// + /// A value indicating whether this instance has been disposed. + /// + private bool disposed; - /// - /// Initializes a new instance of the class. - /// - /// The initial number of requests for the semaphore that can be granted concurrently. - public AsyncSemaphore(int initialCount) - { - this.CurrentCount = initialCount; - this.uncontestedReleaser = Task.FromResult(new Releaser(this)); - } + /// + /// Initializes a new instance of the class. + /// + /// The initial number of requests for the semaphore that can be granted concurrently. + public AsyncSemaphore(int initialCount) + { + this.CurrentCount = initialCount; + this.uncontestedReleaser = Task.FromResult(new Releaser(this)); + } - /// - /// Gets the number of openings that remain in the semaphore. - /// - public int CurrentCount { get; private set; } + /// + /// Gets the number of openings that remain in the semaphore. + /// + public int CurrentCount { get; private set; } - /// - /// Requests access to the lock. - /// - /// A token whose cancellation signals lost interest in the lock. - /// - /// A task whose result is a releaser that should be disposed to release the lock. - /// This task may be canceled if is signaled. - /// - /// Thrown when is canceled before semaphore access is granted. - /// Thrown when this semaphore is disposed before semaphore access is granted. - public Task EnterAsync(CancellationToken cancellationToken = default) => this.EnterAsync(Timeout.InfiniteTimeSpan, cancellationToken); + /// + /// Requests access to the lock. + /// + /// A token whose cancellation signals lost interest in the lock. + /// + /// A task whose result is a releaser that should be disposed to release the lock. + /// This task may be canceled if is signaled. + /// + /// Thrown when is canceled before semaphore access is granted. + /// Thrown when this semaphore is disposed before semaphore access is granted. + public Task EnterAsync(CancellationToken cancellationToken = default) => this.EnterAsync(Timeout.InfiniteTimeSpan, cancellationToken); - /// - /// Requests access to the lock. - /// - /// A timeout for waiting for the lock. - /// A token whose cancellation signals lost interest in the lock. - /// - /// A task whose result is a releaser that should be disposed to release the lock. - /// This task may be canceled if is signaled or expires. - /// - /// Thrown when is canceled or the expires before semaphore access is granted. - /// Thrown when this semaphore is disposed before semaphore access is granted. - public Task EnterAsync(TimeSpan timeout, CancellationToken cancellationToken = default) + /// + /// Requests access to the lock. + /// + /// A timeout for waiting for the lock. + /// A token whose cancellation signals lost interest in the lock. + /// + /// A task whose result is a releaser that should be disposed to release the lock. + /// This task may be canceled if is signaled or expires. + /// + /// Thrown when is canceled or the expires before semaphore access is granted. + /// Thrown when this semaphore is disposed before semaphore access is granted. + public Task EnterAsync(TimeSpan timeout, CancellationToken cancellationToken = default) + { + if (cancellationToken.IsCancellationRequested) + { + return Task.FromCanceled(cancellationToken); + } + + WaiterInfo? info = null; + bool shouldCleanupInfo = false; + lock (this.syncObject) { - if (cancellationToken.IsCancellationRequested) + if (this.disposed) { - return Task.FromCanceled(cancellationToken); + return DisposedReleaserTask; } - WaiterInfo? info = null; - bool shouldCleanupInfo = false; - lock (this.syncObject) + if (this.CurrentCount > 0) + { + this.CurrentCount--; + return this.uncontestedReleaser; + } + else if (timeout == TimeSpan.Zero) { - if (this.disposed) + return CanceledReleaser; + } + else + { + info = new WaiterInfo(this, cancellationToken); + LinkedListNode? node = this.GetNode(info); + + // Careful: consider that if the token was cancelled just now (after we checked it on entry to this method) + // or the timeout expires, + // then this Register method may *inline* the handler we give it, reversing the apparent order of execution with respect to + // the code that follows this Register call. + info.CancellationTokenRegistration = cancellationToken.Register(s => CancellationHandler(s), info); + if (timeout != Timeout.InfiniteTimeSpan) { - return DisposedReleaserTask; + info.TimerTokenSource = new Timer(s => CancellationHandler(s), info, checked((int)timeout.TotalMilliseconds), Timeout.Infinite); } - if (this.CurrentCount > 0) + // Only add to the queue if cancellation hasn't already happened. + if (!info.Trigger.Task.IsCanceled) { - this.CurrentCount--; - return this.uncontestedReleaser; - } - else if (timeout == TimeSpan.Zero) - { - return CanceledReleaser; + this.waiters.AddLast(node); + info.Node = node; } else { - info = new WaiterInfo(this, cancellationToken); - LinkedListNode? node = this.GetNode(info); - - // Careful: consider that if the token was cancelled just now (after we checked it on entry to this method) - // or the timeout expires, - // then this Register method may *inline* the handler we give it, reversing the apparent order of execution with respect to - // the code that follows this Register call. - info.CancellationTokenRegistration = cancellationToken.Register(s => CancellationHandler(s), info); - if (timeout != Timeout.InfiniteTimeSpan) - { - info.TimerTokenSource = new Timer(s => CancellationHandler(s), info, checked((int)timeout.TotalMilliseconds), Timeout.Infinite); - } - - // Only add to the queue if cancellation hasn't already happened. - if (!info.Trigger.Task.IsCanceled) - { - this.waiters.AddLast(node); - info.Node = node; - } - else - { - // Make sure we don't leak the Timer if cancellation happened before we created it. - shouldCleanupInfo = true; + // Make sure we don't leak the Timer if cancellation happened before we created it. + shouldCleanupInfo = true; - // Also recycle the unused node. - this.RecycleNode(node); - } + // Also recycle the unused node. + this.RecycleNode(node); } } - - // We cleanup outside the lock because cleanup can block on the cancellation handler, - // and the handler can take the same lock as we held earlier in this method. - if (shouldCleanupInfo) - { - info.Cleanup(); - } - - return info.Trigger.Task; } - /// - /// Requests access to the lock. - /// - /// A timeout for waiting for the lock (in milliseconds). - /// A token whose cancellation signals lost interest in the lock. - /// A task whose result is a releaser that should be disposed to release the lock. - /// Thrown when is canceled or the expires before semaphore access is granted. - /// Thrown when this semaphore is disposed before semaphore access is granted. - public Task EnterAsync(int timeout, CancellationToken cancellationToken = default) => this.EnterAsync(TimeSpan.FromMilliseconds(timeout), cancellationToken); - - /// - /// Faults all pending semaphore waiters with - /// and rejects all subsequent attempts to enter the semaphore with the same exception. - /// - public void Dispose() + // We cleanup outside the lock because cleanup can block on the cancellation handler, + // and the handler can take the same lock as we held earlier in this method. + if (shouldCleanupInfo) { - this.Dispose(true); - GC.SuppressFinalize(this); + info.Cleanup(); } - /// - /// Disposes managed and unmanaged resources held by this instance. - /// - /// if was called; if the object is being finalized. - protected virtual void Dispose(bool disposing) + return info.Trigger.Task; + } + + /// + /// Requests access to the lock. + /// + /// A timeout for waiting for the lock (in milliseconds). + /// A token whose cancellation signals lost interest in the lock. + /// A task whose result is a releaser that should be disposed to release the lock. + /// Thrown when is canceled or the expires before semaphore access is granted. + /// Thrown when this semaphore is disposed before semaphore access is granted. + public Task EnterAsync(int timeout, CancellationToken cancellationToken = default) => this.EnterAsync(TimeSpan.FromMilliseconds(timeout), cancellationToken); + + /// + /// Faults all pending semaphore waiters with + /// and rejects all subsequent attempts to enter the semaphore with the same exception. + /// + public void Dispose() + { + this.Dispose(true); + GC.SuppressFinalize(this); + } + + /// + /// Disposes managed and unmanaged resources held by this instance. + /// + /// if was called; if the object is being finalized. + protected virtual void Dispose(bool disposing) + { + if (disposing) { - if (disposing) + List? waitersCopy = null; + lock (this.syncObject) { - List? waitersCopy = null; - lock (this.syncObject) - { - this.disposed = true; + this.disposed = true; - if (this.waiters.Count > 0) + if (this.waiters.Count > 0) + { + waitersCopy = new List(this.waiters.Count); + while (this.waiters.First is { } head) { - waitersCopy = new List(this.waiters.Count); - while (this.waiters.First is { } head) - { - head.Value.Trigger.TrySetException(new ObjectDisposedException(this.GetType().FullName)); - waitersCopy.Add(head.Value); - this.waiters.RemoveFirst(); - head.Value.Node = null; - } + head.Value.Trigger.TrySetException(new ObjectDisposedException(this.GetType().FullName)); + waitersCopy.Add(head.Value); + this.waiters.RemoveFirst(); + head.Value.Node = null; } - - this.nodePool.Clear(); } - if (waitersCopy is object) + this.nodePool.Clear(); + } + + if (waitersCopy is object) + { + foreach (WaiterInfo? waitInfo in waitersCopy) { - foreach (WaiterInfo? waitInfo in waitersCopy) - { - waitInfo.Cleanup(); - } + waitInfo.Cleanup(); } } } + } - private static void CancellationHandler(object? state) - { - var waiterInfo = (WaiterInfo)state!; + private static void CancellationHandler(object? state) + { + var waiterInfo = (WaiterInfo)state!; - // The party that manages to complete or cancel the task is responsible to remove it from the queue. - if (waiterInfo.Trigger.TrySetCanceled(waiterInfo.CancellationToken.IsCancellationRequested ? waiterInfo.CancellationToken : new CancellationToken(true))) + // The party that manages to complete or cancel the task is responsible to remove it from the queue. + if (waiterInfo.Trigger.TrySetCanceled(waiterInfo.CancellationToken.IsCancellationRequested ? waiterInfo.CancellationToken : new CancellationToken(true))) + { + // If the node is in the queue, remove it. + // It might not have been added yet if cancellation was already requested by the time we called Register. + lock (waiterInfo.Owner.syncObject) { - // If the node is in the queue, remove it. - // It might not have been added yet if cancellation was already requested by the time we called Register. - lock (waiterInfo.Owner.syncObject) + if (waiterInfo.Node is { } node) { - if (waiterInfo.Node is { } node) - { - waiterInfo.Owner.waiters.Remove(node); - waiterInfo.Owner.RecycleNode(node); - } + waiterInfo.Owner.waiters.Remove(node); + waiterInfo.Owner.RecycleNode(node); } } - - // Clear registration and references. - // We *may* be holding a lock on syncObject at this point iff this handler was executed inline with EnterAsync. - // In such a case, we haven't (yet) set WaiterInfo.CTR, so no deadlock risk exists in that case. - waiterInfo.Cleanup(); } - private void Release() + // Clear registration and references. + // We *may* be holding a lock on syncObject at this point iff this handler was executed inline with EnterAsync. + // In such a case, we haven't (yet) set WaiterInfo.CTR, so no deadlock risk exists in that case. + waiterInfo.Cleanup(); + } + + private void Release() + { + WaiterInfo? info = null; + lock (this.syncObject) { - WaiterInfo? info = null; - lock (this.syncObject) + if (this.CurrentCount++ == 0) { - if (this.CurrentCount++ == 0) + // We loop because the First node may have been canceled. + while (this.waiters.First is { } head) { - // We loop because the First node may have been canceled. - while (this.waiters.First is { } head) - { - // Remove the head of the queue. - this.waiters.RemoveFirst(); - info = head.Value; - this.RecycleNode(head); + // Remove the head of the queue. + this.waiters.RemoveFirst(); + info = head.Value; + this.RecycleNode(head); - if (info.Trigger.TrySetResult(new Releaser(this))) - { - // We successfully let someone enter the semaphore. - this.CurrentCount--; + if (info.Trigger.TrySetResult(new Releaser(this))) + { + // We successfully let someone enter the semaphore. + this.CurrentCount--; - // We've filled the one slot available in the semaphore. Stop looking for more. - break; - } + // We've filled the one slot available in the semaphore. Stop looking for more. + break; } } } - - // Release memory related to cancellation handling. - info?.Cleanup(); } - private void RecycleNode(LinkedListNode node) + // Release memory related to cancellation handling. + info?.Cleanup(); + } + + private void RecycleNode(LinkedListNode node) + { + Assumes.True(Monitor.IsEntered(this.syncObject)); + node.Value.Node = null; + if (this.nodePool.Count < 10) { - Assumes.True(Monitor.IsEntered(this.syncObject)); - node.Value.Node = null; - if (this.nodePool.Count < 10) - { - LinkedListNode nullableNode = node!; - nullableNode.Value = null; - this.nodePool.Push(nullableNode); - } + LinkedListNode nullableNode = node!; + nullableNode.Value = null; + this.nodePool.Push(nullableNode); } + } - private LinkedListNode GetNode(WaiterInfo info) + private LinkedListNode GetNode(WaiterInfo info) + { + Assumes.True(Monitor.IsEntered(this.syncObject)); + if (this.nodePool.Count > 0) { - Assumes.True(Monitor.IsEntered(this.syncObject)); - if (this.nodePool.Count > 0) - { - LinkedListNode? node = this.nodePool.Pop(); - node.Value = info; - return node!; - } - - return new LinkedListNode(info); + LinkedListNode? node = this.nodePool.Pop(); + node.Value = info; + return node!; } + return new LinkedListNode(info); + } + + /// + /// A value whose disposal triggers the release of a lock. + /// + public readonly struct Releaser : IDisposable + { /// - /// A value whose disposal triggers the release of a lock. + /// The lock instance to release. /// - public readonly struct Releaser : IDisposable + private readonly AsyncSemaphore? toRelease; + + /// + /// Initializes a new instance of the struct. + /// + /// The lock instance to release on. + internal Releaser(AsyncSemaphore toRelease) { - /// - /// The lock instance to release. - /// - private readonly AsyncSemaphore? toRelease; - - /// - /// Initializes a new instance of the struct. - /// - /// The lock instance to release on. - internal Releaser(AsyncSemaphore toRelease) - { - this.toRelease = toRelease; - } + this.toRelease = toRelease; + } - /// - /// Releases the lock. - /// - public void Dispose() + /// + /// Releases the lock. + /// + public void Dispose() + { + if (this.toRelease is object) { - if (this.toRelease is object) - { - this.toRelease.Release(); - } + this.toRelease.Release(); } } + } - private class WaiterInfo + private class WaiterInfo + { + internal WaiterInfo(AsyncSemaphore owner, CancellationToken cancellationToken) { - internal WaiterInfo(AsyncSemaphore owner, CancellationToken cancellationToken) - { - this.Owner = owner; - this.CancellationToken = cancellationToken; - } + this.Owner = owner; + this.CancellationToken = cancellationToken; + } - internal LinkedListNode? Node { get; set; } + internal LinkedListNode? Node { get; set; } - internal AsyncSemaphore Owner { get; } + internal AsyncSemaphore Owner { get; } - internal TaskCompletionSource Trigger { get; } = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + internal TaskCompletionSource Trigger { get; } = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); - internal CancellationToken CancellationToken { get; } + internal CancellationToken CancellationToken { get; } - internal CancellationTokenRegistration CancellationTokenRegistration { private get; set; } + internal CancellationTokenRegistration CancellationTokenRegistration { private get; set; } - internal IDisposable? TimerTokenSource { private get; set; } + internal IDisposable? TimerTokenSource { private get; set; } - /// - /// Disposes of and any applicable timer. - /// - /// - /// Callers should avoid calling this method while holding the lock - /// since can block on completion of - /// which requires that same lock. - /// - internal void Cleanup() + /// + /// Disposes of and any applicable timer. + /// + /// + /// Callers should avoid calling this method while holding the lock + /// since can block on completion of + /// which requires that same lock. + /// + internal void Cleanup() + { + CancellationTokenRegistration cancellationTokenRegistration; + IDisposable? timerTokenSource; + lock (this) { - CancellationTokenRegistration cancellationTokenRegistration; - IDisposable? timerTokenSource; - lock (this) - { - cancellationTokenRegistration = this.CancellationTokenRegistration; - this.CancellationTokenRegistration = default; - - timerTokenSource = this.TimerTokenSource; - this.TimerTokenSource = null; - } + cancellationTokenRegistration = this.CancellationTokenRegistration; + this.CancellationTokenRegistration = default; - cancellationTokenRegistration.Dispose(); - timerTokenSource?.Dispose(); + timerTokenSource = this.TimerTokenSource; + this.TimerTokenSource = null; } + + cancellationTokenRegistration.Dispose(); + timerTokenSource?.Dispose(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs index ae7df0916..f1fd44ed8 100644 --- a/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/AwaitExtensions.cs @@ -16,984 +16,983 @@ using Microsoft.Win32; using Microsoft.Win32.SafeHandles; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Extension methods and awaitables for .NET 4.5. +/// +public static partial class AwaitExtensions { /// - /// Extension methods and awaitables for .NET 4.5. + /// Gets an awaiter that schedules continuations on the specified scheduler. /// - public static partial class AwaitExtensions + /// The task scheduler used to execute continuations. + /// An awaitable. + public static TaskSchedulerAwaiter GetAwaiter(this TaskScheduler scheduler) { - /// - /// Gets an awaiter that schedules continuations on the specified scheduler. - /// - /// The task scheduler used to execute continuations. - /// An awaitable. - public static TaskSchedulerAwaiter GetAwaiter(this TaskScheduler scheduler) + Requires.NotNull(scheduler, nameof(scheduler)); + return new TaskSchedulerAwaiter(scheduler); + } + + /// + /// Gets an awaiter that schedules continuations on the specified . + /// + /// The synchronization context used to execute continuations. + /// An awaitable. + /// + /// The awaiter that is returned will always result in yielding, even if already executing within the specified . + /// + public static SynchronizationContextAwaiter GetAwaiter(this SynchronizationContext synchronizationContext) + { + Requires.NotNull(synchronizationContext, nameof(synchronizationContext)); + return new SynchronizationContextAwaiter(synchronizationContext); + } + + /// + /// Gets an awaitable that schedules continuations on the specified scheduler. + /// + /// The task scheduler used to execute continuations. + /// A value indicating whether the caller should yield even if + /// already executing on the desired task scheduler. + /// An awaitable. + public static TaskSchedulerAwaitable SwitchTo(this TaskScheduler scheduler, bool alwaysYield = false) + { + Requires.NotNull(scheduler, nameof(scheduler)); + return new TaskSchedulerAwaitable(scheduler, alwaysYield); + } + + /// + /// Provides await functionality for ordinary s. + /// + /// The handle to wait on. + /// The awaiter. + public static TaskAwaiter GetAwaiter(this WaitHandle handle) + { + Requires.NotNull(handle, nameof(handle)); + Task task = handle.ToTask(); + return task.GetAwaiter(); + } + + /// + /// Returns a task that completes when the process exits and provides the exit code of that process. + /// + /// The process to wait for exit. + /// + /// A token whose cancellation will cause the returned Task to complete + /// before the process exits in a faulted state with an . + /// This token has no effect on the itself. + /// + /// A task whose result is the of the . + public static async Task WaitForExitAsync(this Process process, CancellationToken cancellationToken = default(CancellationToken)) + { + Requires.NotNull(process, nameof(process)); + + var tcs = new TaskCompletionSource(); + EventHandler exitHandler = (s, e) => { - Requires.NotNull(scheduler, nameof(scheduler)); - return new TaskSchedulerAwaiter(scheduler); - } + tcs.TrySetResult(process.ExitCode); + }; + try + { + process.EnableRaisingEvents = true; + process.Exited += exitHandler; + if (process.HasExited) + { + // Allow for the race condition that the process has already exited. + tcs.TrySetResult(process.ExitCode); + } - /// - /// Gets an awaiter that schedules continuations on the specified . - /// - /// The synchronization context used to execute continuations. - /// An awaitable. - /// - /// The awaiter that is returned will always result in yielding, even if already executing within the specified . - /// - public static SynchronizationContextAwaiter GetAwaiter(this SynchronizationContext synchronizationContext) + using (cancellationToken.Register(() => tcs.TrySetCanceled(cancellationToken))) + { + return await tcs.Task.ConfigureAwait(false); + } + } + finally { - Requires.NotNull(synchronizationContext, nameof(synchronizationContext)); - return new SynchronizationContextAwaiter(synchronizationContext); + process.Exited -= exitHandler; } + } - /// - /// Gets an awaitable that schedules continuations on the specified scheduler. - /// - /// The task scheduler used to execute continuations. - /// A value indicating whether the caller should yield even if - /// already executing on the desired task scheduler. - /// An awaitable. - public static TaskSchedulerAwaitable SwitchTo(this TaskScheduler scheduler, bool alwaysYield = false) + /// + /// Returns a Task that completes when the specified registry key changes. + /// + /// The registry key to watch for changes. + /// to watch the keys descendent keys as well; to watch only this key without descendents. + /// Indicates the kinds of changes to watch for. + /// A token that may be canceled to release the resources from watching for changes and complete the returned Task as canceled. + /// + /// A task that completes when the registry key changes, the handle is closed, or upon cancellation. + /// + public static Task WaitForChangeAsync(this RegistryKey registryKey, bool watchSubtree = true, RegistryChangeNotificationFilters change = RegistryChangeNotificationFilters.Value | RegistryChangeNotificationFilters.Subkey, CancellationToken cancellationToken = default(CancellationToken)) + { + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { - Requires.NotNull(scheduler, nameof(scheduler)); - return new TaskSchedulerAwaitable(scheduler, alwaysYield); + throw new PlatformNotSupportedException(); } - /// - /// Provides await functionality for ordinary s. - /// - /// The handle to wait on. - /// The awaiter. - public static TaskAwaiter GetAwaiter(this WaitHandle handle) + Requires.NotNull(registryKey, nameof(registryKey)); + + return WaitForRegistryChangeAsync(registryKey.Handle, watchSubtree, change, cancellationToken); + } + + /// + /// Converts a to a . + /// + /// The result of . + /// A value indicating whether the continuation should run on the captured , if any. + /// An awaitable. + public static ConfiguredTaskYieldAwaitable ConfigureAwait(this YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) + { + return new ConfiguredTaskYieldAwaitable(continueOnCapturedContext); + } + + /// + /// Gets an awaitable that schedules the continuation with a preference to executing synchronously on the callstack that completed the , + /// without regard to thread ID or any that may be applied when the continuation is scheduled or when the antecedent completes. + /// + /// The task to await on. + /// An awaitable. + /// + /// If there is not enough stack space remaining on the thread that is completing the , + /// the continuation may be scheduled on the threadpool. + /// + public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInline(this Task antecedent) + { + Requires.NotNull(antecedent, nameof(antecedent)); + + return new ExecuteContinuationSynchronouslyAwaitable(antecedent); + } + + /// + /// Gets an awaitable that schedules the continuation with a preference to executing synchronously on the callstack that completed the , + /// without regard to thread ID or any that may be applied when the continuation is scheduled or when the antecedent completes. + /// + /// The type of value returned by the awaited . + /// The task to await on. + /// An awaitable. + /// + /// If there is not enough stack space remaining on the thread that is completing the , + /// the continuation may be scheduled on the threadpool. + /// + public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInline(this Task antecedent) + { + Requires.NotNull(antecedent, nameof(antecedent)); + + return new ExecuteContinuationSynchronouslyAwaitable(antecedent); + } + + /// + /// Returns an awaitable that will throw from the property of the task if it faults. + /// + /// The task to track for completion. + /// + /// An awaitable that may throw . + /// + /// Awaiting a with its default only throws the first exception within . + /// When you do not want to lose the detail of other inner exceptions, use this extension method. + /// + /// Thrown when faults. + public static AggregateExceptionAwaitable ConfigureAwaitForAggregateException(this Task task, bool continueOnCapturedContext = true) => new AggregateExceptionAwaitable(task, continueOnCapturedContext); + + /// + /// Returns a Task that completes when the specified registry key changes. + /// + /// The handle to the open registry key to watch for changes. + /// to watch the keys descendent keys as well; to watch only this key without descendents. + /// Indicates the kinds of changes to watch for. + /// A token that may be canceled to release the resources from watching for changes and complete the returned Task as canceled. + /// + /// A task that completes when the registry key changes, the handle is closed, or upon cancellation. + /// + private static async Task WaitForRegistryChangeAsync(SafeRegistryHandle registryKeyHandle, bool watchSubtree, RegistryChangeNotificationFilters change, CancellationToken cancellationToken) + { +#if NET5_0_OR_GREATER + if (!OperatingSystem.IsWindowsVersionAtLeast(7)) +#else + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) +#endif { - Requires.NotNull(handle, nameof(handle)); - Task task = handle.ToTask(); - return task.GetAwaiter(); + throw new PlatformNotSupportedException(); } - /// - /// Returns a task that completes when the process exits and provides the exit code of that process. - /// - /// The process to wait for exit. - /// - /// A token whose cancellation will cause the returned Task to complete - /// before the process exits in a faulted state with an . - /// This token has no effect on the itself. - /// - /// A task whose result is the of the . - public static async Task WaitForExitAsync(this Process process, CancellationToken cancellationToken = default(CancellationToken)) + IDisposable? dedicatedThreadReleaser = null; + try { - Requires.NotNull(process, nameof(process)); - - var tcs = new TaskCompletionSource(); - EventHandler exitHandler = (s, e) => - { - tcs.TrySetResult(process.ExitCode); - }; - try - { - process.EnableRaisingEvents = true; - process.Exited += exitHandler; - if (process.HasExited) + using ManualResetEvent evt = new(false); + REG_NOTIFY_FILTER dwNotifyFilter = (REG_NOTIFY_FILTER)change; + + static void DoNotify(SafeRegistryHandle registryKeyHandle, bool watchSubtree, REG_NOTIFY_FILTER change, WaitHandle evt) + { + WIN32_ERROR win32Error = PInvoke.RegNotifyChangeKeyValue( + registryKeyHandle, + watchSubtree, + change, + evt.SafeWaitHandle, + true); + if (win32Error != 0) { - // Allow for the race condition that the process has already exited. - tcs.TrySetResult(process.ExitCode); - } - - using (cancellationToken.Register(() => tcs.TrySetCanceled(cancellationToken))) - { - return await tcs.Task.ConfigureAwait(false); + throw new Win32Exception((int)win32Error); } } - finally + + if (LightUps.IsWindows8OrLater) { - process.Exited -= exitHandler; + dwNotifyFilter |= REG_NOTIFY_FILTER.REG_NOTIFY_THREAD_AGNOSTIC; + DoNotify(registryKeyHandle, watchSubtree, dwNotifyFilter, evt); } - } - - /// - /// Returns a Task that completes when the specified registry key changes. - /// - /// The registry key to watch for changes. - /// to watch the keys descendent keys as well; to watch only this key without descendents. - /// Indicates the kinds of changes to watch for. - /// A token that may be canceled to release the resources from watching for changes and complete the returned Task as canceled. - /// - /// A task that completes when the registry key changes, the handle is closed, or upon cancellation. - /// - public static Task WaitForChangeAsync(this RegistryKey registryKey, bool watchSubtree = true, RegistryChangeNotificationFilters change = RegistryChangeNotificationFilters.Value | RegistryChangeNotificationFilters.Subkey, CancellationToken cancellationToken = default(CancellationToken)) - { - if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + else { - throw new PlatformNotSupportedException(); + // Engage our downlevel support by using a single, dedicated thread to guarantee + // that we request notification on a thread that will not be destroyed later. + // Although we *could* await this, we synchronously block because our caller expects + // subscription to have begun before we return: for the async part to simply be notification. + // This async method we're calling uses .ConfigureAwait(false) internally so this won't + // deadlock if we're called on a thread with a single-thread SynchronizationContext. + Action registerAction = () => DoNotify(registryKeyHandle, watchSubtree, dwNotifyFilter, evt); + dedicatedThreadReleaser = DownlevelRegistryWatcherSupport.ExecuteOnDedicatedThreadAsync(registerAction).GetAwaiter().GetResult(); } - Requires.NotNull(registryKey, nameof(registryKey)); - - return WaitForRegistryChangeAsync(registryKey.Handle, watchSubtree, change, cancellationToken); + await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); } - - /// - /// Converts a to a . - /// - /// The result of . - /// A value indicating whether the continuation should run on the captured , if any. - /// An awaitable. - public static ConfiguredTaskYieldAwaitable ConfigureAwait(this YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) + finally { - return new ConfiguredTaskYieldAwaitable(continueOnCapturedContext); + dedicatedThreadReleaser?.Dispose(); } + } + + /// + /// The result of to prepare a to be awaited while throwing with all inner exceptions. + /// + public readonly struct AggregateExceptionAwaitable + { + private readonly Task task; + private readonly bool continueOnCapturedContext; /// - /// Gets an awaitable that schedules the continuation with a preference to executing synchronously on the callstack that completed the , - /// without regard to thread ID or any that may be applied when the continuation is scheduled or when the antecedent completes. + /// Initializes a new instance of the struct. /// - /// The task to await on. - /// An awaitable. - /// - /// If there is not enough stack space remaining on the thread that is completing the , - /// the continuation may be scheduled on the threadpool. - /// - public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInline(this Task antecedent) + public AggregateExceptionAwaitable(Task task, bool continueOnCapturedContext) { - Requires.NotNull(antecedent, nameof(antecedent)); - - return new ExecuteContinuationSynchronouslyAwaitable(antecedent); + this.task = task; + this.continueOnCapturedContext = continueOnCapturedContext; } /// - /// Gets an awaitable that schedules the continuation with a preference to executing synchronously on the callstack that completed the , - /// without regard to thread ID or any that may be applied when the continuation is scheduled or when the antecedent completes. + /// Gets an awaitable that schedules continuations on the specified scheduler. /// - /// The type of value returned by the awaited . - /// The task to await on. - /// An awaitable. - /// - /// If there is not enough stack space remaining on the thread that is completing the , - /// the continuation may be scheduled on the threadpool. - /// - public static ExecuteContinuationSynchronouslyAwaitable ConfigureAwaitRunInline(this Task antecedent) + public AggregateExceptionAwaiter GetAwaiter() { - Requires.NotNull(antecedent, nameof(antecedent)); - - return new ExecuteContinuationSynchronouslyAwaitable(antecedent); + return new AggregateExceptionAwaiter(this.task, this.continueOnCapturedContext); } + } - /// - /// Returns an awaitable that will throw from the property of the task if it faults. - /// - /// The task to track for completion. - /// - /// An awaitable that may throw . - /// - /// Awaiting a with its default only throws the first exception within . - /// When you do not want to lose the detail of other inner exceptions, use this extension method. - /// - /// Thrown when faults. - public static AggregateExceptionAwaitable ConfigureAwaitForAggregateException(this Task task, bool continueOnCapturedContext = true) => new AggregateExceptionAwaitable(task, continueOnCapturedContext); + /// + /// The result of to prepare a to be awaited while throwing with all inner exceptions. + /// + public readonly struct AggregateExceptionAwaiter : ICriticalNotifyCompletion + { + private readonly Task task; + private readonly bool continueOnCapturedContext; /// - /// Returns a Task that completes when the specified registry key changes. + /// Initializes a new instance of the struct. /// - /// The handle to the open registry key to watch for changes. - /// to watch the keys descendent keys as well; to watch only this key without descendents. - /// Indicates the kinds of changes to watch for. - /// A token that may be canceled to release the resources from watching for changes and complete the returned Task as canceled. - /// - /// A task that completes when the registry key changes, the handle is closed, or upon cancellation. - /// - private static async Task WaitForRegistryChangeAsync(SafeRegistryHandle registryKeyHandle, bool watchSubtree, RegistryChangeNotificationFilters change, CancellationToken cancellationToken) + public AggregateExceptionAwaiter(Task task, bool continueOnCapturedContext) { -#if NET5_0_OR_GREATER - if (!OperatingSystem.IsWindowsVersionAtLeast(7)) -#else - if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) -#endif - { - throw new PlatformNotSupportedException(); - } + this.task = task; + this.continueOnCapturedContext = continueOnCapturedContext; + } - IDisposable? dedicatedThreadReleaser = null; - try - { - using ManualResetEvent evt = new(false); - REG_NOTIFY_FILTER dwNotifyFilter = (REG_NOTIFY_FILTER)change; + /// + public bool IsCompleted => this.Awaiter.IsCompleted; - static void DoNotify(SafeRegistryHandle registryKeyHandle, bool watchSubtree, REG_NOTIFY_FILTER change, WaitHandle evt) - { - WIN32_ERROR win32Error = PInvoke.RegNotifyChangeKeyValue( - registryKeyHandle, - watchSubtree, - change, - evt.SafeWaitHandle, - true); - if (win32Error != 0) - { - throw new Win32Exception((int)win32Error); - } - } + private ConfiguredTaskAwaitable.ConfiguredTaskAwaiter Awaiter => this.task.ConfigureAwait(this.continueOnCapturedContext).GetAwaiter(); - if (LightUps.IsWindows8OrLater) - { - dwNotifyFilter |= REG_NOTIFY_FILTER.REG_NOTIFY_THREAD_AGNOSTIC; - DoNotify(registryKeyHandle, watchSubtree, dwNotifyFilter, evt); - } - else - { - // Engage our downlevel support by using a single, dedicated thread to guarantee - // that we request notification on a thread that will not be destroyed later. - // Although we *could* await this, we synchronously block because our caller expects - // subscription to have begun before we return: for the async part to simply be notification. - // This async method we're calling uses .ConfigureAwait(false) internally so this won't - // deadlock if we're called on a thread with a single-thread SynchronizationContext. - Action registerAction = () => DoNotify(registryKeyHandle, watchSubtree, dwNotifyFilter, evt); - dedicatedThreadReleaser = DownlevelRegistryWatcherSupport.ExecuteOnDedicatedThreadAsync(registerAction).GetAwaiter().GetResult(); - } + /// + public void OnCompleted(Action continuation) => this.Awaiter.OnCompleted(continuation); - await evt.ToTask(cancellationToken: cancellationToken).ConfigureAwait(false); - } - finally + /// + public void UnsafeOnCompleted(Action continuation) => this.Awaiter.UnsafeOnCompleted(continuation); + + /// + /// Thrown if the task was canceled. + /// Thrown if the task faulted. + public void GetResult() + { + if (this.task.Status == TaskStatus.Faulted && this.task.Exception is object) { - dedicatedThreadReleaser?.Dispose(); + ExceptionDispatchInfo.Capture(this.task.Exception).Throw(); } + + this.Awaiter.GetResult(); } + } + /// + /// An awaitable that executes continuations on the specified task scheduler. + /// + public readonly struct TaskSchedulerAwaitable + { /// - /// The result of to prepare a to be awaited while throwing with all inner exceptions. + /// The scheduler for continuations. /// - public readonly struct AggregateExceptionAwaitable - { - private readonly Task task; - private readonly bool continueOnCapturedContext; - - /// - /// Initializes a new instance of the struct. - /// - public AggregateExceptionAwaitable(Task task, bool continueOnCapturedContext) - { - this.task = task; - this.continueOnCapturedContext = continueOnCapturedContext; - } + private readonly TaskScheduler taskScheduler; - /// - /// Gets an awaitable that schedules continuations on the specified scheduler. - /// - public AggregateExceptionAwaiter GetAwaiter() - { - return new AggregateExceptionAwaiter(this.task, this.continueOnCapturedContext); - } - } + /// + /// A value indicating whether the awaitable will always call the caller to yield. + /// + private readonly bool alwaysYield; /// - /// The result of to prepare a to be awaited while throwing with all inner exceptions. + /// Initializes a new instance of the struct. /// - public readonly struct AggregateExceptionAwaiter : ICriticalNotifyCompletion + /// The task scheduler used to execute continuations. + /// A value indicating whether the caller should yield even if + /// already executing on the desired task scheduler. + public TaskSchedulerAwaitable(TaskScheduler taskScheduler, bool alwaysYield = false) { - private readonly Task task; - private readonly bool continueOnCapturedContext; + Requires.NotNull(taskScheduler, nameof(taskScheduler)); - /// - /// Initializes a new instance of the struct. - /// - public AggregateExceptionAwaiter(Task task, bool continueOnCapturedContext) - { - this.task = task; - this.continueOnCapturedContext = continueOnCapturedContext; - } + this.taskScheduler = taskScheduler; + this.alwaysYield = alwaysYield; + } - /// - public bool IsCompleted => this.Awaiter.IsCompleted; + /// + /// Gets an awaitable that schedules continuations on the specified scheduler. + /// + public TaskSchedulerAwaiter GetAwaiter() + { + return new TaskSchedulerAwaiter(this.taskScheduler, this.alwaysYield); + } + } - private ConfiguredTaskAwaitable.ConfiguredTaskAwaiter Awaiter => this.task.ConfigureAwait(this.continueOnCapturedContext).GetAwaiter(); + /// + /// An awaiter returned from . + /// + public readonly struct TaskSchedulerAwaiter : ICriticalNotifyCompletion + { + /// + /// The scheduler for continuations. + /// + private readonly TaskScheduler scheduler; - /// - public void OnCompleted(Action continuation) => this.Awaiter.OnCompleted(continuation); + /// + /// A value indicating whether + /// should always return false. + /// + private readonly bool alwaysYield; - /// - public void UnsafeOnCompleted(Action continuation) => this.Awaiter.UnsafeOnCompleted(continuation); + /// + /// Initializes a new instance of the struct. + /// + /// The scheduler for continuations. + /// A value indicating whether the caller should yield even if + /// already executing on the desired task scheduler. + public TaskSchedulerAwaiter(TaskScheduler scheduler, bool alwaysYield = false) + { + this.scheduler = scheduler; + this.alwaysYield = alwaysYield; + } - /// - /// Thrown if the task was canceled. - /// Thrown if the task faulted. - public void GetResult() + /// + /// Gets a value indicating whether no yield is necessary. + /// + /// if the caller is already running on that TaskScheduler. + public bool IsCompleted + { + get { - if (this.task.Status == TaskStatus.Faulted && this.task.Exception is object) + if (this.alwaysYield) { - ExceptionDispatchInfo.Capture(this.task.Exception).Throw(); + return false; } - this.Awaiter.GetResult(); + // We special case the TaskScheduler.Default since that is semantically equivalent to being + // on a ThreadPool thread, and there are various ways to get on those threads. + // TaskScheduler.Current is never null. Even if no scheduler is really active and the current + // thread is not a threadpool thread, TaskScheduler.Current == TaskScheduler.Default, so we have + // to protect against that case too. + bool isThreadPoolThread = Thread.CurrentThread.IsThreadPoolThread; + return (this.scheduler == TaskScheduler.Default && isThreadPoolThread) + || (this.scheduler == TaskScheduler.Current && TaskScheduler.Current != TaskScheduler.Default); } } /// - /// An awaitable that executes continuations on the specified task scheduler. + /// Schedules a continuation to execute using the specified task scheduler. /// - public readonly struct TaskSchedulerAwaitable + /// The delegate to invoke. + public void OnCompleted(Action continuation) { - /// - /// The scheduler for continuations. - /// - private readonly TaskScheduler taskScheduler; - - /// - /// A value indicating whether the awaitable will always call the caller to yield. - /// - private readonly bool alwaysYield; - - /// - /// Initializes a new instance of the struct. - /// - /// The task scheduler used to execute continuations. - /// A value indicating whether the caller should yield even if - /// already executing on the desired task scheduler. - public TaskSchedulerAwaitable(TaskScheduler taskScheduler, bool alwaysYield = false) + if (this.scheduler == TaskScheduler.Default) { - Requires.NotNull(taskScheduler, nameof(taskScheduler)); - - this.taskScheduler = taskScheduler; - this.alwaysYield = alwaysYield; + ThreadPool.QueueUserWorkItem(state => ((Action)state!)(), continuation); } - - /// - /// Gets an awaitable that schedules continuations on the specified scheduler. - /// - public TaskSchedulerAwaiter GetAwaiter() + else { - return new TaskSchedulerAwaiter(this.taskScheduler, this.alwaysYield); + Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.None, this.scheduler); } } /// - /// An awaiter returned from . + /// Schedules a continuation to execute using the specified task scheduler + /// without capturing the ExecutionContext. /// - public readonly struct TaskSchedulerAwaiter : ICriticalNotifyCompletion + /// The action. + public void UnsafeOnCompleted(Action continuation) { - /// - /// The scheduler for continuations. - /// - private readonly TaskScheduler scheduler; - - /// - /// A value indicating whether - /// should always return false. - /// - private readonly bool alwaysYield; - - /// - /// Initializes a new instance of the struct. - /// - /// The scheduler for continuations. - /// A value indicating whether the caller should yield even if - /// already executing on the desired task scheduler. - public TaskSchedulerAwaiter(TaskScheduler scheduler, bool alwaysYield = false) - { - this.scheduler = scheduler; - this.alwaysYield = alwaysYield; - } - - /// - /// Gets a value indicating whether no yield is necessary. - /// - /// if the caller is already running on that TaskScheduler. - public bool IsCompleted + if (this.scheduler == TaskScheduler.Default) { - get - { - if (this.alwaysYield) - { - return false; - } - - // We special case the TaskScheduler.Default since that is semantically equivalent to being - // on a ThreadPool thread, and there are various ways to get on those threads. - // TaskScheduler.Current is never null. Even if no scheduler is really active and the current - // thread is not a threadpool thread, TaskScheduler.Current == TaskScheduler.Default, so we have - // to protect against that case too. - bool isThreadPoolThread = Thread.CurrentThread.IsThreadPoolThread; - return (this.scheduler == TaskScheduler.Default && isThreadPoolThread) - || (this.scheduler == TaskScheduler.Current && TaskScheduler.Current != TaskScheduler.Default); - } + ThreadPool.UnsafeQueueUserWorkItem(state => ((Action)state!)(), continuation); } - - /// - /// Schedules a continuation to execute using the specified task scheduler. - /// - /// The delegate to invoke. - public void OnCompleted(Action continuation) + else { - if (this.scheduler == TaskScheduler.Default) - { - ThreadPool.QueueUserWorkItem(state => ((Action)state!)(), continuation); - } - else +#if NETFRAMEWORK // Only bother suppressing flow on .NET Framework where the perf would improve from doing so. + if (ExecutionContext.IsFlowSuppressed()) { Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.None, this.scheduler); } - } - - /// - /// Schedules a continuation to execute using the specified task scheduler - /// without capturing the ExecutionContext. - /// - /// The action. - public void UnsafeOnCompleted(Action continuation) - { - if (this.scheduler == TaskScheduler.Default) - { - ThreadPool.UnsafeQueueUserWorkItem(state => ((Action)state!)(), continuation); - } else { -#if NETFRAMEWORK // Only bother suppressing flow on .NET Framework where the perf would improve from doing so. - if (ExecutionContext.IsFlowSuppressed()) + using (ExecutionContext.SuppressFlow()) { Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.None, this.scheduler); } - else - { - using (ExecutionContext.SuppressFlow()) - { - Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.None, this.scheduler); - } - } + } #else - Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.None, this.scheduler); + Task.Factory.StartNew(continuation, CancellationToken.None, TaskCreationOptions.None, this.scheduler); #endif - } - } - - /// - /// Does nothing. - /// - public void GetResult() - { } } /// - /// An awaiter returned from . + /// Does nothing. /// - public readonly struct SynchronizationContextAwaiter : ICriticalNotifyCompletion + public void GetResult() { - private static readonly SendOrPostCallback SyncContextDelegate = s => ((Action)s!)(); - - /// - /// The context for continuations. - /// - private readonly SynchronizationContext syncContext; + } + } - /// - /// Initializes a new instance of the struct. - /// - /// The context for continuations. - public SynchronizationContextAwaiter(SynchronizationContext syncContext) - { - this.syncContext = syncContext; - } + /// + /// An awaiter returned from . + /// + public readonly struct SynchronizationContextAwaiter : ICriticalNotifyCompletion + { + private static readonly SendOrPostCallback SyncContextDelegate = s => ((Action)s!)(); - /// - /// Gets a value indicating whether no yield is necessary. - /// - /// Always returns . - public bool IsCompleted => false; + /// + /// The context for continuations. + /// + private readonly SynchronizationContext syncContext; - /// - /// Schedules a continuation to execute using the specified . - /// - /// The delegate to invoke. - public void OnCompleted(Action continuation) => this.syncContext.Post(SyncContextDelegate, continuation); + /// + /// Initializes a new instance of the struct. + /// + /// The context for continuations. + public SynchronizationContextAwaiter(SynchronizationContext syncContext) + { + this.syncContext = syncContext; + } - /// - /// Schedules a continuation to execute using the specified - /// without capturing the . - /// - /// The action. - public void UnsafeOnCompleted(Action continuation) - { + /// + /// Gets a value indicating whether no yield is necessary. + /// + /// Always returns . + public bool IsCompleted => false; + + /// + /// Schedules a continuation to execute using the specified . + /// + /// The delegate to invoke. + public void OnCompleted(Action continuation) => this.syncContext.Post(SyncContextDelegate, continuation); + + /// + /// Schedules a continuation to execute using the specified + /// without capturing the . + /// + /// The action. + public void UnsafeOnCompleted(Action continuation) + { #if NETFRAMEWORK // Only bother suppressing flow on .NET Framework where the perf would improve from doing so. - if (ExecutionContext.IsFlowSuppressed()) + if (ExecutionContext.IsFlowSuppressed()) + { + this.syncContext.Post(SyncContextDelegate, continuation); + } + else + { + using (ExecutionContext.SuppressFlow()) { this.syncContext.Post(SyncContextDelegate, continuation); } - else - { - using (ExecutionContext.SuppressFlow()) - { - this.syncContext.Post(SyncContextDelegate, continuation); - } - } + } #else - this.syncContext.Post(SyncContextDelegate, continuation); + this.syncContext.Post(SyncContextDelegate, continuation); #endif - } - - /// - /// Does nothing. - /// - public void GetResult() - { - } } /// - /// An awaitable that will always lead the calling async method to yield, - /// then immediately resume, possibly on the original . + /// Does nothing. /// - public readonly struct ConfiguredTaskYieldAwaitable + public void GetResult() { - /// - /// A value indicating whether the continuation should run on the captured , if any. - /// - private readonly bool continueOnCapturedContext; + } + } - /// - /// Initializes a new instance of the struct. - /// - /// A value indicating whether the continuation should run on the captured , if any. - public ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) - { - this.continueOnCapturedContext = continueOnCapturedContext; - } + /// + /// An awaitable that will always lead the calling async method to yield, + /// then immediately resume, possibly on the original . + /// + public readonly struct ConfiguredTaskYieldAwaitable + { + /// + /// A value indicating whether the continuation should run on the captured , if any. + /// + private readonly bool continueOnCapturedContext; - /// - /// Gets the awaiter. - /// - /// The awaiter. - public ConfiguredTaskYieldAwaiter GetAwaiter() => new ConfiguredTaskYieldAwaiter(this.continueOnCapturedContext); + /// + /// Initializes a new instance of the struct. + /// + /// A value indicating whether the continuation should run on the captured , if any. + public ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) + { + this.continueOnCapturedContext = continueOnCapturedContext; } /// - /// An awaiter that will always lead the calling async method to yield, - /// then immediately resume, possibly on the original . + /// Gets the awaiter. + /// + /// The awaiter. + public ConfiguredTaskYieldAwaiter GetAwaiter() => new ConfiguredTaskYieldAwaiter(this.continueOnCapturedContext); + } + + /// + /// An awaiter that will always lead the calling async method to yield, + /// then immediately resume, possibly on the original . + /// + public readonly struct ConfiguredTaskYieldAwaiter : ICriticalNotifyCompletion + { + /// + /// A value indicating whether the continuation should run on the captured , if any. + /// + private readonly bool continueOnCapturedContext; + + /// + /// Initializes a new instance of the struct. /// - public readonly struct ConfiguredTaskYieldAwaiter : ICriticalNotifyCompletion + /// A value indicating whether the continuation should run on the captured , if any. + public ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) { - /// - /// A value indicating whether the continuation should run on the captured , if any. - /// - private readonly bool continueOnCapturedContext; + this.continueOnCapturedContext = continueOnCapturedContext; + } - /// - /// Initializes a new instance of the struct. - /// - /// A value indicating whether the continuation should run on the captured , if any. - public ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) + /// + /// Gets a value indicating whether the caller should yield. + /// + /// Always false. + public bool IsCompleted => false; + + /// + /// Schedules a continuation to execute immediately (but not synchronously). + /// + /// The delegate to invoke. + public void OnCompleted(Action continuation) + { + if (this.continueOnCapturedContext) { - this.continueOnCapturedContext = continueOnCapturedContext; + Task.Yield().GetAwaiter().OnCompleted(continuation); } - - /// - /// Gets a value indicating whether the caller should yield. - /// - /// Always false. - public bool IsCompleted => false; - - /// - /// Schedules a continuation to execute immediately (but not synchronously). - /// - /// The delegate to invoke. - public void OnCompleted(Action continuation) + else { - if (this.continueOnCapturedContext) - { - Task.Yield().GetAwaiter().OnCompleted(continuation); - } - else - { - ThreadPool.QueueUserWorkItem(state => ((Action)state!)(), continuation); - } + ThreadPool.QueueUserWorkItem(state => ((Action)state!)(), continuation); } + } - /// - /// Schedules a delegate for execution at the conclusion of a task's execution - /// without capturing the ExecutionContext. - /// - /// The action. - public void UnsafeOnCompleted(Action continuation) + /// + /// Schedules a delegate for execution at the conclusion of a task's execution + /// without capturing the ExecutionContext. + /// + /// The action. + public void UnsafeOnCompleted(Action continuation) + { + if (this.continueOnCapturedContext) { - if (this.continueOnCapturedContext) - { - Task.Yield().GetAwaiter().UnsafeOnCompleted(continuation); - } - else - { - ThreadPool.UnsafeQueueUserWorkItem(state => ((Action)state!)(), continuation); - } + Task.Yield().GetAwaiter().UnsafeOnCompleted(continuation); } - - /// - /// Does nothing. - /// - public void GetResult() + else { + ThreadPool.UnsafeQueueUserWorkItem(state => ((Action)state!)(), continuation); } } /// - /// A Task awaitable that has affinity to executing callbacks synchronously on the completing callstack. + /// Does nothing. /// - public readonly struct ExecuteContinuationSynchronouslyAwaitable + public void GetResult() { - /// - /// The task whose completion will execute the continuation. - /// - private readonly Task antecedent; + } + } - /// - /// Initializes a new instance of the struct. - /// - /// The task whose completion will execute the continuation. - public ExecuteContinuationSynchronouslyAwaitable(Task antecedent) - { - Requires.NotNull(antecedent, nameof(antecedent)); - this.antecedent = antecedent; - } + /// + /// A Task awaitable that has affinity to executing callbacks synchronously on the completing callstack. + /// + public readonly struct ExecuteContinuationSynchronouslyAwaitable + { + /// + /// The task whose completion will execute the continuation. + /// + private readonly Task antecedent; - /// - /// Gets the awaiter. - /// - /// The awaiter. - public ExecuteContinuationSynchronouslyAwaiter GetAwaiter() => new ExecuteContinuationSynchronouslyAwaiter(this.antecedent); + /// + /// Initializes a new instance of the struct. + /// + /// The task whose completion will execute the continuation. + public ExecuteContinuationSynchronouslyAwaitable(Task antecedent) + { + Requires.NotNull(antecedent, nameof(antecedent)); + this.antecedent = antecedent; } /// - /// A Task awaiter that has affinity to executing callbacks synchronously on the completing callstack. + /// Gets the awaiter. /// - public readonly struct ExecuteContinuationSynchronouslyAwaiter : INotifyCompletion - { - /// - /// The task whose completion will execute the continuation. - /// - private readonly Task antecedent; + /// The awaiter. + public ExecuteContinuationSynchronouslyAwaiter GetAwaiter() => new ExecuteContinuationSynchronouslyAwaiter(this.antecedent); + } - /// - /// Initializes a new instance of the struct. - /// - /// The task whose completion will execute the continuation. - public ExecuteContinuationSynchronouslyAwaiter(Task antecedent) - { - Requires.NotNull(antecedent, nameof(antecedent)); - this.antecedent = antecedent; - } + /// + /// A Task awaiter that has affinity to executing callbacks synchronously on the completing callstack. + /// + public readonly struct ExecuteContinuationSynchronouslyAwaiter : INotifyCompletion + { + /// + /// The task whose completion will execute the continuation. + /// + private readonly Task antecedent; - /// - /// Gets a value indicating whether the antedent has already completed. - /// - public bool IsCompleted => this.antecedent.IsCompleted; + /// + /// Initializes a new instance of the struct. + /// + /// The task whose completion will execute the continuation. + public ExecuteContinuationSynchronouslyAwaiter(Task antecedent) + { + Requires.NotNull(antecedent, nameof(antecedent)); + this.antecedent = antecedent; + } - /// - /// Rethrows any exception thrown by the antecedent. - /// - public void GetResult() => this.antecedent.GetAwaiter().GetResult(); + /// + /// Gets a value indicating whether the antedent has already completed. + /// + public bool IsCompleted => this.antecedent.IsCompleted; - /// - /// Schedules a callback to run when the antecedent task completes. - /// - /// The callback to invoke. - public void OnCompleted(Action continuation) - { - Requires.NotNull(continuation, nameof(continuation)); - - this.antecedent.ContinueWith( - (_, s) => ((Action)s!)(), - continuation, - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } - } + /// + /// Rethrows any exception thrown by the antecedent. + /// + public void GetResult() => this.antecedent.GetAwaiter().GetResult(); /// - /// A Task awaitable that has affinity to executing callbacks synchronously on the completing callstack. + /// Schedules a callback to run when the antecedent task completes. /// - /// The type of value returned by the awaited . - public readonly struct ExecuteContinuationSynchronouslyAwaitable + /// The callback to invoke. + public void OnCompleted(Action continuation) { - /// - /// The task whose completion will execute the continuation. - /// - private readonly Task antecedent; + Requires.NotNull(continuation, nameof(continuation)); + + this.antecedent.ContinueWith( + (_, s) => ((Action)s!)(), + continuation, + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); + } + } - /// - /// Initializes a new instance of the struct. - /// - /// The task whose completion will execute the continuation. - public ExecuteContinuationSynchronouslyAwaitable(Task antecedent) - { - Requires.NotNull(antecedent, nameof(antecedent)); - this.antecedent = antecedent; - } + /// + /// A Task awaitable that has affinity to executing callbacks synchronously on the completing callstack. + /// + /// The type of value returned by the awaited . + public readonly struct ExecuteContinuationSynchronouslyAwaitable + { + /// + /// The task whose completion will execute the continuation. + /// + private readonly Task antecedent; - /// - /// Gets the awaiter. - /// - /// The awaiter. - public ExecuteContinuationSynchronouslyAwaiter GetAwaiter() => new ExecuteContinuationSynchronouslyAwaiter(this.antecedent); + /// + /// Initializes a new instance of the struct. + /// + /// The task whose completion will execute the continuation. + public ExecuteContinuationSynchronouslyAwaitable(Task antecedent) + { + Requires.NotNull(antecedent, nameof(antecedent)); + this.antecedent = antecedent; } /// - /// A Task awaiter that has affinity to executing callbacks synchronously on the completing callstack. + /// Gets the awaiter. /// - /// The type of value returned by the awaited . - public readonly struct ExecuteContinuationSynchronouslyAwaiter : INotifyCompletion - { - /// - /// The task whose completion will execute the continuation. - /// - private readonly Task antecedent; + /// The awaiter. + public ExecuteContinuationSynchronouslyAwaiter GetAwaiter() => new ExecuteContinuationSynchronouslyAwaiter(this.antecedent); + } - /// - /// Initializes a new instance of the struct. - /// - /// The task whose completion will execute the continuation. - public ExecuteContinuationSynchronouslyAwaiter(Task antecedent) - { - Requires.NotNull(antecedent, nameof(antecedent)); - this.antecedent = antecedent; - } + /// + /// A Task awaiter that has affinity to executing callbacks synchronously on the completing callstack. + /// + /// The type of value returned by the awaited . + public readonly struct ExecuteContinuationSynchronouslyAwaiter : INotifyCompletion + { + /// + /// The task whose completion will execute the continuation. + /// + private readonly Task antecedent; - /// - /// Gets a value indicating whether the antedent has already completed. - /// - public bool IsCompleted => this.antecedent.IsCompleted; + /// + /// Initializes a new instance of the struct. + /// + /// The task whose completion will execute the continuation. + public ExecuteContinuationSynchronouslyAwaiter(Task antecedent) + { + Requires.NotNull(antecedent, nameof(antecedent)); + this.antecedent = antecedent; + } - /// - /// Rethrows any exception thrown by the antecedent. - /// - public T GetResult() => this.antecedent.GetAwaiter().GetResult(); + /// + /// Gets a value indicating whether the antedent has already completed. + /// + public bool IsCompleted => this.antecedent.IsCompleted; - /// - /// Schedules a callback to run when the antecedent task completes. - /// - /// The callback to invoke. - public void OnCompleted(Action continuation) - { - Requires.NotNull(continuation, nameof(continuation)); - - this.antecedent.ContinueWith( - (_, s) => ((Action)s!)(), - continuation, - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } + /// + /// Rethrows any exception thrown by the antecedent. + /// + public T GetResult() => this.antecedent.GetAwaiter().GetResult(); + + /// + /// Schedules a callback to run when the antecedent task completes. + /// + /// The callback to invoke. + public void OnCompleted(Action continuation) + { + Requires.NotNull(continuation, nameof(continuation)); + + this.antecedent.ContinueWith( + (_, s) => ((Action)s!)(), + continuation, + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); } + } + /// + /// Provides a dedicated thread for requesting registry change notifications. + /// + /// + /// For versions of Windows prior to Windows 8, requesting registry change notifications + /// required that the thread that made the request remain alive or else the watcher would + /// simply signal the event and stop watching for changes. + /// This class provides a single, dedicated thread for requesting such notifications + /// so that they don't get canceled when a thread happens to exit. + /// The dedicated thread is released when no one is watching the registry any more. + /// + private static class DownlevelRegistryWatcherSupport + { /// - /// Provides a dedicated thread for requesting registry change notifications. + /// The size of the stack allocated for a thread that expects to stay within just a few methods in depth. /// /// - /// For versions of Windows prior to Windows 8, requesting registry change notifications - /// required that the thread that made the request remain alive or else the watcher would - /// simply signal the event and stop watching for changes. - /// This class provides a single, dedicated thread for requesting such notifications - /// so that they don't get canceled when a thread happens to exit. - /// The dedicated thread is released when no one is watching the registry any more. + /// The default stack size for a thread is 1MB. /// - private static class DownlevelRegistryWatcherSupport - { - /// - /// The size of the stack allocated for a thread that expects to stay within just a few methods in depth. - /// - /// - /// The default stack size for a thread is 1MB. - /// - private const int SmallThreadStackSize = 100 * 1024; + private const int SmallThreadStackSize = 100 * 1024; - /// - /// The object to lock when accessing any fields. - /// This is also the object that is waited on by the dedicated thread, - /// and may be pulsed by others to wake the dedicated thread to do some work. - /// - private static readonly object SyncObject = new object(); + /// + /// The object to lock when accessing any fields. + /// This is also the object that is waited on by the dedicated thread, + /// and may be pulsed by others to wake the dedicated thread to do some work. + /// + private static readonly object SyncObject = new object(); - /// - /// A queue of actions the dedicated thread should take. - /// - private static readonly Queue>> PendingWork = new(); + /// + /// A queue of actions the dedicated thread should take. + /// + private static readonly Queue>> PendingWork = new(); - /// - /// The number of callers that still have an interest in the survival of the dedicated thread. - /// The dedicated thread will exit when this value reaches 0. - /// - private static int keepAliveCount; + /// + /// The number of callers that still have an interest in the survival of the dedicated thread. + /// The dedicated thread will exit when this value reaches 0. + /// + private static int keepAliveCount; - /// - /// The thread that should stay alive and be dequeuing . - /// - private static Thread? liveThread; + /// + /// The thread that should stay alive and be dequeuing . + /// + private static Thread? liveThread; - /// - /// Executes some action on a long-lived thread. - /// - /// The delegate to execute. - /// - /// A task that either faults with the exception thrown by - /// or completes after successfully executing the delegate - /// with a result that should be disposed when it is safe to terminate the long-lived thread. - /// - /// - /// This thread never posts to , so it is safe - /// to call this method and synchronously block on its result. - /// - internal static async Task ExecuteOnDedicatedThreadAsync(Action action) - { - Requires.NotNull(action, nameof(action)); + /// + /// Executes some action on a long-lived thread. + /// + /// The delegate to execute. + /// + /// A task that either faults with the exception thrown by + /// or completes after successfully executing the delegate + /// with a result that should be disposed when it is safe to terminate the long-lived thread. + /// + /// + /// This thread never posts to , so it is safe + /// to call this method and synchronously block on its result. + /// + internal static async Task ExecuteOnDedicatedThreadAsync(Action action) + { + Requires.NotNull(action, nameof(action)); - var tcs = new TaskCompletionSource(); - bool keepAliveCountIncremented = false; - try + var tcs = new TaskCompletionSource(); + bool keepAliveCountIncremented = false; + try + { + lock (SyncObject) { - lock (SyncObject) + PendingWork.Enqueue(Tuple.Create(action, tcs)); + + try + { + // This block intentionally left blank. + } + finally { - PendingWork.Enqueue(Tuple.Create(action, tcs)); + // We make these two assignments within a finally block + // to guard against an untimely ThreadAbortException causing + // us to execute just one of them. + keepAliveCountIncremented = true; + ++keepAliveCount; + } - try - { - // This block intentionally left blank. - } - finally - { - // We make these two assignments within a finally block - // to guard against an untimely ThreadAbortException causing - // us to execute just one of them. - keepAliveCountIncremented = true; - ++keepAliveCount; - } - - if (keepAliveCount == 1) - { - Assumes.Null(liveThread); - liveThread = new Thread(Worker, SmallThreadStackSize) - { - IsBackground = true, - Name = "Registry watcher", - }; - liveThread.Start(); - } - else + if (keepAliveCount == 1) + { + Assumes.Null(liveThread); + liveThread = new Thread(Worker, SmallThreadStackSize) { - // There *could* temporarily be multiple threads in some race conditions. - // Pulse all of them so that the live one is sure to get the message. - Monitor.PulseAll(SyncObject); - } + IsBackground = true, + Name = "Registry watcher", + }; + liveThread.Start(); + } + else + { + // There *could* temporarily be multiple threads in some race conditions. + // Pulse all of them so that the live one is sure to get the message. + Monitor.PulseAll(SyncObject); } + } - await tcs.Task.ConfigureAwait(false); - return new ThreadHandleRelease(); + await tcs.Task.ConfigureAwait(false); + return new ThreadHandleRelease(); + } + catch + { + if (keepAliveCountIncremented) + { + // Our caller will never have a chance to release their claim on the dedicated thread, + // so do it for them. + ReleaseRefOnDedicatedThread(); } - catch + + throw; + } + } + + /// + /// Decrements the count of interested parties in the live thread, + /// and helps it to terminate if necessary. + /// + private static void ReleaseRefOnDedicatedThread() + { + lock (SyncObject) + { + if (--keepAliveCount == 0) { - if (keepAliveCountIncremented) - { - // Our caller will never have a chance to release their claim on the dedicated thread, - // so do it for them. - ReleaseRefOnDedicatedThread(); - } + liveThread = null; - throw; + // Wake up any obsolete thread(s) so they can go to exit. + Monitor.PulseAll(SyncObject); } } + } - /// - /// Decrements the count of interested parties in the live thread, - /// and helps it to terminate if necessary. - /// - private static void ReleaseRefOnDedicatedThread() + /// + /// Executes thread-affinitized work from a queue until both the queue is empty + /// and any lingering interest in the survival of the dedicated thread has been released. + /// + /// + /// This method serves as the for our dedicated thread. + /// + private static void Worker() + { + while (true) { + Tuple>? work = null; lock (SyncObject) { - if (--keepAliveCount == 0) + if (Thread.CurrentThread != liveThread) { - liveThread = null; + // Regardless of our PendingWork and keepAliveCount, + // it isn't meant for this thread any more. + // This happens when keepAliveCount (at least temporarily) + // hits 0, so this thread must be assumed to be on its exit path, + // and another thread will be spawned to process new requests. + Assumes.True(liveThread is object || (keepAliveCount == 0 && PendingWork.Count == 0)); + return; + } - // Wake up any obsolete thread(s) so they can go to exit. - Monitor.PulseAll(SyncObject); + if (PendingWork.Count > 0) + { + work = PendingWork.Dequeue(); + } + else if (keepAliveCount == 0) + { + // No work, and no reason to stay alive. Exit the thread. + return; + } + else + { + // Sleep until another thread wants to wake us up with a Pulse. + Monitor.Wait(SyncObject); } } - } - /// - /// Executes thread-affinitized work from a queue until both the queue is empty - /// and any lingering interest in the survival of the dedicated thread has been released. - /// - /// - /// This method serves as the for our dedicated thread. - /// - private static void Worker() - { - while (true) + if (work is object) { - Tuple>? work = null; - lock (SyncObject) + try { - if (Thread.CurrentThread != liveThread) - { - // Regardless of our PendingWork and keepAliveCount, - // it isn't meant for this thread any more. - // This happens when keepAliveCount (at least temporarily) - // hits 0, so this thread must be assumed to be on its exit path, - // and another thread will be spawned to process new requests. - Assumes.True(liveThread is object || (keepAliveCount == 0 && PendingWork.Count == 0)); - return; - } - - if (PendingWork.Count > 0) - { - work = PendingWork.Dequeue(); - } - else if (keepAliveCount == 0) - { - // No work, and no reason to stay alive. Exit the thread. - return; - } - else - { - // Sleep until another thread wants to wake us up with a Pulse. - Monitor.Wait(SyncObject); - } + work.Item1(); + work.Item2.SetResult(EmptyStruct.Instance); } - - if (work is object) + catch (Exception ex) { - try - { - work.Item1(); - work.Item2.SetResult(EmptyStruct.Instance); - } - catch (Exception ex) - { - work.Item2.SetException(ex); - } + work.Item2.SetException(ex); } } } + } + /// + /// Decrements the dedicated thread use counter by at most one upon disposal. + /// + private class ThreadHandleRelease : IDisposable + { /// - /// Decrements the dedicated thread use counter by at most one upon disposal. + /// A value indicating whether this instance has already been disposed. /// - private class ThreadHandleRelease : IDisposable + private bool disposed; + + /// + /// Release the keep alive count reserved by this instance. + /// + public void Dispose() { - /// - /// A value indicating whether this instance has already been disposed. - /// - private bool disposed; - - /// - /// Release the keep alive count reserved by this instance. - /// - public void Dispose() + lock (SyncObject) { - lock (SyncObject) + if (!this.disposed) { - if (!this.disposed) - { - this.disposed = true; - ReleaseRefOnDedicatedThread(); - } + this.disposed = true; + ReleaseRefOnDedicatedThread(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/Boxed.cs b/src/Microsoft.VisualStudio.Threading/Boxed.cs index 30f029a8e..954140d6f 100644 --- a/src/Microsoft.VisualStudio.Threading/Boxed.cs +++ b/src/Microsoft.VisualStudio.Threading/Boxed.cs @@ -1,26 +1,25 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +internal static class Boxed { - internal static class Boxed - { - /// - /// Returns an object containing . - /// - public static readonly object True = true; + /// + /// Returns an object containing . + /// + public static readonly object True = true; - /// - /// Returns an object containing . - /// - public static readonly object False = false; + /// + /// Returns an object containing . + /// + public static readonly object False = false; - /// - /// Returns an object containing specified value. - /// - public static object Box(bool value) - { - return value ? True : False; - } + /// + /// Returns an object containing specified value. + /// + public static object Box(bool value) + { + return value ? True : False; } } diff --git a/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs b/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs index cec11643a..150a136f7 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs @@ -7,367 +7,366 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Represents a possible shared computation task, which can be joined by multiple consumers with a cancellation token. +/// The overall computation is cancelled if all its consumers are cancelled. +/// +internal class CancellableJoinComputation { /// - /// Represents a possible shared computation task, which can be joined by multiple consumers with a cancellation token. - /// The overall computation is cancelled if all its consumers are cancelled. + /// The object to acquire a Monitor-style lock on for all field access on this instance. /// - internal class CancellableJoinComputation - { - /// - /// The object to acquire a Monitor-style lock on for all field access on this instance. - /// - private readonly object syncObject = new object(); + private readonly object syncObject = new object(); - /// - /// A list of task completion sources which represents joined waiting requests with cancellable cancellation tokens. - /// When an individule cancellation token is triggered, we may allow that specific waiting task to continue, and only all of them abandone the computation then we may - /// cancel the inner computation. - /// - private List? joinedWaitingList; + /// + /// A list of task completion sources which represents joined waiting requests with cancellable cancellation tokens. + /// When an individule cancellation token is triggered, we may allow that specific waiting task to continue, and only all of them abandone the computation then we may + /// cancel the inner computation. + /// + private List? joinedWaitingList; - /// - /// A combined cancellation token source to cancel the inner computation task. - /// - private CancellationTokenSource? combinedCancellationTokenSource; + /// + /// A combined cancellation token source to cancel the inner computation task. + /// + private CancellationTokenSource? combinedCancellationTokenSource; - /// - /// The number of waiting requests which are not cancelled. It is only meaningful when is true. - /// - private int outstandingWaitingCount; + /// + /// The number of waiting requests which are not cancelled. It is only meaningful when is true. + /// + private int outstandingWaitingCount; - /// - /// Whether the inner task can be cancelled. If one waiting request is not cancellable, the inner task cannot be cancelled. - /// - private bool isCancellationAllowed; + /// + /// Whether the inner task can be cancelled. If one waiting request is not cancellable, the inner task cannot be cancelled. + /// + private bool isCancellationAllowed; - /// - /// Whether the cancellation of the inner task is requested. A new waiting request will not be allowed, once it is true. - /// - private bool isCancellationRequested; + /// + /// Whether the cancellation of the inner task is requested. A new waiting request will not be allowed, once it is true. + /// + private bool isCancellationRequested; - /// - /// Initializes a new instance of the class. - /// - /// A callback to create the task. - /// Whether the inner task can be cancelled. - internal CancellableJoinComputation(Func taskFactory, bool allowCancelled) + /// + /// Initializes a new instance of the class. + /// + /// A callback to create the task. + /// Whether the inner task can be cancelled. + internal CancellableJoinComputation(Func taskFactory, bool allowCancelled) + { + Requires.NotNull(taskFactory, nameof(taskFactory)); + + if (allowCancelled) { - Requires.NotNull(taskFactory, nameof(taskFactory)); + this.isCancellationAllowed = true; + this.combinedCancellationTokenSource = new CancellationTokenSource(); + this.joinedWaitingList = new List(capacity: 2); + } - if (allowCancelled) - { - this.isCancellationAllowed = true; - this.combinedCancellationTokenSource = new CancellationTokenSource(); - this.joinedWaitingList = new List(capacity: 2); - } + this.InnerTask = taskFactory(this.combinedCancellationTokenSource?.Token ?? CancellationToken.None); - this.InnerTask = taskFactory(this.combinedCancellationTokenSource?.Token ?? CancellationToken.None); + if (allowCancelled) + { + // Note: this continuation is chained asynchronously to prevent being inlined when we trigger the combined cancellation token. + this.InnerTask.ContinueWith( + (t, s) => + { + var me = (CancellableJoinComputation)s!; - if (allowCancelled) - { - // Note: this continuation is chained asynchronously to prevent being inlined when we trigger the combined cancellation token. - this.InnerTask.ContinueWith( - (t, s) => + List allWaitingTasks; + CancellationTokenSource? combinedCancellationTokenSource; + lock (me.syncObject) { - var me = (CancellableJoinComputation)s!; + Assumes.NotNull(me.joinedWaitingList); - List allWaitingTasks; - CancellationTokenSource? combinedCancellationTokenSource; - lock (me.syncObject) - { - Assumes.NotNull(me.joinedWaitingList); - - allWaitingTasks = me.joinedWaitingList; - combinedCancellationTokenSource = me.combinedCancellationTokenSource; + allWaitingTasks = me.joinedWaitingList; + combinedCancellationTokenSource = me.combinedCancellationTokenSource; - me.joinedWaitingList = null; - me.combinedCancellationTokenSource = null; - } + me.joinedWaitingList = null; + me.combinedCancellationTokenSource = null; + } - combinedCancellationTokenSource?.Dispose(); + combinedCancellationTokenSource?.Dispose(); - if (t.IsCanceled) + if (t.IsCanceled) + { + for (int i = 0; i < allWaitingTasks.Count; i++) { - for (int i = 0; i < allWaitingTasks.Count; i++) + WaitingCancellationStatus status = allWaitingTasks[i]; + if (status.CancellationToken.IsCancellationRequested) { - WaitingCancellationStatus status = allWaitingTasks[i]; - if (status.CancellationToken.IsCancellationRequested) - { - status.TrySetCanceled(status.CancellationToken); - } - else - { - status.TrySetCanceled(); - } - - status.Dispose(); + status.TrySetCanceled(status.CancellationToken); } - } - else if (t.IsFaulted) - { - System.Collections.ObjectModel.ReadOnlyCollection exceptions = t.Exception!.InnerExceptions; - for (int i = 0; i < allWaitingTasks.Count; i++) + else { - WaitingCancellationStatus status = allWaitingTasks[i]; - status.TrySetException(exceptions); - status.Dispose(); + status.TrySetCanceled(); } + + status.Dispose(); } - else + } + else if (t.IsFaulted) + { + System.Collections.ObjectModel.ReadOnlyCollection exceptions = t.Exception!.InnerExceptions; + for (int i = 0; i < allWaitingTasks.Count; i++) { - for (int i = 0; i < allWaitingTasks.Count; i++) - { - WaitingCancellationStatus status = allWaitingTasks[i]; - status.TrySetResult(true); - status.Dispose(); - } + WaitingCancellationStatus status = allWaitingTasks[i]; + status.TrySetException(exceptions); + status.Dispose(); } - }, - this, - CancellationToken.None, - TaskContinuationOptions.RunContinuationsAsynchronously, - TaskScheduler.Default).Forget(); - } + } + else + { + for (int i = 0; i < allWaitingTasks.Count; i++) + { + WaitingCancellationStatus status = allWaitingTasks[i]; + status.TrySetResult(true); + status.Dispose(); + } + } + }, + this, + CancellationToken.None, + TaskContinuationOptions.RunContinuationsAsynchronously, + TaskScheduler.Default).Forget(); } + } - /// - /// Gets the inner computation task. - /// - internal Task InnerTask { get; } + /// + /// Gets the inner computation task. + /// + internal Task InnerTask { get; } - /// - /// Try to join the computation. - /// - /// It is true for the initial task starting the computation. This must be called once right after the constructor. - /// Returns a task which can be waited on. - /// A cancellation token to abort this waiting. - /// It returns false, if the inner task is aborted. In which case, no way to join the existing computation. - internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Task? task, CancellationToken cancellationToken) + /// + /// Try to join the computation. + /// + /// It is true for the initial task starting the computation. This must be called once right after the constructor. + /// Returns a task which can be waited on. + /// A cancellation token to abort this waiting. + /// It returns false, if the inner task is aborted. In which case, no way to join the existing computation. + internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Task? task, CancellationToken cancellationToken) + { + if (!this.isCancellationAllowed) { - if (!this.isCancellationAllowed) - { - task = this.JoinNotCancellableTaskAsync(isInitialTask, cancellationToken); - return true; - } + task = this.JoinNotCancellableTaskAsync(isInitialTask, cancellationToken); + return true; + } - if (cancellationToken.IsCancellationRequested) + if (cancellationToken.IsCancellationRequested) + { + if (isInitialTask) { - if (isInitialTask) + // It is a corner case the cancellation token is triggered right after the first task starts. It may need cancel the inner task. + CancellationTokenSource? cancellationTokenSource = null; + lock (this.syncObject) { - // It is a corner case the cancellation token is triggered right after the first task starts. It may need cancel the inner task. - CancellationTokenSource? cancellationTokenSource = null; - lock (this.syncObject) - { - if (this.isCancellationAllowed && this.outstandingWaitingCount == 0 && this.combinedCancellationTokenSource is not null) - { - this.isCancellationRequested = true; - cancellationTokenSource = this.combinedCancellationTokenSource; - this.combinedCancellationTokenSource = null; - } - } - - if (cancellationTokenSource is not null) + if (this.isCancellationAllowed && this.outstandingWaitingCount == 0 && this.combinedCancellationTokenSource is not null) { - cancellationTokenSource.Cancel(); - cancellationTokenSource.Dispose(); + this.isCancellationRequested = true; + cancellationTokenSource = this.combinedCancellationTokenSource; + this.combinedCancellationTokenSource = null; } - - task = this.InnerTask; - return true; } - else + + if (cancellationTokenSource is not null) { - task = Task.FromCanceled(cancellationToken); - return true; + cancellationTokenSource.Cancel(); + cancellationTokenSource.Dispose(); } + + task = this.InnerTask; + return true; } + else + { + task = Task.FromCanceled(cancellationToken); + return true; + } + } - // if the inner task is joined by a new uncancellable task, we will abandone the cancellation token source because we will never use it anymore. - // we do it outside of our lock. - CancellationTokenSource? combinedCancellationTokenSourceToDispose = null; + // if the inner task is joined by a new uncancellable task, we will abandone the cancellation token source because we will never use it anymore. + // we do it outside of our lock. + CancellationTokenSource? combinedCancellationTokenSourceToDispose = null; - try + try + { + lock (this.syncObject) { - lock (this.syncObject) + if (this.isCancellationRequested) { - if (this.isCancellationRequested) - { - // If the earlier computation is aborted, we cannot join it anymore. - task = null; - return false; - } + // If the earlier computation is aborted, we cannot join it anymore. + task = null; + return false; + } - if (this.InnerTask.IsCompleted) - { - task = this.InnerTask; - return true; - } + if (this.InnerTask.IsCompleted) + { + task = this.InnerTask; + return true; + } - if (!cancellationToken.CanBeCanceled) - { - // A single joined client which doesn't allow cancellation would turn the entire computation not cancellable. - combinedCancellationTokenSourceToDispose = this.combinedCancellationTokenSource; - this.combinedCancellationTokenSource = null; + if (!cancellationToken.CanBeCanceled) + { + // A single joined client which doesn't allow cancellation would turn the entire computation not cancellable. + combinedCancellationTokenSourceToDispose = this.combinedCancellationTokenSource; + this.combinedCancellationTokenSource = null; - this.isCancellationAllowed = false; + this.isCancellationAllowed = false; - task = this.JoinNotCancellableTaskAsync(isInitialTask, CancellationToken.None); - } - else if (!this.isCancellationAllowed) + task = this.JoinNotCancellableTaskAsync(isInitialTask, CancellationToken.None); + } + else if (!this.isCancellationAllowed) + { + task = this.JoinNotCancellableTaskAsync(isInitialTask, cancellationToken); + } + else + { + Assumes.NotNull(this.joinedWaitingList); + + WaitingCancellationStatus status; + + // we need increase the outstanding count before creating WiatingCancellationStatus. + // Under a rare race condition the cancellation token can be trigger with this time frame, and lead OnWaitingTaskCancelled to be called recursively + // within this lock. It would be critical to make sure the outstandingWaitingCount to increase before decreasing there. + this.outstandingWaitingCount++; + try { - task = this.JoinNotCancellableTaskAsync(isInitialTask, cancellationToken); + status = new WaitingCancellationStatus(this, cancellationToken); } - else + catch { - Assumes.NotNull(this.joinedWaitingList); - - WaitingCancellationStatus status; - - // we need increase the outstanding count before creating WiatingCancellationStatus. - // Under a rare race condition the cancellation token can be trigger with this time frame, and lead OnWaitingTaskCancelled to be called recursively - // within this lock. It would be critical to make sure the outstandingWaitingCount to increase before decreasing there. - this.outstandingWaitingCount++; - try - { - status = new WaitingCancellationStatus(this, cancellationToken); - } - catch - { - this.outstandingWaitingCount--; - throw; - } + this.outstandingWaitingCount--; + throw; + } - this.joinedWaitingList.Add(status); + this.joinedWaitingList.Add(status); - task = status.Task; - } + task = status.Task; } } - finally - { - combinedCancellationTokenSourceToDispose?.Dispose(); - } + } + finally + { + combinedCancellationTokenSourceToDispose?.Dispose(); + } - return true; + return true; + } + + /// + /// A simple way to join if the inner task cannot be cancelled. + /// + /// Whether it is the first task to start the computation. + /// A cancellation token to abort the waiting. + /// A task to complete when the computation ends. + private Task JoinNotCancellableTaskAsync(bool isInitialTask, CancellationToken cancellationToken) + { + if (this.InnerTask.IsCompleted || (isInitialTask && !cancellationToken.CanBeCanceled)) + { + // Note: we don't reuse the inner task directly even for second request which is not cancellable. + // This is to prevent two task sychorized continuations, which can be blocking each other causing unexpected deadlocks. + // Adding an extra async task continuation prevents this problem, because all async continuation will be queued before calling synchronized task continuations, + // which are called one by one. + return this.InnerTask; } - /// - /// A simple way to join if the inner task cannot be cancelled. - /// - /// Whether it is the first task to start the computation. - /// A cancellation token to abort the waiting. - /// A task to complete when the computation ends. - private Task JoinNotCancellableTaskAsync(bool isInitialTask, CancellationToken cancellationToken) + if (cancellationToken.IsCancellationRequested) + { + return Task.FromCanceled(cancellationToken); + } + + // We tack cancellation onto the task that we actually return to the caller. + // This doesn't cancel resource preparation, but it does allow the caller to return early + // in the event of their own cancellation token being canceled. + return this.InnerTask.ContinueWith( + t => t.GetAwaiter().GetResult(), + cancellationToken, + TaskContinuationOptions.RunContinuationsAsynchronously, + TaskScheduler.Default); + } + + /// + /// Handles one waiting task can be cancelled. + /// + /// The status of the waiting task being cancelled. + private void OnWaitingTaskCancelled(WaitingCancellationStatus status) + { + CancellationTokenSource? overallCancellationSource = null; + + lock (this.syncObject) { - if (this.InnerTask.IsCompleted || (isInitialTask && !cancellationToken.CanBeCanceled)) + if (--this.outstandingWaitingCount != 0 || !this.isCancellationAllowed) { - // Note: we don't reuse the inner task directly even for second request which is not cancellable. - // This is to prevent two task sychorized continuations, which can be blocking each other causing unexpected deadlocks. - // Adding an extra async task continuation prevents this problem, because all async continuation will be queued before calling synchronized task continuations, - // which are called one by one. - return this.InnerTask; + // when overall cancellation is not allowed, we cancel this single waiting task. + status.TrySetCanceled(status.CancellationToken); } - - if (cancellationToken.IsCancellationRequested) + else { - return Task.FromCanceled(cancellationToken); + // otherwise, we cancel the overall computation, when it is done, it will cancel the current waiting task. + overallCancellationSource = this.combinedCancellationTokenSource; + if (overallCancellationSource is not null) + { + this.combinedCancellationTokenSource = null; + this.isCancellationRequested = true; + } } + } - // We tack cancellation onto the task that we actually return to the caller. - // This doesn't cancel resource preparation, but it does allow the caller to return early - // in the event of their own cancellation token being canceled. - return this.InnerTask.ContinueWith( - t => t.GetAwaiter().GetResult(), - cancellationToken, - TaskContinuationOptions.RunContinuationsAsynchronously, - TaskScheduler.Default); + if (overallCancellationSource is not null) + { + overallCancellationSource.Cancel(); + overallCancellationSource.Dispose(); } + } + /// + /// Represents the status of a single request waiting the inner task to complete. + /// + private class WaitingCancellationStatus : TaskCompletionSource + { /// - /// Handles one waiting task can be cancelled. + /// The cancellation registration to handle the cancellation token of the request. /// - /// The status of the waiting task being cancelled. - private void OnWaitingTaskCancelled(WaitingCancellationStatus status) + private CancellationTokenRegistration cancellationTokenRegistration; + + /// + /// Initializes a new instance of the class. + /// + /// The joined computation. + /// The cancellation token of the request. + internal WaitingCancellationStatus(CancellableJoinComputation computation, CancellationToken cancellationToken) + : base(computation, TaskCreationOptions.RunContinuationsAsynchronously) { - CancellationTokenSource? overallCancellationSource = null; + Assumes.True(cancellationToken.CanBeCanceled); + this.CancellationToken = cancellationToken; - lock (this.syncObject) - { - if (--this.outstandingWaitingCount != 0 || !this.isCancellationAllowed) + this.cancellationTokenRegistration = cancellationToken.Register( + s => { - // when overall cancellation is not allowed, we cancel this single waiting task. - status.TrySetCanceled(status.CancellationToken); - } - else - { - // otherwise, we cancel the overall computation, when it is done, it will cancel the current waiting task. - overallCancellationSource = this.combinedCancellationTokenSource; - if (overallCancellationSource is not null) - { - this.combinedCancellationTokenSource = null; - this.isCancellationRequested = true; - } - } - } - - if (overallCancellationSource is not null) - { - overallCancellationSource.Cancel(); - overallCancellationSource.Dispose(); - } + var me = (WaitingCancellationStatus)s!; + me.Computation.OnWaitingTaskCancelled(me); + }, + this, + useSynchronizationContext: false); } /// - /// Represents the status of a single request waiting the inner task to complete. + /// Gets the joined computation. + /// Note: we set it to the state of the TaskCompletionSource. It makes it easy to trace it through the waiting task in dump files. /// - private class WaitingCancellationStatus : TaskCompletionSource - { - /// - /// The cancellation registration to handle the cancellation token of the request. - /// - private CancellationTokenRegistration cancellationTokenRegistration; - - /// - /// Initializes a new instance of the class. - /// - /// The joined computation. - /// The cancellation token of the request. - internal WaitingCancellationStatus(CancellableJoinComputation computation, CancellationToken cancellationToken) - : base(computation, TaskCreationOptions.RunContinuationsAsynchronously) - { - Assumes.True(cancellationToken.CanBeCanceled); - this.CancellationToken = cancellationToken; + internal CancellableJoinComputation Computation => (CancellableJoinComputation)this.Task.AsyncState!; - this.cancellationTokenRegistration = cancellationToken.Register( - s => - { - var me = (WaitingCancellationStatus)s!; - me.Computation.OnWaitingTaskCancelled(me); - }, - this, - useSynchronizationContext: false); - } + /// + /// Gets the cancellation token of the waiting task. + /// + internal CancellationToken CancellationToken { get; } - /// - /// Gets the joined computation. - /// Note: we set it to the state of the TaskCompletionSource. It makes it easy to trace it through the waiting task in dump files. - /// - internal CancellableJoinComputation Computation => (CancellableJoinComputation)this.Task.AsyncState!; - - /// - /// Gets the cancellation token of the waiting task. - /// - internal CancellationToken CancellationToken { get; } - - /// - /// Dispose this instance. - /// - public void Dispose() - { - this.cancellationTokenRegistration.Dispose(); - } + /// + /// Dispose this instance. + /// + public void Dispose() + { + this.cancellationTokenRegistration.Dispose(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs index 2045d65e5..0978d3406 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs @@ -4,199 +4,198 @@ using System; using System.Threading; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Extensions to . +/// +public static class CancellationTokenExtensions { /// - /// Extensions to . + /// Creates a new that is canceled when any of a set of other tokens are canceled. /// - public static class CancellationTokenExtensions + /// The first token. + /// The second token. + /// A struct that contains the combined and a means to release memory when you're done using it. + public static CombinedCancellationToken CombineWith(this CancellationToken original, CancellationToken other) { - /// - /// Creates a new that is canceled when any of a set of other tokens are canceled. - /// - /// The first token. - /// The second token. - /// A struct that contains the combined and a means to release memory when you're done using it. - public static CombinedCancellationToken CombineWith(this CancellationToken original, CancellationToken other) + if (original.IsCancellationRequested || !other.CanBeCanceled) { - if (original.IsCancellationRequested || !other.CanBeCanceled) - { - return new CombinedCancellationToken(original); - } - - if (other.IsCancellationRequested || !original.CanBeCanceled) - { - return new CombinedCancellationToken(other); - } + return new CombinedCancellationToken(original); + } - // This is the most expensive path to take since it involves allocating memory and requiring disposal. - // Before this point we've checked every condition that would allow us to avoid it. - return new CombinedCancellationToken(CancellationTokenSource.CreateLinkedTokenSource(original, other)); + if (other.IsCancellationRequested || !original.CanBeCanceled) + { + return new CombinedCancellationToken(other); } - /// - /// Creates a new that is canceled when any of a set of other tokens are canceled. - /// - /// The first token. - /// The additional tokens. - /// A struct that contains the combined and a means to release memory when you're done using it. - public static CombinedCancellationToken CombineWith(this CancellationToken original, params CancellationToken[] others) + // This is the most expensive path to take since it involves allocating memory and requiring disposal. + // Before this point we've checked every condition that would allow us to avoid it. + return new CombinedCancellationToken(CancellationTokenSource.CreateLinkedTokenSource(original, other)); + } + + /// + /// Creates a new that is canceled when any of a set of other tokens are canceled. + /// + /// The first token. + /// The additional tokens. + /// A struct that contains the combined and a means to release memory when you're done using it. + public static CombinedCancellationToken CombineWith(this CancellationToken original, params CancellationToken[] others) + { + Requires.NotNull(others, nameof(others)); + + if (original.IsCancellationRequested) { - Requires.NotNull(others, nameof(others)); + return new CombinedCancellationToken(original); + } - if (original.IsCancellationRequested) + int cancelableTokensCount = original.CanBeCanceled ? 1 : 0; + foreach (CancellationToken other in others) + { + if (other.IsCancellationRequested) { - return new CombinedCancellationToken(original); + return new CombinedCancellationToken(other); } - int cancelableTokensCount = original.CanBeCanceled ? 1 : 0; - foreach (CancellationToken other in others) + if (other.CanBeCanceled) { - if (other.IsCancellationRequested) - { - return new CombinedCancellationToken(other); - } + cancelableTokensCount++; + } + } - if (other.CanBeCanceled) + switch (cancelableTokensCount) + { + case 0: + return new CombinedCancellationToken(CancellationToken.None); + case 1: + if (original.CanBeCanceled) { - cancelableTokensCount++; + return new CombinedCancellationToken(original); } - } - - switch (cancelableTokensCount) - { - case 0: - return new CombinedCancellationToken(CancellationToken.None); - case 1: - if (original.CanBeCanceled) - { - return new CombinedCancellationToken(original); - } - foreach (CancellationToken other in others) + foreach (CancellationToken other in others) + { + if (other.CanBeCanceled) { - if (other.CanBeCanceled) - { - return new CombinedCancellationToken(other); - } + return new CombinedCancellationToken(other); } + } - throw Assumes.NotReachable(); - case 2: - CancellationToken first = CancellationToken.None; - CancellationToken second = CancellationToken.None; + throw Assumes.NotReachable(); + case 2: + CancellationToken first = CancellationToken.None; + CancellationToken second = CancellationToken.None; - if (original.CanBeCanceled) - { - first = original; - } + if (original.CanBeCanceled) + { + first = original; + } - foreach (CancellationToken other in others) + foreach (CancellationToken other in others) + { + if (other.CanBeCanceled) { - if (other.CanBeCanceled) + if (first.CanBeCanceled) + { + second = other; + } + else { - if (first.CanBeCanceled) - { - second = other; - } - else - { - first = other; - } + first = other; } } + } - Assumes.True(first.CanBeCanceled && second.CanBeCanceled); + Assumes.True(first.CanBeCanceled && second.CanBeCanceled); - // Call the overload that takes two CancellationTokens explicitly to avoid an array allocation. - return new CombinedCancellationToken(CancellationTokenSource.CreateLinkedTokenSource(first, second)); - default: - // This is the most expensive path to take since it involves allocating memory and requiring disposal. - // Before this point we've checked every condition that would allow us to avoid it. - var cancelableTokens = new CancellationToken[cancelableTokensCount]; - int i = 0; - foreach (CancellationToken other in others) + // Call the overload that takes two CancellationTokens explicitly to avoid an array allocation. + return new CombinedCancellationToken(CancellationTokenSource.CreateLinkedTokenSource(first, second)); + default: + // This is the most expensive path to take since it involves allocating memory and requiring disposal. + // Before this point we've checked every condition that would allow us to avoid it. + var cancelableTokens = new CancellationToken[cancelableTokensCount]; + int i = 0; + foreach (CancellationToken other in others) + { + if (other.CanBeCanceled) { - if (other.CanBeCanceled) - { - cancelableTokens[i++] = other; - } + cancelableTokens[i++] = other; } + } - return new CombinedCancellationToken(CancellationTokenSource.CreateLinkedTokenSource(cancelableTokens)); - } + return new CombinedCancellationToken(CancellationTokenSource.CreateLinkedTokenSource(cancelableTokens)); } + } + + /// + /// Provides access to a that combines multiple other tokens, + /// and allows convenient disposal of any applicable . + /// + public readonly struct CombinedCancellationToken : IDisposable, IEquatable + { + /// + /// The object to dispose when this struct is disposed. + /// + private readonly CancellationTokenSource? cts; /// - /// Provides access to a that combines multiple other tokens, - /// and allows convenient disposal of any applicable . + /// Initializes a new instance of the struct + /// that contains an aggregate whose source must be disposed. /// - public readonly struct CombinedCancellationToken : IDisposable, IEquatable + /// The cancellation token source. + public CombinedCancellationToken(CancellationTokenSource cancellationTokenSource) { - /// - /// The object to dispose when this struct is disposed. - /// - private readonly CancellationTokenSource? cts; - - /// - /// Initializes a new instance of the struct - /// that contains an aggregate whose source must be disposed. - /// - /// The cancellation token source. - public CombinedCancellationToken(CancellationTokenSource cancellationTokenSource) - { - this.cts = cancellationTokenSource; - this.Token = cancellationTokenSource.Token; - } + this.cts = cancellationTokenSource; + this.Token = cancellationTokenSource.Token; + } - /// - /// Initializes a new instance of the struct - /// that represents just a single, non-disposable . - /// - /// The cancellation token. - public CombinedCancellationToken(CancellationToken cancellationToken) - { - this.cts = null; - this.Token = cancellationToken; - } + /// + /// Initializes a new instance of the struct + /// that represents just a single, non-disposable . + /// + /// The cancellation token. + public CombinedCancellationToken(CancellationToken cancellationToken) + { + this.cts = null; + this.Token = cancellationToken; + } - /// - /// Gets the combined cancellation token. - /// - public CancellationToken Token { get; } - - /// - /// Checks whether two instances of are equal. - /// - /// The left operand. - /// The right operand. - /// if they are equal; otherwise. - public static bool operator ==(CombinedCancellationToken left, CombinedCancellationToken right) => left.Equals(right); - - /// - /// Checks whether two instances of are not equal. - /// - /// The left operand. - /// The right operand. - /// if they are not equal; if they are equal. - public static bool operator !=(CombinedCancellationToken left, CombinedCancellationToken right) => !(left == right); - - /// - /// Disposes the behind this combined token, if any. - /// - public void Dispose() - { - this.cts?.Dispose(); - } + /// + /// Gets the combined cancellation token. + /// + public CancellationToken Token { get; } - /// - public override bool Equals(object? obj) => obj is CombinedCancellationToken other && this.Equals(other); + /// + /// Checks whether two instances of are equal. + /// + /// The left operand. + /// The right operand. + /// if they are equal; otherwise. + public static bool operator ==(CombinedCancellationToken left, CombinedCancellationToken right) => left.Equals(right); - /// - public bool Equals(CombinedCancellationToken other) => this.cts == other.cts && this.Token.Equals(other.Token); + /// + /// Checks whether two instances of are not equal. + /// + /// The left operand. + /// The right operand. + /// if they are not equal; if they are equal. + public static bool operator !=(CombinedCancellationToken left, CombinedCancellationToken right) => !(left == right); - /// - public override int GetHashCode() => (this.cts?.GetHashCode() ?? 0) + this.Token.GetHashCode(); + /// + /// Disposes the behind this combined token, if any. + /// + public void Dispose() + { + this.cts?.Dispose(); } + + /// + public override bool Equals(object? obj) => obj is CombinedCancellationToken other && this.Equals(other); + + /// + public bool Equals(CombinedCancellationToken other) => this.cts == other.cts && this.Token.Equals(other.Token); + + /// + public override int GetHashCode() => (this.cts?.GetHashCode() ?? 0) + this.Token.GetHashCode(); } } diff --git a/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs index 20645e8e0..a17438de7 100644 --- a/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/DelegatingJoinableTaskFactory.cs @@ -8,76 +8,75 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A JoinableTaskFactory base class for derived types that delegate some of their work to an existing instance. +/// +/// +/// All virtual methods default to calling into the inner for its behavior, +/// rather than the default behavior of the base class. +/// This is useful because a derived-type cannot call protected methods on another instance of that type. +/// +public class DelegatingJoinableTaskFactory : JoinableTaskFactory { /// - /// A JoinableTaskFactory base class for derived types that delegate some of their work to an existing instance. + /// The inner factory that will create the tasks. /// - /// - /// All virtual methods default to calling into the inner for its behavior, - /// rather than the default behavior of the base class. - /// This is useful because a derived-type cannot call protected methods on another instance of that type. - /// - public class DelegatingJoinableTaskFactory : JoinableTaskFactory - { - /// - /// The inner factory that will create the tasks. - /// - private readonly JoinableTaskFactory innerFactory; + private readonly JoinableTaskFactory innerFactory; - /// - /// Initializes a new instance of the class. - /// - /// The inner factory that will create the tasks. - protected DelegatingJoinableTaskFactory(JoinableTaskFactory innerFactory) - : base(Requires.NotNull(innerFactory, "innerFactory").Context, innerFactory.Collection) - { - this.innerFactory = innerFactory; - } + /// + /// Initializes a new instance of the class. + /// + /// The inner factory that will create the tasks. + protected DelegatingJoinableTaskFactory(JoinableTaskFactory innerFactory) + : base(Requires.NotNull(innerFactory, "innerFactory").Context, innerFactory.Collection) + { + this.innerFactory = innerFactory; + } - /// - /// Synchronously blocks the calling thread for the completion of the specified task. - /// - /// The task whose completion is being waited on. - protected internal override void WaitSynchronously(Task task) - { - this.innerFactory.WaitSynchronously(task); - } + /// + /// Synchronously blocks the calling thread for the completion of the specified task. + /// + /// The task whose completion is being waited on. + protected internal override void WaitSynchronously(Task task) + { + this.innerFactory.WaitSynchronously(task); + } - /// - /// Posts a message to the specified underlying SynchronizationContext for processing when the main thread - /// is freely available. - /// - /// The callback to invoke. - /// State to pass to the callback. - protected internal override void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) - { - this.innerFactory.PostToUnderlyingSynchronizationContext(callback, state); - } + /// + /// Posts a message to the specified underlying SynchronizationContext for processing when the main thread + /// is freely available. + /// + /// The callback to invoke. + /// State to pass to the callback. + protected internal override void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) + { + this.innerFactory.PostToUnderlyingSynchronizationContext(callback, state); + } - /// - /// Raised when a joinable task has requested a transition to the main thread. - /// - /// The task requesting the transition to the main thread. - /// - /// This event may be raised on any thread, including the main thread. - /// - protected internal override void OnTransitioningToMainThread(JoinableTask joinableTask) - { - this.innerFactory.OnTransitioningToMainThread(joinableTask); - } + /// + /// Raised when a joinable task has requested a transition to the main thread. + /// + /// The task requesting the transition to the main thread. + /// + /// This event may be raised on any thread, including the main thread. + /// + protected internal override void OnTransitioningToMainThread(JoinableTask joinableTask) + { + this.innerFactory.OnTransitioningToMainThread(joinableTask); + } - /// - /// Raised whenever a joinable task has completed a transition to the main thread. - /// - /// The task whose request to transition to the main thread has completed. - /// A value indicating whether the transition was cancelled before it was fulfilled. - /// - /// This event is usually raised on the main thread, but can be on another thread when is . - /// - protected internal override void OnTransitionedToMainThread(JoinableTask joinableTask, bool canceled) - { - this.innerFactory.OnTransitionedToMainThread(joinableTask, canceled); - } + /// + /// Raised whenever a joinable task has completed a transition to the main thread. + /// + /// The task whose request to transition to the main thread has completed. + /// A value indicating whether the transition was cancelled before it was fulfilled. + /// + /// This event is usually raised on the main thread, but can be on another thread when is . + /// + protected internal override void OnTransitionedToMainThread(JoinableTask joinableTask, bool canceled) + { + this.innerFactory.OnTransitionedToMainThread(joinableTask, canceled); } } diff --git a/src/Microsoft.VisualStudio.Threading/Dgml.cs b/src/Microsoft.VisualStudio.Threading/Dgml.cs index ee9688dd8..bb628a18f 100644 --- a/src/Microsoft.VisualStudio.Threading/Dgml.cs +++ b/src/Microsoft.VisualStudio.Threading/Dgml.cs @@ -8,287 +8,286 @@ using System.Threading.Tasks; using System.Xml.Linq; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +internal static class Dgml { - internal static class Dgml + /// + /// The namespace that all DGML nodes appear in. + /// + internal const string Namespace = "http://schemas.microsoft.com/vs/2009/dgml"; + + private static readonly XName NodeName = XName.Get("Node", Namespace); + private static readonly XName NodesName = XName.Get("Nodes", Namespace); + private static readonly XName LinkName = XName.Get("Link", Namespace); + private static readonly XName LinksName = XName.Get("Links", Namespace); + private static readonly XName StylesName = XName.Get("Styles", Namespace); + private static readonly XName StyleName = XName.Get("Style", Namespace); + + internal static XDocument Create(out XElement nodes, out XElement links, string layout = "Sugiyama", string? direction = null) { - /// - /// The namespace that all DGML nodes appear in. - /// - internal const string Namespace = "http://schemas.microsoft.com/vs/2009/dgml"; - - private static readonly XName NodeName = XName.Get("Node", Namespace); - private static readonly XName NodesName = XName.Get("Nodes", Namespace); - private static readonly XName LinkName = XName.Get("Link", Namespace); - private static readonly XName LinksName = XName.Get("Links", Namespace); - private static readonly XName StylesName = XName.Get("Styles", Namespace); - private static readonly XName StyleName = XName.Get("Style", Namespace); - - internal static XDocument Create(out XElement nodes, out XElement links, string layout = "Sugiyama", string? direction = null) - { - var dgml = new XDocument(); - dgml.Add( - new XElement( - XName.Get("DirectedGraph", Namespace), - new XAttribute("Layout", layout))); - if (direction is object) - { - dgml.Root!.Add(new XAttribute("GraphDirection", direction)); - } - - nodes = new XElement(XName.Get("Nodes", Namespace)); - links = new XElement(XName.Get("Links", Namespace)); - dgml.Root!.Add(nodes); - dgml.Root.Add(links); - dgml.WithCategories(Category("Contains", isContainment: true)); - return dgml; - } - - internal static XDocument WithCategories(this XDocument document, params string[] categories) + var dgml = new XDocument(); + dgml.Add( + new XElement( + XName.Get("DirectedGraph", Namespace), + new XAttribute("Layout", layout))); + if (direction is object) { - Requires.NotNull(document, nameof(document)); - Requires.NotNull(categories, nameof(categories)); - - GetRootElement(document, "Categories").Add(categories.Select(c => Category(c))); - return document; + dgml.Root!.Add(new XAttribute("GraphDirection", direction)); } - internal static XDocument WithCategories(this XDocument document, params XElement[] categories) - { - Requires.NotNull(document, nameof(document)); - Requires.NotNull(categories, nameof(categories)); - - GetRootElement(document, "Categories").Add(categories); - return document; - } + nodes = new XElement(XName.Get("Nodes", Namespace)); + links = new XElement(XName.Get("Links", Namespace)); + dgml.Root!.Add(nodes); + dgml.Root.Add(links); + dgml.WithCategories(Category("Contains", isContainment: true)); + return dgml; + } - internal static XElement Node(string? id = null, string? label = null, string? group = null) - { - var element = new XElement(NodeName); + internal static XDocument WithCategories(this XDocument document, params string[] categories) + { + Requires.NotNull(document, nameof(document)); + Requires.NotNull(categories, nameof(categories)); - if (!string.IsNullOrEmpty(id)) - { - element.SetAttributeValue("Id", id); - } + GetRootElement(document, "Categories").Add(categories.Select(c => Category(c))); + return document; + } - if (!string.IsNullOrEmpty(label)) - { - element.SetAttributeValue("Label", label); - } + internal static XDocument WithCategories(this XDocument document, params XElement[] categories) + { + Requires.NotNull(document, nameof(document)); + Requires.NotNull(categories, nameof(categories)); - if (!string.IsNullOrEmpty(group)) - { - element.SetAttributeValue("Group", group); - } + GetRootElement(document, "Categories").Add(categories); + return document; + } - return element; - } + internal static XElement Node(string? id = null, string? label = null, string? group = null) + { + var element = new XElement(NodeName); - internal static XDocument WithNode(this XDocument document, XElement node) + if (!string.IsNullOrEmpty(id)) { - Requires.NotNull(document, nameof(document)); - Requires.NotNull(node, nameof(node)); - - XElement? nodes = document.GetRootElement(NodesName); - nodes.Add(node); - return document; + element.SetAttributeValue("Id", id); } - internal static XElement Link(string source, string target) + if (!string.IsNullOrEmpty(label)) { - Requires.NotNullOrEmpty(source, nameof(source)); - Requires.NotNullOrEmpty(target, nameof(target)); - - return new XElement( - LinkName, - new XAttribute("Source", source), - new XAttribute("Target", target)); + element.SetAttributeValue("Label", label); } - internal static XElement Link(XElement source, XElement target) + if (!string.IsNullOrEmpty(group)) { - return Link(source.Attribute("Id")!.Value, target.Attribute("Id")!.Value); + element.SetAttributeValue("Group", group); } - internal static XDocument WithLink(this XDocument document, XElement link) - { - Requires.NotNull(document, nameof(document)); - Requires.NotNull(link, nameof(link)); + return element; + } - XElement? links = document.GetRootElement(LinksName); - links.Add(link); - return document; - } + internal static XDocument WithNode(this XDocument document, XElement node) + { + Requires.NotNull(document, nameof(document)); + Requires.NotNull(node, nameof(node)); - internal static XElement Category(string id, string? label = null, string? background = null, string? foreground = null, string? icon = null, bool isTag = false, bool isContainment = false) - { - Requires.NotNullOrEmpty(id, nameof(id)); + XElement? nodes = document.GetRootElement(NodesName); + nodes.Add(node); + return document; + } - var category = new XElement(XName.Get("Category", Namespace), new XAttribute("Id", id)); - if (!string.IsNullOrEmpty(label)) - { - category.SetAttributeValue("Label", label); - } + internal static XElement Link(string source, string target) + { + Requires.NotNullOrEmpty(source, nameof(source)); + Requires.NotNullOrEmpty(target, nameof(target)); - if (!string.IsNullOrEmpty(background)) - { - category.SetAttributeValue("Background", background); - } + return new XElement( + LinkName, + new XAttribute("Source", source), + new XAttribute("Target", target)); + } - if (!string.IsNullOrEmpty(foreground)) - { - category.SetAttributeValue("Foreground", foreground); - } + internal static XElement Link(XElement source, XElement target) + { + return Link(source.Attribute("Id")!.Value, target.Attribute("Id")!.Value); + } - if (!string.IsNullOrEmpty(icon)) - { - category.SetAttributeValue("Icon", icon); - } + internal static XDocument WithLink(this XDocument document, XElement link) + { + Requires.NotNull(document, nameof(document)); + Requires.NotNull(link, nameof(link)); - if (isTag) - { - category.SetAttributeValue("IsTag", "True"); - } + XElement? links = document.GetRootElement(LinksName); + links.Add(link); + return document; + } - if (isContainment) - { - category.SetAttributeValue("IsContainment", "True"); - } + internal static XElement Category(string id, string? label = null, string? background = null, string? foreground = null, string? icon = null, bool isTag = false, bool isContainment = false) + { + Requires.NotNullOrEmpty(id, nameof(id)); - return category; + var category = new XElement(XName.Get("Category", Namespace), new XAttribute("Id", id)); + if (!string.IsNullOrEmpty(label)) + { + category.SetAttributeValue("Label", label); } - internal static XElement Comment(string label) + if (!string.IsNullOrEmpty(background)) { - return Node(label: label).WithCategories("Comment"); + category.SetAttributeValue("Background", background); } - internal static XElement Container(string id, string? label = null) + if (!string.IsNullOrEmpty(foreground)) { - return Node(id, label, group: "Expanded"); + category.SetAttributeValue("Foreground", foreground); } - internal static XDocument WithContainers(this XDocument document, IEnumerable containers) + if (!string.IsNullOrEmpty(icon)) { - foreach (XElement? container in containers) - { - WithNode(document, container); - } - - return document; + category.SetAttributeValue("Icon", icon); } - internal static XElement ContainedBy(this XElement node, XElement container) + if (isTag) { - Requires.NotNull(node, nameof(node)); - Requires.NotNull(container, nameof(container)); - - Link(container, node).WithCategories("Contains"); - return node; + category.SetAttributeValue("IsTag", "True"); } - internal static XElement ContainedBy(this XElement node, string containerId, XDocument document) + if (isContainment) { - Requires.NotNull(node, nameof(node)); - Requires.NotNullOrEmpty(containerId, nameof(containerId)); - - document.WithLink(Link(containerId, node.Attribute("Id")!.Value).WithCategories("Contains")); - return node; + category.SetAttributeValue("IsContainment", "True"); } - /// - /// Adds categories to a DGML node or link. - /// - /// The node or link to add categories to. - /// The categories to add. - /// The same node that was passed in. To enable "fluent" syntax. - internal static XElement WithCategories(this XElement element, params string[] categories) - { - Requires.NotNull(element, nameof(element)); + return category; + } - foreach (var category in categories) - { - if (element.Attribute("Category") is null) - { - element.SetAttributeValue("Category", category); - } - else - { - element.Add(new XElement( - XName.Get("Category", Namespace), - new XAttribute("Ref", category))); - } - } + internal static XElement Comment(string label) + { + return Node(label: label).WithCategories("Comment"); + } - return element; - } + internal static XElement Container(string id, string? label = null) + { + return Node(id, label, group: "Expanded"); + } - internal static XDocument WithStyle(this XDocument document, string categoryId, IEnumerable> properties, string targetType = "Node") + internal static XDocument WithContainers(this XDocument document, IEnumerable containers) + { + foreach (XElement? container in containers) { - Requires.NotNull(document, nameof(document)); - Requires.NotNullOrEmpty(categoryId, nameof(categoryId)); - Requires.NotNull(properties, nameof(properties)); - Requires.NotNullOrEmpty(targetType, nameof(targetType)); + WithNode(document, container); + } - XElement? container = document.Root!.Element(StylesName); - if (container is null) - { - document.Root.Add(container = new XElement(StylesName)); - } + return document; + } - var style = new XElement( - StyleName, - new XAttribute("TargetType", targetType), - new XAttribute("GroupLabel", categoryId), - new XElement(XName.Get("Condition", Namespace), new XAttribute("Expression", "HasCategory('" + categoryId + "')"))); - style.Add(properties.Select(p => new XElement(XName.Get("Setter", Namespace), new XAttribute("Property", p.Key), new XAttribute("Value", p.Value!)))); + internal static XElement ContainedBy(this XElement node, XElement container) + { + Requires.NotNull(node, nameof(node)); + Requires.NotNull(container, nameof(container)); - container.Add(style); + Link(container, node).WithCategories("Contains"); + return node; + } - return document; - } + internal static XElement ContainedBy(this XElement node, string containerId, XDocument document) + { + Requires.NotNull(node, nameof(node)); + Requires.NotNullOrEmpty(containerId, nameof(containerId)); - internal static XDocument WithStyle(this XDocument document, string categoryId, string targetType = "Node", string? foreground = null, string? background = null, string? icon = null) + document.WithLink(Link(containerId, node.Attribute("Id")!.Value).WithCategories("Contains")); + return node; + } + + /// + /// Adds categories to a DGML node or link. + /// + /// The node or link to add categories to. + /// The categories to add. + /// The same node that was passed in. To enable "fluent" syntax. + internal static XElement WithCategories(this XElement element, params string[] categories) + { + Requires.NotNull(element, nameof(element)); + + foreach (var category in categories) { - var properties = new Dictionary(); - if (!string.IsNullOrEmpty(foreground)) + if (element.Attribute("Category") is null) { - properties.Add("Foreground", foreground); + element.SetAttributeValue("Category", category); } - - if (!string.IsNullOrEmpty(background)) + else { - properties.Add("Background", background); + element.Add(new XElement( + XName.Get("Category", Namespace), + new XAttribute("Ref", category))); } + } - if (!string.IsNullOrEmpty(icon)) - { - properties.Add("Icon", icon); - } + return element; + } - return WithStyle(document, categoryId, properties, targetType); - } + internal static XDocument WithStyle(this XDocument document, string categoryId, IEnumerable> properties, string targetType = "Node") + { + Requires.NotNull(document, nameof(document)); + Requires.NotNullOrEmpty(categoryId, nameof(categoryId)); + Requires.NotNull(properties, nameof(properties)); + Requires.NotNullOrEmpty(targetType, nameof(targetType)); - private static XElement GetRootElement(this XDocument document, XName name) + XElement? container = document.Root!.Element(StylesName); + if (container is null) { - Requires.NotNull(document, nameof(document)); - Requires.NotNull(name, nameof(name)); + document.Root.Add(container = new XElement(StylesName)); + } - XElement? container = document.Root!.Element(name); - if (container is null) - { - document.Root.Add(container = new XElement(name)); - } + var style = new XElement( + StyleName, + new XAttribute("TargetType", targetType), + new XAttribute("GroupLabel", categoryId), + new XElement(XName.Get("Condition", Namespace), new XAttribute("Expression", "HasCategory('" + categoryId + "')"))); + style.Add(properties.Select(p => new XElement(XName.Get("Setter", Namespace), new XAttribute("Property", p.Key), new XAttribute("Value", p.Value!)))); + + container.Add(style); + + return document; + } - return container; + internal static XDocument WithStyle(this XDocument document, string categoryId, string targetType = "Node", string? foreground = null, string? background = null, string? icon = null) + { + var properties = new Dictionary(); + if (!string.IsNullOrEmpty(foreground)) + { + properties.Add("Foreground", foreground); } - private static XElement GetRootElement(XDocument document, string elementName) + if (!string.IsNullOrEmpty(background)) { - Requires.NotNull(document, nameof(document)); - Requires.NotNullOrEmpty(elementName, nameof(elementName)); + properties.Add("Background", background); + } - return GetRootElement(document, XName.Get(elementName, Namespace)); + if (!string.IsNullOrEmpty(icon)) + { + properties.Add("Icon", icon); } + + return WithStyle(document, categoryId, properties, targetType); + } + + private static XElement GetRootElement(this XDocument document, XName name) + { + Requires.NotNull(document, nameof(document)); + Requires.NotNull(name, nameof(name)); + + XElement? container = document.Root!.Element(name); + if (container is null) + { + document.Root.Add(container = new XElement(name)); + } + + return container; + } + + private static XElement GetRootElement(XDocument document, string elementName) + { + Requires.NotNull(document, nameof(document)); + Requires.NotNullOrEmpty(elementName, nameof(elementName)); + + return GetRootElement(document, XName.Get(elementName, Namespace)); } } diff --git a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs index 87bfc2fcf..900977100 100644 --- a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs @@ -7,68 +7,67 @@ using System.Threading; using System.Windows.Threading; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Extension methods for the WPF for better +/// interop with the . +/// +public static class DispatcherExtensions { /// - /// Extension methods for the WPF for better - /// interop with the . + /// Creates a that schedules work with the specified + /// and . + /// + /// The underlying to use. + /// The that schedules work on the main thread. + /// + /// The priority with which to schedule any work on the UI thread, + /// when and if is called + /// and for each asynchronous return to the main thread after an . + /// + /// A that may be used for scheduling async work with the specified priority. + public static JoinableTaskFactory WithPriority(this JoinableTaskFactory joinableTaskFactory, Dispatcher dispatcher, DispatcherPriority priority) + { + Requires.NotNull(joinableTaskFactory, nameof(joinableTaskFactory)); + Requires.NotNull(dispatcher, nameof(dispatcher)); + + return new DispatcherJoinableTaskFactory(joinableTaskFactory, dispatcher, priority); + } + + /// + /// A that schedules work on the UI thread + /// according to a given . /// - public static class DispatcherExtensions + private class DispatcherJoinableTaskFactory : DelegatingJoinableTaskFactory { /// - /// Creates a that schedules work with the specified - /// and . + /// The to use for scheduling work on the UI thread. /// - /// The underlying to use. - /// The that schedules work on the main thread. - /// - /// The priority with which to schedule any work on the UI thread, - /// when and if is called - /// and for each asynchronous return to the main thread after an . - /// - /// A that may be used for scheduling async work with the specified priority. - public static JoinableTaskFactory WithPriority(this JoinableTaskFactory joinableTaskFactory, Dispatcher dispatcher, DispatcherPriority priority) - { - Requires.NotNull(joinableTaskFactory, nameof(joinableTaskFactory)); - Requires.NotNull(dispatcher, nameof(dispatcher)); + private readonly Dispatcher dispatcher; - return new DispatcherJoinableTaskFactory(joinableTaskFactory, dispatcher, priority); - } + /// + /// The priority with which to schedule work on the UI thread. + /// + private readonly DispatcherPriority priority; /// - /// A that schedules work on the UI thread - /// according to a given . + /// Initializes a new instance of the class. /// - private class DispatcherJoinableTaskFactory : DelegatingJoinableTaskFactory + /// The underlying to use when scheduling. + /// The to use for scheduling work on the UI thread. + /// The priority with which to schedule work on the UI thread. + internal DispatcherJoinableTaskFactory(JoinableTaskFactory innerFactory, Dispatcher dispatcher, DispatcherPriority priority) + : base(innerFactory) { - /// - /// The to use for scheduling work on the UI thread. - /// - private readonly Dispatcher dispatcher; - - /// - /// The priority with which to schedule work on the UI thread. - /// - private readonly DispatcherPriority priority; - - /// - /// Initializes a new instance of the class. - /// - /// The underlying to use when scheduling. - /// The to use for scheduling work on the UI thread. - /// The priority with which to schedule work on the UI thread. - internal DispatcherJoinableTaskFactory(JoinableTaskFactory innerFactory, Dispatcher dispatcher, DispatcherPriority priority) - : base(innerFactory) - { - this.dispatcher = dispatcher ?? throw new ArgumentNullException(nameof(dispatcher)); - this.priority = priority; - } + this.dispatcher = dispatcher ?? throw new ArgumentNullException(nameof(dispatcher)); + this.priority = priority; + } - /// - protected internal override void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) - { - this.dispatcher.BeginInvoke(this.priority, callback, state); - } + /// + protected internal override void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) + { + this.dispatcher.BeginInvoke(this.priority, callback, state); } } } diff --git a/src/Microsoft.VisualStudio.Threading/EmptyStruct.cs b/src/Microsoft.VisualStudio.Threading/EmptyStruct.cs index 23aa2ac31..2a08dbf21 100644 --- a/src/Microsoft.VisualStudio.Threading/EmptyStruct.cs +++ b/src/Microsoft.VisualStudio.Threading/EmptyStruct.cs @@ -1,22 +1,21 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An empty struct. +/// +/// +/// This can save 4 bytes over System.Object when a type argument is required for a generic type, but entirely unused. +/// +internal readonly struct EmptyStruct { /// - /// An empty struct. + /// Gets an instance of the empty struct. /// - /// - /// This can save 4 bytes over System.Object when a type argument is required for a generic type, but entirely unused. - /// - internal readonly struct EmptyStruct + internal static EmptyStruct Instance { - /// - /// Gets an instance of the empty struct. - /// - internal static EmptyStruct Instance - { - get { return default(EmptyStruct); } - } + get { return default(EmptyStruct); } } } diff --git a/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs b/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs index bc0c6ba39..4a1f12e48 100644 --- a/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs +++ b/src/Microsoft.VisualStudio.Threading/EnumerateOneOrMany`1.cs @@ -8,141 +8,140 @@ using System.Text; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Enumerates either a single element or a list of elements. +/// +/// The type of element to enumerate. +internal struct EnumerateOneOrMany : IEnumerator { /// - /// Enumerates either a single element or a list of elements. + /// The single element to enumerate, when applicable. /// - /// The type of element to enumerate. - internal struct EnumerateOneOrMany : IEnumerator - { - /// - /// The single element to enumerate, when applicable. - /// - [AllowNull, MaybeNull] - private T value; + [AllowNull, MaybeNull] + private T value; - /// - /// The enumerator of the list. - /// - private List.Enumerator enumerator; + /// + /// The enumerator of the list. + /// + private List.Enumerator enumerator; - /// - /// A value indicating whether a single element or a list of them is being enumerated. - /// - private bool justOne; + /// + /// A value indicating whether a single element or a list of them is being enumerated. + /// + private bool justOne; - /// - /// The position around the lone element being enumerated, when applicable. - /// - private int position; + /// + /// The position around the lone element being enumerated, when applicable. + /// + private int position; - /// - /// Initializes a new instance of the struct. - /// - /// The single value to enumerate. - internal EnumerateOneOrMany(T value) - { - this.value = value; - this.enumerator = default(List.Enumerator); - this.justOne = true; - this.position = -1; - } + /// + /// Initializes a new instance of the struct. + /// + /// The single value to enumerate. + internal EnumerateOneOrMany(T value) + { + this.value = value; + this.enumerator = default(List.Enumerator); + this.justOne = true; + this.position = -1; + } - /// - /// Initializes a new instance of the struct. - /// - /// The list of values to enumerate. - internal EnumerateOneOrMany(List values) - { - this.value = default(T)!; - this.enumerator = values.GetEnumerator(); - this.justOne = false; - this.position = 0; // N/A - } + /// + /// Initializes a new instance of the struct. + /// + /// The list of values to enumerate. + internal EnumerateOneOrMany(List values) + { + this.value = default(T)!; + this.enumerator = values.GetEnumerator(); + this.justOne = false; + this.position = 0; // N/A + } - /// - /// Gets the current value. - /// - public T Current + /// + /// Gets the current value. + /// + public T Current + { + get { - get + if (this.justOne) { - if (this.justOne) + if (this.position == 0) { - if (this.position == 0) - { - return this.value!; - } - else - { - throw new InvalidOperationException(); - } + return this.value!; } else { - return this.enumerator.Current; + throw new InvalidOperationException(); } } + else + { + return this.enumerator.Current; + } } + } - /// - /// Gets the current value. - /// - object? System.Collections.IEnumerator.Current - { - get { return this.Current; } - } + /// + /// Gets the current value. + /// + object? System.Collections.IEnumerator.Current + { + get { return this.Current; } + } - /// - /// Disposes this enumerator. - /// - public void Dispose() - { - this.enumerator.Dispose(); - } + /// + /// Disposes this enumerator. + /// + public void Dispose() + { + this.enumerator.Dispose(); + } - /// - /// Advances enumeration to the next element. - /// - public bool MoveNext() + /// + /// Advances enumeration to the next element. + /// + public bool MoveNext() + { + if (this.justOne) { - if (this.justOne) + if (this.position == -1) { - if (this.position == -1) - { - this.position = 0; - return true; - } - else if (this.position == 0) - { - this.position++; - return false; - } - else - { - return false; - } + this.position = 0; + return true; + } + else if (this.position == 0) + { + this.position++; + return false; } else { - return this.enumerator.MoveNext(); + return false; } } + else + { + return this.enumerator.MoveNext(); + } + } - /// - /// Resets this enumerator. - /// - void System.Collections.IEnumerator.Reset() + /// + /// Resets this enumerator. + /// + void System.Collections.IEnumerator.Reset() + { + if (this.justOne) { - if (this.justOne) - { - this.position = -1; - } - else - { - ((System.Collections.IEnumerator)this.enumerator).Reset(); - } + this.position = -1; + } + else + { + ((System.Collections.IEnumerator)this.enumerator).Reset(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs b/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs index a05e3a029..d017ea7db 100644 --- a/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs +++ b/src/Microsoft.VisualStudio.Threading/HangReportContribution.cs @@ -8,59 +8,58 @@ using System.Text; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A contribution to an aggregate hang report. +/// +public class HangReportContribution { /// - /// A contribution to an aggregate hang report. + /// Initializes a new instance of the class. /// - public class HangReportContribution + /// The content for the hang report. + /// The MIME type of the attached content. + /// The suggested filename of the content when it is attached in a report. + public HangReportContribution(string content, string? contentType, string? contentName) { - /// - /// Initializes a new instance of the class. - /// - /// The content for the hang report. - /// The MIME type of the attached content. - /// The suggested filename of the content when it is attached in a report. - public HangReportContribution(string content, string? contentType, string? contentName) - { - Requires.NotNull(content, nameof(content)); - this.Content = content; - this.ContentType = contentType; - this.ContentName = contentName; - } + Requires.NotNull(content, nameof(content)); + this.Content = content; + this.ContentType = contentType; + this.ContentName = contentName; + } - /// - /// Initializes a new instance of the class. - /// - /// The content for the hang report. - /// The MIME type of the attached content. - /// The suggested filename of the content when it is attached in a report. - /// Nested reports. - public HangReportContribution(string content, string? contentType, string? contentName, params HangReportContribution[]? nestedReports) - : this(content, contentType, contentName) - { - this.NestedReports = nestedReports; - } + /// + /// Initializes a new instance of the class. + /// + /// The content for the hang report. + /// The MIME type of the attached content. + /// The suggested filename of the content when it is attached in a report. + /// Nested reports. + public HangReportContribution(string content, string? contentType, string? contentName, params HangReportContribution[]? nestedReports) + : this(content, contentType, contentName) + { + this.NestedReports = nestedReports; + } - /// - /// Gets the content of the hang report. - /// - public string Content { get; private set; } + /// + /// Gets the content of the hang report. + /// + public string Content { get; private set; } - /// - /// Gets the MIME type for the content. - /// - public string? ContentType { get; private set; } + /// + /// Gets the MIME type for the content. + /// + public string? ContentType { get; private set; } - /// - /// Gets the suggested filename for the content. - /// - public string? ContentName { get; private set; } + /// + /// Gets the suggested filename for the content. + /// + public string? ContentName { get; private set; } - /// - /// Gets the nested hang reports, if any. - /// - /// A read only collection, or . - public IReadOnlyCollection? NestedReports { get; private set; } - } + /// + /// Gets the nested hang reports, if any. + /// + /// A read only collection, or . + public IReadOnlyCollection? NestedReports { get; private set; } } diff --git a/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs b/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs index 22e3a08b9..189ba04d1 100644 --- a/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs +++ b/src/Microsoft.VisualStudio.Threading/IAsyncDisposable.cs @@ -3,20 +3,19 @@ using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Defines an asynchronous method to release allocated resources. +/// +/// +/// Consider implementing instead. +/// +public interface IAsyncDisposable { /// - /// Defines an asynchronous method to release allocated resources. + /// Performs application-defined tasks associated with freeing, + /// releasing, or resetting unmanaged resources asynchronously. /// - /// - /// Consider implementing instead. - /// - public interface IAsyncDisposable - { - /// - /// Performs application-defined tasks associated with freeing, - /// releasing, or resetting unmanaged resources asynchronously. - /// - Task DisposeAsync(); - } + Task DisposeAsync(); } diff --git a/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs index 116e450fa..7c320ff33 100644 --- a/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs @@ -7,17 +7,16 @@ using System.Text; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Provides a facility to produce reports that may be useful when analyzing hangs. +/// +public interface IHangReportContributor { /// - /// Provides a facility to produce reports that may be useful when analyzing hangs. + /// Contributes data for a hang report. /// - public interface IHangReportContributor - { - /// - /// Contributes data for a hang report. - /// - /// The hang report contribution. Null values should be ignored. - HangReportContribution GetHangReport(); - } + /// The hang report contribution. Null values should be ignored. + HangReportContribution GetHangReport(); } diff --git a/src/Microsoft.VisualStudio.Threading/IJoinableTaskDependent.cs b/src/Microsoft.VisualStudio.Threading/IJoinableTaskDependent.cs index 2280bf3ae..5371cdaa2 100644 --- a/src/Microsoft.VisualStudio.Threading/IJoinableTaskDependent.cs +++ b/src/Microsoft.VisualStudio.Threading/IJoinableTaskDependent.cs @@ -1,46 +1,45 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Represents a dependent item in the JoinableTask dependency graph, it can be either a or a . +/// +internal interface IJoinableTaskDependent { /// - /// Represents a dependent item in the JoinableTask dependency graph, it can be either a or a . + /// Gets the this node belongs to. + /// + JoinableTaskContext JoinableTaskContext { get; } + + /// + /// Gets a value indicating whether we need reference count child dependent node. This is to keep the current behavior of . + /// + bool NeedRefCountChildDependencies { get; } + + /// + /// Get the reference of dependent node to record dependencies. + /// + ref JoinableTaskDependencyGraph.JoinableTaskDependentData GetJoinableTaskDependentData(); + + /// + /// A function is called, when this dependent node is added to be a dependency of a parent node. + /// + void OnAddedToDependency(IJoinableTaskDependent parent); + + /// + /// A function is called, when this dependent node is removed as a dependency of a parent node. + /// + void OnRemovedFromDependency(IJoinableTaskDependent parentNode); + + /// + /// A function is called, when a dependent child is added. + /// + void OnDependencyAdded(IJoinableTaskDependent joinChild); + + /// + /// A function is called, when a dependent child is removed. /// - internal interface IJoinableTaskDependent - { - /// - /// Gets the this node belongs to. - /// - JoinableTaskContext JoinableTaskContext { get; } - - /// - /// Gets a value indicating whether we need reference count child dependent node. This is to keep the current behavior of . - /// - bool NeedRefCountChildDependencies { get; } - - /// - /// Get the reference of dependent node to record dependencies. - /// - ref JoinableTaskDependencyGraph.JoinableTaskDependentData GetJoinableTaskDependentData(); - - /// - /// A function is called, when this dependent node is added to be a dependency of a parent node. - /// - void OnAddedToDependency(IJoinableTaskDependent parent); - - /// - /// A function is called, when this dependent node is removed as a dependency of a parent node. - /// - void OnRemovedFromDependency(IJoinableTaskDependent parentNode); - - /// - /// A function is called, when a dependent child is added. - /// - void OnDependencyAdded(IJoinableTaskDependent joinChild); - - /// - /// A function is called, when a dependent child is removed. - /// - void OnDependencyRemoved(IJoinableTaskDependent joinChild); - } + void OnDependencyRemoved(IJoinableTaskDependent joinChild); } diff --git a/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs b/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs index e92cc638a..3d52226b7 100644 --- a/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs +++ b/src/Microsoft.VisualStudio.Threading/IllegalSemaphoreUsageException.cs @@ -4,19 +4,18 @@ using System; using System.Globalization; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Exception which is thrown when the contract of a is violated. +/// +public class IllegalSemaphoreUsageException : InvalidOperationException { /// - /// Exception which is thrown when the contract of a is violated. + /// Initializes a new instance of the class. /// - public class IllegalSemaphoreUsageException : InvalidOperationException + public IllegalSemaphoreUsageException(string message) + : base(message) { - /// - /// Initializes a new instance of the class. - /// - public IllegalSemaphoreUsageException(string message) - : base(message) - { - } } } diff --git a/src/Microsoft.VisualStudio.Threading/InlineResumable.cs b/src/Microsoft.VisualStudio.Threading/InlineResumable.cs index 4abd5bc56..2a7f83013 100644 --- a/src/Microsoft.VisualStudio.Threading/InlineResumable.cs +++ b/src/Microsoft.VisualStudio.Threading/InlineResumable.cs @@ -5,86 +5,85 @@ using System.Runtime.CompilerServices; using System.Threading; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An awaiter that can be pre-created, and later immediately execute its one scheduled continuation. +/// +internal class InlineResumable : ICriticalNotifyCompletion { /// - /// An awaiter that can be pre-created, and later immediately execute its one scheduled continuation. + /// The continuation that has been scheduled. /// - internal class InlineResumable : ICriticalNotifyCompletion - { - /// - /// The continuation that has been scheduled. - /// - private Action? continuation; + private Action? continuation; - /// - /// The current as of when the continuation was scheduled. - /// - private SynchronizationContext? capturedSynchronizationContext; + /// + /// The current as of when the continuation was scheduled. + /// + private SynchronizationContext? capturedSynchronizationContext; - /// - /// Whether has been called already. - /// - private bool resumed; + /// + /// Whether has been called already. + /// + private bool resumed; - /// - /// Gets a value indicating whether an awaiting expression should yield. - /// - /// Always . - public bool IsCompleted => this.resumed; + /// + /// Gets a value indicating whether an awaiting expression should yield. + /// + /// Always . + public bool IsCompleted => this.resumed; - /// - /// Does and returns nothing. - /// - public void GetResult() - { - } + /// + /// Does and returns nothing. + /// + public void GetResult() + { + } - /// - /// Stores the continuation for later execution when is invoked. - /// - /// The delegate to execute later. - public void OnCompleted(Action continuation) - { - Requires.NotNull(continuation, nameof(continuation)); - Assumes.Null(this.continuation); // Only one continuation is supported. + /// + /// Stores the continuation for later execution when is invoked. + /// + /// The delegate to execute later. + public void OnCompleted(Action continuation) + { + Requires.NotNull(continuation, nameof(continuation)); + Assumes.Null(this.continuation); // Only one continuation is supported. - this.capturedSynchronizationContext = SynchronizationContext.Current; - this.continuation = continuation; - } + this.capturedSynchronizationContext = SynchronizationContext.Current; + this.continuation = continuation; + } - /// - /// Stores the continuation for later execution when is invoked. - /// - /// The delegate to execute later. - public void UnsafeOnCompleted(Action continuation) - { - // We don't capture ExecutionContext even in the normal path - // as this is a very special case and internal awaiter. - // Strictly speaking, we don't have to implement ICriticalNotifyCompletion, - // but by implementing it, we show that we don't capture context and avoid - // code audits later from spending time asking why this awaiter isn't so optimized. - this.OnCompleted(continuation); - } + /// + /// Stores the continuation for later execution when is invoked. + /// + /// The delegate to execute later. + public void UnsafeOnCompleted(Action continuation) + { + // We don't capture ExecutionContext even in the normal path + // as this is a very special case and internal awaiter. + // Strictly speaking, we don't have to implement ICriticalNotifyCompletion, + // but by implementing it, we show that we don't capture context and avoid + // code audits later from spending time asking why this awaiter isn't so optimized. + this.OnCompleted(continuation); + } - /// - /// Gets this instance. This method makes this awaiter double as its own awaitable. - /// - /// This instance. - public InlineResumable GetAwaiter() => this; + /// + /// Gets this instance. This method makes this awaiter double as its own awaitable. + /// + /// This instance. + public InlineResumable GetAwaiter() => this; - /// - /// Executes the continuation immediately, on the caller's thread. - /// - public void Resume() + /// + /// Executes the continuation immediately, on the caller's thread. + /// + public void Resume() + { + this.resumed = true; + Action? continuation = this.continuation; + this.continuation = null; + using (this.capturedSynchronizationContext.Apply()) { - this.resumed = true; - Action? continuation = this.continuation; - this.continuation = null; - using (this.capturedSynchronizationContext.Apply()) - { - continuation?.Invoke(); - } + continuation?.Invoke(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs index fd0327068..61ad43124 100644 --- a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs +++ b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs @@ -10,280 +10,279 @@ using System.Runtime.CompilerServices; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Internal helper/extension methods for this assembly's own use. +/// +internal static class InternalUtilities { /// - /// Internal helper/extension methods for this assembly's own use. + /// The substring that should be inserted before each async return stack frame. + /// + /// + /// When printing synchronous callstacks, .NET begins each frame with " at ". + /// When printing async return stack, we use this to indicate continuations. + /// + private const string AsyncReturnStackPrefix = " -> "; + + /// + /// Removes an element from the middle of a queue without disrupting the other elements. /// - internal static class InternalUtilities + /// The element to remove. + /// The queue to modify. + /// The value to remove. + /// + /// If a value appears multiple times in the queue, only its first entry is removed. + /// + internal static bool RemoveMidQueue(this Queue queue, T valueToRemove) + where T : class { - /// - /// The substring that should be inserted before each async return stack frame. - /// - /// - /// When printing synchronous callstacks, .NET begins each frame with " at ". - /// When printing async return stack, we use this to indicate continuations. - /// - private const string AsyncReturnStackPrefix = " -> "; - - /// - /// Removes an element from the middle of a queue without disrupting the other elements. - /// - /// The element to remove. - /// The queue to modify. - /// The value to remove. - /// - /// If a value appears multiple times in the queue, only its first entry is removed. - /// - internal static bool RemoveMidQueue(this Queue queue, T valueToRemove) - where T : class - { - Requires.NotNull(queue, nameof(queue)); - Requires.NotNull(valueToRemove, nameof(valueToRemove)); + Requires.NotNull(queue, nameof(queue)); + Requires.NotNull(valueToRemove, nameof(valueToRemove)); - int originalCount = queue.Count; - int dequeueCounter = 0; - bool found = false; - while (dequeueCounter < originalCount) + int originalCount = queue.Count; + int dequeueCounter = 0; + bool found = false; + while (dequeueCounter < originalCount) + { + dequeueCounter++; + T dequeued = queue.Dequeue(); + if (!found && dequeued == valueToRemove) + { // only find 1 match + found = true; + } + else { - dequeueCounter++; - T dequeued = queue.Dequeue(); - if (!found && dequeued == valueToRemove) - { // only find 1 match - found = true; - } - else - { - queue.Enqueue(dequeued); - } + queue.Enqueue(dequeued); } + } - return found; + return found; + } + + /// + /// Walk the continuation objects inside "async state machines" to generate the return callstack. + /// FOR DIAGNOSTIC PURPOSES ONLY. + /// + /// The delegate that represents the head of an async continuation chain. + internal static IEnumerable GetAsyncReturnStackFrames(this Delegate continuationDelegate) + { + IAsyncStateMachine? stateMachine = FindAsyncStateMachine(continuationDelegate); + if (stateMachine is null) + { + // Did not find the async state machine, so returns the method name as top frame and stop walking. + yield return GetDelegateLabel(continuationDelegate); + yield break; } - /// - /// Walk the continuation objects inside "async state machines" to generate the return callstack. - /// FOR DIAGNOSTIC PURPOSES ONLY. - /// - /// The delegate that represents the head of an async continuation chain. - internal static IEnumerable GetAsyncReturnStackFrames(this Delegate continuationDelegate) + do { - IAsyncStateMachine? stateMachine = FindAsyncStateMachine(continuationDelegate); - if (stateMachine is null) + var state = GetStateMachineFieldValueOnSuffix(stateMachine, "__state"); + yield return string.Format( + CultureInfo.CurrentCulture, + "{2}{0} (state: {1}, address: 0x{3:X8})", + stateMachine.GetType().FullName, + state, + AsyncReturnStackPrefix, + (int)GetAddress(stateMachine)); // the int cast allows hex formatting + + Delegate[]? continuationDelegates = FindContinuationDelegates(stateMachine).ToArray(); + if (continuationDelegates.Length == 0) { - // Did not find the async state machine, so returns the method name as top frame and stop walking. - yield return GetDelegateLabel(continuationDelegate); - yield break; + break; } - do + // Consider: It's possible but uncommon scenario to have multiple "async methods" being awaiting for one "async method". + // Here we just choose the first awaiting "async method" as that should be good enough for postmortem. + // In future we might want to revisit this to cover the other awaiting "async methods". + stateMachine = continuationDelegates.Select((d) => FindAsyncStateMachine(d)) + .FirstOrDefault((s) => s is object); + if (stateMachine is null) { - var state = GetStateMachineFieldValueOnSuffix(stateMachine, "__state"); - yield return string.Format( - CultureInfo.CurrentCulture, - "{2}{0} (state: {1}, address: 0x{3:X8})", - stateMachine.GetType().FullName, - state, - AsyncReturnStackPrefix, - (int)GetAddress(stateMachine)); // the int cast allows hex formatting - - Delegate[]? continuationDelegates = FindContinuationDelegates(stateMachine).ToArray(); - if (continuationDelegates.Length == 0) - { - break; - } - - // Consider: It's possible but uncommon scenario to have multiple "async methods" being awaiting for one "async method". - // Here we just choose the first awaiting "async method" as that should be good enough for postmortem. - // In future we might want to revisit this to cover the other awaiting "async methods". - stateMachine = continuationDelegates.Select((d) => FindAsyncStateMachine(d)) - .FirstOrDefault((s) => s is object); - if (stateMachine is null) - { - yield return GetDelegateLabel(continuationDelegates.First()); - } + yield return GetDelegateLabel(continuationDelegates.First()); } - while (stateMachine is object); } + while (stateMachine is object); + } - /// - /// A helper method to get the label of the given delegate. - /// - private static string GetDelegateLabel(Delegate invokeDelegate) - { - Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); + /// + /// A helper method to get the label of the given delegate. + /// + private static string GetDelegateLabel(Delegate invokeDelegate) + { + Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); - MethodInfo? method = invokeDelegate.GetMethodInfo(); - if (invokeDelegate.Target is object) + MethodInfo? method = invokeDelegate.GetMethodInfo(); + if (invokeDelegate.Target is object) + { + string instanceType = string.Empty; + if (!(method?.DeclaringType?.Equals(invokeDelegate.Target.GetType()) ?? false)) { - string instanceType = string.Empty; - if (!(method?.DeclaringType?.Equals(invokeDelegate.Target.GetType()) ?? false)) - { - instanceType = " (" + invokeDelegate.Target.GetType().FullName + ")"; - } - - return string.Format( - CultureInfo.CurrentCulture, - "{3}{0}.{1}{2} (target address: 0x{4:X" + (IntPtr.Size * 2) + "})", - method?.DeclaringType?.FullName, - method?.Name, - instanceType, - AsyncReturnStackPrefix, - GetAddress(invokeDelegate.Target).ToInt64()); // the cast allows hex formatting + instanceType = " (" + invokeDelegate.Target.GetType().FullName + ")"; } return string.Format( CultureInfo.CurrentCulture, - "{2}{0}.{1}", + "{3}{0}.{1}{2} (target address: 0x{4:X" + (IntPtr.Size * 2) + "})", method?.DeclaringType?.FullName, method?.Name, - AsyncReturnStackPrefix); + instanceType, + AsyncReturnStackPrefix, + GetAddress(invokeDelegate.Target).ToInt64()); // the cast allows hex formatting } - /// - /// Gets the memory address of a given object. - /// - /// The object to get the address for. - /// The memory address. - /// - /// This method works when GCHandle will refuse because the type of object is a non-blittable type. - /// However, this method provides no guarantees that the address will remain valid for the caller, - /// so it is only useful for diagnostics and when we don't expect addresses to be changing much any more. - /// - private static unsafe IntPtr GetAddress(object value) => new IntPtr(Unsafe.AsPointer(ref value)); - - /// - /// A helper method to find the async state machine from the given delegate. - /// - private static IAsyncStateMachine? FindAsyncStateMachine(Delegate invokeDelegate) - { - Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); + return string.Format( + CultureInfo.CurrentCulture, + "{2}{0}.{1}", + method?.DeclaringType?.FullName, + method?.Name, + AsyncReturnStackPrefix); + } + + /// + /// Gets the memory address of a given object. + /// + /// The object to get the address for. + /// The memory address. + /// + /// This method works when GCHandle will refuse because the type of object is a non-blittable type. + /// However, this method provides no guarantees that the address will remain valid for the caller, + /// so it is only useful for diagnostics and when we don't expect addresses to be changing much any more. + /// + private static unsafe IntPtr GetAddress(object value) => new IntPtr(Unsafe.AsPointer(ref value)); + + /// + /// A helper method to find the async state machine from the given delegate. + /// + private static IAsyncStateMachine? FindAsyncStateMachine(Delegate invokeDelegate) + { + Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); - if (invokeDelegate.Target is object) + if (invokeDelegate.Target is object) + { + // Some delegates are wrapped with a ContinuationWrapper object. We have to unwrap that in those cases. + // In testing, this m_continuation field jump is only required when the debugger is attached -- weird. + // I suspect however that it's a natural behavior of the async state machine (when there are >1 continuations perhaps). + // So we check for the case in all cases. + if (GetFieldValue(invokeDelegate.Target, "m_continuation") is Action continuation) { - // Some delegates are wrapped with a ContinuationWrapper object. We have to unwrap that in those cases. - // In testing, this m_continuation field jump is only required when the debugger is attached -- weird. - // I suspect however that it's a natural behavior of the async state machine (when there are >1 continuations perhaps). - // So we check for the case in all cases. - if (GetFieldValue(invokeDelegate.Target, "m_continuation") is Action continuation) + invokeDelegate = continuation; + if (invokeDelegate.Target is null) { - invokeDelegate = continuation; - if (invokeDelegate.Target is null) - { - return null; - } + return null; } - - var stateMachine = GetFieldValue(invokeDelegate.Target, "m_stateMachine") as IAsyncStateMachine; - return stateMachine; } - return null; + var stateMachine = GetFieldValue(invokeDelegate.Target, "m_stateMachine") as IAsyncStateMachine; + return stateMachine; } - /// - /// This is the core to find the continuation delegate(s) inside the given async state machine. - /// The chain of objects is like this: async state machine -> async method builder -> task -> continuation object -> action. - /// - /// - /// There are 3 types of "async method builder": AsyncVoidMethodBuilder, AsyncTaskMethodBuilder, AsyncTaskMethodBuilder<T>. - /// We don't cover AsyncVoidMethodBuilder as it is used rarely and it can't be awaited either; - /// AsyncTaskMethodBuilder is a wrapper on top of AsyncTaskMethodBuilder<VoidTaskResult>. - /// - private static IEnumerable FindContinuationDelegates(IAsyncStateMachine stateMachine) - { - Requires.NotNull(stateMachine, nameof(stateMachine)); + return null; + } - var builder = GetStateMachineFieldValueOnSuffix(stateMachine, "__builder"); - if (builder is null) - { - yield break; - } + /// + /// This is the core to find the continuation delegate(s) inside the given async state machine. + /// The chain of objects is like this: async state machine -> async method builder -> task -> continuation object -> action. + /// + /// + /// There are 3 types of "async method builder": AsyncVoidMethodBuilder, AsyncTaskMethodBuilder, AsyncTaskMethodBuilder<T>. + /// We don't cover AsyncVoidMethodBuilder as it is used rarely and it can't be awaited either; + /// AsyncTaskMethodBuilder is a wrapper on top of AsyncTaskMethodBuilder<VoidTaskResult>. + /// + private static IEnumerable FindContinuationDelegates(IAsyncStateMachine stateMachine) + { + Requires.NotNull(stateMachine, nameof(stateMachine)); - var task = GetFieldValue(builder, "m_task"); - if (task is null) - { - // Probably this builder is an instance of "AsyncTaskMethodBuilder", so we need to get its inner "AsyncTaskMethodBuilder" - builder = GetFieldValue(builder, "m_builder"); - if (builder is object) - { - task = GetFieldValue(builder, "m_task"); - } - } + var builder = GetStateMachineFieldValueOnSuffix(stateMachine, "__builder"); + if (builder is null) + { + yield break; + } - if (task is null) + var task = GetFieldValue(builder, "m_task"); + if (task is null) + { + // Probably this builder is an instance of "AsyncTaskMethodBuilder", so we need to get its inner "AsyncTaskMethodBuilder" + builder = GetFieldValue(builder, "m_builder"); + if (builder is object) { - yield break; + task = GetFieldValue(builder, "m_task"); } + } - // "task" might be an instance of the type deriving from "Task", but "m_continuationObject" is a private field in "Task", - // so we need to use "typeof(Task)" to access "m_continuationObject". - FieldInfo? continuationField = typeof(Task).GetTypeInfo().GetDeclaredField("m_continuationObject"); - if (continuationField is null) - { - yield break; - } + if (task is null) + { + yield break; + } - var continuationObject = continuationField.GetValue(task); - if (continuationObject is null) - { - yield break; - } + // "task" might be an instance of the type deriving from "Task", but "m_continuationObject" is a private field in "Task", + // so we need to use "typeof(Task)" to access "m_continuationObject". + FieldInfo? continuationField = typeof(Task).GetTypeInfo().GetDeclaredField("m_continuationObject"); + if (continuationField is null) + { + yield break; + } - if (continuationObject is IEnumerable items) - { - foreach (var item in items) - { - Delegate? action = item as Delegate ?? GetFieldValue(item!, "m_action") as Delegate; - if (action is object) - { - yield return action; - } - } - } - else + var continuationObject = continuationField.GetValue(task); + if (continuationObject is null) + { + yield break; + } + + if (continuationObject is IEnumerable items) + { + foreach (var item in items) { - Delegate? action = continuationObject as Delegate ?? GetFieldValue(continuationObject, "m_action") as Delegate; + Delegate? action = item as Delegate ?? GetFieldValue(item!, "m_action") as Delegate; if (action is object) { yield return action; } } } - - /// - /// A helper method to get field's value given the object and the field name. - /// - private static object? GetFieldValue(object obj, string fieldName) + else { - Requires.NotNull(obj, nameof(obj)); - Requires.NotNullOrEmpty(fieldName, nameof(fieldName)); - - FieldInfo? field = obj.GetType().GetTypeInfo().GetDeclaredField(fieldName); - if (field is object) + Delegate? action = continuationObject as Delegate ?? GetFieldValue(continuationObject, "m_action") as Delegate; + if (action is object) { - return field.GetValue(obj); + yield return action; } - - return null; } + } + + /// + /// A helper method to get field's value given the object and the field name. + /// + private static object? GetFieldValue(object obj, string fieldName) + { + Requires.NotNull(obj, nameof(obj)); + Requires.NotNullOrEmpty(fieldName, nameof(fieldName)); - /// - /// The field names of "async state machine" are not fixed; the workaround is to find the field based on the suffix. - /// - private static object? GetStateMachineFieldValueOnSuffix(IAsyncStateMachine stateMachine, string suffix) + FieldInfo? field = obj.GetType().GetTypeInfo().GetDeclaredField(fieldName); + if (field is object) { - Requires.NotNull(stateMachine, nameof(stateMachine)); - Requires.NotNullOrEmpty(suffix, nameof(suffix)); + return field.GetValue(obj); + } - IEnumerable? fields = stateMachine.GetType().GetTypeInfo().DeclaredFields; - FieldInfo? field = fields.FirstOrDefault((f) => f.Name.EndsWith(suffix, StringComparison.Ordinal)); - if (field is object) - { - return field.GetValue(stateMachine); - } + return null; + } - return null; + /// + /// The field names of "async state machine" are not fixed; the workaround is to find the field based on the suffix. + /// + private static object? GetStateMachineFieldValueOnSuffix(IAsyncStateMachine stateMachine, string suffix) + { + Requires.NotNull(stateMachine, nameof(stateMachine)); + Requires.NotNullOrEmpty(suffix, nameof(suffix)); + + IEnumerable? fields = stateMachine.GetType().GetTypeInfo().DeclaredFields; + FieldInfo? field = fields.FirstOrDefault((f) => f.Name.EndsWith(suffix, StringComparison.Ordinal)); + if (field is object) + { + return field.GetValue(stateMachine); } + + return null; } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs index 59791eecf..097159a60 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+ExecutionQueue.cs @@ -8,84 +8,83 @@ using System.Threading.Tasks; using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +public partial class JoinableTask { - public partial class JoinableTask + /// + /// A thread-safe queue of elements + /// that self-scavenges elements that are executed by other means. + /// + internal class ExecutionQueue : AsyncQueue { - /// - /// A thread-safe queue of elements - /// that self-scavenges elements that are executed by other means. - /// - internal class ExecutionQueue : AsyncQueue + private readonly JoinableTask owningJob; + + internal ExecutionQueue(JoinableTask owningJob) { - private readonly JoinableTask owningJob; + Requires.NotNull(owningJob, nameof(owningJob)); + this.owningJob = owningJob; + } - internal ExecutionQueue(JoinableTask owningJob) - { - Requires.NotNull(owningJob, nameof(owningJob)); - this.owningJob = owningJob; - } + protected override int InitialCapacity + { + get { return 1; } // in non-concurrent cases, 1 is sufficient. + } - protected override int InitialCapacity - { - get { return 1; } // in non-concurrent cases, 1 is sufficient. - } + internal void OnExecuting(object sender, EventArgs e) + { + this.Scavenge(); + } - internal void OnExecuting(object sender, EventArgs e) - { - this.Scavenge(); - } + protected override void OnEnqueued(SingleExecuteProtector value, bool alreadyDispatched) + { + base.OnEnqueued(value, alreadyDispatched); - protected override void OnEnqueued(SingleExecuteProtector value, bool alreadyDispatched) + // We only need to consider scavenging our queue if this item was + // actually added to the queue. + if (!alreadyDispatched) { - base.OnEnqueued(value, alreadyDispatched); + Requires.NotNull(value, nameof(value)); + value.AddExecutingCallback(this); - // We only need to consider scavenging our queue if this item was - // actually added to the queue. - if (!alreadyDispatched) + // It's possible this value has already been executed + // (before our event wire-up was applied). So check and + // scavenge. + if (value.HasBeenExecuted) { - Requires.NotNull(value, nameof(value)); - value.AddExecutingCallback(this); - - // It's possible this value has already been executed - // (before our event wire-up was applied). So check and - // scavenge. - if (value.HasBeenExecuted) - { - this.Scavenge(); - } + this.Scavenge(); } } + } - protected override void OnDequeued(SingleExecuteProtector value) - { - Requires.NotNull(value, nameof(value)); + protected override void OnDequeued(SingleExecuteProtector value) + { + Requires.NotNull(value, nameof(value)); - base.OnDequeued(value); - value.RemoveExecutingCallback(this); - } + base.OnDequeued(value); + value.RemoveExecutingCallback(this); + } - protected override void OnCompleted() - { - base.OnCompleted(); + protected override void OnCompleted() + { + base.OnCompleted(); - if ((this.owningJob.state & JoinableTaskFlags.CompleteFinalized) != JoinableTaskFlags.CompleteFinalized) + if ((this.owningJob.state & JoinableTaskFlags.CompleteFinalized) != JoinableTaskFlags.CompleteFinalized) + { + using (this.owningJob.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - using (this.owningJob.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.owningJob.JoinableTaskContext.SyncContextLock) { - lock (this.owningJob.JoinableTaskContext.SyncContextLock) - { - this.owningJob.OnQueueCompleted(); - } + this.owningJob.OnQueueCompleted(); } } } + } - private void Scavenge() + private void Scavenge() + { + while (this.TryDequeue(p => p.HasBeenExecuted, out SingleExecuteProtector? stale)) { - while (this.TryDequeue(p => p.HasBeenExecuted, out SingleExecuteProtector? stale)) - { - } } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 3d19dfd4d..cd65c018b 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -14,1234 +14,1233 @@ using JoinRelease = Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease; using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Tracks asynchronous operations and provides the ability to Join those operations to avoid +/// deadlocks while synchronously blocking the Main thread for the operation's completion. +/// +/// +/// For more complete comments please see the . +/// +[DebuggerDisplay("IsCompleted: {IsCompleted}, Method = {EntryMethodInfo != null ? EntryMethodInfo.Name : null}")] +public partial class JoinableTask : IJoinableTaskDependent { /// - /// Tracks asynchronous operations and provides the ability to Join those operations to avoid - /// deadlocks while synchronously blocking the Main thread for the operation's completion. + /// Stores the top-most JoinableTask that is completing on the current thread, if any. /// - /// - /// For more complete comments please see the . - /// - [DebuggerDisplay("IsCompleted: {IsCompleted}, Method = {EntryMethodInfo != null ? EntryMethodInfo.Name : null}")] - public partial class JoinableTask : IJoinableTaskDependent - { - /// - /// Stores the top-most JoinableTask that is completing on the current thread, if any. - /// - private static readonly ThreadLocal CompletingTask = new ThreadLocal(); + private static readonly ThreadLocal CompletingTask = new ThreadLocal(); - /// - /// The that began the async operation. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private readonly JoinableTaskFactory owner; + /// + /// The that began the async operation. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private readonly JoinableTaskFactory owner; - /// - /// Store the task's initial creationOptions. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private readonly JoinableTaskCreationOptions creationOptions; + /// + /// Store the task's initial creationOptions. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private readonly JoinableTaskCreationOptions creationOptions; - /// - /// Other instances of that should be posted - /// to with any main thread bound work. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private ListOfOftenOne nestingFactories; + /// + /// Other instances of that should be posted + /// to with any main thread bound work. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private ListOfOftenOne nestingFactories; - /// - /// The to track dependencies between tasks. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private JoinableTaskDependencyGraph.JoinableTaskDependentData dependentData; + /// + /// The to track dependencies between tasks. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private JoinableTaskDependencyGraph.JoinableTaskDependentData dependentData; - /// - /// The collections that this job is a member of. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private RarelyRemoveItemSet dependencyParents; + /// + /// The collections that this job is a member of. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private RarelyRemoveItemSet dependencyParents; - /// - /// The returned by the async delegate that this JoinableTask originally executed, - /// or a if the property was observed before - /// had given us a Task. - /// - /// - /// This is until after returns a (or the property is observed), - /// and retains its value even after this JoinableTask completes. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private object? wrappedTask; + /// + /// The returned by the async delegate that this JoinableTask originally executed, + /// or a if the property was observed before + /// had given us a Task. + /// + /// + /// This is until after returns a (or the property is observed), + /// and retains its value even after this JoinableTask completes. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private object? wrappedTask; - /// - /// An event that is signaled when any queue in the dependent has item to process. Lazily constructed. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private AsyncManualResetEvent? queueNeedProcessEvent; + /// + /// An event that is signaled when any queue in the dependent has item to process. Lazily constructed. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private AsyncManualResetEvent? queueNeedProcessEvent; - /// - /// The is triggered by this JoinableTask, this allows a quick access to the event. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private WeakReference? pendingEventSource; + /// + /// The is triggered by this JoinableTask, this allows a quick access to the event. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private WeakReference? pendingEventSource; - /// - /// The uplimit of the number pending events. The real number can be less because dependency can be removed, or a pending event can be processed. - /// The number is critical, so it should only be updated in the lock region. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private int pendingEventCount; + /// + /// The uplimit of the number pending events. The real number can be less because dependency can be removed, or a pending event can be processed. + /// The number is critical, so it should only be updated in the lock region. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private int pendingEventCount; - /// The queue of work items. Lazily constructed. - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private ExecutionQueue? mainThreadQueue; + /// The queue of work items. Lazily constructed. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private ExecutionQueue? mainThreadQueue; - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private ExecutionQueue? threadPoolQueue; + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private ExecutionQueue? threadPoolQueue; - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private volatile JoinableTaskFlags state; + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private volatile JoinableTaskFlags state; - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private JoinableTaskSynchronizationContext? mainThreadJobSyncContext; + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private JoinableTaskSynchronizationContext? mainThreadJobSyncContext; - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private JoinableTaskSynchronizationContext? threadPoolJobSyncContext; + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private JoinableTaskSynchronizationContext? threadPoolJobSyncContext; - /// - /// Stores the task's initial delegate so we could show its full name in hang report. - /// This may not *actually* be the real delegate that was invoked for this instance, but - /// it's the meaningful one that should be shown in hang reports. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private Delegate? initialDelegate; + /// + /// Stores the task's initial delegate so we could show its full name in hang report. + /// This may not *actually* be the real delegate that was invoked for this instance, but + /// it's the meaningful one that should be shown in hang reports. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private Delegate? initialDelegate; - /// - /// Backing field for the property. - /// - private WeakReference? weakSelf; + /// + /// Backing field for the property. + /// + private WeakReference? weakSelf; - /// - /// Initializes a new instance of the class. - /// - /// The instance that began the async operation. - /// A value indicating whether the launching thread will synchronously block for this job's completion. - /// The used to customize the task's behavior. - /// The entry method's info for diagnostics. - internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate initialDelegate) + /// + /// Initializes a new instance of the class. + /// + /// The instance that began the async operation. + /// A value indicating whether the launching thread will synchronously block for this job's completion. + /// The used to customize the task's behavior. + /// The entry method's info for diagnostics. + internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate initialDelegate) + { + Requires.NotNull(owner, nameof(owner)); + + this.owner = owner; + if (synchronouslyBlocking) { - Requires.NotNull(owner, nameof(owner)); + this.state |= JoinableTaskFlags.StartedSynchronously | JoinableTaskFlags.CompletingSynchronously; + } - this.owner = owner; + if (owner.Context.IsOnMainThread) + { + this.state |= JoinableTaskFlags.StartedOnMainThread; if (synchronouslyBlocking) { - this.state |= JoinableTaskFlags.StartedSynchronously | JoinableTaskFlags.CompletingSynchronously; - } - - if (owner.Context.IsOnMainThread) - { - this.state |= JoinableTaskFlags.StartedOnMainThread; - if (synchronouslyBlocking) - { - this.state |= JoinableTaskFlags.SynchronouslyBlockingMainThread; - } + this.state |= JoinableTaskFlags.SynchronouslyBlockingMainThread; } - - this.creationOptions = creationOptions; - this.owner.Context.OnJoinableTaskStarted(this); - this.initialDelegate = initialDelegate; } - [Flags] - internal enum JoinableTaskFlags - { - /// - /// No other flags defined. - /// - None = 0x0, - - /// - /// This task was originally started as a synchronously executing one. - /// - StartedSynchronously = 0x1, - - /// - /// This task was originally started on the main thread. - /// - StartedOnMainThread = 0x2, - - /// - /// This task has had its Complete method called, but may have lingering continuations to execute. - /// - CompleteRequested = 0x4, - - /// - /// This task has completed. - /// - CompleteFinalized = 0x8, - - /// - /// This exact task has been passed to the method. - /// - CompletingSynchronously = 0x10, - - /// - /// This exact task has been passed to the method - /// on the main thread. - /// - SynchronouslyBlockingMainThread = 0x20, - } + this.creationOptions = creationOptions; + this.owner.Context.OnJoinableTaskStarted(this); + this.initialDelegate = initialDelegate; + } + [Flags] + internal enum JoinableTaskFlags + { /// - /// Gets a value indicating whether the async operation represented by this instance has completed, - /// as represented by its property's value. + /// No other flags defined. /// - public bool IsCompleted => this.IsCompleteRequested; + None = 0x0, /// - /// Gets the asynchronous task that completes when the async operation completes. + /// This task was originally started as a synchronously executing one. /// - public Task Task - { - get - { - if (this.wrappedTask is null) - { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) - { - lock (this.JoinableTaskContext.SyncContextLock) - { - if (this.wrappedTask is null) - { - // We'd rather not do this. The field is assigned elsewhere later on if we haven't hit this first. - // But some caller needs a Task that we don't yet have, so we have to spin one up. - this.wrappedTask = this.CreateTaskCompletionSource(); - } - } - } - } - - // Read 'wrappedTask' once to a local variable. Since this read occurs outside a lock, we need to ensure - // that writes to the field between the 'Task' type check and the call to 'GetTaskFromCompletionSource' - // do not result in passing the wrong object type to the latter (which would result in an - // InvalidCastException). - var wrappedTask = this.wrappedTask; - return wrappedTask as Task ?? this.GetTaskFromCompletionSource(wrappedTask); - } - } + StartedSynchronously = 0x1, - JoinableTaskContext IJoinableTaskDependent.JoinableTaskContext => this.JoinableTaskContext; + /// + /// This task was originally started on the main thread. + /// + StartedOnMainThread = 0x2, - bool IJoinableTaskDependent.NeedRefCountChildDependencies => true; + /// + /// This task has had its Complete method called, but may have lingering continuations to execute. + /// + CompleteRequested = 0x4, /// - /// Gets the JoinableTask that is completing (i.e. synchronously blocking) on this thread, nearest to the top of the callstack. + /// This task has completed. /// - /// - /// This property is intentionally non-public to avoid its abuse by outside callers. - /// - internal static JoinableTask? TaskCompletingOnThisThread - { - get { return CompletingTask.Value; } - } + CompleteFinalized = 0x8, /// - /// Gets a value indicating whether an awaiter should capture the - /// . + /// This exact task has been passed to the method. /// - /// - /// As a library, we generally wouldn't capture the - /// when awaiting, except that where our thread is synchronously blocking anyway, it is actually - /// more efficient to capture the so that the continuation - /// will resume on the blocking thread instead of occupying yet another one in order to execute. - /// In fact, when threadpool starvation conditions exist, resuming on the calling thread - /// can avoid significant delays in executing an often trivial continuation. - /// - internal static bool AwaitShouldCaptureSyncContext => SynchronizationContext.Current is JoinableTaskSynchronizationContext; + CompletingSynchronously = 0x10, /// - /// Gets a value indicating whether the async operation and any extra queues tracked by this instance has completed. + /// This exact task has been passed to the method + /// on the main thread. /// - internal bool IsFullyCompleted + SynchronouslyBlockingMainThread = 0x20, + } + + /// + /// Gets a value indicating whether the async operation represented by this instance has completed, + /// as represented by its property's value. + /// + public bool IsCompleted => this.IsCompleteRequested; + + /// + /// Gets the asynchronous task that completes when the async operation completes. + /// + public Task Task + { + get { - get + if (this.wrappedTask is null) { using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { lock (this.JoinableTaskContext.SyncContextLock) { - if (!this.IsCompleteRequested) + if (this.wrappedTask is null) { - return false; + // We'd rather not do this. The field is assigned elsewhere later on if we haven't hit this first. + // But some caller needs a Task that we don't yet have, so we have to spin one up. + this.wrappedTask = this.CreateTaskCompletionSource(); } + } + } + } - if (this.mainThreadQueue is object && !this.mainThreadQueue.IsCompleted) - { - return false; - } + // Read 'wrappedTask' once to a local variable. Since this read occurs outside a lock, we need to ensure + // that writes to the field between the 'Task' type check and the call to 'GetTaskFromCompletionSource' + // do not result in passing the wrong object type to the latter (which would result in an + // InvalidCastException). + var wrappedTask = this.wrappedTask; + return wrappedTask as Task ?? this.GetTaskFromCompletionSource(wrappedTask); + } + } - if (this.threadPoolQueue is object && !this.threadPoolQueue.IsCompleted) - { - return false; - } + JoinableTaskContext IJoinableTaskDependent.JoinableTaskContext => this.JoinableTaskContext; - return true; + bool IJoinableTaskDependent.NeedRefCountChildDependencies => true; + + /// + /// Gets the JoinableTask that is completing (i.e. synchronously blocking) on this thread, nearest to the top of the callstack. + /// + /// + /// This property is intentionally non-public to avoid its abuse by outside callers. + /// + internal static JoinableTask? TaskCompletingOnThisThread + { + get { return CompletingTask.Value; } + } + + /// + /// Gets a value indicating whether an awaiter should capture the + /// . + /// + /// + /// As a library, we generally wouldn't capture the + /// when awaiting, except that where our thread is synchronously blocking anyway, it is actually + /// more efficient to capture the so that the continuation + /// will resume on the blocking thread instead of occupying yet another one in order to execute. + /// In fact, when threadpool starvation conditions exist, resuming on the calling thread + /// can avoid significant delays in executing an often trivial continuation. + /// + internal static bool AwaitShouldCaptureSyncContext => SynchronizationContext.Current is JoinableTaskSynchronizationContext; + + /// + /// Gets a value indicating whether the async operation and any extra queues tracked by this instance has completed. + /// + internal bool IsFullyCompleted + { + get + { + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.JoinableTaskContext.SyncContextLock) + { + if (!this.IsCompleteRequested) + { + return false; + } + + if (this.mainThreadQueue is object && !this.mainThreadQueue.IsCompleted) + { + return false; + } + + if (this.threadPoolQueue is object && !this.threadPoolQueue.IsCompleted) + { + return false; } + + return true; } } } + } - /// - /// Gets or sets the set of nesting factories (excluding ) - /// that own JoinableTasks that are nesting this one. - /// - internal ListOfOftenOne NestingFactories - { - get { return this.nestingFactories; } - set { this.nestingFactories = value; } - } + /// + /// Gets or sets the set of nesting factories (excluding ) + /// that own JoinableTasks that are nesting this one. + /// + internal ListOfOftenOne NestingFactories + { + get { return this.nestingFactories; } + set { this.nestingFactories = value; } + } - internal JoinableTaskFactory Factory - { - get { return this.owner; } - } + internal JoinableTaskFactory Factory + { + get { return this.owner; } + } - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal SynchronizationContext? ApplicableJobSyncContext + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal SynchronizationContext? ApplicableJobSyncContext + { + get { - get + if (this.JoinableTaskContext.IsOnMainThread) { - if (this.JoinableTaskContext.IsOnMainThread) + if (this.mainThreadJobSyncContext is null) { - if (this.mainThreadJobSyncContext is null) + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) + if (this.mainThreadJobSyncContext is null) { - if (this.mainThreadJobSyncContext is null) - { - this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true); - } + this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true); } } } - - return this.mainThreadJobSyncContext; } - else + + return this.mainThreadJobSyncContext; + } + else + { + // This property only changes from true to false, and it reads a volatile field. + // To avoid (measured) lock contention, we skip the lock, risking that we could potentially + // enter the true block a little more than if we took a lock. But returning a synccontext + // for task whose completion was requested is a safe operation, since every sync context we return + // must be operable after that point anyway. + if (this.SynchronouslyBlockingThreadPool) { - // This property only changes from true to false, and it reads a volatile field. - // To avoid (measured) lock contention, we skip the lock, risking that we could potentially - // enter the true block a little more than if we took a lock. But returning a synccontext - // for task whose completion was requested is a safe operation, since every sync context we return - // must be operable after that point anyway. - if (this.SynchronouslyBlockingThreadPool) + if (this.threadPoolJobSyncContext is null) { - if (this.threadPoolJobSyncContext is null) + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) + if (this.threadPoolJobSyncContext is null) { - if (this.threadPoolJobSyncContext is null) - { - this.threadPoolJobSyncContext = new JoinableTaskSynchronizationContext(this, false); - } + this.threadPoolJobSyncContext = new JoinableTaskSynchronizationContext(this, false); } } } - - return this.threadPoolJobSyncContext; - } - else - { - // If we're not blocking the threadpool, there is no reason to use a thread pool sync context. - return null; } + + return this.threadPoolJobSyncContext; + } + else + { + // If we're not blocking the threadpool, there is no reason to use a thread pool sync context. + return null; } } } + } - /// - /// Gets a weak reference to this object. - /// - internal WeakReference WeakSelf + /// + /// Gets a weak reference to this object. + /// + internal WeakReference WeakSelf + { + get { - get + if (this.weakSelf is null) { - if (this.weakSelf is null) - { - this.weakSelf = new WeakReference(this); - } - - return this.weakSelf; + this.weakSelf = new WeakReference(this); } + + return this.weakSelf; } + } - /// - /// Gets or sets potential unreachable dependent nodes. - /// This is a special collection only used in synchronized task when there are other tasks which are marked to block it through ref-count code. - /// However, it is possible the reference count is retained by loop-dependencies. This collection tracking those items, - /// so the clean-up logic can run when it becomes necessary. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal HashSet? PotentialUnreachableDependents { get; set; } + /// + /// Gets or sets potential unreachable dependent nodes. + /// This is a special collection only used in synchronized task when there are other tasks which are marked to block it through ref-count code. + /// However, it is possible the reference count is retained by loop-dependencies. This collection tracking those items, + /// so the clean-up logic can run when it becomes necessary. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal HashSet? PotentialUnreachableDependents { get; set; } - /// - /// Gets a value indicating whether PotentialUnreachableDependents is empty. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal bool HasPotentialUnreachableDependents => this.PotentialUnreachableDependents is object && this.PotentialUnreachableDependents.Count != 0; + /// + /// Gets a value indicating whether PotentialUnreachableDependents is empty. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal bool HasPotentialUnreachableDependents => this.PotentialUnreachableDependents is object && this.PotentialUnreachableDependents.Count != 0; - /// - /// Gets the flags set on this task. - /// - internal JoinableTaskFlags State - { - get { return this.state; } - } + /// + /// Gets the flags set on this task. + /// + internal JoinableTaskFlags State + { + get { return this.state; } + } - /// - /// Gets the task's initial creationOptions. - /// - internal JoinableTaskCreationOptions CreationOptions - { - get { return this.creationOptions; } - } + /// + /// Gets the task's initial creationOptions. + /// + internal JoinableTaskCreationOptions CreationOptions + { + get { return this.creationOptions; } + } - /// - /// Gets the entry method's info so we could show its full name in hang report. - /// - internal MethodInfo? EntryMethodInfo => this.initialDelegate?.GetMethodInfo(); + /// + /// Gets the entry method's info so we could show its full name in hang report. + /// + internal MethodInfo? EntryMethodInfo => this.initialDelegate?.GetMethodInfo(); - /// - /// Gets a value indicating whether this task has a non-empty queue. - /// FOR DIAGNOSTICS COLLECTION ONLY. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal bool HasNonEmptyQueue + /// + /// Gets a value indicating whether this task has a non-empty queue. + /// FOR DIAGNOSTICS COLLECTION ONLY. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal bool HasNonEmptyQueue + { + get { - get - { - Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); - return (this.mainThreadQueue is object && this.mainThreadQueue.Count > 0) - || (this.threadPoolQueue is object && this.threadPoolQueue.Count > 0); - } + Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); + return (this.mainThreadQueue is object && this.mainThreadQueue.Count > 0) + || (this.threadPoolQueue is object && this.threadPoolQueue.Count > 0); } + } - /// - /// Gets a snapshot of all work queued to the main thread. - /// FOR DIAGNOSTICS COLLECTION ONLY. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal IEnumerable MainThreadQueueContents + /// + /// Gets a snapshot of all work queued to the main thread. + /// FOR DIAGNOSTICS COLLECTION ONLY. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal IEnumerable MainThreadQueueContents + { + get { - get + Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); + if (this.mainThreadQueue is null) { - Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); - if (this.mainThreadQueue is null) - { - return Enumerable.Empty(); - } - - return this.mainThreadQueue.ToArray(); + return Enumerable.Empty(); } + + return this.mainThreadQueue.ToArray(); } + } - /// - /// Gets a snapshot of all work queued to synchronously blocking threadpool thread. - /// FOR DIAGNOSTICS COLLECTION ONLY. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal IEnumerable ThreadPoolQueueContents + /// + /// Gets a snapshot of all work queued to synchronously blocking threadpool thread. + /// FOR DIAGNOSTICS COLLECTION ONLY. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal IEnumerable ThreadPoolQueueContents + { + get { - get + Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); + if (this.threadPoolQueue is null) { - Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); - if (this.threadPoolQueue is null) - { - return Enumerable.Empty(); - } - - return this.threadPoolQueue.ToArray(); + return Enumerable.Empty(); } + + return this.threadPoolQueue.ToArray(); } + } - /// - /// Gets the collections this task belongs to. - /// FOR DIAGNOSTICS COLLECTION ONLY. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal IEnumerable ContainingCollections + /// + /// Gets the collections this task belongs to. + /// FOR DIAGNOSTICS COLLECTION ONLY. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal IEnumerable ContainingCollections + { + get { - get - { - Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); - return this.dependencyParents.ToArray().OfType(); - } + Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); + return this.dependencyParents.ToArray().OfType(); } + } - /// - /// Gets or sets a value indicating whether this task has had its Complete() method called.. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - internal bool IsCompleteRequested + /// + /// Gets or sets a value indicating whether this task has had its Complete() method called.. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + internal bool IsCompleteRequested + { + get { - get - { - return (this.state & JoinableTaskFlags.CompleteRequested) != 0; - } + return (this.state & JoinableTaskFlags.CompleteRequested) != 0; + } - set - { - Assumes.True(value); - this.state |= JoinableTaskFlags.CompleteRequested; - } + set + { + Assumes.True(value); + this.state |= JoinableTaskFlags.CompleteRequested; } + } - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private bool SynchronouslyBlockingThreadPool + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private bool SynchronouslyBlockingThreadPool + { + get { - get - { - JoinableTaskFlags state = this.state; - return (state & JoinableTaskFlags.StartedSynchronously) == JoinableTaskFlags.StartedSynchronously - && (state & JoinableTaskFlags.StartedOnMainThread) != JoinableTaskFlags.StartedOnMainThread - && (state & JoinableTaskFlags.CompleteRequested) != JoinableTaskFlags.CompleteRequested; - } + JoinableTaskFlags state = this.state; + return (state & JoinableTaskFlags.StartedSynchronously) == JoinableTaskFlags.StartedSynchronously + && (state & JoinableTaskFlags.StartedOnMainThread) != JoinableTaskFlags.StartedOnMainThread + && (state & JoinableTaskFlags.CompleteRequested) != JoinableTaskFlags.CompleteRequested; } + } - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private bool SynchronouslyBlockingMainThread + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private bool SynchronouslyBlockingMainThread + { + get { - get - { - JoinableTaskFlags state = this.state; - return (state & JoinableTaskFlags.StartedSynchronously) == JoinableTaskFlags.StartedSynchronously - && (state & JoinableTaskFlags.StartedOnMainThread) == JoinableTaskFlags.StartedOnMainThread - && (state & JoinableTaskFlags.CompleteRequested) != JoinableTaskFlags.CompleteRequested; - } + JoinableTaskFlags state = this.state; + return (state & JoinableTaskFlags.StartedSynchronously) == JoinableTaskFlags.StartedSynchronously + && (state & JoinableTaskFlags.StartedOnMainThread) == JoinableTaskFlags.StartedOnMainThread + && (state & JoinableTaskFlags.CompleteRequested) != JoinableTaskFlags.CompleteRequested; } + } - /// - /// Gets JoinableTaskContext for to access locks. - /// - private JoinableTaskContext JoinableTaskContext => this.owner.Context; + /// + /// Gets JoinableTaskContext for to access locks. + /// + private JoinableTaskContext JoinableTaskContext => this.owner.Context; - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private Task QueueNeedProcessEvent + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private Task QueueNeedProcessEvent + { + get { - get + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) + if (this.queueNeedProcessEvent is null) { - if (this.queueNeedProcessEvent is null) - { - // We pass in allowInliningWaiters: true, - // since we control all waiters and their continuations - // are benign, and it makes it more efficient. - this.queueNeedProcessEvent = new AsyncManualResetEvent(allowInliningAwaiters: true); - } - - return this.queueNeedProcessEvent.WaitAsync(); + // We pass in allowInliningWaiters: true, + // since we control all waiters and their continuations + // are benign, and it makes it more efficient. + this.queueNeedProcessEvent = new AsyncManualResetEvent(allowInliningAwaiters: true); } + + return this.queueNeedProcessEvent.WaitAsync(); } } } + } - /// - /// Synchronously blocks the calling thread until the operation has completed. - /// If the caller is on the Main thread (or is executing within a JoinableTask that has access to the main thread) - /// the caller's access to the Main thread propagates to this JoinableTask so that it may also access the main thread. - /// - /// A cancellation token that will exit this method before the task is completed. - public void Join(CancellationToken cancellationToken = default(CancellationToken)) + /// + /// Synchronously blocks the calling thread until the operation has completed. + /// If the caller is on the Main thread (or is executing within a JoinableTask that has access to the main thread) + /// the caller's access to the Main thread propagates to this JoinableTask so that it may also access the main thread. + /// + /// A cancellation token that will exit this method before the task is completed. + public void Join(CancellationToken cancellationToken = default(CancellationToken)) + { + cancellationToken.ThrowIfCancellationRequested(); + + if (this.IsCompleted) { - cancellationToken.ThrowIfCancellationRequested(); + this.Task.GetAwaiter().GetResult(); // rethrow any exceptions + return; + } - if (this.IsCompleted) - { - this.Task.GetAwaiter().GetResult(); // rethrow any exceptions - return; - } + // We don't simply call this.CompleteOnCurrentThread because that doesn't take CancellationToken. + // And it really can't be made to, since it sets state flags indicating the JoinableTask is + // blocking till completion. + // So instead, we new up a new JoinableTask to do the blocking. But we preserve the initial delegate + // so that if a hang occurs it blames the original JoinableTask. + this.owner.Run( + () => this.JoinAsync(cancellationToken), + JoinableTaskCreationOptions.None, + this.initialDelegate); + } + + /// + /// Shares any access to the main thread the caller may have + /// Joins any main thread affinity of the caller with the asynchronous operation to avoid deadlocks + /// in the event that the main thread ultimately synchronously blocks waiting for the operation to complete. + /// + /// + /// A cancellation token that will revert the Join and cause the returned task to complete + /// before the async operation has completed. + /// + /// A task that completes after the asynchronous operation completes and the join is reverted. + public Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + cancellationToken.ThrowIfCancellationRequested(); - // We don't simply call this.CompleteOnCurrentThread because that doesn't take CancellationToken. - // And it really can't be made to, since it sets state flags indicating the JoinableTask is - // blocking till completion. - // So instead, we new up a new JoinableTask to do the blocking. But we preserve the initial delegate - // so that if a hang occurs it blames the original JoinableTask. - this.owner.Run( - () => this.JoinAsync(cancellationToken), - JoinableTaskCreationOptions.None, - this.initialDelegate); + if (!cancellationToken.CanBeCanceled) + { + // A completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. + _ = this.AmbientJobJoinsThis(); + return this.Task; + } + else + { + return JoinSlowAsync(this, cancellationToken); } - /// - /// Shares any access to the main thread the caller may have - /// Joins any main thread affinity of the caller with the asynchronous operation to avoid deadlocks - /// in the event that the main thread ultimately synchronously blocks waiting for the operation to complete. - /// - /// - /// A cancellation token that will revert the Join and cause the returned task to complete - /// before the async operation has completed. - /// - /// A task that completes after the asynchronous operation completes and the join is reverted. - public Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) + static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) { - cancellationToken.ThrowIfCancellationRequested(); + // No need to dispose of this except in cancellation case. + JoinRelease dependency = me.AmbientJobJoinsThis(); - if (!cancellationToken.CanBeCanceled) + try { - // A completed or failed JoinableTask will remove itself from parent dependency chains, so we don't repeat it which requires the sync lock. - _ = this.AmbientJobJoinsThis(); - return this.Task; + await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); } - else + catch (OperationCanceledException) { - return JoinSlowAsync(this, cancellationToken); + dependency.Dispose(); + throw; } + } + } - static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) - { - // No need to dispose of this except in cancellation case. - JoinRelease dependency = me.AmbientJobJoinsThis(); + /// + /// Gets an awaiter that is equivalent to calling . + /// + /// A task whose result is the result of the asynchronous operation. + public TaskAwaiter GetAwaiter() + { + return this.JoinAsync().GetAwaiter(); + } - try - { - await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); - } - catch (OperationCanceledException) - { - dependency.Dispose(); - throw; - } - } - } + ref JoinableTaskDependencyGraph.JoinableTaskDependentData IJoinableTaskDependent.GetJoinableTaskDependentData() + { + return ref this.dependentData; + } - /// - /// Gets an awaiter that is equivalent to calling . - /// - /// A task whose result is the result of the asynchronous operation. - public TaskAwaiter GetAwaiter() - { - return this.JoinAsync().GetAwaiter(); - } + void IJoinableTaskDependent.OnAddedToDependency(IJoinableTaskDependent parentNode) + { + Requires.NotNull(parentNode, nameof(parentNode)); + this.dependencyParents.Add(parentNode); + } - ref JoinableTaskDependencyGraph.JoinableTaskDependentData IJoinableTaskDependent.GetJoinableTaskDependentData() - { - return ref this.dependentData; - } + void IJoinableTaskDependent.OnRemovedFromDependency(IJoinableTaskDependent parentNode) + { + Requires.NotNull(parentNode, nameof(parentNode)); + this.dependencyParents.Remove(parentNode); + } - void IJoinableTaskDependent.OnAddedToDependency(IJoinableTaskDependent parentNode) - { - Requires.NotNull(parentNode, nameof(parentNode)); - this.dependencyParents.Add(parentNode); - } + void IJoinableTaskDependent.OnDependencyAdded(IJoinableTaskDependent joinChild) + { + } - void IJoinableTaskDependent.OnRemovedFromDependency(IJoinableTaskDependent parentNode) - { - Requires.NotNull(parentNode, nameof(parentNode)); - this.dependencyParents.Remove(parentNode); - } + void IJoinableTaskDependent.OnDependencyRemoved(IJoinableTaskDependent joinChild) + { + } - void IJoinableTaskDependent.OnDependencyAdded(IJoinableTaskDependent joinChild) + /// + /// Gets a very likely value whether the main thread is blocked by this . + /// + internal bool MaybeBlockMainThread() + { + if ((this.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) { + return false; } - void IJoinableTaskDependent.OnDependencyRemoved(IJoinableTaskDependent joinChild) + if ((this.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) { + return true; } - /// - /// Gets a very likely value whether the main thread is blocked by this . - /// - internal bool MaybeBlockMainThread() + return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(this); + } + + internal void Post(SendOrPostCallback d, object? state, bool mainThreadAffinitized) + { + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - if ((this.State & JoinableTask.JoinableTaskFlags.CompleteFinalized) == JoinableTask.JoinableTaskFlags.CompleteFinalized) + SingleExecuteProtector? wrapper = null; + List? eventsNeedNotify = null; // initialized if we should pulse it at the end of the method + bool postToFactory = false; + + bool isCompleteRequested; + bool synchronouslyBlockingMainThread; + lock (this.JoinableTaskContext.SyncContextLock) { - return false; + isCompleteRequested = this.IsCompleteRequested; + synchronouslyBlockingMainThread = this.SynchronouslyBlockingMainThread; } - if ((this.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + if (isCompleteRequested) { - return true; + // This job has already been marked for completion. + // We need to forward the work to the fallback mechanisms. + postToFactory = true; } - - return JoinableTaskDependencyGraph.MaybeHasMainThreadSynchronousTaskWaiting(this); - } - - internal void Post(SendOrPostCallback d, object? state, bool mainThreadAffinitized) - { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + else { - SingleExecuteProtector? wrapper = null; - List? eventsNeedNotify = null; // initialized if we should pulse it at the end of the method - bool postToFactory = false; + bool mainThreadQueueUpdated = false; + bool backgroundThreadQueueUpdated = false; + wrapper = SingleExecuteProtector.Create(this, d, state); - bool isCompleteRequested; - bool synchronouslyBlockingMainThread; - lock (this.JoinableTaskContext.SyncContextLock) + if (ThreadingEventSource.Instance.IsEnabled()) { - isCompleteRequested = this.IsCompleteRequested; - synchronouslyBlockingMainThread = this.SynchronouslyBlockingMainThread; + ThreadingEventSource.Instance.PostExecutionStart(wrapper.GetHashCode(), mainThreadAffinitized); } - if (isCompleteRequested) + if (mainThreadAffinitized && !synchronouslyBlockingMainThread) { - // This job has already been marked for completion. - // We need to forward the work to the fallback mechanisms. - postToFactory = true; + wrapper.RaiseTransitioningEvents(); } - else - { - bool mainThreadQueueUpdated = false; - bool backgroundThreadQueueUpdated = false; - wrapper = SingleExecuteProtector.Create(this, d, state); - - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.PostExecutionStart(wrapper.GetHashCode(), mainThreadAffinitized); - } - - if (mainThreadAffinitized && !synchronouslyBlockingMainThread) - { - wrapper.RaiseTransitioningEvents(); - } - lock (this.JoinableTaskContext.SyncContextLock) + lock (this.JoinableTaskContext.SyncContextLock) + { + if (mainThreadAffinitized) { - if (mainThreadAffinitized) + if (this.mainThreadQueue is null) { - if (this.mainThreadQueue is null) - { - this.mainThreadQueue = new ExecutionQueue(this); - } - - // Try to post the message here, but we'll also post to the underlying sync context - // so if this fails (because the operation has completed) we'll still get the work - // done eventually. - this.mainThreadQueue.TryEnqueue(wrapper); - mainThreadQueueUpdated = true; + this.mainThreadQueue = new ExecutionQueue(this); } - else - { - if (this.SynchronouslyBlockingThreadPool) - { - if (this.threadPoolQueue is null) - { - this.threadPoolQueue = new ExecutionQueue(this); - } - backgroundThreadQueueUpdated = this.threadPoolQueue.TryEnqueue(wrapper); - if (!backgroundThreadQueueUpdated) - { - ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, wrapper); - } + // Try to post the message here, but we'll also post to the underlying sync context + // so if this fails (because the operation has completed) we'll still get the work + // done eventually. + this.mainThreadQueue.TryEnqueue(wrapper); + mainThreadQueueUpdated = true; + } + else + { + if (this.SynchronouslyBlockingThreadPool) + { + if (this.threadPoolQueue is null) + { + this.threadPoolQueue = new ExecutionQueue(this); } - else + + backgroundThreadQueueUpdated = this.threadPoolQueue.TryEnqueue(wrapper); + if (!backgroundThreadQueueUpdated) { ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, wrapper); } } + else + { + ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, wrapper); + } + } - if (mainThreadQueueUpdated || backgroundThreadQueueUpdated) + if (mainThreadQueueUpdated || backgroundThreadQueueUpdated) + { + IReadOnlyCollection? tasksNeedNotify = JoinableTaskDependencyGraph.GetDependingSynchronousTasks(this, mainThreadQueueUpdated); + if (tasksNeedNotify.Count > 0) { - IReadOnlyCollection? tasksNeedNotify = JoinableTaskDependencyGraph.GetDependingSynchronousTasks(this, mainThreadQueueUpdated); - if (tasksNeedNotify.Count > 0) + eventsNeedNotify = new List(tasksNeedNotify.Count); + foreach (JoinableTask? taskToNotify in tasksNeedNotify) { - eventsNeedNotify = new List(tasksNeedNotify.Count); - foreach (JoinableTask? taskToNotify in tasksNeedNotify) + if (mainThreadQueueUpdated && taskToNotify != this && taskToNotify.pendingEventCount == 0 && taskToNotify.HasPotentialUnreachableDependents) { - if (mainThreadQueueUpdated && taskToNotify != this && taskToNotify.pendingEventCount == 0 && taskToNotify.HasPotentialUnreachableDependents) + // It is not essential to clean up potential unreachable dependent items before triggering the UI thread, + // because dependencies may change, and invalidate this work. However, we try to do this work in the background thread to make it less likely + // doing the expensive work on the UI thread. + if (JoinableTaskDependencyGraph.CleanUpPotentialUnreachableDependentItems(taskToNotify, out HashSet? reachableNodes) && + !reachableNodes.Contains(this)) { - // It is not essential to clean up potential unreachable dependent items before triggering the UI thread, - // because dependencies may change, and invalidate this work. However, we try to do this work in the background thread to make it less likely - // doing the expensive work on the UI thread. - if (JoinableTaskDependencyGraph.CleanUpPotentialUnreachableDependentItems(taskToNotify, out HashSet? reachableNodes) && - !reachableNodes.Contains(this)) - { - continue; - } + continue; } + } - if (taskToNotify.pendingEventSource is null || taskToNotify == this) - { - taskToNotify.pendingEventSource = this.WeakSelf; - } + if (taskToNotify.pendingEventSource is null || taskToNotify == this) + { + taskToNotify.pendingEventSource = this.WeakSelf; + } - taskToNotify.pendingEventCount++; - if (taskToNotify.queueNeedProcessEvent is object) - { - eventsNeedNotify.Add(taskToNotify.queueNeedProcessEvent); - } + taskToNotify.pendingEventCount++; + if (taskToNotify.queueNeedProcessEvent is object) + { + eventsNeedNotify.Add(taskToNotify.queueNeedProcessEvent); } } } } } + } - // Notify tasks which can process the event queue. - if (eventsNeedNotify is object) + // Notify tasks which can process the event queue. + if (eventsNeedNotify is object) + { + foreach (AsyncManualResetEvent? queueEvent in eventsNeedNotify) { - foreach (AsyncManualResetEvent? queueEvent in eventsNeedNotify) - { - queueEvent.PulseAll(); - } + queueEvent.PulseAll(); } + } - // We deferred this till after we release our lock earlier in this method since we're calling outside code. - if (postToFactory) - { - Assumes.Null(wrapper); // we avoid using a wrapper in this case because this job transferring ownership to the factory. - this.Factory.Post(d, state, mainThreadAffinitized); - } - else if (mainThreadAffinitized) - { - Assumes.NotNull(wrapper); // this should have been initialized in the above logic. - this.owner.PostToUnderlyingSynchronizationContextOrThreadPool(wrapper); + // We deferred this till after we release our lock earlier in this method since we're calling outside code. + if (postToFactory) + { + Assumes.Null(wrapper); // we avoid using a wrapper in this case because this job transferring ownership to the factory. + this.Factory.Post(d, state, mainThreadAffinitized); + } + else if (mainThreadAffinitized) + { + Assumes.NotNull(wrapper); // this should have been initialized in the above logic. + this.owner.PostToUnderlyingSynchronizationContextOrThreadPool(wrapper); - foreach (JoinableTaskFactory? nestingFactory in this.nestingFactories) + foreach (JoinableTaskFactory? nestingFactory in this.nestingFactories) + { + if (nestingFactory != this.owner) { - if (nestingFactory != this.owner) - { - nestingFactory.PostToUnderlyingSynchronizationContextOrThreadPool(wrapper); - } + nestingFactory.PostToUnderlyingSynchronizationContextOrThreadPool(wrapper); } } } } + } - /// - /// Instantiate a that can track the ultimate result of . - /// - /// The new task completion source. - /// - /// The implementation should be sure to instantiate a that will - /// NOT inline continuations, since we'll be completing this ourselves, potentially while holding a private lock. - /// - internal virtual object CreateTaskCompletionSource() => new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); + /// + /// Instantiate a that can track the ultimate result of . + /// + /// The new task completion source. + /// + /// The implementation should be sure to instantiate a that will + /// NOT inline continuations, since we'll be completing this ourselves, potentially while holding a private lock. + /// + internal virtual object CreateTaskCompletionSource() => new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); - /// - /// Retrieves the from a . - /// - /// The task completion source. - /// The that will complete with this . - internal virtual Task GetTaskFromCompletionSource(object taskCompletionSource) => ((TaskCompletionSourceWithoutInlining)taskCompletionSource).Task; + /// + /// Retrieves the from a . + /// + /// The task completion source. + /// The that will complete with this . + internal virtual Task GetTaskFromCompletionSource(object taskCompletionSource) => ((TaskCompletionSourceWithoutInlining)taskCompletionSource).Task; - /// - /// Completes a . - /// - /// The task to read a result from. - /// The created earlier with to apply the result to. - internal virtual void CompleteTaskSourceFromWrappedTask(Task wrappedTask, object taskCompletionSource) => wrappedTask.ApplyResultTo((TaskCompletionSourceWithoutInlining)taskCompletionSource); + /// + /// Completes a . + /// + /// The task to read a result from. + /// The created earlier with to apply the result to. + internal virtual void CompleteTaskSourceFromWrappedTask(Task wrappedTask, object taskCompletionSource) => wrappedTask.ApplyResultTo((TaskCompletionSourceWithoutInlining)taskCompletionSource); - internal void SetWrappedTask(Task wrappedTask) - { - Requires.NotNull(wrappedTask, nameof(wrappedTask)); + internal void SetWrappedTask(Task wrappedTask) + { + Requires.NotNull(wrappedTask, nameof(wrappedTask)); - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) + if (this.wrappedTask is null) { - if (this.wrappedTask is null) - { - this.wrappedTask = wrappedTask; - } + this.wrappedTask = wrappedTask; + } - if (wrappedTask.IsCompleted) - { - this.Complete(wrappedTask); - } - else - { - // Arrange for the wrapped task to complete this job when the task completes. - wrappedTask.ContinueWith( - (t, s) => ((JoinableTask)s!).Complete(t), - this, - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } + if (wrappedTask.IsCompleted) + { + this.Complete(wrappedTask); + } + else + { + // Arrange for the wrapped task to complete this job when the task completes. + wrappedTask.ContinueWith( + (t, s) => ((JoinableTask)s!).Complete(t), + this, + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); } } } + } - /// - /// Fires when the underlying Task is completed. - /// - /// The actual result from . - internal void Complete(Task wrappedTask) - { - Assumes.NotNull(this.wrappedTask); + /// + /// Fires when the underlying Task is completed. + /// + /// The actual result from . + internal void Complete(Task wrappedTask) + { + Assumes.NotNull(this.wrappedTask); - // If we had to synthesize a Task earlier, then wrappedTask is a TaskCompletionSource, - // which we should now complete. - if (!(this.wrappedTask is Task)) - { - this.CompleteTaskSourceFromWrappedTask(wrappedTask, this.wrappedTask); - } + // If we had to synthesize a Task earlier, then wrappedTask is a TaskCompletionSource, + // which we should now complete. + if (!(this.wrappedTask is Task)) + { + this.CompleteTaskSourceFromWrappedTask(wrappedTask, this.wrappedTask); + } - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + AsyncManualResetEvent? queueNeedProcessEvent = null; + lock (this.JoinableTaskContext.SyncContextLock) { - AsyncManualResetEvent? queueNeedProcessEvent = null; - lock (this.JoinableTaskContext.SyncContextLock) + if (!this.IsCompleteRequested) { - if (!this.IsCompleteRequested) - { - this.IsCompleteRequested = true; + this.IsCompleteRequested = true; - if (this.mainThreadQueue is object) - { - this.mainThreadQueue.Complete(); - } + if (this.mainThreadQueue is object) + { + this.mainThreadQueue.Complete(); + } - if (this.threadPoolQueue is object) - { - this.threadPoolQueue.Complete(); - } + if (this.threadPoolQueue is object) + { + this.threadPoolQueue.Complete(); + } - this.OnQueueCompleted(); + this.OnQueueCompleted(); - // Always arrange to pulse the event since folks waiting - // will likely want to know that the JoinableTask has completed. - queueNeedProcessEvent = this.queueNeedProcessEvent; + // Always arrange to pulse the event since folks waiting + // will likely want to know that the JoinableTask has completed. + queueNeedProcessEvent = this.queueNeedProcessEvent; - JoinableTaskDependencyGraph.OnTaskCompleted(this); - } + JoinableTaskDependencyGraph.OnTaskCompleted(this); } + } - if (queueNeedProcessEvent is object) - { - // We explicitly do this outside our lock. - queueNeedProcessEvent.PulseAll(); - } + if (queueNeedProcessEvent is object) + { + // We explicitly do this outside our lock. + queueNeedProcessEvent.PulseAll(); } } + } + + /// Runs a loop to process all queued work items, returning only when the task is completed. + internal void CompleteOnCurrentThread() + { + Assumes.NotNull(this.wrappedTask); - /// Runs a loop to process all queued work items, returning only when the task is completed. - internal void CompleteOnCurrentThread() + // "Push" this task onto the TLS field's virtual stack so that on hang reports we know which task to 'blame'. + JoinableTask? priorCompletingTask = CompletingTask.Value; + CompletingTask.Value = this; + try { - Assumes.NotNull(this.wrappedTask); + bool onMainThread = false; + JoinableTaskFlags additionalFlags = JoinableTaskFlags.CompletingSynchronously; + if (this.JoinableTaskContext.IsOnMainThread) + { + additionalFlags |= JoinableTaskFlags.SynchronouslyBlockingMainThread; + onMainThread = true; + } - // "Push" this task onto the TLS field's virtual stack so that on hang reports we know which task to 'blame'. - JoinableTask? priorCompletingTask = CompletingTask.Value; - CompletingTask.Value = this; - try + this.AddStateFlags(additionalFlags); + + if (!this.IsCompleteRequested) { - bool onMainThread = false; - JoinableTaskFlags additionalFlags = JoinableTaskFlags.CompletingSynchronously; - if (this.JoinableTaskContext.IsOnMainThread) + if (ThreadingEventSource.Instance.IsEnabled()) { - additionalFlags |= JoinableTaskFlags.SynchronouslyBlockingMainThread; - onMainThread = true; + ThreadingEventSource.Instance.CompleteOnCurrentThreadStart(this.GetHashCode(), onMainThread); } - this.AddStateFlags(additionalFlags); - - if (!this.IsCompleteRequested) + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.CompleteOnCurrentThreadStart(this.GetHashCode(), onMainThread); - } - - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) - { - JoinableTaskDependencyGraph.OnSynchronousTaskStartToBlockWaiting(this, out JoinableTask? pendingRequestTask, out this.pendingEventCount); + JoinableTaskDependencyGraph.OnSynchronousTaskStartToBlockWaiting(this, out JoinableTask? pendingRequestTask, out this.pendingEventCount); - // Add the task to the depending tracking list of itself, so it will monitor the event queue. - this.pendingEventSource = pendingRequestTask?.WeakSelf; - } + // Add the task to the depending tracking list of itself, so it will monitor the event queue. + this.pendingEventSource = pendingRequestTask?.WeakSelf; } + } - if (onMainThread) - { - this.JoinableTaskContext.OnSynchronousJoinableTaskToCompleteOnMainThread(this); - } + if (onMainThread) + { + this.JoinableTaskContext.OnSynchronousJoinableTaskToCompleteOnMainThread(this); + } - try + try + { + // Don't use IsCompleted as the condition because that + // includes queues of posted work that don't have to complete for the + // JoinableTask to be ready to return from the JTF.Run method. + HashSet? visited = null; + while (!this.IsCompleteRequested) { - // Don't use IsCompleted as the condition because that - // includes queues of posted work that don't have to complete for the - // JoinableTask to be ready to return from the JTF.Run method. - HashSet? visited = null; - while (!this.IsCompleteRequested) + if (this.TryDequeueSelfOrDependencies(onMainThread, ref visited, out SingleExecuteProtector? work, out Task? tryAgainAfter)) { - if (this.TryDequeueSelfOrDependencies(onMainThread, ref visited, out SingleExecuteProtector? work, out Task? tryAgainAfter)) - { - work.TryExecute(); - } - else if (tryAgainAfter is object) - { - // prevent referencing tasks which may be GCed during the waiting cycle. - visited?.Clear(); - - ThreadingEventSource.Instance.WaitSynchronouslyStart(); - this.owner.WaitSynchronously(tryAgainAfter); - ThreadingEventSource.Instance.WaitSynchronouslyStop(); - Assumes.True(tryAgainAfter.IsCompleted); - } + work.TryExecute(); } - } - finally - { - JoinableTaskDependencyGraph.OnSynchronousTaskEndToBlockWaiting(this); - } + else if (tryAgainAfter is object) + { + // prevent referencing tasks which may be GCed during the waiting cycle. + visited?.Clear(); - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.CompleteOnCurrentThreadStop(this.GetHashCode()); + ThreadingEventSource.Instance.WaitSynchronouslyStart(); + this.owner.WaitSynchronously(tryAgainAfter); + ThreadingEventSource.Instance.WaitSynchronouslyStop(); + Assumes.True(tryAgainAfter.IsCompleted); + } } } - else + finally { - if (onMainThread) - { - this.JoinableTaskContext.OnSynchronousJoinableTaskToCompleteOnMainThread(this); - } + JoinableTaskDependencyGraph.OnSynchronousTaskEndToBlockWaiting(this); } - // Now that we're about to stop blocking a thread, transfer any work - // that was queued but evidently not required to complete this task - // back to the threadpool so it still gets done. - if (this.threadPoolQueue?.Count > 0) + if (ThreadingEventSource.Instance.IsEnabled()) { - while (this.threadPoolQueue.TryDequeue(out SingleExecuteProtector? executor)) - { - ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, executor); - } + ThreadingEventSource.Instance.CompleteOnCurrentThreadStop(this.GetHashCode()); } - - Assumes.True(this.Task.IsCompleted); - this.Task.GetAwaiter().GetResult(); // rethrow any exceptions - } - finally - { - CompletingTask.Value = priorCompletingTask; - } - } - - internal void OnQueueCompleted() - { - if ((this.state & JoinableTaskFlags.CompleteFinalized) == JoinableTaskFlags.CompleteFinalized) - { - return; } - - if (this.IsFullyCompleted) + else { - // Note this code may execute more than once, as multiple queue completion - // notifications come in. - this.JoinableTaskContext.OnJoinableTaskCompleted(this); - - foreach (IJoinableTaskDependent collection in this.dependencyParents.EnumerateAndClear()) - { - JoinableTaskDependencyGraph.RemoveDependency(collection, this, forceCleanup: true); - } - - if (this.mainThreadJobSyncContext is object) + if (onMainThread) { - this.mainThreadJobSyncContext.OnCompleted(); + this.JoinableTaskContext.OnSynchronousJoinableTaskToCompleteOnMainThread(this); } + } - if (this.threadPoolJobSyncContext is object) + // Now that we're about to stop blocking a thread, transfer any work + // that was queued but evidently not required to complete this task + // back to the threadpool so it still gets done. + if (this.threadPoolQueue?.Count > 0) + { + while (this.threadPoolQueue.TryDequeue(out SingleExecuteProtector? executor)) { - this.threadPoolJobSyncContext.OnCompleted(); + ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, executor); } - - this.nestingFactories = default(ListOfOftenOne); - this.initialDelegate = null; - this.state |= JoinableTaskFlags.CompleteFinalized; } + + Assumes.True(this.Task.IsCompleted); + this.Task.GetAwaiter().GetResult(); // rethrow any exceptions } + finally + { + CompletingTask.Value = priorCompletingTask; + } + } - /// - /// Get the number of pending messages to be process for the synchronous task. - /// - /// The synchronous task. - /// The number of events need be processed by the synchronous task in the current JoinableTask. - internal int GetPendingEventCountForSynchronousTask(JoinableTask synchronousTask) + internal void OnQueueCompleted() + { + if ((this.state & JoinableTaskFlags.CompleteFinalized) == JoinableTaskFlags.CompleteFinalized) { - Requires.NotNull(synchronousTask, nameof(synchronousTask)); - ExecutionQueue? queue = ((synchronousTask.state & JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTaskFlags.SynchronouslyBlockingMainThread) - ? this.mainThreadQueue - : this.threadPoolQueue; - return queue is object ? queue.Count : 0; + return; } - /// - /// This is a helper method to parepare notifing the sychronous task for pending events. - /// It must be called inside JTF lock, and returns a collection of event to trigger later. (Those events must be triggered out of the JTF lock.) - /// - internal AsyncManualResetEvent? RegisterPendingEventsForSynchrousTask(JoinableTask taskHasPendingMessages, int newPendingMessagesCount) + if (this.IsFullyCompleted) { - Requires.NotNull(taskHasPendingMessages, nameof(taskHasPendingMessages)); - Requires.Range(newPendingMessagesCount > 0, nameof(newPendingMessagesCount)); - Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); - Assumes.True((this.state & JoinableTaskFlags.CompletingSynchronously) == JoinableTaskFlags.CompletingSynchronously); + // Note this code may execute more than once, as multiple queue completion + // notifications come in. + this.JoinableTaskContext.OnJoinableTaskCompleted(this); - if (this.pendingEventSource is null || taskHasPendingMessages == this) + foreach (IJoinableTaskDependent collection in this.dependencyParents.EnumerateAndClear()) { - this.pendingEventSource = taskHasPendingMessages.WeakSelf; + JoinableTaskDependencyGraph.RemoveDependency(collection, this, forceCleanup: true); } - this.pendingEventCount += newPendingMessagesCount; - return this.queueNeedProcessEvent; - } + if (this.mainThreadJobSyncContext is object) + { + this.mainThreadJobSyncContext.OnCompleted(); + } - private protected JoinRelease AmbientJobJoinsThis() - { - if (!this.IsCompleted) + if (this.threadPoolJobSyncContext is object) { - JoinableTask? ambientJob = this.JoinableTaskContext.AmbientTask; - if (ambientJob is object && ambientJob != this) - { - return JoinableTaskDependencyGraph.AddDependency(ambientJob, this); - } + this.threadPoolJobSyncContext.OnCompleted(); } - return default(JoinRelease); + this.nestingFactories = default(ListOfOftenOne); + this.initialDelegate = null; + this.state |= JoinableTaskFlags.CompleteFinalized; + } + } + + /// + /// Get the number of pending messages to be process for the synchronous task. + /// + /// The synchronous task. + /// The number of events need be processed by the synchronous task in the current JoinableTask. + internal int GetPendingEventCountForSynchronousTask(JoinableTask synchronousTask) + { + Requires.NotNull(synchronousTask, nameof(synchronousTask)); + ExecutionQueue? queue = ((synchronousTask.state & JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTaskFlags.SynchronouslyBlockingMainThread) + ? this.mainThreadQueue + : this.threadPoolQueue; + return queue is object ? queue.Count : 0; + } + + /// + /// This is a helper method to parepare notifing the sychronous task for pending events. + /// It must be called inside JTF lock, and returns a collection of event to trigger later. (Those events must be triggered out of the JTF lock.) + /// + internal AsyncManualResetEvent? RegisterPendingEventsForSynchrousTask(JoinableTask taskHasPendingMessages, int newPendingMessagesCount) + { + Requires.NotNull(taskHasPendingMessages, nameof(taskHasPendingMessages)); + Requires.Range(newPendingMessagesCount > 0, nameof(newPendingMessagesCount)); + Assumes.True(Monitor.IsEntered(this.JoinableTaskContext.SyncContextLock)); + Assumes.True((this.state & JoinableTaskFlags.CompletingSynchronously) == JoinableTaskFlags.CompletingSynchronously); + + if (this.pendingEventSource is null || taskHasPendingMessages == this) + { + this.pendingEventSource = taskHasPendingMessages.WeakSelf; } - private static bool TryDequeueSelfOrDependencies(IJoinableTaskDependent currentNode, bool onMainThread, HashSet visited, [NotNullWhen(true)] out SingleExecuteProtector? work) + this.pendingEventCount += newPendingMessagesCount; + return this.queueNeedProcessEvent; + } + + private protected JoinRelease AmbientJobJoinsThis() + { + if (!this.IsCompleted) { - Requires.NotNull(currentNode, nameof(currentNode)); - Requires.NotNull(visited, nameof(visited)); - Report.IfNot(Monitor.IsEntered(currentNode.JoinableTaskContext.SyncContextLock)); + JoinableTask? ambientJob = this.JoinableTaskContext.AmbientTask; + if (ambientJob is object && ambientJob != this) + { + return JoinableTaskDependencyGraph.AddDependency(ambientJob, this); + } + } + + return default(JoinRelease); + } - // We only need to find the first work item. - work = null; - if (visited.Add(currentNode)) + private static bool TryDequeueSelfOrDependencies(IJoinableTaskDependent currentNode, bool onMainThread, HashSet visited, [NotNullWhen(true)] out SingleExecuteProtector? work) + { + Requires.NotNull(currentNode, nameof(currentNode)); + Requires.NotNull(visited, nameof(visited)); + Report.IfNot(Monitor.IsEntered(currentNode.JoinableTaskContext.SyncContextLock)); + + // We only need to find the first work item. + work = null; + if (visited.Add(currentNode)) + { + JoinableTask? joinableTask = currentNode as JoinableTask; + if (joinableTask is object) { - JoinableTask? joinableTask = currentNode as JoinableTask; - if (joinableTask is object) + ExecutionQueue? queue = onMainThread ? joinableTask.mainThreadQueue : joinableTask.threadPoolQueue; + if (queue is object && !queue.IsCompleted) { - ExecutionQueue? queue = onMainThread ? joinableTask.mainThreadQueue : joinableTask.threadPoolQueue; - if (queue is object && !queue.IsCompleted) - { - queue.TryDequeue(out work); - } + queue.TryDequeue(out work); } + } - if (work is null) + if (work is null) + { + if (joinableTask?.IsCompleteRequested != true) { - if (joinableTask?.IsCompleteRequested != true) + foreach (IJoinableTaskDependent? item in JoinableTaskDependencyGraph.GetDirectDependentNodes(currentNode)) { - foreach (IJoinableTaskDependent? item in JoinableTaskDependencyGraph.GetDirectDependentNodes(currentNode)) + if (TryDequeueSelfOrDependencies(item, onMainThread, visited, out work)) { - if (TryDequeueSelfOrDependencies(item, onMainThread, visited, out work)) - { - break; - } + break; } } } } - - return work is object; } - private bool TryDequeueSelfOrDependencies(bool onMainThread, ref HashSet? visited, [NotNullWhen(true)] out SingleExecuteProtector? work, out Task? tryAgainAfter) + return work is object; + } + + private bool TryDequeueSelfOrDependencies(bool onMainThread, ref HashSet? visited, [NotNullWhen(true)] out SingleExecuteProtector? work, out Task? tryAgainAfter) + { + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) + if (this.IsFullyCompleted) { - if (this.IsFullyCompleted) - { - work = null; - tryAgainAfter = null; - return false; - } + work = null; + tryAgainAfter = null; + return false; + } - if (this.pendingEventCount > 0) - { - this.pendingEventCount--; + if (this.pendingEventCount > 0) + { + this.pendingEventCount--; - if (this.pendingEventSource is object) + if (this.pendingEventSource is object) + { + if (this.pendingEventSource.TryGetTarget(out JoinableTask? pendingSource) && + (pendingSource == this || + (!this.HasPotentialUnreachableDependents && JoinableTaskDependencyGraph.IsDependingSynchronousTask(pendingSource, this)))) { - if (this.pendingEventSource.TryGetTarget(out JoinableTask? pendingSource) && - (pendingSource == this || - (!this.HasPotentialUnreachableDependents && JoinableTaskDependencyGraph.IsDependingSynchronousTask(pendingSource, this)))) + ExecutionQueue? queue = onMainThread ? pendingSource.mainThreadQueue : pendingSource.threadPoolQueue; + if (queue is object && !queue.IsCompleted && queue.TryDequeue(out work)) { - ExecutionQueue? queue = onMainThread ? pendingSource.mainThreadQueue : pendingSource.threadPoolQueue; - if (queue is object && !queue.IsCompleted && queue.TryDequeue(out work)) + if (queue.Count == 0) { - if (queue.Count == 0) - { - this.pendingEventSource = null; - } - - tryAgainAfter = null; - return true; + this.pendingEventSource = null; } - } - this.pendingEventSource = null; + tryAgainAfter = null; + return true; + } } - if (visited is null) - { - visited = new HashSet(); - } - else - { - visited.Clear(); - } + this.pendingEventSource = null; + } - bool foundWork = TryDequeueSelfOrDependencies(this, onMainThread, visited, out work); + if (visited is null) + { + visited = new HashSet(); + } + else + { + visited.Clear(); + } - HashSet? visitedNodes = visited; - if (this.HasPotentialUnreachableDependents) - { - // We walked the dependencies tree and use this information to update the PotentialUnreachableDependents list. - this.PotentialUnreachableDependents!.RemoveWhere(n => visitedNodes.Contains(n)); + bool foundWork = TryDequeueSelfOrDependencies(this, onMainThread, visited, out work); - if (!foundWork && this.PotentialUnreachableDependents.Count > 0) - { - JoinableTaskDependencyGraph.RemoveUnreachableDependentItems(this, this.PotentialUnreachableDependents, visitedNodes); - this.PotentialUnreachableDependents.Clear(); - } - } + HashSet? visitedNodes = visited; + if (this.HasPotentialUnreachableDependents) + { + // We walked the dependencies tree and use this information to update the PotentialUnreachableDependents list. + this.PotentialUnreachableDependents!.RemoveWhere(n => visitedNodes.Contains(n)); - if (foundWork) + if (!foundWork && this.PotentialUnreachableDependents.Count > 0) { - Assumes.NotNull(work); - - tryAgainAfter = null; - return true; + JoinableTaskDependencyGraph.RemoveUnreachableDependentItems(this, this.PotentialUnreachableDependents, visitedNodes); + this.PotentialUnreachableDependents.Clear(); } } - this.pendingEventCount = 0; + if (foundWork) + { + Assumes.NotNull(work); - work = null; - tryAgainAfter = this.IsCompleteRequested ? null : this.QueueNeedProcessEvent; - return false; + tryAgainAfter = null; + return true; + } } + + this.pendingEventCount = 0; + + work = null; + tryAgainAfter = this.IsCompleteRequested ? null : this.QueueNeedProcessEvent; + return false; } } + } - /// - /// Adds the specified flags to the field. - /// - private void AddStateFlags(JoinableTaskFlags flags) + /// + /// Adds the specified flags to the field. + /// + private void AddStateFlags(JoinableTaskFlags flags) + { + // Try to avoid taking a lock if the flags are already set appropriately. + if ((this.state & flags) != flags) { - // Try to avoid taking a lock if the flags are already set appropriately. - if ((this.state & flags) != flags) + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (this.JoinableTaskContext.SyncContextLock) { - lock (this.JoinableTaskContext.SyncContextLock) - { - this.state |= flags; - } + this.state |= flags; } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs index 88204887e..c71028d55 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs @@ -7,286 +7,285 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A collection of incomplete objects. +/// +/// +/// Any completed is automatically removed from the collection. +/// +[DebuggerDisplay("JoinableTaskCollection: {displayName ?? \"(anonymous)\"}")] +public class JoinableTaskCollection : IJoinableTaskDependent, IEnumerable { /// - /// A collection of incomplete objects. + /// A value indicating whether joinable tasks are only removed when completed or removed as many times as they were added. /// - /// - /// Any completed is automatically removed from the collection. - /// - [DebuggerDisplay("JoinableTaskCollection: {displayName ?? \"(anonymous)\"}")] - public class JoinableTaskCollection : IJoinableTaskDependent, IEnumerable - { - /// - /// A value indicating whether joinable tasks are only removed when completed or removed as many times as they were added. - /// - private readonly bool refCountAddedJobs; + private readonly bool refCountAddedJobs; - /// - /// A human-readable name that may appear in hang reports. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private string? displayName; + /// + /// A human-readable name that may appear in hang reports. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private string? displayName; - /// - /// The to track dependencies between tasks. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private JoinableTaskDependencyGraph.JoinableTaskDependentData dependentData; + /// + /// The to track dependencies between tasks. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private JoinableTaskDependencyGraph.JoinableTaskDependentData dependentData; - /// - /// An event that is set when the collection is empty (lazily initialized). - /// - private AsyncManualResetEvent? emptyEvent; + /// + /// An event that is set when the collection is empty (lazily initialized). + /// + private AsyncManualResetEvent? emptyEvent; - /// - /// Initializes a new instance of the class. - /// - /// The instance to which this collection applies. - /// - /// if JoinableTask instances added to the collection multiple times should remain in the collection until they are - /// either removed the same number of times or until they are completed; - /// causes the first Remove call for a JoinableTask to remove it from this collection regardless - /// how many times it had been added. - public JoinableTaskCollection(JoinableTaskContext context, bool refCountAddedJobs = false) - { - Requires.NotNull(context, nameof(context)); - this.Context = context; - this.refCountAddedJobs = refCountAddedJobs; - } + /// + /// Initializes a new instance of the class. + /// + /// The instance to which this collection applies. + /// + /// if JoinableTask instances added to the collection multiple times should remain in the collection until they are + /// either removed the same number of times or until they are completed; + /// causes the first Remove call for a JoinableTask to remove it from this collection regardless + /// how many times it had been added. + public JoinableTaskCollection(JoinableTaskContext context, bool refCountAddedJobs = false) + { + Requires.NotNull(context, nameof(context)); + this.Context = context; + this.refCountAddedJobs = refCountAddedJobs; + } - /// - /// Gets the to which this collection belongs. - /// - public JoinableTaskContext Context { get; } + /// + /// Gets the to which this collection belongs. + /// + public JoinableTaskContext Context { get; } - /// - /// Gets or sets a human-readable name that may appear in hang reports. - /// - /// - /// This property should *not* be set to a value that may disclose - /// personally identifiable information or other confidential data - /// since this value may be included in hang reports sent to a third party. - /// - public string? DisplayName - { - get { return this.displayName; } - set { this.displayName = value; } - } + /// + /// Gets or sets a human-readable name that may appear in hang reports. + /// + /// + /// This property should *not* be set to a value that may disclose + /// personally identifiable information or other confidential data + /// since this value may be included in hang reports sent to a third party. + /// + public string? DisplayName + { + get { return this.displayName; } + set { this.displayName = value; } + } - /// - /// Gets JoinableTaskContext for to access locks. - /// - JoinableTaskContext IJoinableTaskDependent.JoinableTaskContext => this.Context; + /// + /// Gets JoinableTaskContext for to access locks. + /// + JoinableTaskContext IJoinableTaskDependent.JoinableTaskContext => this.Context; - /// - /// Gets a value indicating whether we need count reference for child dependent nodes. - /// - bool IJoinableTaskDependent.NeedRefCountChildDependencies => this.refCountAddedJobs; + /// + /// Gets a value indicating whether we need count reference for child dependent nodes. + /// + bool IJoinableTaskDependent.NeedRefCountChildDependencies => this.refCountAddedJobs; - ref JoinableTaskDependencyGraph.JoinableTaskDependentData IJoinableTaskDependent.GetJoinableTaskDependentData() => ref this.dependentData; + ref JoinableTaskDependencyGraph.JoinableTaskDependentData IJoinableTaskDependent.GetJoinableTaskDependentData() => ref this.dependentData; - /// - /// Adds the specified to this collection. - /// - /// The to add to the collection. - /// - /// As the collection only stores *incomplete* instances, - /// if the is already completed, it will not be added to the collection and this method will simply return. - /// Any instances added to the collection will be automatically removed upon completion. - /// - public void Add(JoinableTask joinableTask) + /// + /// Adds the specified to this collection. + /// + /// The to add to the collection. + /// + /// As the collection only stores *incomplete* instances, + /// if the is already completed, it will not be added to the collection and this method will simply return. + /// Any instances added to the collection will be automatically removed upon completion. + /// + public void Add(JoinableTask joinableTask) + { + Requires.NotNull(joinableTask, nameof(joinableTask)); + if (joinableTask.Factory.Context != this.Context) { - Requires.NotNull(joinableTask, nameof(joinableTask)); - if (joinableTask.Factory.Context != this.Context) - { - Requires.Argument(false, "joinableTask", Strings.JoinableTaskContextAndCollectionMismatch); - } - - JoinableTaskDependencyGraph.AddDependency(this, joinableTask); + Requires.Argument(false, "joinableTask", Strings.JoinableTaskContextAndCollectionMismatch); } - /// - /// Removes the specified from this collection, - /// or decrements the ref count if this collection tracks that. - /// - /// The to remove. - /// - /// Completed instances are automatically removed from the collection. - /// Calling this method to remove them is not necessary. - /// - public void Remove(JoinableTask joinableTask) + JoinableTaskDependencyGraph.AddDependency(this, joinableTask); + } + + /// + /// Removes the specified from this collection, + /// or decrements the ref count if this collection tracks that. + /// + /// The to remove. + /// + /// Completed instances are automatically removed from the collection. + /// Calling this method to remove them is not necessary. + /// + public void Remove(JoinableTask joinableTask) + { + Requires.NotNull(joinableTask, nameof(joinableTask)); + JoinableTaskDependencyGraph.RemoveDependency(this, joinableTask); + } + + /// + /// Shares access to the main thread that the caller's JoinableTask may have (if any) with all + /// JoinableTask instances in this collection until the returned value is disposed. + /// + /// A value to dispose of to revert the join. + /// + /// Calling this method when the caller is not executing within a JoinableTask safely no-ops. + /// + public JoinRelease Join() + { + JoinableTask? ambientJob = this.Context.AmbientTask; + if (ambientJob is null) { - Requires.NotNull(joinableTask, nameof(joinableTask)); - JoinableTaskDependencyGraph.RemoveDependency(this, joinableTask); + // The caller isn't running in the context of a joinable task, so there is nothing to join with this collection. + return default(JoinRelease); } - /// - /// Shares access to the main thread that the caller's JoinableTask may have (if any) with all - /// JoinableTask instances in this collection until the returned value is disposed. - /// - /// A value to dispose of to revert the join. - /// - /// Calling this method when the caller is not executing within a JoinableTask safely no-ops. - /// - public JoinRelease Join() - { - JoinableTask? ambientJob = this.Context.AmbientTask; - if (ambientJob is null) - { - // The caller isn't running in the context of a joinable task, so there is nothing to join with this collection. - return default(JoinRelease); - } + return JoinableTaskDependencyGraph.AddDependency(ambientJob, this); + } - return JoinableTaskDependencyGraph.AddDependency(ambientJob, this); - } + /// + /// Joins the caller's context to this collection till the collection is empty. + /// + /// A task that completes when this collection is empty. + public Task JoinTillEmptyAsync() => this.JoinTillEmptyAsync(CancellationToken.None); - /// - /// Joins the caller's context to this collection till the collection is empty. - /// - /// A task that completes when this collection is empty. - public Task JoinTillEmptyAsync() => this.JoinTillEmptyAsync(CancellationToken.None); + /// + /// Joins the caller's context to this collection till the collection is empty. + /// + /// A cancellation token. + /// A task that completes when this collection is empty, or is canceled when is canceled. + public async Task JoinTillEmptyAsync(CancellationToken cancellationToken) + { + cancellationToken.ThrowIfCancellationRequested(); - /// - /// Joins the caller's context to this collection till the collection is empty. - /// - /// A cancellation token. - /// A task that completes when this collection is empty, or is canceled when is canceled. - public async Task JoinTillEmptyAsync(CancellationToken cancellationToken) + if (this.emptyEvent is null) { - cancellationToken.ThrowIfCancellationRequested(); - - if (this.emptyEvent is null) + // We need a read lock to protect against the emptiness of this collection changing + // while we're setting the initial set state of the new event. + using (this.Context.NoMessagePumpSynchronizationContext.Apply()) { - // We need a read lock to protect against the emptiness of this collection changing - // while we're setting the initial set state of the new event. - using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + lock (this.Context.SyncContextLock) { - lock (this.Context.SyncContextLock) + if (this.emptyEvent is null) { - if (this.emptyEvent is null) - { - this.emptyEvent = new AsyncManualResetEvent(JoinableTaskDependencyGraph.HasNoChildDependentNode(this)); - } + this.emptyEvent = new AsyncManualResetEvent(JoinableTaskDependencyGraph.HasNoChildDependentNode(this)); } } } - - using (this.Join()) - { - await this.emptyEvent.WaitAsync(cancellationToken).ConfigureAwaitRunInline(); - } } - /// - /// Checks whether the specified joinable task is a member of this collection. - /// - public bool Contains(JoinableTask joinableTask) + using (this.Join()) { - Requires.NotNull(joinableTask, nameof(joinableTask)); + await this.emptyEvent.WaitAsync(cancellationToken).ConfigureAwaitRunInline(); + } + } - using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + /// + /// Checks whether the specified joinable task is a member of this collection. + /// + public bool Contains(JoinableTask joinableTask) + { + Requires.NotNull(joinableTask, nameof(joinableTask)); + + using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.Context.SyncContextLock) { - lock (this.Context.SyncContextLock) - { - return JoinableTaskDependencyGraph.HasDirectDependency(this, joinableTask); - } + return JoinableTaskDependencyGraph.HasDirectDependency(this, joinableTask); } } + } - /// - /// Enumerates the tasks in this collection. - /// - public IEnumerator GetEnumerator() + /// + /// Enumerates the tasks in this collection. + /// + public IEnumerator GetEnumerator() + { + using (this.Context.NoMessagePumpSynchronizationContext.Apply()) { - using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + var joinables = new List(); + lock (this.Context.SyncContextLock) { - var joinables = new List(); - lock (this.Context.SyncContextLock) + foreach (IJoinableTaskDependent? item in JoinableTaskDependencyGraph.GetDirectDependentNodes(this)) { - foreach (IJoinableTaskDependent? item in JoinableTaskDependencyGraph.GetDirectDependentNodes(this)) + if (item is JoinableTask joinableTask) { - if (item is JoinableTask joinableTask) - { - joinables.Add(joinableTask); - } + joinables.Add(joinableTask); } } - - return joinables.GetEnumerator(); } - } - /// - /// Enumerates the tasks in this collection. - /// - System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() - { - return this.GetEnumerator(); + return joinables.GetEnumerator(); } + } - void IJoinableTaskDependent.OnAddedToDependency(IJoinableTaskDependent parent) - { - } + /// + /// Enumerates the tasks in this collection. + /// + System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() + { + return this.GetEnumerator(); + } - void IJoinableTaskDependent.OnRemovedFromDependency(IJoinableTaskDependent parentNode) + void IJoinableTaskDependent.OnAddedToDependency(IJoinableTaskDependent parent) + { + } + + void IJoinableTaskDependent.OnRemovedFromDependency(IJoinableTaskDependent parentNode) + { + } + + void IJoinableTaskDependent.OnDependencyAdded(IJoinableTaskDependent joinChild) + { + if (this.emptyEvent is object && joinChild is JoinableTask) { + this.emptyEvent.Reset(); } + } - void IJoinableTaskDependent.OnDependencyAdded(IJoinableTaskDependent joinChild) + void IJoinableTaskDependent.OnDependencyRemoved(IJoinableTaskDependent joinChild) + { + if (this.emptyEvent is object && JoinableTaskDependencyGraph.HasNoChildDependentNode(this)) { - if (this.emptyEvent is object && joinChild is JoinableTask) - { - this.emptyEvent.Reset(); - } + this.emptyEvent.Set(); } + } + + /// + /// A value whose disposal cancels a operation. + /// + public struct JoinRelease : IDisposable + { + private IJoinableTaskDependent? parentDependencyNode; + private IJoinableTaskDependent? childDependencyNode; - void IJoinableTaskDependent.OnDependencyRemoved(IJoinableTaskDependent joinChild) + /// + /// Initializes a new instance of the struct. + /// + /// The Main thread controlling SingleThreadSynchronizationContext to use to accelerate execution of Main thread bound work. + /// The instance that created this value. + internal JoinRelease(IJoinableTaskDependent parentDependencyNode, IJoinableTaskDependent childDependencyNode) { - if (this.emptyEvent is object && JoinableTaskDependencyGraph.HasNoChildDependentNode(this)) - { - this.emptyEvent.Set(); - } + Requires.NotNull(parentDependencyNode, nameof(parentDependencyNode)); + Requires.NotNull(childDependencyNode, nameof(childDependencyNode)); + + this.parentDependencyNode = parentDependencyNode; + this.childDependencyNode = childDependencyNode; } /// - /// A value whose disposal cancels a operation. + /// Cancels the operation. /// - public struct JoinRelease : IDisposable + public void Dispose() { - private IJoinableTaskDependent? parentDependencyNode; - private IJoinableTaskDependent? childDependencyNode; - - /// - /// Initializes a new instance of the struct. - /// - /// The Main thread controlling SingleThreadSynchronizationContext to use to accelerate execution of Main thread bound work. - /// The instance that created this value. - internal JoinRelease(IJoinableTaskDependent parentDependencyNode, IJoinableTaskDependent childDependencyNode) + if (this.parentDependencyNode is object) { - Requires.NotNull(parentDependencyNode, nameof(parentDependencyNode)); - Requires.NotNull(childDependencyNode, nameof(childDependencyNode)); + RoslynDebug.Assert(this.childDependencyNode is object, $"{nameof(this.childDependencyNode)} can only be null when {nameof(this.parentDependencyNode)} is null."); - this.parentDependencyNode = parentDependencyNode; - this.childDependencyNode = childDependencyNode; + JoinableTaskDependencyGraph.RemoveDependency(this.parentDependencyNode, this.childDependencyNode); + this.parentDependencyNode = null; } - /// - /// Cancels the operation. - /// - public void Dispose() - { - if (this.parentDependencyNode is object) - { - RoslynDebug.Assert(this.childDependencyNode is object, $"{nameof(this.childDependencyNode)} can only be null when {nameof(this.parentDependencyNode)} is null."); - - JoinableTaskDependencyGraph.RemoveDependency(this.parentDependencyNode, this.childDependencyNode); - this.parentDependencyNode = null; - } - - this.childDependencyNode = null; - } + this.childDependencyNode = null; } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs index 42ba5e1e3..7f96afed4 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs @@ -9,202 +9,201 @@ using System.Threading.Tasks; using System.Xml.Linq; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +public partial class JoinableTaskContext : IHangReportContributor { - public partial class JoinableTaskContext : IHangReportContributor + /// + /// Contributes data for a hang report. + /// + /// The hang report contribution. + HangReportContribution IHangReportContributor.GetHangReport() { - /// - /// Contributes data for a hang report. - /// - /// The hang report contribution. - HangReportContribution IHangReportContributor.GetHangReport() - { - return this.GetHangReport(); - } + return this.GetHangReport(); + } - /// - /// Contributes data for a hang report. - /// - /// The hang report contribution. Null values should be ignored. - protected virtual HangReportContribution GetHangReport() + /// + /// Contributes data for a hang report. + /// + /// The hang report contribution. Null values should be ignored. + protected virtual HangReportContribution GetHangReport() + { + using (this.NoMessagePumpSynchronizationContext.Apply()) { - using (this.NoMessagePumpSynchronizationContext.Apply()) + lock (this.SyncContextLock) { - lock (this.SyncContextLock) - { - XDocument? dgml = CreateTemplateDgml(out XElement nodes, out XElement links); - - Dictionary? pendingTasksElements = this.CreateNodesForPendingTasks(); - List>? taskLabels = CreateNodeLabels(pendingTasksElements); - Dictionary? pendingTaskCollections = CreateNodesForJoinableTaskCollections(pendingTasksElements.Keys); - nodes.Add(pendingTasksElements.Values); - nodes.Add(pendingTaskCollections.Values); - nodes.Add(taskLabels.Select(t => t.Item1)); - links.Add(CreatesLinksBetweenNodes(pendingTasksElements)); - links.Add(CreateCollectionContainingTaskLinks(pendingTasksElements, pendingTaskCollections)); - links.Add(taskLabels.Select(t => t.Item2)); - - return new HangReportContribution( - dgml.ToString(), - "application/xml", - "JoinableTaskContext.dgml"); - } + XDocument? dgml = CreateTemplateDgml(out XElement nodes, out XElement links); + + Dictionary? pendingTasksElements = this.CreateNodesForPendingTasks(); + List>? taskLabels = CreateNodeLabels(pendingTasksElements); + Dictionary? pendingTaskCollections = CreateNodesForJoinableTaskCollections(pendingTasksElements.Keys); + nodes.Add(pendingTasksElements.Values); + nodes.Add(pendingTaskCollections.Values); + nodes.Add(taskLabels.Select(t => t.Item1)); + links.Add(CreatesLinksBetweenNodes(pendingTasksElements)); + links.Add(CreateCollectionContainingTaskLinks(pendingTasksElements, pendingTaskCollections)); + links.Add(taskLabels.Select(t => t.Item2)); + + return new HangReportContribution( + dgml.ToString(), + "application/xml", + "JoinableTaskContext.dgml"); } } + } - private static XDocument CreateTemplateDgml(out XElement nodes, out XElement links) - { - return Dgml.Create(out nodes, out links) - .WithCategories( - Dgml.Category("MainThreadBlocking", "Blocking main thread", background: "#FFF9FF7F", isTag: true), - Dgml.Category("NonEmptyQueue", "Non-empty queue", background: "#FFFF0000", isTag: true)); - } + private static XDocument CreateTemplateDgml(out XElement nodes, out XElement links) + { + return Dgml.Create(out nodes, out links) + .WithCategories( + Dgml.Category("MainThreadBlocking", "Blocking main thread", background: "#FFF9FF7F", isTag: true), + Dgml.Category("NonEmptyQueue", "Non-empty queue", background: "#FFFF0000", isTag: true)); + } - private static ICollection CreatesLinksBetweenNodes(Dictionary pendingTasksElements) - { - Requires.NotNull(pendingTasksElements, nameof(pendingTasksElements)); + private static ICollection CreatesLinksBetweenNodes(Dictionary pendingTasksElements) + { + Requires.NotNull(pendingTasksElements, nameof(pendingTasksElements)); - var links = new List(); - foreach (KeyValuePair joinableTaskAndElement in pendingTasksElements) + var links = new List(); + foreach (KeyValuePair joinableTaskAndElement in pendingTasksElements) + { + foreach (JoinableTask? joinedTask in JoinableTaskDependencyGraph.GetAllDirectlyDependentJoinableTasks(joinableTaskAndElement.Key)) { - foreach (JoinableTask? joinedTask in JoinableTaskDependencyGraph.GetAllDirectlyDependentJoinableTasks(joinableTaskAndElement.Key)) + if (pendingTasksElements.TryGetValue(joinedTask, out XElement? joinedTaskElement)) { - if (pendingTasksElements.TryGetValue(joinedTask, out XElement? joinedTaskElement)) - { - links.Add(Dgml.Link(joinableTaskAndElement.Value, joinedTaskElement)); - } + links.Add(Dgml.Link(joinableTaskAndElement.Value, joinedTaskElement)); } } - - return links; } - private static ICollection CreateCollectionContainingTaskLinks(Dictionary tasks, Dictionary collections) - { - Requires.NotNull(tasks, nameof(tasks)); - Requires.NotNull(collections, nameof(collections)); + return links; + } + + private static ICollection CreateCollectionContainingTaskLinks(Dictionary tasks, Dictionary collections) + { + Requires.NotNull(tasks, nameof(tasks)); + Requires.NotNull(collections, nameof(collections)); - var result = new List(); - foreach (KeyValuePair task in tasks) + var result = new List(); + foreach (KeyValuePair task in tasks) + { + foreach (JoinableTaskCollection? collection in task.Key.ContainingCollections) { - foreach (JoinableTaskCollection? collection in task.Key.ContainingCollections) - { - XElement? collectionElement = collections[collection]; - result.Add(Dgml.Link(collectionElement, task.Value).WithCategories("Contains")); - } + XElement? collectionElement = collections[collection]; + result.Add(Dgml.Link(collectionElement, task.Value).WithCategories("Contains")); } - - return result; } - private static Dictionary CreateNodesForJoinableTaskCollections(IEnumerable tasks) + return result; + } + + private static Dictionary CreateNodesForJoinableTaskCollections(IEnumerable tasks) + { + Requires.NotNull(tasks, nameof(tasks)); + + var collectionsSet = new HashSet(tasks.SelectMany(t => t.ContainingCollections)); + var result = new Dictionary(collectionsSet.Count); + int collectionId = 0; + foreach (JoinableTaskCollection? collection in collectionsSet) { - Requires.NotNull(tasks, nameof(tasks)); + collectionId++; + var label = string.IsNullOrEmpty(collection.DisplayName) ? "Collection #" + collectionId : collection.DisplayName; + XElement? element = Dgml.Node("Collection#" + collectionId, label, group: "Expanded") + .WithCategories("Collection"); + result.Add(collection, element); + } + + return result; + } + + private static List> CreateNodeLabels(Dictionary tasksAndElements) + { + Requires.NotNull(tasksAndElements, nameof(tasksAndElements)); - var collectionsSet = new HashSet(tasks.SelectMany(t => t.ContainingCollections)); - var result = new Dictionary(collectionsSet.Count); - int collectionId = 0; - foreach (JoinableTaskCollection? collection in collectionsSet) + var result = new List>(); + foreach (KeyValuePair tasksAndElement in tasksAndElements) + { + JoinableTask? pendingTask = tasksAndElement.Key; + XElement? node = tasksAndElement.Value; + int queueIndex = 0; + foreach (JoinableTaskFactory.SingleExecuteProtector? pendingTasksElement in pendingTask.MainThreadQueueContents) { - collectionId++; - var label = string.IsNullOrEmpty(collection.DisplayName) ? "Collection #" + collectionId : collection.DisplayName; - XElement? element = Dgml.Node("Collection#" + collectionId, label, group: "Expanded") - .WithCategories("Collection"); - result.Add(collection, element); + queueIndex++; + XElement? callstackNode = Dgml.Node(node.Attribute("Id")!.Value + "MTQueue#" + queueIndex, GetAsyncReturnStack(pendingTasksElement)); + XElement? callstackLink = Dgml.Link(callstackNode, node); + result.Add(Tuple.Create(callstackNode, callstackLink)); } - return result; + foreach (JoinableTaskFactory.SingleExecuteProtector? pendingTasksElement in pendingTask.ThreadPoolQueueContents) + { + queueIndex++; + XElement? callstackNode = Dgml.Node(node.Attribute("Id")!.Value + "TPQueue#" + queueIndex, GetAsyncReturnStack(pendingTasksElement)); + XElement? callstackLink = Dgml.Link(callstackNode, node); + result.Add(Tuple.Create(callstackNode, callstackLink)); + } } - private static List> CreateNodeLabels(Dictionary tasksAndElements) - { - Requires.NotNull(tasksAndElements, nameof(tasksAndElements)); + return result; + } - var result = new List>(); - foreach (KeyValuePair tasksAndElement in tasksAndElements) - { - JoinableTask? pendingTask = tasksAndElement.Key; - XElement? node = tasksAndElement.Value; - int queueIndex = 0; - foreach (JoinableTaskFactory.SingleExecuteProtector? pendingTasksElement in pendingTask.MainThreadQueueContents) - { - queueIndex++; - XElement? callstackNode = Dgml.Node(node.Attribute("Id")!.Value + "MTQueue#" + queueIndex, GetAsyncReturnStack(pendingTasksElement)); - XElement? callstackLink = Dgml.Link(callstackNode, node); - result.Add(Tuple.Create(callstackNode, callstackLink)); - } + private static string GetAsyncReturnStack(JoinableTaskFactory.SingleExecuteProtector singleExecuteProtector) + { + Requires.NotNull(singleExecuteProtector, nameof(singleExecuteProtector)); - foreach (JoinableTaskFactory.SingleExecuteProtector? pendingTasksElement in pendingTask.ThreadPoolQueueContents) - { - queueIndex++; - XElement? callstackNode = Dgml.Node(node.Attribute("Id")!.Value + "TPQueue#" + queueIndex, GetAsyncReturnStack(pendingTasksElement)); - XElement? callstackLink = Dgml.Link(callstackNode, node); - result.Add(Tuple.Create(callstackNode, callstackLink)); - } + var stringBuilder = new StringBuilder(); + try + { + foreach (var frame in singleExecuteProtector.WalkAsyncReturnStackFrames()) + { + stringBuilder.AppendLine(frame); } - - return result; } - - private static string GetAsyncReturnStack(JoinableTaskFactory.SingleExecuteProtector singleExecuteProtector) + catch (Exception ex) { - Requires.NotNull(singleExecuteProtector, nameof(singleExecuteProtector)); + // Just eat the exception so we don't crash during a hang report. + Report.Fail("GetAsyncReturnStackFrames threw exception: ", ex); + } - var stringBuilder = new StringBuilder(); - try + return stringBuilder.ToString().TrimEnd(); + } + + private Dictionary CreateNodesForPendingTasks() + { + var pendingTasksElements = new Dictionary(); + lock (this.pendingTasks) + { + int taskId = 0; + foreach (JoinableTask? pendingTask in this.pendingTasks) { - foreach (var frame in singleExecuteProtector.WalkAsyncReturnStackFrames()) + taskId++; + + string methodName = string.Empty; + System.Reflection.MethodInfo? entryMethodInfo = pendingTask.EntryMethodInfo; + if (entryMethodInfo is object) { - stringBuilder.AppendLine(frame); + methodName = string.Format( + CultureInfo.InvariantCulture, + " ({0}.{1})", + entryMethodInfo.DeclaringType?.FullName, + entryMethodInfo.Name); } - } - catch (Exception ex) - { - // Just eat the exception so we don't crash during a hang report. - Report.Fail("GetAsyncReturnStackFrames threw exception: ", ex); - } - return stringBuilder.ToString().TrimEnd(); - } + XElement? node = Dgml.Node("Task#" + taskId, "Task #" + taskId + methodName) + .WithCategories("Task"); + if (pendingTask.HasNonEmptyQueue) + { + node.WithCategories("NonEmptyQueue"); + } - private Dictionary CreateNodesForPendingTasks() - { - var pendingTasksElements = new Dictionary(); - lock (this.pendingTasks) - { - int taskId = 0; - foreach (JoinableTask? pendingTask in this.pendingTasks) + if (pendingTask.State.HasFlag(JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread)) { - taskId++; - - string methodName = string.Empty; - System.Reflection.MethodInfo? entryMethodInfo = pendingTask.EntryMethodInfo; - if (entryMethodInfo is object) - { - methodName = string.Format( - CultureInfo.InvariantCulture, - " ({0}.{1})", - entryMethodInfo.DeclaringType?.FullName, - entryMethodInfo.Name); - } - - XElement? node = Dgml.Node("Task#" + taskId, "Task #" + taskId + methodName) - .WithCategories("Task"); - if (pendingTask.HasNonEmptyQueue) - { - node.WithCategories("NonEmptyQueue"); - } - - if (pendingTask.State.HasFlag(JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread)) - { - node.WithCategories("MainThreadBlocking"); - } - - pendingTasksElements.Add(pendingTask, node); + node.WithCategories("MainThreadBlocking"); } - } - return pendingTasksElements; + pendingTasksElements.Add(pendingTask, node); + } } + + return pendingTasksElements; } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 0d4bc67de..318fc01ac 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -14,722 +14,721 @@ using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A common context within which joinable tasks may be created and interact to avoid deadlocks. +/// +/// +/// Lots of documentation and FAQ on Joinable Tasks is available on OneNote: . +/// +/// +/// There are three rules that should be strictly followed when using or interacting +/// with JoinableTasks: +/// 1. If a method has certain thread apartment requirements (STA or MTA) it must either: +/// a) Have an asynchronous signature, and asynchronously marshal to the appropriate +/// thread if it isn't originally invoked on a compatible thread. +/// The recommended way to switch to the main thread is: +/// +/// await JoinableTaskFactory.SwitchToMainThreadAsync(); +/// +/// b) Have a synchronous signature, and throw an exception when called on the wrong thread. +/// In particular, no method is allowed to synchronously marshal work to another thread +/// (blocking while that work is done). Synchronous blocks in general are to be avoided +/// whenever possible. +/// 2. When an implementation of an already-shipped public API must call asynchronous code +/// and block for its completion, it must do so by following this simple pattern: +/// +/// JoinableTaskFactory.Run(async delegate { +/// await SomeOperationAsync(...); +/// }); +/// +/// 3. If ever awaiting work that was started earlier, that work must be Joined. +/// For example, one service kicks off some asynchronous work that may later become +/// synchronously blocking: +/// +/// JoinableTask longRunningAsyncWork = JoinableTaskFactory.RunAsync(async delegate { +/// await SomeOperationAsync(...); +/// }); +/// +/// Then later that async work becomes blocking: +/// +/// longRunningAsyncWork.Join(); +/// +/// or perhaps: +/// +/// await longRunningAsyncWork; +/// +/// Note however that this extra step is not necessary when awaiting is done +/// immediately after kicking off an asynchronous operation. +/// +public partial class JoinableTaskContext : IDisposable { /// - /// A common context within which joinable tasks may be created and interact to avoid deadlocks. + /// A "global" lock that allows the graph of interconnected sync context and JoinableSet instances + /// communicate in a thread-safe way without fear of deadlocks due to each taking their own private + /// lock and then calling others, thus leading to deadlocks from lock ordering issues. /// - /// - /// Lots of documentation and FAQ on Joinable Tasks is available on OneNote: . - /// /// - /// There are three rules that should be strictly followed when using or interacting - /// with JoinableTasks: - /// 1. If a method has certain thread apartment requirements (STA or MTA) it must either: - /// a) Have an asynchronous signature, and asynchronously marshal to the appropriate - /// thread if it isn't originally invoked on a compatible thread. - /// The recommended way to switch to the main thread is: - /// - /// await JoinableTaskFactory.SwitchToMainThreadAsync(); - /// - /// b) Have a synchronous signature, and throw an exception when called on the wrong thread. - /// In particular, no method is allowed to synchronously marshal work to another thread - /// (blocking while that work is done). Synchronous blocks in general are to be avoided - /// whenever possible. - /// 2. When an implementation of an already-shipped public API must call asynchronous code - /// and block for its completion, it must do so by following this simple pattern: - /// - /// JoinableTaskFactory.Run(async delegate { - /// await SomeOperationAsync(...); - /// }); - /// - /// 3. If ever awaiting work that was started earlier, that work must be Joined. - /// For example, one service kicks off some asynchronous work that may later become - /// synchronously blocking: - /// - /// JoinableTask longRunningAsyncWork = JoinableTaskFactory.RunAsync(async delegate { - /// await SomeOperationAsync(...); - /// }); - /// - /// Then later that async work becomes blocking: - /// - /// longRunningAsyncWork.Join(); - /// - /// or perhaps: - /// - /// await longRunningAsyncWork; - /// - /// Note however that this extra step is not necessary when awaiting is done - /// immediately after kicking off an asynchronous operation. + /// Yes, global locks should be avoided wherever possible. However even MEF from the .NET Framework + /// uses a global lock around critical composition operations because containers can be interconnected + /// in arbitrary ways. The code in this file has a very similar problem, so we use a similar solution. + /// Except that our lock is only as global as the JoinableTaskContext. It isn't static. /// - public partial class JoinableTaskContext : IDisposable - { - /// - /// A "global" lock that allows the graph of interconnected sync context and JoinableSet instances - /// communicate in a thread-safe way without fear of deadlocks due to each taking their own private - /// lock and then calling others, thus leading to deadlocks from lock ordering issues. - /// - /// - /// Yes, global locks should be avoided wherever possible. However even MEF from the .NET Framework - /// uses a global lock around critical composition operations because containers can be interconnected - /// in arbitrary ways. The code in this file has a very similar problem, so we use a similar solution. - /// Except that our lock is only as global as the JoinableTaskContext. It isn't static. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private readonly object syncContextLock = new object(); + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private readonly object syncContextLock = new object(); - /// - /// An AsyncLocal value that carries the joinable instance associated with an async operation. - /// - private readonly AsyncLocal> joinableOperation = new AsyncLocal>(); + /// + /// An AsyncLocal value that carries the joinable instance associated with an async operation. + /// + private readonly AsyncLocal> joinableOperation = new AsyncLocal>(); - /// - /// The set of tasks that have started but have not yet completed. - /// - /// - /// All access to this collection should be guarded by locking this collection. - /// - private readonly HashSet pendingTasks = new HashSet(); + /// + /// The set of tasks that have started but have not yet completed. + /// + /// + /// All access to this collection should be guarded by locking this collection. + /// + private readonly HashSet pendingTasks = new HashSet(); - /// - /// The stack of tasks which synchronously blocks the main thread in the initial stage (before it yields and CompleteOnCurrentThread starts.) - /// - /// - /// Normally we expect this stack contains 0 or 1 task. When a synchronous task starts another synchronous task in the initialization stage, - /// we might get more than 1 tasks, but it should be very rare to exceed 2 tasks. - /// All access to this collection should be guarded by locking this collection. - /// - private readonly Stack initializingSynchronouslyMainThreadTasks = new Stack(2); + /// + /// The stack of tasks which synchronously blocks the main thread in the initial stage (before it yields and CompleteOnCurrentThread starts.) + /// + /// + /// Normally we expect this stack contains 0 or 1 task. When a synchronous task starts another synchronous task in the initialization stage, + /// we might get more than 1 tasks, but it should be very rare to exceed 2 tasks. + /// All access to this collection should be guarded by locking this collection. + /// + private readonly Stack initializingSynchronouslyMainThreadTasks = new Stack(2); - /// - /// A set of receivers of hang notifications. - /// - /// - /// All access to this collection should be guarded by locking this collection. - /// - private readonly HashSet hangNotifications = new HashSet(); + /// + /// A set of receivers of hang notifications. + /// + /// + /// All access to this collection should be guarded by locking this collection. + /// + private readonly HashSet hangNotifications = new HashSet(); - /// - /// The ManagedThreadID for the main thread. - /// - private readonly int mainThreadManagedThreadId; + /// + /// The ManagedThreadID for the main thread. + /// + private readonly int mainThreadManagedThreadId; - /// - /// The count of s blocking the main thread. - /// - private volatile int mainThreadBlockingJoinableTaskCount; + /// + /// The count of s blocking the main thread. + /// + private volatile int mainThreadBlockingJoinableTaskCount; - /// - /// A single joinable task factory that itself cannot be joined. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private JoinableTaskFactory? nonJoinableFactory; + /// + /// A single joinable task factory that itself cannot be joined. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private JoinableTaskFactory? nonJoinableFactory; - /// - /// Initializes a new instance of the class - /// assuming the current thread is the main thread and - /// will provide the means to switch - /// to the main thread from another thread. - /// - public JoinableTaskContext() - : this(Thread.CurrentThread, SynchronizationContext.Current) - { - } + /// + /// Initializes a new instance of the class + /// assuming the current thread is the main thread and + /// will provide the means to switch + /// to the main thread from another thread. + /// + public JoinableTaskContext() + : this(Thread.CurrentThread, SynchronizationContext.Current) + { + } - /// - /// Initializes a new instance of the class. - /// - /// - /// The thread to switch to in . - /// If omitted, the current thread will be assumed to be the main thread. - /// - /// - /// The synchronization context to use to switch to the main thread. - /// - public JoinableTaskContext(Thread? mainThread = null, SynchronizationContext? synchronizationContext = null) - { - this.MainThread = mainThread ?? Thread.CurrentThread; - this.mainThreadManagedThreadId = this.MainThread.ManagedThreadId; - this.UnderlyingSynchronizationContext = synchronizationContext ?? SynchronizationContext.Current; // may still be null after this. - } + /// + /// Initializes a new instance of the class. + /// + /// + /// The thread to switch to in . + /// If omitted, the current thread will be assumed to be the main thread. + /// + /// + /// The synchronization context to use to switch to the main thread. + /// + public JoinableTaskContext(Thread? mainThread = null, SynchronizationContext? synchronizationContext = null) + { + this.MainThread = mainThread ?? Thread.CurrentThread; + this.mainThreadManagedThreadId = this.MainThread.ManagedThreadId; + this.UnderlyingSynchronizationContext = synchronizationContext ?? SynchronizationContext.Current; // may still be null after this. + } - /// - /// Gets the factory which creates joinable tasks - /// that do not belong to a joinable task collection. - /// - public JoinableTaskFactory Factory + /// + /// Gets the factory which creates joinable tasks + /// that do not belong to a joinable task collection. + /// + public JoinableTaskFactory Factory + { + get { - get + if (this.nonJoinableFactory is null) { - if (this.nonJoinableFactory is null) + using (this.NoMessagePumpSynchronizationContext.Apply()) { - using (this.NoMessagePumpSynchronizationContext.Apply()) + lock (this.SyncContextLock) { - lock (this.SyncContextLock) + if (this.nonJoinableFactory is null) { - if (this.nonJoinableFactory is null) - { - this.nonJoinableFactory = this.CreateDefaultFactory(); - } + this.nonJoinableFactory = this.CreateDefaultFactory(); } } } - - return this.nonJoinableFactory; } + + return this.nonJoinableFactory; } + } - /// - /// Gets the main thread that can be shared by tasks created by this context. - /// - public Thread MainThread { get; private set; } + /// + /// Gets the main thread that can be shared by tasks created by this context. + /// + public Thread MainThread { get; private set; } - /// - /// Gets a value indicating whether the caller is executing on the main thread. - /// - public bool IsOnMainThread => Environment.CurrentManagedThreadId == this.mainThreadManagedThreadId; + /// + /// Gets a value indicating whether the caller is executing on the main thread. + /// + public bool IsOnMainThread => Environment.CurrentManagedThreadId == this.mainThreadManagedThreadId; - /// - /// Gets a value indicating whether the caller is currently running within the context of a joinable task. - /// - /// - /// Use of this property is generally discouraged, as any operation that becomes a no-op when no - /// ambient JoinableTask is present is very cheap. For clients that have complex algorithms that are - /// only relevant if an ambient joinable task is present, this property may serve to skip that for - /// performance reasons. - /// - public bool IsWithinJoinableTask - { - get { return this.AmbientTask is object; } - } + /// + /// Gets a value indicating whether the caller is currently running within the context of a joinable task. + /// + /// + /// Use of this property is generally discouraged, as any operation that becomes a no-op when no + /// ambient JoinableTask is present is very cheap. For clients that have complex algorithms that are + /// only relevant if an ambient joinable task is present, this property may serve to skip that for + /// performance reasons. + /// + public bool IsWithinJoinableTask + { + get { return this.AmbientTask is object; } + } - /// - /// Gets a value indicating whether the main thread is blocked by any joinable task. - /// - internal bool IsMainThreadBlockedByAnyJoinableTask => this.mainThreadBlockingJoinableTaskCount > 0; + /// + /// Gets a value indicating whether the main thread is blocked by any joinable task. + /// + internal bool IsMainThreadBlockedByAnyJoinableTask => this.mainThreadBlockingJoinableTaskCount > 0; - /// - /// Gets the underlying that controls the main thread in the host. - /// - internal SynchronizationContext? UnderlyingSynchronizationContext { get; private set; } + /// + /// Gets the underlying that controls the main thread in the host. + /// + internal SynchronizationContext? UnderlyingSynchronizationContext { get; private set; } - /// - /// Gets the context-wide synchronization lock. - /// - internal object SyncContextLock - { - get { return this.syncContextLock; } - } + /// + /// Gets the context-wide synchronization lock. + /// + internal object SyncContextLock + { + get { return this.syncContextLock; } + } - /// - /// Gets or sets the caller's ambient joinable task. - /// - internal JoinableTask? AmbientTask + /// + /// Gets or sets the caller's ambient joinable task. + /// + internal JoinableTask? AmbientTask + { + get { - get - { - JoinableTask? result = null; - this.joinableOperation.Value?.TryGetTarget(out result); - return result; - } - - set => this.joinableOperation.Value = value?.WeakSelf; + JoinableTask? result = null; + this.joinableOperation.Value?.TryGetTarget(out result); + return result; } - /// - /// Gets a which, when applied, - /// suppresses any message pump that may run during synchronous blocks - /// of the calling thread. - /// - /// - /// The default implementation of this property is effective - /// in builds of this assembly that target the .NET Framework. - /// But on builds that target the portable profile, it should be - /// overridden to provide an effective platform-specific solution. - /// - protected internal virtual SynchronizationContext NoMessagePumpSynchronizationContext + set => this.joinableOperation.Value = value?.WeakSelf; + } + + /// + /// Gets a which, when applied, + /// suppresses any message pump that may run during synchronous blocks + /// of the calling thread. + /// + /// + /// The default implementation of this property is effective + /// in builds of this assembly that target the .NET Framework. + /// But on builds that target the portable profile, it should be + /// overridden to provide an effective platform-specific solution. + /// + protected internal virtual SynchronizationContext NoMessagePumpSynchronizationContext + { + get { - get - { - // Callers of this method are about to take a private lock, which tends - // to cause a deadlock while debugging because of lock contention with the - // debugger's expression evaluator. So prevent that. - Debugger.NotifyOfCrossThreadDependency(); + // Callers of this method are about to take a private lock, which tends + // to cause a deadlock while debugging because of lock contention with the + // debugger's expression evaluator. So prevent that. + Debugger.NotifyOfCrossThreadDependency(); - return NoMessagePumpSyncContext.Default; - } + return NoMessagePumpSyncContext.Default; } + } - /// - /// Conceals any JoinableTask the caller is associated with until the returned value is disposed. - /// - /// A value to dispose of to restore visibility into the caller's associated JoinableTask, if any. - /// - /// In some cases asynchronous work may be spun off inside a delegate supplied to Run, - /// so that the work does not have privileges to re-enter the Main thread until the - /// call has returned and the UI thread is idle. - /// To prevent the asynchronous work from automatically being allowed to re-enter the Main thread, - /// wrap the code that calls the asynchronous task in a using block with a call to this method - /// as the expression. - /// - /// - /// this.JoinableTaskContext.RunSynchronously(async delegate { - /// using(this.JoinableTaskContext.SuppressRelevance()) { - /// var asyncOperation = Task.Run(async delegate { - /// // Some background work. - /// await this.JoinableTaskContext.SwitchToMainThreadAsync(); - /// // Some Main thread work, that cannot begin until the outer RunSynchronously call has returned. - /// }); - /// } - /// - /// // Because the asyncOperation is not related to this Main thread work (it was suppressed), - /// // the following await *would* deadlock if it were uncommented. - /// ////await asyncOperation; - /// }); - /// - /// - /// - public RevertRelevance SuppressRelevance() - { - return new RevertRelevance(this); - } + /// + /// Conceals any JoinableTask the caller is associated with until the returned value is disposed. + /// + /// A value to dispose of to restore visibility into the caller's associated JoinableTask, if any. + /// + /// In some cases asynchronous work may be spun off inside a delegate supplied to Run, + /// so that the work does not have privileges to re-enter the Main thread until the + /// call has returned and the UI thread is idle. + /// To prevent the asynchronous work from automatically being allowed to re-enter the Main thread, + /// wrap the code that calls the asynchronous task in a using block with a call to this method + /// as the expression. + /// + /// + /// this.JoinableTaskContext.RunSynchronously(async delegate { + /// using(this.JoinableTaskContext.SuppressRelevance()) { + /// var asyncOperation = Task.Run(async delegate { + /// // Some background work. + /// await this.JoinableTaskContext.SwitchToMainThreadAsync(); + /// // Some Main thread work, that cannot begin until the outer RunSynchronously call has returned. + /// }); + /// } + /// + /// // Because the asyncOperation is not related to this Main thread work (it was suppressed), + /// // the following await *would* deadlock if it were uncommented. + /// ////await asyncOperation; + /// }); + /// + /// + /// + public RevertRelevance SuppressRelevance() + { + return new RevertRelevance(this); + } - /// - /// Gets a value indicating whether the main thread is blocked for the caller's completion. - /// - public bool IsMainThreadBlocked() + /// + /// Gets a value indicating whether the main thread is blocked for the caller's completion. + /// + public bool IsMainThreadBlocked() + { + JoinableTask? ambientTask = this.AmbientTask; + if (ambientTask is object) { - JoinableTask? ambientTask = this.AmbientTask; - if (ambientTask is object) + if (JoinableTaskDependencyGraph.HasMainThreadSynchronousTaskWaiting(ambientTask)) { - if (JoinableTaskDependencyGraph.HasMainThreadSynchronousTaskWaiting(ambientTask)) - { - return true; - } + return true; + } - // The JoinableTask dependent chain gives a fast way to check IsMainThreadBlocked. - // However, it only works when the main thread tasks is in the CompleteOnCurrentThread loop. - // The dependent chain won't be added when a synchronous task is in the initialization phase. - // In that case, we still need to follow the descendent of the task in the initialization stage. - // We hope the dependency tree is relatively small in that stage. - using (this.NoMessagePumpSynchronizationContext.Apply()) + // The JoinableTask dependent chain gives a fast way to check IsMainThreadBlocked. + // However, it only works when the main thread tasks is in the CompleteOnCurrentThread loop. + // The dependent chain won't be added when a synchronous task is in the initialization phase. + // In that case, we still need to follow the descendent of the task in the initialization stage. + // We hope the dependency tree is relatively small in that stage. + using (this.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.SyncContextLock) { - lock (this.SyncContextLock) + lock (this.initializingSynchronouslyMainThreadTasks) { - lock (this.initializingSynchronouslyMainThreadTasks) + if (this.initializingSynchronouslyMainThreadTasks.Count > 0) { - if (this.initializingSynchronouslyMainThreadTasks.Count > 0) + // our read lock doesn't cover this collection + var allJoinedJobs = new HashSet(); + foreach (JoinableTask? initializingTask in this.initializingSynchronouslyMainThreadTasks) { - // our read lock doesn't cover this collection - var allJoinedJobs = new HashSet(); - foreach (JoinableTask? initializingTask in this.initializingSynchronouslyMainThreadTasks) + if (!JoinableTaskDependencyGraph.HasMainThreadSynchronousTaskWaiting(initializingTask)) { - if (!JoinableTaskDependencyGraph.HasMainThreadSynchronousTaskWaiting(initializingTask)) + // This task blocks the main thread. If it has joined the ambient task + // directly or indirectly, then our ambient task is considered blocking + // the main thread. + JoinableTaskDependencyGraph.AddSelfAndDescendentOrJoinedJobs(initializingTask, allJoinedJobs); + if (allJoinedJobs.Contains(ambientTask)) { - // This task blocks the main thread. If it has joined the ambient task - // directly or indirectly, then our ambient task is considered blocking - // the main thread. - JoinableTaskDependencyGraph.AddSelfAndDescendentOrJoinedJobs(initializingTask, allJoinedJobs); - if (allJoinedJobs.Contains(ambientTask)) - { - return true; - } - - allJoinedJobs.Clear(); + return true; } + + allJoinedJobs.Clear(); } } } } } } - - return false; } - /// - /// Gets a very likely value whether the main thread is blocked for the caller's completion. - /// It is less accurate when the UI thread blocking task just starts and hasn't been blocked yet, or the dependency chain is just removed. - /// However, unlike , this implementation is lock free, and faster in high contention scenarios. - /// - public bool IsMainThreadMaybeBlocked() - { - JoinableTask? ambientTask = this.AmbientTask; - if (ambientTask is object) - { - return ambientTask.MaybeBlockMainThread(); - } - - return false; - } + return false; + } - /// - /// Creates a joinable task factory that automatically adds all created tasks - /// to a collection that can be jointly joined. - /// - /// The collection that all tasks should be added to. - public virtual JoinableTaskFactory CreateFactory(JoinableTaskCollection collection) + /// + /// Gets a very likely value whether the main thread is blocked for the caller's completion. + /// It is less accurate when the UI thread blocking task just starts and hasn't been blocked yet, or the dependency chain is just removed. + /// However, unlike , this implementation is lock free, and faster in high contention scenarios. + /// + public bool IsMainThreadMaybeBlocked() + { + JoinableTask? ambientTask = this.AmbientTask; + if (ambientTask is object) { - Requires.NotNull(collection, nameof(collection)); - return new JoinableTaskFactory(collection); + return ambientTask.MaybeBlockMainThread(); } - /// - /// Creates a collection for in-flight joinable tasks. - /// - /// A new joinable task collection. - public JoinableTaskCollection CreateCollection() - { - return new JoinableTaskCollection(this); - } + return false; + } - /// - public void Dispose() - { - this.Dispose(true); - GC.SuppressFinalize(this); - } + /// + /// Creates a joinable task factory that automatically adds all created tasks + /// to a collection that can be jointly joined. + /// + /// The collection that all tasks should be added to. + public virtual JoinableTaskFactory CreateFactory(JoinableTaskCollection collection) + { + Requires.NotNull(collection, nameof(collection)); + return new JoinableTaskFactory(collection); + } - /// - /// Raised when a joinable task starts. - /// - /// The task that has started. - internal void OnJoinableTaskStarted(JoinableTask task) - { - Requires.NotNull(task, nameof(task)); + /// + /// Creates a collection for in-flight joinable tasks. + /// + /// A new joinable task collection. + public JoinableTaskCollection CreateCollection() + { + return new JoinableTaskCollection(this); + } - using (this.NoMessagePumpSynchronizationContext.Apply()) + /// + public void Dispose() + { + this.Dispose(true); + GC.SuppressFinalize(this); + } + + /// + /// Raised when a joinable task starts. + /// + /// The task that has started. + internal void OnJoinableTaskStarted(JoinableTask task) + { + Requires.NotNull(task, nameof(task)); + + using (this.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.pendingTasks) { - lock (this.pendingTasks) - { - Assumes.True(this.pendingTasks.Add(task)); - } + Assumes.True(this.pendingTasks.Add(task)); + } - if ((task.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + if ((task.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + { + lock (this.initializingSynchronouslyMainThreadTasks) { - lock (this.initializingSynchronouslyMainThreadTasks) - { - this.initializingSynchronouslyMainThreadTasks.Push(task); - } + this.initializingSynchronouslyMainThreadTasks.Push(task); } } } + } - /// - /// Raised when a joinable task completes. - /// - /// The completing task. - internal void OnJoinableTaskCompleted(JoinableTask task) - { - Requires.NotNull(task, nameof(task)); + /// + /// Raised when a joinable task completes. + /// + /// The completing task. + internal void OnJoinableTaskCompleted(JoinableTask task) + { + Requires.NotNull(task, nameof(task)); - using (this.NoMessagePumpSynchronizationContext.Apply()) + using (this.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.pendingTasks) { - lock (this.pendingTasks) - { - this.pendingTasks.Remove(task); - } + this.pendingTasks.Remove(task); } } + } - /// - /// Raised when it starts to wait a joinable task to complete in the main thread. - /// - /// The task requires to be completed. - internal void OnSynchronousJoinableTaskToCompleteOnMainThread(JoinableTask task) - { - Requires.NotNull(task, nameof(task)); + /// + /// Raised when it starts to wait a joinable task to complete in the main thread. + /// + /// The task requires to be completed. + internal void OnSynchronousJoinableTaskToCompleteOnMainThread(JoinableTask task) + { + Requires.NotNull(task, nameof(task)); - using (this.NoMessagePumpSynchronizationContext.Apply()) + using (this.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.initializingSynchronouslyMainThreadTasks) { - lock (this.initializingSynchronouslyMainThreadTasks) - { - Assumes.True(this.initializingSynchronouslyMainThreadTasks.Count > 0); - Assumes.True(this.initializingSynchronouslyMainThreadTasks.Peek() == task); - this.initializingSynchronouslyMainThreadTasks.Pop(); - } + Assumes.True(this.initializingSynchronouslyMainThreadTasks.Count > 0); + Assumes.True(this.initializingSynchronouslyMainThreadTasks.Peek() == task); + this.initializingSynchronouslyMainThreadTasks.Pop(); } } + } - /// - /// Registers a node for notification when a hang is detected. - /// - /// The instance to notify. - /// A value to dispose of to cancel registration. - internal IDisposable RegisterHangNotifications(JoinableTaskContextNode node) - { - Requires.NotNull(node, nameof(node)); + /// + /// Registers a node for notification when a hang is detected. + /// + /// The instance to notify. + /// A value to dispose of to cancel registration. + internal IDisposable RegisterHangNotifications(JoinableTaskContextNode node) + { + Requires.NotNull(node, nameof(node)); - using (this.NoMessagePumpSynchronizationContext.Apply()) + using (this.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.hangNotifications) { - lock (this.hangNotifications) + if (!this.hangNotifications.Add(node)) { - if (!this.hangNotifications.Add(node)) - { - Verify.FailOperation(Strings.JoinableTaskContextNodeAlreadyRegistered); - } + Verify.FailOperation(Strings.JoinableTaskContextNodeAlreadyRegistered); } } - - return new HangNotificationRegistration(node); } - /// - /// Increment the count of s blocking the main thread. - /// - /// - /// This method should only be called on the main thread. - /// - internal void IncrementMainThreadBlockingCount() + return new HangNotificationRegistration(node); + } + + /// + /// Increment the count of s blocking the main thread. + /// + /// + /// This method should only be called on the main thread. + /// + internal void IncrementMainThreadBlockingCount() + { + Assumes.True(this.IsOnMainThread); + this.mainThreadBlockingJoinableTaskCount++; + } + + /// + /// Decrement the count of s blocking the main thread. + /// + /// + /// This method should only be called on the main thread. + /// + internal void DecrementMainThreadBlockingCount() + { + Assumes.True(this.IsOnMainThread); + this.mainThreadBlockingJoinableTaskCount--; + } + + /// + /// Invoked when a hang is suspected to have occurred involving the main thread. + /// + /// The duration of the current hang. + /// The number of times this hang has been reported, including this one. + /// A random GUID that uniquely identifies this particular hang. + /// + /// A single hang occurrence may invoke this method multiple times, with increasing + /// values in the parameter. + /// + protected internal virtual void OnHangDetected(TimeSpan hangDuration, int notificationCount, Guid hangId) + { + List listeners; + using (this.NoMessagePumpSynchronizationContext.Apply()) { - Assumes.True(this.IsOnMainThread); - this.mainThreadBlockingJoinableTaskCount++; + lock (this.hangNotifications) + { + listeners = this.hangNotifications.ToList(); + } } - /// - /// Decrement the count of s blocking the main thread. - /// - /// - /// This method should only be called on the main thread. - /// - internal void DecrementMainThreadBlockingCount() + JoinableTask? blockingTask = JoinableTask.TaskCompletingOnThisThread; + var hangDetails = new HangDetails( + hangDuration, + notificationCount, + hangId, + blockingTask?.EntryMethodInfo); + foreach (JoinableTaskContextNode? listener in listeners) { - Assumes.True(this.IsOnMainThread); - this.mainThreadBlockingJoinableTaskCount--; + try + { + listener.OnHangDetected(hangDetails); + } + catch (Exception ex) + { + // Report it in CHK, but don't throw. In a hang situation, we don't want the product + // to fail for another reason, thus hiding the hang issue. + Report.Fail("Exception thrown from OnHangDetected listener. {0}", ex); + } } + } - /// - /// Invoked when a hang is suspected to have occurred involving the main thread. - /// - /// The duration of the current hang. - /// The number of times this hang has been reported, including this one. - /// A random GUID that uniquely identifies this particular hang. - /// - /// A single hang occurrence may invoke this method multiple times, with increasing - /// values in the parameter. - /// - protected internal virtual void OnHangDetected(TimeSpan hangDuration, int notificationCount, Guid hangId) + /// + /// Invoked when an earlier hang report is false alarm. + /// + protected internal virtual void OnFalseHangDetected(TimeSpan hangDuration, Guid hangId) + { + List listeners; + using (this.NoMessagePumpSynchronizationContext.Apply()) { - List listeners; - using (this.NoMessagePumpSynchronizationContext.Apply()) + lock (this.hangNotifications) { - lock (this.hangNotifications) - { - listeners = this.hangNotifications.ToList(); - } + listeners = this.hangNotifications.ToList(); } + } - JoinableTask? blockingTask = JoinableTask.TaskCompletingOnThisThread; - var hangDetails = new HangDetails( - hangDuration, - notificationCount, - hangId, - blockingTask?.EntryMethodInfo); - foreach (JoinableTaskContextNode? listener in listeners) + foreach (JoinableTaskContextNode? listener in listeners) + { + try { - try - { - listener.OnHangDetected(hangDetails); - } - catch (Exception ex) - { - // Report it in CHK, but don't throw. In a hang situation, we don't want the product - // to fail for another reason, thus hiding the hang issue. - Report.Fail("Exception thrown from OnHangDetected listener. {0}", ex); - } + listener.OnFalseHangDetected(hangDuration, hangId); + } + catch (Exception ex) + { + // Report it in CHK, but don't throw. In a hang situation, we don't want the product + // to fail for another reason, thus hiding the hang issue. + Report.Fail("Exception thrown from OnHangDetected listener. {0}", ex); } } + } + + /// + /// Creates a factory without a . + /// + /// + /// Used for initializing the property. + /// + protected internal virtual JoinableTaskFactory CreateDefaultFactory() + { + return new JoinableTaskFactory(this); + } + + /// + /// Disposes managed and unmanaged resources held by this instance. + /// + /// if was called; if the object is being finalized. + protected virtual void Dispose(bool disposing) + { + } + + /// + /// A structure that clears CallContext and SynchronizationContext async/thread statics and + /// restores those values when this structure is disposed. + /// + public readonly struct RevertRelevance : IDisposable + { + private readonly JoinableTaskContext? pump; + private readonly SpecializedSyncContext temporarySyncContext; + private readonly JoinableTask? oldJoinable; /// - /// Invoked when an earlier hang report is false alarm. + /// Initializes a new instance of the struct. /// - protected internal virtual void OnFalseHangDetected(TimeSpan hangDuration, Guid hangId) + /// The instance that created this value. + internal RevertRelevance(JoinableTaskContext pump) { - List listeners; - using (this.NoMessagePumpSynchronizationContext.Apply()) + Requires.NotNull(pump, nameof(pump)); + this.pump = pump; + + this.oldJoinable = pump.AmbientTask; + pump.AmbientTask = null; + + if (SynchronizationContext.Current is JoinableTaskSynchronizationContext jobSyncContext) { - lock (this.hangNotifications) + SynchronizationContext? appliedSyncContext = null; + if (jobSyncContext.MainThreadAffinitized) { - listeners = this.hangNotifications.ToList(); + appliedSyncContext = pump.UnderlyingSynchronizationContext; } - } - foreach (JoinableTaskContextNode? listener in listeners) + this.temporarySyncContext = appliedSyncContext.Apply(); // Apply() extension method allows null receiver + } + else { - try - { - listener.OnFalseHangDetected(hangDuration, hangId); - } - catch (Exception ex) - { - // Report it in CHK, but don't throw. In a hang situation, we don't want the product - // to fail for another reason, thus hiding the hang issue. - Report.Fail("Exception thrown from OnHangDetected listener. {0}", ex); - } + this.temporarySyncContext = default(SpecializedSyncContext); } } /// - /// Creates a factory without a . + /// Reverts the async local and thread static values to their original values. /// - /// - /// Used for initializing the property. - /// - protected internal virtual JoinableTaskFactory CreateDefaultFactory() + public void Dispose() { - return new JoinableTaskFactory(this); + if (this.pump is object) + { + this.pump.AmbientTask = this.oldJoinable; + } + + this.temporarySyncContext.Dispose(); } + } - /// - /// Disposes managed and unmanaged resources held by this instance. - /// - /// if was called; if the object is being finalized. - protected virtual void Dispose(bool disposing) + /// + /// A class to encapsulate the details of a possible hang. + /// An instance of this class will be passed to the + /// instances who registered the hang notifications. + /// + public class HangDetails + { + /// Initializes a new instance of the class. + /// The duration of the current hang. + /// The number of times this hang has been reported, including this one. + /// A random GUID that uniquely identifies this particular hang. + /// The method that served as the entrypoint for the JoinableTask. + public HangDetails(TimeSpan hangDuration, int notificationCount, Guid hangId, MethodInfo? entryMethod) { + this.HangDuration = hangDuration; + this.NotificationCount = notificationCount; + this.HangId = hangId; + this.EntryMethod = entryMethod; } /// - /// A structure that clears CallContext and SynchronizationContext async/thread statics and - /// restores those values when this structure is disposed. + /// Gets the length of time this hang has lasted so far. /// - public readonly struct RevertRelevance : IDisposable - { - private readonly JoinableTaskContext? pump; - private readonly SpecializedSyncContext temporarySyncContext; - private readonly JoinableTask? oldJoinable; - - /// - /// Initializes a new instance of the struct. - /// - /// The instance that created this value. - internal RevertRelevance(JoinableTaskContext pump) - { - Requires.NotNull(pump, nameof(pump)); - this.pump = pump; - - this.oldJoinable = pump.AmbientTask; - pump.AmbientTask = null; + public TimeSpan HangDuration { get; private set; } - if (SynchronizationContext.Current is JoinableTaskSynchronizationContext jobSyncContext) - { - SynchronizationContext? appliedSyncContext = null; - if (jobSyncContext.MainThreadAffinitized) - { - appliedSyncContext = pump.UnderlyingSynchronizationContext; - } + /// + /// Gets the number of times this particular hang has been reported, including this one. + /// + public int NotificationCount { get; private set; } - this.temporarySyncContext = appliedSyncContext.Apply(); // Apply() extension method allows null receiver - } - else - { - this.temporarySyncContext = default(SpecializedSyncContext); - } - } + /// + /// Gets a unique GUID identifying this particular hang. + /// If the same hang is reported multiple times (with increasing duration values) + /// the value of this property will remain constant. + /// + public Guid HangId { get; private set; } - /// - /// Reverts the async local and thread static values to their original values. - /// - public void Dispose() - { - if (this.pump is object) - { - this.pump.AmbientTask = this.oldJoinable; - } + /// + /// Gets the method that served as the entrypoint for the JoinableTask that now blocks a thread. + /// + /// + /// The method indicated here may not be the one that is actually blocking a thread, + /// but typically a deadlock is caused by a violation of a threading rule which is under + /// the entrypoint's control. So usually regardless of where someone chooses the block + /// a thread for the completion of a , a hang usually indicates + /// a bug in the code that created it. + /// This value may be used to assign the hangs to different buckets based on this method info. + /// + public MethodInfo? EntryMethod { get; private set; } + } - this.temporarySyncContext.Dispose(); - } - } + /// + /// A value whose disposal cancels hang registration. + /// + private class HangNotificationRegistration : IDisposable + { + /// + /// The node to receive notifications. May be if has already been called. + /// + private JoinableTaskContextNode? node; /// - /// A class to encapsulate the details of a possible hang. - /// An instance of this class will be passed to the - /// instances who registered the hang notifications. + /// Initializes a new instance of the class. /// - public class HangDetails + internal HangNotificationRegistration(JoinableTaskContextNode node) { - /// Initializes a new instance of the class. - /// The duration of the current hang. - /// The number of times this hang has been reported, including this one. - /// A random GUID that uniquely identifies this particular hang. - /// The method that served as the entrypoint for the JoinableTask. - public HangDetails(TimeSpan hangDuration, int notificationCount, Guid hangId, MethodInfo? entryMethod) - { - this.HangDuration = hangDuration; - this.NotificationCount = notificationCount; - this.HangId = hangId; - this.EntryMethod = entryMethod; - } - - /// - /// Gets the length of time this hang has lasted so far. - /// - public TimeSpan HangDuration { get; private set; } - - /// - /// Gets the number of times this particular hang has been reported, including this one. - /// - public int NotificationCount { get; private set; } - - /// - /// Gets a unique GUID identifying this particular hang. - /// If the same hang is reported multiple times (with increasing duration values) - /// the value of this property will remain constant. - /// - public Guid HangId { get; private set; } - - /// - /// Gets the method that served as the entrypoint for the JoinableTask that now blocks a thread. - /// - /// - /// The method indicated here may not be the one that is actually blocking a thread, - /// but typically a deadlock is caused by a violation of a threading rule which is under - /// the entrypoint's control. So usually regardless of where someone chooses the block - /// a thread for the completion of a , a hang usually indicates - /// a bug in the code that created it. - /// This value may be used to assign the hangs to different buckets based on this method info. - /// - public MethodInfo? EntryMethod { get; private set; } + Requires.NotNull(node, nameof(node)); + this.node = node; } /// - /// A value whose disposal cancels hang registration. + /// Removes the node from hang notifications. /// - private class HangNotificationRegistration : IDisposable + public void Dispose() { - /// - /// The node to receive notifications. May be if has already been called. - /// - private JoinableTaskContextNode? node; - - /// - /// Initializes a new instance of the class. - /// - internal HangNotificationRegistration(JoinableTaskContextNode node) + JoinableTaskContextNode? node = this.node; + if (node is object) { - Requires.NotNull(node, nameof(node)); - this.node = node; - } - - /// - /// Removes the node from hang notifications. - /// - public void Dispose() - { - JoinableTaskContextNode? node = this.node; - if (node is object) + using (node.Context.NoMessagePumpSynchronizationContext.Apply()) { - using (node.Context.NoMessagePumpSynchronizationContext.Apply()) + lock (node.Context.hangNotifications) { - lock (node.Context.hangNotifications) - { - Assumes.True(node.Context.hangNotifications.Remove(node)); - } + Assumes.True(node.Context.hangNotifications.Remove(node)); } - - this.node = null; } + + this.node = null; } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs index 4f33333ed..c43176585 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextException.cs @@ -3,50 +3,49 @@ using System; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An exception thrown when the configuration provided to the +/// are incorrect or a virtual method is overridden such that it violates a contract. +/// This exception should not be caught. It is thrown when the application has a programming fault. +/// +[Serializable] +public class JoinableTaskContextException : Exception { /// - /// An exception thrown when the configuration provided to the - /// are incorrect or a virtual method is overridden such that it violates a contract. - /// This exception should not be caught. It is thrown when the application has a programming fault. + /// Initializes a new instance of the class. /// - [Serializable] - public class JoinableTaskContextException : Exception + public JoinableTaskContextException() { - /// - /// Initializes a new instance of the class. - /// - public JoinableTaskContextException() - { - } + } - /// - /// Initializes a new instance of the class. - /// - /// The message for the exception. - public JoinableTaskContextException(string? message) - : base(message) - { - } + /// + /// Initializes a new instance of the class. + /// + /// The message for the exception. + public JoinableTaskContextException(string? message) + : base(message) + { + } - /// - /// Initializes a new instance of the class. - /// - /// The message for the exception. - /// The inner exception. - public JoinableTaskContextException(string? message, Exception? inner) - : base(message, inner) - { - } + /// + /// Initializes a new instance of the class. + /// + /// The message for the exception. + /// The inner exception. + public JoinableTaskContextException(string? message, Exception? inner) + : base(message, inner) + { + } - /// - /// Initializes a new instance of the class. - /// - protected JoinableTaskContextException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) - : base(info, context) - { - } + /// + /// Initializes a new instance of the class. + /// + protected JoinableTaskContextException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) + : base(info, context) + { } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs index 0b5c67721..9c96f73c4 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContextNode.cs @@ -9,193 +9,192 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A customizable source of instances. +/// +public class JoinableTaskContextNode { /// - /// A customizable source of instances. + /// The inner JoinableTaskContext. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private readonly JoinableTaskContext context; + + /// + /// A single joinable task factory that itself cannot be joined. /// - public class JoinableTaskContextNode + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private JoinableTaskFactory? nonJoinableFactory; + + /// + /// Initializes a new instance of the class. + /// + /// The inner JoinableTaskContext. + public JoinableTaskContextNode(JoinableTaskContext context) { - /// - /// The inner JoinableTaskContext. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private readonly JoinableTaskContext context; - - /// - /// A single joinable task factory that itself cannot be joined. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private JoinableTaskFactory? nonJoinableFactory; - - /// - /// Initializes a new instance of the class. - /// - /// The inner JoinableTaskContext. - public JoinableTaskContextNode(JoinableTaskContext context) - { - Requires.NotNull(context, nameof(context)); - this.context = context; - } + Requires.NotNull(context, nameof(context)); + this.context = context; + } - /// - /// Gets the factory which creates joinable tasks - /// that do not belong to a joinable task collection. - /// - public JoinableTaskFactory Factory + /// + /// Gets the factory which creates joinable tasks + /// that do not belong to a joinable task collection. + /// + public JoinableTaskFactory Factory + { + get { - get + if (this.nonJoinableFactory is null) { - if (this.nonJoinableFactory is null) - { - JoinableTaskFactory? factory = this.CreateDefaultFactory(); - Interlocked.CompareExchange(ref this.nonJoinableFactory, factory, null); - } - - return this.nonJoinableFactory; + JoinableTaskFactory? factory = this.CreateDefaultFactory(); + Interlocked.CompareExchange(ref this.nonJoinableFactory, factory, null); } - } - /// - /// Gets the main thread that can be shared by tasks created by this context. - /// - public Thread MainThread - { - get { return this.context.MainThread; } + return this.nonJoinableFactory; } + } - /// - /// Gets a value indicating whether the caller is executing on the main thread. - /// - public bool IsOnMainThread => this.context.IsOnMainThread; + /// + /// Gets the main thread that can be shared by tasks created by this context. + /// + public Thread MainThread + { + get { return this.context.MainThread; } + } - /// - /// Gets the inner wrapped context. - /// - public JoinableTaskContext Context - { - get { return this.context; } - } + /// + /// Gets a value indicating whether the caller is executing on the main thread. + /// + public bool IsOnMainThread => this.context.IsOnMainThread; - /// - /// Creates a joinable task factory that automatically adds all created tasks - /// to a collection that can be jointly joined. - /// - /// The collection that all tasks should be added to. - public virtual JoinableTaskFactory CreateFactory(JoinableTaskCollection collection) - { - return this.context.CreateFactory(collection); - } + /// + /// Gets the inner wrapped context. + /// + public JoinableTaskContext Context + { + get { return this.context; } + } - /// - /// Creates a collection for in-flight joinable tasks. - /// - /// A new joinable task collection. - public JoinableTaskCollection CreateCollection() - { - return this.context.CreateCollection(); - } + /// + /// Creates a joinable task factory that automatically adds all created tasks + /// to a collection that can be jointly joined. + /// + /// The collection that all tasks should be added to. + public virtual JoinableTaskFactory CreateFactory(JoinableTaskCollection collection) + { + return this.context.CreateFactory(collection); + } - /// - /// Conceals any JoinableTask the caller is associated with until the returned value is disposed. - /// - /// A value to dispose of to restore visibility into the caller's associated JoinableTask, if any. - /// - /// In some cases asynchronous work may be spun off inside a delegate supplied to Run, - /// so that the work does not have privileges to re-enter the Main thread until the - /// call has returned and the UI thread is idle. - /// To prevent the asynchronous work from automatically being allowed to re-enter the Main thread, - /// wrap the code that calls the asynchronous task in a using block with a call to this method - /// as the expression. - /// - /// - /// this.JoinableTaskContext.RunSynchronously(async delegate { - /// using(this.JoinableTaskContext.SuppressRelevance()) { - /// var asyncOperation = Task.Run(async delegate { - /// // Some background work. - /// await this.JoinableTaskContext.SwitchToMainThreadAsync(); - /// // Some Main thread work, that cannot begin until the outer RunSynchronously call has returned. - /// }); - /// } - /// - /// // Because the asyncOperation is not related to this Main thread work (it was suppressed), - /// // the following await *would* deadlock if it were uncommented. - /// ////await asyncOperation; - /// }); - /// - /// - /// - public JoinableTaskContext.RevertRelevance SuppressRelevance() - { - return this.context.SuppressRelevance(); - } + /// + /// Creates a collection for in-flight joinable tasks. + /// + /// A new joinable task collection. + public JoinableTaskCollection CreateCollection() + { + return this.context.CreateCollection(); + } - /// - /// Gets a value indicating whether the main thread is blocked for the caller's completion. - /// - public bool IsMainThreadBlocked() - { - return this.context.IsMainThreadBlocked(); - } + /// + /// Conceals any JoinableTask the caller is associated with until the returned value is disposed. + /// + /// A value to dispose of to restore visibility into the caller's associated JoinableTask, if any. + /// + /// In some cases asynchronous work may be spun off inside a delegate supplied to Run, + /// so that the work does not have privileges to re-enter the Main thread until the + /// call has returned and the UI thread is idle. + /// To prevent the asynchronous work from automatically being allowed to re-enter the Main thread, + /// wrap the code that calls the asynchronous task in a using block with a call to this method + /// as the expression. + /// + /// + /// this.JoinableTaskContext.RunSynchronously(async delegate { + /// using(this.JoinableTaskContext.SuppressRelevance()) { + /// var asyncOperation = Task.Run(async delegate { + /// // Some background work. + /// await this.JoinableTaskContext.SwitchToMainThreadAsync(); + /// // Some Main thread work, that cannot begin until the outer RunSynchronously call has returned. + /// }); + /// } + /// + /// // Because the asyncOperation is not related to this Main thread work (it was suppressed), + /// // the following await *would* deadlock if it were uncommented. + /// ////await asyncOperation; + /// }); + /// + /// + /// + public JoinableTaskContext.RevertRelevance SuppressRelevance() + { + return this.context.SuppressRelevance(); + } - /// - /// Invoked when a hang is suspected to have occurred involving the main thread. - /// - /// Describes the hang in detail. - /// - /// A single hang occurrence may invoke this method multiple times, with increasing - /// values in the values - /// in the parameter. - /// - protected internal virtual void OnHangDetected(JoinableTaskContext.HangDetails details) - { - Requires.NotNull(details, nameof(details)); + /// + /// Gets a value indicating whether the main thread is blocked for the caller's completion. + /// + public bool IsMainThreadBlocked() + { + return this.context.IsMainThreadBlocked(); + } - // Preserve backward compatibility by forwarding the call to the older overload. - this.OnHangDetected(details.HangDuration, details.NotificationCount, details.HangId); - } + /// + /// Invoked when a hang is suspected to have occurred involving the main thread. + /// + /// Describes the hang in detail. + /// + /// A single hang occurrence may invoke this method multiple times, with increasing + /// values in the values + /// in the parameter. + /// + protected internal virtual void OnHangDetected(JoinableTaskContext.HangDetails details) + { + Requires.NotNull(details, nameof(details)); - /// - /// Invoked when an earlier hang report is false alarm. - /// - /// The duration of the total waiting time. - /// A GUID that uniquely identifies the earlier hang report. - protected internal virtual void OnFalseHangDetected(TimeSpan hangDuration, Guid hangId) - { - } + // Preserve backward compatibility by forwarding the call to the older overload. + this.OnHangDetected(details.HangDuration, details.NotificationCount, details.HangId); + } - /// - /// Invoked when a hang is suspected to have occurred involving the main thread. - /// - /// The duration of the current hang. - /// The number of times this hang has been reported, including this one. - /// A random GUID that uniquely identifies this particular hang. - /// - /// A single hang occurrence may invoke this method multiple times, with increasing - /// values in the parameter. - /// - protected virtual void OnHangDetected(TimeSpan hangDuration, int notificationCount, Guid hangId) - { - } + /// + /// Invoked when an earlier hang report is false alarm. + /// + /// The duration of the total waiting time. + /// A GUID that uniquely identifies the earlier hang report. + protected internal virtual void OnFalseHangDetected(TimeSpan hangDuration, Guid hangId) + { + } - /// - /// Creates a factory without a . - /// - /// - /// Used for initializing the property. - /// - protected virtual JoinableTaskFactory CreateDefaultFactory() - { - return this.context.CreateDefaultFactory(); - } + /// + /// Invoked when a hang is suspected to have occurred involving the main thread. + /// + /// The duration of the current hang. + /// The number of times this hang has been reported, including this one. + /// A random GUID that uniquely identifies this particular hang. + /// + /// A single hang occurrence may invoke this method multiple times, with increasing + /// values in the parameter. + /// + protected virtual void OnHangDetected(TimeSpan hangDuration, int notificationCount, Guid hangId) + { + } - /// - /// Registers with the inner to receive hang notifications. - /// - /// A value to dispose of to cancel hang notifications. - protected IDisposable RegisterOnHangDetected() - { - return this.context.RegisterHangNotifications(this); - } + /// + /// Creates a factory without a . + /// + /// + /// Used for initializing the property. + /// + protected virtual JoinableTaskFactory CreateDefaultFactory() + { + return this.context.CreateDefaultFactory(); + } + + /// + /// Registers with the inner to receive hang notifications. + /// + /// A value to dispose of to cancel hang notifications. + protected IDisposable RegisterOnHangDetected() + { + return this.context.RegisterHangNotifications(this); } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs index 7bc1784f6..b2e81852e 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskCreationOptions.cs @@ -3,24 +3,23 @@ using System; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Specifies flags that control optional behavior for the creation and execution of tasks. +/// +[Flags] +[Serializable] +public enum JoinableTaskCreationOptions { /// - /// Specifies flags that control optional behavior for the creation and execution of tasks. + /// Specifies that the default behavior should be used. /// - [Flags] - [Serializable] - public enum JoinableTaskCreationOptions - { - /// - /// Specifies that the default behavior should be used. - /// - None = 0x0, + None = 0x0, - /// - /// Specifies that a task will be a long-running operation. It provides a hint to the - /// that hang report should not be fired, when the main thread task is blocked on it. - /// - LongRunning = 0x01, - } + /// + /// Specifies that a task will be a long-running operation. It provides a hint to the + /// that hang report should not be fired, when the main thread task is blocked on it. + /// + LongRunning = 0x01, } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs index e4ae34b07..4f054bdf9 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs @@ -8,1109 +8,1108 @@ using System.Linq; using System.Threading; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Methods to maintain dependencies between . +/// Those methods are expected to be called by or only to maintain relationship between them, and should not be called directly by other code. +/// +internal static class JoinableTaskDependencyGraph { + private static readonly HashSet EmptySet = new HashSet(); + /// - /// Methods to maintain dependencies between . - /// Those methods are expected to be called by or only to maintain relationship between them, and should not be called directly by other code. + /// Gets a value indicating whether there is no child depenent item. + /// This method is expected to be used with the JTF lock. /// - internal static class JoinableTaskDependencyGraph + internal static bool HasNoChildDependentNode(IJoinableTaskDependent taskItem) { - private static readonly HashSet EmptySet = new HashSet(); - - /// - /// Gets a value indicating whether there is no child depenent item. - /// This method is expected to be used with the JTF lock. - /// - internal static bool HasNoChildDependentNode(IJoinableTaskDependent taskItem) - { - Requires.NotNull(taskItem, nameof(taskItem)); - Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); - return taskItem.GetJoinableTaskDependentData().HasNoChildDependentNode; - } + Requires.NotNull(taskItem, nameof(taskItem)); + Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); + return taskItem.GetJoinableTaskDependentData().HasNoChildDependentNode; + } - /// - /// Checks whether a task or collection is a directly dependent of this item. - /// This method is expected to be used with the JTF lock. - /// - internal static bool HasDirectDependency(IJoinableTaskDependent taskItem, IJoinableTaskDependent dependency) - { - Requires.NotNull(taskItem, nameof(taskItem)); - Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); - return taskItem.GetJoinableTaskDependentData().HasDirectDependency(dependency); - } + /// + /// Checks whether a task or collection is a directly dependent of this item. + /// This method is expected to be used with the JTF lock. + /// + internal static bool HasDirectDependency(IJoinableTaskDependent taskItem, IJoinableTaskDependent dependency) + { + Requires.NotNull(taskItem, nameof(taskItem)); + Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); + return taskItem.GetJoinableTaskDependentData().HasDirectDependency(dependency); + } - /// - /// Gets a value indicating whether the main thread is waiting for the task's completion. - /// - internal static bool HasMainThreadSynchronousTaskWaiting(IJoinableTaskDependent taskItem) + /// + /// Gets a value indicating whether the main thread is waiting for the task's completion. + /// + internal static bool HasMainThreadSynchronousTaskWaiting(IJoinableTaskDependent taskItem) + { + Requires.NotNull(taskItem, nameof(taskItem)); + using (taskItem.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - Requires.NotNull(taskItem, nameof(taskItem)); - using (taskItem.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + lock (taskItem.JoinableTaskContext.SyncContextLock) { - lock (taskItem.JoinableTaskContext.SyncContextLock) - { - return taskItem.GetJoinableTaskDependentData().HasMainThreadSynchronousTaskWaiting(taskItem); - } + return taskItem.GetJoinableTaskDependentData().HasMainThreadSynchronousTaskWaiting(taskItem); } } + } - /// - /// Gets a likely value whether the main thread is blocked for the caller's completion. - /// - internal static bool MaybeHasMainThreadSynchronousTaskWaiting(IJoinableTaskDependent taskItem) - { - return taskItem.GetJoinableTaskDependentData().MaybeHasMainThreadSynchronousTaskWaiting(); - } + /// + /// Gets a likely value whether the main thread is blocked for the caller's completion. + /// + internal static bool MaybeHasMainThreadSynchronousTaskWaiting(IJoinableTaskDependent taskItem) + { + return taskItem.GetJoinableTaskDependentData().MaybeHasMainThreadSynchronousTaskWaiting(); + } - /// - /// Adds a instance as one that is relevant to the async operation. - /// - /// The current joinableTask or collection. - /// The to join as a child. - internal static JoinableTaskCollection.JoinRelease AddDependency(IJoinableTaskDependent taskItem, IJoinableTaskDependent joinChild) - { - Requires.NotNull(taskItem, nameof(taskItem)); - return JoinableTaskDependentData.AddDependency(taskItem, joinChild); - } + /// + /// Adds a instance as one that is relevant to the async operation. + /// + /// The current joinableTask or collection. + /// The to join as a child. + internal static JoinableTaskCollection.JoinRelease AddDependency(IJoinableTaskDependent taskItem, IJoinableTaskDependent joinChild) + { + Requires.NotNull(taskItem, nameof(taskItem)); + return JoinableTaskDependentData.AddDependency(taskItem, joinChild); + } - /// - /// Removes a instance as one that is no longer relevant to the async operation. - /// - /// The current joinableTask or collection. - /// The to join as a child. - /// Ignore refCount, it is being used when the child task is completed. - internal static void RemoveDependency(IJoinableTaskDependent taskItem, IJoinableTaskDependent child, bool forceCleanup = false) - { - Requires.NotNull(taskItem, nameof(taskItem)); - JoinableTaskDependentData.RemoveDependency(taskItem, child, forceCleanup); - } + /// + /// Removes a instance as one that is no longer relevant to the async operation. + /// + /// The current joinableTask or collection. + /// The to join as a child. + /// Ignore refCount, it is being used when the child task is completed. + internal static void RemoveDependency(IJoinableTaskDependent taskItem, IJoinableTaskDependent child, bool forceCleanup = false) + { + Requires.NotNull(taskItem, nameof(taskItem)); + JoinableTaskDependentData.RemoveDependency(taskItem, child, forceCleanup); + } - /// - /// Gets all dependent nodes registered in the dependency collection. - /// This method is expected to be used with the JTF lock. - /// - internal static IEnumerable GetDirectDependentNodes(IJoinableTaskDependent taskItem) - { - Requires.NotNull(taskItem, nameof(taskItem)); - Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); - return taskItem.GetJoinableTaskDependentData().GetDirectDependentNodes(); - } + /// + /// Gets all dependent nodes registered in the dependency collection. + /// This method is expected to be used with the JTF lock. + /// + internal static IEnumerable GetDirectDependentNodes(IJoinableTaskDependent taskItem) + { + Requires.NotNull(taskItem, nameof(taskItem)); + Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); + return taskItem.GetJoinableTaskDependentData().GetDirectDependentNodes(); + } - /// - /// Check whether a task is being tracked in our tracking list. - /// - internal static bool IsDependingSynchronousTask(IJoinableTaskDependent taskItem, JoinableTask syncTask) - { - Requires.NotNull(taskItem, nameof(taskItem)); - return taskItem.GetJoinableTaskDependentData().IsDependingSynchronousTask(syncTask); - } + /// + /// Check whether a task is being tracked in our tracking list. + /// + internal static bool IsDependingSynchronousTask(IJoinableTaskDependent taskItem, JoinableTask syncTask) + { + Requires.NotNull(taskItem, nameof(taskItem)); + return taskItem.GetJoinableTaskDependentData().IsDependingSynchronousTask(syncTask); + } - /// - /// Calculate the collection of events we need trigger after we enqueue a request. - /// This method is expected to be used with the JTF lock. - /// - /// The current joinableTask or collection. - /// True if we want to find tasks to process the main thread queue. Otherwise tasks to process the background queue. - /// The collection of synchronous tasks we need notify. - internal static IReadOnlyCollection GetDependingSynchronousTasks(IJoinableTaskDependent taskItem, bool forMainThread) - { - Requires.NotNull(taskItem, nameof(taskItem)); - Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); - return taskItem.GetJoinableTaskDependentData().GetDependingSynchronousTasks(forMainThread); - } + /// + /// Calculate the collection of events we need trigger after we enqueue a request. + /// This method is expected to be used with the JTF lock. + /// + /// The current joinableTask or collection. + /// True if we want to find tasks to process the main thread queue. Otherwise tasks to process the background queue. + /// The collection of synchronous tasks we need notify. + internal static IReadOnlyCollection GetDependingSynchronousTasks(IJoinableTaskDependent taskItem, bool forMainThread) + { + Requires.NotNull(taskItem, nameof(taskItem)); + Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); + return taskItem.GetJoinableTaskDependentData().GetDependingSynchronousTasks(forMainThread); + } - /// - /// Gets a snapshot of all joined tasks. - /// FOR DIAGNOSTICS COLLECTION ONLY. - /// This method is expected to be used with the JTF lock. - /// - internal static IEnumerable GetAllDirectlyDependentJoinableTasks(IJoinableTaskDependent taskItem) - { - Requires.NotNull(taskItem, nameof(taskItem)); - return JoinableTaskDependentData.GetAllDirectlyDependentJoinableTasks(taskItem); - } + /// + /// Gets a snapshot of all joined tasks. + /// FOR DIAGNOSTICS COLLECTION ONLY. + /// This method is expected to be used with the JTF lock. + /// + internal static IEnumerable GetAllDirectlyDependentJoinableTasks(IJoinableTaskDependent taskItem) + { + Requires.NotNull(taskItem, nameof(taskItem)); + return JoinableTaskDependentData.GetAllDirectlyDependentJoinableTasks(taskItem); + } - /// - /// Recursively adds this joinable and all its dependencies to the specified set, that are not yet completed. - /// - internal static void AddSelfAndDescendentOrJoinedJobs(IJoinableTaskDependent taskItem, HashSet joinables) - { - Requires.NotNull(taskItem, nameof(taskItem)); - JoinableTaskDependentData.AddSelfAndDescendentOrJoinedJobs(taskItem, joinables); - } + /// + /// Recursively adds this joinable and all its dependencies to the specified set, that are not yet completed. + /// + internal static void AddSelfAndDescendentOrJoinedJobs(IJoinableTaskDependent taskItem, HashSet joinables) + { + Requires.NotNull(taskItem, nameof(taskItem)); + JoinableTaskDependentData.AddSelfAndDescendentOrJoinedJobs(taskItem, joinables); + } - /// - /// When the current dependent node is a synchronous task, this method is called before the thread is blocked to wait it to complete. - /// This adds the current task to the dependingSynchronousTaskTracking list of the task itself (which will propergate through its dependencies.) - /// After the task is finished, is called to revert this change. - /// This method is expected to be used with the JTF lock. - /// - /// The current joinableTask or collection. - /// Return the JoinableTask which has already had pending requests to be handled. - /// The number of pending requests. - internal static void OnSynchronousTaskStartToBlockWaiting(JoinableTask taskItem, out JoinableTask? taskHasPendingRequests, out int pendingRequestsCount) - { - Requires.NotNull(taskItem, nameof(taskItem)); - Assumes.True(Monitor.IsEntered(taskItem.Factory.Context.SyncContextLock)); - JoinableTaskDependentData.OnSynchronousTaskStartToBlockWaiting(taskItem, out taskHasPendingRequests, out pendingRequestsCount); - } + /// + /// When the current dependent node is a synchronous task, this method is called before the thread is blocked to wait it to complete. + /// This adds the current task to the dependingSynchronousTaskTracking list of the task itself (which will propergate through its dependencies.) + /// After the task is finished, is called to revert this change. + /// This method is expected to be used with the JTF lock. + /// + /// The current joinableTask or collection. + /// Return the JoinableTask which has already had pending requests to be handled. + /// The number of pending requests. + internal static void OnSynchronousTaskStartToBlockWaiting(JoinableTask taskItem, out JoinableTask? taskHasPendingRequests, out int pendingRequestsCount) + { + Requires.NotNull(taskItem, nameof(taskItem)); + Assumes.True(Monitor.IsEntered(taskItem.Factory.Context.SyncContextLock)); + JoinableTaskDependentData.OnSynchronousTaskStartToBlockWaiting(taskItem, out taskHasPendingRequests, out pendingRequestsCount); + } - /// - /// When the current dependent node is a synchronous task, this method is called after the synchronous is completed, and the thread is no longer blocked. - /// This removes the current task from the dependingSynchronousTaskTracking list of the task itself (and propergate through its dependencies.) - /// It reverts the data structure change done in the . - /// - internal static void OnSynchronousTaskEndToBlockWaiting(JoinableTask taskItem) - { - Requires.NotNull(taskItem, nameof(taskItem)); - JoinableTaskDependentData.OnSynchronousTaskEndToBlockWaiting(taskItem); - } + /// + /// When the current dependent node is a synchronous task, this method is called after the synchronous is completed, and the thread is no longer blocked. + /// This removes the current task from the dependingSynchronousTaskTracking list of the task itself (and propergate through its dependencies.) + /// It reverts the data structure change done in the . + /// + internal static void OnSynchronousTaskEndToBlockWaiting(JoinableTask taskItem) + { + Requires.NotNull(taskItem, nameof(taskItem)); + JoinableTaskDependentData.OnSynchronousTaskEndToBlockWaiting(taskItem); + } - /// - /// Remove all synchronous tasks tracked by the this task. - /// This is called when this task is completed. - /// This method is expected to be used with the JTF lock. - /// - internal static void OnTaskCompleted(IJoinableTaskDependent taskItem) + /// + /// Remove all synchronous tasks tracked by the this task. + /// This is called when this task is completed. + /// This method is expected to be used with the JTF lock. + /// + internal static void OnTaskCompleted(IJoinableTaskDependent taskItem) + { + Requires.NotNull(taskItem, nameof(taskItem)); + Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); + taskItem.GetJoinableTaskDependentData().OnTaskCompleted(taskItem); + } + + /// + /// Get all tasks inside the candidate sets tasks, which are depended by one or more task in the source tasks list. + /// + /// A collection of JoinableTasks represents source tasks. + /// A collection of JoinableTasks which represents candidates. + /// A set of tasks matching the condition. + internal static HashSet GetDependentTasksFromCandidates(IEnumerable sourceTasks, IEnumerable candidateTasks) + { + Requires.NotNull(sourceTasks, nameof(sourceTasks)); + Requires.NotNull(candidateTasks, nameof(candidateTasks)); + + var candidates = new HashSet(candidateTasks); + if (candidates.Count == 0) { - Requires.NotNull(taskItem, nameof(taskItem)); - Assumes.True(Monitor.IsEntered(taskItem.JoinableTaskContext.SyncContextLock)); - taskItem.GetJoinableTaskDependentData().OnTaskCompleted(taskItem); + return candidates; } - /// - /// Get all tasks inside the candidate sets tasks, which are depended by one or more task in the source tasks list. - /// - /// A collection of JoinableTasks represents source tasks. - /// A collection of JoinableTasks which represents candidates. - /// A set of tasks matching the condition. - internal static HashSet GetDependentTasksFromCandidates(IEnumerable sourceTasks, IEnumerable candidateTasks) - { - Requires.NotNull(sourceTasks, nameof(sourceTasks)); - Requires.NotNull(candidateTasks, nameof(candidateTasks)); + var results = new HashSet(); + var visited = new HashSet(); - var candidates = new HashSet(candidateTasks); - if (candidates.Count == 0) + var queue = new Queue(); + foreach (JoinableTask task in sourceTasks) + { + if (task is not null && visited.Add(task)) { - return candidates; + queue.Enqueue(task); } + } - var results = new HashSet(); - var visited = new HashSet(); - - var queue = new Queue(); - foreach (JoinableTask task in sourceTasks) + while (queue.Count > 0) + { + IJoinableTaskDependent startDepenentNode = queue.Dequeue(); + if (startDepenentNode is JoinableTask startTask && candidates.Contains(startTask)) { - if (task is not null && visited.Add(task)) - { - queue.Enqueue(task); - } + results.Add(startTask); } - while (queue.Count > 0) + lock (startDepenentNode.JoinableTaskContext.SyncContextLock) { - IJoinableTaskDependent startDepenentNode = queue.Dequeue(); - if (startDepenentNode is JoinableTask startTask && candidates.Contains(startTask)) + foreach (IJoinableTaskDependent? dependentItem in JoinableTaskDependencyGraph.GetDirectDependentNodes(startDepenentNode)) { - results.Add(startTask); - } - - lock (startDepenentNode.JoinableTaskContext.SyncContextLock) - { - foreach (IJoinableTaskDependent? dependentItem in JoinableTaskDependencyGraph.GetDirectDependentNodes(startDepenentNode)) + if (visited.Add(dependentItem)) { - if (visited.Add(dependentItem)) - { - queue.Enqueue(dependentItem); - } + queue.Enqueue(dependentItem); } } } - - return results; } - /// - /// Computes dependency graph to clean up all potential unreachable dependents items. - /// - /// A thread blocking sychornizing task. - /// Returns all reachable nodes in the connected dependency graph, if unreachable dependency is found. - /// True if it removes any unreachable items. - internal static bool CleanUpPotentialUnreachableDependentItems(JoinableTask syncTask, [NotNullWhen(true)] out HashSet? allReachableNodes) + return results; + } + + /// + /// Computes dependency graph to clean up all potential unreachable dependents items. + /// + /// A thread blocking sychornizing task. + /// Returns all reachable nodes in the connected dependency graph, if unreachable dependency is found. + /// True if it removes any unreachable items. + internal static bool CleanUpPotentialUnreachableDependentItems(JoinableTask syncTask, [NotNullWhen(true)] out HashSet? allReachableNodes) + { + Requires.NotNull(syncTask, nameof(syncTask)); + + // a set of tasks may form a dependent loop, so it will make the reference count system + // not to work correctly when we try to remove the synchronous task. + // To get rid of those loops, if a task still tracks the synchronous task after reducing + // the reference count, we will calculate the entire reachable tree from the root. That will + // tell us the exactly tasks which need track the synchronous task, and we will clean up the rest. + HashSet? possibleUnreachableItems = syncTask.PotentialUnreachableDependents; + if (possibleUnreachableItems is object && possibleUnreachableItems.Count > 0) { - Requires.NotNull(syncTask, nameof(syncTask)); + var reachableNodes = new HashSet(); + IJoinableTaskDependent syncTaskItem = syncTask; + + JoinableTaskDependentData.ComputeSelfAndDescendentOrJoinedJobsAndRemainTasks(syncTaskItem, reachableNodes, possibleUnreachableItems); - // a set of tasks may form a dependent loop, so it will make the reference count system - // not to work correctly when we try to remove the synchronous task. - // To get rid of those loops, if a task still tracks the synchronous task after reducing - // the reference count, we will calculate the entire reachable tree from the root. That will - // tell us the exactly tasks which need track the synchronous task, and we will clean up the rest. - HashSet? possibleUnreachableItems = syncTask.PotentialUnreachableDependents; - if (possibleUnreachableItems is object && possibleUnreachableItems.Count > 0) + allReachableNodes = reachableNodes; + + // force to remove all invalid items + if (possibleUnreachableItems.Count > 0) { - var reachableNodes = new HashSet(); - IJoinableTaskDependent syncTaskItem = syncTask; + JoinableTaskDependentData.RemoveUnreachableDependentItems(syncTask, possibleUnreachableItems, reachableNodes); + possibleUnreachableItems.Clear(); - JoinableTaskDependentData.ComputeSelfAndDescendentOrJoinedJobsAndRemainTasks(syncTaskItem, reachableNodes, possibleUnreachableItems); + return true; + } + } - allReachableNodes = reachableNodes; + allReachableNodes = null; + return false; + } - // force to remove all invalid items - if (possibleUnreachableItems.Count > 0) - { - JoinableTaskDependentData.RemoveUnreachableDependentItems(syncTask, possibleUnreachableItems, reachableNodes); - possibleUnreachableItems.Clear(); + /// + /// Force to clean up all unreachable dependent item, so they are not marked to block the syncTask. + /// + /// The thread blocking task. + /// Unreachable dependent items. + /// All reachable items. + internal static void RemoveUnreachableDependentItems(JoinableTask syncTask, HashSet unreachableItems, HashSet reachableItems) + { + Requires.NotNull(syncTask, nameof(syncTask)); + Requires.NotNull(unreachableItems, nameof(unreachableItems)); + Requires.NotNull(reachableItems, nameof(reachableItems)); - return true; - } - } + JoinableTaskDependentData.RemoveUnreachableDependentItems(syncTask, unreachableItems, reachableItems); + } - allReachableNodes = null; - return false; - } + /// + /// Preserve data for the JoinableTask dependency tree. It is holded inside either a or a . + /// Do not call methods/properties directly anywhere out of . + /// + internal struct JoinableTaskDependentData + { + /// + /// A map of jobs that we should be willing to dequeue from when we control the UI thread, and a ref count. Lazily constructed. + /// + /// + /// When the value in an entry is decremented to 0, the entry is removed from the map. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private Dictionary childDependentNodes; /// - /// Force to clean up all unreachable dependent item, so they are not marked to block the syncTask. + /// The head of a singly linked list of records to track which task may process events of this task. + /// This list should contain only tasks which need be completed synchronously, and depends on this task. /// - /// The thread blocking task. - /// Unreachable dependent items. - /// All reachable items. - internal static void RemoveUnreachableDependentItems(JoinableTask syncTask, HashSet unreachableItems, HashSet reachableItems) - { - Requires.NotNull(syncTask, nameof(syncTask)); - Requires.NotNull(unreachableItems, nameof(unreachableItems)); - Requires.NotNull(reachableItems, nameof(reachableItems)); + private DependentSynchronousTask? dependingSynchronousTaskTracking; - JoinableTaskDependentData.RemoveUnreachableDependentItems(syncTask, unreachableItems, reachableItems); - } + /// + /// Gets a value indicating whether the is empty. + /// + internal bool HasNoChildDependentNode => this.childDependentNodes is null || this.childDependentNodes.Count == 0; /// - /// Preserve data for the JoinableTask dependency tree. It is holded inside either a or a . - /// Do not call methods/properties directly anywhere out of . + /// Gets a snapshot of all joined tasks. + /// FOR DIAGNOSTICS COLLECTION ONLY. + /// This method is expected to be used with the JTF lock. /// - internal struct JoinableTaskDependentData + /// The current joinableTask or collection contains this data. + internal static IEnumerable GetAllDirectlyDependentJoinableTasks(IJoinableTaskDependent taskOrCollection) { - /// - /// A map of jobs that we should be willing to dequeue from when we control the UI thread, and a ref count. Lazily constructed. - /// - /// - /// When the value in an entry is decremented to 0, the entry is removed from the map. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private Dictionary childDependentNodes; - - /// - /// The head of a singly linked list of records to track which task may process events of this task. - /// This list should contain only tasks which need be completed synchronously, and depends on this task. - /// - private DependentSynchronousTask? dependingSynchronousTaskTracking; + Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); + Assumes.True(Monitor.IsEntered(taskOrCollection.JoinableTaskContext.SyncContextLock)); + if (taskOrCollection.GetJoinableTaskDependentData().childDependentNodes is null) + { + return Enumerable.Empty(); + } - /// - /// Gets a value indicating whether the is empty. - /// - internal bool HasNoChildDependentNode => this.childDependentNodes is null || this.childDependentNodes.Count == 0; + var allTasks = new HashSet(); + AddSelfAndDescendentOrJoinedJobs(taskOrCollection, allTasks); + return allTasks; + } - /// - /// Gets a snapshot of all joined tasks. - /// FOR DIAGNOSTICS COLLECTION ONLY. - /// This method is expected to be used with the JTF lock. - /// - /// The current joinableTask or collection contains this data. - internal static IEnumerable GetAllDirectlyDependentJoinableTasks(IJoinableTaskDependent taskOrCollection) + /// + /// Adds a instance as one that is relevant to the async operation. + /// + /// The current joinableTask or collection contains to add a dependency. + /// The to join as a child. + internal static JoinableTaskCollection.JoinRelease AddDependency(IJoinableTaskDependent parentTaskOrCollection, IJoinableTaskDependent joinChild) + { + Requires.NotNull(parentTaskOrCollection, nameof(parentTaskOrCollection)); + Requires.NotNull(joinChild, nameof(joinChild)); + if (parentTaskOrCollection == joinChild) { - Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); - Assumes.True(Monitor.IsEntered(taskOrCollection.JoinableTaskContext.SyncContextLock)); - if (taskOrCollection.GetJoinableTaskDependentData().childDependentNodes is null) - { - return Enumerable.Empty(); - } - - var allTasks = new HashSet(); - AddSelfAndDescendentOrJoinedJobs(taskOrCollection, allTasks); - return allTasks; + // Joining oneself would be pointless. + return default(JoinableTaskCollection.JoinRelease); } - /// - /// Adds a instance as one that is relevant to the async operation. - /// - /// The current joinableTask or collection contains to add a dependency. - /// The to join as a child. - internal static JoinableTaskCollection.JoinRelease AddDependency(IJoinableTaskDependent parentTaskOrCollection, IJoinableTaskDependent joinChild) + using (parentTaskOrCollection.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) { - Requires.NotNull(parentTaskOrCollection, nameof(parentTaskOrCollection)); - Requires.NotNull(joinChild, nameof(joinChild)); - if (parentTaskOrCollection == joinChild) + List? eventsNeedNotify = null; + lock (parentTaskOrCollection.JoinableTaskContext.SyncContextLock) { - // Joining oneself would be pointless. - return default(JoinableTaskCollection.JoinRelease); - } - - using (parentTaskOrCollection.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) - { - List? eventsNeedNotify = null; - lock (parentTaskOrCollection.JoinableTaskContext.SyncContextLock) + var joinableTask = joinChild as JoinableTask; + if (joinableTask?.IsFullyCompleted == true) { - var joinableTask = joinChild as JoinableTask; - if (joinableTask?.IsFullyCompleted == true) - { - return default(JoinableTaskCollection.JoinRelease); - } + return default(JoinableTaskCollection.JoinRelease); + } - ref JoinableTaskDependentData data = ref parentTaskOrCollection.GetJoinableTaskDependentData(); - if (data.childDependentNodes is null) - { - data.childDependentNodes = new Dictionary(capacity: 2); - } + ref JoinableTaskDependentData data = ref parentTaskOrCollection.GetJoinableTaskDependentData(); + if (data.childDependentNodes is null) + { + data.childDependentNodes = new Dictionary(capacity: 2); + } - if (data.childDependentNodes.TryGetValue(joinChild, out int refCount) && !parentTaskOrCollection.NeedRefCountChildDependencies) - { - return default(JoinableTaskCollection.JoinRelease); - } + if (data.childDependentNodes.TryGetValue(joinChild, out int refCount) && !parentTaskOrCollection.NeedRefCountChildDependencies) + { + return default(JoinableTaskCollection.JoinRelease); + } - data.childDependentNodes[joinChild] = ++refCount; - if (refCount == 1) + data.childDependentNodes[joinChild] = ++refCount; + if (refCount == 1) + { + // This constitutes a significant change, so we should apply synchronous task tracking to the new child. + joinChild.OnAddedToDependency(parentTaskOrCollection); + IReadOnlyCollection? tasksNeedNotify = AddDependingSynchronousTaskToChild(parentTaskOrCollection, joinChild); + if (tasksNeedNotify.Count > 0) { - // This constitutes a significant change, so we should apply synchronous task tracking to the new child. - joinChild.OnAddedToDependency(parentTaskOrCollection); - IReadOnlyCollection? tasksNeedNotify = AddDependingSynchronousTaskToChild(parentTaskOrCollection, joinChild); - if (tasksNeedNotify.Count > 0) + eventsNeedNotify = new List(tasksNeedNotify.Count); + foreach (PendingNotification taskToNotify in tasksNeedNotify) { - eventsNeedNotify = new List(tasksNeedNotify.Count); - foreach (PendingNotification taskToNotify in tasksNeedNotify) + AsyncManualResetEvent? notifyEvent = taskToNotify.SynchronousTask.RegisterPendingEventsForSynchrousTask(taskToNotify.TaskHasPendingMessages, taskToNotify.NewPendingMessagesCount); + if (notifyEvent is object) { - AsyncManualResetEvent? notifyEvent = taskToNotify.SynchronousTask.RegisterPendingEventsForSynchrousTask(taskToNotify.TaskHasPendingMessages, taskToNotify.NewPendingMessagesCount); - if (notifyEvent is object) - { - eventsNeedNotify.Add(notifyEvent); - } + eventsNeedNotify.Add(notifyEvent); } } - - parentTaskOrCollection.OnDependencyAdded(joinChild); } + + parentTaskOrCollection.OnDependencyAdded(joinChild); } + } - // We explicitly do this outside our lock. - if (eventsNeedNotify is object) + // We explicitly do this outside our lock. + if (eventsNeedNotify is object) + { + foreach (AsyncManualResetEvent? queueEvent in eventsNeedNotify) { - foreach (AsyncManualResetEvent? queueEvent in eventsNeedNotify) - { - queueEvent.PulseAll(); - } + queueEvent.PulseAll(); } - - return new JoinableTaskCollection.JoinRelease(parentTaskOrCollection, joinChild); } + + return new JoinableTaskCollection.JoinRelease(parentTaskOrCollection, joinChild); } + } - /// - /// Removes a instance as one that is no longer relevant to the async operation. - /// - /// The current joinableTask or collection contains to remove a dependency. - /// The to join as a child. - /// Ignore refCount, it is being used when the child task is completed. - internal static void RemoveDependency(IJoinableTaskDependent parentTaskOrCollection, IJoinableTaskDependent joinChild, bool forceCleanup) - { - Requires.NotNull(parentTaskOrCollection, nameof(parentTaskOrCollection)); - Requires.NotNull(joinChild, nameof(joinChild)); + /// + /// Removes a instance as one that is no longer relevant to the async operation. + /// + /// The current joinableTask or collection contains to remove a dependency. + /// The to join as a child. + /// Ignore refCount, it is being used when the child task is completed. + internal static void RemoveDependency(IJoinableTaskDependent parentTaskOrCollection, IJoinableTaskDependent joinChild, bool forceCleanup) + { + Requires.NotNull(parentTaskOrCollection, nameof(parentTaskOrCollection)); + Requires.NotNull(joinChild, nameof(joinChild)); - using (parentTaskOrCollection.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + using (parentTaskOrCollection.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + ref JoinableTaskDependentData data = ref parentTaskOrCollection.GetJoinableTaskDependentData(); + lock (parentTaskOrCollection.JoinableTaskContext.SyncContextLock) { - ref JoinableTaskDependentData data = ref parentTaskOrCollection.GetJoinableTaskDependentData(); - lock (parentTaskOrCollection.JoinableTaskContext.SyncContextLock) + if (data.childDependentNodes is object && data.childDependentNodes.TryGetValue(joinChild, out int refCount)) { - if (data.childDependentNodes is object && data.childDependentNodes.TryGetValue(joinChild, out int refCount)) + if (refCount == 1 || forceCleanup) { - if (refCount == 1 || forceCleanup) - { - joinChild.OnRemovedFromDependency(parentTaskOrCollection); + joinChild.OnRemovedFromDependency(parentTaskOrCollection); - data.childDependentNodes.Remove(joinChild); - data.RemoveDependingSynchronousTaskFromChild(joinChild); - parentTaskOrCollection.OnDependencyRemoved(joinChild); + data.childDependentNodes.Remove(joinChild); + data.RemoveDependingSynchronousTaskFromChild(joinChild); + parentTaskOrCollection.OnDependencyRemoved(joinChild); - // A node with no out-going dependency chain cannot be a part of a circular dependency loop. - // JoinableTaskCollection doesn't have a completion event, this logic makes sure it will be removed from a long runnning JTF.Run. - if (data.HasNoChildDependentNode) + // A node with no out-going dependency chain cannot be a part of a circular dependency loop. + // JoinableTaskCollection doesn't have a completion event, this logic makes sure it will be removed from a long runnning JTF.Run. + if (data.HasNoChildDependentNode) + { + DependentSynchronousTask? existingTaskTracking = data.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) { - DependentSynchronousTask? existingTaskTracking = data.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) - { - existingTaskTracking.SynchronousTask.PotentialUnreachableDependents?.Remove(parentTaskOrCollection); - existingTaskTracking = existingTaskTracking.Next; - } + existingTaskTracking.SynchronousTask.PotentialUnreachableDependents?.Remove(parentTaskOrCollection); + existingTaskTracking = existingTaskTracking.Next; } } - else - { - data.childDependentNodes[joinChild] = --refCount; - } + } + else + { + data.childDependentNodes[joinChild] = --refCount; } } } } + } - /// - /// Recursively adds this joinable and all its dependencies to the specified set, that are not yet completed. - /// - /// The current joinableTask or collection contains this data. - /// A collection to hold found. - internal static void AddSelfAndDescendentOrJoinedJobs(IJoinableTaskDependent taskOrCollection, HashSet joinables) - { - Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); - Requires.NotNull(joinables, nameof(joinables)); + /// + /// Recursively adds this joinable and all its dependencies to the specified set, that are not yet completed. + /// + /// The current joinableTask or collection contains this data. + /// A collection to hold found. + internal static void AddSelfAndDescendentOrJoinedJobs(IJoinableTaskDependent taskOrCollection, HashSet joinables) + { + Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); + Requires.NotNull(joinables, nameof(joinables)); - if (taskOrCollection is JoinableTask thisJoinableTask) + if (taskOrCollection is JoinableTask thisJoinableTask) + { + if (thisJoinableTask.IsCompleteRequested) { - if (thisJoinableTask.IsCompleteRequested) + if (!thisJoinableTask.IsFullyCompleted) { - if (!thisJoinableTask.IsFullyCompleted) - { - joinables.Add(thisJoinableTask); - } - - return; + joinables.Add(thisJoinableTask); } - if (!joinables.Add(thisJoinableTask)) - { - return; - } + return; } - Dictionary? childDependentNodes = taskOrCollection.GetJoinableTaskDependentData().childDependentNodes; - if (childDependentNodes is object) + if (!joinables.Add(thisJoinableTask)) { - foreach (KeyValuePair item in childDependentNodes) - { - AddSelfAndDescendentOrJoinedJobs(item.Key, joinables); - } + return; } } - /// - /// When the current dependent node is a synchronous task, this method is called before the thread is blocked to wait it to complete. - /// This adds the current task to the of the task itself (which will propergate through its dependencies.) - /// After the task is finished, is called to revert this change. - /// This method is expected to be used with the JTF lock. - /// - /// The synchronized joinableTask. - /// Return the JoinableTask which has already had pending requests to be handled. - /// The number of pending requests. - internal static void OnSynchronousTaskStartToBlockWaiting(JoinableTask syncTask, out JoinableTask? taskHasPendingRequests, out int pendingRequestsCount) + Dictionary? childDependentNodes = taskOrCollection.GetJoinableTaskDependentData().childDependentNodes; + if (childDependentNodes is object) { - Requires.NotNull(syncTask, nameof(syncTask)); + foreach (KeyValuePair item in childDependentNodes) + { + AddSelfAndDescendentOrJoinedJobs(item.Key, joinables); + } + } + } - pendingRequestsCount = 0; + /// + /// When the current dependent node is a synchronous task, this method is called before the thread is blocked to wait it to complete. + /// This adds the current task to the of the task itself (which will propergate through its dependencies.) + /// After the task is finished, is called to revert this change. + /// This method is expected to be used with the JTF lock. + /// + /// The synchronized joinableTask. + /// Return the JoinableTask which has already had pending requests to be handled. + /// The number of pending requests. + internal static void OnSynchronousTaskStartToBlockWaiting(JoinableTask syncTask, out JoinableTask? taskHasPendingRequests, out int pendingRequestsCount) + { + Requires.NotNull(syncTask, nameof(syncTask)); - taskHasPendingRequests = AddDependingSynchronousTask(syncTask, syncTask, ref pendingRequestsCount); - } + pendingRequestsCount = 0; - /// - /// When the current dependent node is a synchronous task, this method is called after the synchronous is completed, and the thread is no longer blocked. - /// This removes the current task from the of the task itself (and propergate through its dependencies.) - /// It reverts the data structure change done in the . - /// - /// The synchronized joinableTask. - internal static void OnSynchronousTaskEndToBlockWaiting(JoinableTask syncTask) + taskHasPendingRequests = AddDependingSynchronousTask(syncTask, syncTask, ref pendingRequestsCount); + } + + /// + /// When the current dependent node is a synchronous task, this method is called after the synchronous is completed, and the thread is no longer blocked. + /// This removes the current task from the of the task itself (and propergate through its dependencies.) + /// It reverts the data structure change done in the . + /// + /// The synchronized joinableTask. + internal static void OnSynchronousTaskEndToBlockWaiting(JoinableTask syncTask) + { + Requires.NotNull(syncTask, nameof(syncTask)); + using (syncTask.Factory.Context.NoMessagePumpSynchronizationContext.Apply()) { - Requires.NotNull(syncTask, nameof(syncTask)); - using (syncTask.Factory.Context.NoMessagePumpSynchronizationContext.Apply()) + lock (syncTask.Factory.Context.SyncContextLock) { - lock (syncTask.Factory.Context.SyncContextLock) + // Remove itself from the tracking list, after the task is completed. + IJoinableTaskDependent syncTaskItem = syncTask; + if (syncTaskItem.GetJoinableTaskDependentData().dependingSynchronousTaskTracking is object) { - // Remove itself from the tracking list, after the task is completed. - IJoinableTaskDependent syncTaskItem = syncTask; - if (syncTaskItem.GetJoinableTaskDependentData().dependingSynchronousTaskTracking is object) - { - RemoveDependingSynchronousTask(syncTask, syncTask, force: true); - } + RemoveDependingSynchronousTask(syncTask, syncTask, force: true); + } - if (syncTask.PotentialUnreachableDependents is object && syncTask.PotentialUnreachableDependents.Count > 0) - { - RemoveUnreachableDependentItems(syncTask, syncTask.PotentialUnreachableDependents, EmptySet); - syncTask.PotentialUnreachableDependents = null; - } + if (syncTask.PotentialUnreachableDependents is object && syncTask.PotentialUnreachableDependents.Count > 0) + { + RemoveUnreachableDependentItems(syncTask, syncTask.PotentialUnreachableDependents, EmptySet); + syncTask.PotentialUnreachableDependents = null; } } } + } - /// - /// Compute all reachable nodes from a synchronous task. Because we use the result to clean up invalid - /// items from the remain task, we will remove valid task from the collection, and stop immediately if nothing is left. - /// - /// The current joinableTask or collection owns the data. - /// All reachable dependency nodes. This is not a completed list, if there is no remain node. - /// Remain dependency nodes we want to check. After the execution, it will retain non-reachable nodes. - internal static void ComputeSelfAndDescendentOrJoinedJobsAndRemainTasks(IJoinableTaskDependent taskOrCollection, HashSet reachableNodes, HashSet remainNodes) + /// + /// Compute all reachable nodes from a synchronous task. Because we use the result to clean up invalid + /// items from the remain task, we will remove valid task from the collection, and stop immediately if nothing is left. + /// + /// The current joinableTask or collection owns the data. + /// All reachable dependency nodes. This is not a completed list, if there is no remain node. + /// Remain dependency nodes we want to check. After the execution, it will retain non-reachable nodes. + internal static void ComputeSelfAndDescendentOrJoinedJobsAndRemainTasks(IJoinableTaskDependent taskOrCollection, HashSet reachableNodes, HashSet remainNodes) + { + Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); + Requires.NotNull(remainNodes, nameof(remainNodes)); + Requires.NotNull(reachableNodes, nameof(reachableNodes)); + if ((taskOrCollection as JoinableTask)?.IsFullyCompleted != true) { - Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); - Requires.NotNull(remainNodes, nameof(remainNodes)); - Requires.NotNull(reachableNodes, nameof(reachableNodes)); - if ((taskOrCollection as JoinableTask)?.IsFullyCompleted != true) + if (reachableNodes.Add(taskOrCollection)) { - if (reachableNodes.Add(taskOrCollection)) + if (remainNodes.Remove(taskOrCollection) && remainNodes.Count == 0) { - if (remainNodes.Remove(taskOrCollection) && remainNodes.Count == 0) - { - // no remain task left, quit the loop earlier - return; - } + // no remain task left, quit the loop earlier + return; + } - if ((taskOrCollection as JoinableTask)?.IsCompleteRequested == true) - { - return; - } + if ((taskOrCollection as JoinableTask)?.IsCompleteRequested == true) + { + return; + } - Dictionary? dependencies = taskOrCollection.GetJoinableTaskDependentData().childDependentNodes; - if (dependencies is object) + Dictionary? dependencies = taskOrCollection.GetJoinableTaskDependentData().childDependentNodes; + if (dependencies is object) + { + foreach (KeyValuePair item in dependencies) { - foreach (KeyValuePair item in dependencies) + ComputeSelfAndDescendentOrJoinedJobsAndRemainTasks(item.Key, reachableNodes, remainNodes); + if (remainNodes.Count == 0) { - ComputeSelfAndDescendentOrJoinedJobsAndRemainTasks(item.Key, reachableNodes, remainNodes); - if (remainNodes.Count == 0) - { - return; - } + return; } } } } } + } - /// - /// Force to clean up all unreachable dependent item, so they are not marked to block the syncTask. - /// - /// The thread blocking task. - /// Unreachable dependent items. - /// All reachable items. - internal static void RemoveUnreachableDependentItems(JoinableTask syncTask, HashSet unreachableItems, HashSet reachableItemsReadOnlySet) - { - ThreadingEventSource.Instance.CircularJoinableTaskDependencyDetected(unreachableItems.Count, reachableItemsReadOnlySet.Count); + /// + /// Force to clean up all unreachable dependent item, so they are not marked to block the syncTask. + /// + /// The thread blocking task. + /// Unreachable dependent items. + /// All reachable items. + internal static void RemoveUnreachableDependentItems(JoinableTask syncTask, HashSet unreachableItems, HashSet reachableItemsReadOnlySet) + { + ThreadingEventSource.Instance.CircularJoinableTaskDependencyDetected(unreachableItems.Count, reachableItemsReadOnlySet.Count); - HashSet? remainPlaceHold = null; - foreach (IJoinableTaskDependent? unreachableItem in unreachableItems) - { - RemoveDependingSynchronousTask(unreachableItem, syncTask, reachableItemsReadOnlySet, ref remainPlaceHold); - } + HashSet? remainPlaceHold = null; + foreach (IJoinableTaskDependent? unreachableItem in unreachableItems) + { + RemoveDependingSynchronousTask(unreachableItem, syncTask, reachableItemsReadOnlySet, ref remainPlaceHold); } + } - /// - /// Gets all dependent nodes registered in the - /// This method is expected to be used with the JTF lock. - /// - internal IEnumerable GetDirectDependentNodes() + /// + /// Gets all dependent nodes registered in the + /// This method is expected to be used with the JTF lock. + /// + internal IEnumerable GetDirectDependentNodes() + { + if (this.childDependentNodes is null) { - if (this.childDependentNodes is null) - { - return Enumerable.Empty(); - } - - return this.childDependentNodes.Keys; + return Enumerable.Empty(); } - /// - /// Checks whether a dependent node is inside . - /// This method is expected to be used with the JTF lock. - /// - internal bool HasDirectDependency(IJoinableTaskDependent dependency) - { - if (this.childDependentNodes is null) - { - return false; - } + return this.childDependentNodes.Keys; + } - return this.childDependentNodes.ContainsKey(dependency); + /// + /// Checks whether a dependent node is inside . + /// This method is expected to be used with the JTF lock. + /// + internal bool HasDirectDependency(IJoinableTaskDependent dependency) + { + if (this.childDependentNodes is null) + { + return false; } - /// - /// Gets a value indicating whether the main thread is waiting for the task's completion - /// This method is expected to be used with the JTF lock. - /// - internal bool HasMainThreadSynchronousTaskWaiting(IJoinableTaskDependent taskItem) + return this.childDependentNodes.ContainsKey(dependency); + } + + /// + /// Gets a value indicating whether the main thread is waiting for the task's completion + /// This method is expected to be used with the JTF lock. + /// + internal bool HasMainThreadSynchronousTaskWaiting(IJoinableTaskDependent taskItem) + { + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) { - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) + DependentSynchronousTask? nextTrackingTask = existingTaskTracking.Next; + if ((existingTaskTracking.SynchronousTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) { - DependentSynchronousTask? nextTrackingTask = existingTaskTracking.Next; - if ((existingTaskTracking.SynchronousTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) + if (existingTaskTracking.SynchronousTask.HasPotentialUnreachableDependents) { - if (existingTaskTracking.SynchronousTask.HasPotentialUnreachableDependents) - { - // This might remove the current tracking item from the linked list, so we capture next node first. - if (!CleanUpPotentialUnreachableDependentItems(existingTaskTracking.SynchronousTask, out HashSet? allReachableNodes) || - allReachableNodes.Contains(taskItem)) - { - // this task is still a dependenting task - return true; - } - } - else + // This might remove the current tracking item from the linked list, so we capture next node first. + if (!CleanUpPotentialUnreachableDependentItems(existingTaskTracking.SynchronousTask, out HashSet? allReachableNodes) || + allReachableNodes.Contains(taskItem)) { + // this task is still a dependenting task return true; } } - - existingTaskTracking = nextTrackingTask; + else + { + return true; + } } - return false; + existingTaskTracking = nextTrackingTask; } - /// - /// Gets a likely value whether the main thread is blocked for the caller's completion. - /// - internal bool MaybeHasMainThreadSynchronousTaskWaiting() + return false; + } + + /// + /// Gets a likely value whether the main thread is blocked for the caller's completion. + /// + internal bool MaybeHasMainThreadSynchronousTaskWaiting() + { + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) { - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) + if ((existingTaskTracking.SynchronousTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) { - if ((existingTaskTracking.SynchronousTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) - { - return true; - } - - existingTaskTracking = existingTaskTracking.Next; + return true; } - return false; + existingTaskTracking = existingTaskTracking.Next; } - /// - /// Remove all synchronous tasks tracked by the this task. - /// This is called when this task is completed. - /// This method is expected to be used with the JTF lock. - /// - internal void OnTaskCompleted(IJoinableTaskDependent thisDependentNode) + return false; + } + + /// + /// Remove all synchronous tasks tracked by the this task. + /// This is called when this task is completed. + /// This method is expected to be used with the JTF lock. + /// + internal void OnTaskCompleted(IJoinableTaskDependent thisDependentNode) + { + if (this.dependingSynchronousTaskTracking is object) { - if (this.dependingSynchronousTaskTracking is object) - { - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - this.dependingSynchronousTaskTracking = null; + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + this.dependingSynchronousTaskTracking = null; - if (this.childDependentNodes is object) + if (this.childDependentNodes is object) + { + Dictionary.KeyCollection? childrenTasks = this.childDependentNodes.Keys; + while (existingTaskTracking is object) { - Dictionary.KeyCollection? childrenTasks = this.childDependentNodes.Keys; - while (existingTaskTracking is object) - { - RemoveDependingSynchronousTaskFrom(childrenTasks, existingTaskTracking.SynchronousTask, force: existingTaskTracking.SynchronousTask == thisDependentNode); - - HashSet? potentialUnreachableDependents = existingTaskTracking.SynchronousTask.PotentialUnreachableDependents; - if (potentialUnreachableDependents is object && potentialUnreachableDependents.Count > 0) - { - potentialUnreachableDependents.Remove(thisDependentNode); - } + RemoveDependingSynchronousTaskFrom(childrenTasks, existingTaskTracking.SynchronousTask, force: existingTaskTracking.SynchronousTask == thisDependentNode); - existingTaskTracking = existingTaskTracking.Next; + HashSet? potentialUnreachableDependents = existingTaskTracking.SynchronousTask.PotentialUnreachableDependents; + if (potentialUnreachableDependents is object && potentialUnreachableDependents.Count > 0) + { + potentialUnreachableDependents.Remove(thisDependentNode); } + + existingTaskTracking = existingTaskTracking.Next; } } } + } - /// - /// Check whether a task is being tracked in our tracking list. - /// - internal bool IsDependingSynchronousTask(JoinableTask syncTask) + /// + /// Check whether a task is being tracked in our tracking list. + /// + internal bool IsDependingSynchronousTask(JoinableTask syncTask) + { + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) { - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) + if (existingTaskTracking.SynchronousTask == syncTask) { - if (existingTaskTracking.SynchronousTask == syncTask) - { - return true; - } - - existingTaskTracking = existingTaskTracking.Next; + return true; } - return false; + existingTaskTracking = existingTaskTracking.Next; } - /// - /// Calculate the collection of events we need trigger after we enqueue a request. - /// This method is expected to be used with the JTF lock. - /// - /// True if we want to find tasks to process the main thread queue. Otherwise tasks to process the background queue. - /// The collection of synchronous tasks we need notify. - internal IReadOnlyCollection GetDependingSynchronousTasks(bool forMainThread) + return false; + } + + /// + /// Calculate the collection of events we need trigger after we enqueue a request. + /// This method is expected to be used with the JTF lock. + /// + /// True if we want to find tasks to process the main thread queue. Otherwise tasks to process the background queue. + /// The collection of synchronous tasks we need notify. + internal IReadOnlyCollection GetDependingSynchronousTasks(bool forMainThread) + { + int count = this.CountOfDependingSynchronousTasks(); + if (count == 0) { - int count = this.CountOfDependingSynchronousTasks(); - if (count == 0) - { - return Array.Empty(); - } + return Array.Empty(); + } - var tasksNeedNotify = new List(count); - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) + var tasksNeedNotify = new List(count); + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) + { + JoinableTask? syncTask = existingTaskTracking.SynchronousTask; + bool syncTaskInOnMainThread = (syncTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread; + if (forMainThread == syncTaskInOnMainThread) { - JoinableTask? syncTask = existingTaskTracking.SynchronousTask; - bool syncTaskInOnMainThread = (syncTask.State & JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread) == JoinableTask.JoinableTaskFlags.SynchronouslyBlockingMainThread; - if (forMainThread == syncTaskInOnMainThread) - { - // Only synchronous tasks are in the list, so we don't need do further check for the CompletingSynchronously flag - tasksNeedNotify.Add(syncTask); - } - - existingTaskTracking = existingTaskTracking.Next; + // Only synchronous tasks are in the list, so we don't need do further check for the CompletingSynchronously flag + tasksNeedNotify.Add(syncTask); } - return tasksNeedNotify; + existingTaskTracking = existingTaskTracking.Next; } - /// - /// Applies all synchronous tasks tracked by this task to a new child/dependent task. - /// - /// The current joinableTask or collection owns the data. - /// The new child task. - /// Pairs of synchronous tasks we need notify and the event source triggering it, plus the number of pending events. - private static IReadOnlyCollection AddDependingSynchronousTaskToChild(IJoinableTaskDependent dependentNode, IJoinableTaskDependent child) + return tasksNeedNotify; + } + + /// + /// Applies all synchronous tasks tracked by this task to a new child/dependent task. + /// + /// The current joinableTask or collection owns the data. + /// The new child task. + /// Pairs of synchronous tasks we need notify and the event source triggering it, plus the number of pending events. + private static IReadOnlyCollection AddDependingSynchronousTaskToChild(IJoinableTaskDependent dependentNode, IJoinableTaskDependent child) + { + Requires.NotNull(dependentNode, nameof(dependentNode)); + Requires.NotNull(child, nameof(child)); + Assumes.True(Monitor.IsEntered(dependentNode.JoinableTaskContext.SyncContextLock)); + + ref JoinableTaskDependentData data = ref dependentNode.GetJoinableTaskDependentData(); + int count = data.CountOfDependingSynchronousTasks(); + if (count == 0) { - Requires.NotNull(dependentNode, nameof(dependentNode)); - Requires.NotNull(child, nameof(child)); - Assumes.True(Monitor.IsEntered(dependentNode.JoinableTaskContext.SyncContextLock)); + return Array.Empty(); + } - ref JoinableTaskDependentData data = ref dependentNode.GetJoinableTaskDependentData(); - int count = data.CountOfDependingSynchronousTasks(); - if (count == 0) + var tasksNeedNotify = new List(count); + DependentSynchronousTask? existingTaskTracking = data.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) + { + int totalEventNumber = 0; + JoinableTask? eventTriggeringTask = AddDependingSynchronousTask(child, existingTaskTracking.SynchronousTask, ref totalEventNumber); + if (eventTriggeringTask is object) { - return Array.Empty(); + tasksNeedNotify.Add(new PendingNotification(existingTaskTracking.SynchronousTask, eventTriggeringTask, totalEventNumber)); } - var tasksNeedNotify = new List(count); - DependentSynchronousTask? existingTaskTracking = data.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) - { - int totalEventNumber = 0; - JoinableTask? eventTriggeringTask = AddDependingSynchronousTask(child, existingTaskTracking.SynchronousTask, ref totalEventNumber); - if (eventTriggeringTask is object) - { - tasksNeedNotify.Add(new PendingNotification(existingTaskTracking.SynchronousTask, eventTriggeringTask, totalEventNumber)); - } + existingTaskTracking = existingTaskTracking.Next; + } - existingTaskTracking = existingTaskTracking.Next; - } + return tasksNeedNotify; + } - return tasksNeedNotify; - } + /// + /// Tracks a new synchronous task for this task. + /// A synchronous task is a task blocking a thread and waits it to be completed. We may want the blocking thread + /// to process events from this task. + /// + /// The current joinableTask or collection. + /// The synchronous task. + /// The total events need be processed. + /// The task causes us to trigger the event of the synchronous task, so it can process new events. Null means we don't need trigger any event. + private static JoinableTask? AddDependingSynchronousTask(IJoinableTaskDependent taskOrCollection, JoinableTask synchronousTask, ref int totalEventsPending) + { + Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); + Requires.NotNull(synchronousTask, nameof(synchronousTask)); + Assumes.True(Monitor.IsEntered(taskOrCollection.JoinableTaskContext.SyncContextLock)); - /// - /// Tracks a new synchronous task for this task. - /// A synchronous task is a task blocking a thread and waits it to be completed. We may want the blocking thread - /// to process events from this task. - /// - /// The current joinableTask or collection. - /// The synchronous task. - /// The total events need be processed. - /// The task causes us to trigger the event of the synchronous task, so it can process new events. Null means we don't need trigger any event. - private static JoinableTask? AddDependingSynchronousTask(IJoinableTaskDependent taskOrCollection, JoinableTask synchronousTask, ref int totalEventsPending) + JoinableTask? thisJoinableTask = taskOrCollection as JoinableTask; + if (thisJoinableTask is object) { - Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); - Requires.NotNull(synchronousTask, nameof(synchronousTask)); - Assumes.True(Monitor.IsEntered(taskOrCollection.JoinableTaskContext.SyncContextLock)); - - JoinableTask? thisJoinableTask = taskOrCollection as JoinableTask; - if (thisJoinableTask is object) + if (thisJoinableTask.IsCompleteRequested) { - if (thisJoinableTask.IsCompleteRequested) + if (!thisJoinableTask.IsFullyCompleted) { - if (!thisJoinableTask.IsFullyCompleted) + // A completed task might still have pending items in the queue. + int pendingCount = thisJoinableTask.GetPendingEventCountForSynchronousTask(synchronousTask); + if (pendingCount > 0) { - // A completed task might still have pending items in the queue. - int pendingCount = thisJoinableTask.GetPendingEventCountForSynchronousTask(synchronousTask); - if (pendingCount > 0) - { - totalEventsPending += pendingCount; - return thisJoinableTask; - } + totalEventsPending += pendingCount; + return thisJoinableTask; } - - return null; } + + return null; } + } - ref JoinableTaskDependentData data = ref taskOrCollection.GetJoinableTaskDependentData(); - DependentSynchronousTask? existingTaskTracking = data.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) + ref JoinableTaskDependentData data = ref taskOrCollection.GetJoinableTaskDependentData(); + DependentSynchronousTask? existingTaskTracking = data.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) + { + if (existingTaskTracking.SynchronousTask == synchronousTask) { - if (existingTaskTracking.SynchronousTask == synchronousTask) - { - existingTaskTracking.ReferenceCount++; - return null; - } - - existingTaskTracking = existingTaskTracking.Next; + existingTaskTracking.ReferenceCount++; + return null; } - JoinableTask? eventTriggeringTask = null; + existingTaskTracking = existingTaskTracking.Next; + } + + JoinableTask? eventTriggeringTask = null; - if (thisJoinableTask is object) + if (thisJoinableTask is object) + { + int pendingItemCount = thisJoinableTask.GetPendingEventCountForSynchronousTask(synchronousTask); + if (pendingItemCount > 0) { - int pendingItemCount = thisJoinableTask.GetPendingEventCountForSynchronousTask(synchronousTask); - if (pendingItemCount > 0) - { - totalEventsPending += pendingItemCount; - eventTriggeringTask = thisJoinableTask; - } + totalEventsPending += pendingItemCount; + eventTriggeringTask = thisJoinableTask; } + } - // For a new synchronous task, we need apply it to our child tasks. - var newTaskTracking = new DependentSynchronousTask(synchronousTask) - { - Next = data.dependingSynchronousTaskTracking, - }; + // For a new synchronous task, we need apply it to our child tasks. + var newTaskTracking = new DependentSynchronousTask(synchronousTask) + { + Next = data.dependingSynchronousTaskTracking, + }; - Thread.MemoryBarrier(); + Thread.MemoryBarrier(); - data.dependingSynchronousTaskTracking = newTaskTracking; + data.dependingSynchronousTaskTracking = newTaskTracking; - if (data.childDependentNodes is object) + if (data.childDependentNodes is object) + { + foreach (KeyValuePair item in data.childDependentNodes) { - foreach (KeyValuePair item in data.childDependentNodes) + JoinableTask? childTiggeringTask = AddDependingSynchronousTask(item.Key, synchronousTask, ref totalEventsPending); + if (eventTriggeringTask is null) { - JoinableTask? childTiggeringTask = AddDependingSynchronousTask(item.Key, synchronousTask, ref totalEventsPending); - if (eventTriggeringTask is null) - { - eventTriggeringTask = childTiggeringTask; - } + eventTriggeringTask = childTiggeringTask; } } - - return eventTriggeringTask; } - /// - /// Remove a synchronous task from the tracking list. - /// - /// The current joinableTask or collection. - /// The synchronous task. - /// We always remove it from the tracking list if it is true. Otherwise, we keep tracking the reference count. - private static void RemoveDependingSynchronousTask(IJoinableTaskDependent taskOrCollection, JoinableTask syncTask, bool force = false) - { - Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); - Requires.NotNull(syncTask, nameof(syncTask)); - Assumes.True(Monitor.IsEntered(taskOrCollection.JoinableTaskContext.SyncContextLock)); + return eventTriggeringTask; + } - RemoveDependingSynchronousTaskFrom(new IJoinableTaskDependent[] { taskOrCollection }, syncTask, force); - } + /// + /// Remove a synchronous task from the tracking list. + /// + /// The current joinableTask or collection. + /// The synchronous task. + /// We always remove it from the tracking list if it is true. Otherwise, we keep tracking the reference count. + private static void RemoveDependingSynchronousTask(IJoinableTaskDependent taskOrCollection, JoinableTask syncTask, bool force = false) + { + Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); + Requires.NotNull(syncTask, nameof(syncTask)); + Assumes.True(Monitor.IsEntered(taskOrCollection.JoinableTaskContext.SyncContextLock)); - /// - /// Remove a synchronous task from the tracking list of a list of tasks. - /// - /// A list of tasks we need update the tracking list. - /// The synchronous task we want to remove. - /// We always remove it from the tracking list if it is true. Otherwise, we keep tracking the reference count. - private static void RemoveDependingSynchronousTaskFrom(IReadOnlyCollection tasks, JoinableTask syncTask, bool force) - { - Requires.NotNull(tasks, nameof(tasks)); - Requires.NotNull(syncTask, nameof(syncTask)); + RemoveDependingSynchronousTaskFrom(new IJoinableTaskDependent[] { taskOrCollection }, syncTask, force); + } - HashSet? emptySetOrNull = force ? EmptySet : null; - HashSet? remainNodes = syncTask.PotentialUnreachableDependents; + /// + /// Remove a synchronous task from the tracking list of a list of tasks. + /// + /// A list of tasks we need update the tracking list. + /// The synchronous task we want to remove. + /// We always remove it from the tracking list if it is true. Otherwise, we keep tracking the reference count. + private static void RemoveDependingSynchronousTaskFrom(IReadOnlyCollection tasks, JoinableTask syncTask, bool force) + { + Requires.NotNull(tasks, nameof(tasks)); + Requires.NotNull(syncTask, nameof(syncTask)); - foreach (IJoinableTaskDependent? task in tasks) - { - RemoveDependingSynchronousTask(task, syncTask, reachableNodesReadOnlySet: emptySetOrNull, ref remainNodes); - } + HashSet? emptySetOrNull = force ? EmptySet : null; + HashSet? remainNodes = syncTask.PotentialUnreachableDependents; - if (remainNodes is object && remainNodes.Count > 0) + foreach (IJoinableTaskDependent? task in tasks) + { + RemoveDependingSynchronousTask(task, syncTask, reachableNodesReadOnlySet: emptySetOrNull, ref remainNodes); + } + + if (remainNodes is object && remainNodes.Count > 0) + { + if (force) { - if (force) - { - Assumes.NotNull(emptySetOrNull); - Assumes.True(emptySetOrNull.Count == 0); + Assumes.NotNull(emptySetOrNull); + Assumes.True(emptySetOrNull.Count == 0); - RemoveUnreachableDependentItems(syncTask, remainNodes, reachableItemsReadOnlySet: emptySetOrNull); + RemoveUnreachableDependentItems(syncTask, remainNodes, reachableItemsReadOnlySet: emptySetOrNull); - syncTask.PotentialUnreachableDependents = null; - } - else if (syncTask.PotentialUnreachableDependents != remainNodes) - { - // a set of tasks may form a dependent loop, so it will make the reference count system - // not to work correctly when we try to remove the synchronous task. - // It will require full dependency scanning to clean them up, which is quite expensive, - // so we keep tracking them, and clean them up when it becomes essential. - syncTask.PotentialUnreachableDependents = remainNodes; - } + syncTask.PotentialUnreachableDependents = null; + } + else if (syncTask.PotentialUnreachableDependents != remainNodes) + { + // a set of tasks may form a dependent loop, so it will make the reference count system + // not to work correctly when we try to remove the synchronous task. + // It will require full dependency scanning to clean them up, which is quite expensive, + // so we keep tracking them, and clean them up when it becomes essential. + syncTask.PotentialUnreachableDependents = remainNodes; } } + } - /// - /// Remove a synchronous task from the tracking list of this task. - /// - /// The current joinableTask or collection. - /// The synchronous task. - /// - /// If it is not null, it will contain all dependency nodes which can track the synchronous task. We will ignore reference count in that case. - /// - /// This will retain the tasks which still tracks the synchronous task. - private static void RemoveDependingSynchronousTask(IJoinableTaskDependent taskOrCollection, JoinableTask task, HashSet? reachableNodesReadOnlySet, ref HashSet? remainingDependentNodes) - { - Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); - Requires.NotNull(task, nameof(task)); + /// + /// Remove a synchronous task from the tracking list of this task. + /// + /// The current joinableTask or collection. + /// The synchronous task. + /// + /// If it is not null, it will contain all dependency nodes which can track the synchronous task. We will ignore reference count in that case. + /// + /// This will retain the tasks which still tracks the synchronous task. + private static void RemoveDependingSynchronousTask(IJoinableTaskDependent taskOrCollection, JoinableTask task, HashSet? reachableNodesReadOnlySet, ref HashSet? remainingDependentNodes) + { + Requires.NotNull(taskOrCollection, nameof(taskOrCollection)); + Requires.NotNull(task, nameof(task)); - ref JoinableTaskDependentData data = ref taskOrCollection.GetJoinableTaskDependentData(); - DependentSynchronousTask? previousTaskTracking = null; - DependentSynchronousTask? currentTaskTracking = data.dependingSynchronousTaskTracking; - bool removed = false; + ref JoinableTaskDependentData data = ref taskOrCollection.GetJoinableTaskDependentData(); + DependentSynchronousTask? previousTaskTracking = null; + DependentSynchronousTask? currentTaskTracking = data.dependingSynchronousTaskTracking; + bool removed = false; - while (currentTaskTracking is object) + while (currentTaskTracking is object) + { + if (currentTaskTracking.SynchronousTask == task) { - if (currentTaskTracking.SynchronousTask == task) + if (--currentTaskTracking.ReferenceCount > 0) { - if (--currentTaskTracking.ReferenceCount > 0) + if (reachableNodesReadOnlySet is object) { - if (reachableNodesReadOnlySet is object) + if (!reachableNodesReadOnlySet.Contains(taskOrCollection)) { - if (!reachableNodesReadOnlySet.Contains(taskOrCollection)) - { - currentTaskTracking.ReferenceCount = 0; - } + currentTaskTracking.ReferenceCount = 0; } } + } - if (currentTaskTracking.ReferenceCount == 0) + if (currentTaskTracking.ReferenceCount == 0) + { + removed = true; + if (previousTaskTracking is object) { - removed = true; - if (previousTaskTracking is object) - { - previousTaskTracking.Next = currentTaskTracking.Next; - } - else - { - data.dependingSynchronousTaskTracking = currentTaskTracking.Next; - } + previousTaskTracking.Next = currentTaskTracking.Next; + } + else + { + data.dependingSynchronousTaskTracking = currentTaskTracking.Next; } + } - if (reachableNodesReadOnlySet is null) + if (reachableNodesReadOnlySet is null) + { + // if a node doesn't have dependencies, it cannot be a part of a dependency circle. + if (removed || taskOrCollection.GetJoinableTaskDependentData().HasNoChildDependentNode) { - // if a node doesn't have dependencies, it cannot be a part of a dependency circle. - if (removed || taskOrCollection.GetJoinableTaskDependentData().HasNoChildDependentNode) + if (remainingDependentNodes is object) { - if (remainingDependentNodes is object) - { - remainingDependentNodes.Remove(taskOrCollection); - } + remainingDependentNodes.Remove(taskOrCollection); } - else + } + else + { + if (remainingDependentNodes is null) { - if (remainingDependentNodes is null) - { - remainingDependentNodes = new HashSet(); - } - - remainingDependentNodes.Add(taskOrCollection); + remainingDependentNodes = new HashSet(); } - } - break; + remainingDependentNodes.Add(taskOrCollection); + } } - previousTaskTracking = currentTaskTracking; - currentTaskTracking = currentTaskTracking.Next; + break; } - if (removed && data.childDependentNodes is object) - { - foreach (KeyValuePair item in data.childDependentNodes) - { - RemoveDependingSynchronousTask(item.Key, task, reachableNodesReadOnlySet, ref remainingDependentNodes); - } - } + previousTaskTracking = currentTaskTracking; + currentTaskTracking = currentTaskTracking.Next; } - /// - /// Get how many number of synchronous tasks in our tracking list. - /// - private int CountOfDependingSynchronousTasks() + if (removed && data.childDependentNodes is object) { - int count = 0; - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) + foreach (KeyValuePair item in data.childDependentNodes) { - count++; - existingTaskTracking = existingTaskTracking.Next; + RemoveDependingSynchronousTask(item.Key, task, reachableNodesReadOnlySet, ref remainingDependentNodes); } + } + } - return count; + /// + /// Get how many number of synchronous tasks in our tracking list. + /// + private int CountOfDependingSynchronousTasks() + { + int count = 0; + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) + { + count++; + existingTaskTracking = existingTaskTracking.Next; } - /// - /// Removes all synchronous tasks we applies to a dependent task, after the relationship is removed. - /// - /// The original dependent task. - private void RemoveDependingSynchronousTaskFromChild(IJoinableTaskDependent child) + return count; + } + + /// + /// Removes all synchronous tasks we applies to a dependent task, after the relationship is removed. + /// + /// The original dependent task. + private void RemoveDependingSynchronousTaskFromChild(IJoinableTaskDependent child) + { + Requires.NotNull(child, nameof(child)); + + DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; + while (existingTaskTracking is object) + { + RemoveDependingSynchronousTask(child, existingTaskTracking.SynchronousTask); + existingTaskTracking = existingTaskTracking.Next; + } + } + + /// + /// The record of a pending notification we need send to the synchronous task that we have some new messages to process. + /// + private readonly struct PendingNotification + { + internal PendingNotification(JoinableTask synchronousTask, JoinableTask taskHasPendingMessages, int newPendingMessagesCount) { - Requires.NotNull(child, nameof(child)); + Requires.NotNull(synchronousTask, nameof(synchronousTask)); + Requires.NotNull(taskHasPendingMessages, nameof(taskHasPendingMessages)); - DependentSynchronousTask? existingTaskTracking = this.dependingSynchronousTaskTracking; - while (existingTaskTracking is object) - { - RemoveDependingSynchronousTask(child, existingTaskTracking.SynchronousTask); - existingTaskTracking = existingTaskTracking.Next; - } + this.SynchronousTask = synchronousTask; + this.TaskHasPendingMessages = taskHasPendingMessages; + this.NewPendingMessagesCount = newPendingMessagesCount; } /// - /// The record of a pending notification we need send to the synchronous task that we have some new messages to process. + /// Gets the synchronous task which need process new messages. /// - private readonly struct PendingNotification - { - internal PendingNotification(JoinableTask synchronousTask, JoinableTask taskHasPendingMessages, int newPendingMessagesCount) - { - Requires.NotNull(synchronousTask, nameof(synchronousTask)); - Requires.NotNull(taskHasPendingMessages, nameof(taskHasPendingMessages)); + internal JoinableTask SynchronousTask { get; } - this.SynchronousTask = synchronousTask; - this.TaskHasPendingMessages = taskHasPendingMessages; - this.NewPendingMessagesCount = newPendingMessagesCount; - } - - /// - /// Gets the synchronous task which need process new messages. - /// - internal JoinableTask SynchronousTask { get; } - - /// - /// Gets one JoinableTask which may have pending messages. We may have multiple new JoinableTasks which contains pending messages. - /// This is just one of them. It gives the synchronous task a way to start quickly without searching all messages. - /// - internal JoinableTask TaskHasPendingMessages { get; } - - /// - /// Gets the total number of new pending messages. The real number could be less than that, but should not be more than that. - /// - internal int NewPendingMessagesCount { get; } - } + /// + /// Gets one JoinableTask which may have pending messages. We may have multiple new JoinableTasks which contains pending messages. + /// This is just one of them. It gives the synchronous task a way to start quickly without searching all messages. + /// + internal JoinableTask TaskHasPendingMessages { get; } /// - /// A single linked list to maintain synchronous JoinableTask depends on the current task, - /// which may process the queue of the current task. + /// Gets the total number of new pending messages. The real number could be less than that, but should not be more than that. /// - private class DependentSynchronousTask + internal int NewPendingMessagesCount { get; } + } + + /// + /// A single linked list to maintain synchronous JoinableTask depends on the current task, + /// which may process the queue of the current task. + /// + private class DependentSynchronousTask + { + internal DependentSynchronousTask(JoinableTask task) { - internal DependentSynchronousTask(JoinableTask task) - { - this.SynchronousTask = task; - this.ReferenceCount = 1; - } + this.SynchronousTask = task; + this.ReferenceCount = 1; + } - /// - /// Gets or sets the chain of the single linked list. - /// - internal DependentSynchronousTask? Next { get; set; } + /// + /// Gets or sets the chain of the single linked list. + /// + internal DependentSynchronousTask? Next { get; set; } - /// - /// Gets the synchronous task. - /// - internal JoinableTask SynchronousTask { get; } + /// + /// Gets the synchronous task. + /// + internal JoinableTask SynchronousTask { get; } - /// - /// Gets or sets the reference count. We remove the item from the list, if it reaches 0. - /// - internal int ReferenceCount { get; set; } - } + /// + /// Gets or sets the reference count. We remove the item from the list, if it reaches 0. + /// + internal int ReferenceCount { get; set; } } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 41c97163d..91b489790 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -16,1282 +16,1281 @@ using System.Threading.Tasks; using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A factory for starting asynchronous tasks that can mitigate deadlocks +/// when the tasks require the Main thread of an application and the Main +/// thread may itself be blocking on the completion of a task. +/// +/// +/// For more complete comments please see the . +/// +public partial class JoinableTaskFactory { /// - /// A factory for starting asynchronous tasks that can mitigate deadlocks - /// when the tasks require the Main thread of an application and the Main - /// thread may itself be blocking on the completion of a task. + /// The that owns this instance. /// - /// - /// For more complete comments please see the . - /// - public partial class JoinableTaskFactory + private readonly JoinableTaskContext owner; + + private readonly SynchronizationContext mainThreadJobSyncContext; + + /// + /// The collection to add all created tasks to. May be . + /// + private readonly JoinableTaskCollection? jobCollection; + + /// + /// Backing field for the property. + /// + private TimeSpan hangDetectionTimeout = TimeSpan.FromSeconds(6); + + /// + /// Initializes a new instance of the class. + /// + /// The context for the tasks created by this factory. + public JoinableTaskFactory(JoinableTaskContext owner) + : this(owner, null) { - /// - /// The that owns this instance. - /// - private readonly JoinableTaskContext owner; + } - private readonly SynchronizationContext mainThreadJobSyncContext; + /// + /// Initializes a new instance of the class + /// that adds all generated jobs to the specified collection. + /// + /// The collection that all tasks created by this factory will belong to till they complete. + public JoinableTaskFactory(JoinableTaskCollection collection) + : this(Requires.NotNull(collection, "collection").Context, collection) + { + } - /// - /// The collection to add all created tasks to. May be . - /// - private readonly JoinableTaskCollection? jobCollection; + /// + /// Initializes a new instance of the class. + /// + /// The context for the tasks created by this factory. + /// The collection that all tasks created by this factory will belong to till they complete. May be null. + internal JoinableTaskFactory(JoinableTaskContext owner, JoinableTaskCollection? collection) + { + Requires.NotNull(owner, nameof(owner)); + Assumes.True(collection is null || collection.Context == owner); - /// - /// Backing field for the property. - /// - private TimeSpan hangDetectionTimeout = TimeSpan.FromSeconds(6); + this.owner = owner; + this.jobCollection = collection; + this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this); + } - /// - /// Initializes a new instance of the class. - /// - /// The context for the tasks created by this factory. - public JoinableTaskFactory(JoinableTaskContext owner) - : this(owner, null) + /// + /// Gets the joinable task context to which this factory belongs. + /// + public JoinableTaskContext Context + { + get { return this.owner; } + } + + /// + /// Gets the synchronization context to apply before executing work associated with this factory. + /// + internal SynchronizationContext? ApplicableJobSyncContext + { + get { return this.Context.IsOnMainThread ? this.mainThreadJobSyncContext : null; } + } + + /// + /// Gets the collection to which created tasks belong until they complete. May be null. + /// + internal JoinableTaskCollection? Collection + { + get { return this.jobCollection; } + } + + /// + /// Gets or sets the timeout after which no activity while synchronously blocking + /// suggests a hang has occurred. + /// + protected TimeSpan HangDetectionTimeout + { + get { + return this.hangDetectionTimeout; } - /// - /// Initializes a new instance of the class - /// that adds all generated jobs to the specified collection. - /// - /// The collection that all tasks created by this factory will belong to till they complete. - public JoinableTaskFactory(JoinableTaskCollection collection) - : this(Requires.NotNull(collection, "collection").Context, collection) + set { + Requires.Range(value > TimeSpan.Zero, "value"); + this.hangDetectionTimeout = value; } + } - /// - /// Initializes a new instance of the class. - /// - /// The context for the tasks created by this factory. - /// The collection that all tasks created by this factory will belong to till they complete. May be null. - internal JoinableTaskFactory(JoinableTaskContext owner, JoinableTaskCollection? collection) + /// + /// Gets the underlying that controls the main thread in the host. + /// + protected SynchronizationContext? UnderlyingSynchronizationContext + { + get { return this.Context.UnderlyingSynchronizationContext; } + } + + /// + /// Gets an awaitable whose continuations execute on the synchronization context that this instance was initialized with, + /// in such a way as to mitigate both deadlocks and reentrancy. + /// + /// + /// A token whose cancellation will immediately schedule the continuation + /// on a threadpool thread and will cause the continuation to throw , + /// even if the caller is already on the main thread. + /// + /// An awaitable. + /// + /// Thrown back at the awaiting caller if is canceled, + /// even if the caller is already on the main thread. + /// + /// + /// + /// + /// private async Task SomeOperationAsync() { + /// // on the caller's thread. + /// await DoAsync(); + /// + /// // Now switch to a threadpool thread explicitly. + /// await TaskScheduler.Default; + /// + /// // Now switch to the Main thread to talk to some STA object. + /// await this.JobContext.SwitchToMainThreadAsync(); + /// STAService.DoSomething(); + /// } + /// + /// + /// + public MainThreadAwaitable SwitchToMainThreadAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return new MainThreadAwaitable(this, this.Context.AmbientTask, cancellationToken); + } + + /// + /// Gets an awaitable whose continuations execute on the synchronization context that this instance was initialized with, + /// in such a way as to mitigate both deadlocks and reentrancy. + /// + /// A value indicating whether the caller should yield even if + /// already executing on the main thread. + /// + /// A token whose cancellation will immediately schedule the continuation + /// on a threadpool thread and will cause the continuation to throw , + /// even if the caller is already on the main thread. + /// + /// An awaitable. + /// + /// Thrown back at the awaiting caller if is canceled, + /// even if the caller is already on the main thread. + /// + /// + /// + /// + /// private async Task SomeOperationAsync() + /// { + /// // This first part can be on the caller's thread, whatever that is. + /// DoSomething(); + /// + /// // Now switch to the Main thread to talk to some STA object. + /// // Supposing it is also important to *not* do this step on our caller's callstack, + /// // be sure we yield even if we're on the UI thread. + /// await this.JoinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); + /// STAService.DoSomething(); + /// } + /// + /// + /// + public MainThreadAwaitable SwitchToMainThreadAsync(bool alwaysYield, CancellationToken cancellationToken = default(CancellationToken)) + { + return new MainThreadAwaitable(this, this.Context.AmbientTask, cancellationToken, alwaysYield); + } + + /// + /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. + /// + /// The asynchronous method to execute. + /// + /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + /// + /// // On threadpool or Main thread, this method will block + /// // the calling thread until all async operations in the + /// // delegate complete. + /// joinableTaskFactory.Run(async delegate { + /// // still on the threadpool or Main thread as before. + /// await OperationAsync(); + /// // still on the threadpool or Main thread as before. + /// await Task.Run(async delegate { + /// // Now we're on a threadpool thread. + /// await Task.Yield(); + /// // still on a threadpool thread. + /// }); + /// // Now back on the Main thread (or threadpool thread if that's where we started). + /// }); + /// + /// + /// + public void Run(Func asyncMethod) + { + this.Run(asyncMethod, JoinableTaskCreationOptions.None, entrypointOverride: null); + } + + /// + /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. + /// + /// The asynchronous method to execute. + /// The used to customize the task's behavior. + public void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions) + { + this.Run(asyncMethod, creationOptions, entrypointOverride: null); + } + + /// + /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. + /// + /// The type of value returned by the asynchronous operation. + /// The asynchronous method to execute. + /// The result of the Task returned by . + /// + /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// See the overload documentation for an example. + /// + public T Run(Func> asyncMethod) + { + return this.Run(asyncMethod, JoinableTaskCreationOptions.None); + } + + /// + /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. + /// + /// The type of value returned by the asynchronous operation. + /// The asynchronous method to execute. + /// The used to customize the task's behavior. + /// The result of the Task returned by . + /// + /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + public T Run(Func> asyncMethod, JoinableTaskCreationOptions creationOptions) + { + VerifyNoNonConcurrentSyncContext(); + JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, creationOptions: creationOptions); + return joinable.CompleteOnCurrentThread(); + } + + /// + /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. + /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method + /// requires the main thread while the main thread is blocked waiting for the async method's completion. + /// + /// The method that, when executed, will begin the async operation. + /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. + /// + /// Exceptions thrown by the delegate are captured by the returned . + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + public JoinableTask RunAsync(Func asyncMethod) + { + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: JoinableTaskCreationOptions.None); + } + + /// + /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. + /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method + /// requires the main thread while the main thread is blocked waiting for the async method's completion. + /// + /// The method that, when executed, will begin the async operation. + /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. + /// The used to customize the task's behavior. + /// + /// Exceptions thrown by the delegate are captured by the returned . + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + public JoinableTask RunAsync(Func asyncMethod, JoinableTaskCreationOptions creationOptions) + { + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: creationOptions); + } + + /// + /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. + /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method + /// requires the main thread while the main thread is blocked waiting for the async method's completion. + /// + /// The type of value returned by the asynchronous operation. + /// The method that, when executed, will begin the async operation. + /// + /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. + /// + /// + /// Exceptions thrown by the delegate are captured by the returned . + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + public JoinableTask RunAsync(Func> asyncMethod) + { + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: JoinableTaskCreationOptions.None); + } + + /// + /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. + /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method + /// requires the main thread while the main thread is blocked waiting for the async method's completion. + /// + /// The type of value returned by the asynchronous operation. + /// The method that, when executed, will begin the async operation. + /// The used to customize the task's behavior. + /// + /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. + /// + /// + /// Exceptions thrown by the delegate are captured by the returned . + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + public JoinableTask RunAsync(Func> asyncMethod, JoinableTaskCreationOptions creationOptions) + { + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: creationOptions); + } + + /// + /// Responds to calls to + /// by scheduling a continuation to execute on the Main thread. + /// + /// The callback to invoke. + internal SingleExecuteProtector RequestSwitchToMainThread(Action callback) + { + Requires.NotNull(callback, nameof(callback)); + + // Make sure that this thread switch request is in a job that is captured by the job collection + // to which this switch request belongs. + // If an ambient job already exists and belongs to the collection, that's good enough. But if + // there is no ambient job, or the ambient job does not belong to the collection, we must create + // a (child) job and add that to this job factory's collection so that folks joining that factory + // can help this switch to complete. + JoinableTask? ambientJob = this.Context.AmbientTask; + SingleExecuteProtector? wrapper = null; + if (ambientJob is null || (this.jobCollection is object && !this.jobCollection.Contains(ambientJob))) { - Requires.NotNull(owner, nameof(owner)); - Assumes.True(collection is null || collection.Context == owner); + JoinableTask? transient = this.RunAsync( + delegate + { + RoslynDebug.Assert(this.Context.AmbientTask is object, $"{nameof(this.Context.AmbientTask)} is always set for {nameof(this.RunAsync)} callbacks."); - this.owner = owner; - this.jobCollection = collection; - this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this); - } + ambientJob = this.Context.AmbientTask; + wrapper = SingleExecuteProtector.Create(ambientJob, callback); + ambientJob.Post(SingleExecuteProtector.ExecuteOnce, wrapper, true); + return Task.CompletedTask; + }, + synchronouslyBlocking: false, + creationOptions: JoinableTaskCreationOptions.None, + entrypointOverride: callback); - /// - /// Gets the joinable task context to which this factory belongs. - /// - public JoinableTaskContext Context + if (transient.Task.IsFaulted) + { + // rethrow the exception. + transient.Task.GetAwaiter().GetResult(); + } + } + else { - get { return this.owner; } + wrapper = SingleExecuteProtector.Create(ambientJob, callback); + ambientJob.Post(SingleExecuteProtector.ExecuteOnce, wrapper, true); } - /// - /// Gets the synchronization context to apply before executing work associated with this factory. - /// - internal SynchronizationContext? ApplicableJobSyncContext + Assumes.NotNull(wrapper); + return wrapper; + } + + /// + /// Posts a callback to the main thread via the underlying dispatcher, + /// or to the threadpool when no dispatcher exists on the main thread. + /// + internal void PostToUnderlyingSynchronizationContextOrThreadPool(SingleExecuteProtector callback) + { + Requires.NotNull(callback, nameof(callback)); + + if (this.UnderlyingSynchronizationContext is object) { - get { return this.Context.IsOnMainThread ? this.mainThreadJobSyncContext : null; } + this.PostToUnderlyingSynchronizationContext(SingleExecuteProtector.ExecuteOnce, callback); } - - /// - /// Gets the collection to which created tasks belong until they complete. May be null. - /// - internal JoinableTaskCollection? Collection + else { - get { return this.jobCollection; } + ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, callback); } + } - /// - /// Gets or sets the timeout after which no activity while synchronously blocking - /// suggests a hang has occurred. - /// - protected TimeSpan HangDetectionTimeout + /// Runs the specified asynchronous method. + /// The asynchronous method to execute. + /// The used to customize the task's behavior. + /// The delegate to record as the entrypoint for this JoinableTask. + internal void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride) + { + VerifyNoNonConcurrentSyncContext(); + JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, creationOptions: creationOptions, entrypointOverride: entrypointOverride); + joinable.CompleteOnCurrentThread(); + } + + internal void Post(SendOrPostCallback callback, object? state, bool mainThreadAffinitized) + { + Requires.NotNull(callback, nameof(callback)); + + if (mainThreadAffinitized) { - get + JoinableTask? transient = this.RunAsync(delegate { - return this.hangDetectionTimeout; - } + RoslynDebug.Assert(this.Context.AmbientTask is object, $"{nameof(this.Context.AmbientTask)} is always set for {nameof(this.RunAsync)} callbacks."); + + this.Context.AmbientTask.Post(callback, state, true); + return Task.CompletedTask; + }); - set + if (transient.Task.IsFaulted) { - Requires.Range(value > TimeSpan.Zero, "value"); - this.hangDetectionTimeout = value; + // rethrow the exception. + transient.Task.GetAwaiter().GetResult(); } } - - /// - /// Gets the underlying that controls the main thread in the host. - /// - protected SynchronizationContext? UnderlyingSynchronizationContext + else { - get { return this.Context.UnderlyingSynchronizationContext; } + ThreadPool.QueueUserWorkItem(new WaitCallback(callback), state); } + } - /// - /// Gets an awaitable whose continuations execute on the synchronization context that this instance was initialized with, - /// in such a way as to mitigate both deadlocks and reentrancy. - /// - /// - /// A token whose cancellation will immediately schedule the continuation - /// on a threadpool thread and will cause the continuation to throw , - /// even if the caller is already on the main thread. - /// - /// An awaitable. - /// - /// Thrown back at the awaiting caller if is canceled, - /// even if the caller is already on the main thread. - /// - /// - /// - /// - /// private async Task SomeOperationAsync() { - /// // on the caller's thread. - /// await DoAsync(); - /// - /// // Now switch to a threadpool thread explicitly. - /// await TaskScheduler.Default; - /// - /// // Now switch to the Main thread to talk to some STA object. - /// await this.JobContext.SwitchToMainThreadAsync(); - /// STAService.DoSomething(); - /// } - /// - /// - /// - public MainThreadAwaitable SwitchToMainThreadAsync(CancellationToken cancellationToken = default(CancellationToken)) - { - return new MainThreadAwaitable(this, this.Context.AmbientTask, cancellationToken); - } + /// + /// Posts a message to the specified underlying SynchronizationContext for processing when the main thread + /// is freely available. + /// + /// The callback to invoke. + /// State to pass to the callback. + protected internal virtual void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) + { + Requires.NotNull(callback, nameof(callback)); + Assumes.NotNull(this.UnderlyingSynchronizationContext); - /// - /// Gets an awaitable whose continuations execute on the synchronization context that this instance was initialized with, - /// in such a way as to mitigate both deadlocks and reentrancy. - /// - /// A value indicating whether the caller should yield even if - /// already executing on the main thread. - /// - /// A token whose cancellation will immediately schedule the continuation - /// on a threadpool thread and will cause the continuation to throw , - /// even if the caller is already on the main thread. - /// - /// An awaitable. - /// - /// Thrown back at the awaiting caller if is canceled, - /// even if the caller is already on the main thread. - /// - /// - /// - /// - /// private async Task SomeOperationAsync() - /// { - /// // This first part can be on the caller's thread, whatever that is. - /// DoSomething(); - /// - /// // Now switch to the Main thread to talk to some STA object. - /// // Supposing it is also important to *not* do this step on our caller's callstack, - /// // be sure we yield even if we're on the UI thread. - /// await this.JoinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); - /// STAService.DoSomething(); - /// } - /// - /// - /// - public MainThreadAwaitable SwitchToMainThreadAsync(bool alwaysYield, CancellationToken cancellationToken = default(CancellationToken)) + this.UnderlyingSynchronizationContext.Post(callback, state); + } + + /// + /// Raised when a joinable task has requested a transition to the main thread. + /// + /// The task requesting the transition to the main thread. + /// + /// This event may be raised on any thread, including the main thread. + /// + protected internal virtual void OnTransitioningToMainThread(JoinableTask joinableTask) + { + Requires.NotNull(joinableTask, nameof(joinableTask)); + } + + /// + /// Raised whenever a joinable task has completed a transition to the main thread. + /// + /// The task whose request to transition to the main thread has completed. + /// A value indicating whether the transition was cancelled before it was fulfilled. + /// + /// This event is usually raised on the main thread, but can be on another thread when is . + /// + protected internal virtual void OnTransitionedToMainThread(JoinableTask joinableTask, bool canceled) + { + Requires.NotNull(joinableTask, nameof(joinableTask)); + } + + /// + /// Synchronously blocks the calling thread for the completion of the specified task. + /// If running on the main thread, any applicable message pump is suppressed + /// while the thread sleeps. + /// + /// The task whose completion is being waited on. + /// + /// Implementations should take care that exceptions from faulted or canceled tasks + /// not be thrown back to the caller. + /// + protected internal virtual void WaitSynchronously(Task task) + { + if (this.Context.IsOnMainThread) { - return new MainThreadAwaitable(this, this.Context.AmbientTask, cancellationToken, alwaysYield); + // Suppress any reentrancy by causing this synchronously blocking wait + // to not pump any messages at all. + using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + { + this.WaitSynchronouslyCore(task); + } } - - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The asynchronous method to execute. - /// - /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - /// - /// // On threadpool or Main thread, this method will block - /// // the calling thread until all async operations in the - /// // delegate complete. - /// joinableTaskFactory.Run(async delegate { - /// // still on the threadpool or Main thread as before. - /// await OperationAsync(); - /// // still on the threadpool or Main thread as before. - /// await Task.Run(async delegate { - /// // Now we're on a threadpool thread. - /// await Task.Yield(); - /// // still on a threadpool thread. - /// }); - /// // Now back on the Main thread (or threadpool thread if that's where we started). - /// }); - /// - /// - /// - public void Run(Func asyncMethod) + else { - this.Run(asyncMethod, JoinableTaskCreationOptions.None, entrypointOverride: null); + this.WaitSynchronouslyCore(task); } + } - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The asynchronous method to execute. - /// The used to customize the task's behavior. - public void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions) + /// + /// Synchronously blocks the calling thread for the completion of the specified task. + /// + /// The task whose completion is being waited on. + /// + /// Implementations should take care that exceptions from faulted or canceled tasks + /// not be thrown back to the caller. + /// + protected virtual void WaitSynchronouslyCore(Task task) + { + Requires.NotNull(task, nameof(task)); + + if (this.Context.IsOnMainThread) { - this.Run(asyncMethod, creationOptions, entrypointOverride: null); + this.Context.IncrementMainThreadBlockingCount(); } - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The type of value returned by the asynchronous operation. - /// The asynchronous method to execute. - /// The result of the Task returned by . - /// - /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// See the overload documentation for an example. - /// - public T Run(Func> asyncMethod) + int hangTimeoutsCount = 0; // useful for debugging dump files to see how many times we looped. + int hangNotificationCount = 0; + Guid hangId = Guid.Empty; + Stopwatch? stopWatch = null; + try { - return this.Run(asyncMethod, JoinableTaskCreationOptions.None); - } + while (!task.Wait(this.HangDetectionTimeout)) + { + if (hangTimeoutsCount == 0) + { + stopWatch = Stopwatch.StartNew(); + } - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The type of value returned by the asynchronous operation. - /// The asynchronous method to execute. - /// The used to customize the task's behavior. - /// The result of the Task returned by . - /// - /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - public T Run(Func> asyncMethod, JoinableTaskCreationOptions creationOptions) + hangTimeoutsCount++; + TimeSpan hangDuration = TimeSpan.FromMilliseconds(this.HangDetectionTimeout.TotalMilliseconds * hangTimeoutsCount); + if (hangId == Guid.Empty) + { + hangId = Guid.NewGuid(); + } + + if (!this.IsWaitingOnLongRunningTask()) + { + hangNotificationCount++; + this.Context.OnHangDetected(hangDuration, hangNotificationCount, hangId); + } + } + + if (hangNotificationCount > 0) + { + RoslynDebug.Assert(stopWatch is object); + + // We detect a false alarm. The stop watch was started after the first timeout, so we add intial timeout to the total delay. + this.Context.OnFalseHangDetected( + stopWatch.Elapsed + this.HangDetectionTimeout, + hangId); + } + } + catch (AggregateException) { - VerifyNoNonConcurrentSyncContext(); - JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, creationOptions: creationOptions); - return joinable.CompleteOnCurrentThread(); + // Swallow exceptions thrown by Task.Wait(). + // Our caller just wants to know when the Task completes, + // whether successfully or not. } - - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The method that, when executed, will begin the async operation. - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - public JoinableTask RunAsync(Func asyncMethod) + finally { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: JoinableTaskCreationOptions.None); + if (this.Context.IsOnMainThread) + { + this.Context.DecrementMainThreadBlockingCount(); + } } + } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The method that, when executed, will begin the async operation. - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// The used to customize the task's behavior. - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - public JoinableTask RunAsync(Func asyncMethod, JoinableTaskCreationOptions creationOptions) + /// + /// Check whether the current joinableTask is waiting on a long running task. + /// + /// Return true if the current synchronous task on the thread is waiting on a long running task. + protected bool IsWaitingOnLongRunningTask() + { + JoinableTask? currentBlockingTask = JoinableTask.TaskCompletingOnThisThread; + if (currentBlockingTask is object) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: creationOptions); + if ((currentBlockingTask.CreationOptions & JoinableTaskCreationOptions.LongRunning) == JoinableTaskCreationOptions.LongRunning) + { + return true; + } + + using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + { + var allJoinedJobs = new HashSet(); + lock (this.Context.SyncContextLock) + { + JoinableTaskDependencyGraph.AddSelfAndDescendentOrJoinedJobs(currentBlockingTask, allJoinedJobs); + return allJoinedJobs.Any(t => (t.CreationOptions & JoinableTaskCreationOptions.LongRunning) == JoinableTaskCreationOptions.LongRunning); + } + } } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The type of value returned by the asynchronous operation. - /// The method that, when executed, will begin the async operation. - /// - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - public JoinableTask RunAsync(Func> asyncMethod) + return false; + } + + /// + /// Adds the specified joinable task to the applicable collection. + /// + protected void Add(JoinableTask joinable) + { + Requires.NotNull(joinable, nameof(joinable)); + if (this.jobCollection is object) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: JoinableTaskCreationOptions.None); + this.jobCollection.Add(joinable); } + } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The type of value returned by the asynchronous operation. - /// The method that, when executed, will begin the async operation. - /// The used to customize the task's behavior. - /// - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - public JoinableTask RunAsync(Func> asyncMethod, JoinableTaskCreationOptions creationOptions) + /// + /// Throws an exception if an active AsyncReaderWriterLock + /// upgradeable read or write lock is held by the caller. + /// + /// + /// This is important to call from the Run and Run{T} methods because + /// if they are called from within an ARWL upgradeable read or write lock, + /// then Run will synchronously block while inside the semaphore held + /// by the ARWL that prevents concurrency. If the delegate within Run + /// yields and then tries to reacquire the ARWL lock, it will be unable + /// to re-enter the semaphore, leading to a deadlock. + /// Instead, callers who hold UR/W locks should never call Run, or should + /// switch to the STA thread first in order to exit the semaphore before + /// calling the Run method. + /// + private static void VerifyNoNonConcurrentSyncContext() + { + // Don't use Verify.Operation here to avoid loading a string resource in success cases. + if (SynchronizationContext.Current is AsyncReaderWriterLock.NonConcurrentSynchronizationContext) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: creationOptions); + Report.Fail(Strings.NotAllowedUnderURorWLock); // pops a CHK assert dialog, but doesn't throw. + Verify.FailOperation(Strings.NotAllowedUnderURorWLock); // actually throws, even in RET. } + } - /// - /// Responds to calls to - /// by scheduling a continuation to execute on the Main thread. - /// - /// The callback to invoke. - internal SingleExecuteProtector RequestSwitchToMainThread(Action callback) + /// + /// Wraps the invocation of an async method such that it may + /// execute asynchronously, but may potentially be + /// synchronously completed (waited on) in the future. + /// + /// The asynchronous method to execute. + /// A value indicating whether the launching thread will synchronously block for this job's completion. + /// The used to customize the task's behavior. + /// The entry method's info for diagnostics. + private JoinableTask RunAsync(Func asyncMethod, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride = null) + { + Requires.NotNull(asyncMethod, nameof(asyncMethod)); + + var job = new JoinableTask(this, synchronouslyBlocking, creationOptions, entrypointOverride ?? asyncMethod); + this.ExecuteJob(asyncMethod, job); + return job; + } + + private JoinableTask RunAsync(Func> asyncMethod, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions) + { + Requires.NotNull(asyncMethod, nameof(asyncMethod)); + + var job = new JoinableTask(this, synchronouslyBlocking, creationOptions, asyncMethod); + this.ExecuteJob(asyncMethod, job); + return job; + } + + private void ExecuteJob(Func asyncMethod, JoinableTask job) + { + try { - Requires.NotNull(callback, nameof(callback)); - - // Make sure that this thread switch request is in a job that is captured by the job collection - // to which this switch request belongs. - // If an ambient job already exists and belongs to the collection, that's good enough. But if - // there is no ambient job, or the ambient job does not belong to the collection, we must create - // a (child) job and add that to this job factory's collection so that folks joining that factory - // can help this switch to complete. - JoinableTask? ambientJob = this.Context.AmbientTask; - SingleExecuteProtector? wrapper = null; - if (ambientJob is null || (this.jobCollection is object && !this.jobCollection.Contains(ambientJob))) + using (var framework = new RunFramework(this, job)) { - JoinableTask? transient = this.RunAsync( - delegate - { - RoslynDebug.Assert(this.Context.AmbientTask is object, $"{nameof(this.Context.AmbientTask)} is always set for {nameof(this.RunAsync)} callbacks."); - - ambientJob = this.Context.AmbientTask; - wrapper = SingleExecuteProtector.Create(ambientJob, callback); - ambientJob.Post(SingleExecuteProtector.ExecuteOnce, wrapper, true); - return Task.CompletedTask; - }, - synchronouslyBlocking: false, - creationOptions: JoinableTaskCreationOptions.None, - entrypointOverride: callback); - - if (transient.Task.IsFaulted) + Task asyncMethodResult; + try { - // rethrow the exception. - transient.Task.GetAwaiter().GetResult(); + asyncMethodResult = asyncMethod(); } + catch (Exception ex) + { + var tcs = new TaskCompletionSource(); + tcs.SetException(ex); + asyncMethodResult = tcs.Task; + } + + job.SetWrappedTask(asyncMethodResult); } - else - { - wrapper = SingleExecuteProtector.Create(ambientJob, callback); - ambientJob.Post(SingleExecuteProtector.ExecuteOnce, wrapper, true); - } + } + catch (Exception ex) when (FailFast(ex)) + { + // We use a crashing exception filter to capture all the detail possible (even before unwinding the callstack) + // when an exception is thrown from this critical method. + // In particular, we have seen the WeakReference object that is instantiated by "new RunFramework" throw OutOfMemoryException. + throw Assumes.NotReachable(); + } - Assumes.NotNull(wrapper); - return wrapper; + static bool FailFast(Exception ex) + { + Environment.FailFast("Unexpected exception thrown in critical scheduling code.", ex); + throw Assumes.NotReachable(); } + } + + /// + /// An awaitable struct that facilitates an asynchronous transition to the Main thread. + /// + public readonly struct MainThreadAwaitable + { + private readonly JoinableTaskFactory? jobFactory; + + private readonly JoinableTask? job; + + private readonly CancellationToken cancellationToken; + + private readonly bool alwaysYield; /// - /// Posts a callback to the main thread via the underlying dispatcher, - /// or to the threadpool when no dispatcher exists on the main thread. + /// Initializes a new instance of the struct. /// - internal void PostToUnderlyingSynchronizationContextOrThreadPool(SingleExecuteProtector callback) + internal MainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, CancellationToken cancellationToken, bool alwaysYield = false) { - Requires.NotNull(callback, nameof(callback)); + Requires.NotNull(jobFactory, nameof(jobFactory)); - if (this.UnderlyingSynchronizationContext is object) - { - this.PostToUnderlyingSynchronizationContext(SingleExecuteProtector.ExecuteOnce, callback); - } - else - { - ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, callback); - } + this.jobFactory = jobFactory; + this.job = job; + this.cancellationToken = cancellationToken; + this.alwaysYield = alwaysYield; } - /// Runs the specified asynchronous method. - /// The asynchronous method to execute. - /// The used to customize the task's behavior. - /// The delegate to record as the entrypoint for this JoinableTask. - internal void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride) + /// + /// Gets the awaiter. + /// + public MainThreadAwaiter GetAwaiter() { - VerifyNoNonConcurrentSyncContext(); - JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, creationOptions: creationOptions, entrypointOverride: entrypointOverride); - joinable.CompleteOnCurrentThread(); + if (this.jobFactory is null) + { + return default; + } + + return new MainThreadAwaiter(this.jobFactory, this.job, this.alwaysYield, this.cancellationToken); } + } - internal void Post(SendOrPostCallback callback, object? state, bool mainThreadAffinitized) - { - Requires.NotNull(callback, nameof(callback)); + /// + /// An awaiter struct that facilitates an asynchronous transition to the Main thread. + /// + public readonly struct MainThreadAwaiter : ICriticalNotifyCompletion + { + private static readonly Action SafeCancellationAction = state => ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, state); - if (mainThreadAffinitized) - { - JoinableTask? transient = this.RunAsync(delegate - { - RoslynDebug.Assert(this.Context.AmbientTask is object, $"{nameof(this.Context.AmbientTask)} is always set for {nameof(this.RunAsync)} callbacks."); + private static readonly Action UnsafeCancellationAction = state => ThreadPool.UnsafeQueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, state); - this.Context.AmbientTask.Post(callback, state, true); - return Task.CompletedTask; - }); + private readonly JoinableTaskFactory? jobFactory; - if (transient.Task.IsFaulted) - { - // rethrow the exception. - transient.Task.GetAwaiter().GetResult(); - } - } - else - { - ThreadPool.QueueUserWorkItem(new WaitCallback(callback), state); - } + private readonly CancellationToken cancellationToken; + + private readonly bool alwaysYield; + + private readonly JoinableTask? job; + + private readonly bool synchronousCancellation; + + /// + /// Holds the reference to the struct, so that all the copies of will hold + /// the same object. + /// + /// + /// This must be initialized to either null or an object holding no value. + /// If this starts as an object object holding no value, then it means we are interested in the cancellation, + /// and its state would be changed following one of these 2 patterns determined by the execution order. + /// 1. if finishes before is being executed on main thread, + /// then this will hold the real registered value after , and + /// will dispose that value and set a default value of . + /// 2. if is executed on main thread before registers the cancellation, + /// then this will hold a default value of , and + /// would not touch it. + /// + private readonly StrongBox? cancellationRegistrationPtr; + + /// + /// Initializes a new instance of the struct. + /// + internal MainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) + { + this.jobFactory = jobFactory; + this.job = job; + this.cancellationToken = cancellationToken; + this.synchronousCancellation = cancellationToken.IsCancellationRequested && !alwaysYield; + this.alwaysYield = alwaysYield; + + // Don't allocate the pointer if the cancellation token can't be canceled (or already is): + this.cancellationRegistrationPtr = cancellationToken.CanBeCanceled && !this.synchronousCancellation + ? new StrongBox() + : null; } /// - /// Posts a message to the specified underlying SynchronizationContext for processing when the main thread - /// is freely available. + /// Gets a value indicating whether the caller is already on the Main thread. /// - /// The callback to invoke. - /// State to pass to the callback. - protected internal virtual void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) + public bool IsCompleted { - Requires.NotNull(callback, nameof(callback)); - Assumes.NotNull(this.UnderlyingSynchronizationContext); + get + { + if (this.alwaysYield) + { + return false; + } - this.UnderlyingSynchronizationContext.Post(callback, state); + return this.synchronousCancellation + || this.jobFactory is null + || this.jobFactory.Context.IsOnMainThread + || this.jobFactory.Context.UnderlyingSynchronizationContext is null; + } } /// - /// Raised when a joinable task has requested a transition to the main thread. + /// Schedules a continuation for execution on the Main thread + /// without capturing the ExecutionContext. /// - /// The task requesting the transition to the main thread. - /// - /// This event may be raised on any thread, including the main thread. - /// - protected internal virtual void OnTransitioningToMainThread(JoinableTask joinableTask) + /// The action to invoke when the operation completes. + public void UnsafeOnCompleted(Action continuation) { - Requires.NotNull(joinableTask, nameof(joinableTask)); + this.OnCompleted(continuation, flowExecutionContext: false); } /// - /// Raised whenever a joinable task has completed a transition to the main thread. + /// Schedules a continuation for execution on the Main thread. /// - /// The task whose request to transition to the main thread has completed. - /// A value indicating whether the transition was cancelled before it was fulfilled. - /// - /// This event is usually raised on the main thread, but can be on another thread when is . - /// - protected internal virtual void OnTransitionedToMainThread(JoinableTask joinableTask, bool canceled) + /// The action to invoke when the operation completes. + public void OnCompleted(Action continuation) { - Requires.NotNull(joinableTask, nameof(joinableTask)); + this.OnCompleted(continuation, flowExecutionContext: true); } /// - /// Synchronously blocks the calling thread for the completion of the specified task. - /// If running on the main thread, any applicable message pump is suppressed - /// while the thread sleeps. + /// Called on the Main thread to prepare it to execute the continuation. /// - /// The task whose completion is being waited on. - /// - /// Implementations should take care that exceptions from faulted or canceled tasks - /// not be thrown back to the caller. - /// - protected internal virtual void WaitSynchronously(Task task) + public void GetResult() { - if (this.Context.IsOnMainThread) + Assumes.True(this.jobFactory is object); + if (!(this.jobFactory.Context.IsOnMainThread || this.jobFactory.Context.UnderlyingSynchronizationContext is null || this.cancellationToken.IsCancellationRequested)) { - // Suppress any reentrancy by causing this synchronously blocking wait - // to not pump any messages at all. - using (this.Context.NoMessagePumpSynchronizationContext.Apply()) - { - this.WaitSynchronouslyCore(task); - } + throw new JoinableTaskContextException(Strings.SwitchToMainThreadFailedToReachExpectedThread); } - else + + // Release memory associated with the cancellation request. + if (this.cancellationRegistrationPtr is object) { - this.WaitSynchronouslyCore(task); + CancellationTokenRegistration registration = default(CancellationTokenRegistration); + using (this.jobFactory.Context.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.cancellationRegistrationPtr) + { + if (this.cancellationRegistrationPtr.Value.HasValue) + { + registration = this.cancellationRegistrationPtr.Value.Value; + } + + // The reason we set this is to effectively null the struct that + // the strong box points to. Dispose does not seem to do this. If we + // have two copies of MainThreadAwaiter pointing to the same strongbox, + // then if one copy executes but the other does not, we could end + // up holding onto the memory pointed to through this pointer. By + // resetting the value here we make sure it gets cleaned. + // + // In addition, assigning default(CancellationTokenRegistration) to a field that + // stores a Nullable effectively gives it a HasValue status, + // which will let OnCompleted know it lost the interest on the cancellation. That is an + // important hint for OnCompleted() in order NOT to leak the cancellation registration. + this.cancellationRegistrationPtr.Value = default(CancellationTokenRegistration); + } + } + + // Intentionally deferring disposal till we exit the lock to avoid executing outside code within the lock. + registration.Dispose(); } + + // If this method is called in a continuation after an actual yield, then SingleExecuteProtector.TryExecute + // should have already applied the appropriate SynchronizationContext to avoid deadlocks. + // However if no yield occurred then no TryExecute would have been invoked, so to avoid deadlocks in those + // cases, we apply the synchronization context here. + // We don't have an opportunity to revert the sync context change, but it turns out we don't need to because + // this method should only be called from async methods, which automatically revert any execution context + // changes they apply (including SynchronizationContext) when they complete, thanks to the way .NET 4.5 works. + SynchronizationContext? syncContext = this.job is object ? this.job.ApplicableJobSyncContext : this.jobFactory.ApplicableJobSyncContext; + syncContext.Apply(); + + // Cancel if requested, even if we arrived on the main thread. + // Unlike most async methods where throwing OperationCanceledException after completing the work may not be a good idea, + // SwitchToMainThreadAsync is a scheduler method, and always precedes some work by the caller that almost certainly should + // not be carried out if cancellation was requested. + this.cancellationToken.ThrowIfCancellationRequested(); } /// - /// Synchronously blocks the calling thread for the completion of the specified task. + /// Schedules a continuation for execution on the Main thread. /// - /// The task whose completion is being waited on. - /// - /// Implementations should take care that exceptions from faulted or canceled tasks - /// not be thrown back to the caller. - /// - protected virtual void WaitSynchronouslyCore(Task task) + /// The action to invoke when the operation completes. + /// A value indicating whether to capture and reapply the current ExecutionContext for the continuation. + private void OnCompleted(Action continuation, bool flowExecutionContext) { - Requires.NotNull(task, nameof(task)); + Assumes.True(this.jobFactory is object); - if (this.Context.IsOnMainThread) + bool restoreFlow = !flowExecutionContext && !ExecutionContext.IsFlowSuppressed(); + if (restoreFlow) { - this.Context.IncrementMainThreadBlockingCount(); + ExecutionContext.SuppressFlow(); } - int hangTimeoutsCount = 0; // useful for debugging dump files to see how many times we looped. - int hangNotificationCount = 0; - Guid hangId = Guid.Empty; - Stopwatch? stopWatch = null; try { - while (!task.Wait(this.HangDetectionTimeout)) - { - if (hangTimeoutsCount == 0) - { - stopWatch = Stopwatch.StartNew(); - } + // In the event of a cancellation request, it becomes a race as to whether the threadpool + // or the main thread will execute the continuation first. So we must wrap the continuation + // in a SingleExecuteProtector so that it can't be executed twice by accident. + // Success case of the main thread. + SingleExecuteProtector? wrapper = this.jobFactory.RequestSwitchToMainThread(continuation); - hangTimeoutsCount++; - TimeSpan hangDuration = TimeSpan.FromMilliseconds(this.HangDetectionTimeout.TotalMilliseconds * hangTimeoutsCount); - if (hangId == Guid.Empty) + // Cancellation case of a threadpool thread. + if (this.cancellationRegistrationPtr is object) + { + // Store the cancellation token registration in the struct pointer. This way, + // if the awaiter has been copied (since it's a struct), each copy of the awaiter + // points to the same registration. Without this we can have a memory leak. + CancellationTokenRegistration registration = this.cancellationToken.Register( + NullableHelpers.AsNullableArgAction(flowExecutionContext ? SafeCancellationAction : UnsafeCancellationAction), + wrapper, + useSynchronizationContext: false); + + // Needs a lock to avoid a race condition between this method and GetResult(). + // This method is usually called on a background thread. After "this.jobFactory.RequestSwitchToMainThread()" returns, + // the continuation is scheduled and GetResult() will be called whenever it is ready on main thread. + // We have observed sometimes GetResult() was called right after "this.jobFactory.RequestSwitchToMainThread()" + // and before "this.cancellationToken.Register()". If that happens, that means we lose the interest on the cancellation + // and should not register the cancellation here. Without protecting that, "this.cancellationRegistrationPtr" will be leaked. + bool disposeThisRegistration = false; + using (this.jobFactory.Context.NoMessagePumpSynchronizationContext.Apply()) { - hangId = Guid.NewGuid(); + lock (this.cancellationRegistrationPtr) + { + if (!this.cancellationRegistrationPtr.Value.HasValue) + { + this.cancellationRegistrationPtr.Value = registration; + } + else + { + disposeThisRegistration = true; + } + } } - if (!this.IsWaitingOnLongRunningTask()) + if (disposeThisRegistration) { - hangNotificationCount++; - this.Context.OnHangDetected(hangDuration, hangNotificationCount, hangId); + registration.Dispose(); } } - - if (hangNotificationCount > 0) - { - RoslynDebug.Assert(stopWatch is object); - - // We detect a false alarm. The stop watch was started after the first timeout, so we add intial timeout to the total delay. - this.Context.OnFalseHangDetected( - stopWatch.Elapsed + this.HangDetectionTimeout, - hangId); - } } - catch (AggregateException) + catch (Exception ex) { - // Swallow exceptions thrown by Task.Wait(). - // Our caller just wants to know when the Task completes, - // whether successfully or not. + // This is bad. It would cause a hang without a trace as to why, since if we can't + // schedule the continuation, stuff would just never happen. + // Crash now, so that a Watson report would capture the original error. + Environment.FailFast("Failed to schedule time on the UI thread. A continuation would never execute.", ex); } finally { - if (this.Context.IsOnMainThread) + if (restoreFlow) { - this.Context.DecrementMainThreadBlockingCount(); + ExecutionContext.RestoreFlow(); } } } + } + + /// + /// A value to construct with a C# using block in all the Run method overloads + /// to setup and teardown the boilerplate stuff. + /// + private readonly struct RunFramework : IDisposable + { + private readonly JoinableTaskFactory factory; + private readonly SpecializedSyncContext syncContextRevert; + private readonly JoinableTask joinable; + private readonly JoinableTask? previousJoinable; /// - /// Check whether the current joinableTask is waiting on a long running task. + /// Initializes a new instance of the struct + /// and sets up the synchronization contexts for the + /// family of methods. /// - /// Return true if the current synchronous task on the thread is waiting on a long running task. - protected bool IsWaitingOnLongRunningTask() + internal RunFramework(JoinableTaskFactory factory, JoinableTask joinable) { - JoinableTask? currentBlockingTask = JoinableTask.TaskCompletingOnThisThread; - if (currentBlockingTask is object) + Requires.NotNull(factory, nameof(factory)); + Requires.NotNull(joinable, nameof(joinable)); + + this.factory = factory; + this.joinable = joinable; + this.factory.Add(joinable); + this.previousJoinable = this.factory.Context.AmbientTask; + this.factory.Context.AmbientTask = joinable; + this.syncContextRevert = this.joinable.ApplicableJobSyncContext.Apply(); + + // Join the ambient parent job, so the parent can dequeue this job's work. + if (this.previousJoinable is object && !this.previousJoinable.IsFullyCompleted) { - if ((currentBlockingTask.CreationOptions & JoinableTaskCreationOptions.LongRunning) == JoinableTaskCreationOptions.LongRunning) - { - return true; - } + JoinableTaskDependencyGraph.AddDependency(this.previousJoinable, joinable); - using (this.Context.NoMessagePumpSynchronizationContext.Apply()) + // By definition we inherit the nesting factories of our immediate nesting task. + ListOfOftenOne nestingFactories = this.previousJoinable.NestingFactories; + + // And we may add our immediate nesting parent's factory to the list of + // ancestors if it isn't already in the list. + if (this.previousJoinable.Factory != this.factory) { - var allJoinedJobs = new HashSet(); - lock (this.Context.SyncContextLock) + if (!nestingFactories.Contains(this.previousJoinable.Factory)) { - JoinableTaskDependencyGraph.AddSelfAndDescendentOrJoinedJobs(currentBlockingTask, allJoinedJobs); - return allJoinedJobs.Any(t => (t.CreationOptions & JoinableTaskCreationOptions.LongRunning) == JoinableTaskCreationOptions.LongRunning); + nestingFactories.Add(this.previousJoinable.Factory); } } - } - return false; + this.joinable.NestingFactories = nestingFactories; + } } /// - /// Adds the specified joinable task to the applicable collection. + /// Reverts the execution context to its previous state before this struct was created. /// - protected void Add(JoinableTask joinable) + public void Dispose() { - Requires.NotNull(joinable, nameof(joinable)); - if (this.jobCollection is object) - { - this.jobCollection.Add(joinable); - } + this.syncContextRevert.Dispose(); + this.factory.Context.AmbientTask = this.previousJoinable; } + } + /// + /// A delegate wrapper that ensures the delegate is only invoked at most once. + /// + [DebuggerDisplay("{DelegateLabel}")] + internal class SingleExecuteProtector + { /// - /// Throws an exception if an active AsyncReaderWriterLock - /// upgradeable read or write lock is held by the caller. + /// Executes the delegate if it has not already executed. /// - /// - /// This is important to call from the Run and Run{T} methods because - /// if they are called from within an ARWL upgradeable read or write lock, - /// then Run will synchronously block while inside the semaphore held - /// by the ARWL that prevents concurrency. If the delegate within Run - /// yields and then tries to reacquire the ARWL lock, it will be unable - /// to re-enter the semaphore, leading to a deadlock. - /// Instead, callers who hold UR/W locks should never call Run, or should - /// switch to the STA thread first in order to exit the semaphore before - /// calling the Run method. - /// - private static void VerifyNoNonConcurrentSyncContext() - { - // Don't use Verify.Operation here to avoid loading a string resource in success cases. - if (SynchronizationContext.Current is AsyncReaderWriterLock.NonConcurrentSynchronizationContext) - { - Report.Fail(Strings.NotAllowedUnderURorWLock); // pops a CHK assert dialog, but doesn't throw. - Verify.FailOperation(Strings.NotAllowedUnderURorWLock); // actually throws, even in RET. - } - } + internal static readonly SendOrPostCallback ExecuteOnce = state => ((SingleExecuteProtector)state!).TryExecute(); /// - /// Wraps the invocation of an async method such that it may - /// execute asynchronously, but may potentially be - /// synchronously completed (waited on) in the future. + /// Executes the delegate if it has not already executed. /// - /// The asynchronous method to execute. - /// A value indicating whether the launching thread will synchronously block for this job's completion. - /// The used to customize the task's behavior. - /// The entry method's info for diagnostics. - private JoinableTask RunAsync(Func asyncMethod, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride = null) - { - Requires.NotNull(asyncMethod, nameof(asyncMethod)); + internal static readonly WaitCallback ExecuteOnceWaitCallback = state => ((SingleExecuteProtector)state!).TryExecute(); - var job = new JoinableTask(this, synchronouslyBlocking, creationOptions, entrypointOverride ?? asyncMethod); - this.ExecuteJob(asyncMethod, job); - return job; - } + /// + /// The job that created this wrapper. + /// + private JoinableTask? job; - private JoinableTask RunAsync(Func> asyncMethod, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions) - { - Requires.NotNull(asyncMethod, nameof(asyncMethod)); + private bool raiseTransitionComplete; + + /// + /// The delegate to invoke. if it has already been invoked. + /// + /// May be of type or . + private object? invokeDelegate; + + /// + /// The value to pass to the delegate if it is a . + /// + private object? state; + + /// + /// Stores execution callbacks for . + /// + private ListOfOftenOne executingCallbacks; - var job = new JoinableTask(this, synchronouslyBlocking, creationOptions, asyncMethod); - this.ExecuteJob(asyncMethod, job); - return job; + /// + /// Initializes a new instance of the class. + /// + private SingleExecuteProtector(JoinableTask job) + { + Requires.NotNull(job, nameof(job)); + this.job = job; } - private void ExecuteJob(Func asyncMethod, JoinableTask job) + /// + /// Gets a value indicating whether this instance has already executed. + /// + internal bool HasBeenExecuted { - try - { - using (var framework = new RunFramework(this, job)) - { - Task asyncMethodResult; - try - { - asyncMethodResult = asyncMethod(); - } - catch (Exception ex) - { - var tcs = new TaskCompletionSource(); - tcs.SetException(ex); - asyncMethodResult = tcs.Task; - } + get { return this.invokeDelegate is null; } + } - job.SetWrappedTask(asyncMethodResult); - } - } - catch (Exception ex) when (FailFast(ex)) + /// + /// Gets a string that describes the delegate that this instance invokes. + /// FOR DIAGNOSTIC PURPOSES ONLY. + /// + internal string DelegateLabel + { + get { - // We use a crashing exception filter to capture all the detail possible (even before unwinding the callstack) - // when an exception is thrown from this critical method. - // In particular, we have seen the WeakReference object that is instantiated by "new RunFramework" throw OutOfMemoryException. - throw Assumes.NotReachable(); + return this.WalkAsyncReturnStackFrames().First(); // Top frame of the return callstack. } + } - static bool FailFast(Exception ex) + /// + /// Initializes a new instance of the class. + /// + /// The joinable task responsible for this work. + /// The delegate being wrapped. + /// An instance of . + internal static SingleExecuteProtector Create(JoinableTask job, Action action) + { + return new SingleExecuteProtector(job) { - Environment.FailFast("Unexpected exception thrown in critical scheduling code.", ex); - throw Assumes.NotReachable(); - } + invokeDelegate = action, + }; } /// - /// An awaitable struct that facilitates an asynchronous transition to the Main thread. + /// Initializes a new instance of the class + /// that describes the specified callback. /// - public readonly struct MainThreadAwaitable + /// The joinable task responsible for this work. + /// The callback to invoke. + /// The state object to pass to the callback. + /// An instance of . + internal static SingleExecuteProtector Create(JoinableTask job, SendOrPostCallback callback, object? state) { - private readonly JoinableTaskFactory? jobFactory; - - private readonly JoinableTask? job; - - private readonly CancellationToken cancellationToken; - - private readonly bool alwaysYield; + Requires.NotNull(job, nameof(job)); - /// - /// Initializes a new instance of the struct. - /// - internal MainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, CancellationToken cancellationToken, bool alwaysYield = false) + // As an optimization, recognize if what we're being handed is already an instance of this type, + // because if it is, we don't need to wrap it with yet another instance. + var existing = state as SingleExecuteProtector; + if (callback == ExecuteOnce && existing is object && job == existing.job) { - Requires.NotNull(jobFactory, nameof(jobFactory)); - - this.jobFactory = jobFactory; - this.job = job; - this.cancellationToken = cancellationToken; - this.alwaysYield = alwaysYield; + return existing; } - /// - /// Gets the awaiter. - /// - public MainThreadAwaiter GetAwaiter() + return new SingleExecuteProtector(job) { - if (this.jobFactory is null) - { - return default; - } - - return new MainThreadAwaiter(this.jobFactory, this.job, this.alwaysYield, this.cancellationToken); - } + invokeDelegate = callback, + state = state, + }; } /// - /// An awaiter struct that facilitates an asynchronous transition to the Main thread. + /// Registers for a callback when this instance is executed. /// - public readonly struct MainThreadAwaiter : ICriticalNotifyCompletion + internal void AddExecutingCallback(JoinableTask.ExecutionQueue callbackReceiver) { - private static readonly Action SafeCancellationAction = state => ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, state); - - private static readonly Action UnsafeCancellationAction = state => ThreadPool.UnsafeQueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, state); - - private readonly JoinableTaskFactory? jobFactory; - - private readonly CancellationToken cancellationToken; - - private readonly bool alwaysYield; - - private readonly JoinableTask? job; - - private readonly bool synchronousCancellation; - - /// - /// Holds the reference to the struct, so that all the copies of will hold - /// the same object. - /// - /// - /// This must be initialized to either null or an object holding no value. - /// If this starts as an object object holding no value, then it means we are interested in the cancellation, - /// and its state would be changed following one of these 2 patterns determined by the execution order. - /// 1. if finishes before is being executed on main thread, - /// then this will hold the real registered value after , and - /// will dispose that value and set a default value of . - /// 2. if is executed on main thread before registers the cancellation, - /// then this will hold a default value of , and - /// would not touch it. - /// - private readonly StrongBox? cancellationRegistrationPtr; - - /// - /// Initializes a new instance of the struct. - /// - internal MainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) + if (!this.HasBeenExecuted) { - this.jobFactory = jobFactory; - this.job = job; - this.cancellationToken = cancellationToken; - this.synchronousCancellation = cancellationToken.IsCancellationRequested && !alwaysYield; - this.alwaysYield = alwaysYield; - - // Don't allocate the pointer if the cancellation token can't be canceled (or already is): - this.cancellationRegistrationPtr = cancellationToken.CanBeCanceled && !this.synchronousCancellation - ? new StrongBox() - : null; + this.executingCallbacks.Add(callbackReceiver); } + } - /// - /// Gets a value indicating whether the caller is already on the Main thread. - /// - public bool IsCompleted - { - get - { - if (this.alwaysYield) - { - return false; - } - - return this.synchronousCancellation - || this.jobFactory is null - || this.jobFactory.Context.IsOnMainThread - || this.jobFactory.Context.UnderlyingSynchronizationContext is null; - } - } + /// + /// Unregisters a callback for when this instance is executed. + /// + internal void RemoveExecutingCallback(JoinableTask.ExecutionQueue callbackReceiver) + { + this.executingCallbacks.Remove(callbackReceiver); + } - /// - /// Schedules a continuation for execution on the Main thread - /// without capturing the ExecutionContext. - /// - /// The action to invoke when the operation completes. - public void UnsafeOnCompleted(Action continuation) + /// + /// Walk the continuation objects inside "async state machines" to generate the return callstack. + /// FOR DIAGNOSTIC PURPOSES ONLY. + /// + internal IEnumerable WalkAsyncReturnStackFrames() + { + // This instance might be a wrapper of another instance of "SingleExecuteProtector". + // If that is true, we need to follow the chain to find the inner instance of "SingleExecuteProtector". + SingleExecuteProtector? singleExecuteProtector = this; + while (singleExecuteProtector.state is SingleExecuteProtector) { - this.OnCompleted(continuation, flowExecutionContext: false); + singleExecuteProtector = (SingleExecuteProtector)singleExecuteProtector.state; } - /// - /// Schedules a continuation for execution on the Main thread. - /// - /// The action to invoke when the operation completes. - public void OnCompleted(Action continuation) - { - this.OnCompleted(continuation, flowExecutionContext: true); - } + var invokeDelegate = singleExecuteProtector.invokeDelegate as Delegate; + var stateDelegate = singleExecuteProtector.state as Delegate; - /// - /// Called on the Main thread to prepare it to execute the continuation. - /// - public void GetResult() + // We are in favor of "state" when "invokeDelegate" is a static method and "state" is the actual delegate. + Delegate? actualDelegate = (stateDelegate is object && stateDelegate.Target is object) ? stateDelegate : invokeDelegate; + if (actualDelegate is null) { - Assumes.True(this.jobFactory is object); - if (!(this.jobFactory.Context.IsOnMainThread || this.jobFactory.Context.UnderlyingSynchronizationContext is null || this.cancellationToken.IsCancellationRequested)) - { - throw new JoinableTaskContextException(Strings.SwitchToMainThreadFailedToReachExpectedThread); - } - - // Release memory associated with the cancellation request. - if (this.cancellationRegistrationPtr is object) - { - CancellationTokenRegistration registration = default(CancellationTokenRegistration); - using (this.jobFactory.Context.NoMessagePumpSynchronizationContext.Apply()) - { - lock (this.cancellationRegistrationPtr) - { - if (this.cancellationRegistrationPtr.Value.HasValue) - { - registration = this.cancellationRegistrationPtr.Value.Value; - } - - // The reason we set this is to effectively null the struct that - // the strong box points to. Dispose does not seem to do this. If we - // have two copies of MainThreadAwaiter pointing to the same strongbox, - // then if one copy executes but the other does not, we could end - // up holding onto the memory pointed to through this pointer. By - // resetting the value here we make sure it gets cleaned. - // - // In addition, assigning default(CancellationTokenRegistration) to a field that - // stores a Nullable effectively gives it a HasValue status, - // which will let OnCompleted know it lost the interest on the cancellation. That is an - // important hint for OnCompleted() in order NOT to leak the cancellation registration. - this.cancellationRegistrationPtr.Value = default(CancellationTokenRegistration); - } - } - - // Intentionally deferring disposal till we exit the lock to avoid executing outside code within the lock. - registration.Dispose(); - } - - // If this method is called in a continuation after an actual yield, then SingleExecuteProtector.TryExecute - // should have already applied the appropriate SynchronizationContext to avoid deadlocks. - // However if no yield occurred then no TryExecute would have been invoked, so to avoid deadlocks in those - // cases, we apply the synchronization context here. - // We don't have an opportunity to revert the sync context change, but it turns out we don't need to because - // this method should only be called from async methods, which automatically revert any execution context - // changes they apply (including SynchronizationContext) when they complete, thanks to the way .NET 4.5 works. - SynchronizationContext? syncContext = this.job is object ? this.job.ApplicableJobSyncContext : this.jobFactory.ApplicableJobSyncContext; - syncContext.Apply(); - - // Cancel if requested, even if we arrived on the main thread. - // Unlike most async methods where throwing OperationCanceledException after completing the work may not be a good idea, - // SwitchToMainThreadAsync is a scheduler method, and always precedes some work by the caller that almost certainly should - // not be carried out if cancellation was requested. - this.cancellationToken.ThrowIfCancellationRequested(); + yield return ""; + yield break; } - /// - /// Schedules a continuation for execution on the Main thread. - /// - /// The action to invoke when the operation completes. - /// A value indicating whether to capture and reapply the current ExecutionContext for the continuation. - private void OnCompleted(Action continuation, bool flowExecutionContext) + foreach (var frame in actualDelegate.GetAsyncReturnStackFrames()) { - Assumes.True(this.jobFactory is object); - - bool restoreFlow = !flowExecutionContext && !ExecutionContext.IsFlowSuppressed(); - if (restoreFlow) - { - ExecutionContext.SuppressFlow(); - } + yield return frame; + } + } - try - { - // In the event of a cancellation request, it becomes a race as to whether the threadpool - // or the main thread will execute the continuation first. So we must wrap the continuation - // in a SingleExecuteProtector so that it can't be executed twice by accident. - // Success case of the main thread. - SingleExecuteProtector? wrapper = this.jobFactory.RequestSwitchToMainThread(continuation); - - // Cancellation case of a threadpool thread. - if (this.cancellationRegistrationPtr is object) - { - // Store the cancellation token registration in the struct pointer. This way, - // if the awaiter has been copied (since it's a struct), each copy of the awaiter - // points to the same registration. Without this we can have a memory leak. - CancellationTokenRegistration registration = this.cancellationToken.Register( - NullableHelpers.AsNullableArgAction(flowExecutionContext ? SafeCancellationAction : UnsafeCancellationAction), - wrapper, - useSynchronizationContext: false); - - // Needs a lock to avoid a race condition between this method and GetResult(). - // This method is usually called on a background thread. After "this.jobFactory.RequestSwitchToMainThread()" returns, - // the continuation is scheduled and GetResult() will be called whenever it is ready on main thread. - // We have observed sometimes GetResult() was called right after "this.jobFactory.RequestSwitchToMainThread()" - // and before "this.cancellationToken.Register()". If that happens, that means we lose the interest on the cancellation - // and should not register the cancellation here. Without protecting that, "this.cancellationRegistrationPtr" will be leaked. - bool disposeThisRegistration = false; - using (this.jobFactory.Context.NoMessagePumpSynchronizationContext.Apply()) - { - lock (this.cancellationRegistrationPtr) - { - if (!this.cancellationRegistrationPtr.Value.HasValue) - { - this.cancellationRegistrationPtr.Value = registration; - } - else - { - disposeThisRegistration = true; - } - } - } + internal void RaiseTransitioningEvents() + { + Assumes.False(this.raiseTransitionComplete); // if this method is called twice, that's the sign of a problem. + RoslynDebug.Assert(this.job is object); - if (disposeThisRegistration) - { - registration.Dispose(); - } - } - } - catch (Exception ex) - { - // This is bad. It would cause a hang without a trace as to why, since if we can't - // schedule the continuation, stuff would just never happen. - // Crash now, so that a Watson report would capture the original error. - Environment.FailFast("Failed to schedule time on the UI thread. A continuation would never execute.", ex); - } - finally - { - if (restoreFlow) - { - ExecutionContext.RestoreFlow(); - } - } - } + this.raiseTransitionComplete = true; + this.job.Factory.OnTransitioningToMainThread(this.job); } /// - /// A value to construct with a C# using block in all the Run method overloads - /// to setup and teardown the boilerplate stuff. + /// Executes the delegate if it has not already executed. /// - private readonly struct RunFramework : IDisposable + internal bool TryExecute() { - private readonly JoinableTaskFactory factory; - private readonly SpecializedSyncContext syncContextRevert; - private readonly JoinableTask joinable; - private readonly JoinableTask? previousJoinable; - - /// - /// Initializes a new instance of the struct - /// and sets up the synchronization contexts for the - /// family of methods. - /// - internal RunFramework(JoinableTaskFactory factory, JoinableTask joinable) + object? invokeDelegate = Interlocked.Exchange(ref this.invokeDelegate, null); + if (invokeDelegate is object) { - Requires.NotNull(factory, nameof(factory)); - Requires.NotNull(joinable, nameof(joinable)); - - this.factory = factory; - this.joinable = joinable; - this.factory.Add(joinable); - this.previousJoinable = this.factory.Context.AmbientTask; - this.factory.Context.AmbientTask = joinable; - this.syncContextRevert = this.joinable.ApplicableJobSyncContext.Apply(); - - // Join the ambient parent job, so the parent can dequeue this job's work. - if (this.previousJoinable is object && !this.previousJoinable.IsFullyCompleted) + this.OnExecuting(); + RoslynDebug.Assert(this.job is object); + SynchronizationContext? syncContext = this.job.ApplicableJobSyncContext; + using (syncContext.Apply(checkForChangesOnRevert: false)) { - JoinableTaskDependencyGraph.AddDependency(this.previousJoinable, joinable); - - // By definition we inherit the nesting factories of our immediate nesting task. - ListOfOftenOne nestingFactories = this.previousJoinable.NestingFactories; - - // And we may add our immediate nesting parent's factory to the list of - // ancestors if it isn't already in the list. - if (this.previousJoinable.Factory != this.factory) + if (invokeDelegate is Action action) { - if (!nestingFactories.Contains(this.previousJoinable.Factory)) - { - nestingFactories.Add(this.previousJoinable.Factory); - } + action(); + } + else + { + var callback = (SendOrPostCallback)invokeDelegate; + callback(this.state); } - this.joinable.NestingFactories = nestingFactories; + // Release the rest of the memory we're referencing. + this.state = null; + this.job = null; } - } - /// - /// Reverts the execution context to its previous state before this struct was created. - /// - public void Dispose() + return true; + } + else { - this.syncContextRevert.Dispose(); - this.factory.Context.AmbientTask = this.previousJoinable; + return false; } } /// - /// A delegate wrapper that ensures the delegate is only invoked at most once. + /// Invokes handler. /// - [DebuggerDisplay("{DelegateLabel}")] - internal class SingleExecuteProtector + private void OnExecuting() { - /// - /// Executes the delegate if it has not already executed. - /// - internal static readonly SendOrPostCallback ExecuteOnce = state => ((SingleExecuteProtector)state!).TryExecute(); - - /// - /// Executes the delegate if it has not already executed. - /// - internal static readonly WaitCallback ExecuteOnceWaitCallback = state => ((SingleExecuteProtector)state!).TryExecute(); - - /// - /// The job that created this wrapper. - /// - private JoinableTask? job; - - private bool raiseTransitionComplete; - - /// - /// The delegate to invoke. if it has already been invoked. - /// - /// May be of type or . - private object? invokeDelegate; - - /// - /// The value to pass to the delegate if it is a . - /// - private object? state; - - /// - /// Stores execution callbacks for . - /// - private ListOfOftenOne executingCallbacks; - - /// - /// Initializes a new instance of the class. - /// - private SingleExecuteProtector(JoinableTask job) - { - Requires.NotNull(job, nameof(job)); - this.job = job; - } - - /// - /// Gets a value indicating whether this instance has already executed. - /// - internal bool HasBeenExecuted - { - get { return this.invokeDelegate is null; } - } - - /// - /// Gets a string that describes the delegate that this instance invokes. - /// FOR DIAGNOSTIC PURPOSES ONLY. - /// - internal string DelegateLabel - { - get - { - return this.WalkAsyncReturnStackFrames().First(); // Top frame of the return callstack. - } - } - - /// - /// Initializes a new instance of the class. - /// - /// The joinable task responsible for this work. - /// The delegate being wrapped. - /// An instance of . - internal static SingleExecuteProtector Create(JoinableTask job, Action action) - { - return new SingleExecuteProtector(job) - { - invokeDelegate = action, - }; - } - - /// - /// Initializes a new instance of the class - /// that describes the specified callback. - /// - /// The joinable task responsible for this work. - /// The callback to invoke. - /// The state object to pass to the callback. - /// An instance of . - internal static SingleExecuteProtector Create(JoinableTask job, SendOrPostCallback callback, object? state) - { - Requires.NotNull(job, nameof(job)); - - // As an optimization, recognize if what we're being handed is already an instance of this type, - // because if it is, we don't need to wrap it with yet another instance. - var existing = state as SingleExecuteProtector; - if (callback == ExecuteOnce && existing is object && job == existing.job) - { - return existing; - } - - return new SingleExecuteProtector(job) - { - invokeDelegate = callback, - state = state, - }; - } - - /// - /// Registers for a callback when this instance is executed. - /// - internal void AddExecutingCallback(JoinableTask.ExecutionQueue callbackReceiver) - { - if (!this.HasBeenExecuted) - { - this.executingCallbacks.Add(callbackReceiver); - } - } - - /// - /// Unregisters a callback for when this instance is executed. - /// - internal void RemoveExecutingCallback(JoinableTask.ExecutionQueue callbackReceiver) + if (ThreadingEventSource.Instance.IsEnabled()) { - this.executingCallbacks.Remove(callbackReceiver); + ThreadingEventSource.Instance.PostExecutionStop(this.GetHashCode()); } - /// - /// Walk the continuation objects inside "async state machines" to generate the return callstack. - /// FOR DIAGNOSTIC PURPOSES ONLY. - /// - internal IEnumerable WalkAsyncReturnStackFrames() + // While raising the event, automatically remove the handlers since we'll only + // raise them once, and we'd like to avoid holding references that may extend + // the lifetime of our recipients. + using (ListOfOftenOne.Enumerator enumerator = this.executingCallbacks.EnumerateAndClear()) { - // This instance might be a wrapper of another instance of "SingleExecuteProtector". - // If that is true, we need to follow the chain to find the inner instance of "SingleExecuteProtector". - SingleExecuteProtector? singleExecuteProtector = this; - while (singleExecuteProtector.state is SingleExecuteProtector) - { - singleExecuteProtector = (SingleExecuteProtector)singleExecuteProtector.state; - } - - var invokeDelegate = singleExecuteProtector.invokeDelegate as Delegate; - var stateDelegate = singleExecuteProtector.state as Delegate; - - // We are in favor of "state" when "invokeDelegate" is a static method and "state" is the actual delegate. - Delegate? actualDelegate = (stateDelegate is object && stateDelegate.Target is object) ? stateDelegate : invokeDelegate; - if (actualDelegate is null) - { - yield return ""; - yield break; - } - - foreach (var frame in actualDelegate.GetAsyncReturnStackFrames()) + while (enumerator.MoveNext()) { - yield return frame; + enumerator.Current.OnExecuting(this, EventArgs.Empty); } } - internal void RaiseTransitioningEvents() + if (this.raiseTransitionComplete) { - Assumes.False(this.raiseTransitionComplete); // if this method is called twice, that's the sign of a problem. RoslynDebug.Assert(this.job is object); - this.raiseTransitionComplete = true; - this.job.Factory.OnTransitioningToMainThread(this.job); - } - - /// - /// Executes the delegate if it has not already executed. - /// - internal bool TryExecute() - { - object? invokeDelegate = Interlocked.Exchange(ref this.invokeDelegate, null); - if (invokeDelegate is object) - { - this.OnExecuting(); - RoslynDebug.Assert(this.job is object); - SynchronizationContext? syncContext = this.job.ApplicableJobSyncContext; - using (syncContext.Apply(checkForChangesOnRevert: false)) - { - if (invokeDelegate is Action action) - { - action(); - } - else - { - var callback = (SendOrPostCallback)invokeDelegate; - callback(this.state); - } - - // Release the rest of the memory we're referencing. - this.state = null; - this.job = null; - } - - return true; - } - else - { - return false; - } - } - - /// - /// Invokes handler. - /// - private void OnExecuting() - { - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.PostExecutionStop(this.GetHashCode()); - } - - // While raising the event, automatically remove the handlers since we'll only - // raise them once, and we'd like to avoid holding references that may extend - // the lifetime of our recipients. - using (ListOfOftenOne.Enumerator enumerator = this.executingCallbacks.EnumerateAndClear()) - { - while (enumerator.MoveNext()) - { - enumerator.Current.OnExecuting(this, EventArgs.Empty); - } - } - - if (this.raiseTransitionComplete) - { - RoslynDebug.Assert(this.job is object); - - this.job.Factory.OnTransitionedToMainThread(this.job, !this.job.Factory.Context.IsOnMainThread); - } + this.job.Factory.OnTransitionedToMainThread(this.job, !this.job.Factory.Context.IsOnMainThread); } } } diff --git a/src/Microsoft.VisualStudio.Threading/LightUps.cs b/src/Microsoft.VisualStudio.Threading/LightUps.cs index 7baa9d766..71475c1d2 100644 --- a/src/Microsoft.VisualStudio.Threading/LightUps.cs +++ b/src/Microsoft.VisualStudio.Threading/LightUps.cs @@ -3,34 +3,33 @@ using System; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A non-generic class used to store statics that do not vary by generic type argument. +/// +internal static class LightUps { /// - /// A non-generic class used to store statics that do not vary by generic type argument. + /// Gets a value indicating whether we execute Windows 7 code even on later versions of Windows. /// - internal static class LightUps - { - /// - /// Gets a value indicating whether we execute Windows 7 code even on later versions of Windows. - /// - internal const bool ForceWindows7Mode = false; + internal const bool ForceWindows7Mode = false; - /// - /// The for Windows 8. - /// - private static readonly Version Windows8Version = new Version(6, 2, 9200); + /// + /// The for Windows 8. + /// + private static readonly Version Windows8Version = new Version(6, 2, 9200); - /// - /// Gets a value indicating whether the current operating system is Windows 8 or later. - /// - internal static bool IsWindows8OrLater + /// + /// Gets a value indicating whether the current operating system is Windows 8 or later. + /// + internal static bool IsWindows8OrLater + { + get { - get - { - return !ForceWindows7Mode - && Environment.OSVersion.Platform == PlatformID.Win32NT - && Environment.OSVersion.Version >= Windows8Version; - } + return !ForceWindows7Mode + && Environment.OSVersion.Platform == PlatformID.Win32NT + && Environment.OSVersion.Version >= Windows8Version; } } } diff --git a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs index e3a9c7edb..6520289fc 100644 --- a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs +++ b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs @@ -9,252 +9,251 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A thread-safe collection optimized for very small number of non-null elements. +/// +/// The type of elements to be stored. +/// +/// The collection is alloc-free for storage, retrieval and enumeration of collection sizes of 0 or 1. +/// Beyond that causes one allocation for an immutable array that contains the entire collection. +/// +internal struct ListOfOftenOne : IEnumerable + where T : class { /// - /// A thread-safe collection optimized for very small number of non-null elements. + /// The single value or array of values stored by this collection. Null if empty. /// - /// The type of elements to be stored. - /// - /// The collection is alloc-free for storage, retrieval and enumeration of collection sizes of 0 or 1. - /// Beyond that causes one allocation for an immutable array that contains the entire collection. - /// - internal struct ListOfOftenOne : IEnumerable - where T : class + private object? value; + + /// + /// Returns an enumerator for a current snapshot of the collection. + /// + public Enumerator GetEnumerator() { - /// - /// The single value or array of values stored by this collection. Null if empty. - /// - private object? value; - - /// - /// Returns an enumerator for a current snapshot of the collection. - /// - public Enumerator GetEnumerator() - { - return new Enumerator(Volatile.Read(ref this.value)); - } + return new Enumerator(Volatile.Read(ref this.value)); + } - /// - /// Returns an enumerator for a current snapshot of the collection. - /// - IEnumerator IEnumerable.GetEnumerator() + /// + /// Returns an enumerator for a current snapshot of the collection. + /// + IEnumerator IEnumerable.GetEnumerator() + { + return this.GetEnumerator(); + } + + /// + /// Returns an enumerator for a current snapshot of the collection. + /// + System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() + { + return this.GetEnumerator(); + } + + /// + /// Adds an element to the collection. + /// + public void Add(T value) + { + object? priorValue; + object? fieldBeforeExchange; + do { - return this.GetEnumerator(); + priorValue = Volatile.Read(ref this.value); + var newValue = Combine(priorValue, value); + fieldBeforeExchange = Interlocked.CompareExchange(ref this.value, newValue, priorValue); } + while (priorValue != fieldBeforeExchange); + } - /// - /// Returns an enumerator for a current snapshot of the collection. - /// - System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() + /// + /// Removes an element from the collection. + /// + public void Remove(T value) + { + object? priorValue; + object? fieldBeforeExchange; + do { - return this.GetEnumerator(); + priorValue = Volatile.Read(ref this.value); + var newValue = Remove(priorValue, value); + fieldBeforeExchange = Interlocked.CompareExchange(ref this.value, newValue, priorValue); } + while (priorValue != fieldBeforeExchange); + } - /// - /// Adds an element to the collection. - /// - public void Add(T value) + /// + /// Checks for reference equality between the specified value and an element of this collection. + /// + /// The value to check for. + /// if a match is found; otherwise. + /// + /// This method is intended to hide the Linq Contains extension method to avoid + /// the boxing of this struct and its Enumerator. + /// + public bool Contains(T value) + { + foreach (T? item in this) { - object? priorValue; - object? fieldBeforeExchange; - do + if (item == value) { - priorValue = Volatile.Read(ref this.value); - var newValue = Combine(priorValue, value); - fieldBeforeExchange = Interlocked.CompareExchange(ref this.value, newValue, priorValue); + return true; } - while (priorValue != fieldBeforeExchange); } - /// - /// Removes an element from the collection. - /// - public void Remove(T value) + return false; + } + + /// + /// Atomically clears the collection's contents and returns an enumerator over the prior contents. + /// + internal Enumerator EnumerateAndClear() + { + // Enumeration is atomically destructive. + object? enumeratedValue = Interlocked.Exchange(ref this.value, null); + return new Enumerator(enumeratedValue); + } + + /// + /// Combines the previous contents of the collection with one additional value. + /// + /// The collection's prior contents. + /// The value to add to the collection. + /// The new value to store as the collection. + private static object Combine(object? baseValue, T value) + { + Requires.NotNull(value, nameof(value)); + + if (baseValue is null) { - object? priorValue; - object? fieldBeforeExchange; - do - { - priorValue = Volatile.Read(ref this.value); - var newValue = Remove(priorValue, value); - fieldBeforeExchange = Interlocked.CompareExchange(ref this.value, newValue, priorValue); - } - while (priorValue != fieldBeforeExchange); + return value; } - /// - /// Checks for reference equality between the specified value and an element of this collection. - /// - /// The value to check for. - /// if a match is found; otherwise. - /// - /// This method is intended to hide the Linq Contains extension method to avoid - /// the boxing of this struct and its Enumerator. - /// - public bool Contains(T value) + if (baseValue is T singleValue) { - foreach (T? item in this) - { - if (item == value) - { - return true; - } - } + return new T[] { singleValue, value }; + } - return false; + var oldArray = (T[])baseValue; + var result = new T[oldArray.Length + 1]; + oldArray.CopyTo(result, 0); + result[result.Length - 1] = value; + return result; + } + + /// + /// Removes a value from contents of the collection. + /// + /// The collection's prior contents. + /// The value to remove from the collection. + /// The new value to store as the collection. + private static object? Remove(object? baseValue, T value) + { + if (baseValue == value || baseValue is null) + { + return null; } - /// - /// Atomically clears the collection's contents and returns an enumerator over the prior contents. - /// - internal Enumerator EnumerateAndClear() + if (baseValue is T) { - // Enumeration is atomically destructive. - object? enumeratedValue = Interlocked.Exchange(ref this.value, null); - return new Enumerator(enumeratedValue); + return baseValue; // the value to remove wasn't in the list anyway. } - /// - /// Combines the previous contents of the collection with one additional value. - /// - /// The collection's prior contents. - /// The value to add to the collection. - /// The new value to store as the collection. - private static object Combine(object? baseValue, T value) + var oldArray = (T[])baseValue; + int index = Array.IndexOf(oldArray, value); + if (index < 0) { - Requires.NotNull(value, nameof(value)); + return baseValue; + } + else if (oldArray.Length == 2) + { + return oldArray[index == 0 ? 1 : 0]; // return the one remaining value. + } + else + { + var result = new T[oldArray.Length - 1]; + Array.Copy(oldArray, result, index); + Array.Copy(oldArray, index + 1, result, index, result.Length - index); + return result; + } + } - if (baseValue is null) - { - return value; - } + public struct Enumerator : IEnumerator + { + private const int IndexBeforeFirstArrayElement = -1; + private const int IndexSingleElement = -2; + private const int IndexBeforeSingleElement = -3; - if (baseValue is T singleValue) - { - return new T[] { singleValue, value }; - } + private readonly object? enumeratedValue; - var oldArray = (T[])baseValue; - var result = new T[oldArray.Length + 1]; - oldArray.CopyTo(result, 0); - result[result.Length - 1] = value; - return result; - } + private int currentIndex; - /// - /// Removes a value from contents of the collection. - /// - /// The collection's prior contents. - /// The value to remove from the collection. - /// The new value to store as the collection. - private static object? Remove(object? baseValue, T value) + internal Enumerator(object? enumeratedValue) { - if (baseValue == value || baseValue is null) - { - return null; - } + this.enumeratedValue = enumeratedValue; + this.currentIndex = 0; + this.Reset(); + } - if (baseValue is T) + public T Current + { + get { - return baseValue; // the value to remove wasn't in the list anyway. - } + if (this.currentIndex == IndexBeforeFirstArrayElement || this.currentIndex == IndexBeforeSingleElement) + { + throw new InvalidOperationException(); + } - var oldArray = (T[])baseValue; - int index = Array.IndexOf(oldArray, value); - if (index < 0) - { - return baseValue; - } - else if (oldArray.Length == 2) - { - return oldArray[index == 0 ? 1 : 0]; // return the one remaining value. - } - else - { - var result = new T[oldArray.Length - 1]; - Array.Copy(oldArray, result, index); - Array.Copy(oldArray, index + 1, result, index, result.Length - index); - return result; + // enumeratedValue cannot be null here following a call to `MoveNext` that returns true (required + // for correct usage of IEnumerator). + return this.currentIndex == IndexSingleElement + ? (T)this.enumeratedValue! + : ((T[])this.enumeratedValue!)[this.currentIndex]; } } - public struct Enumerator : IEnumerator + object System.Collections.IEnumerator.Current { - private const int IndexBeforeFirstArrayElement = -1; - private const int IndexSingleElement = -2; - private const int IndexBeforeSingleElement = -3; - - private readonly object? enumeratedValue; + get { return this.Current; } + } - private int currentIndex; + public void Dispose() + { + } - internal Enumerator(object? enumeratedValue) + public bool MoveNext() + { + if (this.currentIndex == IndexBeforeSingleElement && this.enumeratedValue is object) { - this.enumeratedValue = enumeratedValue; - this.currentIndex = 0; - this.Reset(); + this.currentIndex = IndexSingleElement; + return true; } - public T Current + if (this.currentIndex == IndexSingleElement) { - get - { - if (this.currentIndex == IndexBeforeFirstArrayElement || this.currentIndex == IndexBeforeSingleElement) - { - throw new InvalidOperationException(); - } - - // enumeratedValue cannot be null here following a call to `MoveNext` that returns true (required - // for correct usage of IEnumerator). - return this.currentIndex == IndexSingleElement - ? (T)this.enumeratedValue! - : ((T[])this.enumeratedValue!)[this.currentIndex]; - } + return false; } - object System.Collections.IEnumerator.Current + if (this.currentIndex == IndexBeforeFirstArrayElement) { - get { return this.Current; } + this.currentIndex = 0; + return true; } - public void Dispose() + var array = (T[]?)this.enumeratedValue; + if (this.currentIndex >= 0 && this.currentIndex < array!.Length) { + this.currentIndex++; + return this.currentIndex < array.Length; } - public bool MoveNext() - { - if (this.currentIndex == IndexBeforeSingleElement && this.enumeratedValue is object) - { - this.currentIndex = IndexSingleElement; - return true; - } - - if (this.currentIndex == IndexSingleElement) - { - return false; - } - - if (this.currentIndex == IndexBeforeFirstArrayElement) - { - this.currentIndex = 0; - return true; - } - - var array = (T[]?)this.enumeratedValue; - if (this.currentIndex >= 0 && this.currentIndex < array!.Length) - { - this.currentIndex++; - return this.currentIndex < array.Length; - } - - return false; - } + return false; + } - public void Reset() - { - this.currentIndex = this.enumeratedValue is T[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; - } + public void Reset() + { + this.currentIndex = this.enumeratedValue is T[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; } } } diff --git a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs index d8065eeb0..5d1f1b58e 100644 --- a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs @@ -8,65 +8,64 @@ using global::Windows.Win32; using global::Windows.Win32.Foundation; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A SynchronizationContext whose synchronously blocking Wait method does not allow +/// any reentrancy via the message pump. +/// +public class NoMessagePumpSyncContext : SynchronizationContext { /// - /// A SynchronizationContext whose synchronously blocking Wait method does not allow - /// any reentrancy via the message pump. + /// A shared singleton. /// - public class NoMessagePumpSyncContext : SynchronizationContext - { - /// - /// A shared singleton. - /// - private static readonly SynchronizationContext DefaultInstance = new NoMessagePumpSyncContext(); + private static readonly SynchronizationContext DefaultInstance = new NoMessagePumpSyncContext(); - /// - /// Initializes a new instance of the class. - /// - public NoMessagePumpSyncContext() - { - // This is required so that our override of Wait is invoked. - this.SetWaitNotificationRequired(); - } + /// + /// Initializes a new instance of the class. + /// + public NoMessagePumpSyncContext() + { + // This is required so that our override of Wait is invoked. + this.SetWaitNotificationRequired(); + } - /// - /// Gets a shared instance of this class. - /// - public static SynchronizationContext Default - { - get { return DefaultInstance; } - } + /// + /// Gets a shared instance of this class. + /// + public static SynchronizationContext Default + { + get { return DefaultInstance; } + } - /// - /// Synchronously blocks without a message pump. - /// - /// An array of type that contains the native operating system handles. - /// true to wait for all handles; false to wait for any handle. - /// The number of milliseconds to wait, or (-1) to wait indefinitely. - /// - /// The array index of the object that satisfied the wait. - /// - public override int Wait(IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout) - { - Requires.NotNull(waitHandles, nameof(waitHandles)); + /// + /// Synchronously blocks without a message pump. + /// + /// An array of type that contains the native operating system handles. + /// true to wait for all handles; false to wait for any handle. + /// The number of milliseconds to wait, or (-1) to wait indefinitely. + /// + /// The array index of the object that satisfied the wait. + /// + public override int Wait(IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout) + { + Requires.NotNull(waitHandles, nameof(waitHandles)); - // On .NET Framework we must take special care to NOT end up in a call to CoWait (which lets in RPC calls). - // Off Windows, we can't p/invoke to kernel32, but it appears that .NET Core never calls CoWait, so we can rely on default behavior. - // We're just going to use the OS as the switch instead of the framework so that (one day) if we drop our .NET Framework specific target, - // and if .NET Core ever adds CoWait support on Windows, we'll still behave properly. + // On .NET Framework we must take special care to NOT end up in a call to CoWait (which lets in RPC calls). + // Off Windows, we can't p/invoke to kernel32, but it appears that .NET Core never calls CoWait, so we can rely on default behavior. + // We're just going to use the OS as the switch instead of the framework so that (one day) if we drop our .NET Framework specific target, + // and if .NET Core ever adds CoWait support on Windows, we'll still behave properly. #if NET5_0_OR_GREATER - if (OperatingSystem.IsWindowsVersionAtLeast(5, 1, 2600)) + if (OperatingSystem.IsWindowsVersionAtLeast(5, 1, 2600)) #else - if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) #endif - { - return (int)PInvoke.WaitForMultipleObjects(MemoryMarshal.Cast(waitHandles), waitAll, (uint)millisecondsTimeout); - } - else - { - return WaitHelper(waitHandles, waitAll, millisecondsTimeout); - } + { + return (int)PInvoke.WaitForMultipleObjects(MemoryMarshal.Cast(waitHandles), waitAll, (uint)millisecondsTimeout); + } + else + { + return WaitHelper(waitHandles, waitAll, millisecondsTimeout); } } } diff --git a/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs index 25f67b916..8e006891c 100644 --- a/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NonConcurrentSynchronizationContext.cs @@ -6,172 +6,171 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A that executes messages in the order they are received. +/// +/// +/// Delegates will be invoked in the order they are received on the threadpool. +/// No two delegates will ever be executed concurrently, but may permit +/// a delegate to execute inline on another. +/// Note that if the delegate invokes an async method, the delegate formally ends +/// when the async method yields for the first time or returns, whichever comes first. +/// Once that delegate returns the next delegate can be executed. +/// +public sealed class NonConcurrentSynchronizationContext : SynchronizationContext { /// - /// A that executes messages in the order they are received. + /// The queue of work to execute, if this is the original instance. + /// + private readonly AsyncQueue<(SendOrPostCallback, object?)>? queue; + + /// + /// A value indicating whether to set this instance as when invoking delegates. + /// + private readonly bool sticky; + + /// + /// The original instance (on which was called). + /// + private readonly NonConcurrentSynchronizationContext? copyOf; + + /// + /// Set to the when a delegate is currently executing. + /// + private int? activeManagedThreadId; + + /// + /// Initializes a new instance of the class. + /// + /// + /// A value indicating whether to set this instance as when invoking delegates. + /// This has the effect that async methods that are invoked on this + /// will execute their continuations on this as well unless they use with as the argument. + /// + public NonConcurrentSynchronizationContext(bool sticky) + { + this.queue = new AsyncQueue<(SendOrPostCallback, object?)>(); + this.sticky = sticky; + + // Start the queue processor. It will handle all exceptions. + this.ProcessQueueAsync().Forget(); + } + + /// + /// Initializes a new instance of the class + /// that is a copy of an existing instance. + /// + /// The instance to copy from. + private NonConcurrentSynchronizationContext(NonConcurrentSynchronizationContext copyFrom) + { + // We do *not* kick off processing of the queue, since the original copy has done that and we don't want two logical threads processing the queue. + this.sticky = copyFrom.sticky; + this.copyOf = copyFrom; + } + + /// + /// Occurs when posted work throws an unhandled exception. /// /// - /// Delegates will be invoked in the order they are received on the threadpool. - /// No two delegates will ever be executed concurrently, but may permit - /// a delegate to execute inline on another. - /// Note that if the delegate invokes an async method, the delegate formally ends - /// when the async method yields for the first time or returns, whichever comes first. - /// Once that delegate returns the next delegate can be executed. + /// Any exception thrown from this handler will crash the process. /// - public sealed class NonConcurrentSynchronizationContext : SynchronizationContext - { - /// - /// The queue of work to execute, if this is the original instance. - /// - private readonly AsyncQueue<(SendOrPostCallback, object?)>? queue; - - /// - /// A value indicating whether to set this instance as when invoking delegates. - /// - private readonly bool sticky; - - /// - /// The original instance (on which was called). - /// - private readonly NonConcurrentSynchronizationContext? copyOf; - - /// - /// Set to the when a delegate is currently executing. - /// - private int? activeManagedThreadId; - - /// - /// Initializes a new instance of the class. - /// - /// - /// A value indicating whether to set this instance as when invoking delegates. - /// This has the effect that async methods that are invoked on this - /// will execute their continuations on this as well unless they use with as the argument. - /// - public NonConcurrentSynchronizationContext(bool sticky) - { - this.queue = new AsyncQueue<(SendOrPostCallback, object?)>(); - this.sticky = sticky; + public event EventHandler? UnhandledException; - // Start the queue processor. It will handle all exceptions. - this.ProcessQueueAsync().Forget(); - } + /// + public override void Post(SendOrPostCallback d, object? state) + { + Requires.NotNull(d, nameof(d)); - /// - /// Initializes a new instance of the class - /// that is a copy of an existing instance. - /// - /// The instance to copy from. - private NonConcurrentSynchronizationContext(NonConcurrentSynchronizationContext copyFrom) + if (this.copyOf is object) { - // We do *not* kick off processing of the queue, since the original copy has done that and we don't want two logical threads processing the queue. - this.sticky = copyFrom.sticky; - this.copyOf = copyFrom; + this.copyOf.Post(d, state); + return; } - /// - /// Occurs when posted work throws an unhandled exception. - /// - /// - /// Any exception thrown from this handler will crash the process. - /// - public event EventHandler? UnhandledException; - - /// - public override void Post(SendOrPostCallback d, object? state) - { - Requires.NotNull(d, nameof(d)); + this.queue!.Enqueue((d, state)); + } - if (this.copyOf is object) - { - this.copyOf.Post(d, state); - return; - } + /// + public override void Send(SendOrPostCallback d, object? state) + { + Requires.NotNull(d, nameof(d)); - this.queue!.Enqueue((d, state)); + if (this.copyOf is object) + { + this.copyOf.Send(d, state); + return; } - /// - public override void Send(SendOrPostCallback d, object? state) + // Allow inlining if we're on the already-assigned thread. + if (this.activeManagedThreadId is int activeThread && Environment.CurrentManagedThreadId == activeThread) { - Requires.NotNull(d, nameof(d)); - - if (this.copyOf is object) + using (this.sticky ? this.Apply(checkForChangesOnRevert: false) : default) { - this.copyOf.Send(d, state); - return; + d(state); } - // Allow inlining if we're on the already-assigned thread. - if (this.activeManagedThreadId is int activeThread && Environment.CurrentManagedThreadId == activeThread) + return; + } + + var tcs = new TaskCompletionSource(); + this.Post( + s2 => { - using (this.sticky ? this.Apply(checkForChangesOnRevert: false) : default) + (SendOrPostCallback cb, object s, TaskCompletionSource m) = (Tuple>)s2!; + try { - d(state); + cb(s); + m.SetResult(null); } - - return; - } - - var tcs = new TaskCompletionSource(); - this.Post( - s2 => + catch (Exception ex) { - (SendOrPostCallback cb, object s, TaskCompletionSource m) = (Tuple>)s2!; - try - { - cb(s); - m.SetResult(null); - } - catch (Exception ex) - { - m.SetException(ex); - } - }, - Tuple.Create(d, state, tcs)); - tcs.Task.GetAwaiter().GetResult(); - } + m.SetException(ex); + } + }, + Tuple.Create(d, state, tcs)); + tcs.Task.GetAwaiter().GetResult(); + } - /// - public override SynchronizationContext CreateCopy() => new NonConcurrentSynchronizationContext(this); + /// + public override SynchronizationContext CreateCopy() => new NonConcurrentSynchronizationContext(this); - /// - /// Executes queued work on the threadpool, one at a time. - /// - /// A task that always completes successfully. - private async Task ProcessQueueAsync() + /// + /// Executes queued work on the threadpool, one at a time. + /// + /// A task that always completes successfully. + private async Task ProcessQueueAsync() + { + try { - try + while (true) { - while (true) + (SendOrPostCallback, object?) work = await this.queue!.DequeueAsync().ConfigureAwait(false); + this.activeManagedThreadId = Environment.CurrentManagedThreadId; + try { - (SendOrPostCallback, object?) work = await this.queue!.DequeueAsync().ConfigureAwait(false); - this.activeManagedThreadId = Environment.CurrentManagedThreadId; - try - { - using (this.sticky ? this.Apply(checkForChangesOnRevert: false) : default) - { - work.Item1(work.Item2); - } - } - catch (Exception ex) - { - this.UnhandledException?.Invoke(this, ex); - } - finally + using (this.sticky ? this.Apply(checkForChangesOnRevert: false) : default) { - this.activeManagedThreadId = null; + work.Item1(work.Item2); } } + catch (Exception ex) + { + this.UnhandledException?.Invoke(this, ex); + } + finally + { + this.activeManagedThreadId = null; + } } - catch (Exception ex) - { - // A failure to schedule work is fatal because it can lead to hangs that are - // very hard to diagnose to a failure in the scheduler, and even harder to identify - // the root cause of the failure in the scheduler. - Environment.FailFast("Failure in scheduler.", ex); - } + } + catch (Exception ex) + { + // A failure to schedule work is fatal because it can lead to hangs that are + // very hard to diagnose to a failure in the scheduler, and even harder to identify + // the root cause of the failure in the scheduler. + Environment.FailFast("Failure in scheduler.", ex); } } } diff --git a/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs b/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs index 49444128d..2be3d6dd8 100644 --- a/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs +++ b/src/Microsoft.VisualStudio.Threading/NullableHelpers.cs @@ -3,35 +3,34 @@ using System; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +internal static class NullableHelpers { - internal static class NullableHelpers + /// + /// Converts a delegate which assumes an argument that is never null into a delegate which might be given a null value, + /// without adding an explicit null check. + /// + /// The type of argument to be passed to the delegate. + /// The delegate which, according to the signature, does not expect . + /// The exact same referenced delegate, but with a signature that may expect . + internal static Action AsNullableArgAction(Action action) + where T : class { - /// - /// Converts a delegate which assumes an argument that is never null into a delegate which might be given a null value, - /// without adding an explicit null check. - /// - /// The type of argument to be passed to the delegate. - /// The delegate which, according to the signature, does not expect . - /// The exact same referenced delegate, but with a signature that may expect . - internal static Action AsNullableArgAction(Action action) - where T : class - { - return action!; - } + return action!; + } - /// - /// Converts a delegate which assumes an argument that is never null into a delegate which might be given a null value, - /// without adding an explicit null check. - /// - /// The type of argument to be passed to the delegate. - /// The type of value returned from the delegate. - /// The delegate which, according to the signature, does not expect . - /// The exact same referenced delegate, but with a signature that may expect . - internal static Func AsNullableArgFunc(Func func) - where TArg : class - { - return func!; - } + /// + /// Converts a delegate which assumes an argument that is never null into a delegate which might be given a null value, + /// without adding an explicit null check. + /// + /// The type of argument to be passed to the delegate. + /// The type of value returned from the delegate. + /// The delegate which, according to the signature, does not expect . + /// The exact same referenced delegate, but with a signature that may expect . + internal static Func AsNullableArgFunc(Func func) + where TArg : class + { + return func!; } } diff --git a/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs b/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs index 0e57ccb76..959fa1324 100644 --- a/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs +++ b/src/Microsoft.VisualStudio.Threading/ProgressWithCompletion`1.cs @@ -7,229 +7,228 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// An incremental progress reporting mechanism that also allows +/// asynchronous awaiting for all reports to be processed. +/// +/// The type of message sent in progress updates. +public class ProgressWithCompletion : IProgress { /// - /// An incremental progress reporting mechanism that also allows - /// asynchronous awaiting for all reports to be processed. + /// The synchronization object. + /// Applicable only when is null. /// - /// The type of message sent in progress updates. - public class ProgressWithCompletion : IProgress + private readonly object? syncObject; + + /// + /// The handler to invoke for each progress update. + /// + private readonly Func handler; + + /// + /// The set of progress reports that have started (but may not have finished yet). + /// Applicable only when is null. + /// + private readonly HashSet? outstandingTasks; + + /// + /// The factory to use for invoking the . + /// Applicable only when is null. + /// + private readonly TaskFactory? taskFactory; + + /// + /// A value indicating whether this instance was constructed on the main thread. + /// Applicable only when is not null. + /// + private readonly bool createdOnMainThread; + + /// + /// The to use when invoking the to mitigate deadlocks. + /// May be null. + /// + private readonly JoinableTaskFactory? joinableTaskFactory; + + /// + /// A collection of outstanding progress updates that have not completed execution. + /// Applicable only when is not null. + /// + private readonly JoinableTaskCollection? outstandingJoinableTasks; + + /// + /// Initializes a new instance of the class. + /// + /// + /// A handler to invoke for each reported progress value. + /// Depending on the instance that is captured when this constructor is invoked, + /// it is possible that this handler instance could be invoked concurrently with itself. + /// + public ProgressWithCompletion(Action handler) + : this(WrapSyncHandler(handler), joinableTaskFactory: null) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// A handler to invoke for each reported progress value. + /// Depending on the instance that is captured when this constructor is invoked, + /// it is possible that this handler instance could be invoked concurrently with itself. + /// + public ProgressWithCompletion(Func handler) + : this(handler, joinableTaskFactory: null) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// A handler to invoke for each reported progress value. + /// It is possible that this handler instance could be invoked concurrently with itself. + /// + /// A instance that can be used to mitigate deadlocks when is called and the requires the main thread. + public ProgressWithCompletion(Action handler, JoinableTaskFactory? joinableTaskFactory) + : this(WrapSyncHandler(handler), joinableTaskFactory) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + /// A handler to invoke for each reported progress value. + /// It is possible that this handler instance could be invoked concurrently with itself. + /// + /// A instance that can be used to mitigate deadlocks when is called and the requires the main thread. + public ProgressWithCompletion(Func handler, JoinableTaskFactory? joinableTaskFactory) { - /// - /// The synchronization object. - /// Applicable only when is null. - /// - private readonly object? syncObject; - - /// - /// The handler to invoke for each progress update. - /// - private readonly Func handler; - - /// - /// The set of progress reports that have started (but may not have finished yet). - /// Applicable only when is null. - /// - private readonly HashSet? outstandingTasks; - - /// - /// The factory to use for invoking the . - /// Applicable only when is null. - /// - private readonly TaskFactory? taskFactory; - - /// - /// A value indicating whether this instance was constructed on the main thread. - /// Applicable only when is not null. - /// - private readonly bool createdOnMainThread; - - /// - /// The to use when invoking the to mitigate deadlocks. - /// May be null. - /// - private readonly JoinableTaskFactory? joinableTaskFactory; - - /// - /// A collection of outstanding progress updates that have not completed execution. - /// Applicable only when is not null. - /// - private readonly JoinableTaskCollection? outstandingJoinableTasks; - - /// - /// Initializes a new instance of the class. - /// - /// - /// A handler to invoke for each reported progress value. - /// Depending on the instance that is captured when this constructor is invoked, - /// it is possible that this handler instance could be invoked concurrently with itself. - /// - public ProgressWithCompletion(Action handler) - : this(WrapSyncHandler(handler), joinableTaskFactory: null) + Requires.NotNull(handler, nameof(handler)); + this.handler = handler; + if (joinableTaskFactory is object) { + this.joinableTaskFactory = joinableTaskFactory; + this.outstandingJoinableTasks = joinableTaskFactory.Context.CreateCollection(); + this.createdOnMainThread = joinableTaskFactory.Context.IsOnMainThread; } - - /// - /// Initializes a new instance of the class. - /// - /// - /// A handler to invoke for each reported progress value. - /// Depending on the instance that is captured when this constructor is invoked, - /// it is possible that this handler instance could be invoked concurrently with itself. - /// - public ProgressWithCompletion(Func handler) - : this(handler, joinableTaskFactory: null) + else { + this.syncObject = new object(); + this.taskFactory = new TaskFactory(SynchronizationContext.Current is object ? TaskScheduler.FromCurrentSynchronizationContext() : TaskScheduler.Default); + this.outstandingTasks = new HashSet(); } + } + + /// + /// Receives a progress update. + /// + /// The value representing the updated progress. + void IProgress.Report(T value) + { + this.Report(value); + } + + /// + /// Returns a task that completes when all reported progress has executed. + /// + /// A task that completes when all progress is complete. + public Task WaitAsync() => this.WaitAsync(CancellationToken.None); - /// - /// Initializes a new instance of the class. - /// - /// - /// A handler to invoke for each reported progress value. - /// It is possible that this handler instance could be invoked concurrently with itself. - /// - /// A instance that can be used to mitigate deadlocks when is called and the requires the main thread. - public ProgressWithCompletion(Action handler, JoinableTaskFactory? joinableTaskFactory) - : this(WrapSyncHandler(handler), joinableTaskFactory) + /// + /// Returns a task that completes when all reported progress has executed. + /// + /// A cancellation token. + /// A task that completes when all progress is complete. + public Task WaitAsync(CancellationToken cancellationToken) + { + if (this.IsJoinableTaskAware(out _, out JoinableTaskCollection? outstandingJoinableTasks, out var syncObject, out HashSet? outstandingTasks, out _)) { + return outstandingJoinableTasks.JoinTillEmptyAsync(cancellationToken); } - - /// - /// Initializes a new instance of the class. - /// - /// - /// A handler to invoke for each reported progress value. - /// It is possible that this handler instance could be invoked concurrently with itself. - /// - /// A instance that can be used to mitigate deadlocks when is called and the requires the main thread. - public ProgressWithCompletion(Func handler, JoinableTaskFactory? joinableTaskFactory) + else { - Requires.NotNull(handler, nameof(handler)); - this.handler = handler; - if (joinableTaskFactory is object) + lock (syncObject) { - this.joinableTaskFactory = joinableTaskFactory; - this.outstandingJoinableTasks = joinableTaskFactory.Context.CreateCollection(); - this.createdOnMainThread = joinableTaskFactory.Context.IsOnMainThread; + return Task.WhenAll(outstandingTasks).WithCancellation(cancellationToken); } - else - { - this.syncObject = new object(); - this.taskFactory = new TaskFactory(SynchronizationContext.Current is object ? TaskScheduler.FromCurrentSynchronizationContext() : TaskScheduler.Default); - this.outstandingTasks = new HashSet(); - } - } - - /// - /// Receives a progress update. - /// - /// The value representing the updated progress. - void IProgress.Report(T value) - { - this.Report(value); } + } - /// - /// Returns a task that completes when all reported progress has executed. - /// - /// A task that completes when all progress is complete. - public Task WaitAsync() => this.WaitAsync(CancellationToken.None); - - /// - /// Returns a task that completes when all reported progress has executed. - /// - /// A cancellation token. - /// A task that completes when all progress is complete. - public Task WaitAsync(CancellationToken cancellationToken) + /// + /// Receives a progress update. + /// + /// The value representing the updated progress. + protected virtual void Report(T value) + { + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out JoinableTaskCollection? outstandingJoinableTasks, out var syncObject, out HashSet? outstandingTasks, out TaskFactory? taskFactory)) { - if (this.IsJoinableTaskAware(out _, out JoinableTaskCollection? outstandingJoinableTasks, out var syncObject, out HashSet? outstandingTasks, out _)) - { - return outstandingJoinableTasks.JoinTillEmptyAsync(cancellationToken); - } - else - { - lock (syncObject) + JoinableTask joinableTask = joinableTaskFactory.RunAsync( + async delegate { - return Task.WhenAll(outstandingTasks).WithCancellation(cancellationToken); - } - } - } + // Emulate the behavior of having captured a SynchronizationContext by invoking the handler on the main thread + // if the constructor was on the main thread. Otherwise use the threadpool thread. But never invoke the handler + // inline with our caller, per the behavior folks expect from this and .NET's Progress class. + if (this.createdOnMainThread) + { + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); + } + else + { + await TaskScheduler.Default.SwitchTo(alwaysYield: true); + } - /// - /// Receives a progress update. - /// - /// The value representing the updated progress. - protected virtual void Report(T value) + await this.handler(value).ConfigureAwaitRunInline(); + }); + outstandingJoinableTasks.Add(joinableTask); + } + else { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out JoinableTaskCollection? outstandingJoinableTasks, out var syncObject, out HashSet? outstandingTasks, out TaskFactory? taskFactory)) + Task? reported = taskFactory.StartNew(() => this.handler(value)).Unwrap(); + lock (syncObject) { - JoinableTask joinableTask = joinableTaskFactory.RunAsync( - async delegate - { - // Emulate the behavior of having captured a SynchronizationContext by invoking the handler on the main thread - // if the constructor was on the main thread. Otherwise use the threadpool thread. But never invoke the handler - // inline with our caller, per the behavior folks expect from this and .NET's Progress class. - if (this.createdOnMainThread) - { - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); - } - else - { - await TaskScheduler.Default.SwitchTo(alwaysYield: true); - } - - await this.handler(value).ConfigureAwaitRunInline(); - }); - outstandingJoinableTasks.Add(joinableTask); + outstandingTasks.Add(reported); } - else - { - Task? reported = taskFactory.StartNew(() => this.handler(value)).Unwrap(); - lock (syncObject) - { - outstandingTasks.Add(reported); - } - reported.ContinueWith( - t => + reported.ContinueWith( + t => + { + lock (syncObject) { - lock (syncObject) - { - outstandingTasks.Remove(t); - } - }, - CancellationToken.None, - TaskContinuationOptions.NotOnFaulted | TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } + outstandingTasks.Remove(t); + } + }, + CancellationToken.None, + TaskContinuationOptions.NotOnFaulted | TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); } + } - private static Func WrapSyncHandler(Action handler) + private static Func WrapSyncHandler(Action handler) + { + Requires.NotNull(handler, nameof(handler)); + return value => { - Requires.NotNull(handler, nameof(handler)); - return value => - { - handler(value); - return Task.CompletedTask; - }; - } + handler(value); + return Task.CompletedTask; + }; + } - private bool IsJoinableTaskAware( - [NotNullWhen(true)] out JoinableTaskFactory? joinableTaskFactory, - [NotNullWhen(true)] out JoinableTaskCollection? outstandingJoinableTasks, - [NotNullWhen(false)] out object? syncObject, - [NotNullWhen(false)] out HashSet? outstandingTasks, - [NotNullWhen(false)] out TaskFactory? taskFactory) - { - joinableTaskFactory = this.joinableTaskFactory; - outstandingJoinableTasks = this.outstandingJoinableTasks; + private bool IsJoinableTaskAware( + [NotNullWhen(true)] out JoinableTaskFactory? joinableTaskFactory, + [NotNullWhen(true)] out JoinableTaskCollection? outstandingJoinableTasks, + [NotNullWhen(false)] out object? syncObject, + [NotNullWhen(false)] out HashSet? outstandingTasks, + [NotNullWhen(false)] out TaskFactory? taskFactory) + { + joinableTaskFactory = this.joinableTaskFactory; + outstandingJoinableTasks = this.outstandingJoinableTasks; - syncObject = this.syncObject; - outstandingTasks = this.outstandingTasks; - taskFactory = this.taskFactory; - return joinableTaskFactory is object; - } + syncObject = this.syncObject; + outstandingTasks = this.outstandingTasks; + taskFactory = this.taskFactory; + return joinableTaskFactory is object; } } diff --git a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs index 36da42afb..d1391f960 100644 --- a/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs +++ b/src/Microsoft.VisualStudio.Threading/RarelyRemoveItemSet`1.cs @@ -4,242 +4,241 @@ using System; using System.Collections.Generic; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A collection optimized for usually small number of elements, and items are rarely removed. +/// Note: this implementation is not thread-safe. It must be protected to prevent race conditions. +/// +/// The type of elements to be stored. +internal struct RarelyRemoveItemSet + where T : class? { + private const int MaxExpansionSize = 16 * 1024; + /// - /// A collection optimized for usually small number of elements, and items are rarely removed. - /// Note: this implementation is not thread-safe. It must be protected to prevent race conditions. + /// The single value or array of values stored by this collection. /// - /// The type of elements to be stored. - internal struct RarelyRemoveItemSet - where T : class? - { - private const int MaxExpansionSize = 16 * 1024; - - /// - /// The single value or array of values stored by this collection. - /// - private object? value; + private object? value; - /// - /// The number of items. - /// - private int count; + /// + /// The number of items. + /// + private int count; - /// - /// Adds an element to the collection. - /// - internal void Add(T value) + /// + /// Adds an element to the collection. + /// + internal void Add(T value) + { + if (this.value is T?[] valueArray) { - if (this.value is T?[] valueArray) + if (valueArray.Length > this.count) { - if (valueArray.Length > this.count) - { - valueArray[this.count] = value; - } - else - { - int nextSize = valueArray.Length > MaxExpansionSize ? (valueArray.Length + MaxExpansionSize) : valueArray.Length * 2; - - Array.Resize(ref valueArray, nextSize); - valueArray[this.count] = value; - this.value = valueArray; - } + valueArray[this.count] = value; } else { - if (this.count == 0) - { - this.value = value; - } - else - { - Assumes.True(this.count == 1); - valueArray = new T?[2] { (T?)this.value, value }; - this.value = valueArray; - } - } + int nextSize = valueArray.Length > MaxExpansionSize ? (valueArray.Length + MaxExpansionSize) : valueArray.Length * 2; - this.count++; + Array.Resize(ref valueArray, nextSize); + valueArray[this.count] = value; + this.value = valueArray; + } } - - /// - /// Removes an element from the collection. - /// - internal void Remove(T value) + else { if (this.count == 0) { - return; + this.value = value; + } + else + { + Assumes.True(this.count == 1); + valueArray = new T?[2] { (T?)this.value, value }; + this.value = valueArray; } + } - if (this.value is T?[] valueArray) + this.count++; + } + + /// + /// Removes an element from the collection. + /// + internal void Remove(T value) + { + if (this.count == 0) + { + return; + } + + if (this.value is T?[] valueArray) + { + for (int i = 0; i < this.count; i++) { - for (int i = 0; i < this.count; i++) + if (valueArray[i] == value) { - if (valueArray[i] == value) - { - // found matched item - --this.count; - - if (i < this.count) - { - // if the item removed was not the latest item in the array, we move the latest item in the original array there to fill the hole. - // After that, we reduce the size of the array by 1. (This eliminates extra work to move more than one item during Remove.) - valueArray[i] = valueArray[this.count]; - } + // found matched item + --this.count; - // prevent holding reference - valueArray[this.count] = null; - break; + if (i < this.count) + { + // if the item removed was not the latest item in the array, we move the latest item in the original array there to fill the hole. + // After that, we reduce the size of the array by 1. (This eliminates extra work to move more than one item during Remove.) + valueArray[i] = valueArray[this.count]; } + + // prevent holding reference + valueArray[this.count] = null; + break; } } - else if (this.value == value) - { - this.value = null; - this.count = 0; - } } - - /// - /// Gets the result out of the current list, and reset it to empty. - /// - internal Enumerable EnumerateAndClear() + else if (this.value == value) { - var copy = new Enumerable(this.value, this.count); - this.value = null; this.count = 0; - - return copy; } + } - /// - /// Make a thread safe copy of the content of this list. - /// - internal T[] ToArray() - { - if (this.count == 0) - { - return Array.Empty(); - } + /// + /// Gets the result out of the current list, and reset it to empty. + /// + internal Enumerable EnumerateAndClear() + { + var copy = new Enumerable(this.value, this.count); - var results = new T[this.count]; - if (this.value is T?[] valueArray) - { - Array.Copy(valueArray, results, this.count); - } - else - { - results[0] = (T)this.value!; - } + this.value = null; + this.count = 0; - return results; + return copy; + } + + /// + /// Make a thread safe copy of the content of this list. + /// + internal T[] ToArray() + { + if (this.count == 0) + { + return Array.Empty(); } - internal struct Enumerator : IEnumerator + var results = new T[this.count]; + if (this.value is T?[] valueArray) + { + Array.Copy(valueArray, results, this.count); + } + else { - private const int IndexBeforeFirstArrayElement = -1; - private const int IndexSingleElement = -2; - private const int IndexBeforeSingleElement = -3; + results[0] = (T)this.value!; + } - private readonly object? enumeratedValue; - private readonly int count; + return results; + } - private int currentIndex; + internal struct Enumerator : IEnumerator + { + private const int IndexBeforeFirstArrayElement = -1; + private const int IndexSingleElement = -2; + private const int IndexBeforeSingleElement = -3; - internal Enumerator(object? enumeratedValue, int count) - { - this.enumeratedValue = enumeratedValue; - this.count = count; - this.currentIndex = 0; - this.Reset(); - } + private readonly object? enumeratedValue; + private readonly int count; - public T Current + private int currentIndex; + + internal Enumerator(object? enumeratedValue, int count) + { + this.enumeratedValue = enumeratedValue; + this.count = count; + this.currentIndex = 0; + this.Reset(); + } + + public T Current + { + get { - get + if (this.currentIndex >= 0 && this.currentIndex < this.count) { - if (this.currentIndex >= 0 && this.currentIndex < this.count) - { - return ((T[])this.enumeratedValue!)[this.currentIndex]; - } - else if (this.currentIndex == IndexSingleElement) - { - return (T)this.enumeratedValue!; - } - - throw new InvalidOperationException(); + return ((T[])this.enumeratedValue!)[this.currentIndex]; + } + else if (this.currentIndex == IndexSingleElement) + { + return (T)this.enumeratedValue!; } + + throw new InvalidOperationException(); } + } - object? System.Collections.IEnumerator.Current => this.Current; + object? System.Collections.IEnumerator.Current => this.Current; - public void Dispose() - { - } + public void Dispose() + { + } - public bool MoveNext() + public bool MoveNext() + { + if (this.currentIndex >= 0) { - if (this.currentIndex >= 0) + if (this.currentIndex < this.count) { - if (this.currentIndex < this.count) - { - this.currentIndex++; - return this.currentIndex < this.count; - } + this.currentIndex++; + return this.currentIndex < this.count; } - else + } + else + { + switch (this.currentIndex) { - switch (this.currentIndex) - { - case IndexBeforeSingleElement: - if (this.count > 0) - { - this.currentIndex = IndexSingleElement; - return true; - } + case IndexBeforeSingleElement: + if (this.count > 0) + { + this.currentIndex = IndexSingleElement; + return true; + } - break; + break; - case IndexBeforeFirstArrayElement: - this.currentIndex = 0; - return true; - } + case IndexBeforeFirstArrayElement: + this.currentIndex = 0; + return true; } - - return false; } - public void Reset() - { - this.currentIndex = this.enumeratedValue is T?[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; - } + return false; } - internal readonly struct Enumerable + public void Reset() { - private readonly object? value; + this.currentIndex = this.enumeratedValue is T?[] ? IndexBeforeFirstArrayElement : IndexBeforeSingleElement; + } + } - /// - /// The number of items. - /// - private readonly int count; + internal readonly struct Enumerable + { + private readonly object? value; - internal Enumerable(object? value, int count) - { - this.value = value; - this.count = count; - } + /// + /// The number of items. + /// + private readonly int count; - /// - /// Returns an enumerator for a current snapshot of the collection. - /// - public Enumerator GetEnumerator() - { - return new Enumerator(this.value, this.count); - } + internal Enumerable(object? value, int count) + { + this.value = value; + this.count = count; + } + + /// + /// Returns an enumerator for a current snapshot of the collection. + /// + public Enumerator GetEnumerator() + { + return new Enumerator(this.value, this.count); } } } diff --git a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs index 949faeb43..3e7c581a5 100644 --- a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs @@ -10,394 +10,690 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A -aware semaphore that allows reentrancy without consuming another slot in the semaphore. +/// +[DebuggerDisplay(nameof(CurrentCount) + " = {" + nameof(CurrentCount) + "}")] +public abstract class ReentrantSemaphore : IDisposable { /// - /// A -aware semaphore that allows reentrancy without consuming another slot in the semaphore. + /// The factory to wrap all pending and active semaphore requests with to mitigate deadlocks. + /// + private readonly JoinableTaskFactory? joinableTaskFactory; + + /// + /// The collection of all semaphore holders (and possibly waiters), which waiters should join to mitigate deadlocks. + /// + private readonly JoinableTaskCollection? joinableTaskCollection; + + /// + /// The underlying semaphore primitive. + /// + private readonly AsyncSemaphore semaphore; + + /// + /// Initializes a new instance of the class. /// - [DebuggerDisplay(nameof(CurrentCount) + " = {" + nameof(CurrentCount) + "}")] - public abstract class ReentrantSemaphore : IDisposable + /// The initial number of concurrent operations to allow. + /// The to use to mitigate deadlocks. + /// + /// This is private protected so that others cannot derive from this type but we can within the assembly. + /// + private protected ReentrantSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) + { + if (joinableTaskContext is object) + { + this.joinableTaskCollection = joinableTaskContext.CreateCollection(); + this.joinableTaskFactory = joinableTaskContext.CreateFactory(this.joinableTaskCollection); + } + + this.semaphore = new AsyncSemaphore(initialCount); + } + + /// + /// Describes ways the may behave when a semaphore request is made in a context that is already in the semaphore. + /// + public enum ReentrancyMode { /// - /// The factory to wrap all pending and active semaphore requests with to mitigate deadlocks. + /// Reject all requests when the caller has already entered the semaphore + /// (and not yet exited) by throwing an . /// - private readonly JoinableTaskFactory? joinableTaskFactory; + /// + /// When reentrancy is not expected this is the recommended mode as it will prevent deadlocks + /// when unexpected reentrancy is detected. + /// + NotAllowed, /// - /// The collection of all semaphore holders (and possibly waiters), which waiters should join to mitigate deadlocks. + /// Each request occupies a unique slot in the semaphore. + /// Reentrancy is not recognized and may lead to deadlocks if the reentrancy level exceeds the count on the semaphore. + /// This resembles the behavior of the class. /// - private readonly JoinableTaskCollection? joinableTaskCollection; + /// + /// If reentrancy is not in the design, but leads to exceptions due to + /// ExecutionContext flowing unexpectedly, this mode may be the best option. + /// + NotRecognized, /// - /// The underlying semaphore primitive. + /// A request made by a caller that is already in the semaphore is immediately executed, + /// and shares the same semaphore slot with its parent. + /// This nested request must exit before its parent (Strict LIFO/stack behavior). + /// Exiting the semaphore before a child has or after the parent has will cause an + /// to fault the returned + /// from . /// - private readonly AsyncSemaphore semaphore; + /// + /// When reentrancy is a requirement, this mode helps ensure that reentrancy only happens + /// where code enters a semaphore, then awaits on other code that itself may enter the semaphore. + /// When a violation occurs, this semaphore transitions into a faulted state, after which any call + /// will throw an . + /// + Stack, /// - /// Initializes a new instance of the class. + /// A request made by a caller that is already in the semaphore is immediately executed, + /// and shares the same semaphore slot with its parent. + /// The slot is only released when all requests have exited, which may be in any order. /// - /// The initial number of concurrent operations to allow. - /// The to use to mitigate deadlocks. - /// - /// This is private protected so that others cannot derive from this type but we can within the assembly. - /// - private protected ReentrantSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) - { - if (joinableTaskContext is object) - { - this.joinableTaskCollection = joinableTaskContext.CreateCollection(); - this.joinableTaskFactory = joinableTaskContext.CreateFactory(this.joinableTaskCollection); - } + /// + /// This is the most permissive, but has the highest risk that leaked semaphore access will remain undetected. + /// Leaked semaphore access is a condition where code is inappropriately considered parented to another semaphore holder, + /// leading to it being allowed to run code within the semaphore, potentially in parallel with the actual semaphore holder. + /// + Freeform, + } - this.semaphore = new AsyncSemaphore(initialCount); + /// + /// Gets the number of openings that remain in the semaphore. + /// + public int CurrentCount + { + get + { + this.ThrowIfFaulted(); + return this.semaphore.CurrentCount; } + } - /// - /// Describes ways the may behave when a semaphore request is made in a context that is already in the semaphore. - /// - public enum ReentrancyMode + /// + /// Initializes a new instance of the class. + /// + /// The initial number of concurrent operations to allow. + /// The to use to mitigate deadlocks. + /// How to respond to a semaphore request by a caller that has already entered the semaphore. + public static ReentrantSemaphore Create(int initialCount = 1, JoinableTaskContext? joinableTaskContext = null, ReentrancyMode mode = ReentrancyMode.NotAllowed) + { + switch (mode) { - /// - /// Reject all requests when the caller has already entered the semaphore - /// (and not yet exited) by throwing an . - /// - /// - /// When reentrancy is not expected this is the recommended mode as it will prevent deadlocks - /// when unexpected reentrancy is detected. - /// - NotAllowed, - - /// - /// Each request occupies a unique slot in the semaphore. - /// Reentrancy is not recognized and may lead to deadlocks if the reentrancy level exceeds the count on the semaphore. - /// This resembles the behavior of the class. - /// - /// - /// If reentrancy is not in the design, but leads to exceptions due to - /// ExecutionContext flowing unexpectedly, this mode may be the best option. - /// - NotRecognized, - - /// - /// A request made by a caller that is already in the semaphore is immediately executed, - /// and shares the same semaphore slot with its parent. - /// This nested request must exit before its parent (Strict LIFO/stack behavior). - /// Exiting the semaphore before a child has or after the parent has will cause an - /// to fault the returned - /// from . - /// - /// - /// When reentrancy is a requirement, this mode helps ensure that reentrancy only happens - /// where code enters a semaphore, then awaits on other code that itself may enter the semaphore. - /// When a violation occurs, this semaphore transitions into a faulted state, after which any call - /// will throw an . - /// - Stack, - - /// - /// A request made by a caller that is already in the semaphore is immediately executed, - /// and shares the same semaphore slot with its parent. - /// The slot is only released when all requests have exited, which may be in any order. - /// - /// - /// This is the most permissive, but has the highest risk that leaked semaphore access will remain undetected. - /// Leaked semaphore access is a condition where code is inappropriately considered parented to another semaphore holder, - /// leading to it being allowed to run code within the semaphore, potentially in parallel with the actual semaphore holder. - /// - Freeform, + case ReentrancyMode.NotRecognized: + return new NotRecognizedSemaphore(initialCount, joinableTaskContext); + case ReentrancyMode.NotAllowed: + return new NotAllowedSemaphore(initialCount, joinableTaskContext); + case ReentrancyMode.Stack: + return new StackSemaphore(initialCount, joinableTaskContext); + case ReentrancyMode.Freeform: + return new FreeformSemaphore(initialCount, joinableTaskContext); + default: + throw new ArgumentOutOfRangeException(nameof(mode)); } + } - /// - /// Gets the number of openings that remain in the semaphore. - /// - public int CurrentCount + /// + /// Executes a given operation within the semaphore. + /// + /// + /// The delegate to invoke once the semaphore is entered. If a was supplied to the constructor, + /// this delegate will execute on the main thread if this is invoked on the main thread, otherwise it will be invoked on the + /// threadpool. When no is supplied to the constructor, this delegate will execute on the + /// caller's context. + /// + /// A cancellation token. + /// A task that completes with the result of , after the semaphore has been exited. + public abstract Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default); + + /// + /// Executes a given operation within the semaphore. + /// + /// The type of value returned by the operation. + /// + /// The delegate to invoke once the semaphore is entered. If a was supplied to the constructor, + /// this delegate will execute on the main thread if this is invoked on the main thread, otherwise it will be invoked on the + /// threadpool. When no is supplied to the constructor, this delegate will execute on the + /// caller's context. + /// + /// A cancellation token. + /// A task that completes with the result of , after the semaphore has been exited. + public abstract ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default); + + /// + /// Conceals evidence that the caller has entered this till its result is disposed. + /// + /// A value to dispose to restore visibility of any presence in this semaphore. + /// + /// This method is useful when the caller is about to spin off another operation (e.g. scheduling work to the threadpool) + /// that it does not consider vital to its own completion, in order to prevent the spun off work from abusing the + /// caller's right to the semaphore. + /// This is a safe call to make whether or not the semaphore is currently held, or whether reentrancy is allowed on this instance. + /// + public virtual RevertRelevance SuppressRelevance() => default; + + /// + /// Faults all pending semaphore waiters with + /// and rejects all subsequent attempts to enter the semaphore with the same exception. + /// + public void Dispose() + { + this.Dispose(true); + GC.SuppressFinalize(this); + } + + /// + /// Disposes managed and unmanaged resources held by this instance. + /// + /// if was called; if the object is being finalized. + protected virtual void Dispose(bool disposing) + { + if (disposing) { - get - { - this.ThrowIfFaulted(); - return this.semaphore.CurrentCount; - } + this.semaphore.Dispose(); } + } - /// - /// Initializes a new instance of the class. - /// - /// The initial number of concurrent operations to allow. - /// The to use to mitigate deadlocks. - /// How to respond to a semaphore request by a caller that has already entered the semaphore. - public static ReentrantSemaphore Create(int initialCount = 1, JoinableTaskContext? joinableTaskContext = null, ReentrancyMode mode = ReentrancyMode.NotAllowed) + /// + /// Throws an exception if this instance has been faulted. + /// + protected virtual void ThrowIfFaulted() + { + } + + /// + /// Disposes the specfied release, swallowing certain exceptions. + /// + /// The releaser to dispose. + private static void DisposeReleaserNoThrow(AsyncSemaphore.Releaser releaser) + { + try { - switch (mode) - { - case ReentrancyMode.NotRecognized: - return new NotRecognizedSemaphore(initialCount, joinableTaskContext); - case ReentrancyMode.NotAllowed: - return new NotAllowedSemaphore(initialCount, joinableTaskContext); - case ReentrancyMode.Stack: - return new StackSemaphore(initialCount, joinableTaskContext); - case ReentrancyMode.Freeform: - return new FreeformSemaphore(initialCount, joinableTaskContext); - default: - throw new ArgumentOutOfRangeException(nameof(mode)); - } + releaser.Dispose(); } + catch (ObjectDisposedException) + { + // Swallow this, since in releasing the semaphore if it's already disposed the caller probably doesn't care. + } + } + + /// + /// Gets a value indicating whether this instance is using Joinable Task aware or not. + /// + private bool IsJoinableTaskAware([NotNullWhen(true)] out JoinableTaskFactory? joinableTaskFactory, [NotNullWhen(true)] out JoinableTaskCollection? joinableTaskCollection) + { + joinableTaskFactory = this.joinableTaskFactory; + joinableTaskCollection = this.joinableTaskCollection; + return this.joinableTaskCollection is object; + } + + /// + /// Executes the semaphore request. + /// + /// The delegate that requests the semaphore and executes code within it. + /// A value for the caller to await on. + private AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable ExecuteCoreAsync(Func semaphoreUser) + { + Requires.NotNull(semaphoreUser, nameof(semaphoreUser)); + + return this.joinableTaskFactory is object + ? this.joinableTaskFactory.RunAsync(semaphoreUser).Task.ConfigureAwaitRunInline() + : semaphoreUser().ConfigureAwaitRunInline(); + } + + /// + /// Executes the semaphore request. + /// + /// The delegate that requests the semaphore and executes code within it. + /// A value for the caller to await on. + private AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable ExecuteCoreAsync(Func> semaphoreUser) + { + Requires.NotNull(semaphoreUser, nameof(semaphoreUser)); + return this.joinableTaskFactory is object + ? this.joinableTaskFactory.RunAsync(semaphoreUser).Task.ConfigureAwaitRunInline() + : semaphoreUser().ConfigureAwaitRunInline(); + } + + /// + /// A structure that hides any evidence that the caller has entered a till this value is disposed. + /// + public readonly struct RevertRelevance : IDisposable + { /// - /// Executes a given operation within the semaphore. + /// The delegate to invoke on disposal. /// - /// - /// The delegate to invoke once the semaphore is entered. If a was supplied to the constructor, - /// this delegate will execute on the main thread if this is invoked on the main thread, otherwise it will be invoked on the - /// threadpool. When no is supplied to the constructor, this delegate will execute on the - /// caller's context. - /// - /// A cancellation token. - /// A task that completes with the result of , after the semaphore has been exited. - public abstract Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default); + private readonly Action disposeAction; /// - /// Executes a given operation within the semaphore. + /// The instance that is suppressing relevance. /// - /// The type of value returned by the operation. - /// - /// The delegate to invoke once the semaphore is entered. If a was supplied to the constructor, - /// this delegate will execute on the main thread if this is invoked on the main thread, otherwise it will be invoked on the - /// threadpool. When no is supplied to the constructor, this delegate will execute on the - /// caller's context. - /// - /// A cancellation token. - /// A task that completes with the result of , after the semaphore has been exited. - public abstract ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default); + private readonly ReentrantSemaphore semaphore; /// - /// Conceals evidence that the caller has entered this till its result is disposed. + /// The argument to pass to the delegate. /// - /// A value to dispose to restore visibility of any presence in this semaphore. - /// - /// This method is useful when the caller is about to spin off another operation (e.g. scheduling work to the threadpool) - /// that it does not consider vital to its own completion, in order to prevent the spun off work from abusing the - /// caller's right to the semaphore. - /// This is a safe call to make whether or not the semaphore is currently held, or whether reentrancy is allowed on this instance. - /// - public virtual RevertRelevance SuppressRelevance() => default; + private readonly object? state; /// - /// Faults all pending semaphore waiters with - /// and rejects all subsequent attempts to enter the semaphore with the same exception. + /// Initializes a new instance of the struct. /// - public void Dispose() + /// The delegate to invoke on disposal. + /// The instance that is suppressing relevance. + /// The argument to pass to the delegate. + internal RevertRelevance(Action disposeAction, ReentrantSemaphore semaphore, object? state) { - this.Dispose(true); - GC.SuppressFinalize(this); + this.disposeAction = disposeAction; + this.semaphore = semaphore; + this.state = state; } + /// + public void Dispose() => this.disposeAction?.Invoke(this.semaphore, this.state); + } + + /// + /// An implementation of supporting the mode. + /// + private class NotRecognizedSemaphore : ReentrantSemaphore + { /// - /// Disposes managed and unmanaged resources held by this instance. + /// Initializes a new instance of the class. /// - /// if was called; if the object is being finalized. - protected virtual void Dispose(bool disposing) + /// The initial number of concurrent operations to allow. + /// The to use to mitigate deadlocks. + internal NotRecognizedSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) + : base(initialCount, joinableTaskContext) { - if (disposing) - { - this.semaphore.Dispose(); - } } - /// - /// Throws an exception if this instance has been faulted. - /// - protected virtual void ThrowIfFaulted() + /// + public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) { + Requires.NotNull(operation, nameof(operation)); + + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + try + { + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + using (this.joinableTaskCollection?.Join()) + { + if (this.IsJoinableTaskAware(out _, out _)) + { + // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will + // deadlock due to not being inside a JTF.RunAsync(). + Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); + mustYield = !releaserTask.IsCompleted; + releaser = await releaserTask.ConfigureAwaitRunInline(); + } + else + { + releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); + } + } + + await this.ExecuteCoreAsync(async delegate + { + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + { + if (resumeOnMainThread) + { + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(cancellationToken); + } + else + { + await TaskScheduler.Default; + } + + if (mustYield) + { + // Yield to prevent running on the stack that released the semaphore. + await Task.Yield(); + } + } + + await operation().ConfigureAwaitRunInline(); + }); + } + finally + { + DisposeReleaserNoThrow(releaser); + } } - /// - /// Disposes the specfied release, swallowing certain exceptions. - /// - /// The releaser to dispose. - private static void DisposeReleaserNoThrow(AsyncSemaphore.Releaser releaser) + /// + public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) { + Requires.NotNull(operation, nameof(operation)); + + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; try { - releaser.Dispose(); + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + using (this.joinableTaskCollection?.Join()) + { + if (this.IsJoinableTaskAware(out _, out _)) + { + // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will + // deadlock due to not being inside a JTF.RunAsync(). + Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); + + // Yield to prevent running on the stack that released the semaphore. + mustYield = !releaserTask.IsCompleted; + + releaser = await releaserTask.ConfigureAwaitRunInline(); + } + else + { + releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); + } + } + + return await this.ExecuteCoreAsync(async delegate + { + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + { + if (resumeOnMainThread) + { + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); + } + else + { + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); + } + } + + return await operation().ConfigureAwait(true); + }); } - catch (ObjectDisposedException) + finally { - // Swallow this, since in releasing the semaphore if it's already disposed the caller probably doesn't care. + DisposeReleaserNoThrow(releaser); } } + } + /// + /// An implementation of supporting the mode. + /// + private class NotAllowedSemaphore : ReentrantSemaphore + { /// - /// Gets a value indicating whether this instance is using Joinable Task aware or not. + /// The means to recognize that a caller has already entered the semaphore. /// - private bool IsJoinableTaskAware([NotNullWhen(true)] out JoinableTaskFactory? joinableTaskFactory, [NotNullWhen(true)] out JoinableTaskCollection? joinableTaskCollection) - { - joinableTaskFactory = this.joinableTaskFactory; - joinableTaskCollection = this.joinableTaskCollection; - return this.joinableTaskCollection is object; - } + /// + /// We use instead of just here for two reasons: + /// 1. Our own class requires a ref type for the generic type argument. + /// 2. (more importantly) we need all forks of an ExecutionContext to observe updates to the value. + /// But ExecutionContext is copy-on-write so forks don't see changes to it. + /// lets us store and later update the boxed value of the existing box reference. + /// + private readonly AsyncLocal> reentrancyDetection = new AsyncLocal>(); /// - /// Executes the semaphore request. + /// Initializes a new instance of the class. /// - /// The delegate that requests the semaphore and executes code within it. - /// A value for the caller to await on. - private AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable ExecuteCoreAsync(Func semaphoreUser) + /// The initial number of concurrent operations to allow. + /// The to use to mitigate deadlocks. + internal NotAllowedSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) + : base(initialCount, joinableTaskContext) { - Requires.NotNull(semaphoreUser, nameof(semaphoreUser)); - - return this.joinableTaskFactory is object - ? this.joinableTaskFactory.RunAsync(semaphoreUser).Task.ConfigureAwaitRunInline() - : semaphoreUser().ConfigureAwaitRunInline(); } - /// - /// Executes the semaphore request. - /// - /// The delegate that requests the semaphore and executes code within it. - /// A value for the caller to await on. - private AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable ExecuteCoreAsync(Func> semaphoreUser) + /// + public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) { - Requires.NotNull(semaphoreUser, nameof(semaphoreUser)); + Requires.NotNull(operation, nameof(operation)); + this.ThrowIfFaulted(); - return this.joinableTaskFactory is object - ? this.joinableTaskFactory.RunAsync(semaphoreUser).Task.ConfigureAwaitRunInline() - : semaphoreUser().ConfigureAwaitRunInline(); - } + StrongBox? ownedBox = this.reentrancyDetection.Value; + if (ownedBox?.Value ?? false) + { + throw Verify.FailOperation(Strings.SemaphoreAlreadyHeld, ReentrancyMode.NotAllowed); + } - /// - /// A structure that hides any evidence that the caller has entered a till this value is disposed. - /// - public readonly struct RevertRelevance : IDisposable - { - /// - /// The delegate to invoke on disposal. - /// - private readonly Action disposeAction; - - /// - /// The instance that is suppressing relevance. - /// - private readonly ReentrantSemaphore semaphore; - - /// - /// The argument to pass to the delegate. - /// - private readonly object? state; - - /// - /// Initializes a new instance of the struct. - /// - /// The delegate to invoke on disposal. - /// The instance that is suppressing relevance. - /// The argument to pass to the delegate. - internal RevertRelevance(Action disposeAction, ReentrantSemaphore semaphore, object? state) + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + try { - this.disposeAction = disposeAction; - this.semaphore = semaphore; - this.state = state; + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + using (this.joinableTaskCollection?.Join()) + { + if (this.IsJoinableTaskAware(out _, out _)) + { + // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will + // deadlock due to not being inside a JTF.RunAsync(). + Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); + + // Yield to prevent running on the stack that released the semaphore. + mustYield = !releaserTask.IsCompleted; + + releaser = await releaserTask.ConfigureAwaitRunInline(); + } + else + { + releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); + } + } + + await this.ExecuteCoreAsync(async delegate + { + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + { + if (resumeOnMainThread) + { + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); + } + else + { + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); + } + } + + this.reentrancyDetection.Value = ownedBox = new StrongBox(true); + await operation().ConfigureAwaitRunInline(); + }); } + finally + { + // Make it clear to any forks of our ExecutionContexxt that the semaphore is no longer owned. + // Null check incase the switch to UI thread was cancelled. + if (ownedBox is object) + { + ownedBox.Value = false; + } - /// - public void Dispose() => this.disposeAction?.Invoke(this.semaphore, this.state); + DisposeReleaserNoThrow(releaser); + } } - /// - /// An implementation of supporting the mode. - /// - private class NotRecognizedSemaphore : ReentrantSemaphore + /// + public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) { - /// - /// Initializes a new instance of the class. - /// - /// The initial number of concurrent operations to allow. - /// The to use to mitigate deadlocks. - internal NotRecognizedSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) - : base(initialCount, joinableTaskContext) + Requires.NotNull(operation, nameof(operation)); + this.ThrowIfFaulted(); + + StrongBox? ownedBox = this.reentrancyDetection.Value; + if (ownedBox?.Value ?? false) { + throw Verify.FailOperation(Strings.SemaphoreAlreadyHeld, ReentrancyMode.NotAllowed); } - /// - public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + try { - Requires.NotNull(operation, nameof(operation)); - - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - try + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + using (this.joinableTaskCollection?.Join()) { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; - using (this.joinableTaskCollection?.Join()) + if (this.IsJoinableTaskAware(out _, out _)) { - if (this.IsJoinableTaskAware(out _, out _)) + // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will + // deadlock due to not being inside a JTF.RunAsync(). + Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); + + // Yield to prevent running on the stack that released the semaphore. + mustYield = !releaserTask.IsCompleted; + releaser = await releaserTask.ConfigureAwaitRunInline(); + } + else + { + releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); + } + } + + return await this.ExecuteCoreAsync(async delegate + { + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + { + if (resumeOnMainThread) { - // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will - // deadlock due to not being inside a JTF.RunAsync(). - Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - mustYield = !releaserTask.IsCompleted; - releaser = await releaserTask.ConfigureAwaitRunInline(); + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); } else { - releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); } } - await this.ExecuteCoreAsync(async delegate - { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) - { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(cancellationToken); - } - else - { - await TaskScheduler.Default; - } - - if (mustYield) - { - // Yield to prevent running on the stack that released the semaphore. - await Task.Yield(); - } - } - - await operation().ConfigureAwaitRunInline(); - }); - } - finally + this.reentrancyDetection.Value = ownedBox = new StrongBox(true); + return await operation().ConfigureAwait(true); + }); + } + finally + { + // Make it clear to any forks of our ExecutionContexxt that the semaphore is no longer owned. + // Null check incase the switch to UI thread was cancelled. + if (ownedBox is object) { - DisposeReleaserNoThrow(releaser); + ownedBox.Value = false; } + + DisposeReleaserNoThrow(releaser); } + } + + /// + public override RevertRelevance SuppressRelevance() + { + StrongBox? originalValue = this.reentrancyDetection.Value; + this.reentrancyDetection.Value = null; + return new RevertRelevance((t, s) => ((NotAllowedSemaphore)t).reentrancyDetection.Value = (StrongBox?)s, this, originalValue); + } + } - /// - public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) + /// + /// An implementation of supporting the mode. + /// + private class StackSemaphore : ReentrantSemaphore + { + /// + /// The means to recognize that a caller has already entered the semaphore. + /// + /// + /// We use instead of just here + /// so that we have a unique identity for each Releaser that we can recognize as a means to verify + /// the integrity of the "stack" of semaphore reentrant requests. + /// + private readonly AsyncLocal>> reentrantCount = new AsyncLocal>>(); + + /// + /// A flag to indicate this instance was misused and the data it protects should not be touched as it may be corrupted. + /// + private bool faulted; + + /// + /// Initializes a new instance of the class. + /// + /// The initial number of concurrent operations to allow. + /// The to use to mitigate deadlocks. + internal StackSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) + : base(initialCount, joinableTaskContext) + { + } + + /// + public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) + { + Requires.NotNull(operation, nameof(operation)); + this.ThrowIfFaulted(); + + // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. + // Multiple threads or multiple async methods will all have their own storage for this field. + Stack>? reentrantStack = this.reentrantCount.Value; + if (reentrantStack is null || reentrantStack.Count == 0) { - Requires.NotNull(operation, nameof(operation)); - - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - try + // When the stack is empty, the semaphore isn't held. But many execution contexts that forked from a common root + // would be sharing this same empty Stack instance. If we pushed to that Stack, all those forks would suddenly + // be seen as having entered this new top-level semaphore. We therefore allocate a new Stack and assign it to our + // AsyncLocal field so that only this particular ExecutionContext is seen as having entered the semaphore. + this.reentrantCount.Value = reentrantStack = new Stack>(capacity: 2); + } + + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + bool pushed = false; + StrongBox? pushedReleaser = null; + try + { + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + if (reentrantStack.Count == 0) { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; using (this.joinableTaskCollection?.Join()) { if (this.IsJoinableTaskAware(out _, out _)) @@ -416,24 +712,59 @@ public override async ValueTask ExecuteAsync(Func> operation, releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); } } + } + else + { + releaser = default; + } - return await this.ExecuteCoreAsync(async delegate + pushedReleaser = new StrongBox(releaser); + await this.ExecuteCoreAsync(async delegate + { + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + if (resumeOnMainThread) { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); + } + else + { + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); + } + } + + // The semaphore faulted while we were waiting on it. + this.ThrowIfFaulted(); + + lock (reentrantStack) + { + reentrantStack.Push(pushedReleaser); + pushed = true; + } + + await operation().ConfigureAwaitRunInline(); + }); + } + finally + { + try + { + if (pushed) + { + lock (reentrantStack) + { + StrongBox? poppedReleaser = reentrantStack.Pop(); + if (!object.ReferenceEquals(poppedReleaser, pushedReleaser)) { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); + // When the semaphore faults, we will drain and throw for awaiting tasks one by one. + this.faulted = true; +#pragma warning disable CA2219 // Do not raise exceptions in finally clauses + throw new IllegalSemaphoreUsageException(string.Format(CultureInfo.CurrentCulture, Strings.SemaphoreStackNestingViolated, ReentrantSemaphore.ReentrancyMode.Stack)); +#pragma warning restore CA2219 // Do not raise exceptions in finally clauses } } - - return await operation().ConfigureAwait(true); - }); + } } finally { @@ -442,58 +773,41 @@ public override async ValueTask ExecuteAsync(Func> operation, } } - /// - /// An implementation of supporting the mode. - /// - private class NotAllowedSemaphore : ReentrantSemaphore + /// + public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) { - /// - /// The means to recognize that a caller has already entered the semaphore. - /// - /// - /// We use instead of just here for two reasons: - /// 1. Our own class requires a ref type for the generic type argument. - /// 2. (more importantly) we need all forks of an ExecutionContext to observe updates to the value. - /// But ExecutionContext is copy-on-write so forks don't see changes to it. - /// lets us store and later update the boxed value of the existing box reference. - /// - private readonly AsyncLocal> reentrancyDetection = new AsyncLocal>(); - - /// - /// Initializes a new instance of the class. - /// - /// The initial number of concurrent operations to allow. - /// The to use to mitigate deadlocks. - internal NotAllowedSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) - : base(initialCount, joinableTaskContext) + Requires.NotNull(operation, nameof(operation)); + this.ThrowIfFaulted(); + + // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. + // Multiple threads or multiple async methods will all have their own storage for this field. + Stack>? reentrantStack = this.reentrantCount.Value; + if (reentrantStack is null || reentrantStack.Count == 0) { + // When the stack is empty, the semaphore isn't held. But many execution contexts that forked from a common root + // would be sharing this same empty Stack instance. If we pushed to that Stack, all those forks would suddenly + // be seen as having entered this new top-level semaphore. We therefore allocate a new Stack and assign it to our + // AsyncLocal field so that only this particular ExecutionContext is seen as having entered the semaphore. + this.reentrantCount.Value = reentrantStack = new Stack>(capacity: 2); } - /// - public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + bool pushed = false; + StrongBox? pushedReleaser = null; + try { - Requires.NotNull(operation, nameof(operation)); - this.ThrowIfFaulted(); - - StrongBox? ownedBox = this.reentrancyDetection.Value; - if (ownedBox?.Value ?? false) - { - throw Verify.FailOperation(Strings.SemaphoreAlreadyHeld, ReentrancyMode.NotAllowed); - } - - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - try + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + if (reentrantStack.Count == 0) { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; using (this.joinableTaskCollection?.Join()) { if (this.IsJoinableTaskAware(out _, out _)) @@ -512,614 +826,299 @@ public override async Task ExecuteAsync(Func operation, CancellationToken releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); } } - - await this.ExecuteCoreAsync(async delegate - { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) - { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else - { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); - } - } - - this.reentrancyDetection.Value = ownedBox = new StrongBox(true); - await operation().ConfigureAwaitRunInline(); - }); - } - finally - { - // Make it clear to any forks of our ExecutionContexxt that the semaphore is no longer owned. - // Null check incase the switch to UI thread was cancelled. - if (ownedBox is object) - { - ownedBox.Value = false; - } - - DisposeReleaserNoThrow(releaser); } - } - - /// - public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) - { - Requires.NotNull(operation, nameof(operation)); - this.ThrowIfFaulted(); - - StrongBox? ownedBox = this.reentrancyDetection.Value; - if (ownedBox?.Value ?? false) + else { - throw Verify.FailOperation(Strings.SemaphoreAlreadyHeld, ReentrancyMode.NotAllowed); + releaser = default; } - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - try + pushedReleaser = new StrongBox(releaser); + return await this.ExecuteCoreAsync(async delegate { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; - using (this.joinableTaskCollection?.Join()) + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) { - if (this.IsJoinableTaskAware(out _, out _)) + if (resumeOnMainThread) { - // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will - // deadlock due to not being inside a JTF.RunAsync(). - Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - - // Yield to prevent running on the stack that released the semaphore. - mustYield = !releaserTask.IsCompleted; - releaser = await releaserTask.ConfigureAwaitRunInline(); + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); } else { - releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); } } - return await this.ExecuteCoreAsync(async delegate + // The semaphore faulted while we were waiting on it. + this.ThrowIfFaulted(); + + lock (reentrantStack) + { + reentrantStack.Push(pushedReleaser); + pushed = true; + } + + return await operation().ConfigureAwait(true); + }); + } + finally + { + try + { + if (pushed) { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + lock (reentrantStack) { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else + StrongBox? poppedReleaser = reentrantStack.Pop(); + if (!object.ReferenceEquals(poppedReleaser, pushedReleaser)) { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); + // When the semaphore faults, we will drain and throw for awaiting tasks one by one. + this.faulted = true; +#pragma warning disable CA2219 // Do not raise exceptions in finally clauses + throw new IllegalSemaphoreUsageException(string.Format(CultureInfo.CurrentCulture, Strings.SemaphoreStackNestingViolated, ReentrantSemaphore.ReentrancyMode.Stack)); +#pragma warning restore CA2219 // Do not raise exceptions in finally clauses } } - - this.reentrancyDetection.Value = ownedBox = new StrongBox(true); - return await operation().ConfigureAwait(true); - }); + } } finally { - // Make it clear to any forks of our ExecutionContexxt that the semaphore is no longer owned. - // Null check incase the switch to UI thread was cancelled. - if (ownedBox is object) - { - ownedBox.Value = false; - } - DisposeReleaserNoThrow(releaser); } } + } - /// - public override RevertRelevance SuppressRelevance() - { - StrongBox? originalValue = this.reentrancyDetection.Value; - this.reentrancyDetection.Value = null; - return new RevertRelevance((t, s) => ((NotAllowedSemaphore)t).reentrancyDetection.Value = (StrongBox?)s, this, originalValue); - } + /// + public override RevertRelevance SuppressRelevance() + { + Stack>? originalValue = this.reentrantCount.Value; + this.reentrantCount.Value = null; + return new RevertRelevance((t, s) => ((StackSemaphore)t).reentrantCount.Value = (Stack>?)s, this, originalValue); } /// - /// An implementation of supporting the mode. + /// Throws an exception if this instance has been faulted. /// - private class StackSemaphore : ReentrantSemaphore + protected override void ThrowIfFaulted() { - /// - /// The means to recognize that a caller has already entered the semaphore. - /// - /// - /// We use instead of just here - /// so that we have a unique identity for each Releaser that we can recognize as a means to verify - /// the integrity of the "stack" of semaphore reentrant requests. - /// - private readonly AsyncLocal>> reentrantCount = new AsyncLocal>>(); - - /// - /// A flag to indicate this instance was misused and the data it protects should not be touched as it may be corrupted. - /// - private bool faulted; - - /// - /// Initializes a new instance of the class. - /// - /// The initial number of concurrent operations to allow. - /// The to use to mitigate deadlocks. - internal StackSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) - : base(initialCount, joinableTaskContext) + if (this.faulted) { + throw new SemaphoreFaultedException(); } + } + } - /// - public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) - { - Requires.NotNull(operation, nameof(operation)); - this.ThrowIfFaulted(); - - // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. - // Multiple threads or multiple async methods will all have their own storage for this field. - Stack>? reentrantStack = this.reentrantCount.Value; - if (reentrantStack is null || reentrantStack.Count == 0) - { - // When the stack is empty, the semaphore isn't held. But many execution contexts that forked from a common root - // would be sharing this same empty Stack instance. If we pushed to that Stack, all those forks would suddenly - // be seen as having entered this new top-level semaphore. We therefore allocate a new Stack and assign it to our - // AsyncLocal field so that only this particular ExecutionContext is seen as having entered the semaphore. - this.reentrantCount.Value = reentrantStack = new Stack>(capacity: 2); - } + /// + /// An implementation of supporting the mode. + /// + private class FreeformSemaphore : ReentrantSemaphore + { + /// + /// The means to recognize that a caller has already entered the semaphore. + /// + private readonly AsyncLocal> reentrantCount = new AsyncLocal>(); - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - bool pushed = false; - StrongBox? pushedReleaser = null; - try - { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; - if (reentrantStack.Count == 0) - { - using (this.joinableTaskCollection?.Join()) - { - if (this.IsJoinableTaskAware(out _, out _)) - { - // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will - // deadlock due to not being inside a JTF.RunAsync(). - Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); + /// + /// Initializes a new instance of the class. + /// + /// The initial number of concurrent operations to allow. + /// The to use to mitigate deadlocks. + internal FreeformSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) + : base(initialCount, joinableTaskContext) + { + } - // Yield to prevent running on the stack that released the semaphore. - mustYield = !releaserTask.IsCompleted; + /// + public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) + { + Requires.NotNull(operation, nameof(operation)); + this.ThrowIfFaulted(); - releaser = await releaserTask.ConfigureAwaitRunInline(); - } - else - { - releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); - } - } - } - else - { - releaser = default; - } + // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. + // Multiple threads or multiple async methods will all have their own storage for this field. + Stack? reentrantStack = this.reentrantCount.Value; + if (reentrantStack is null || reentrantStack.Count == 0) + { + this.reentrantCount.Value = reentrantStack = new Stack(capacity: 2); + } - pushedReleaser = new StrongBox(releaser); - await this.ExecuteCoreAsync(async delegate + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + bool pushed = false; + try + { + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + if (reentrantStack.Count == 0) + { + using (this.joinableTaskCollection?.Join()) { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + if (this.IsJoinableTaskAware(out _, out _)) { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else - { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); - } - } + // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will + // deadlock due to not being inside a JTF.RunAsync(). + Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - // The semaphore faulted while we were waiting on it. - this.ThrowIfFaulted(); + // Yield to prevent running on the stack that released the semaphore. + mustYield = !releaserTask.IsCompleted; - lock (reentrantStack) - { - reentrantStack.Push(pushedReleaser); - pushed = true; + releaser = await releaserTask.ConfigureAwaitRunInline(); } - - await operation().ConfigureAwaitRunInline(); - }); - } - finally - { - try - { - if (pushed) + else { - lock (reentrantStack) - { - StrongBox? poppedReleaser = reentrantStack.Pop(); - if (!object.ReferenceEquals(poppedReleaser, pushedReleaser)) - { - // When the semaphore faults, we will drain and throw for awaiting tasks one by one. - this.faulted = true; -#pragma warning disable CA2219 // Do not raise exceptions in finally clauses - throw new IllegalSemaphoreUsageException(string.Format(CultureInfo.CurrentCulture, Strings.SemaphoreStackNestingViolated, ReentrantSemaphore.ReentrancyMode.Stack)); -#pragma warning restore CA2219 // Do not raise exceptions in finally clauses - } - } + releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); } } - finally - { - DisposeReleaserNoThrow(releaser); - } } - } - - /// - public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) - { - Requires.NotNull(operation, nameof(operation)); - this.ThrowIfFaulted(); - - // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. - // Multiple threads or multiple async methods will all have their own storage for this field. - Stack>? reentrantStack = this.reentrantCount.Value; - if (reentrantStack is null || reentrantStack.Count == 0) + else { - // When the stack is empty, the semaphore isn't held. But many execution contexts that forked from a common root - // would be sharing this same empty Stack instance. If we pushed to that Stack, all those forks would suddenly - // be seen as having entered this new top-level semaphore. We therefore allocate a new Stack and assign it to our - // AsyncLocal field so that only this particular ExecutionContext is seen as having entered the semaphore. - this.reentrantCount.Value = reentrantStack = new Stack>(capacity: 2); + releaser = default; } - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - bool pushed = false; - StrongBox? pushedReleaser = null; - try + await this.ExecuteCoreAsync(async delegate { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; - if (reentrantStack.Count == 0) - { - using (this.joinableTaskCollection?.Join()) - { - if (this.IsJoinableTaskAware(out _, out _)) - { - // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will - // deadlock due to not being inside a JTF.RunAsync(). - Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - - // Yield to prevent running on the stack that released the semaphore. - mustYield = !releaserTask.IsCompleted; - - releaser = await releaserTask.ConfigureAwaitRunInline(); - } - else - { - releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); - } - } - } - else - { - releaser = default; - } - - pushedReleaser = new StrongBox(releaser); - return await this.ExecuteCoreAsync(async delegate + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) - { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else - { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); - } - } - - // The semaphore faulted while we were waiting on it. - this.ThrowIfFaulted(); - - lock (reentrantStack) + if (resumeOnMainThread) { - reentrantStack.Push(pushedReleaser); - pushed = true; + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); } - - return await operation().ConfigureAwait(true); - }); - } - finally - { - try - { - if (pushed) + else { - lock (reentrantStack) - { - StrongBox? poppedReleaser = reentrantStack.Pop(); - if (!object.ReferenceEquals(poppedReleaser, pushedReleaser)) - { - // When the semaphore faults, we will drain and throw for awaiting tasks one by one. - this.faulted = true; -#pragma warning disable CA2219 // Do not raise exceptions in finally clauses - throw new IllegalSemaphoreUsageException(string.Format(CultureInfo.CurrentCulture, Strings.SemaphoreStackNestingViolated, ReentrantSemaphore.ReentrancyMode.Stack)); -#pragma warning restore CA2219 // Do not raise exceptions in finally clauses - } - } + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); } } - finally + + lock (reentrantStack) { - DisposeReleaserNoThrow(releaser); + reentrantStack.Push(releaser); + pushed = true; + releaser = default; // we should release whatever we pop off the stack (which ensures the last surviving nested holder actually releases). } - } - } - /// - public override RevertRelevance SuppressRelevance() - { - Stack>? originalValue = this.reentrantCount.Value; - this.reentrantCount.Value = null; - return new RevertRelevance((t, s) => ((StackSemaphore)t).reentrantCount.Value = (Stack>?)s, this, originalValue); + await operation().ConfigureAwaitRunInline(); + }); } - - /// - /// Throws an exception if this instance has been faulted. - /// - protected override void ThrowIfFaulted() + finally { - if (this.faulted) + if (pushed) { - throw new SemaphoreFaultedException(); + lock (reentrantStack) + { + releaser = reentrantStack.Pop(); + } } + + DisposeReleaserNoThrow(releaser); } } - /// - /// An implementation of supporting the mode. - /// - private class FreeformSemaphore : ReentrantSemaphore + /// + public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) { - /// - /// The means to recognize that a caller has already entered the semaphore. - /// - private readonly AsyncLocal> reentrantCount = new AsyncLocal>(); - - /// - /// Initializes a new instance of the class. - /// - /// The initial number of concurrent operations to allow. - /// The to use to mitigate deadlocks. - internal FreeformSemaphore(int initialCount, JoinableTaskContext? joinableTaskContext) - : base(initialCount, joinableTaskContext) + Requires.NotNull(operation, nameof(operation)); + this.ThrowIfFaulted(); + + // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. + // Multiple threads or multiple async methods will all have their own storage for this field. + Stack? reentrantStack = this.reentrantCount.Value; + if (reentrantStack is null || reentrantStack.Count == 0) { + this.reentrantCount.Value = reentrantStack = new Stack(capacity: 2); } - /// - public override async Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default) + // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. + // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also + // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a + // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from + // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or + // thread pool. + AsyncSemaphore.Releaser releaser = default; + bool pushed = false; + try { - Requires.NotNull(operation, nameof(operation)); - this.ThrowIfFaulted(); - - // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. - // Multiple threads or multiple async methods will all have their own storage for this field. - Stack? reentrantStack = this.reentrantCount.Value; - if (reentrantStack is null || reentrantStack.Count == 0) - { - this.reentrantCount.Value = reentrantStack = new Stack(capacity: 2); - } - - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - bool pushed = false; - try + bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) + ? joinableTaskCollection.Context.IsOnMainThread + : false; + bool mustYield = false; + if (reentrantStack.Count == 0) { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; - if (reentrantStack.Count == 0) + using (this.joinableTaskCollection?.Join()) { - using (this.joinableTaskCollection?.Join()) + if (this.IsJoinableTaskAware(out _, out _)) { - if (this.IsJoinableTaskAware(out _, out _)) - { - // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will - // deadlock due to not being inside a JTF.RunAsync(). - Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - - // Yield to prevent running on the stack that released the semaphore. - mustYield = !releaserTask.IsCompleted; - - releaser = await releaserTask.ConfigureAwaitRunInline(); - } - else - { - releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); - } - } - } - else - { - releaser = default; - } + // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will + // deadlock due to not being inside a JTF.RunAsync(). + Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - await this.ExecuteCoreAsync(async delegate - { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) - { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else - { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); - } - } + // Yield to prevent running on the stack that released the semaphore. + mustYield = !releaserTask.IsCompleted; - lock (reentrantStack) - { - reentrantStack.Push(releaser); - pushed = true; - releaser = default; // we should release whatever we pop off the stack (which ensures the last surviving nested holder actually releases). + releaser = await releaserTask.ConfigureAwaitRunInline(); } - - await operation().ConfigureAwaitRunInline(); - }); - } - finally - { - if (pushed) - { - lock (reentrantStack) + else { - releaser = reentrantStack.Pop(); + releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); } } - - DisposeReleaserNoThrow(releaser); } - } - - /// - public override async ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default) - { - Requires.NotNull(operation, nameof(operation)); - this.ThrowIfFaulted(); - - // No race condition here: We're accessing AsyncLocal which we by definition have our own copy of. - // Multiple threads or multiple async methods will all have their own storage for this field. - Stack? reentrantStack = this.reentrantCount.Value; - if (reentrantStack is null || reentrantStack.Count == 0) + else { - this.reentrantCount.Value = reentrantStack = new Stack(capacity: 2); + releaser = default; } - // Note: this code is duplicated and not extracted to minimize allocating extra async state machines. - // For performance reasons in the JTF enabled scenario, we want to minimize the number of Joins performed, and also - // keep the size of the JoinableCollection to a minimum. This also means awaiting on the semaphore outside of a - // JTF.RunAsync. This requires us to not ConfigureAwait(true) on the semaphore. However, that prevents us from - // resuming on the correct sync context. To partially fix this, we will at least resume you on the main thread or - // thread pool. - AsyncSemaphore.Releaser releaser = default; - bool pushed = false; - try + return await this.ExecuteCoreAsync(async delegate { - bool resumeOnMainThread = this.IsJoinableTaskAware(out _, out JoinableTaskCollection? joinableTaskCollection) - ? joinableTaskCollection.Context.IsOnMainThread - : false; - bool mustYield = false; - if (reentrantStack.Count == 0) + if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) { - using (this.joinableTaskCollection?.Join()) + if (resumeOnMainThread) { - if (this.IsJoinableTaskAware(out _, out _)) - { - // Use ConfiguredAwaitRunInline() as ConfigureAwait(true) will - // deadlock due to not being inside a JTF.RunAsync(). - Task? releaserTask = this.semaphore.EnterAsync(cancellationToken); - - // Yield to prevent running on the stack that released the semaphore. - mustYield = !releaserTask.IsCompleted; - - releaser = await releaserTask.ConfigureAwaitRunInline(); - } - else - { - releaser = await this.semaphore.EnterAsync(cancellationToken).ConfigureAwait(true); - } + // Return to the main thread if we started there. + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); } - } - else - { - releaser = default; - } - - return await this.ExecuteCoreAsync(async delegate - { - if (this.IsJoinableTaskAware(out JoinableTaskFactory? joinableTaskFactory, out _)) + else { - if (resumeOnMainThread) - { - // Return to the main thread if we started there. - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: mustYield, cancellationToken); - } - else - { - await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); - } + await TaskScheduler.Default.SwitchTo(alwaysYield: mustYield); } + } - lock (reentrantStack) - { - reentrantStack.Push(releaser); - pushed = true; - releaser = default; // we should release whatever we pop off the stack (which ensures the last surviving nested holder actually releases). - } + lock (reentrantStack) + { + reentrantStack.Push(releaser); + pushed = true; + releaser = default; // we should release whatever we pop off the stack (which ensures the last surviving nested holder actually releases). + } - return await operation().ConfigureAwait(true); - }); - } - finally + return await operation().ConfigureAwait(true); + }); + } + finally + { + if (pushed) { - if (pushed) + lock (reentrantStack) { - lock (reentrantStack) - { - releaser = reentrantStack.Pop(); - } + releaser = reentrantStack.Pop(); } - - DisposeReleaserNoThrow(releaser); } - } - /// - public override RevertRelevance SuppressRelevance() - { - Stack? originalValue = this.reentrantCount.Value; - this.reentrantCount.Value = null; - return new RevertRelevance((t, s) => ((FreeformSemaphore)t).reentrantCount.Value = (Stack?)s, this, originalValue); + DisposeReleaserNoThrow(releaser); } } + + /// + public override RevertRelevance SuppressRelevance() + { + Stack? originalValue = this.reentrantCount.Value; + this.reentrantCount.Value = null; + return new RevertRelevance((t, s) => ((FreeformSemaphore)t).reentrantCount.Value = (Stack?)s, this, originalValue); + } } } diff --git a/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs b/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs index ab03d816c..8a7db1ab8 100644 --- a/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs +++ b/src/Microsoft.VisualStudio.Threading/RegistryChangeNotificationFilters.cs @@ -4,38 +4,37 @@ using System; using global::Windows.Win32.System.Registry; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// The various types of data within a registry key that generate notifications +/// when changed. +/// +/// +/// This enum matches the Win32 REG_NOTIFY_CHANGE_* constants. +/// +[Flags] +public enum RegistryChangeNotificationFilters { /// - /// The various types of data within a registry key that generate notifications - /// when changed. + /// Notify the caller if a subkey is added or deleted. /// - /// - /// This enum matches the Win32 REG_NOTIFY_CHANGE_* constants. - /// - [Flags] - public enum RegistryChangeNotificationFilters - { - /// - /// Notify the caller if a subkey is added or deleted. - /// - Subkey = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_NAME, + Subkey = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_NAME, - /// - /// Notify the caller of changes to the attributes of the key, - /// such as the security descriptor information. - /// - Attributes = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_ATTRIBUTES, + /// + /// Notify the caller of changes to the attributes of the key, + /// such as the security descriptor information. + /// + Attributes = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_ATTRIBUTES, - /// - /// Notify the caller of changes to a value of the key. This can - /// include adding or deleting a value, or changing an existing value. - /// - Value = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_LAST_SET, + /// + /// Notify the caller of changes to a value of the key. This can + /// include adding or deleting a value, or changing an existing value. + /// + Value = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_LAST_SET, - /// - /// Notify the caller of changes to the security descriptor of the key. - /// - Security = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_SECURITY, - } + /// + /// Notify the caller of changes to the security descriptor of the key. + /// + Security = (int)REG_NOTIFY_FILTER.REG_NOTIFY_CHANGE_SECURITY, } diff --git a/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs b/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs index 3d399f3b8..6ade94373 100644 --- a/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs +++ b/src/Microsoft.VisualStudio.Threading/RoslynDebug.cs @@ -3,20 +3,19 @@ using System.Diagnostics.CodeAnalysis; -namespace System.Diagnostics +namespace System.Diagnostics; + +internal static class RoslynDebug { - internal static class RoslynDebug - { - /// - [Conditional("DEBUG")] - internal static void Assert([DoesNotReturnIf(false)] bool b) + /// + [Conditional("DEBUG")] + internal static void Assert([DoesNotReturnIf(false)] bool b) #pragma warning disable SA1405 // Debug.Assert should provide message text - => Debug.Assert(b); + => Debug.Assert(b); #pragma warning restore SA1405 // Debug.Assert should provide message text - /// - [Conditional("DEBUG")] - internal static void Assert([DoesNotReturnIf(false)] bool b, string message) - => Debug.Assert(b, message); - } + /// + [Conditional("DEBUG")] + internal static void Assert([DoesNotReturnIf(false)] bool b, string message) + => Debug.Assert(b, message); } diff --git a/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs b/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs index f7ddd5b06..f5dbafea1 100644 --- a/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs +++ b/src/Microsoft.VisualStudio.Threading/SemaphoreFaultedException.cs @@ -3,19 +3,18 @@ using System; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Exception thrown when a is in a faulted state. +/// +public class SemaphoreFaultedException : InvalidOperationException { /// - /// Exception thrown when a is in a faulted state. + /// Initializes a new instance of the class. /// - public class SemaphoreFaultedException : InvalidOperationException + public SemaphoreFaultedException() + : base(Strings.SemaphoreMisused) { - /// - /// Initializes a new instance of the class. - /// - public SemaphoreFaultedException() - : base(Strings.SemaphoreMisused) - { - } } } diff --git a/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs index 5e5d06fc7..c99693784 100644 --- a/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/SingleThreadedSynchronizationContext.cs @@ -6,240 +6,239 @@ using System.Reflection; using System.Threading; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A single-threaded synchronization context, akin to the DispatcherSynchronizationContext +/// and WindowsFormsSynchronizationContext. +/// +/// +/// This must be created on the thread that will serve as the pumping thread. +/// +public class SingleThreadedSynchronizationContext : SynchronizationContext { /// - /// A single-threaded synchronization context, akin to the DispatcherSynchronizationContext - /// and WindowsFormsSynchronizationContext. + /// The list of posted messages to be executed. Must be locked for all access. /// - /// - /// This must be created on the thread that will serve as the pumping thread. - /// - public class SingleThreadedSynchronizationContext : SynchronizationContext + private readonly Queue messageQueue; + + /// + /// The managed thread ID of the thread this instance owns. + /// + private readonly int ownedThreadId; + + /// + /// Initializes a new instance of the class, + /// with the new instance affinitized to the current thread. + /// + public SingleThreadedSynchronizationContext() { - /// - /// The list of posted messages to be executed. Must be locked for all access. - /// - private readonly Queue messageQueue; + this.messageQueue = new Queue(); + this.ownedThreadId = Environment.CurrentManagedThreadId; + } - /// - /// The managed thread ID of the thread this instance owns. - /// - private readonly int ownedThreadId; + /// + /// Initializes a new instance of the class, + /// as an equivalent copy to another instance. + /// + private SingleThreadedSynchronizationContext(SingleThreadedSynchronizationContext copyFrom) + { + Requires.NotNull(copyFrom, nameof(copyFrom)); - /// - /// Initializes a new instance of the class, - /// with the new instance affinitized to the current thread. - /// - public SingleThreadedSynchronizationContext() + this.messageQueue = copyFrom.messageQueue; + this.ownedThreadId = copyFrom.ownedThreadId; + } + + /// + public override void Post(SendOrPostCallback d, object? state) + { + var ctxt = ExecutionContext.Capture(); + lock (this.messageQueue) { - this.messageQueue = new Queue(); - this.ownedThreadId = Environment.CurrentManagedThreadId; + this.messageQueue.Enqueue(new Message(d, state, ctxt)); + Monitor.PulseAll(this.messageQueue); } + } - /// - /// Initializes a new instance of the class, - /// as an equivalent copy to another instance. - /// - private SingleThreadedSynchronizationContext(SingleThreadedSynchronizationContext copyFrom) - { - Requires.NotNull(copyFrom, nameof(copyFrom)); + /// + public override void Send(SendOrPostCallback d, object? state) + { + Requires.NotNull(d, nameof(d)); - this.messageQueue = copyFrom.messageQueue; - this.ownedThreadId = copyFrom.ownedThreadId; + if (this.ownedThreadId == Environment.CurrentManagedThreadId) + { + try + { + d(state); + } + catch (Exception ex) + { + throw new TargetInvocationException(ex); + } } - - /// - public override void Post(SendOrPostCallback d, object? state) + else { + Exception? caughtException = null; + var evt = new ManualResetEventSlim(); var ctxt = ExecutionContext.Capture(); lock (this.messageQueue) { - this.messageQueue.Enqueue(new Message(d, state, ctxt)); + this.messageQueue.Enqueue(new Message( + s => + { + try + { + d(state); + } + catch (Exception ex) + { + caughtException = ex; + } + finally + { + evt.Set(); + } + }, + null, + ctxt)); Monitor.PulseAll(this.messageQueue); } - } - - /// - public override void Send(SendOrPostCallback d, object? state) - { - Requires.NotNull(d, nameof(d)); - if (this.ownedThreadId == Environment.CurrentManagedThreadId) + evt.Wait(); + if (caughtException is object) { - try - { - d(state); - } - catch (Exception ex) - { - throw new TargetInvocationException(ex); - } - } - else - { - Exception? caughtException = null; - var evt = new ManualResetEventSlim(); - var ctxt = ExecutionContext.Capture(); - lock (this.messageQueue) - { - this.messageQueue.Enqueue(new Message( - s => - { - try - { - d(state); - } - catch (Exception ex) - { - caughtException = ex; - } - finally - { - evt.Set(); - } - }, - null, - ctxt)); - Monitor.PulseAll(this.messageQueue); - } - - evt.Wait(); - if (caughtException is object) - { - throw new TargetInvocationException(caughtException); - } + throw new TargetInvocationException(caughtException); } } + } - /// - public override SynchronizationContext CreateCopy() - { - // Don't return "this", since that can result in the same instance being "Current" - // on another thread, and end up being misinterpreted as permission to skip the SyncContext - // and simply inline certain continuations by buggy code. - // See https://referencesource.microsoft.com/#WindowsBase/Base/System/Windows/BaseCompatibilityPreferences.cs,39 - return new SingleThreadedSynchronizationContext(this); - } + /// + public override SynchronizationContext CreateCopy() + { + // Don't return "this", since that can result in the same instance being "Current" + // on another thread, and end up being misinterpreted as permission to skip the SyncContext + // and simply inline certain continuations by buggy code. + // See https://referencesource.microsoft.com/#WindowsBase/Base/System/Windows/BaseCompatibilityPreferences.cs,39 + return new SingleThreadedSynchronizationContext(this); + } - /// - /// Pushes a message pump on the current thread that will execute work scheduled using . - /// - /// The frame to represent this message pump, which controls when the message pump ends. - public void PushFrame(Frame frame) - { - Requires.NotNull(frame, nameof(frame)); - Verify.Operation(this.ownedThreadId == Environment.CurrentManagedThreadId, Strings.PushFromWrongThread); - frame.SetOwner(this); + /// + /// Pushes a message pump on the current thread that will execute work scheduled using . + /// + /// The frame to represent this message pump, which controls when the message pump ends. + public void PushFrame(Frame frame) + { + Requires.NotNull(frame, nameof(frame)); + Verify.Operation(this.ownedThreadId == Environment.CurrentManagedThreadId, Strings.PushFromWrongThread); + frame.SetOwner(this); - using (this.Apply()) + using (this.Apply()) + { + while (frame.Continue) { - while (frame.Continue) + Message message; + lock (this.messageQueue) { - Message message; - lock (this.messageQueue) + // Check again now that we're holding the lock. + if (!frame.Continue) { - // Check again now that we're holding the lock. - if (!frame.Continue) - { - break; - } - - if (this.messageQueue.Count > 0) - { - message = this.messageQueue.Dequeue(); - } - else - { - Monitor.Wait(this.messageQueue); - continue; - } + break; } - if (message.Context is object) + if (this.messageQueue.Count > 0) { - ExecutionContext.Run( - message.Context, - new ContextCallback(message.Callback), - message.State); + message = this.messageQueue.Dequeue(); } else { - // If this throws, we intentionally let it propagate to our caller. - // WPF/WinForms SyncContexts will crash the process (perhaps by throwing from their method like this?). - // But anyway, throwing from here instead of crashing is more friendly IMO and more easily tested. - message.Callback(message.State); + Monitor.Wait(this.messageQueue); + continue; } } + + if (message.Context is object) + { + ExecutionContext.Run( + message.Context, + new ContextCallback(message.Callback), + message.State); + } + else + { + // If this throws, we intentionally let it propagate to our caller. + // WPF/WinForms SyncContexts will crash the process (perhaps by throwing from their method like this?). + // But anyway, throwing from here instead of crashing is more friendly IMO and more easily tested. + message.Callback(message.State); + } } } + } - private readonly struct Message - { - internal readonly SendOrPostCallback Callback; - internal readonly object? State; - internal readonly ExecutionContext? Context; + private readonly struct Message + { + internal readonly SendOrPostCallback Callback; + internal readonly object? State; + internal readonly ExecutionContext? Context; - internal Message(SendOrPostCallback d, object? state, ExecutionContext? ctxt) - { - this.Callback = d; - this.State = state; - this.Context = ctxt; - } + internal Message(SendOrPostCallback d, object? state, ExecutionContext? ctxt) + { + this.Callback = d; + this.State = state; + this.Context = ctxt; } + } + + /// + /// A message pumping frame that may be pushed with to pump messages + /// on the owning thread. + /// + public class Frame + { + /// + /// The owning sync context. + /// + private SingleThreadedSynchronizationContext? owner; + + /// + /// Backing field for the property. + /// + private bool @continue = true; /// - /// A message pumping frame that may be pushed with to pump messages - /// on the owning thread. + /// Gets or sets a value indicating whether a call to with this + /// should continue pumping messages or should return to its caller. /// - public class Frame + public bool Continue { - /// - /// The owning sync context. - /// - private SingleThreadedSynchronizationContext? owner; - - /// - /// Backing field for the property. - /// - private bool @continue = true; - - /// - /// Gets or sets a value indicating whether a call to with this - /// should continue pumping messages or should return to its caller. - /// - public bool Continue + get { - get - { - return this.@continue; - } + return this.@continue; + } - set - { - Verify.Operation(this.owner is object, Strings.FrameMustBePushedFirst); + set + { + Verify.Operation(this.owner is object, Strings.FrameMustBePushedFirst); - this.@continue = value; + this.@continue = value; - // Alert thread that may be blocked waiting for an incoming message - // that it no longer needs to wait. - if (!value) + // Alert thread that may be blocked waiting for an incoming message + // that it no longer needs to wait. + if (!value) + { + lock (this.owner.messageQueue) { - lock (this.owner.messageQueue) - { - Monitor.PulseAll(this.owner.messageQueue); - } + Monitor.PulseAll(this.owner.messageQueue); } } } + } - internal void SetOwner(SingleThreadedSynchronizationContext context) + internal void SetOwner(SingleThreadedSynchronizationContext context) + { + if (context != this.owner) { - if (context != this.owner) - { - Verify.Operation(this.owner is null, Strings.SyncContextFrameMismatchedAffinity); - this.owner = context; - } + Verify.Operation(this.owner is null, Strings.SyncContextFrameMismatchedAffinity); + this.owner = context; } } } diff --git a/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs b/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs index 5810883ef..f6cf97bde 100644 --- a/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/SpecializedSyncContext.cs @@ -4,65 +4,64 @@ using System; using System.Threading; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A structure that applies and reverts changes to the . +/// +public readonly struct SpecializedSyncContext : IDisposable { /// - /// A structure that applies and reverts changes to the . + /// A flag indicating whether the non-default constructor was invoked. /// - public readonly struct SpecializedSyncContext : IDisposable - { - /// - /// A flag indicating whether the non-default constructor was invoked. - /// - private readonly bool initialized; + private readonly bool initialized; - /// - /// The SynchronizationContext to restore when is invoked. - /// - private readonly SynchronizationContext? prior; + /// + /// The SynchronizationContext to restore when is invoked. + /// + private readonly SynchronizationContext? prior; - /// - /// The SynchronizationContext applied when this struct was constructed. - /// - private readonly SynchronizationContext? appliedContext; + /// + /// The SynchronizationContext applied when this struct was constructed. + /// + private readonly SynchronizationContext? appliedContext; - /// - /// A value indicating whether to check that the applied SyncContext is still the current one when the original is restored. - /// - private readonly bool checkForChangesOnRevert; + /// + /// A value indicating whether to check that the applied SyncContext is still the current one when the original is restored. + /// + private readonly bool checkForChangesOnRevert; - /// - /// Initializes a new instance of the struct. - /// - private SpecializedSyncContext(SynchronizationContext? syncContext, bool checkForChangesOnRevert) - { - this.initialized = true; - this.prior = SynchronizationContext.Current; - this.appliedContext = syncContext; - this.checkForChangesOnRevert = checkForChangesOnRevert; - SynchronizationContext.SetSynchronizationContext(syncContext); - } + /// + /// Initializes a new instance of the struct. + /// + private SpecializedSyncContext(SynchronizationContext? syncContext, bool checkForChangesOnRevert) + { + this.initialized = true; + this.prior = SynchronizationContext.Current; + this.appliedContext = syncContext; + this.checkForChangesOnRevert = checkForChangesOnRevert; + SynchronizationContext.SetSynchronizationContext(syncContext); + } - /// - /// Applies the specified to the caller's context. - /// - /// The synchronization context to apply. - /// A value indicating whether to check that the applied SyncContext is still the current one when the original is restored. - public static SpecializedSyncContext Apply(SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) - { - return new SpecializedSyncContext(syncContext, checkForChangesOnRevert); - } + /// + /// Applies the specified to the caller's context. + /// + /// The synchronization context to apply. + /// A value indicating whether to check that the applied SyncContext is still the current one when the original is restored. + public static SpecializedSyncContext Apply(SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) + { + return new SpecializedSyncContext(syncContext, checkForChangesOnRevert); + } - /// - /// Reverts the SynchronizationContext to its previous instance. - /// - public void Dispose() + /// + /// Reverts the SynchronizationContext to its previous instance. + /// + public void Dispose() + { + if (this.initialized) { - if (this.initialized) - { - Report.If(this.checkForChangesOnRevert && SynchronizationContext.Current != this.appliedContext); - SynchronizationContext.SetSynchronizationContext(this.prior); - } + Report.If(this.checkForChangesOnRevert && SynchronizationContext.Current != this.appliedContext); + SynchronizationContext.SetSynchronizationContext(this.prior); } } } diff --git a/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs b/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs index 195cf0993..68184f498 100644 --- a/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs +++ b/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs @@ -8,281 +8,280 @@ // //------------------------------------------------------------------------------ -namespace Microsoft.VisualStudio.Threading { - using System; +namespace Microsoft.VisualStudio.Threading; +using System; + + +/// +/// A strongly-typed resource class, for looking up localized strings, etc. +/// +// This class was auto-generated by the StronglyTypedResourceBuilder +// class via a tool like ResGen or Visual Studio. +// To add or remove a member, edit your .ResX file then rerun ResGen +// with the /str option, or rebuild your VS project. +[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] +[global::System.Diagnostics.DebuggerNonUserCodeAttribute()] +[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] +internal class Strings { + + private static global::System.Resources.ResourceManager resourceMan; + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Strings() { + } /// - /// A strongly-typed resource class, for looking up localized strings, etc. + /// Returns the cached ResourceManager instance used by this class. /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class Strings { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal Strings() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Strings", typeof(Strings).Assembly); - resourceMan = temp; - } - return resourceMan; + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Strings", typeof(Strings).Assembly); + resourceMan = temp; } + return resourceMan; } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } + } + + /// + /// Overrides the current thread's CurrentUICulture property for all + /// resource lookups using this strongly typed resource class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; } - - /// - /// Looks up a localized string similar to Acquiring locks on threads with a SynchronizationContext applied is not allowed.. - /// - internal static string AppliedSynchronizationContextNotAllowed { - get { - return ResourceManager.GetString("AppliedSynchronizationContextNotAllowed", resourceCulture); - } + set { + resourceCulture = value; } - - /// - /// Looks up a localized string similar to A non-upgradeable read lock is held by the caller and cannot be upgraded.. - /// - internal static string CannotUpgradeNonUpgradeableLock { - get { - return ResourceManager.GetString("CannotUpgradeNonUpgradeableLock", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Acquiring locks on threads with a SynchronizationContext applied is not allowed.. + /// + internal static string AppliedSynchronizationContextNotAllowed { + get { + return ResourceManager.GetString("AppliedSynchronizationContextNotAllowed", resourceCulture); } - - /// - /// Looks up a localized string similar to Dangerous request for read lock from fork of write lock.. - /// - internal static string DangerousReadLockRequestFromWriteLockFork { - get { - return ResourceManager.GetString("DangerousReadLockRequestFromWriteLockFork", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to A non-upgradeable read lock is held by the caller and cannot be upgraded.. + /// + internal static string CannotUpgradeNonUpgradeableLock { + get { + return ResourceManager.GetString("CannotUpgradeNonUpgradeableLock", resourceCulture); } - - /// - /// Looks up a localized string similar to This instance must be pushed first.. - /// - internal static string FrameMustBePushedFirst { - get { - return ResourceManager.GetString("FrameMustBePushedFirst", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Dangerous request for read lock from fork of write lock.. + /// + internal static string DangerousReadLockRequestFromWriteLockFork { + get { + return ResourceManager.GetString("DangerousReadLockRequestFromWriteLockFork", resourceCulture); } - - /// - /// Looks up a localized string similar to Already transitioned to the Completed state.. - /// - internal static string InvalidAfterCompleted { - get { - return ResourceManager.GetString("InvalidAfterCompleted", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This instance must be pushed first.. + /// + internal static string FrameMustBePushedFirst { + get { + return ResourceManager.GetString("FrameMustBePushedFirst", resourceCulture); } - - /// - /// Looks up a localized string similar to This operation can only be executed against a valid lock.. - /// - internal static string InvalidLock { - get { - return ResourceManager.GetString("InvalidLock", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Already transitioned to the Completed state.. + /// + internal static string InvalidAfterCompleted { + get { + return ResourceManager.GetString("InvalidAfterCompleted", resourceCulture); } - - /// - /// Looks up a localized string similar to A lock is required.. - /// - internal static string InvalidWithoutLock { - get { - return ResourceManager.GetString("InvalidWithoutLock", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This operation can only be executed against a valid lock.. + /// + internal static string InvalidLock { + get { + return ResourceManager.GetString("InvalidLock", resourceCulture); } - - /// - /// Looks up a localized string similar to JoinableTask does not belong to the context this collection was instantiated with.. - /// - internal static string JoinableTaskContextAndCollectionMismatch { - get { - return ResourceManager.GetString("JoinableTaskContextAndCollectionMismatch", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to A lock is required.. + /// + internal static string InvalidWithoutLock { + get { + return ResourceManager.GetString("InvalidWithoutLock", resourceCulture); } - - /// - /// Looks up a localized string similar to This node already registered.. - /// - internal static string JoinableTaskContextNodeAlreadyRegistered { - get { - return ResourceManager.GetString("JoinableTaskContextNodeAlreadyRegistered", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to JoinableTask does not belong to the context this collection was instantiated with.. + /// + internal static string JoinableTaskContextAndCollectionMismatch { + get { + return ResourceManager.GetString("JoinableTaskContextAndCollectionMismatch", resourceCulture); } - - /// - /// Looks up a localized string similar to Lazily created value faulted during construction.. - /// - internal static string LazyValueFaulted { - get { - return ResourceManager.GetString("LazyValueFaulted", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This node already registered.. + /// + internal static string JoinableTaskContextNodeAlreadyRegistered { + get { + return ResourceManager.GetString("JoinableTaskContextNodeAlreadyRegistered", resourceCulture); } - - /// - /// Looks up a localized string similar to Lazily created value not yet constructed.. - /// - internal static string LazyValueNotCreated { - get { - return ResourceManager.GetString("LazyValueNotCreated", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Lazily created value faulted during construction.. + /// + internal static string LazyValueFaulted { + get { + return ResourceManager.GetString("LazyValueFaulted", resourceCulture); } - - /// - /// Looks up a localized string similar to This lock has already been marked for completion. No new top-level locks can be serviced.. - /// - internal static string LockCompletionAlreadyRequested { - get { - return ResourceManager.GetString("LockCompletionAlreadyRequested", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Lazily created value not yet constructed.. + /// + internal static string LazyValueNotCreated { + get { + return ResourceManager.GetString("LazyValueNotCreated", resourceCulture); } - - /// - /// Looks up a localized string similar to Multiple continuations are not supported.. - /// - internal static string MultipleContinuationsNotSupported { - get { - return ResourceManager.GetString("MultipleContinuationsNotSupported", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This lock has already been marked for completion. No new top-level locks can be serviced.. + /// + internal static string LockCompletionAlreadyRequested { + get { + return ResourceManager.GetString("LockCompletionAlreadyRequested", resourceCulture); } - - /// - /// Looks up a localized string similar to This operation is not allowed while holding an active upgradeable read or write lock from an AsyncReaderWriterLock.. - /// - internal static string NotAllowedUnderURorWLock { - get { - return ResourceManager.GetString("NotAllowedUnderURorWLock", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Multiple continuations are not supported.. + /// + internal static string MultipleContinuationsNotSupported { + get { + return ResourceManager.GetString("MultipleContinuationsNotSupported", resourceCulture); } - - /// - /// Looks up a localized string similar to Message pump can only be run from the original thread.. - /// - internal static string PushFromWrongThread { - get { - return ResourceManager.GetString("PushFromWrongThread", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This operation is not allowed while holding an active upgradeable read or write lock from an AsyncReaderWriterLock.. + /// + internal static string NotAllowedUnderURorWLock { + get { + return ResourceManager.GetString("NotAllowedUnderURorWLock", resourceCulture); } - - /// - /// Looks up a localized string similar to The queue is empty.. - /// - internal static string QueueEmpty { - get { - return ResourceManager.GetString("QueueEmpty", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Message pump can only be run from the original thread.. + /// + internal static string PushFromWrongThread { + get { + return ResourceManager.GetString("PushFromWrongThread", resourceCulture); } - - /// - /// Looks up a localized string similar to Semaphore is already held and reentrancy setting is '{0}'.. - /// - internal static string SemaphoreAlreadyHeld { - get { - return ResourceManager.GetString("SemaphoreAlreadyHeld", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to The queue is empty.. + /// + internal static string QueueEmpty { + get { + return ResourceManager.GetString("QueueEmpty", resourceCulture); } - - /// - /// Looks up a localized string similar to This semaphore has been misused and can no longer be used.. - /// - internal static string SemaphoreMisused { - get { - return ResourceManager.GetString("SemaphoreMisused", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Semaphore is already held and reentrancy setting is '{0}'.. + /// + internal static string SemaphoreAlreadyHeld { + get { + return ResourceManager.GetString("SemaphoreAlreadyHeld", resourceCulture); } - - /// - /// Looks up a localized string similar to Nested semaphore requests must be released in LIFO order when the reentrancy setting is: '{0}'. - /// - internal static string SemaphoreStackNestingViolated { - get { - return ResourceManager.GetString("SemaphoreStackNestingViolated", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This semaphore has been misused and can no longer be used.. + /// + internal static string SemaphoreMisused { + get { + return ResourceManager.GetString("SemaphoreMisused", resourceCulture); } - - /// - /// Looks up a localized string similar to This operation cannot be completed on an STA thread.. - /// - internal static string STAThreadCallerNotAllowed { - get { - return ResourceManager.GetString("STAThreadCallerNotAllowed", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to Nested semaphore requests must be released in LIFO order when the reentrancy setting is: '{0}'. + /// + internal static string SemaphoreStackNestingViolated { + get { + return ResourceManager.GetString("SemaphoreStackNestingViolated", resourceCulture); } - - /// - /// Looks up a localized string similar to An attempt to switch to the main thread failed to reach the expected thread. Was the JoinableTaskContext initialized on the wrong thread or with a SynchronizationContext whose Post method does not execute its delegate on the main thread?. - /// - internal static string SwitchToMainThreadFailedToReachExpectedThread { - get { - return ResourceManager.GetString("SwitchToMainThreadFailedToReachExpectedThread", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This operation cannot be completed on an STA thread.. + /// + internal static string STAThreadCallerNotAllowed { + get { + return ResourceManager.GetString("STAThreadCallerNotAllowed", resourceCulture); } - - /// - /// Looks up a localized string similar to This frame has already been used with a different instance.. - /// - internal static string SyncContextFrameMismatchedAffinity { - get { - return ResourceManager.GetString("SyncContextFrameMismatchedAffinity", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to An attempt to switch to the main thread failed to reach the expected thread. Was the JoinableTaskContext initialized on the wrong thread or with a SynchronizationContext whose Post method does not execute its delegate on the main thread?. + /// + internal static string SwitchToMainThreadFailedToReachExpectedThread { + get { + return ResourceManager.GetString("SwitchToMainThreadFailedToReachExpectedThread", resourceCulture); } - - /// - /// Looks up a localized string similar to No SynchronizationContext to reach the main thread has been set.. - /// - internal static string SyncContextNotSet { - get { - return ResourceManager.GetString("SyncContextNotSet", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to This frame has already been used with a different instance.. + /// + internal static string SyncContextFrameMismatchedAffinity { + get { + return ResourceManager.GetString("SyncContextFrameMismatchedAffinity", resourceCulture); } - - /// - /// Looks up a localized string similar to The value factory has called for the value on the same instance.. - /// - internal static string ValueFactoryReentrancy { - get { - return ResourceManager.GetString("ValueFactoryReentrancy", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to No SynchronizationContext to reach the main thread has been set.. + /// + internal static string SyncContextNotSet { + get { + return ResourceManager.GetString("SyncContextNotSet", resourceCulture); } - - /// - /// Looks up a localized string similar to Write lock out-lived by a nested read lock, which is not allowed.. - /// - internal static string WriteLockOutlived { - get { - return ResourceManager.GetString("WriteLockOutlived", resourceCulture); - } + } + + /// + /// Looks up a localized string similar to The value factory has called for the value on the same instance.. + /// + internal static string ValueFactoryReentrancy { + get { + return ResourceManager.GetString("ValueFactoryReentrancy", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to Write lock out-lived by a nested read lock, which is not allowed.. + /// + internal static string WriteLockOutlived { + get { + return ResourceManager.GetString("WriteLockOutlived", resourceCulture); } } } diff --git a/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs b/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs index 0e95f8675..5e5002ce2 100644 --- a/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs +++ b/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs @@ -6,59 +6,58 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// A -derivative that +/// does not inline continuations if so configured. +/// +/// The type of the task's resulting value. +internal class TaskCompletionSourceWithoutInlining : TaskCompletionSource { /// - /// A -derivative that - /// does not inline continuations if so configured. + /// The Task that we expose to others that may not inline continuations. /// - /// The type of the task's resulting value. - internal class TaskCompletionSourceWithoutInlining : TaskCompletionSource - { - /// - /// The Task that we expose to others that may not inline continuations. - /// - private readonly Task exposedTask; + private readonly Task exposedTask; - /// - /// Initializes a new instance of the class. - /// - /// - /// to allow continuations to be inlined; otherwise . - /// - /// - /// TaskCreationOptions to pass on to the base constructor. - /// - /// The state to set on the Task. - internal TaskCompletionSourceWithoutInlining(bool allowInliningContinuations, TaskCreationOptions options = TaskCreationOptions.None, object? state = null) - : base(state, AdjustFlags(options, allowInliningContinuations)) - { - this.exposedTask = base.Task; - } + /// + /// Initializes a new instance of the class. + /// + /// + /// to allow continuations to be inlined; otherwise . + /// + /// + /// TaskCreationOptions to pass on to the base constructor. + /// + /// The state to set on the Task. + internal TaskCompletionSourceWithoutInlining(bool allowInliningContinuations, TaskCreationOptions options = TaskCreationOptions.None, object? state = null) + : base(state, AdjustFlags(options, allowInliningContinuations)) + { + this.exposedTask = base.Task; + } - /// - /// Gets the that may never complete inline with completion of this . - /// - /// - /// Return the base.Task if it is already completed since inlining continuations - /// on the completer is no longer a concern. Also, when we are not inlining continuations, - /// this.exposedTask completes slightly later than base.Task, and callers expect - /// the Task we return to be complete as soon as they call TrySetResult. - /// - internal new Task Task => base.Task.IsCompleted ? base.Task : this.exposedTask; + /// + /// Gets the that may never complete inline with completion of this . + /// + /// + /// Return the base.Task if it is already completed since inlining continuations + /// on the completer is no longer a concern. Also, when we are not inlining continuations, + /// this.exposedTask completes slightly later than base.Task, and callers expect + /// the Task we return to be complete as soon as they call TrySetResult. + /// + internal new Task Task => base.Task.IsCompleted ? base.Task : this.exposedTask; - /// - /// Modifies the specified flags to include RunContinuationsAsynchronously - /// if wanted by the caller and supported by the platform. - /// - /// The base options supplied by the caller. - /// to allow inlining continuations. - /// The possibly modified flags. - private static TaskCreationOptions AdjustFlags(TaskCreationOptions options, bool allowInliningContinuations) - { - return allowInliningContinuations - ? (options & ~TaskCreationOptions.RunContinuationsAsynchronously) - : (options | TaskCreationOptions.RunContinuationsAsynchronously); - } + /// + /// Modifies the specified flags to include RunContinuationsAsynchronously + /// if wanted by the caller and supported by the platform. + /// + /// The base options supplied by the caller. + /// to allow inlining continuations. + /// The possibly modified flags. + private static TaskCreationOptions AdjustFlags(TaskCreationOptions options, bool allowInliningContinuations) + { + return allowInliningContinuations + ? (options & ~TaskCreationOptions.RunContinuationsAsynchronously) + : (options | TaskCreationOptions.RunContinuationsAsynchronously); } } diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs index 365ad37c3..890718f74 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs @@ -4,193 +4,192 @@ using System; using System.Diagnostics.Tracing; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// The ETW source for logging events for this library. +/// +/// +/// We use a fully-descriptive type name because the type name becomes the name +/// of the ETW Provider. +/// +[EventSource(Name = "Microsoft-VisualStudio-Threading")] +internal sealed partial class ThreadingEventSource : EventSource { /// - /// The ETW source for logging events for this library. + /// The singleton instance used for logging. /// - /// - /// We use a fully-descriptive type name because the type name becomes the name - /// of the ETW Provider. - /// - [EventSource(Name = "Microsoft-VisualStudio-Threading")] - internal sealed partial class ThreadingEventSource : EventSource + internal static readonly ThreadingEventSource Instance = new ThreadingEventSource(); + + /// + /// The event ID for the event. + /// + private const int ReaderWriterLockIssuedLockCountsEvent = 1; + + /// + /// The event ID for the event. + /// + private const int WaitReaderWriterLockStartEvent = 2; + + /// + /// The event ID for the event. + /// + private const int WaitReaderWriterLockStopEvent = 3; + + /// + /// The event ID for the . + /// + private const int CompleteOnCurrentThreadStartEvent = 11; + + /// + /// The event ID for the . + /// + private const int CompleteOnCurrentThreadStopEvent = 12; + + /// + /// The event ID for the . + /// + private const int WaitSynchronouslyStartEvent = 13; + + /// + /// The event ID for the . + /// + private const int WaitSynchronouslyStopEvent = 14; + + /// + /// The event ID for the . + /// + private const int PostExecutionStartEvent = 15; + + /// + /// The event ID for the . + /// + private const int PostExecutionStopEvent = 16; + + /// + /// The event ID for the . + /// + private const int CircularJoinableTaskDependencyDetectedEvent = 17; + + /// + /// Logs an issued lock. + /// + [Event(ReaderWriterLockIssuedLockCountsEvent, Task = Tasks.LockRequest, Opcode = Opcodes.ReaderWriterLockIssued)] + public void ReaderWriterLockIssued(int lockId, AsyncReaderWriterLock.LockKind kind, int issuedUpgradeableReadCount, int issuedReadCount) + { + this.WriteEvent(ReaderWriterLockIssuedLockCountsEvent, lockId, kind, issuedUpgradeableReadCount, issuedReadCount); + } + + /// + /// Logs a wait for a lock. + /// + [Event(WaitReaderWriterLockStartEvent, Task = Tasks.LockRequestContention, Opcode = EventOpcode.Start)] + public void WaitReaderWriterLockStart(int lockId, AsyncReaderWriterLock.LockKind kind, int issuedWriteCount, int issuedUpgradeableReadCount, int issuedReadCount) + { + this.WriteEvent(WaitReaderWriterLockStartEvent, lockId, kind, issuedWriteCount, issuedUpgradeableReadCount, issuedReadCount); + } + + /// + /// Logs a lock that was issued after a contending lock was released. + /// + [Event(WaitReaderWriterLockStopEvent, Task = Tasks.LockRequestContention, Opcode = EventOpcode.Stop)] + public void WaitReaderWriterLockStop(int lockId, AsyncReaderWriterLock.LockKind kind) + { + this.WriteEvent(WaitReaderWriterLockStopEvent, lockId, kind); + } + + /// + /// Enters a synchronously task. + /// + /// Hash code of the task. + /// Whether the task is on the main thread. + [Event(CompleteOnCurrentThreadStartEvent)] + public void CompleteOnCurrentThreadStart(int taskId, bool isOnMainThread) + { + this.WriteEvent(CompleteOnCurrentThreadStartEvent, taskId, Boxed.Box(isOnMainThread)); + } + + /// + /// Exits a synchronously task. + /// + /// Hash code of the task. + [Event(CompleteOnCurrentThreadStopEvent)] + public void CompleteOnCurrentThreadStop(int taskId) + { + this.WriteEvent(CompleteOnCurrentThreadStopEvent, taskId); + } + + /// + /// The current thread starts to wait on execution requests. + /// + [Event(WaitSynchronouslyStartEvent, Level = EventLevel.Verbose)] + public void WaitSynchronouslyStart() + { + this.WriteEvent(WaitSynchronouslyStartEvent); + } + + /// + /// The current thread gets an execution request. + /// + [Event(WaitSynchronouslyStopEvent, Level = EventLevel.Verbose)] + public void WaitSynchronouslyStop() + { + this.WriteEvent(WaitSynchronouslyStopEvent); + } + + /// + /// Post a execution request to the queue. + /// + /// The request id. + /// The execution need happen on the main thread. + [Event(PostExecutionStartEvent, Level = EventLevel.Verbose)] + public void PostExecutionStart(int requestId, bool mainThreadAffinitized) + { + this.WriteEvent(PostExecutionStartEvent, requestId, Boxed.Box(mainThreadAffinitized)); + } + + /// + /// An execution request is processed. + /// + /// The request id. + [Event(PostExecutionStopEvent, Level = EventLevel.Verbose)] + public void PostExecutionStop(int requestId) + { + this.WriteEvent(PostExecutionStopEvent, requestId); + } + + /// + /// Circular JoinableTask dependency detected. + /// + /// Initial count of unreachable nodes. + /// The size of the connected dependency graph. + [Event(CircularJoinableTaskDependencyDetectedEvent, Level = EventLevel.Informational)] + public void CircularJoinableTaskDependencyDetected(int initUnreachableCount, int reachableCount) + { + this.WriteEvent(CircularJoinableTaskDependencyDetectedEvent, initUnreachableCount, reachableCount); + } + + /// + /// The names of constants in this class make up the middle term in + /// the AsyncReaderWriterLock/LockRequest/Issued event name. + /// + /// The name of this class is important for EventSource. + public static class Tasks + { + public const EventTask LockRequest = (EventTask)1; + public const EventTask LockRequestContention = (EventTask)2; + } + + /// + /// The names of constants in this class make up the last term in + /// the AsyncReaderWriterLock/LockRequest/Issued event name. + /// + /// The name of this class is important for EventSource. + public static class Opcodes { - /// - /// The singleton instance used for logging. - /// - internal static readonly ThreadingEventSource Instance = new ThreadingEventSource(); - - /// - /// The event ID for the event. - /// - private const int ReaderWriterLockIssuedLockCountsEvent = 1; - - /// - /// The event ID for the event. - /// - private const int WaitReaderWriterLockStartEvent = 2; - - /// - /// The event ID for the event. - /// - private const int WaitReaderWriterLockStopEvent = 3; - - /// - /// The event ID for the . - /// - private const int CompleteOnCurrentThreadStartEvent = 11; - - /// - /// The event ID for the . - /// - private const int CompleteOnCurrentThreadStopEvent = 12; - - /// - /// The event ID for the . - /// - private const int WaitSynchronouslyStartEvent = 13; - - /// - /// The event ID for the . - /// - private const int WaitSynchronouslyStopEvent = 14; - - /// - /// The event ID for the . - /// - private const int PostExecutionStartEvent = 15; - - /// - /// The event ID for the . - /// - private const int PostExecutionStopEvent = 16; - - /// - /// The event ID for the . - /// - private const int CircularJoinableTaskDependencyDetectedEvent = 17; - - /// - /// Logs an issued lock. - /// - [Event(ReaderWriterLockIssuedLockCountsEvent, Task = Tasks.LockRequest, Opcode = Opcodes.ReaderWriterLockIssued)] - public void ReaderWriterLockIssued(int lockId, AsyncReaderWriterLock.LockKind kind, int issuedUpgradeableReadCount, int issuedReadCount) - { - this.WriteEvent(ReaderWriterLockIssuedLockCountsEvent, lockId, kind, issuedUpgradeableReadCount, issuedReadCount); - } - - /// - /// Logs a wait for a lock. - /// - [Event(WaitReaderWriterLockStartEvent, Task = Tasks.LockRequestContention, Opcode = EventOpcode.Start)] - public void WaitReaderWriterLockStart(int lockId, AsyncReaderWriterLock.LockKind kind, int issuedWriteCount, int issuedUpgradeableReadCount, int issuedReadCount) - { - this.WriteEvent(WaitReaderWriterLockStartEvent, lockId, kind, issuedWriteCount, issuedUpgradeableReadCount, issuedReadCount); - } - - /// - /// Logs a lock that was issued after a contending lock was released. - /// - [Event(WaitReaderWriterLockStopEvent, Task = Tasks.LockRequestContention, Opcode = EventOpcode.Stop)] - public void WaitReaderWriterLockStop(int lockId, AsyncReaderWriterLock.LockKind kind) - { - this.WriteEvent(WaitReaderWriterLockStopEvent, lockId, kind); - } - - /// - /// Enters a synchronously task. - /// - /// Hash code of the task. - /// Whether the task is on the main thread. - [Event(CompleteOnCurrentThreadStartEvent)] - public void CompleteOnCurrentThreadStart(int taskId, bool isOnMainThread) - { - this.WriteEvent(CompleteOnCurrentThreadStartEvent, taskId, Boxed.Box(isOnMainThread)); - } - - /// - /// Exits a synchronously task. - /// - /// Hash code of the task. - [Event(CompleteOnCurrentThreadStopEvent)] - public void CompleteOnCurrentThreadStop(int taskId) - { - this.WriteEvent(CompleteOnCurrentThreadStopEvent, taskId); - } - - /// - /// The current thread starts to wait on execution requests. - /// - [Event(WaitSynchronouslyStartEvent, Level = EventLevel.Verbose)] - public void WaitSynchronouslyStart() - { - this.WriteEvent(WaitSynchronouslyStartEvent); - } - - /// - /// The current thread gets an execution request. - /// - [Event(WaitSynchronouslyStopEvent, Level = EventLevel.Verbose)] - public void WaitSynchronouslyStop() - { - this.WriteEvent(WaitSynchronouslyStopEvent); - } - - /// - /// Post a execution request to the queue. - /// - /// The request id. - /// The execution need happen on the main thread. - [Event(PostExecutionStartEvent, Level = EventLevel.Verbose)] - public void PostExecutionStart(int requestId, bool mainThreadAffinitized) - { - this.WriteEvent(PostExecutionStartEvent, requestId, Boxed.Box(mainThreadAffinitized)); - } - - /// - /// An execution request is processed. - /// - /// The request id. - [Event(PostExecutionStopEvent, Level = EventLevel.Verbose)] - public void PostExecutionStop(int requestId) - { - this.WriteEvent(PostExecutionStopEvent, requestId); - } - - /// - /// Circular JoinableTask dependency detected. - /// - /// Initial count of unreachable nodes. - /// The size of the connected dependency graph. - [Event(CircularJoinableTaskDependencyDetectedEvent, Level = EventLevel.Informational)] - public void CircularJoinableTaskDependencyDetected(int initUnreachableCount, int reachableCount) - { - this.WriteEvent(CircularJoinableTaskDependencyDetectedEvent, initUnreachableCount, reachableCount); - } - - /// - /// The names of constants in this class make up the middle term in - /// the AsyncReaderWriterLock/LockRequest/Issued event name. - /// - /// The name of this class is important for EventSource. - public static class Tasks - { - public const EventTask LockRequest = (EventTask)1; - public const EventTask LockRequestContention = (EventTask)2; - } - - /// - /// The names of constants in this class make up the last term in - /// the AsyncReaderWriterLock/LockRequest/Issued event name. - /// - /// The name of this class is important for EventSource. - public static class Opcodes - { - // Custom opcodes should range 11 - 239; see http://msdn.microsoft.com/en-us/library/windows/desktop/dd996918(v=vs.85).aspx - public const EventOpcode ReaderWriterLockWaiting = (EventOpcode)100; - public const EventOpcode ReaderWriterLockIssued = (EventOpcode)101; - public const EventOpcode ReaderWriterLockIssuedAfterContention = (EventOpcode)102; - } + // Custom opcodes should range 11 - 239; see http://msdn.microsoft.com/en-us/library/windows/desktop/dd996918(v=vs.85).aspx + public const EventOpcode ReaderWriterLockWaiting = (EventOpcode)100; + public const EventOpcode ReaderWriterLockIssued = (EventOpcode)101; + public const EventOpcode ReaderWriterLockIssuedAfterContention = (EventOpcode)102; } } diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs index 54f78c094..d6d87f01c 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs @@ -5,365 +5,364 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Utility methods for working across threads. +/// +public static class ThreadingTools { + internal interface ICancellationNotification + { + void OnCanceled(); + } + /// - /// Utility methods for working across threads. + /// Optimistically performs some value transformation based on some field and tries to apply it back to the field, + /// retrying as many times as necessary until no other thread is manipulating the same field. /// - public static class ThreadingTools + /// The type of data. + /// The field that may be manipulated by multiple threads. + /// A function that receives the unchanged value and returns the changed value. + /// + /// if the location's value is changed by applying the result of the function; + /// if the location's value remained the same because the last invocation of returned the existing value. + /// + public static bool ApplyChangeOptimistically(ref T hotLocation, Func applyChange) + where T : class? { - internal interface ICancellationNotification - { - void OnCanceled(); - } + Requires.NotNull(applyChange, nameof(applyChange)); - /// - /// Optimistically performs some value transformation based on some field and tries to apply it back to the field, - /// retrying as many times as necessary until no other thread is manipulating the same field. - /// - /// The type of data. - /// The field that may be manipulated by multiple threads. - /// A function that receives the unchanged value and returns the changed value. - /// - /// if the location's value is changed by applying the result of the function; - /// if the location's value remained the same because the last invocation of returned the existing value. - /// - public static bool ApplyChangeOptimistically(ref T hotLocation, Func applyChange) - where T : class? + bool successful; + do { - Requires.NotNull(applyChange, nameof(applyChange)); - - bool successful; - do + T oldValue = Volatile.Read(ref hotLocation); + T newValue = applyChange(oldValue); + if (object.ReferenceEquals(oldValue, newValue)) { - T oldValue = Volatile.Read(ref hotLocation); - T newValue = applyChange(oldValue); - if (object.ReferenceEquals(oldValue, newValue)) - { - // No change was actually required. - return false; - } - - T actualOldValue = Interlocked.CompareExchange(ref hotLocation, newValue, oldValue); - successful = object.ReferenceEquals(oldValue, actualOldValue); + // No change was actually required. + return false; } - while (!successful); - return true; + T actualOldValue = Interlocked.CompareExchange(ref hotLocation, newValue, oldValue); + successful = object.ReferenceEquals(oldValue, actualOldValue); } + while (!successful); - /// - /// Optimistically performs some value transformation based on some field and tries to apply it back to the field, - /// retrying as many times as necessary until no other thread is manipulating the same field. - /// - /// - /// Use this overload when requires a single item, as is common when updating immutable - /// collection types. By passing the item as a method operand, the caller may be able to avoid allocating a closure - /// object for every call. - /// - /// The type of data to apply the change to. - /// The type of argument passed to the . - /// The field that may be manipulated by multiple threads. - /// An argument to pass to . - /// A function that receives both the unchanged value and , then returns the changed value. - /// - /// if the location's value is changed by applying the result of the function; - /// if the location's value remained the same because the last invocation of returned the existing value. - /// - public static bool ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, Func applyChange) - where T : class? - { - Requires.NotNull(applyChange, nameof(applyChange)); + return true; + } - bool successful; - do + /// + /// Optimistically performs some value transformation based on some field and tries to apply it back to the field, + /// retrying as many times as necessary until no other thread is manipulating the same field. + /// + /// + /// Use this overload when requires a single item, as is common when updating immutable + /// collection types. By passing the item as a method operand, the caller may be able to avoid allocating a closure + /// object for every call. + /// + /// The type of data to apply the change to. + /// The type of argument passed to the . + /// The field that may be manipulated by multiple threads. + /// An argument to pass to . + /// A function that receives both the unchanged value and , then returns the changed value. + /// + /// if the location's value is changed by applying the result of the function; + /// if the location's value remained the same because the last invocation of returned the existing value. + /// + public static bool ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, Func applyChange) + where T : class? + { + Requires.NotNull(applyChange, nameof(applyChange)); + + bool successful; + do + { + T oldValue = Volatile.Read(ref hotLocation); + T newValue = applyChange(oldValue, applyChangeArgument); + if (object.ReferenceEquals(oldValue, newValue)) { - T oldValue = Volatile.Read(ref hotLocation); - T newValue = applyChange(oldValue, applyChangeArgument); - if (object.ReferenceEquals(oldValue, newValue)) - { - // No change was actually required. - return false; - } - - T actualOldValue = Interlocked.CompareExchange(ref hotLocation, newValue, oldValue); - successful = object.ReferenceEquals(oldValue, actualOldValue); + // No change was actually required. + return false; } - while (!successful); - return true; + T actualOldValue = Interlocked.CompareExchange(ref hotLocation, newValue, oldValue); + successful = object.ReferenceEquals(oldValue, actualOldValue); } + while (!successful); - /// - /// Wraps a task with one that will complete as cancelled based on a cancellation token, - /// allowing someone to await a task but be able to break out early by cancelling the token. - /// - /// The type of value returned by the task. - /// The task to wrap. - /// The token that can be canceled to break out of the await. - /// The wrapping task. - public static Task WithCancellation(this Task task, CancellationToken cancellationToken) - { - Requires.NotNull(task, nameof(task)); - - if (!cancellationToken.CanBeCanceled || task.IsCompleted) - { - return task; - } + return true; + } - if (cancellationToken.IsCancellationRequested) - { - return Task.FromCanceled(cancellationToken); - } + /// + /// Wraps a task with one that will complete as cancelled based on a cancellation token, + /// allowing someone to await a task but be able to break out early by cancelling the token. + /// + /// The type of value returned by the task. + /// The task to wrap. + /// The token that can be canceled to break out of the await. + /// The wrapping task. + public static Task WithCancellation(this Task task, CancellationToken cancellationToken) + { + Requires.NotNull(task, nameof(task)); - return WithCancellationSlow(task, cancellationToken); + if (!cancellationToken.CanBeCanceled || task.IsCompleted) + { + return task; } - /// - /// Wraps a task with one that will complete as cancelled based on a cancellation token, - /// allowing someone to await a task but be able to break out early by cancelling the token. - /// - /// The task to wrap. - /// The token that can be canceled to break out of the await. - /// The wrapping task. - public static Task WithCancellation(this Task task, CancellationToken cancellationToken) + if (cancellationToken.IsCancellationRequested) { - Requires.NotNull(task, nameof(task)); + return Task.FromCanceled(cancellationToken); + } - if (!cancellationToken.CanBeCanceled || task.IsCompleted) - { - return task; - } + return WithCancellationSlow(task, cancellationToken); + } - if (cancellationToken.IsCancellationRequested) - { - return Task.FromCanceled(cancellationToken); - } + /// + /// Wraps a task with one that will complete as cancelled based on a cancellation token, + /// allowing someone to await a task but be able to break out early by cancelling the token. + /// + /// The task to wrap. + /// The token that can be canceled to break out of the await. + /// The wrapping task. + public static Task WithCancellation(this Task task, CancellationToken cancellationToken) + { + Requires.NotNull(task, nameof(task)); - return WithCancellationSlow(task, continueOnCapturedContext: false, cancellationToken: cancellationToken); + if (!cancellationToken.CanBeCanceled || task.IsCompleted) + { + return task; } - /// - /// Applies the specified to the caller's context. - /// - /// The synchronization context to apply. - /// A value indicating whether to check that the applied SyncContext is still the current one when the original is restored. - public static SpecializedSyncContext Apply(this SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) + if (cancellationToken.IsCancellationRequested) { - return SpecializedSyncContext.Apply(syncContext, checkForChangesOnRevert); + return Task.FromCanceled(cancellationToken); } - /// - /// Wraps a task with one that will complete as cancelled based on a cancellation token, - /// allowing someone to await a task but be able to break out early by cancelling the token. - /// - /// The task to wrap. - /// A value indicating whether *internal* continuations required to respond to cancellation should run on the current . - /// The token that can be canceled to break out of the await. - /// The wrapping task. - internal static Task WithCancellation(this Task task, bool continueOnCapturedContext, CancellationToken cancellationToken) - { - Requires.NotNull(task, nameof(task)); + return WithCancellationSlow(task, continueOnCapturedContext: false, cancellationToken: cancellationToken); + } - if (!cancellationToken.CanBeCanceled || task.IsCompleted) - { - return task; - } + /// + /// Applies the specified to the caller's context. + /// + /// The synchronization context to apply. + /// A value indicating whether to check that the applied SyncContext is still the current one when the original is restored. + public static SpecializedSyncContext Apply(this SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) + { + return SpecializedSyncContext.Apply(syncContext, checkForChangesOnRevert); + } - if (cancellationToken.IsCancellationRequested) - { - return Task.FromCanceled(cancellationToken); - } + /// + /// Wraps a task with one that will complete as cancelled based on a cancellation token, + /// allowing someone to await a task but be able to break out early by cancelling the token. + /// + /// The task to wrap. + /// A value indicating whether *internal* continuations required to respond to cancellation should run on the current . + /// The token that can be canceled to break out of the await. + /// The wrapping task. + internal static Task WithCancellation(this Task task, bool continueOnCapturedContext, CancellationToken cancellationToken) + { + Requires.NotNull(task, nameof(task)); - return WithCancellationSlow(task, continueOnCapturedContext, cancellationToken); + if (!cancellationToken.CanBeCanceled || task.IsCompleted) + { + return task; } - /// - /// Cancels a if a given is canceled. - /// - /// The type of value returned by a successfully completed . - /// The to cancel. - /// The . - /// A callback to invoke when cancellation occurs. - internal static void AttachCancellation(this TaskCompletionSource taskCompletionSource, CancellationToken cancellationToken, ICancellationNotification? cancellationCallback = null) + if (cancellationToken.IsCancellationRequested) { - Requires.NotNull(taskCompletionSource, nameof(taskCompletionSource)); + return Task.FromCanceled(cancellationToken); + } + + return WithCancellationSlow(task, continueOnCapturedContext, cancellationToken); + } + + /// + /// Cancels a if a given is canceled. + /// + /// The type of value returned by a successfully completed . + /// The to cancel. + /// The . + /// A callback to invoke when cancellation occurs. + internal static void AttachCancellation(this TaskCompletionSource taskCompletionSource, CancellationToken cancellationToken, ICancellationNotification? cancellationCallback = null) + { + Requires.NotNull(taskCompletionSource, nameof(taskCompletionSource)); - if (cancellationToken.CanBeCanceled && !taskCompletionSource.Task.IsCompleted) + if (cancellationToken.CanBeCanceled && !taskCompletionSource.Task.IsCompleted) + { + if (cancellationToken.IsCancellationRequested) { - if (cancellationToken.IsCancellationRequested) - { - taskCompletionSource.TrySetCanceled(cancellationToken); - } - else - { - var tuple = new CancelableTaskCompletionSource(taskCompletionSource, cancellationCallback, cancellationToken); - tuple.CancellationTokenRegistration = cancellationToken.Register( - s => + taskCompletionSource.TrySetCanceled(cancellationToken); + } + else + { + var tuple = new CancelableTaskCompletionSource(taskCompletionSource, cancellationCallback, cancellationToken); + tuple.CancellationTokenRegistration = cancellationToken.Register( + s => + { + var t = (CancelableTaskCompletionSource)s!; + if (t.TaskCompletionSource.TrySetCanceled(t.CancellationToken)) + { + t.CancellationCallback?.OnCanceled(); + } + }, + tuple, + useSynchronizationContext: false); + + // In certain race conditions, our continuation could execute inline. We could force it to always run + // asynchronously, but then in the common case it becomes less efficient. + // Instead, we will optimize for the common (no-race) case and detect if we were inlined, and if so, defer the work + // to avoid making our caller block for arbitrary code since CTR.Dispose blocks for in-progress cancellation notification to complete. + taskCompletionSource.Task.ContinueWith( + (_, s) => + { + var t = (CancelableTaskCompletionSource)s!; + if (t.ContinuationScheduled || !t.OnOwnerThread) { - var t = (CancelableTaskCompletionSource)s!; - if (t.TaskCompletionSource.TrySetCanceled(t.CancellationToken)) - { - t.CancellationCallback?.OnCanceled(); - } - }, - tuple, - useSynchronizationContext: false); - - // In certain race conditions, our continuation could execute inline. We could force it to always run - // asynchronously, but then in the common case it becomes less efficient. - // Instead, we will optimize for the common (no-race) case and detect if we were inlined, and if so, defer the work - // to avoid making our caller block for arbitrary code since CTR.Dispose blocks for in-progress cancellation notification to complete. - taskCompletionSource.Task.ContinueWith( - (_, s) => + // We're not executing inline... Go ahead and do the work. + t.CancellationTokenRegistration.Dispose(); + } + else if (!t.CancellationToken.IsCancellationRequested) // If the CT is canceled, the CTR is implicitly disposed. { - var t = (CancelableTaskCompletionSource)s!; - if (t.ContinuationScheduled || !t.OnOwnerThread) - { - // We're not executing inline... Go ahead and do the work. - t.CancellationTokenRegistration.Dispose(); - } - else if (!t.CancellationToken.IsCancellationRequested) // If the CT is canceled, the CTR is implicitly disposed. - { - // We hit the race where the task is already completed another way, - // and our continuation is executing inline with our caller. - // Dispose our CTR from the threadpool to avoid blocking on 3rd party code. - ThreadPool.QueueUserWorkItem( - s2 => + // We hit the race where the task is already completed another way, + // and our continuation is executing inline with our caller. + // Dispose our CTR from the threadpool to avoid blocking on 3rd party code. + ThreadPool.QueueUserWorkItem( + s2 => + { + try { - try - { - var t2 = (CancelableTaskCompletionSource)s2!; - t2.CancellationTokenRegistration.Dispose(); - } - catch (Exception ex) - { - // Swallow any exception. - Report.Fail(ex.Message); - } - }, - s); - } - }, - tuple, - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - tuple.ContinuationScheduled = true; - } + var t2 = (CancelableTaskCompletionSource)s2!; + t2.CancellationTokenRegistration.Dispose(); + } + catch (Exception ex) + { + // Swallow any exception. + Report.Fail(ex.Message); + } + }, + s); + } + }, + tuple, + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); + tuple.ContinuationScheduled = true; } } + } - /// - /// Wraps a task with one that will complete as cancelled based on a cancellation token, - /// allowing someone to await a task but be able to break out early by cancelling the token. - /// - /// The type of value returned by the task. - /// The task to wrap. - /// The token that can be canceled to break out of the await. - /// The wrapping task. - private static async Task WithCancellationSlow(Task task, CancellationToken cancellationToken) - { - Assumes.NotNull(task); - Assumes.True(cancellationToken.CanBeCanceled); + /// + /// Wraps a task with one that will complete as cancelled based on a cancellation token, + /// allowing someone to await a task but be able to break out early by cancelling the token. + /// + /// The type of value returned by the task. + /// The task to wrap. + /// The token that can be canceled to break out of the await. + /// The wrapping task. + private static async Task WithCancellationSlow(Task task, CancellationToken cancellationToken) + { + Assumes.NotNull(task); + Assumes.True(cancellationToken.CanBeCanceled); - var tcs = new TaskCompletionSource(); - using (cancellationToken.Register(s => ((TaskCompletionSource)s!).TrySetResult(true), tcs)) + var tcs = new TaskCompletionSource(); + using (cancellationToken.Register(s => ((TaskCompletionSource)s!).TrySetResult(true), tcs)) + { + if (task != await Task.WhenAny(task, tcs.Task).ConfigureAwait(false)) { - if (task != await Task.WhenAny(task, tcs.Task).ConfigureAwait(false)) - { - cancellationToken.ThrowIfCancellationRequested(); - } + cancellationToken.ThrowIfCancellationRequested(); } - - // Rethrow any fault/cancellation exception, even if we awaited above. - // But if we skipped the above if branch, this will actually yield - // on an incompleted task. - return await task.ConfigureAwait(false); } - /// - /// Wraps a task with one that will complete as cancelled based on a cancellation token, - /// allowing someone to await a task but be able to break out early by cancelling the token. - /// - /// The task to wrap. - /// A value indicating whether *internal* continuations required to respond to cancellation should run on the current . - /// The token that can be canceled to break out of the await. - /// The wrapping task. - private static async Task WithCancellationSlow(this Task task, bool continueOnCapturedContext, CancellationToken cancellationToken) - { - Assumes.NotNull(task); - Assumes.True(cancellationToken.CanBeCanceled); + // Rethrow any fault/cancellation exception, even if we awaited above. + // But if we skipped the above if branch, this will actually yield + // on an incompleted task. + return await task.ConfigureAwait(false); + } + + /// + /// Wraps a task with one that will complete as cancelled based on a cancellation token, + /// allowing someone to await a task but be able to break out early by cancelling the token. + /// + /// The task to wrap. + /// A value indicating whether *internal* continuations required to respond to cancellation should run on the current . + /// The token that can be canceled to break out of the await. + /// The wrapping task. + private static async Task WithCancellationSlow(this Task task, bool continueOnCapturedContext, CancellationToken cancellationToken) + { + Assumes.NotNull(task); + Assumes.True(cancellationToken.CanBeCanceled); - var tcs = new TaskCompletionSource(); - using (cancellationToken.Register(s => ((TaskCompletionSource)s!).TrySetResult(true), tcs)) + var tcs = new TaskCompletionSource(); + using (cancellationToken.Register(s => ((TaskCompletionSource)s!).TrySetResult(true), tcs)) + { + if (task != await Task.WhenAny(task, tcs.Task).ConfigureAwait(continueOnCapturedContext)) { - if (task != await Task.WhenAny(task, tcs.Task).ConfigureAwait(continueOnCapturedContext)) - { - cancellationToken.ThrowIfCancellationRequested(); - } + cancellationToken.ThrowIfCancellationRequested(); } - - // Rethrow any fault/cancellation exception, even if we awaited above. - // But if we skipped the above if branch, this will actually yield - // on an incompleted task. - await task.ConfigureAwait(continueOnCapturedContext); } + // Rethrow any fault/cancellation exception, even if we awaited above. + // But if we skipped the above if branch, this will actually yield + // on an incompleted task. + await task.ConfigureAwait(continueOnCapturedContext); + } + + /// + /// A state object for tracking cancellation and a TaskCompletionSource. + /// + /// The type of value returned from a task. + /// + /// We use this class so that we only allocate one object to support all continuations + /// required for cancellation handling, rather than a special closure and delegate for each one. + /// + private class CancelableTaskCompletionSource + { + /// + /// The ID of the thread on which this instance was created. + /// + private readonly int ownerThreadId = Environment.CurrentManagedThreadId; + /// - /// A state object for tracking cancellation and a TaskCompletionSource. + /// Initializes a new instance of the class. /// - /// The type of value returned from a task. - /// - /// We use this class so that we only allocate one object to support all continuations - /// required for cancellation handling, rather than a special closure and delegate for each one. - /// - private class CancelableTaskCompletionSource + /// The task completion source. + /// A callback to invoke when cancellation occurs. + /// The cancellation token. + internal CancelableTaskCompletionSource(TaskCompletionSource taskCompletionSource, ICancellationNotification? cancellationCallback, CancellationToken cancellationToken) { - /// - /// The ID of the thread on which this instance was created. - /// - private readonly int ownerThreadId = Environment.CurrentManagedThreadId; - - /// - /// Initializes a new instance of the class. - /// - /// The task completion source. - /// A callback to invoke when cancellation occurs. - /// The cancellation token. - internal CancelableTaskCompletionSource(TaskCompletionSource taskCompletionSource, ICancellationNotification? cancellationCallback, CancellationToken cancellationToken) - { - this.TaskCompletionSource = taskCompletionSource ?? throw new ArgumentNullException(nameof(taskCompletionSource)); - this.CancellationToken = cancellationToken; - this.CancellationCallback = cancellationCallback; - } + this.TaskCompletionSource = taskCompletionSource ?? throw new ArgumentNullException(nameof(taskCompletionSource)); + this.CancellationToken = cancellationToken; + this.CancellationCallback = cancellationCallback; + } - /// - /// Gets the cancellation token. - /// - internal CancellationToken CancellationToken { get; } + /// + /// Gets the cancellation token. + /// + internal CancellationToken CancellationToken { get; } - /// - /// Gets the Task completion source. - /// - internal TaskCompletionSource TaskCompletionSource { get; } + /// + /// Gets the Task completion source. + /// + internal TaskCompletionSource TaskCompletionSource { get; } - internal ICancellationNotification? CancellationCallback { get; } + internal ICancellationNotification? CancellationCallback { get; } - /// - /// Gets or sets the cancellation token registration. - /// - internal CancellationTokenRegistration CancellationTokenRegistration { get; set; } + /// + /// Gets or sets the cancellation token registration. + /// + internal CancellationTokenRegistration CancellationTokenRegistration { get; set; } - /// - /// Gets or sets a value indicating whether the continuation has been scheduled (and not run inline). - /// - internal bool ContinuationScheduled { get; set; } + /// + /// Gets or sets a value indicating whether the continuation has been scheduled (and not run inline). + /// + internal bool ContinuationScheduled { get; set; } - /// - /// Gets a value indicating whether the caller is on the same thread as the one that created this instance. - /// - internal bool OnOwnerThread => Environment.CurrentManagedThreadId == this.ownerThreadId; - } + /// + /// Gets a value indicating whether the caller is on the same thread as the one that created this instance. + /// + internal bool OnOwnerThread => Environment.CurrentManagedThreadId == this.ownerThreadId; } } diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index ba9b03b32..b62198fc3 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -8,860 +8,859 @@ using System.Threading; using System.Threading.Tasks; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Extensions to the Task Parallel Library. +/// +public static partial class TplExtensions { /// - /// Extensions to the Task Parallel Library. + /// A singleton completed task. /// - public static partial class TplExtensions - { - /// - /// A singleton completed task. - /// - [Obsolete("Use Task.CompletedTask instead.")] - public static readonly Task CompletedTask = Task.FromResult(default(EmptyStruct)); + [Obsolete("Use Task.CompletedTask instead.")] + public static readonly Task CompletedTask = Task.FromResult(default(EmptyStruct)); - /// - /// A task that is already canceled. - /// - [Obsolete("Use Task.FromCanceled instead.")] - public static readonly Task CanceledTask = Task.FromCanceled(new CancellationToken(canceled: true)); + /// + /// A task that is already canceled. + /// + [Obsolete("Use Task.FromCanceled instead.")] + public static readonly Task CanceledTask = Task.FromCanceled(new CancellationToken(canceled: true)); - /// - /// A completed task with a result. - /// - public static readonly Task TrueTask = Task.FromResult(true); + /// + /// A completed task with a result. + /// + public static readonly Task TrueTask = Task.FromResult(true); - /// - /// A completed task with a result. - /// - public static readonly Task FalseTask = Task.FromResult(false); + /// + /// A completed task with a result. + /// + public static readonly Task FalseTask = Task.FromResult(false); - /// - /// Wait on a task without possibly inlining it to the current thread. - /// - /// The task to wait on. - public static void WaitWithoutInlining(this Task task) + /// + /// Wait on a task without possibly inlining it to the current thread. + /// + /// The task to wait on. + public static void WaitWithoutInlining(this Task task) + { + Requires.NotNull(task, nameof(task)); + if (!task.IsCompleted) { - Requires.NotNull(task, nameof(task)); - if (!task.IsCompleted) - { - // Waiting on a continuation of a task won't ever inline the predecessor (in .NET 4.x anyway). - Task? continuation = task.ContinueWith(t => { }, CancellationToken.None, TaskContinuationOptions.RunContinuationsAsynchronously, TaskScheduler.Default); - continuation.Wait(); - } - - task.Wait(); // purely for exception behavior; alternatively in .NET 4.5 task.GetAwaiter().GetResult(); + // Waiting on a continuation of a task won't ever inline the predecessor (in .NET 4.x anyway). + Task? continuation = task.ContinueWith(t => { }, CancellationToken.None, TaskContinuationOptions.RunContinuationsAsynchronously, TaskScheduler.Default); + continuation.Wait(); } - /// - /// Returns a task that completes as the original task completes or when a timeout expires, - /// whichever happens first. - /// - /// The task to wait for. - /// The maximum time to wait. - /// - /// A task that completes with the result of the specified or - /// faults with a if elapses first. - /// - public static async Task WithTimeout(this Task task, TimeSpan timeout) - { - Requires.NotNull(task, nameof(task)); + task.Wait(); // purely for exception behavior; alternatively in .NET 4.5 task.GetAwaiter().GetResult(); + } + + /// + /// Returns a task that completes as the original task completes or when a timeout expires, + /// whichever happens first. + /// + /// The task to wait for. + /// The maximum time to wait. + /// + /// A task that completes with the result of the specified or + /// faults with a if elapses first. + /// + public static async Task WithTimeout(this Task task, TimeSpan timeout) + { + Requires.NotNull(task, nameof(task)); - using (var timerCancellation = new CancellationTokenSource()) + using (var timerCancellation = new CancellationTokenSource()) + { + Task timeoutTask = Task.Delay(timeout, timerCancellation.Token); + Task firstCompletedTask = await Task.WhenAny(task, timeoutTask).ConfigureAwait(false); + if (firstCompletedTask == timeoutTask) { - Task timeoutTask = Task.Delay(timeout, timerCancellation.Token); - Task firstCompletedTask = await Task.WhenAny(task, timeoutTask).ConfigureAwait(false); - if (firstCompletedTask == timeoutTask) - { - throw new TimeoutException(); - } + throw new TimeoutException(); + } - // The timeout did not elapse, so cancel the timer to recover system resources. - timerCancellation.Cancel(); + // The timeout did not elapse, so cancel the timer to recover system resources. + timerCancellation.Cancel(); - // re-throw any exceptions from the completed task. - await task.ConfigureAwait(false); - } + // re-throw any exceptions from the completed task. + await task.ConfigureAwait(false); } + } - /// - /// Returns a task that completes as the original task completes or when a timeout expires, - /// whichever happens first. - /// - /// The type of value returned by the original task. - /// The task to wait for. - /// The maximum time to wait. - /// - /// A task that completes with the result of the specified or - /// faults with a if elapses first. - /// - public static async Task WithTimeout(this Task task, TimeSpan timeout) - { - await WithTimeout((Task)task, timeout).ConfigureAwait(false); - return task.GetAwaiter().GetResult(); - } + /// + /// Returns a task that completes as the original task completes or when a timeout expires, + /// whichever happens first. + /// + /// The type of value returned by the original task. + /// The task to wait for. + /// The maximum time to wait. + /// + /// A task that completes with the result of the specified or + /// faults with a if elapses first. + /// + public static async Task WithTimeout(this Task task, TimeSpan timeout) + { + await WithTimeout((Task)task, timeout).ConfigureAwait(false); + return task.GetAwaiter().GetResult(); + } - /// - /// Applies one task's results to another. - /// - /// The type of value returned by a task. - /// The task whose completion should be applied to another. - /// The task that should receive the completion status. - public static void ApplyResultTo(this Task task, TaskCompletionSource tcs) - { - ApplyResultTo(task, tcs, inlineSubsequentCompletion: true); - } + /// + /// Applies one task's results to another. + /// + /// The type of value returned by a task. + /// The task whose completion should be applied to another. + /// The task that should receive the completion status. + public static void ApplyResultTo(this Task task, TaskCompletionSource tcs) + { + ApplyResultTo(task, tcs, inlineSubsequentCompletion: true); + } - /// - /// Applies one task's results to another. - /// - /// The type of value returned by a task. - /// The task whose completion should be applied to another. - /// The task that should receive the completion status. - public static void ApplyResultTo(this Task task, TaskCompletionSource tcs) - //// where T : defaultable - { - Requires.NotNull(task, nameof(task)); - Requires.NotNull(tcs, nameof(tcs)); + /// + /// Applies one task's results to another. + /// + /// The type of value returned by a task. + /// The task whose completion should be applied to another. + /// The task that should receive the completion status. + public static void ApplyResultTo(this Task task, TaskCompletionSource tcs) + //// where T : defaultable + { + Requires.NotNull(task, nameof(task)); + Requires.NotNull(tcs, nameof(tcs)); - if (task.IsCompleted) - { - ApplyCompletedTaskResultTo(task, tcs, default(T)!); - } - else - { - // Using a minimum of allocations (just one task, and no closure) ensure that one task's completion sets equivalent completion on another task. - task.ContinueWith( - (t, s) => ApplyCompletedTaskResultTo(t, (TaskCompletionSource)s!, default(T)!), - tcs, - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } + if (task.IsCompleted) + { + ApplyCompletedTaskResultTo(task, tcs, default(T)!); } - - /// - /// Creates a task that is attached to the parent task, but produces the same result as an existing task. - /// - /// The type of value produced by the task. - /// The task to wrap with an AttachedToParent task. - /// A task that is attached to parent. - public static Task AttachToParent(this Task task) + else { - Requires.NotNull(task, nameof(task)); - - var tcs = new TaskCompletionSource(TaskCreationOptions.AttachedToParent); - task.ApplyResultTo(tcs); - return tcs.Task; + // Using a minimum of allocations (just one task, and no closure) ensure that one task's completion sets equivalent completion on another task. + task.ContinueWith( + (t, s) => ApplyCompletedTaskResultTo(t, (TaskCompletionSource)s!, default(T)!), + tcs, + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); } + } - /// - /// Creates a task that is attached to the parent task, but produces the same result as an existing task. - /// - /// The task to wrap with an AttachedToParent task. - /// A task that is attached to parent. - public static Task AttachToParent(this Task task) - { - Requires.NotNull(task, nameof(task)); + /// + /// Creates a task that is attached to the parent task, but produces the same result as an existing task. + /// + /// The type of value produced by the task. + /// The task to wrap with an AttachedToParent task. + /// A task that is attached to parent. + public static Task AttachToParent(this Task task) + { + Requires.NotNull(task, nameof(task)); - var tcs = new TaskCompletionSource(TaskCreationOptions.AttachedToParent); - task.ApplyResultTo(tcs); - return tcs.Task; - } + var tcs = new TaskCompletionSource(TaskCreationOptions.AttachedToParent); + task.ApplyResultTo(tcs); + return tcs.Task; + } - /// - /// Schedules some action for execution at the conclusion of a task, regardless of the task's outcome. - /// - /// The task that should complete before the posted is invoked. - /// The action to execute after has completed. - /// The task continuation options to apply. - /// The cancellation token that signals the continuation should not execute (if it has not already begun). - /// - /// The task that will execute the action. - /// - public static Task AppendAction(this Task task, Action action, TaskContinuationOptions options = TaskContinuationOptions.None, CancellationToken cancellation = default(CancellationToken)) - { - Requires.NotNull(task, nameof(task)); - Requires.NotNull(action, nameof(action)); + /// + /// Creates a task that is attached to the parent task, but produces the same result as an existing task. + /// + /// The task to wrap with an AttachedToParent task. + /// A task that is attached to parent. + public static Task AttachToParent(this Task task) + { + Requires.NotNull(task, nameof(task)); - return task.ContinueWith((t, state) => ((Action)state!)(), action, cancellation, options, TaskScheduler.Default); - } + var tcs = new TaskCompletionSource(TaskCreationOptions.AttachedToParent); + task.ApplyResultTo(tcs); + return tcs.Task; + } - /// - /// Gets a task that will eventually produce the result of another task, when that task finishes. - /// If that task is instead canceled, its successor will be followed for its result, iteratively. - /// - /// The type of value returned by the task. - /// The task whose result should be returned by the following task. - /// A token whose cancellation signals that the following task should be cancelled. - /// The TaskCompletionSource whose task is to follow. Leave at for a new task to be created. - /// The following task. - public static Task FollowCancelableTaskToCompletion(Func> taskToFollow, CancellationToken ultimateCancellation, TaskCompletionSource? taskThatFollows = null) - { - Requires.NotNull(taskToFollow, nameof(taskToFollow)); + /// + /// Schedules some action for execution at the conclusion of a task, regardless of the task's outcome. + /// + /// The task that should complete before the posted is invoked. + /// The action to execute after has completed. + /// The task continuation options to apply. + /// The cancellation token that signals the continuation should not execute (if it has not already begun). + /// + /// The task that will execute the action. + /// + public static Task AppendAction(this Task task, Action action, TaskContinuationOptions options = TaskContinuationOptions.None, CancellationToken cancellation = default(CancellationToken)) + { + Requires.NotNull(task, nameof(task)); + Requires.NotNull(action, nameof(action)); - var tcs = new TaskCompletionSource, T>( - new FollowCancelableTaskState(taskToFollow, ultimateCancellation)); + return task.ContinueWith((t, state) => ((Action)state!)(), action, cancellation, options, TaskScheduler.Default); + } - if (ultimateCancellation.CanBeCanceled) - { - CancellationTokenRegistration registeredCallback = ultimateCancellation.Register( - state => - { - var tuple = (Tuple, T>, CancellationToken>)state!; - tuple.Item1.TrySetCanceled(tuple.Item2); - }, - Tuple.Create(tcs, ultimateCancellation)); - tcs.SourceState = tcs.SourceState.WithRegisteredCallback(registeredCallback); - } + /// + /// Gets a task that will eventually produce the result of another task, when that task finishes. + /// If that task is instead canceled, its successor will be followed for its result, iteratively. + /// + /// The type of value returned by the task. + /// The task whose result should be returned by the following task. + /// A token whose cancellation signals that the following task should be cancelled. + /// The TaskCompletionSource whose task is to follow. Leave at for a new task to be created. + /// The following task. + public static Task FollowCancelableTaskToCompletion(Func> taskToFollow, CancellationToken ultimateCancellation, TaskCompletionSource? taskThatFollows = null) + { + Requires.NotNull(taskToFollow, nameof(taskToFollow)); - FollowCancelableTaskToCompletionHelper(tcs, taskToFollow()); + var tcs = new TaskCompletionSource, T>( + new FollowCancelableTaskState(taskToFollow, ultimateCancellation)); - if (taskThatFollows is null) - { - return tcs.Task; - } - else - { - tcs.Task.ApplyResultTo(taskThatFollows); - return taskThatFollows.Task; - } + if (ultimateCancellation.CanBeCanceled) + { + CancellationTokenRegistration registeredCallback = ultimateCancellation.Register( + state => + { + var tuple = (Tuple, T>, CancellationToken>)state!; + tuple.Item1.TrySetCanceled(tuple.Item2); + }, + Tuple.Create(tcs, ultimateCancellation)); + tcs.SourceState = tcs.SourceState.WithRegisteredCallback(registeredCallback); } - /// - /// Returns an awaitable for the specified task that will never throw, even if the source task - /// faults or is canceled. - /// - /// The task whose completion should signal the completion of the returned awaitable. - /// if set to the continuation will be scheduled on the caller's context; to always execute the continuation on the threadpool. - /// An awaitable. - public static NoThrowTaskAwaitable NoThrowAwaitable(this Task task, bool captureContext = true) + FollowCancelableTaskToCompletionHelper(tcs, taskToFollow()); + + if (taskThatFollows is null) { - return new NoThrowTaskAwaitable(task, captureContext); + return tcs.Task; } - - /// - /// Consumes a task and doesn't do anything with it. Useful for fire-and-forget calls to async methods within async methods. - /// - /// The task whose result is to be ignored. - public static void Forget(this Task? task) + else { + tcs.Task.ApplyResultTo(taskThatFollows); + return taskThatFollows.Task; } + } - /// - /// Consumes a and allows it to be recycled, if applicable. Useful for fire-and-forget calls to async methods within async methods. - /// NOTE: APIs should not generally return if callers aren't 99.9999% likely to await the result immediately. - /// - /// The task whose result is to be ignored. - public static void Forget(this ValueTask task) => task.Preserve(); + /// + /// Returns an awaitable for the specified task that will never throw, even if the source task + /// faults or is canceled. + /// + /// The task whose completion should signal the completion of the returned awaitable. + /// if set to the continuation will be scheduled on the caller's context; to always execute the continuation on the threadpool. + /// An awaitable. + public static NoThrowTaskAwaitable NoThrowAwaitable(this Task task, bool captureContext = true) + { + return new NoThrowTaskAwaitable(task, captureContext); + } - /// - /// Consumes a ValueTask and allows it to be recycled, if applicable. Useful for fire-and-forget calls to async methods within async methods. - /// NOTE: APIs should not generally return if callers aren't 99.9999% likely to await the result immediately. - /// - /// The type of value produced by the . - /// The task whose result is to be ignored. - public static void Forget(this ValueTask task) => task.Preserve(); + /// + /// Consumes a task and doesn't do anything with it. Useful for fire-and-forget calls to async methods within async methods. + /// + /// The task whose result is to be ignored. + public static void Forget(this Task? task) + { + } - /// - /// Invokes asynchronous event handlers, returning a task that completes when all event handlers have been invoked. - /// Each handler is fully executed (including continuations) before the next handler in the list is invoked. - /// - /// The event handlers. May be . - /// The event source. - /// The event argument. - /// The task that completes when all handlers have completed. - /// Thrown if any handlers fail. It contains a collection of all failures. - public static async Task InvokeAsync(this AsyncEventHandler? handlers, object? sender, EventArgs args) - { - if (handlers is object) + /// + /// Consumes a and allows it to be recycled, if applicable. Useful for fire-and-forget calls to async methods within async methods. + /// NOTE: APIs should not generally return if callers aren't 99.9999% likely to await the result immediately. + /// + /// The task whose result is to be ignored. + public static void Forget(this ValueTask task) => task.Preserve(); + + /// + /// Consumes a ValueTask and allows it to be recycled, if applicable. Useful for fire-and-forget calls to async methods within async methods. + /// NOTE: APIs should not generally return if callers aren't 99.9999% likely to await the result immediately. + /// + /// The type of value produced by the . + /// The task whose result is to be ignored. + public static void Forget(this ValueTask task) => task.Preserve(); + + /// + /// Invokes asynchronous event handlers, returning a task that completes when all event handlers have been invoked. + /// Each handler is fully executed (including continuations) before the next handler in the list is invoked. + /// + /// The event handlers. May be . + /// The event source. + /// The event argument. + /// The task that completes when all handlers have completed. + /// Thrown if any handlers fail. It contains a collection of all failures. + public static async Task InvokeAsync(this AsyncEventHandler? handlers, object? sender, EventArgs args) + { + if (handlers is object) + { + Delegate[]? individualHandlers = handlers.GetInvocationList(); + List? exceptions = null; + foreach (AsyncEventHandler handler in individualHandlers) { - Delegate[]? individualHandlers = handlers.GetInvocationList(); - List? exceptions = null; - foreach (AsyncEventHandler handler in individualHandlers) + try + { + await handler(sender, args).ConfigureAwait(true); + } + catch (Exception ex) { - try + if (exceptions is null) { - await handler(sender, args).ConfigureAwait(true); + exceptions = new List(2); } - catch (Exception ex) - { - if (exceptions is null) - { - exceptions = new List(2); - } - exceptions.Add(ex); - } + exceptions.Add(ex); } + } - if (exceptions is object) - { - throw new AggregateException(exceptions); - } + if (exceptions is object) + { + throw new AggregateException(exceptions); } } + } - /// - /// Invokes asynchronous event handlers, returning a task that completes when all event handlers have been invoked. - /// Each handler is fully executed (including continuations) before the next handler in the list is invoked. - /// - /// The type of argument passed to each handler. - /// The event handlers. May be . - /// The event source. - /// The event argument. - /// The task that completes when all handlers have completed. The task is faulted if any handlers throw an exception. - /// Thrown if any handlers fail. It contains a collection of all failures. - public static async Task InvokeAsync(this AsyncEventHandler? handlers, object? sender, TEventArgs args) - { - if (handlers is object) + /// + /// Invokes asynchronous event handlers, returning a task that completes when all event handlers have been invoked. + /// Each handler is fully executed (including continuations) before the next handler in the list is invoked. + /// + /// The type of argument passed to each handler. + /// The event handlers. May be . + /// The event source. + /// The event argument. + /// The task that completes when all handlers have completed. The task is faulted if any handlers throw an exception. + /// Thrown if any handlers fail. It contains a collection of all failures. + public static async Task InvokeAsync(this AsyncEventHandler? handlers, object? sender, TEventArgs args) + { + if (handlers is object) + { + Delegate[]? individualHandlers = handlers.GetInvocationList(); + List? exceptions = null; + foreach (AsyncEventHandler handler in individualHandlers) { - Delegate[]? individualHandlers = handlers.GetInvocationList(); - List? exceptions = null; - foreach (AsyncEventHandler handler in individualHandlers) + try { - try + await handler(sender, args).ConfigureAwait(true); + } + catch (Exception ex) + { + if (exceptions is null) { - await handler(sender, args).ConfigureAwait(true); + exceptions = new List(2); } - catch (Exception ex) - { - if (exceptions is null) - { - exceptions = new List(2); - } - exceptions.Add(ex); - } + exceptions.Add(ex); } + } - if (exceptions is object) - { - throw new AggregateException(exceptions); - } + if (exceptions is object) + { + throw new AggregateException(exceptions); } } + } - /// - /// Converts a TPL task to the APM Begin-End pattern. - /// - /// The result value to be returned from the End method. - /// The task that came from the async method. - /// The optional callback to invoke when the task is completed. - /// The state object provided by the caller of the Begin method. - /// A task (that implements that should be returned from the Begin method. - public static Task ToApm(this Task task, AsyncCallback? callback, object? state) + /// + /// Converts a TPL task to the APM Begin-End pattern. + /// + /// The result value to be returned from the End method. + /// The task that came from the async method. + /// The optional callback to invoke when the task is completed. + /// The state object provided by the caller of the Begin method. + /// A task (that implements that should be returned from the Begin method. + public static Task ToApm(this Task task, AsyncCallback? callback, object? state) + { + Requires.NotNull(task, nameof(task)); + + if (task.AsyncState == state) { - Requires.NotNull(task, nameof(task)); + if (callback is object) + { + task.ContinueWith( + (t, cb) => ((AsyncCallback)cb!)(t), + callback, + CancellationToken.None, + TaskContinuationOptions.None, + TaskScheduler.Default); + } - if (task.AsyncState == state) + return task; + } + + var tcs = new TaskCompletionSource(state); + task.ContinueWith( + t => { - if (callback is object) - { - task.ContinueWith( - (t, cb) => ((AsyncCallback)cb!)(t), - callback, - CancellationToken.None, - TaskContinuationOptions.None, - TaskScheduler.Default); - } + ApplyCompletedTaskResultTo(t, tcs); - return task; + callback?.Invoke(tcs.Task); + }, + CancellationToken.None, + TaskContinuationOptions.None, + TaskScheduler.Default); + + return tcs.Task; + } + + /// + /// Converts a TPL task to the APM Begin-End pattern. + /// + /// The task that came from the async method. + /// The optional callback to invoke when the task is completed. + /// The state object provided by the caller of the Begin method. + /// A task (that implements that should be returned from the Begin method. + public static Task ToApm(this Task task, AsyncCallback? callback, object? state) + { + Requires.NotNull(task, nameof(task)); + + if (task.AsyncState == state) + { + if (callback is object) + { + task.ContinueWith( + (t, cb) => ((AsyncCallback)cb!)(t), + callback, + CancellationToken.None, + TaskContinuationOptions.None, + TaskScheduler.Default); } - var tcs = new TaskCompletionSource(state); - task.ContinueWith( - t => - { - ApplyCompletedTaskResultTo(t, tcs); + return task; + } - callback?.Invoke(tcs.Task); - }, - CancellationToken.None, - TaskContinuationOptions.None, - TaskScheduler.Default); + var tcs = new TaskCompletionSource(state); + task.ContinueWith( + t => + { + ApplyCompletedTaskResultTo(t, tcs, null); - return tcs.Task; + callback?.Invoke(tcs.Task); + }, + CancellationToken.None, + TaskContinuationOptions.None, + TaskScheduler.Default); + + return tcs.Task; + } + + /// + /// Creates a TPL Task that returns when a is signaled or returns if a timeout occurs first. + /// + /// The handle whose signal triggers the task to be completed. Do not use a here. + /// The timeout (in milliseconds) after which the task will return if the handle is not signaled by that time. + /// A token whose cancellation will cause the returned Task to immediately complete in a canceled state. + /// + /// A Task that completes when the handle is signaled or times out, or when the caller's cancellation token is canceled. + /// If the task completes because the handle is signaled, the task's result is . + /// If the task completes because the handle is not signaled prior to the timeout, the task's result is . + /// + /// + /// The completion of the returned task is asynchronous with respect to the code that actually signals the wait handle. + /// + public static Task ToTask(this WaitHandle handle, int timeout = Timeout.Infinite, CancellationToken cancellationToken = default(CancellationToken)) + { + Requires.NotNull(handle, nameof(handle)); + + // Check whether the handle is already signaled as an optimization. + // But even for WaitOne(0) the CLR can pump messages if called on the UI thread, which the caller may not + // be expecting at this time, so be sure there is no message pump active by controlling the SynchronizationContext. + using (NoMessagePumpSyncContext.Default.Apply()) + { + if (handle.WaitOne(0)) + { + return TrueTask; + } + else if (timeout == 0) + { + return FalseTask; + } } - /// - /// Converts a TPL task to the APM Begin-End pattern. - /// - /// The task that came from the async method. - /// The optional callback to invoke when the task is completed. - /// The state object provided by the caller of the Begin method. - /// A task (that implements that should be returned from the Begin method. - public static Task ToApm(this Task task, AsyncCallback? callback, object? state) + cancellationToken.ThrowIfCancellationRequested(); + var tcs = new TaskCompletionSource(); + + RegisteredWaitHandle callbackHandle = ThreadPool.RegisterWaitForSingleObject( + handle, + static (state, timedOut) => ((TaskCompletionSource)state!).TrySetResult(!timedOut), + state: tcs, + millisecondsTimeOutInterval: timeout, + executeOnlyOnce: true); + + if (cancellationToken.CanBeCanceled) { - Requires.NotNull(task, nameof(task)); + // Arrange that if the caller signals their cancellation token that we complete the task + // we return immediately. Because of the continuation we've scheduled on that task, this + // will automatically release the wait handle notification as well. + CancellationTokenRegistration cancellationRegistration = + cancellationToken.Register( + static state => + { + var tuple = (Tuple, CancellationToken>)state!; + tuple.Item1.TrySetCanceled(tuple.Item2); + }, + Tuple.Create(tcs, cancellationToken)); - if (task.AsyncState == state) - { - if (callback is object) + // We have a cancellation token registration and a wait handle registration to release. + // Each time this code executes, allocate one tuple as a state object to reduce from allocating an implicit closure *and* a delegate. + tcs.Task.ContinueWith( + static (_, state) => { - task.ContinueWith( - (t, cb) => ((AsyncCallback)cb!)(t), - callback, - CancellationToken.None, - TaskContinuationOptions.None, - TaskScheduler.Default); - } + var tuple = (Tuple)state!; + tuple.Item1.Unregister(null); // release resources for the async callback + tuple.Item2.Dispose(); // release memory for cancellation token registration + }, + Tuple.Create(callbackHandle, cancellationRegistration), + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); + } + else + { + // Since the cancellation token was the default one, the only thing we need to track is clearing the RegisteredWaitHandle, + // so do this such that we allocate as few objects as possible. + tcs.Task.ContinueWith( + static (_, state) => ((RegisteredWaitHandle)state!).Unregister(null), + callbackHandle, + CancellationToken.None, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); + } - return task; - } + return tcs.Task; + } - var tcs = new TaskCompletionSource(state); - task.ContinueWith( - t => - { - ApplyCompletedTaskResultTo(t, tcs, null); + /// + /// Applies one task's results to another. + /// + /// The type of value returned by a task. + /// The task whose completion should be applied to another. + /// The task that should receive the completion status. + /// + /// to complete the supplied as efficiently as possible (inline with the completion of ); + /// to complete the asynchronously. + /// Note if is completed when this method is invoked, then is always completed synchronously. + /// + internal static void ApplyResultTo(this Task task, TaskCompletionSource tcs, bool inlineSubsequentCompletion) + { + Requires.NotNull(task, nameof(task)); + Requires.NotNull(tcs, nameof(tcs)); - callback?.Invoke(tcs.Task); - }, + if (task.IsCompleted) + { + ApplyCompletedTaskResultTo(task, tcs); + } + else + { + // Using a minimum of allocations (just one task, and no closure) ensure that one task's completion sets equivalent completion on another task. + task.ContinueWith( + (t, s) => ApplyCompletedTaskResultTo(t, (TaskCompletionSource)s!), + tcs, CancellationToken.None, - TaskContinuationOptions.None, + inlineSubsequentCompletion ? TaskContinuationOptions.ExecuteSynchronously : TaskContinuationOptions.None, TaskScheduler.Default); + } + } - return tcs.Task; + /// + /// Returns a reusable task that is already canceled. + /// + /// The type parameter for the returned task. + internal static Task CanceledTaskOfT() => CanceledTaskOfTCache.CanceledTask; + + /// + /// Returns a that has been faulted with the specified exception. + /// + /// The type of value that might have been returned from the . + /// The exception used to fault the . + /// The faulted task. + internal static Task FaultedTask(Exception ex) + { + return Task.FromException(ex); + } + + /// + /// Applies a completed task's results to another. + /// + /// The type of value returned by a task. + /// The task whose completion should be applied to another. + /// The task that should receive the completion status. + private static void ApplyCompletedTaskResultTo(Task completedTask, TaskCompletionSource taskCompletionSource) + { + Assumes.NotNull(completedTask); + Assumes.True(completedTask.IsCompleted); + Assumes.NotNull(taskCompletionSource); + + if (completedTask.IsCanceled) + { + // NOTE: this is "lossy" in that we don't propagate any CancellationToken that the Task would throw an OperationCanceledException with. + // Propagating that data would require that we actually cause the completedTask to throw so we can inspect the + // OperationCanceledException.CancellationToken property, which we consider more costly than it's worth. + taskCompletionSource.TrySetCanceled(); + } + else if (completedTask.IsFaulted) + { + taskCompletionSource.TrySetException(completedTask.Exception!.InnerExceptions); + } + else + { + taskCompletionSource.TrySetResult(completedTask.Result); } + } - /// - /// Creates a TPL Task that returns when a is signaled or returns if a timeout occurs first. - /// - /// The handle whose signal triggers the task to be completed. Do not use a here. - /// The timeout (in milliseconds) after which the task will return if the handle is not signaled by that time. - /// A token whose cancellation will cause the returned Task to immediately complete in a canceled state. - /// - /// A Task that completes when the handle is signaled or times out, or when the caller's cancellation token is canceled. - /// If the task completes because the handle is signaled, the task's result is . - /// If the task completes because the handle is not signaled prior to the timeout, the task's result is . - /// - /// - /// The completion of the returned task is asynchronous with respect to the code that actually signals the wait handle. - /// - public static Task ToTask(this WaitHandle handle, int timeout = Timeout.Infinite, CancellationToken cancellationToken = default(CancellationToken)) - { - Requires.NotNull(handle, nameof(handle)); - - // Check whether the handle is already signaled as an optimization. - // But even for WaitOne(0) the CLR can pump messages if called on the UI thread, which the caller may not - // be expecting at this time, so be sure there is no message pump active by controlling the SynchronizationContext. - using (NoMessagePumpSyncContext.Default.Apply()) + /// + /// Applies a completed task's results to another. + /// + /// The type of value returned by a task. + /// The task whose completion should be applied to another. + /// The task that should receive the completion status. + /// The value to set on the completion source when the source task runs to completion. + private static void ApplyCompletedTaskResultTo(Task completedTask, TaskCompletionSource taskCompletionSource, T valueOnRanToCompletion) + { + Assumes.NotNull(completedTask); + Assumes.True(completedTask.IsCompleted); + Assumes.NotNull(taskCompletionSource); + + if (completedTask.IsCanceled) + { + // NOTE: this is "lossy" in that we don't propagate any CancellationToken that the Task would throw an OperationCanceledException with. + // Propagating that data would require that we actually cause the completedTask to throw so we can inspect the + // OperationCanceledException.CancellationToken property, which we consider more costly than it's worth. + taskCompletionSource.TrySetCanceled(); + } + else if (completedTask.IsFaulted) + { + taskCompletionSource.TrySetException(completedTask.Exception!.InnerExceptions); + } + else + { + taskCompletionSource.TrySetResult(valueOnRanToCompletion); + } + } + + /// + /// Gets a task that will eventually produce the result of another task, when that task finishes. + /// If that task is instead canceled, its successor will be followed for its result, iteratively. + /// + /// The type of value returned by the task. + /// The TaskCompletionSource whose task is to follow. + /// The current task. + /// + /// The following task. + /// + private static Task FollowCancelableTaskToCompletionHelper(TaskCompletionSource, T> tcs, Task currentTask) + { + Requires.NotNull(tcs, nameof(tcs)); + Requires.NotNull(currentTask, nameof(currentTask)); + + currentTask.ContinueWith( + (t, state) => { - if (handle.WaitOne(0)) - { - return TrueTask; - } - else if (timeout == 0) + var tcsNested = (TaskCompletionSource, T>)state!; + switch (t.Status) { - return FalseTask; + case TaskStatus.RanToCompletion: + tcsNested.TrySetResult(t.Result); + tcsNested.SourceState.RegisteredCallback.Dispose(); + break; + case TaskStatus.Faulted: + tcsNested.TrySetException(t.Exception!.InnerExceptions); + tcsNested.SourceState.RegisteredCallback.Dispose(); + break; + case TaskStatus.Canceled: + Task? newTask = tcsNested.SourceState.CurrentTask; + Assumes.True(newTask != t, "A canceled task was not replaced with a new task."); + FollowCancelableTaskToCompletionHelper(tcsNested, newTask); + break; } - } + }, + tcs, + tcs.SourceState.UltimateCancellation, + TaskContinuationOptions.ExecuteSynchronously, + TaskScheduler.Default); - cancellationToken.ThrowIfCancellationRequested(); - var tcs = new TaskCompletionSource(); - - RegisteredWaitHandle callbackHandle = ThreadPool.RegisterWaitForSingleObject( - handle, - static (state, timedOut) => ((TaskCompletionSource)state!).TrySetResult(!timedOut), - state: tcs, - millisecondsTimeOutInterval: timeout, - executeOnlyOnce: true); + return tcs.Task; + } - if (cancellationToken.CanBeCanceled) - { - // Arrange that if the caller signals their cancellation token that we complete the task - // we return immediately. Because of the continuation we've scheduled on that task, this - // will automatically release the wait handle notification as well. - CancellationTokenRegistration cancellationRegistration = - cancellationToken.Register( - static state => - { - var tuple = (Tuple, CancellationToken>)state!; - tuple.Item1.TrySetCanceled(tuple.Item2); - }, - Tuple.Create(tcs, cancellationToken)); - - // We have a cancellation token registration and a wait handle registration to release. - // Each time this code executes, allocate one tuple as a state object to reduce from allocating an implicit closure *and* a delegate. - tcs.Task.ContinueWith( - static (_, state) => - { - var tuple = (Tuple)state!; - tuple.Item1.Unregister(null); // release resources for the async callback - tuple.Item2.Dispose(); // release memory for cancellation token registration - }, - Tuple.Create(callbackHandle, cancellationRegistration), - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } - else - { - // Since the cancellation token was the default one, the only thing we need to track is clearing the RegisteredWaitHandle, - // so do this such that we allocate as few objects as possible. - tcs.Task.ContinueWith( - static (_, state) => ((RegisteredWaitHandle)state!).Unregister(null), - callbackHandle, - CancellationToken.None, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - } + /// + /// An awaitable that wraps a task and never throws an exception when waited on. + /// + public readonly struct NoThrowTaskAwaitable + { + /// + /// The task. + /// + private readonly Task task; - return tcs.Task; - } + /// + /// A value indicating whether the continuation should be scheduled on the current sync context. + /// + private readonly bool captureContext; /// - /// Applies one task's results to another. + /// Initializes a new instance of the struct. /// - /// The type of value returned by a task. - /// The task whose completion should be applied to another. - /// The task that should receive the completion status. - /// - /// to complete the supplied as efficiently as possible (inline with the completion of ); - /// to complete the asynchronously. - /// Note if is completed when this method is invoked, then is always completed synchronously. - /// - internal static void ApplyResultTo(this Task task, TaskCompletionSource tcs, bool inlineSubsequentCompletion) + /// The task. + /// Whether the continuation should be scheduled on the current sync context. + public NoThrowTaskAwaitable(Task task, bool captureContext) { Requires.NotNull(task, nameof(task)); - Requires.NotNull(tcs, nameof(tcs)); + this.task = task; + this.captureContext = captureContext; + } - if (task.IsCompleted) - { - ApplyCompletedTaskResultTo(task, tcs); - } - else - { - // Using a minimum of allocations (just one task, and no closure) ensure that one task's completion sets equivalent completion on another task. - task.ContinueWith( - (t, s) => ApplyCompletedTaskResultTo(t, (TaskCompletionSource)s!), - tcs, - CancellationToken.None, - inlineSubsequentCompletion ? TaskContinuationOptions.ExecuteSynchronously : TaskContinuationOptions.None, - TaskScheduler.Default); - } + /// + /// Gets the awaiter. + /// + /// The awaiter. + public NoThrowTaskAwaiter GetAwaiter() + { + return new NoThrowTaskAwaiter(this.task, this.captureContext); } + } + + /// + /// An awaiter that wraps a task and never throws an exception when waited on. + /// + public readonly struct NoThrowTaskAwaiter : ICriticalNotifyCompletion + { + /// + /// The task. + /// + private readonly Task task; /// - /// Returns a reusable task that is already canceled. + /// A value indicating whether the continuation should be scheduled on the current sync context. /// - /// The type parameter for the returned task. - internal static Task CanceledTaskOfT() => CanceledTaskOfTCache.CanceledTask; + private readonly bool captureContext; /// - /// Returns a that has been faulted with the specified exception. + /// Initializes a new instance of the struct. /// - /// The type of value that might have been returned from the . - /// The exception used to fault the . - /// The faulted task. - internal static Task FaultedTask(Exception ex) + /// The task. + /// if set to [capture context]. + public NoThrowTaskAwaiter(Task task, bool captureContext) { - return Task.FromException(ex); + Requires.NotNull(task, nameof(task)); + this.task = task; + this.captureContext = captureContext; } /// - /// Applies a completed task's results to another. + /// Gets a value indicating whether the task has completed. /// - /// The type of value returned by a task. - /// The task whose completion should be applied to another. - /// The task that should receive the completion status. - private static void ApplyCompletedTaskResultTo(Task completedTask, TaskCompletionSource taskCompletionSource) + public bool IsCompleted { - Assumes.NotNull(completedTask); - Assumes.True(completedTask.IsCompleted); - Assumes.NotNull(taskCompletionSource); - - if (completedTask.IsCanceled) - { - // NOTE: this is "lossy" in that we don't propagate any CancellationToken that the Task would throw an OperationCanceledException with. - // Propagating that data would require that we actually cause the completedTask to throw so we can inspect the - // OperationCanceledException.CancellationToken property, which we consider more costly than it's worth. - taskCompletionSource.TrySetCanceled(); - } - else if (completedTask.IsFaulted) - { - taskCompletionSource.TrySetException(completedTask.Exception!.InnerExceptions); - } - else - { - taskCompletionSource.TrySetResult(completedTask.Result); - } + get { return this.task.IsCompleted; } } /// - /// Applies a completed task's results to another. + /// Schedules a delegate for execution at the conclusion of a task's execution. /// - /// The type of value returned by a task. - /// The task whose completion should be applied to another. - /// The task that should receive the completion status. - /// The value to set on the completion source when the source task runs to completion. - private static void ApplyCompletedTaskResultTo(Task completedTask, TaskCompletionSource taskCompletionSource, T valueOnRanToCompletion) + /// The action. + public void OnCompleted(Action continuation) { - Assumes.NotNull(completedTask); - Assumes.True(completedTask.IsCompleted); - Assumes.NotNull(taskCompletionSource); - - if (completedTask.IsCanceled) - { - // NOTE: this is "lossy" in that we don't propagate any CancellationToken that the Task would throw an OperationCanceledException with. - // Propagating that data would require that we actually cause the completedTask to throw so we can inspect the - // OperationCanceledException.CancellationToken property, which we consider more costly than it's worth. - taskCompletionSource.TrySetCanceled(); - } - else if (completedTask.IsFaulted) - { - taskCompletionSource.TrySetException(completedTask.Exception!.InnerExceptions); - } - else - { - taskCompletionSource.TrySetResult(valueOnRanToCompletion); - } + this.task.ConfigureAwait(this.captureContext).GetAwaiter().OnCompleted(continuation); } /// - /// Gets a task that will eventually produce the result of another task, when that task finishes. - /// If that task is instead canceled, its successor will be followed for its result, iteratively. + /// Schedules a delegate for execution at the conclusion of a task's execution + /// without capturing the ExecutionContext. /// - /// The type of value returned by the task. - /// The TaskCompletionSource whose task is to follow. - /// The current task. - /// - /// The following task. - /// - private static Task FollowCancelableTaskToCompletionHelper(TaskCompletionSource, T> tcs, Task currentTask) - { - Requires.NotNull(tcs, nameof(tcs)); - Requires.NotNull(currentTask, nameof(currentTask)); - - currentTask.ContinueWith( - (t, state) => - { - var tcsNested = (TaskCompletionSource, T>)state!; - switch (t.Status) - { - case TaskStatus.RanToCompletion: - tcsNested.TrySetResult(t.Result); - tcsNested.SourceState.RegisteredCallback.Dispose(); - break; - case TaskStatus.Faulted: - tcsNested.TrySetException(t.Exception!.InnerExceptions); - tcsNested.SourceState.RegisteredCallback.Dispose(); - break; - case TaskStatus.Canceled: - Task? newTask = tcsNested.SourceState.CurrentTask; - Assumes.True(newTask != t, "A canceled task was not replaced with a new task."); - FollowCancelableTaskToCompletionHelper(tcsNested, newTask); - break; - } - }, - tcs, - tcs.SourceState.UltimateCancellation, - TaskContinuationOptions.ExecuteSynchronously, - TaskScheduler.Default); - - return tcs.Task; + /// The action. + public void UnsafeOnCompleted(Action continuation) + { + this.task.ConfigureAwait(this.captureContext).GetAwaiter().UnsafeOnCompleted(continuation); } /// - /// An awaitable that wraps a task and never throws an exception when waited on. + /// Does nothing. /// - public readonly struct NoThrowTaskAwaitable - { - /// - /// The task. - /// - private readonly Task task; - - /// - /// A value indicating whether the continuation should be scheduled on the current sync context. - /// - private readonly bool captureContext; - - /// - /// Initializes a new instance of the struct. - /// - /// The task. - /// Whether the continuation should be scheduled on the current sync context. - public NoThrowTaskAwaitable(Task task, bool captureContext) - { - Requires.NotNull(task, nameof(task)); - this.task = task; - this.captureContext = captureContext; - } - - /// - /// Gets the awaiter. - /// - /// The awaiter. - public NoThrowTaskAwaiter GetAwaiter() - { - return new NoThrowTaskAwaiter(this.task, this.captureContext); - } + public void GetResult() + { + // Never throw here. } + } + /// + /// A state bag for the method. + /// + /// The type of value ultimately returned. + private readonly struct FollowCancelableTaskState + { /// - /// An awaiter that wraps a task and never throws an exception when waited on. + /// The delegate that returns the task to follow. /// - public readonly struct NoThrowTaskAwaiter : ICriticalNotifyCompletion - { - /// - /// The task. - /// - private readonly Task task; - - /// - /// A value indicating whether the continuation should be scheduled on the current sync context. - /// - private readonly bool captureContext; - - /// - /// Initializes a new instance of the struct. - /// - /// The task. - /// if set to [capture context]. - public NoThrowTaskAwaiter(Task task, bool captureContext) - { - Requires.NotNull(task, nameof(task)); - this.task = task; - this.captureContext = captureContext; - } - - /// - /// Gets a value indicating whether the task has completed. - /// - public bool IsCompleted - { - get { return this.task.IsCompleted; } - } + private readonly Func> getTaskToFollow; - /// - /// Schedules a delegate for execution at the conclusion of a task's execution. - /// - /// The action. - public void OnCompleted(Action continuation) - { - this.task.ConfigureAwait(this.captureContext).GetAwaiter().OnCompleted(continuation); - } - - /// - /// Schedules a delegate for execution at the conclusion of a task's execution - /// without capturing the ExecutionContext. - /// - /// The action. - public void UnsafeOnCompleted(Action continuation) - { - this.task.ConfigureAwait(this.captureContext).GetAwaiter().UnsafeOnCompleted(continuation); - } - - /// - /// Does nothing. - /// - public void GetResult() - { - // Never throw here. - } + /// + /// Initializes a new instance of the struct. + /// + /// The get task to follow. + /// The cancellation token. + internal FollowCancelableTaskState(Func> getTaskToFollow, CancellationToken cancellationToken) + : this(getTaskToFollow, registeredCallback: default, cancellationToken) + { } /// - /// A state bag for the method. + /// Initializes a new instance of the struct. /// - /// The type of value ultimately returned. - private readonly struct FollowCancelableTaskState - { - /// - /// The delegate that returns the task to follow. - /// - private readonly Func> getTaskToFollow; - - /// - /// Initializes a new instance of the struct. - /// - /// The get task to follow. - /// The cancellation token. - internal FollowCancelableTaskState(Func> getTaskToFollow, CancellationToken cancellationToken) - : this(getTaskToFollow, registeredCallback: default, cancellationToken) - { - } - - /// - /// Initializes a new instance of the struct. - /// - /// The get task to follow. - /// The cancellation token registration to dispose of when the task completes normally. - /// The cancellation token. - private FollowCancelableTaskState(Func> getTaskToFollow, CancellationTokenRegistration registeredCallback, CancellationToken cancellationToken) - { - Requires.NotNull(getTaskToFollow, nameof(getTaskToFollow)); + /// The get task to follow. + /// The cancellation token registration to dispose of when the task completes normally. + /// The cancellation token. + private FollowCancelableTaskState(Func> getTaskToFollow, CancellationTokenRegistration registeredCallback, CancellationToken cancellationToken) + { + Requires.NotNull(getTaskToFollow, nameof(getTaskToFollow)); - this.getTaskToFollow = getTaskToFollow; - this.RegisteredCallback = registeredCallback; - this.UltimateCancellation = cancellationToken; - } + this.getTaskToFollow = getTaskToFollow; + this.RegisteredCallback = registeredCallback; + this.UltimateCancellation = cancellationToken; + } - /// - /// Gets the ultimate cancellation token. - /// - internal CancellationToken UltimateCancellation { get; } + /// + /// Gets the ultimate cancellation token. + /// + internal CancellationToken UltimateCancellation { get; } - /// - /// Gets the cancellation token registration to dispose of when the task completes normally. - /// - internal CancellationTokenRegistration RegisteredCallback { get; } + /// + /// Gets the cancellation token registration to dispose of when the task completes normally. + /// + internal CancellationTokenRegistration RegisteredCallback { get; } - /// - /// Gets the current task to follow. - /// - internal Task CurrentTask + /// + /// Gets the current task to follow. + /// + internal Task CurrentTask + { + get { - get - { - Task? task = this.getTaskToFollow(); - Assumes.NotNull(task); - return task; - } + Task? task = this.getTaskToFollow(); + Assumes.NotNull(task); + return task; } - - internal FollowCancelableTaskState WithRegisteredCallback(CancellationTokenRegistration registeredCallback) - => new FollowCancelableTaskState(this.getTaskToFollow, registeredCallback, this.UltimateCancellation); } + internal FollowCancelableTaskState WithRegisteredCallback(CancellationTokenRegistration registeredCallback) + => new FollowCancelableTaskState(this.getTaskToFollow, registeredCallback, this.UltimateCancellation); + } + + /// + /// A cache for canceled instances. + /// + /// The type parameter for the returned task. + private static class CanceledTaskOfTCache + { + /// + /// A task that is already canceled. + /// + internal static readonly Task CanceledTask = Task.FromCanceled(new CancellationToken(canceled: true)); + } + + /// + /// A task completion source that contains additional state. + /// + /// The type of the state. + /// The type of the result. + private class TaskCompletionSource : TaskCompletionSource + { /// - /// A cache for canceled instances. + /// Initializes a new instance of the class. /// - /// The type parameter for the returned task. - private static class CanceledTaskOfTCache + /// The state to store in the property. + /// State of the task. + /// The options. + internal TaskCompletionSource(TState sourceState, object? taskState = null, TaskCreationOptions options = TaskCreationOptions.None) + : base(taskState, options) { - /// - /// A task that is already canceled. - /// - internal static readonly Task CanceledTask = Task.FromCanceled(new CancellationToken(canceled: true)); + this.SourceState = sourceState; } /// - /// A task completion source that contains additional state. + /// Gets or sets the state passed into the constructor. /// - /// The type of the state. - /// The type of the result. - private class TaskCompletionSource : TaskCompletionSource - { - /// - /// Initializes a new instance of the class. - /// - /// The state to store in the property. - /// State of the task. - /// The options. - internal TaskCompletionSource(TState sourceState, object? taskState = null, TaskCreationOptions options = TaskCreationOptions.None) - : base(taskState, options) - { - this.SourceState = sourceState; - } - - /// - /// Gets or sets the state passed into the constructor. - /// - internal TState SourceState { get; set; } - } + internal TState SourceState { get; set; } } } diff --git a/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs b/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs index 23f6423f3..562d198aa 100644 --- a/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs +++ b/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs @@ -6,503 +6,502 @@ using System.Diagnostics; using System.Diagnostics.CodeAnalysis; -namespace Microsoft.VisualStudio.Threading +namespace Microsoft.VisualStudio.Threading; + +/// +/// Dictionary that does not prevent keys from being garbage collected. +/// +/// Type of key, without the WeakReference wrapper. +/// Type of value. +/// +/// See also Microsoft.Build.Collections.WeakDictionary. +/// +internal class WeakKeyDictionary : IEnumerable> + where TKey : class { /// - /// Dictionary that does not prevent keys from being garbage collected. + /// The dictionary used internally to store the keys and values. /// - /// Type of key, without the WeakReference wrapper. - /// Type of value. - /// - /// See also Microsoft.Build.Collections.WeakDictionary. - /// - internal class WeakKeyDictionary : IEnumerable> - where TKey : class + [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)] + private readonly Dictionary, TValue> dictionary; + + /// + /// The key comparer to use for hashing and equality checks. + /// + private readonly IEqualityComparer keyComparer; + + /// + /// The dictionary's initial capacity, and the capacity beyond which we will resist to grow + /// by scavenging for collected keys first. + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + private int capacity; + + /// + /// Initializes a new instance of the class. + /// + /// The key comparer to use. A value indicates the default comparer will be used. + /// The initial capacity of the dictionary. Growth beyond this capacity will first induce a scavenge operation. + public WeakKeyDictionary(IEqualityComparer? keyComparer = null, int capacity = 10) { - /// - /// The dictionary used internally to store the keys and values. - /// - [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)] - private readonly Dictionary, TValue> dictionary; + Requires.Range(capacity > 0, "capacity"); - /// - /// The key comparer to use for hashing and equality checks. - /// - private readonly IEqualityComparer keyComparer; + this.keyComparer = keyComparer ?? EqualityComparer.Default; + this.capacity = capacity; + IEqualityComparer> equalityComparer = new WeakReferenceEqualityComparer(this.keyComparer); + this.dictionary = new Dictionary, TValue>(this.capacity, equalityComparer); + } - /// - /// The dictionary's initial capacity, and the capacity beyond which we will resist to grow - /// by scavenging for collected keys first. - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - private int capacity; + /// + /// Gets the number of entries in this dictionary. + /// Some entries may represent keys or values that have already been garbage collected. + /// To clean these out call . + /// + [DebuggerBrowsable(DebuggerBrowsableState.Never)] + public int Count + { + get { return this.dictionary.Count; } + } - /// - /// Initializes a new instance of the class. - /// - /// The key comparer to use. A value indicates the default comparer will be used. - /// The initial capacity of the dictionary. Growth beyond this capacity will first induce a scavenge operation. - public WeakKeyDictionary(IEqualityComparer? keyComparer = null, int capacity = 10) + /// + /// Gets all key values in the dictionary. + /// + internal IEnumerable Keys + { + get { - Requires.Range(capacity > 0, "capacity"); - - this.keyComparer = keyComparer ?? EqualityComparer.Default; - this.capacity = capacity; - IEqualityComparer> equalityComparer = new WeakReferenceEqualityComparer(this.keyComparer); - this.dictionary = new Dictionary, TValue>(this.capacity, equalityComparer); + return new KeyEnumerable(this); } + } - /// - /// Gets the number of entries in this dictionary. - /// Some entries may represent keys or values that have already been garbage collected. - /// To clean these out call . - /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] - public int Count + /// + /// Obtains the value for a given key. + /// + public TValue this[TKey key] + { + get { - get { return this.dictionary.Count; } + WeakReference wrappedKey = new WeakReference(key, this.keyComparer, avoidWeakReferenceAllocation: true); + TValue value = this.dictionary[wrappedKey]; + return value; } - /// - /// Gets all key values in the dictionary. - /// - internal IEnumerable Keys + set { - get + WeakReference wrappedKey = new WeakReference(key, this.keyComparer); + + // Make some attempt to prevent dictionary growing forever with + // entries whose underlying key or value has already been collected. + // We do not have access to the dictionary's true capacity or growth + // method, so we improvise with our own. + // So attempt to make room for the upcoming add before we do it. + if (this.dictionary.Count == this.capacity && !this.ContainsKey(key)) { - return new KeyEnumerable(this); + this.Scavenge(); + + // If that didn't do anything, raise the capacity at which + // we next scavenge. Note that we never shrink, but neither + // does the underlying dictionary. + if (this.dictionary.Count == this.capacity) + { + this.capacity = this.dictionary.Count * 2; + } } + + this.dictionary[wrappedKey] = value; } + } - /// - /// Obtains the value for a given key. - /// - public TValue this[TKey key] + /// + /// Whether there is a key present with the specified key. + /// + /// + /// As usual, don't just call Contained as the wrapped value may be null. + /// + public bool ContainsKey(TKey key) + { +#pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. + bool contained = this.TryGetValue(key, out TValue? value); +#pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. + return contained; + } + + /// + /// Attempts to get the value for the provided key. + /// Returns true if the key is found, otherwise false. + /// + public bool TryGetValue(TKey key, [MaybeNullWhen(false)] out TValue value) + { +#pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. https://github.com/dotnet/roslyn/issues/39656 + return this.dictionary.TryGetValue(new WeakReference(key, this.keyComparer, avoidWeakReferenceAllocation: true), out value); +#pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. + } + + /// + /// Removes an entry with the specified key. + /// Returns true if found, false otherwise. + /// + public bool Remove(TKey key) + { + return this.dictionary.Remove(new WeakReference(key, this.keyComparer, avoidWeakReferenceAllocation: true)); + } + + /// + /// Remove any entries from the dictionary that represent keys + /// that have been garbage collected. + /// + /// The number of entries removed. + public int Scavenge() + { + List>? remove = null; + + foreach (WeakReference weakKey in this.dictionary.Keys) { - get + if (!weakKey.IsAlive) { - WeakReference wrappedKey = new WeakReference(key, this.keyComparer, avoidWeakReferenceAllocation: true); - TValue value = this.dictionary[wrappedKey]; - return value; + remove = remove ?? new List>(); + remove.Add(weakKey); } + } - set + if (remove is object) + { + foreach (WeakReference entry in remove) { - WeakReference wrappedKey = new WeakReference(key, this.keyComparer); - - // Make some attempt to prevent dictionary growing forever with - // entries whose underlying key or value has already been collected. - // We do not have access to the dictionary's true capacity or growth - // method, so we improvise with our own. - // So attempt to make room for the upcoming add before we do it. - if (this.dictionary.Count == this.capacity && !this.ContainsKey(key)) - { - this.Scavenge(); - - // If that didn't do anything, raise the capacity at which - // we next scavenge. Note that we never shrink, but neither - // does the underlying dictionary. - if (this.dictionary.Count == this.capacity) - { - this.capacity = this.dictionary.Count * 2; - } - } + this.dictionary.Remove(entry); + } + + return remove.Count; + } - this.dictionary[wrappedKey] = value; + return 0; + } + + /// + /// Empty the collection. + /// + public void Clear() + { + this.dictionary.Clear(); + } + + /// + /// See IEnumerable<T>. + /// + public Enumerator GetEnumerator() + { + return new Enumerator(this); + } + + /// + /// See IEnumerable<T>. + /// + IEnumerator> IEnumerable>.GetEnumerator() + { + return this.GetEnumerator(); + } + + /// + /// See IEnumerable. + /// + System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() + { + return this.GetEnumerator(); + } + + /// + /// Whether the collection contains any item. + /// + internal bool Any() + { + foreach (KeyValuePair.WeakReference, TValue> item in this.dictionary) + { + if (item.Key.IsAlive) + { + return true; } } - /// - /// Whether there is a key present with the specified key. - /// - /// - /// As usual, don't just call Contained as the wrapped value may be null. - /// - public bool ContainsKey(TKey key) + return false; + } + + public struct Enumerator : IEnumerator> + { + private Dictionary, TValue>.Enumerator enumerator; + + private KeyValuePair current; + + internal Enumerator(WeakKeyDictionary dictionary) { -#pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - bool contained = this.TryGetValue(key, out TValue? value); -#pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. - return contained; + Requires.NotNull(dictionary, nameof(dictionary)); + + this.enumerator = dictionary.dictionary.GetEnumerator(); + this.current = default(KeyValuePair); } - /// - /// Attempts to get the value for the provided key. - /// Returns true if the key is found, otherwise false. - /// - public bool TryGetValue(TKey key, [MaybeNullWhen(false)] out TValue value) + public KeyValuePair Current { -#pragma warning disable CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. https://github.com/dotnet/roslyn/issues/39656 - return this.dictionary.TryGetValue(new WeakReference(key, this.keyComparer, avoidWeakReferenceAllocation: true), out value); -#pragma warning restore CS8717 // A member returning a [MaybeNull] value introduces a null value for a type parameter. + get { return this.current; } } - /// - /// Removes an entry with the specified key. - /// Returns true if found, false otherwise. - /// - public bool Remove(TKey key) + object System.Collections.IEnumerator.Current { - return this.dictionary.Remove(new WeakReference(key, this.keyComparer, avoidWeakReferenceAllocation: true)); + get { return this.Current; } } - /// - /// Remove any entries from the dictionary that represent keys - /// that have been garbage collected. - /// - /// The number of entries removed. - public int Scavenge() + public bool MoveNext() { - List>? remove = null; + TKey? key = null; - foreach (WeakReference weakKey in this.dictionary.Keys) + while (this.enumerator.MoveNext()) { - if (!weakKey.IsAlive) + key = this.enumerator.Current.Key.Target; + if (key is object) { - remove = remove ?? new List>(); - remove.Add(weakKey); + this.current = new KeyValuePair(key, this.enumerator.Current.Value); + return true; } } - if (remove is object) - { - foreach (WeakReference entry in remove) - { - this.dictionary.Remove(entry); - } + return false; + } - return remove.Count; - } + void System.Collections.IEnumerator.Reset() + { + // Calling reset on the dictionary enumerator would require boxing it in the cast to the explicit interface method. + // But boxing a valuetype means that any changes you make will not be brought back to the value type field + // so the Reset() will probably have no effect. + // If we ever have to support this, we'll probably have to do box the enumerator and then retain the boxed + // version and use that in this enumerator for the rest of its lifetime. + throw new NotSupportedException(); + } - return 0; + public void Dispose() + { + this.enumerator.Dispose(); } + } + /// + /// Strongly typed wrapper around a weak reference that caches + /// the target's hash code so that it can be used in a hashtable. + /// + /// Type of the target of the weak reference. + private readonly struct WeakReference : IEquatable> + where T : class + { /// - /// Empty the collection. + /// Cache the hashcode so that it is still available even if the target has been + /// collected. This allows this object to be still found in a table so it can be removed. /// - public void Clear() - { - this.dictionary.Clear(); - } + private readonly int hashcode; /// - /// See IEnumerable<T>. + /// Backing weak reference. /// - public Enumerator GetEnumerator() + private readonly WeakReference? weakReference; + + /// + /// Some of the instances are around just to do existence checks, and don't want + /// to allocate WeakReference objects as they are short-lived. + /// + private readonly T? notSoWeakTarget; + + /// + /// Initializes a new instance of the struct. + /// + internal WeakReference(T target, IEqualityComparer equalityComparer, bool avoidWeakReferenceAllocation = false) { - return new Enumerator(this); + Requires.NotNull(target, nameof(target)); + Requires.NotNull(equalityComparer, nameof(equalityComparer)); + + this.notSoWeakTarget = avoidWeakReferenceAllocation ? target : null; + this.weakReference = avoidWeakReferenceAllocation ? null : new WeakReference(target); + this.hashcode = equalityComparer.GetHashCode(target); } /// - /// See IEnumerable<T>. + /// Gets the target wrapped by this weak reference. Null if the target has already been garbage collected. /// - IEnumerator> IEnumerable>.GetEnumerator() + internal T? Target { - return this.GetEnumerator(); + get { return this.notSoWeakTarget ?? (T?)this.weakReference?.Target; } } /// - /// See IEnumerable. + /// Gets a value indicating whether the target has not been garbage collected yet. /// - System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() + internal bool IsAlive { - return this.GetEnumerator(); + get { return this.notSoWeakTarget is object || (this.weakReference?.IsAlive ?? false); } } /// - /// Whether the collection contains any item. + /// Returns the hashcode of the wrapped target. /// - internal bool Any() + public override int GetHashCode() { - foreach (KeyValuePair.WeakReference, TValue> item in this.dictionary) - { - if (item.Key.IsAlive) - { - return true; - } - } - - return false; + return this.hashcode; } - public struct Enumerator : IEnumerator> + /// + /// Compares two structures. + /// + public override bool Equals(object? obj) { - private Dictionary, TValue>.Enumerator enumerator; - - private KeyValuePair current; - - internal Enumerator(WeakKeyDictionary dictionary) - { - Requires.NotNull(dictionary, nameof(dictionary)); - - this.enumerator = dictionary.dictionary.GetEnumerator(); - this.current = default(KeyValuePair); - } + // We can't implement equals in the same terms as GetHashCode() because + // our target object may have been collected. Instead just go based on + // equality of our weak references. + return obj is WeakReference other && this.Equals(other); + } - public KeyValuePair Current - { - get { return this.current; } - } + /// + public bool Equals(WeakReference other) => Equals(this.weakReference, other.weakReference); + } - object System.Collections.IEnumerator.Current - { - get { return this.Current; } - } + /// + /// A helper structure to implement . + /// + private class KeyEnumerator : IEnumerator + { + private Dictionary, TValue>.Enumerator enumerator; - public bool MoveNext() - { - TKey? key = null; + internal KeyEnumerator(WeakKeyDictionary dictionary) + { + Requires.NotNull(dictionary, nameof(dictionary)); - while (this.enumerator.MoveNext()) - { - key = this.enumerator.Current.Key.Target; - if (key is object) - { - this.current = new KeyValuePair(key, this.enumerator.Current.Value); - return true; - } - } + // Assign a value to Current to suppress CS8618. The Current property may have a null value at times, + // but the value will never be exposed to external code provided the code only accesses Current after a + // call to MoveNext returns true. + this.Current = null!; - return false; - } + this.enumerator = dictionary.dictionary.GetEnumerator(); + } - void System.Collections.IEnumerator.Reset() - { - // Calling reset on the dictionary enumerator would require boxing it in the cast to the explicit interface method. - // But boxing a valuetype means that any changes you make will not be brought back to the value type field - // so the Reset() will probably have no effect. - // If we ever have to support this, we'll probably have to do box the enumerator and then retain the boxed - // version and use that in this enumerator for the rest of its lifetime. - throw new NotSupportedException(); - } + /// + /// Gets the current item of the enumerator. + /// + public TKey Current { get; private set; } - public void Dispose() - { - this.enumerator.Dispose(); - } - } + object System.Collections.IEnumerator.Current => this.Current; /// - /// Strongly typed wrapper around a weak reference that caches - /// the target's hash code so that it can be used in a hashtable. + /// Implements . /// - /// Type of the target of the weak reference. - private readonly struct WeakReference : IEquatable> - where T : class + public bool MoveNext() { - /// - /// Cache the hashcode so that it is still available even if the target has been - /// collected. This allows this object to be still found in a table so it can be removed. - /// - private readonly int hashcode; - - /// - /// Backing weak reference. - /// - private readonly WeakReference? weakReference; - - /// - /// Some of the instances are around just to do existence checks, and don't want - /// to allocate WeakReference objects as they are short-lived. - /// - private readonly T? notSoWeakTarget; - - /// - /// Initializes a new instance of the struct. - /// - internal WeakReference(T target, IEqualityComparer equalityComparer, bool avoidWeakReferenceAllocation = false) + while (this.enumerator.MoveNext()) { - Requires.NotNull(target, nameof(target)); - Requires.NotNull(equalityComparer, nameof(equalityComparer)); - - this.notSoWeakTarget = avoidWeakReferenceAllocation ? target : null; - this.weakReference = avoidWeakReferenceAllocation ? null : new WeakReference(target); - this.hashcode = equalityComparer.GetHashCode(target); + TKey? key = this.enumerator.Current.Key.Target; + if (key is object) + { + this.Current = key; + return true; + } } - /// - /// Gets the target wrapped by this weak reference. Null if the target has already been garbage collected. - /// - internal T? Target - { - get { return this.notSoWeakTarget ?? (T?)this.weakReference?.Target; } - } + return false; + } - /// - /// Gets a value indicating whether the target has not been garbage collected yet. - /// - internal bool IsAlive - { - get { return this.notSoWeakTarget is object || (this.weakReference?.IsAlive ?? false); } - } + void System.Collections.IEnumerator.Reset() + { + // Calling reset on the dictionary enumerator would require boxing it in the cast to the explicit interface method. + // But boxing a valuetype means that any changes you make will not be brought back to the value type field + // so the Reset() will probably have no effect. + // If we ever have to support this, we'll probably have to do box the enumerator and then retain the boxed + // version and use that in this enumerator for the rest of its lifetime. + throw new NotSupportedException(); + } - /// - /// Returns the hashcode of the wrapped target. - /// - public override int GetHashCode() - { - return this.hashcode; - } + public void Dispose() + { + this.enumerator.Dispose(); + } + } - /// - /// Compares two structures. - /// - public override bool Equals(object? obj) - { - // We can't implement equals in the same terms as GetHashCode() because - // our target object may have been collected. Instead just go based on - // equality of our weak references. - return obj is WeakReference other && this.Equals(other); - } + /// + /// A helper structure to enumerate keys in the dictionary. + /// + private class KeyEnumerable : IEnumerable + { + private readonly WeakKeyDictionary dictionary; - /// - public bool Equals(WeakReference other) => Equals(this.weakReference, other.weakReference); + internal KeyEnumerable(WeakKeyDictionary dictionary) + { + Requires.NotNull(dictionary, nameof(dictionary)); + this.dictionary = dictionary; } /// - /// A helper structure to implement . + /// Implements . /// - private class KeyEnumerator : IEnumerator + IEnumerator IEnumerable.GetEnumerator() { - private Dictionary, TValue>.Enumerator enumerator; - - internal KeyEnumerator(WeakKeyDictionary dictionary) - { - Requires.NotNull(dictionary, nameof(dictionary)); - - // Assign a value to Current to suppress CS8618. The Current property may have a null value at times, - // but the value will never be exposed to external code provided the code only accesses Current after a - // call to MoveNext returns true. - this.Current = null!; - - this.enumerator = dictionary.dictionary.GetEnumerator(); - } - - /// - /// Gets the current item of the enumerator. - /// - public TKey Current { get; private set; } - - object System.Collections.IEnumerator.Current => this.Current; - - /// - /// Implements . - /// - public bool MoveNext() - { - while (this.enumerator.MoveNext()) - { - TKey? key = this.enumerator.Current.Key.Target; - if (key is object) - { - this.Current = key; - return true; - } - } - - return false; - } - - void System.Collections.IEnumerator.Reset() - { - // Calling reset on the dictionary enumerator would require boxing it in the cast to the explicit interface method. - // But boxing a valuetype means that any changes you make will not be brought back to the value type field - // so the Reset() will probably have no effect. - // If we ever have to support this, we'll probably have to do box the enumerator and then retain the boxed - // version and use that in this enumerator for the rest of its lifetime. - throw new NotSupportedException(); - } - - public void Dispose() - { - this.enumerator.Dispose(); - } + return this.GetEnumerator(); } /// - /// A helper structure to enumerate keys in the dictionary. + /// Implements . /// - private class KeyEnumerable : IEnumerable + System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() { - private readonly WeakKeyDictionary dictionary; + return this.GetEnumerator(); + } - internal KeyEnumerable(WeakKeyDictionary dictionary) - { - Requires.NotNull(dictionary, nameof(dictionary)); - this.dictionary = dictionary; - } + /// + /// Gets the Enumerator. + /// + /// A new KeyEnumerator. + private KeyEnumerator GetEnumerator() + { + return new KeyEnumerator(this.dictionary); + } + } - /// - /// Implements . - /// - IEnumerator IEnumerable.GetEnumerator() - { - return this.GetEnumerator(); - } + /// + /// Equality comparer for weak references that actually compares the + /// targets of the weak references. + /// + /// Type of the targets of the weak references to be compared. + private class WeakReferenceEqualityComparer : IEqualityComparer> + where T : class + { + /// + /// Comparer to use if specified, otherwise null. + /// + private readonly IEqualityComparer underlyingComparer; - /// - /// Implements . - /// - System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() - { - return this.GetEnumerator(); - } + /// + /// Initializes a new instance of the class + /// with an explicitly specified comparer. + /// + /// + /// May be null, in which case the default comparer for the type will be used. + /// + internal WeakReferenceEqualityComparer(IEqualityComparer comparer) + { + Requires.NotNull(comparer, nameof(comparer)); - /// - /// Gets the Enumerator. - /// - /// A new KeyEnumerator. - private KeyEnumerator GetEnumerator() - { - return new KeyEnumerator(this.dictionary); - } + this.underlyingComparer = comparer; } /// - /// Equality comparer for weak references that actually compares the - /// targets of the weak references. + /// Gets the hashcode. /// - /// Type of the targets of the weak references to be compared. - private class WeakReferenceEqualityComparer : IEqualityComparer> - where T : class + public int GetHashCode(WeakReference item) { - /// - /// Comparer to use if specified, otherwise null. - /// - private readonly IEqualityComparer underlyingComparer; - - /// - /// Initializes a new instance of the class - /// with an explicitly specified comparer. - /// - /// - /// May be null, in which case the default comparer for the type will be used. - /// - internal WeakReferenceEqualityComparer(IEqualityComparer comparer) - { - Requires.NotNull(comparer, nameof(comparer)); - - this.underlyingComparer = comparer; - } - - /// - /// Gets the hashcode. - /// - public int GetHashCode(WeakReference item) - { - // item.GetHashCode() returns a cached value from when the Target was referenced, - // and was calculated using this.underlyingComparer. - return item.GetHashCode(); - } + // item.GetHashCode() returns a cached value from when the Target was referenced, + // and was calculated using this.underlyingComparer. + return item.GetHashCode(); + } - /// - /// Compares the weak references for equality. - /// - public bool Equals(WeakReference left, WeakReference right) - { - // PERF: do not add any code here that will cause the value type parameters to be boxed! - return this.underlyingComparer.Equals(left.Target, right.Target); - } + /// + /// Compares the weak references for equality. + /// + public bool Equals(WeakReference left, WeakReference right) + { + // PERF: do not add any code here that will cause the value type parameters to be boxed! + return this.underlyingComparer.Equals(left.Target, right.Target); } } } diff --git a/src/SosThreadingTools/Commands.cs b/src/SosThreadingTools/Commands.cs index ada6f7b6b..b894551b0 100644 --- a/src/SosThreadingTools/Commands.cs +++ b/src/SosThreadingTools/Commands.cs @@ -5,48 +5,47 @@ using System.Collections.Generic; using System.Runtime.InteropServices; -namespace CpsDbg +namespace CpsDbg; + +internal static class Commands { - internal static class Commands + private const string DumpAsyncCommand = "dumpasync"; + + private static readonly Dictionary CommandHandlers = new Dictionary(StringComparer.OrdinalIgnoreCase) { - private const string DumpAsyncCommand = "dumpasync"; + { "dumpasync", new DumpAsyncCommand() }, + }; + + [DllExport(DumpAsyncCommand, CallingConvention.StdCall)] + internal static void DumpAsync(IntPtr client, [MarshalAs(UnmanagedType.LPStr)] string args) + { + ExecuteCommand(client, DumpAsyncCommand, args); + } - private static readonly Dictionary CommandHandlers = new Dictionary(StringComparer.OrdinalIgnoreCase) + private static void ExecuteCommand(IntPtr client, string command, [MarshalAs(UnmanagedType.LPStr)] string args) + { + ICommandHandler handler; + if (!CommandHandlers.TryGetValue(command, out handler)) { - { "dumpasync", new DumpAsyncCommand() }, - }; + return; + } - [DllExport(DumpAsyncCommand, CallingConvention.StdCall)] - internal static void DumpAsync(IntPtr client, [MarshalAs(UnmanagedType.LPStr)] string args) + DebuggerContext? context = DebuggerContext.GetDebuggerContext(client); + if (context is null) { - ExecuteCommand(client, DumpAsyncCommand, args); + return; } - private static void ExecuteCommand(IntPtr client, string command, [MarshalAs(UnmanagedType.LPStr)] string args) + try { - ICommandHandler handler; - if (!CommandHandlers.TryGetValue(command, out handler)) - { - return; - } - - DebuggerContext? context = DebuggerContext.GetDebuggerContext(client); - if (context is null) - { - return; - } - - try - { - handler.Execute(context, args); - } + handler.Execute(context, args); + } #pragma warning disable CA1031 // Do not catch general exception types - catch (Exception ex) + catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types - { - context.Output.WriteLine($"Encountered an unhandled exception running '{command}':"); - context.Output.WriteLine(ex.ToString()); - } + { + context.Output.WriteLine($"Encountered an unhandled exception running '{command}':"); + context.Output.WriteLine(ex.ToString()); } } } diff --git a/src/SosThreadingTools/DebuggerContext.cs b/src/SosThreadingTools/DebuggerContext.cs index 4189f06f0..85cadcd04 100644 --- a/src/SosThreadingTools/DebuggerContext.cs +++ b/src/SosThreadingTools/DebuggerContext.cs @@ -11,116 +11,115 @@ using Microsoft.Diagnostics.Runtime; using Microsoft.Diagnostics.Runtime.Interop; -namespace CpsDbg +namespace CpsDbg; + +internal class DebuggerContext { - internal class DebuggerContext - { - private const string ClrMD = "Microsoft.Diagnostics.Runtime"; + private const string ClrMD = "Microsoft.Diagnostics.Runtime"; - /// - /// The singleton instance used in a debug session. - /// - private static DebuggerContext? instance; + /// + /// The singleton instance used in a debug session. + /// + private static DebuggerContext? instance; - static DebuggerContext() - { - AppDomain.CurrentDomain.AssemblyResolve += ResolveAssembly; - } + static DebuggerContext() + { + AppDomain.CurrentDomain.AssemblyResolve += ResolveAssembly; + } - private DebuggerContext(IDebugClient debugClient, DataTarget dataTarget, ClrRuntime runtime, DebuggerOutput output) - { - this.DebugClient = debugClient; - this.DataTarget = dataTarget; - this.Runtime = runtime; - this.Output = output; - } + private DebuggerContext(IDebugClient debugClient, DataTarget dataTarget, ClrRuntime runtime, DebuggerOutput output) + { + this.DebugClient = debugClient; + this.DataTarget = dataTarget; + this.Runtime = runtime; + this.Output = output; + } - internal ClrRuntime Runtime { get; } + internal ClrRuntime Runtime { get; } - internal DebuggerOutput Output { get; } + internal DebuggerOutput Output { get; } - internal IDebugClient DebugClient { get; } + internal IDebugClient DebugClient { get; } - internal IDebugControl DebugControl => (IDebugControl)this.DebugClient; + internal IDebugControl DebugControl => (IDebugControl)this.DebugClient; - private DataTarget DataTarget { get; } + private DataTarget DataTarget { get; } - internal static DebuggerContext? GetDebuggerContext(IntPtr ptrClient) + internal static DebuggerContext? GetDebuggerContext(IntPtr ptrClient) + { + // On our first call to the API: + // 1. Store a copy of IDebugClient in DebugClient. + // 2. Replace Console's output stream to be the debugger window. + // 3. Create an instance of DataTarget using the IDebugClient. + if (instance is null) { - // On our first call to the API: - // 1. Store a copy of IDebugClient in DebugClient. - // 2. Replace Console's output stream to be the debugger window. - // 3. Create an instance of DataTarget using the IDebugClient. - if (instance is null) - { - object client = Marshal.GetUniqueObjectForIUnknown(ptrClient); - var debugClient = (IDebugClient)client; + object client = Marshal.GetUniqueObjectForIUnknown(ptrClient); + var debugClient = (IDebugClient)client; - var output = new DebuggerOutput(debugClient); + var output = new DebuggerOutput(debugClient); #pragma warning disable CA2000 // Dispose objects before losing scope - var dataTarget = DataTarget.CreateFromDbgEng(ptrClient); + var dataTarget = DataTarget.CreateFromDbgEng(ptrClient); #pragma warning restore CA2000 // Dispose objects before losing scope - ClrRuntime? runtime = null; - - // If our ClrRuntime instance is null, it means that this is our first call, or - // that the dac wasn't loaded on any previous call. Find the dac loaded in the - // process (the user must use .cordll), then construct our runtime from it. + ClrRuntime? runtime = null; - // Just find a module named mscordacwks and assume it's the one the user - // loaded into windbg. - Process p = Process.GetCurrentProcess(); - foreach (ProcessModule module in p.Modules) - { - if (module.FileName.ToUpperInvariant().Contains("MSCORDACWKS")) - { - // TODO: This does not support side-by-side CLRs. - runtime = dataTarget.ClrVersions.Single().CreateRuntime(module.FileName); - break; - } - } + // If our ClrRuntime instance is null, it means that this is our first call, or + // that the dac wasn't loaded on any previous call. Find the dac loaded in the + // process (the user must use .cordll), then construct our runtime from it. - // Otherwise, the user didn't run .cordll. - if (runtime is null) - { - output.WriteLine("Mscordacwks.dll not loaded into the debugger."); - output.WriteLine("Run .cordll to load the dac before running this command."); - } - - if (runtime is object) + // Just find a module named mscordacwks and assume it's the one the user + // loaded into windbg. + Process p = Process.GetCurrentProcess(); + foreach (ProcessModule module in p.Modules) + { + if (module.FileName.ToUpperInvariant().Contains("MSCORDACWKS")) { - instance = new DebuggerContext(debugClient, dataTarget, runtime, output); + // TODO: This does not support side-by-side CLRs. + runtime = dataTarget.ClrVersions.Single().CreateRuntime(module.FileName); + break; } } - else + + // Otherwise, the user didn't run .cordll. + if (runtime is null) { - // If we already had a runtime, flush it for this use. This is ONLY required - // for a live process or iDNA trace. If you use the IDebug* apis to detect - // that we are debugging a crash dump you may skip this call for better perf. - // instance.Runtime.Flush(); + output.WriteLine("Mscordacwks.dll not loaded into the debugger."); + output.WriteLine("Run .cordll to load the dac before running this command."); } - return instance; + if (runtime is object) + { + instance = new DebuggerContext(debugClient, dataTarget, runtime, output); + } } - - private static Assembly? ResolveAssembly(object sender, ResolveEventArgs args) + else { - if (args.Name.Contains(ClrMD)) - { - string codebase = Assembly.GetExecutingAssembly().CodeBase; + // If we already had a runtime, flush it for this use. This is ONLY required + // for a live process or iDNA trace. If you use the IDebug* apis to detect + // that we are debugging a crash dump you may skip this call for better perf. + // instance.Runtime.Flush(); + } - if (codebase.StartsWith("file://", StringComparison.OrdinalIgnoreCase)) - { - codebase = codebase.Substring(8).Replace('/', '\\'); - } + return instance; + } + + private static Assembly? ResolveAssembly(object sender, ResolveEventArgs args) + { + if (args.Name.Contains(ClrMD)) + { + string codebase = Assembly.GetExecutingAssembly().CodeBase; - string directory = Path.GetDirectoryName(codebase); - string path = Path.Combine(directory, ClrMD) + ".dll"; - return Assembly.LoadFile(path); + if (codebase.StartsWith("file://", StringComparison.OrdinalIgnoreCase)) + { + codebase = codebase.Substring(8).Replace('/', '\\'); } - return null; + string directory = Path.GetDirectoryName(codebase); + string path = Path.Combine(directory, ClrMD) + ".dll"; + return Assembly.LoadFile(path); } + + return null; } } diff --git a/src/SosThreadingTools/DebuggerOutput.cs b/src/SosThreadingTools/DebuggerOutput.cs index d97f26dec..bfa0c1dbd 100644 --- a/src/SosThreadingTools/DebuggerOutput.cs +++ b/src/SosThreadingTools/DebuggerOutput.cs @@ -3,52 +3,51 @@ using Microsoft.Diagnostics.Runtime.Interop; -namespace CpsDbg +namespace CpsDbg; + +internal class DebuggerOutput { - internal class DebuggerOutput - { - private IDebugClient client; - private IDebugControl control; - - internal DebuggerOutput(IDebugClient client) - { - this.client = client; - this.control = (IDebugControl)client; - } - - internal void WriteString(string message) - { - this.control.ControlledOutput(DEBUG_OUTCTL.ALL_CLIENTS, DEBUG_OUTPUT.NORMAL, message); - } - - internal void WriteLine(string message) - { - this.WriteString(message + "\n"); - } - - internal void WriteObjectAddress(ulong address) - { - this.WriteDml($"{address:x8}"); - } - - internal void WriteThreadLink(uint threadId) - { - this.WriteDml($"Thread TID:[{threadId:x}]"); - } - - internal void WriteMethodInfo(string name, ulong address) - { - this.WriteDml($"{name}"); - } - - internal void WriteStringWithLink(string message, string linkCommand) - { - this.WriteDml($"{message}"); - } - - private void WriteDml(string dml) - { - this.control.ControlledOutput(DEBUG_OUTCTL.AMBIENT_DML, DEBUG_OUTPUT.NORMAL, dml); - } + private IDebugClient client; + private IDebugControl control; + + internal DebuggerOutput(IDebugClient client) + { + this.client = client; + this.control = (IDebugControl)client; + } + + internal void WriteString(string message) + { + this.control.ControlledOutput(DEBUG_OUTCTL.ALL_CLIENTS, DEBUG_OUTPUT.NORMAL, message); + } + + internal void WriteLine(string message) + { + this.WriteString(message + "\n"); + } + + internal void WriteObjectAddress(ulong address) + { + this.WriteDml($"{address:x8}"); + } + + internal void WriteThreadLink(uint threadId) + { + this.WriteDml($"Thread TID:[{threadId:x}]"); + } + + internal void WriteMethodInfo(string name, ulong address) + { + this.WriteDml($"{name}"); + } + + internal void WriteStringWithLink(string message, string linkCommand) + { + this.WriteDml($"{message}"); + } + + private void WriteDml(string dml) + { + this.control.ControlledOutput(DEBUG_OUTCTL.AMBIENT_DML, DEBUG_OUTPUT.NORMAL, dml); } } diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index c82f24f04..606565a77 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -7,561 +7,560 @@ using Microsoft.Diagnostics.Runtime; using Microsoft.Diagnostics.Runtime.Interop; -namespace CpsDbg +namespace CpsDbg; + +internal class DumpAsyncCommand : ICommandHandler { - internal class DumpAsyncCommand : ICommandHandler + public void Execute(DebuggerContext context, string args) { - public void Execute(DebuggerContext context, string args) - { - ClrHeap heap = context.Runtime.Heap; + ClrHeap heap = context.Runtime.Heap; - var allStateMachines = new List(); - var knownStateMachines = new Dictionary(); + var allStateMachines = new List(); + var knownStateMachines = new Dictionary(); - GetAllStateMachines(context, heap, allStateMachines, knownStateMachines); + GetAllStateMachines(context, heap, allStateMachines, knownStateMachines); - ChainStateMachinesBasedOnTaskContinuations(context, knownStateMachines); - ChainStateMachinesBasedOnJointableTasks(context, allStateMachines); - MarkThreadingBlockTasks(context, allStateMachines); - MarkUIThreadDependingTasks(allStateMachines); - FixBrokenDependencies(allStateMachines); + ChainStateMachinesBasedOnTaskContinuations(context, knownStateMachines); + ChainStateMachinesBasedOnJointableTasks(context, allStateMachines); + MarkThreadingBlockTasks(context, allStateMachines); + MarkUIThreadDependingTasks(allStateMachines); + FixBrokenDependencies(allStateMachines); - PrintOutStateMachines(allStateMachines, context.Output); - LoadCodePages(context, allStateMachines); - } + PrintOutStateMachines(allStateMachines, context.Output); + LoadCodePages(context, allStateMachines); + } - private static void GetAllStateMachines(DebuggerContext context, ClrHeap heap, List allStateMachines, Dictionary knownStateMachines) + private static void GetAllStateMachines(DebuggerContext context, ClrHeap heap, List allStateMachines, Dictionary knownStateMachines) + { + foreach (ClrObject obj in heap.GetObjectsOfType("System.Runtime.CompilerServices.AsyncMethodBuilderCore+MoveNextRunner")) { - foreach (ClrObject obj in heap.GetObjectsOfType("System.Runtime.CompilerServices.AsyncMethodBuilderCore+MoveNextRunner")) + try { - try + ClrObject stateMachine = obj.ReadObjectField("m_stateMachine"); + if (!knownStateMachines.ContainsKey(stateMachine.Address)) { - ClrObject stateMachine = obj.ReadObjectField("m_stateMachine"); - if (!knownStateMachines.ContainsKey(stateMachine.Address)) + try { - try + var state = stateMachine.ReadField("<>1__state"); + if (state >= -1) { - var state = stateMachine.ReadField("<>1__state"); - if (state >= -1) + ClrObject taskField = default(ClrObject); + ClrValueType? asyncBuilder = stateMachine.TryGetValueClassField("<>t__builder"); + if (asyncBuilder.HasValue) { - ClrObject taskField = default(ClrObject); - ClrValueType? asyncBuilder = stateMachine.TryGetValueClassField("<>t__builder"); - if (asyncBuilder.HasValue) + while (asyncBuilder.HasValue) { - while (asyncBuilder.HasValue) + taskField = asyncBuilder.TryGetObjectField("m_task"); + if (!taskField.IsNull) { - taskField = asyncBuilder.TryGetObjectField("m_task"); - if (!taskField.IsNull) - { - break; - } + break; + } - ClrValueType? nextAsyncBuilder = asyncBuilder.TryGetValueClassField("m_builder"); - if (nextAsyncBuilder is null) - { - asyncBuilder = asyncBuilder.TryGetValueClassField("_methodBuilder"); - } - else - { - asyncBuilder = nextAsyncBuilder; - } + ClrValueType? nextAsyncBuilder = asyncBuilder.TryGetValueClassField("m_builder"); + if (nextAsyncBuilder is null) + { + asyncBuilder = asyncBuilder.TryGetValueClassField("_methodBuilder"); + } + else + { + asyncBuilder = nextAsyncBuilder; } } - else + } + else + { + // CLR debugger may not be able to access t__builder, when NGEN assemblies are being used, and the type of the field could be lost. + // Our workaround is to pick up the first Task object referenced by the state machine, which seems to be correct. + // That function works with the raw data structure (like how GC scans the object, so it doesn't depend on symbols. + // + // However, one problem of that is we can pick up tasks from other reference fields of the same structure. So, we go through fields which we have symbols + // and remember references encounted, and we skip them when we go through GC references. + // Note: we can do better by going through other value structures, and extract references from them here, which we can consider when we have a real scenario. + var previousReferences = new Dictionary(); + if (stateMachine.Type?.GetFieldByName("<>t__builder") is not null) { - // CLR debugger may not be able to access t__builder, when NGEN assemblies are being used, and the type of the field could be lost. - // Our workaround is to pick up the first Task object referenced by the state machine, which seems to be correct. - // That function works with the raw data structure (like how GC scans the object, so it doesn't depend on symbols. - // - // However, one problem of that is we can pick up tasks from other reference fields of the same structure. So, we go through fields which we have symbols - // and remember references encounted, and we skip them when we go through GC references. - // Note: we can do better by going through other value structures, and extract references from them here, which we can consider when we have a real scenario. - var previousReferences = new Dictionary(); - if (stateMachine.Type?.GetFieldByName("<>t__builder") is not null) + foreach (ClrInstanceField field in stateMachine.Type.Fields) { - foreach (ClrInstanceField field in stateMachine.Type.Fields) + if (string.Equals(field.Name, "<>t__builder", StringComparison.Ordinal)) { - if (string.Equals(field.Name, "<>t__builder", StringComparison.Ordinal)) - { - break; - } + break; + } - if (field.IsObjectReference) + if (field.IsObjectReference) + { + ClrObject referencedValue = field.ReadObject(stateMachine.Address, interior: false); + if (!referencedValue.IsNull) { - ClrObject referencedValue = field.ReadObject(stateMachine.Address, interior: false); - if (!referencedValue.IsNull) + if (previousReferences.TryGetValue(referencedValue.Address, out int refCount)) { - if (previousReferences.TryGetValue(referencedValue.Address, out int refCount)) - { - previousReferences[referencedValue.Address] = refCount + 1; - } - else - { - previousReferences[referencedValue.Address] = 1; - } + previousReferences[referencedValue.Address] = refCount + 1; + } + else + { + previousReferences[referencedValue.Address] = 1; } } } } + } - foreach (ClrObject referencedObject in stateMachine.EnumerateReferences(true)) + foreach (ClrObject referencedObject in stateMachine.EnumerateReferences(true)) + { + if (!referencedObject.IsNull) { - if (!referencedObject.IsNull) + if (previousReferences.TryGetValue(referencedObject.Address, out int refCount) && refCount > 0) { - if (previousReferences.TryGetValue(referencedObject.Address, out int refCount) && refCount > 0) + if (refCount == 1) { - if (refCount == 1) - { - previousReferences.Remove(referencedObject.Address); - } - else - { - previousReferences[referencedObject.Address] = refCount - 1; - } - - continue; + previousReferences.Remove(referencedObject.Address); } - else if (previousReferences.Count > 0) + else { - continue; + previousReferences[referencedObject.Address] = refCount - 1; } - if (referencedObject.Type is object && - (string.Equals(referencedObject.Type.Name, "System.Threading.Tasks.Task", StringComparison.Ordinal) || string.Equals(referencedObject.Type.BaseType?.Name, "System.Threading.Tasks.Task", StringComparison.Ordinal))) - { - taskField = referencedObject; - break; - } + continue; + } + else if (previousReferences.Count > 0) + { + continue; + } + + if (referencedObject.Type is object && + (string.Equals(referencedObject.Type.Name, "System.Threading.Tasks.Task", StringComparison.Ordinal) || string.Equals(referencedObject.Type.BaseType?.Name, "System.Threading.Tasks.Task", StringComparison.Ordinal))) + { + taskField = referencedObject; + break; } } } + } - var asyncState = new AsyncStateMachine(state, stateMachine, taskField); - allStateMachines.Add(asyncState); - knownStateMachines.Add(stateMachine.Address, asyncState); + var asyncState = new AsyncStateMachine(state, stateMachine, taskField); + allStateMachines.Add(asyncState); + knownStateMachines.Add(stateMachine.Address, asyncState); - if (stateMachine.Type is object) + if (stateMachine.Type is object) + { + foreach (ClrMethod? method in stateMachine.Type.Methods) { - foreach (ClrMethod? method in stateMachine.Type.Methods) + if (method.Name == "MoveNext" && method.NativeCode != ulong.MaxValue) { - if (method.Name == "MoveNext" && method.NativeCode != ulong.MaxValue) - { - asyncState.CodeAddress = method.NativeCode; - } + asyncState.CodeAddress = method.NativeCode; } } } } + } #pragma warning disable CA1031 // Do not catch general exception types - catch (Exception ex) + catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types - { - context.Output.WriteLine($"Fail to process state machine {stateMachine.Address:x} Type:'{stateMachine.Type?.Name}' Module:'{stateMachine.Type?.Module?.Name}' Error: {ex.Message}"); - } + { + context.Output.WriteLine($"Fail to process state machine {stateMachine.Address:x} Type:'{stateMachine.Type?.Name}' Module:'{stateMachine.Type?.Module?.Name}' Error: {ex.Message}"); } } + } #pragma warning disable CA1031 // Do not catch general exception types - catch (Exception ex) + catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types - { - context.Output.WriteLine($"Fail to process AsyncStateMachine Runner {obj.Address:x} Error: {ex.Message}"); - } + { + context.Output.WriteLine($"Fail to process AsyncStateMachine Runner {obj.Address:x} Error: {ex.Message}"); } } + } - private static void ChainStateMachinesBasedOnTaskContinuations(DebuggerContext context, Dictionary knownStateMachines) + private static void ChainStateMachinesBasedOnTaskContinuations(DebuggerContext context, Dictionary knownStateMachines) + { + foreach (AsyncStateMachine? stateMachine in knownStateMachines.Values) { - foreach (AsyncStateMachine? stateMachine in knownStateMachines.Values) + ClrObject taskObject = stateMachine.Task; + try { - ClrObject taskObject = stateMachine.Task; - try + while (!taskObject.IsNull) { - while (!taskObject.IsNull) + // 3 cases in order to get the _target: + // 1. m_continuationObject.m_action._target + // 2. m_continuationObject._target + // 3. m_continuationObject.m_task.m_stateObject._target + ClrObject continuationObject = taskObject.TryGetObjectField("m_continuationObject"); + if (continuationObject.IsNull) { - // 3 cases in order to get the _target: - // 1. m_continuationObject.m_action._target - // 2. m_continuationObject._target - // 3. m_continuationObject.m_task.m_stateObject._target - ClrObject continuationObject = taskObject.TryGetObjectField("m_continuationObject"); - if (continuationObject.IsNull) - { - break; - } + break; + } - ChainStateMachineBasedOnTaskContinuations(knownStateMachines, stateMachine, continuationObject); + ChainStateMachineBasedOnTaskContinuations(knownStateMachines, stateMachine, continuationObject); - taskObject = continuationObject; - } + taskObject = continuationObject; } + } #pragma warning disable CA1031 // Do not catch general exception types - catch (Exception ex) + catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types - { - context.Output.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); - } + { + context.Output.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); } } + } - private static void ChainStateMachineBasedOnTaskContinuations(Dictionary knownStateMachines, AsyncStateMachine stateMachine, ClrObject continuationObject) - { - ClrObject continuationAction = continuationObject.TryGetObjectField("m_action"); + private static void ChainStateMachineBasedOnTaskContinuations(Dictionary knownStateMachines, AsyncStateMachine stateMachine, ClrObject continuationObject) + { + ClrObject continuationAction = continuationObject.TryGetObjectField("m_action"); - // case 1 - ClrObject continuationTarget = continuationAction.TryGetObjectField("_target"); + // case 1 + ClrObject continuationTarget = continuationAction.TryGetObjectField("_target"); + if (continuationTarget.IsNull) + { + // case 2 + continuationTarget = continuationObject.TryGetObjectField("_target"); if (continuationTarget.IsNull) { - // case 2 - continuationTarget = continuationObject.TryGetObjectField("_target"); - if (continuationTarget.IsNull) - { - // case 3 - continuationTarget = continuationObject.TryGetObjectField("m_task").TryGetObjectField("m_stateObject").TryGetObjectField("_target"); - } + // case 3 + continuationTarget = continuationObject.TryGetObjectField("m_task").TryGetObjectField("m_stateObject").TryGetObjectField("_target"); } + } - while (!continuationTarget.IsNull) + while (!continuationTarget.IsNull) + { + // now get the continuation from the target + ClrObject continuationTargetStateMachine = continuationTarget.TryGetObjectField("m_stateMachine"); + if (!continuationTargetStateMachine.IsNull) { - // now get the continuation from the target - ClrObject continuationTargetStateMachine = continuationTarget.TryGetObjectField("m_stateMachine"); - if (!continuationTargetStateMachine.IsNull) + AsyncStateMachine targetAsyncState; + if (knownStateMachines.TryGetValue(continuationTargetStateMachine.Address, out targetAsyncState) && targetAsyncState != stateMachine) { - AsyncStateMachine targetAsyncState; - if (knownStateMachines.TryGetValue(continuationTargetStateMachine.Address, out targetAsyncState) && targetAsyncState != stateMachine) - { - stateMachine.Next = targetAsyncState; - stateMachine.DependentCount++; - targetAsyncState.Previous = stateMachine; - } - - break; - } - else - { - ClrObject nextContinuation = continuationTarget.TryGetObjectField("m_continuation"); - continuationTarget = nextContinuation.TryGetObjectField("_target"); + stateMachine.Next = targetAsyncState; + stateMachine.DependentCount++; + targetAsyncState.Previous = stateMachine; } + + break; } + else + { + ClrObject nextContinuation = continuationTarget.TryGetObjectField("m_continuation"); + continuationTarget = nextContinuation.TryGetObjectField("_target"); + } + } - ClrObject items = continuationObject.TryGetObjectField("_items"); - if (!items.IsNull && items.IsArray && items.ContainsPointers) + ClrObject items = continuationObject.TryGetObjectField("_items"); + if (!items.IsNull && items.IsArray && items.ContainsPointers) + { + foreach (ClrObject promise in items.EnumerateReferences(true)) { - foreach (ClrObject promise in items.EnumerateReferences(true)) + if (!promise.IsNull) { - if (!promise.IsNull) + ClrObject innerContinuationObject = promise.TryGetObjectField("m_continuationObject"); + if (!innerContinuationObject.IsNull) { - ClrObject innerContinuationObject = promise.TryGetObjectField("m_continuationObject"); - if (!innerContinuationObject.IsNull) - { - ChainStateMachineBasedOnTaskContinuations(knownStateMachines, stateMachine, innerContinuationObject); - } - else - { - ChainStateMachineBasedOnTaskContinuations(knownStateMachines, stateMachine, promise); - } + ChainStateMachineBasedOnTaskContinuations(knownStateMachines, stateMachine, innerContinuationObject); + } + else + { + ChainStateMachineBasedOnTaskContinuations(knownStateMachines, stateMachine, promise); } } } } + } - private static void ChainStateMachinesBasedOnJointableTasks(DebuggerContext context, List allStateMachines) + private static void ChainStateMachinesBasedOnJointableTasks(DebuggerContext context, List allStateMachines) + { + foreach (AsyncStateMachine? stateMachine in allStateMachines) { - foreach (AsyncStateMachine? stateMachine in allStateMachines) + if (stateMachine.Previous is null) { - if (stateMachine.Previous is null) + try { - try + ClrObject joinableTask = stateMachine.StateMachine.TryGetObjectField("<>4__this"); + ClrObject wrappedTask = joinableTask.TryGetObjectField("wrappedTask"); + if (!wrappedTask.IsNull) { - ClrObject joinableTask = stateMachine.StateMachine.TryGetObjectField("<>4__this"); - ClrObject wrappedTask = joinableTask.TryGetObjectField("wrappedTask"); - if (!wrappedTask.IsNull) + AsyncStateMachine? previousStateMachine = allStateMachines + .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); + if (previousStateMachine is object && stateMachine != previousStateMachine) { - AsyncStateMachine? previousStateMachine = allStateMachines - .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); - if (previousStateMachine is object && stateMachine != previousStateMachine) - { - stateMachine.Previous = previousStateMachine; - previousStateMachine.Next = stateMachine; - previousStateMachine.DependentCount++; - } + stateMachine.Previous = previousStateMachine; + previousStateMachine.Next = stateMachine; + previousStateMachine.DependentCount++; } } + } #pragma warning disable CA1031 // Do not catch general exception types - catch (Exception ex) + catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types - { - context.Output.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); - } + { + context.Output.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); } } } + } - private static void MarkThreadingBlockTasks(DebuggerContext context, List allStateMachines) + private static void MarkThreadingBlockTasks(DebuggerContext context, List allStateMachines) + { + foreach (ClrThread? thread in context.Runtime.Threads) { - foreach (ClrThread? thread in context.Runtime.Threads) - { - ClrStackFrame? stackFrame = thread.EnumerateStackTrace().Take(50).FirstOrDefault( - f => f.Method is { } method - && string.Equals(f.Method.Name, "CompleteOnCurrentThread", StringComparison.Ordinal) - && string.Equals(f.Method.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)); + ClrStackFrame? stackFrame = thread.EnumerateStackTrace().Take(50).FirstOrDefault( + f => f.Method is { } method + && string.Equals(f.Method.Name, "CompleteOnCurrentThread", StringComparison.Ordinal) + && string.Equals(f.Method.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)); - if (stackFrame is object) + if (stackFrame is object) + { + var visitedObjects = new HashSet(); + foreach (IClrStackRoot stackRoot in thread.EnumerateStackRoots()) { - var visitedObjects = new HashSet(); - foreach (IClrStackRoot stackRoot in thread.EnumerateStackRoots()) + ClrObject stackObject = stackRoot.Object; + if (string.Equals(stackObject.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || + string.Equals(stackObject.Type?.BaseType?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)) { - ClrObject stackObject = stackRoot.Object; - if (string.Equals(stackObject.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || - string.Equals(stackObject.Type?.BaseType?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)) + if (visitedObjects.Add(stackObject.Address)) { - if (visitedObjects.Add(stackObject.Address)) + var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); + int state = joinableTaskObject.ReadField("state"); + if ((state & 0x10) == 0x10) { - var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); - int state = joinableTaskObject.ReadField("state"); - if ((state & 0x10) == 0x10) + // This flag indicates the JTF is blocking the thread + ClrObject wrappedTask = joinableTaskObject.TryGetObjectField("wrappedTask"); + if (!wrappedTask.IsNull) { - // This flag indicates the JTF is blocking the thread - ClrObject wrappedTask = joinableTaskObject.TryGetObjectField("wrappedTask"); - if (!wrappedTask.IsNull) + AsyncStateMachine? blockingStateMachine = allStateMachines + .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); + if (blockingStateMachine is object) { - AsyncStateMachine? blockingStateMachine = allStateMachines - .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); - if (blockingStateMachine is object) - { - blockingStateMachine.BlockedThread = thread.OSThreadId; - blockingStateMachine.BlockedJoinableTask = joinableTaskObject; - } + blockingStateMachine.BlockedThread = thread.OSThreadId; + blockingStateMachine.BlockedJoinableTask = joinableTaskObject; } - - break; } + + break; } } } } } } + } - private static void MarkUIThreadDependingTasks(List allStateMachines) + private static void MarkUIThreadDependingTasks(List allStateMachines) + { + foreach (AsyncStateMachine? stateMachine in allStateMachines) { - foreach (AsyncStateMachine? stateMachine in allStateMachines) + if (stateMachine.Previous is null && stateMachine.State >= 0) { - if (stateMachine.Previous is null && stateMachine.State >= 0) + try { - try + ClrInstanceField? awaitField = stateMachine.StateMachine.Type?.GetFieldByName($"<>u__{stateMachine.State + 1}"); + if (awaitField is object && awaitField.IsValueType && string.Equals(awaitField.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTaskFactory+MainThreadAwaiter", StringComparison.Ordinal)) { - ClrInstanceField? awaitField = stateMachine.StateMachine.Type?.GetFieldByName($"<>u__{stateMachine.State + 1}"); - if (awaitField is object && awaitField.IsValueType && string.Equals(awaitField.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTaskFactory+MainThreadAwaiter", StringComparison.Ordinal)) + ClrValueType? awaitObject = stateMachine.StateMachine.TryGetValueClassField($"<>u__{stateMachine.State + 1}"); + if (awaitObject.HasValue) { - ClrValueType? awaitObject = stateMachine.StateMachine.TryGetValueClassField($"<>u__{stateMachine.State + 1}"); - if (awaitObject.HasValue) - { - stateMachine.SwitchToMainThreadTask = awaitObject.TryGetObjectField("job"); - } + stateMachine.SwitchToMainThreadTask = awaitObject.TryGetObjectField("job"); } } + } #pragma warning disable CA1031 // Do not catch general exception types - catch (Exception) + catch (Exception) #pragma warning restore CA1031 // Do not catch general exception types - { - } + { } } } + } - private static void FixBrokenDependencies(List allStateMachines) + private static void FixBrokenDependencies(List allStateMachines) + { + foreach (AsyncStateMachine? stateMachine in allStateMachines) { - foreach (AsyncStateMachine? stateMachine in allStateMachines) + if (stateMachine.Previous is object && stateMachine.Previous.Next != stateMachine) { - if (stateMachine.Previous is object && stateMachine.Previous.Next != stateMachine) - { - // If the previous task actually has two continuations, we end up in a one way dependencies chain, we need fix it in the future. - stateMachine.AlterPrevious = stateMachine.Previous; - stateMachine.Previous = null; - } + // If the previous task actually has two continuations, we end up in a one way dependencies chain, we need fix it in the future. + stateMachine.AlterPrevious = stateMachine.Previous; + stateMachine.Previous = null; } } + } - private static void PrintOutStateMachines(List allStateMachines, DebuggerOutput output) + private static void PrintOutStateMachines(List allStateMachines, DebuggerOutput output) + { + int loopMark = -1; + foreach (AsyncStateMachine? stateMachine in allStateMachines) { - int loopMark = -1; - foreach (AsyncStateMachine? stateMachine in allStateMachines) + int depth = 0; + if (stateMachine.Previous is null) { - int depth = 0; - if (stateMachine.Previous is null) + AsyncStateMachine? p = stateMachine; + while (p is object) { - AsyncStateMachine? p = stateMachine; - while (p is object) + depth++; + if (p.Depth == loopMark) { - depth++; - if (p.Depth == loopMark) - { - break; - } - - p.Depth = loopMark; - p = p.Next; + break; } - } - if (stateMachine.AlterPrevious is object) - { - depth++; + p.Depth = loopMark; + p = p.Next; } + } - stateMachine.Depth = depth; - loopMark--; + if (stateMachine.AlterPrevious is object) + { + depth++; } - var printedMachines = new HashSet(); + stateMachine.Depth = depth; + loopMark--; + } - foreach (AsyncStateMachine? node in allStateMachines - .Where(m => m.Depth > 0) - .OrderByDescending(m => m.Depth) - .ThenByDescending(m => m.SwitchToMainThreadTask.Address)) - { - bool multipleLineBlock = PrintAsyncStateMachineChain(output, node, printedMachines); + var printedMachines = new HashSet(); - if (multipleLineBlock) - { - output.WriteLine(string.Empty); - } + foreach (AsyncStateMachine? node in allStateMachines + .Where(m => m.Depth > 0) + .OrderByDescending(m => m.Depth) + .ThenByDescending(m => m.SwitchToMainThreadTask.Address)) + { + bool multipleLineBlock = PrintAsyncStateMachineChain(output, node, printedMachines); + + if (multipleLineBlock) + { + output.WriteLine(string.Empty); } + } - // Print nodes which we didn't print because of loops. - if (allStateMachines.Count > printedMachines.Count) + // Print nodes which we didn't print because of loops. + if (allStateMachines.Count > printedMachines.Count) + { + output.WriteLine("States form dependencies loop -- could be an error caused by the analysis tool"); + foreach (AsyncStateMachine? node in allStateMachines) { - output.WriteLine("States form dependencies loop -- could be an error caused by the analysis tool"); - foreach (AsyncStateMachine? node in allStateMachines) + if (!printedMachines.Contains(node)) { - if (!printedMachines.Contains(node)) - { - PrintAsyncStateMachineChain(output, node, printedMachines); - output.WriteLine(string.Empty); - } + PrintAsyncStateMachineChain(output, node, printedMachines); + output.WriteLine(string.Empty); } } } + } - private static bool PrintAsyncStateMachineChain(DebuggerOutput output, AsyncStateMachine node, HashSet printedMachines) + private static bool PrintAsyncStateMachineChain(DebuggerOutput output, AsyncStateMachine node, HashSet printedMachines) + { + int nLevel = 0; + bool multipleLineBlock = false; + + var loopDetection = new HashSet(); + for (AsyncStateMachine? p = node; p is object; p = p.Next) { - int nLevel = 0; - bool multipleLineBlock = false; + printedMachines.Add(p); - var loopDetection = new HashSet(); - for (AsyncStateMachine? p = node; p is object; p = p.Next) + if (nLevel > 0) + { + output.WriteString(".."); + multipleLineBlock = true; + } + else if (p.AlterPrevious is object) { - printedMachines.Add(p); + output.WriteObjectAddress(p.AlterPrevious.StateMachine.Address); + output.WriteString($" <{p.AlterPrevious.State}> * {p.AlterPrevious.StateMachine.Type?.Name} @ "); + output.WriteMethodInfo($"{p.AlterPrevious.CodeAddress:x}", p.AlterPrevious.CodeAddress); + output.WriteLine(string.Empty); + output.WriteString(".."); + multipleLineBlock = true; + } + else if (!p.SwitchToMainThreadTask.IsNull) + { + output.WriteObjectAddress(p.SwitchToMainThreadTask.Address); + output.WriteLine(".SwitchToMainThreadAsync"); + output.WriteString(".."); + multipleLineBlock = true; + } - if (nLevel > 0) - { - output.WriteString(".."); - multipleLineBlock = true; - } - else if (p.AlterPrevious is object) - { - output.WriteObjectAddress(p.AlterPrevious.StateMachine.Address); - output.WriteString($" <{p.AlterPrevious.State}> * {p.AlterPrevious.StateMachine.Type?.Name} @ "); - output.WriteMethodInfo($"{p.AlterPrevious.CodeAddress:x}", p.AlterPrevious.CodeAddress); - output.WriteLine(string.Empty); - output.WriteString(".."); - multipleLineBlock = true; - } - else if (!p.SwitchToMainThreadTask.IsNull) - { - output.WriteObjectAddress(p.SwitchToMainThreadTask.Address); - output.WriteLine(".SwitchToMainThreadAsync"); - output.WriteString(".."); - multipleLineBlock = true; - } + output.WriteObjectAddress(p.StateMachine.Address); + string doubleDependentTaskMark = p.DependentCount > 1 ? " * " : " "; + output.WriteString($" <{p.State}>{doubleDependentTaskMark}{p.StateMachine.Type?.Name} @ "); + output.WriteMethodInfo($"{p.CodeAddress:x}", p.CodeAddress); + output.WriteLine(string.Empty); - output.WriteObjectAddress(p.StateMachine.Address); - string doubleDependentTaskMark = p.DependentCount > 1 ? " * " : " "; - output.WriteString($" <{p.State}>{doubleDependentTaskMark}{p.StateMachine.Type?.Name} @ "); - output.WriteMethodInfo($"{p.CodeAddress:x}", p.CodeAddress); - output.WriteLine(string.Empty); + if (!loopDetection.Add(p)) + { + output.WriteLine("!!Loop task dependencies"); + break; + } - if (!loopDetection.Add(p)) + if (p.Next is null && p.BlockedThread.HasValue) + { + output.WriteString("-- "); + output.WriteThreadLink(p.BlockedThread.Value); + output.WriteString(" - JoinableTask: "); + output.WriteObjectAddress(p.BlockedJoinableTask.Address); + + int state = p.BlockedJoinableTask.ReadField("state"); + if ((state & 0x20) == 0x20) { - output.WriteLine("!!Loop task dependencies"); - break; + output.WriteLine(" SynchronouslyBlockingMainThread"); } - - if (p.Next is null && p.BlockedThread.HasValue) + else { - output.WriteString("-- "); - output.WriteThreadLink(p.BlockedThread.Value); - output.WriteString(" - JoinableTask: "); - output.WriteObjectAddress(p.BlockedJoinableTask.Address); - - int state = p.BlockedJoinableTask.ReadField("state"); - if ((state & 0x20) == 0x20) - { - output.WriteLine(" SynchronouslyBlockingMainThread"); - } - else - { - output.WriteLine(string.Empty); - } - - multipleLineBlock = true; + output.WriteLine(string.Empty); } - nLevel++; + multipleLineBlock = true; } - return multipleLineBlock; + nLevel++; } - private static void LoadCodePages(DebuggerContext context, List allStateMachines) + return multipleLineBlock; + } + + private static void LoadCodePages(DebuggerContext context, List allStateMachines) + { + var loadedAddresses = new HashSet(); + foreach (AsyncStateMachine? stateMachine in allStateMachines) { - var loadedAddresses = new HashSet(); - foreach (AsyncStateMachine? stateMachine in allStateMachines) + ulong codeAddress = stateMachine.CodeAddress; + if (loadedAddresses.Add(codeAddress)) { - ulong codeAddress = stateMachine.CodeAddress; - if (loadedAddresses.Add(codeAddress)) - { - context.DebugControl.Execute(DEBUG_OUTCTL.IGNORE, $"u {codeAddress} {codeAddress}", DEBUG_EXECUTE.NOT_LOGGED); - } + context.DebugControl.Execute(DEBUG_OUTCTL.IGNORE, $"u {codeAddress} {codeAddress}", DEBUG_EXECUTE.NOT_LOGGED); } } + } - private class AsyncStateMachine + private class AsyncStateMachine + { + public AsyncStateMachine(int state, ClrObject stateMachine, ClrObject task) { - public AsyncStateMachine(int state, ClrObject stateMachine, ClrObject task) - { - this.State = state; - this.StateMachine = stateMachine; - this.Task = task; - } + this.State = state; + this.StateMachine = stateMachine; + this.Task = task; + } - public int State { get; } // -1 == currently running, 0 = still waiting on first await, 2= before the 3rd await + public int State { get; } // -1 == currently running, 0 = still waiting on first await, 2= before the 3rd await - public ClrObject StateMachine { get; } + public ClrObject StateMachine { get; } - public ClrObject Task { get; } + public ClrObject Task { get; } - public AsyncStateMachine? Previous { get; set; } + public AsyncStateMachine? Previous { get; set; } - public AsyncStateMachine? Next { get; set; } + public AsyncStateMachine? Next { get; set; } - public int DependentCount { get; set; } + public int DependentCount { get; set; } - public int Depth { get; set; } + public int Depth { get; set; } - public uint? BlockedThread { get; set; } + public uint? BlockedThread { get; set; } - public ClrObject BlockedJoinableTask { get; set; } + public ClrObject BlockedJoinableTask { get; set; } - public ClrObject SwitchToMainThreadTask { get; set; } + public ClrObject SwitchToMainThreadTask { get; set; } - public AsyncStateMachine? AlterPrevious { get; set; } + public AsyncStateMachine? AlterPrevious { get; set; } - public ulong CodeAddress { get; set; } + public ulong CodeAddress { get; set; } - public override string ToString() - { - return $"state = {this.State} Depth {this.Depth} StateMachine = {this.StateMachine} Task = {this.Task}"; - } + public override string ToString() + { + return $"state = {this.State} Depth {this.Depth} StateMachine = {this.StateMachine} Task = {this.Task}"; } } } diff --git a/src/SosThreadingTools/ExtensionContext.cs b/src/SosThreadingTools/ExtensionContext.cs index aa71a30a8..8d15f2102 100644 --- a/src/SosThreadingTools/ExtensionContext.cs +++ b/src/SosThreadingTools/ExtensionContext.cs @@ -6,39 +6,38 @@ using System.Reflection; using System.Runtime.InteropServices; -namespace CpsDbg +namespace CpsDbg; + +internal static class ExtensionContext { - internal static class ExtensionContext + [DllExport(nameof(DebugExtensionInitialize), CallingConvention.StdCall)] + internal static int DebugExtensionInitialize(ref uint version, ref uint flags) { - [DllExport(nameof(DebugExtensionInitialize), CallingConvention.StdCall)] - internal static int DebugExtensionInitialize(ref uint version, ref uint flags) - { - // Set the extension version to 1, which expects exports with this signature: - // void _stdcall function(IDebugClient *client, const char *args) - version = DEBUG_EXTENSION_VERSION(1, 0); - flags = 0; + // Set the extension version to 1, which expects exports with this signature: + // void _stdcall function(IDebugClient *client, const char *args) + version = DEBUG_EXTENSION_VERSION(1, 0); + flags = 0; - AppDomain currentDomain = AppDomain.CurrentDomain; - currentDomain.AssemblyResolve += new ResolveEventHandler(LoadFromSameFolder); - return 0; - } + AppDomain currentDomain = AppDomain.CurrentDomain; + currentDomain.AssemblyResolve += new ResolveEventHandler(LoadFromSameFolder); + return 0; + } - private static uint DEBUG_EXTENSION_VERSION(uint major, uint minor) - { - return ((major & 0xffff) << 16) | (minor & 0xffff); - } + private static uint DEBUG_EXTENSION_VERSION(uint major, uint minor) + { + return ((major & 0xffff) << 16) | (minor & 0xffff); + } - private static Assembly? LoadFromSameFolder(object sender, ResolveEventArgs args) + private static Assembly? LoadFromSameFolder(object sender, ResolveEventArgs args) + { + string folderPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location); + string assemblyPath = Path.Combine(folderPath, new AssemblyName(args.Name).Name + ".dll"); + if (!File.Exists(assemblyPath)) { - string folderPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location); - string assemblyPath = Path.Combine(folderPath, new AssemblyName(args.Name).Name + ".dll"); - if (!File.Exists(assemblyPath)) - { - return null; - } - - Assembly assembly = Assembly.LoadFrom(assemblyPath); - return assembly; + return null; } + + Assembly assembly = Assembly.LoadFrom(assemblyPath); + return assembly; } } diff --git a/src/SosThreadingTools/ICommandHandler.cs b/src/SosThreadingTools/ICommandHandler.cs index 9042d51bd..489711bbc 100644 --- a/src/SosThreadingTools/ICommandHandler.cs +++ b/src/SosThreadingTools/ICommandHandler.cs @@ -1,10 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace CpsDbg +namespace CpsDbg; + +internal interface ICommandHandler { - internal interface ICommandHandler - { - void Execute(DebuggerContext context, string args); - } + void Execute(DebuggerContext context, string args); } diff --git a/src/SosThreadingTools/Utilities.cs b/src/SosThreadingTools/Utilities.cs index e4bdcc2b7..616273029 100644 --- a/src/SosThreadingTools/Utilities.cs +++ b/src/SosThreadingTools/Utilities.cs @@ -6,70 +6,69 @@ using System.Linq; using Microsoft.Diagnostics.Runtime; -namespace CpsDbg +namespace CpsDbg; + +internal static class Utilities { - internal static class Utilities + internal static ClrObject TryGetObjectField(this ClrObject clrObject, string fieldName) { - internal static ClrObject TryGetObjectField(this ClrObject clrObject, string fieldName) + if (!clrObject.IsNull) { - if (!clrObject.IsNull) + ClrInstanceField? field = clrObject.Type?.GetFieldByName(fieldName); + if (field is object && field.IsObjectReference) { - ClrInstanceField? field = clrObject.Type?.GetFieldByName(fieldName); - if (field is object && field.IsObjectReference) - { - return field.ReadObject(clrObject.Address, interior: false); - } + return field.ReadObject(clrObject.Address, interior: false); } - - return default(ClrObject); } - internal static ClrValueType? TryGetValueClassField(this ClrObject clrObject, string fieldName) + return default(ClrObject); + } + + internal static ClrValueType? TryGetValueClassField(this ClrObject clrObject, string fieldName) + { + if (!clrObject.IsNull) { - if (!clrObject.IsNull) + ClrInstanceField? field = clrObject.Type?.GetFieldByName(fieldName); + if (field?.Type is object && field.Type.IsValueType) { - ClrInstanceField? field = clrObject.Type?.GetFieldByName(fieldName); - if (field?.Type is object && field.Type.IsValueType) - { - // System.Console.WriteLine("{0} {1:x} Field {2} {3} {4} {5}", clrObject.Type.Name, clrObject.Address, fieldName, field.Type.Name, field.Type.IsValueType, field.Type.IsRuntimeType); - return clrObject.ReadValueTypeField(fieldName); - } + // System.Console.WriteLine("{0} {1:x} Field {2} {3} {4} {5}", clrObject.Type.Name, clrObject.Address, fieldName, field.Type.Name, field.Type.IsValueType, field.Type.IsRuntimeType); + return clrObject.ReadValueTypeField(fieldName); } - - return null; } - internal static ClrObject TryGetObjectField(this ClrValueType? clrObject, string fieldName) + return null; + } + + internal static ClrObject TryGetObjectField(this ClrValueType? clrObject, string fieldName) + { + if (clrObject is object) { - if (clrObject is object) + ClrInstanceField? field = clrObject.Value.Type?.GetFieldByName(fieldName); + if (field is object && field.IsObjectReference) { - ClrInstanceField? field = clrObject.Value.Type?.GetFieldByName(fieldName); - if (field is object && field.IsObjectReference) - { - return clrObject.Value.ReadObjectField(fieldName); - } + return clrObject.Value.ReadObjectField(fieldName); } - - return default(ClrObject); } - internal static ClrValueType? TryGetValueClassField(this ClrValueType? clrObject, string fieldName) + return default(ClrObject); + } + + internal static ClrValueType? TryGetValueClassField(this ClrValueType? clrObject, string fieldName) + { + if (clrObject.HasValue) { - if (clrObject.HasValue) + ClrInstanceField? field = clrObject.Value.Type?.GetFieldByName(fieldName); + if (field is object && field.IsValueType) { - ClrInstanceField? field = clrObject.Value.Type?.GetFieldByName(fieldName); - if (field is object && field.IsValueType) - { - return clrObject.Value.ReadValueTypeField(fieldName); - } + return clrObject.Value.ReadValueTypeField(fieldName); } - - return null; } - internal static IEnumerable GetObjectsOfType(this ClrHeap heap, string typeName) - { - return heap.EnumerateObjects().Where(obj => string.Equals(obj.Type?.Name, typeName, StringComparison.Ordinal)); - } + return null; + } + + internal static IEnumerable GetObjectsOfType(this ClrHeap heap, string typeName) + { + return heap.EnumerateObjects().Where(obj => string.Equals(obj.Type?.Name, typeName, StringComparison.Ordinal)); } } diff --git a/test/IsolatedTestHost/ExitCode.cs b/test/IsolatedTestHost/ExitCode.cs index c35a68e9d..fd347daaa 100644 --- a/test/IsolatedTestHost/ExitCode.cs +++ b/test/IsolatedTestHost/ExitCode.cs @@ -1,51 +1,50 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -namespace IsolatedTestHost +namespace IsolatedTestHost; + +/// +/// The meanings of each exit code that may be returned from this process. +/// +public enum ExitCode { /// - /// The meanings of each exit code that may be returned from this process. - /// - public enum ExitCode - { - /// - /// The test executed and passed. - /// - TestPassed = 0, - - /// - /// The test executed and failed. - /// - TestFailed, - - /// - /// The test threw SkipException. - /// - TestSkipped, - - /// - /// The test assembly could not be found. - /// - AssemblyNotFound, - - /// - /// The test class could not be found. - /// - TestClassNotFound, - - /// - /// The test method could not be found. - /// - TestMethodNotFound, - - /// - /// The test class or test method took parameters that are not supported by this host. - /// - TestNotSupported, - - /// - /// Too few or too many command line arguments passed to this process. - /// - UnexpectedCommandLineArgs, - } + /// The test executed and passed. + /// + TestPassed = 0, + + /// + /// The test executed and failed. + /// + TestFailed, + + /// + /// The test threw SkipException. + /// + TestSkipped, + + /// + /// The test assembly could not be found. + /// + AssemblyNotFound, + + /// + /// The test class could not be found. + /// + TestClassNotFound, + + /// + /// The test method could not be found. + /// + TestMethodNotFound, + + /// + /// The test class or test method took parameters that are not supported by this host. + /// + TestNotSupported, + + /// + /// Too few or too many command line arguments passed to this process. + /// + UnexpectedCommandLineArgs, } diff --git a/test/IsolatedTestHost/Program.cs b/test/IsolatedTestHost/Program.cs index bcabc8a3c..6712fa6e0 100644 --- a/test/IsolatedTestHost/Program.cs +++ b/test/IsolatedTestHost/Program.cs @@ -9,112 +9,111 @@ using System.Threading.Tasks; using Xunit; -namespace IsolatedTestHost +namespace IsolatedTestHost; + +internal static class Program { - internal static class Program + private static int Main(string[] args) { - private static int Main(string[] args) + if (args.Length != 3) { - if (args.Length != 3) - { - return (int)ExitCode.UnexpectedCommandLineArgs; - } + return (int)ExitCode.UnexpectedCommandLineArgs; + } - string assemblyFile = args[0]; - string testClassName = args[1]; - string testMethodName = args[2]; + string assemblyFile = args[0]; + string testClassName = args[1]; + string testMethodName = args[2]; - return (int)MyMain(assemblyFile, testClassName, testMethodName); + return (int)MyMain(assemblyFile, testClassName, testMethodName); + } + + private static ExitCode MyMain(string assemblyFile, string testClassName, string testMethodName) + { + Assembly assembly; + try + { + assembly = Assembly.LoadFrom(assemblyFile); + } + catch (FileNotFoundException ex) + { + Console.Error.WriteLine(ex.Message); + return ExitCode.AssemblyNotFound; } - private static ExitCode MyMain(string assemblyFile, string testClassName, string testMethodName) + Type testClass = assembly.GetType(testClassName); + if (testClass is null) { - Assembly assembly; - try - { - assembly = Assembly.LoadFrom(assemblyFile); - } - catch (FileNotFoundException ex) - { - Console.Error.WriteLine(ex.Message); - return ExitCode.AssemblyNotFound; - } + return ExitCode.TestClassNotFound; + } + + MethodInfo testMethod = testClass.GetRuntimeMethod(testMethodName, Type.EmptyTypes); + if (testMethod is null) + { + return ExitCode.TestMethodNotFound; + } + + bool fact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "FactAttribute"); + bool skippableFact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "SkippableFactAttribute"); + if (fact || skippableFact) + { + return ExecuteTest(testClass, testMethod); + } - Type testClass = assembly.GetType(testClassName); - if (testClass is null) + bool stafact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "StaFactAttribute"); + if (stafact) + { + ExitCode result = ExitCode.TestFailed; + var testThread = new Thread(() => { - return ExitCode.TestClassNotFound; - } + result = ExecuteTest(testClass, testMethod); + }); + testThread.SetApartmentState(ApartmentState.STA); + testThread.Start(); + testThread.Join(); + return result; + } - MethodInfo testMethod = testClass.GetRuntimeMethod(testMethodName, Type.EmptyTypes); - if (testMethod is null) + return ExitCode.TestNotSupported; + } + + private static ExitCode ExecuteTest(Type testClass, MethodInfo testMethod) + { + try + { + ConstructorInfo? ctorWithLogger = testClass.GetConstructors().FirstOrDefault( + ctor => ctor.GetParameters().Length == 1 && ctor.GetParameters()[0].ParameterType.IsAssignableFrom(typeof(TestOutputHelper))); + ConstructorInfo? ctorDefault = testClass.GetConstructor(Type.EmptyTypes); + object? testClassInstance = + ctorWithLogger?.Invoke(new object[] { new TestOutputHelper() }) ?? + ctorDefault?.Invoke(Type.EmptyTypes); + if (testClassInstance is null) { - return ExitCode.TestMethodNotFound; + return ExitCode.TestNotSupported; } - bool fact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "FactAttribute"); - bool skippableFact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "SkippableFactAttribute"); - if (fact || skippableFact) + object result = testMethod.Invoke(testClassInstance, Type.EmptyTypes); + if (result is Task resultTask) { - return ExecuteTest(testClass, testMethod); + resultTask.GetAwaiter().GetResult(); } - bool stafact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "StaFactAttribute"); - if (stafact) + if (testClassInstance is IDisposable disposableTestClass) { - ExitCode result = ExitCode.TestFailed; - var testThread = new Thread(() => - { - result = ExecuteTest(testClass, testMethod); - }); - testThread.SetApartmentState(ApartmentState.STA); - testThread.Start(); - testThread.Join(); - return result; + disposableTestClass.Dispose(); } - return ExitCode.TestNotSupported; + return ExitCode.TestPassed; } - - private static ExitCode ExecuteTest(Type testClass, MethodInfo testMethod) + catch (Exception ex) { - try - { - ConstructorInfo? ctorWithLogger = testClass.GetConstructors().FirstOrDefault( - ctor => ctor.GetParameters().Length == 1 && ctor.GetParameters()[0].ParameterType.IsAssignableFrom(typeof(TestOutputHelper))); - ConstructorInfo? ctorDefault = testClass.GetConstructor(Type.EmptyTypes); - object? testClassInstance = - ctorWithLogger?.Invoke(new object[] { new TestOutputHelper() }) ?? - ctorDefault?.Invoke(Type.EmptyTypes); - if (testClassInstance is null) - { - return ExitCode.TestNotSupported; - } - - object result = testMethod.Invoke(testClassInstance, Type.EmptyTypes); - if (result is Task resultTask) - { - resultTask.GetAwaiter().GetResult(); - } - - if (testClassInstance is IDisposable disposableTestClass) - { - disposableTestClass.Dispose(); - } - - return ExitCode.TestPassed; - } - catch (Exception ex) + if (ex.GetType().Name == "SkipException") { - if (ex.GetType().Name == "SkipException") - { - return ExitCode.TestSkipped; - } - - Console.Error.WriteLine("Test failed."); - Console.Error.WriteLine(ex); - return ExitCode.TestFailed; + return ExitCode.TestSkipped; } + + Console.Error.WriteLine("Test failed."); + Console.Error.WriteLine(ex); + return ExitCode.TestFailed; } } } diff --git a/test/IsolatedTestHost/TestOutputHelper.cs b/test/IsolatedTestHost/TestOutputHelper.cs index 1bdf3c17d..b27c20f25 100644 --- a/test/IsolatedTestHost/TestOutputHelper.cs +++ b/test/IsolatedTestHost/TestOutputHelper.cs @@ -4,18 +4,17 @@ using System; using Xunit.Abstractions; -namespace IsolatedTestHost +namespace IsolatedTestHost; + +internal class TestOutputHelper : ITestOutputHelper { - internal class TestOutputHelper : ITestOutputHelper + public void WriteLine(string message) { - public void WriteLine(string message) - { - Console.WriteLine(message); - } + Console.WriteLine(message); + } - public void WriteLine(string format, params object[] args) - { - Console.WriteLine(format, args); - } + public void WriteLine(string format, params object[] args) + { + Console.WriteLine(format, args); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs index f422dd62b..079a3220c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Program.cs @@ -3,17 +3,16 @@ using Microsoft.Win32; -namespace Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher +namespace Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher; + +internal static class Program { - internal static class Program + private static void Main() { - private static void Main() - { - // Watch a registry key. Then try to exit the program. - // If in Win7 support mode we start a thread to monitor for registry changes, - // this verifies that the thread is a *background* thread that won't keep the process running. - RegistryKey? key = Registry.CurrentUser.OpenSubKey("SOFTWARE"); - key.WaitForChangeAsync(); - } + // Watch a registry key. Then try to exit the program. + // If in Win7 support mode we start a thread to monitor for registry changes, + // this verifies that the thread is a *background* thread that won't keep the process running. + RegistryKey? key = Registry.CurrentUser.OpenSubKey("SOFTWARE"); + key.WaitForChangeAsync(); } } From 14c24e3c9da0ed63dc5c14d16fa47e2ec0f6143d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 10:30:27 -0600 Subject: [PATCH 0599/1753] Insert into rel/d17.4 --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..33bdf2e3d 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.4' From dd6b902e431a655eb05615775ba4d7716432ad77 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 10:29:27 -0600 Subject: [PATCH 0600/1753] Set version to '17.5-alpha' --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- version.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index 33bdf2e3d..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.4' +'main' diff --git a/version.json b/version.json index f42813ca4..b249956a2 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.4", + "version": "17.5-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} +} \ No newline at end of file From d7153e9291769aa4c80b19e9cec404010423ef13 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 10:35:03 -0600 Subject: [PATCH 0601/1753] Promote APIs as shipped --- .../net472/PublicAPI.Shipped.txt | 12 ++++++++++++ .../net472/PublicAPI.Unshipped.txt | 12 ------------ .../net6.0-windows/PublicAPI.Shipped.txt | 12 ++++++++++++ .../net6.0-windows/PublicAPI.Unshipped.txt | 12 ------------ .../net6.0/PublicAPI.Shipped.txt | 12 ++++++++++++ .../net6.0/PublicAPI.Unshipped.txt | 12 ------------ .../netcoreapp3.1/PublicAPI.Shipped.txt | 12 ++++++++++++ .../netcoreapp3.1/PublicAPI.Unshipped.txt | 12 ------------ .../netstandard2.0/PublicAPI.Shipped.txt | 12 ++++++++++++ .../netstandard2.0/PublicAPI.Unshipped.txt | 12 ------------ 10 files changed, 60 insertions(+), 60 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt index 3d7cc2bc8..99f3cea34 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt @@ -458,3 +458,15 @@ Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Mic Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 79b8d419e..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,12 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt index 3d7cc2bc8..99f3cea34 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt @@ -458,3 +458,15 @@ Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Mic Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index 79b8d419e..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -1,12 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt index 916298d7d..21783f9f2 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt @@ -456,3 +456,15 @@ Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Mic Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index 79b8d419e..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -1,12 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt index 916298d7d..21783f9f2 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt @@ -456,3 +456,15 @@ Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Mic Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt index 79b8d419e..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt @@ -1,12 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt index 916298d7d..21783f9f2 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt @@ -456,3 +456,15 @@ Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Mic Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan +Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void +Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.SemaphoreFaultedException +Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException +Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void +static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 79b8d419e..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,12 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter From 0f0921d5f8481a21f029ca23e3ff84dca9c6f3f8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 07:27:43 -0600 Subject: [PATCH 0602/1753] Fix VSTHRD110 failure to handle unobserved tasks in finalizers Fixes devdiv-1645072 --- .../CSharpUtils.cs | 6 +++++ ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 24 +++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index fd8b66fb2..633aaa0d2 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -92,6 +92,12 @@ internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode sy BlockSyntax block => o.WithBody(block), _ => throw new NotSupportedException(), }, + DestructorDeclarationSyntax d => (CSharpSyntaxNode newBody) => newBody switch + { + ArrowExpressionClauseSyntax expr => d.WithExpressionBody(expr), + BlockSyntax block => d.WithBody(block), + _ => throw new NotSupportedException(), + }, _ => throw new NotSupportedException(), }; return new ContainingFunctionData(method, method.Modifiers.Any(SyntaxKind.AsyncKeyword), method.ParameterList, method.Body, bodyReplacement); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index 224d392bc..e77c3baff 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -402,6 +402,30 @@ async Task Foo(Test? tester) await Verify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task TaskInFinalizer() + { + string test = @" +using System; +using System.Threading.Tasks; + +public class Test : IAsyncDisposable +{ + ~Test() + { + Task.[|Run|](async () => await DisposeAsync().ConfigureAwait(false)); + } + + public async ValueTask DisposeAsync() + { + await Task.Delay(5000); + } +} +"; + + await Verify.VerifyAnalyzerAsync(test); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length) => Verify.Diagnostic().WithSpan(line, column, line, column + length); } From 5676531eb6cab62940ddf3943c452023175da0c4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 11:16:55 -0600 Subject: [PATCH 0603/1753] Fix a few failing tests --- test/IsolatedTestHost/App.config | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index ce1411ac1..03a0834b7 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -10,13 +10,13 @@ - + - + From 07dd2b0f1279cbcaca8b687c526c05a946cde396 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 12:45:31 -0600 Subject: [PATCH 0604/1753] Fix release pipeline --- azure-pipelines/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 9d942ce75..e102a62ea 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -35,7 +35,7 @@ jobs: - download: CI artifact: deployables-Windows displayName: Download deployables-Windows artifact - patterns: 'deployables-Windows/*' + patterns: 'deployables-Windows/NuGet/*' - task: GitHubRelease@1 displayName: GitHub release (create) inputs: From 2cc8e3ec10ad4812134c74345a7cacced9437c26 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 17:42:39 -0600 Subject: [PATCH 0605/1753] Fix release pipeline --- azure-pipelines/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index db7d7dd0d..175c37a9d 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -35,7 +35,7 @@ jobs: - download: CI artifact: deployables-Windows displayName: 🔻 Download deployables-Windows artifact - patterns: 'deployables-Windows/*' + patterns: 'deployables-Windows/NuGet/*' - task: GitHubRelease@1 displayName: 📢 GitHub release (create) inputs: From bec0a44abf92343e4e685ab63aa2ad63d97099b5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 21 Oct 2022 17:44:36 -0600 Subject: [PATCH 0606/1753] Enable CodeQL --- azure-pipelines/official.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index d469afdf3..ad1544c02 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -52,6 +52,7 @@ stages: NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages SignTypeSelection: ${{ parameters.SignTypeSelection }} Packaging.EnableSBOMSigning: false + Codeql.Enabled: true jobs: - template: build.yml From c3be0152c23ebc3f49d87081bec1875583684bbb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 24 Oct 2022 13:10:18 -0600 Subject: [PATCH 0607/1753] Fix scheduled run of source code archival pipeline --- azure-pipelines/archive-sourcecode.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 2f00a00cb..0c99a236b 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -19,6 +19,7 @@ parameters: - name: whatif displayName: Only simulate the request type: boolean + default: false variables: - group: VS Core team # Expected to provide ManagerAlias, SourceCodeArchivalUri From 0d28ad612a8ca322fd44cefa0e4024ad7a9066c0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 24 Oct 2022 14:04:19 -0600 Subject: [PATCH 0608/1753] Update MicroBuild to 2.0.87 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index f74cb06d0..a07c9a88e 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -34,7 +34,7 @@ true snupkg - 2.0.84 + 2.0.87 From cffffa4afb7b44d45896d8138d6464bc92650fbe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 24 Oct 2022 14:17:43 -0600 Subject: [PATCH 0609/1753] Update Nerdbank.GitVersioning version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 8cada6c76..abdb9d8b1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -40,7 +40,7 @@ - + From 2a5a528133ac007b2facba8b53cfbdb86f0f0b67 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 31 Oct 2022 08:51:51 -0600 Subject: [PATCH 0610/1753] Improve verbose output of artifact collection --- azure-pipelines/artifacts/_all.ps1 | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/artifacts/_all.ps1 b/azure-pipelines/artifacts/_all.ps1 index 033cc87c9..9a22a1d08 100755 --- a/azure-pipelines/artifacts/_all.ps1 +++ b/azure-pipelines/artifacts/_all.ps1 @@ -38,6 +38,7 @@ Get-ChildItem "$PSScriptRoot\*.ps1" -Exclude "_*" -Recurse | % { $ArtifactName = $_.BaseName if ($Force -or !(Test-ArtifactStaged($ArtifactName + $ArtifactNameSuffix))) { $totalFileCount = 0 + Write-Verbose "Collecting file list for artifact $($_.BaseName)" $fileGroups = & $_ if ($fileGroups) { $fileGroups.GetEnumerator() | % { From 77fcd3de2d9f7c6368cc0baeb6cf6e23a204bdaa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 08:16:02 -0600 Subject: [PATCH 0611/1753] Switch to NuGet's central package versioning --- Directory.Build.props | 13 ++++++------- Directory.Packages.props | 17 +++++++++++++++++ test/Library.Tests/Library.Tests.csproj | 6 +++--- 3 files changed, 26 insertions(+), 10 deletions(-) create mode 100644 Directory.Packages.props diff --git a/Directory.Build.props b/Directory.Build.props index abdb9d8b1..8f186a7c7 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -39,13 +39,12 @@ - - - - - - - + + + + + + diff --git a/Directory.Packages.props b/Directory.Packages.props new file mode 100644 index 000000000..8bec0397a --- /dev/null +++ b/Directory.Packages.props @@ -0,0 +1,17 @@ + + + + true + + + + + + + + + + + + + diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 4e9a7a4c4..39650b7d7 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,9 +10,9 @@ - - - + + + From b894b8a9901dfcbec1030860da30bf6c7507bd19 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 08:22:12 -0600 Subject: [PATCH 0612/1753] Update to the .NET 7.0.100-rc.2 SDK This removes the warning about using NuGet CPVM, "a preview feature". --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 7bf6fc99a..01e689ed8 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "6.0.401", + "version": "7.0.100-rc.2.22477.23", "rollForward": "patch", "allowPrerelease": false } From ab4fb10d210dd404d8d04aa14c706af271129d0e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 08:29:15 -0600 Subject: [PATCH 0613/1753] Switch to using GlobalPackageReference --- Directory.Build.props | 9 --------- Directory.Packages.props | 14 ++++++++------ 2 files changed, 8 insertions(+), 15 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 8f186a7c7..301047d1e 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -38,15 +38,6 @@ snupkg - - - - - - - - - diff --git a/Directory.Packages.props b/Directory.Packages.props index 8bec0397a..2b94d74d9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,14 +4,16 @@ true - - - - - - + + + + + + + + From 318aaadd6dc4f2b674e5f7c18e9940550a1b3e43 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 08:45:31 -0600 Subject: [PATCH 0614/1753] Move GitHub-specific package ref to its own group This is to reduce merge conflicts with the microbuild branch where nearby lines change a lot. --- Directory.Packages.props | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2b94d74d9..c33a3beb0 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,9 +11,11 @@ - + + + From 428672900e289ae0e59dccdfe51cf5b4e9fd3884 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 09:12:45 -0600 Subject: [PATCH 0615/1753] Remove old style build from template expansion test --- azure-pipelines/expand-template.yml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index 1a8b32404..0047e5368 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -14,14 +14,5 @@ steps: - powershell: .\init.ps1 displayName: 🔽 Install prereqs and restore packages -- task: VSBuild@1 - displayName: 🛠 Build Visual Studio solution (expanded template) - inputs: - msbuildArgs: /t:build,pack /m - platform: Any CPU - configuration: $(BuildConfiguration) - condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - - script: dotnet build displayName: 🛠 dotnet build (expanded template) - condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) From 253e62c08488d57a5b740fb68475501353713cdd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 12:02:25 -0600 Subject: [PATCH 0616/1753] Simplify parent import pattern --- src/Directory.Build.props | 2 +- src/Directory.Build.targets | 2 +- test/Directory.Build.props | 2 +- test/Directory.Build.targets | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 77d947658..052fe3ef0 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,3 +1,3 @@ - + diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 566ab4fcf..c1d929a5b 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -3,5 +3,5 @@ - + diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 449a06e45..ad4a4b6c5 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -1,5 +1,5 @@ - + false diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index e7edee55a..052fe3ef0 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,3 +1,3 @@ - + From 610968dc21b84a116d0bd1c7a0ff00441308f536 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 12:27:24 -0600 Subject: [PATCH 0617/1753] Remove redundant attribute --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 14fd97040..75b671532 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -18,7 +18,7 @@ - + From f91a0e871d9f794cc36020341f358718d6b07f83 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 14:19:46 -0600 Subject: [PATCH 0618/1753] Avoid .NET 7 SDK till it's stable Otherwise, msbuild.exe fails on VS 17.3, which is the latest stable release. We need to wait till folks can use VS 17.4 to use the .NET 7 SDK. --- Directory.Packages.props | 24 ++++++++++++++++++------ global.json | 2 +- 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c33a3beb0..8c1e8f80a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,14 +8,26 @@ + - - - - - + + + + + - + + + + + + + + + + + diff --git a/global.json b/global.json index 01e689ed8..3ce46e096 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.100-rc.2.22477.23", + "version": "6.0.402", "rollForward": "patch", "allowPrerelease": false } From 956093988fd134e694a50850e9488953ba4aaed2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 4 Nov 2022 14:22:24 -0600 Subject: [PATCH 0619/1753] Avoid spreading package version information into test directory --- Directory.Packages.props | 1 + test/Directory.Build.props | 4 ++++ test/Directory.Packages.props | 7 ------- 3 files changed, 5 insertions(+), 7 deletions(-) delete mode 100644 test/Directory.Packages.props diff --git a/Directory.Packages.props b/Directory.Packages.props index 75b671532..a27701624 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,6 +7,7 @@ + diff --git a/test/Directory.Build.props b/test/Directory.Build.props index f3d4b88ba..1ca1ec44f 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -5,4 +5,8 @@ false true + + + + diff --git a/test/Directory.Packages.props b/test/Directory.Packages.props deleted file mode 100644 index 14735472a..000000000 --- a/test/Directory.Packages.props +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - From a61d5a3770b73e92683e9c73bb3ddd05e80f0108 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 7 Nov 2022 07:56:26 -0700 Subject: [PATCH 0620/1753] Dependency updates (#1110) * Bump Microsoft.VisualStudio.Validation from 17.0.64 to 17.0.65 Bumps [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) from 17.0.64 to 17.0.65. - [Release notes](https://github.com/microsoft/vs-validation/releases) - [Commits](https://github.com/microsoft/vs-validation/commits) --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Validation dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * Bump Microsoft.VisualStudio.Shell.15.0 Bumps Microsoft.VisualStudio.Shell.15.0 from 17.2.32531.470 to 17.4.33103.184. --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Shell.15.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump Microsoft.VisualStudio.Interop Bumps Microsoft.VisualStudio.Interop from 17.3.32630.470 to 17.4.33103.184. --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Interop dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump Microsoft.VisualStudio.Shell.Framework Bumps Microsoft.VisualStudio.Shell.Framework from 17.2.32531.470 to 17.4.33103.184. --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Shell.Framework dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 9a5e561d9..2be4c3824 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -22,10 +22,10 @@ - - - - + + + + From c32551d1365873cdf6c26bec81c07481fa2b28fe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 7 Nov 2022 08:59:40 -0700 Subject: [PATCH 0621/1753] Add Directory.Packages.props as a solution item --- Library.sln | 1 + 1 file changed, 1 insertion(+) diff --git a/Library.sln b/Library.sln index 606811aaf..638efb568 100644 --- a/Library.sln +++ b/Library.sln @@ -12,6 +12,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution .editorconfig = .editorconfig Directory.Build.props = Directory.Build.props Directory.Build.targets = Directory.Build.targets + Directory.Packages.props = Directory.Packages.props global.json = global.json nuget.config = nuget.config README.md = README.md From a83e88dac6a824cd80e8ad6024b29a473ca2e270 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 7 Nov 2022 10:06:00 -0700 Subject: [PATCH 0622/1753] Remove uses of politically sensitive terms --- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 1f7191d9f..cc9e016fb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -187,7 +187,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) return null; } - // Whitelist Task.From*() methods. + // Allow Task.From*() methods. if (!context.TryGetNewOrExistingSemanticModel(invocationSyntax.SyntaxTree, out SemanticModel? declarationSemanticModel)) { return null; @@ -211,7 +211,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) ISymbol? definition = declarationSemanticModel.GetSymbolInfo(memberAccessSyntax, cancellationToken).Symbol; if (definition is IFieldSymbol field) { - // Whitelist the TplExtensions.CompletedTask and related fields. + // Allow the TplExtensions.CompletedTask and related fields. if (field.ContainingType.Name == Types.TplExtensions.TypeName && field.BelongsToNamespace(Types.TplExtensions.Namespace) && (field.Name == Types.TplExtensions.CompletedTask || field.Name == Types.TplExtensions.CanceledTask || field.Name == Types.TplExtensions.TrueTask || field.Name == Types.TplExtensions.FalseTask)) { From 295d06694b9fd0993197bb6c1ea94731c2b4bb05 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 10 Nov 2022 17:26:57 +0000 Subject: [PATCH 0623/1753] Use static code coverage preview This is in an attempt to fix #180 --- Directory.Packages.props | 1 + azure-pipelines/test.runsettings | 6 ++++-- nuget.config | 1 + test/Library.Tests/Library.Tests.csproj | 1 + 4 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 8c1e8f80a..d12266917 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,6 +4,7 @@ true + diff --git a/azure-pipelines/test.runsettings b/azure-pipelines/test.runsettings index c69022fc0..975b71233 100644 --- a/azure-pipelines/test.runsettings +++ b/azure-pipelines/test.runsettings @@ -31,11 +31,13 @@ False - True + False - True + False True + True + False diff --git a/nuget.config b/nuget.config index 22f7b8098..9454ec025 100644 --- a/nuget.config +++ b/nuget.config @@ -7,6 +7,7 @@ + diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 39650b7d7..2eb4afe1e 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,6 +10,7 @@ + From ad6e2422bed202dfd0e95a567635809eb9b3a2f3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Nov 2022 15:19:51 +0000 Subject: [PATCH 0624/1753] Resolve NU1507 warning --- nuget.config | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/nuget.config b/nuget.config index 9454ec025..6ce7cfd05 100644 --- a/nuget.config +++ b/nuget.config @@ -13,4 +13,12 @@ + + + + + + + + From 66a302c4e7c60633ad09c232f0b8cd105ab1f795 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Nov 2022 12:17:50 -0700 Subject: [PATCH 0625/1753] Update Microsoft.NET.Test.Sdk --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d12266917..924f4b4e0 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ - + @@ -31,4 +31,4 @@ - + \ No newline at end of file From 0443ebe4e17636a5ce0a6280648b03f6deaf65ef Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Nov 2022 07:03:32 -0700 Subject: [PATCH 0626/1753] Add CompilationEnd tag to VSTHRD010 analyzer Fixes #1113 --- .../VSTHRD010MainThreadUsageAnalyzer.cs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs index e3c366283..55bb07f31 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs @@ -64,7 +64,8 @@ public class VSTHRD010MainThreadUsageAnalyzer : DiagnosticAnalyzer helpLinkUri: Utils.GetHelpLink(Id), category: "Usage", defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + isEnabledByDefault: true, + customTags: "CompilationEnd" /*WellKnownDiagnosticTags.CompilationEnd*/); /// /// The descriptor to use for diagnostics reported in async methods. @@ -76,7 +77,8 @@ public class VSTHRD010MainThreadUsageAnalyzer : DiagnosticAnalyzer helpLinkUri: Utils.GetHelpLink(Id), category: "Usage", defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); + isEnabledByDefault: true, + customTags: "CompilationEnd" /*WellKnownDiagnosticTags.CompilationEnd*/); /// /// A reusable value to return from . From 450869369c56cfc09e73a4e24f8e96f5209f8e43 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Nov 2022 08:54:27 -0700 Subject: [PATCH 0627/1753] Retarget analyzers to the 3.11.0 version This means the analyzers will now require at least Dev16.11. --- Directory.Packages.props | 4 +- Microsoft.VisualStudio.Threading.sln | 33 +++++++- .../CSharpCommonInterest.cs | 4 +- .../CSharpUtils.cs | 14 ++-- ...alStudio.Threading.Analyzers.CSharp.csproj | 2 +- .../VSTHRD002UseJtfRunAnalyzer.cs | 6 +- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 10 +-- .../VSTHRD010MainThreadUsageAnalyzer.cs | 32 +++---- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 8 +- ...7AwaitTaskWithinUsingExpressionAnalyzer.cs | 2 +- .../FixUtils.cs | 84 ++++++++++--------- ...tudio.Threading.Analyzers.CodeFixes.csproj | 2 +- .../VSTHRD002UseJtfRunCodeFixWithAwait.cs | 24 +++--- .../VSTHRD010MainThreadUsageCodeFix.cs | 14 ++-- .../VSTHRD100AsyncVoidMethodCodeFix.cs | 4 +- .../VSTHRD103UseAsyncOptionCodeFix.cs | 39 +++++---- ...07AwaitTaskWithinUsingExpressionCodeFix.cs | 8 +- ...THRD109AvoidAssertInAsyncMethodsCodeFix.cs | 12 +-- .../VSTHRD111UseConfigureAwaitCodeFix.cs | 6 +- ...2ImplementSystemIAsyncDisposableCodeFix.cs | 21 +++-- .../VSTHRD114AvoidReturningNullTaskCodeFix.cs | 6 +- ...STHRD200UseAsyncNamingConventionCodeFix.cs | 25 +++--- ...dio.Threading.Analyzers.VisualBasic.csproj | 2 +- .../VisualBasicUtils.cs | 6 +- ...AbstractVSTHRD012SpecifyJtfWhereAllowed.cs | 13 ++- ...8AssertThreadRequirementUnconditionally.cs | 4 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 2 +- .../CommonInterest.cs | 2 +- .../DiagnosticAnalyzerState.cs | 4 +- ...ft.VisualStudio.Threading.Analyzers.csproj | 2 +- .../Utils.cs | 54 ++++++------ ...3CheckForSystemIAsyncDisposableAnalyzer.cs | 12 +-- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 4 +- 33 files changed, 260 insertions(+), 205 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2be4c3824..330f8e822 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,8 +4,8 @@ true 2.0.87 - 2.10.0 - 3.11.0 + 3.11.0 + 4.4.0 1.1.1 diff --git a/Microsoft.VisualStudio.Threading.sln b/Microsoft.VisualStudio.Threading.sln index 6e6704560..aab07fca4 100644 --- a/Microsoft.VisualStudio.Threading.sln +++ b/Microsoft.VisualStudio.Threading.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.28413.118 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.33116.440 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers", "src\Microsoft.VisualStudio.Threading.Analyzers\Microsoft.VisualStudio.Threading.Analyzers.csproj", "{536F3F9A-B457-43B8-BC93-CE1C16959037}" EndProject @@ -12,6 +12,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution .editorconfig = .editorconfig azure-pipelines\build.yml = azure-pipelines\build.yml Directory.Build.props = Directory.Build.props + Directory.Build.targets = Directory.Build.targets + Directory.Packages.props = Directory.Packages.props global.json = global.json nuget.config = nuget.config stylecop.json = stylecop.json @@ -34,6 +36,21 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Thre EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers.VisualBasic", "src\Microsoft.VisualStudio.Threading.Analyzers.VisualBasic\Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj", "{8CDF7526-D625-4E16-A266-BAF654ABE181}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{96134B19-FB32-4FA0-A565-BD4247D1E5B2}" + ProjectSection(SolutionItems) = preProject + src\.editorconfig = src\.editorconfig + src\AssemblyInfo.cs = src\AssemblyInfo.cs + src\Directory.Build.props = src\Directory.Build.props + src\Directory.Build.targets = src\Directory.Build.targets + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{C1DAF484-769B-4C5E-9DD1-A4CFAA66E938}" + ProjectSection(SolutionItems) = preProject + test\.editorconfig = test\.editorconfig + test\Directory.Build.props = test\Directory.Build.props + test\Directory.Build.targets = test\Directory.Build.targets + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -124,6 +141,18 @@ Global GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {536F3F9A-B457-43B8-BC93-CE1C16959037} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {620ED702-B6DA-4454-BF3E-5494D3652724} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} + {3BDB8F46-A39C-422B-8B0E-89E98B83073F} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {8CDF7526-D625-4E16-A266-BAF654ABE181} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {E2124DFF-970E-4BA1-9E50-3ADB0AABF347} EndGlobalSection diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs index d72dcd915..497469f95 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpCommonInterest.cs @@ -113,7 +113,7 @@ internal static void InspectMemberAccess( } } - private static SyntaxNode? GetEnclosingBlock(SyntaxNode node) + private static SyntaxNode? GetEnclosingBlock(SyntaxNode? node) { while (node is not null) { @@ -186,7 +186,7 @@ private static bool IsTaskCompletedWithWhenAll(SyntaxNodeAnalysisContext context // Is this `Task.WhenAll` invocation from the System.Threading.Tasks.Task type? ITypeSymbol? classType = context.SemanticModel.GetTypeInfo(memberAccess.Expression).Type; - var correctType = classType.Name == Types.Task.TypeName && classType.BelongsToNamespace(Types.Task.Namespace); + var correctType = classType?.Name == Types.Task.TypeName && classType.BelongsToNamespace(Types.Task.Namespace); if (!correctType) { return false; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index c53a6efe9..faf7549af 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -40,7 +40,7 @@ internal static ExpressionSyntax IsolateMethodName(InvocationExpressionSyntax in /// /// The syntax node to begin the search from. /// The containing function, and metadata for it. - internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode syntaxNode) + internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode? syntaxNode) { while (syntaxNode is object) { @@ -103,7 +103,7 @@ internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode sy return new ContainingFunctionData(method, method.Modifiers.Any(SyntaxKind.AsyncKeyword), method.ParameterList, method.Body, bodyReplacement); } - syntaxNode = (CSharpSyntaxNode)syntaxNode.Parent; + syntaxNode = (CSharpSyntaxNode?)syntaxNode.Parent; } return default(ContainingFunctionData); @@ -147,7 +147,7 @@ internal static bool IsAssignedWithin(SyntaxNode container, SemanticModel semant if (node is AssignmentExpressionSyntax assignment) { ISymbol? assignedSymbol = semanticModel.GetSymbolInfo(assignment.Left, cancellationToken).Symbol; - if (variable.Equals(assignedSymbol)) + if (variable.Equals(assignedSymbol, SymbolEqualityComparer.Default)) { return true; } @@ -207,7 +207,7 @@ internal static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) foreach (BaseTypeSyntax? baseTypeSyntax in typeDeclarationSyntax.BaseList.Types) { SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(baseTypeSyntax.Type, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) + if (SymbolEqualityComparer.Default.Equals(baseTypeSymbolInfo.Symbol, baseType)) { return baseTypeSyntax.GetLocation(); } @@ -264,7 +264,7 @@ internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSy internal readonly struct ContainingFunctionData { - internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax parameterList, CSharpSyntaxNode blockOrExpression, Func bodyReplacement) + internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax? parameterList, CSharpSyntaxNode? blockOrExpression, Func bodyReplacement) { this.Function = function; this.IsAsync = isAsync; @@ -277,9 +277,9 @@ internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, Paramet internal bool IsAsync { get; } - internal ParameterListSyntax ParameterList { get; } + internal ParameterListSyntax? ParameterList { get; } - internal CSharpSyntaxNode BlockOrExpression { get; } + internal CSharpSyntaxNode? BlockOrExpression { get; } internal Func BodyReplacement { get; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj index cc23cdbdb..393de50bd 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj @@ -1,6 +1,6 @@  - netstandard1.3 + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers false diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs index 7ba3d2a46..6a7cc8661 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs @@ -122,9 +122,9 @@ private static void InspectMemberAccess( if (firstParameter is object) { // Are we accessing a member of the completed task? - ISymbol invokedObjectSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax.Expression, context.CancellationToken).Symbol; - IParameterSymbol completedTask = context.SemanticModel.GetDeclaredSymbol(firstParameter); - if (EqualityComparer.Default.Equals(invokedObjectSymbol, completedTask)) + ISymbol? invokedObjectSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax.Expression, context.CancellationToken).Symbol; + IParameterSymbol? completedTask = context.SemanticModel.GetDeclaredSymbol(firstParameter); + if (EqualityComparer.Default.Equals(invokedObjectSymbol, completedTask)) { // Skip analysis since Task.Result (et. al) of a completed Task is fair game. return; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index cc9e016fb..25328fdb5 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -117,7 +117,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) } } - private Diagnostic? AnalyzeAwaitedOrReturnedExpression(ExpressionSyntax expressionSyntax, SyntaxNodeAnalysisContext context, CancellationToken cancellationToken) + private Diagnostic? AnalyzeAwaitedOrReturnedExpression(ExpressionSyntax? expressionSyntax, SyntaxNodeAnalysisContext context, CancellationToken cancellationToken) { if (expressionSyntax is null) { @@ -242,7 +242,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) // Consider the implicit first argument when this method is invoked as an extension method. if (methodSymbol.IsExtensionMethod && invocationExpressionSyntax.Expression is MemberAccessExpressionSyntax invokedMember) { - if (!methodSymbol.ContainingType.Equals(semanticModel.GetSymbolInfo(invokedMember.Expression, cancellationToken).Symbol)) + if (!methodSymbol.ContainingType.Equals(semanticModel.GetSymbolInfo(invokedMember.Expression, cancellationToken).Symbol, SymbolEqualityComparer.Default)) { expressionsToConsider = new ExpressionSyntax[] { invokedMember.Expression }.Concat(expressionsToConsider); } @@ -268,11 +268,11 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) if (dataflowAnalysisCompatibleVariable) { // Run data flow analysis to understand where the task was defined - DataFlowAnalysis dataFlowAnalysis; + DataFlowAnalysis? dataFlowAnalysis; // When possible (await is direct child of the block and not a field), execute data flow analysis by passing first and last statement to capture only what happens before the await // Check if the await is direct child of the code block (first parent is ExpressionStantement, second parent is the block itself) - if (delegateBlock.Equals(expressionSyntax.Parent.Parent?.Parent)) + if (delegateBlock.Equals(expressionSyntax.Parent?.Parent?.Parent)) { dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock.ChildNodes().First(), expressionSyntax.Parent.Parent); } @@ -282,7 +282,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock); } - if (!dataFlowAnalysis.WrittenInside.Contains(symbolToConsider.Symbol)) + if (dataFlowAnalysis?.WrittenInside.Contains(symbolToConsider.Symbol) is false) { return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs index 43ec46b3d..895b8bd33 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs @@ -120,13 +120,13 @@ public override void Initialize(AnalysisContext context) var mainThreadAssertingMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForMethodsThatAssertMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); var mainThreadSwitchingMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); var membersRequiringMainThread = CommonInterest.ReadTypesAndMembers(compilationStartContext.Options, CommonInterest.FileNamePatternForMembersRequiringMainThread, compilationStartContext.CancellationToken).ToImmutableArray(); - ImmutableDictionary? diagnosticProperties = ImmutableDictionary.Empty + ImmutableDictionary? diagnosticProperties = ImmutableDictionary.Empty .Add(CommonInterest.FileNamePatternForMethodsThatAssertMainThread.ToString(), string.Join("\n", mainThreadAssertingMethods)) .Add(CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread.ToString(), string.Join("\n", mainThreadSwitchingMethods)); - var methodsDeclaringUIThreadRequirement = new HashSet(); - var methodsAssertingUIThreadRequirement = new HashSet(); - var callerToCalleeMap = new Dictionary>(); + var methodsDeclaringUIThreadRequirement = new HashSet(SymbolEqualityComparer.Default); + var methodsAssertingUIThreadRequirement = new HashSet(SymbolEqualityComparer.Default); + var callerToCalleeMap = new Dictionary>(SymbolEqualityComparer.Default); compilationStartContext.RegisterCodeBlockStartAction(codeBlockStartContext => { @@ -157,10 +157,10 @@ public override void Initialize(AnalysisContext context) HashSet? transitiveClosureOfMainThreadRequiringMethods = GetTransitiveClosureOfMainThreadRequiringMethods(methodsAssertingUIThreadRequirement, calleeToCallerMap); foreach (IMethodSymbol? implicitUserMethod in transitiveClosureOfMainThreadRequiringMethods.Except(methodsDeclaringUIThreadRequirement)) { - var reportSites = from info in callerToCalleeMap[implicitUserMethod] - where transitiveClosureOfMainThreadRequiringMethods.Contains(info.MethodSymbol) - group info by info.MethodSymbol into bySymbol - select new { Location = bySymbol.First().InvocationSyntax.GetLocation(), CalleeMethod = bySymbol.Key }; + var reportSites = callerToCalleeMap[implicitUserMethod] + .Where(info => transitiveClosureOfMainThreadRequiringMethods.Contains(info.MethodSymbol)) + .GroupBy(info => info.MethodSymbol, SymbolEqualityComparer.Default) + .Select(bySymbol => new { Location = bySymbol.First().InvocationSyntax.GetLocation(), CalleeMethod = bySymbol.Key }); foreach (var site in reportSites) { bool isAsync = Utils.IsAsyncReady(implicitUserMethod); @@ -181,7 +181,7 @@ group info by info.MethodSymbol into bySymbol private static HashSet GetTransitiveClosureOfMainThreadRequiringMethods(HashSet methodsRequiringUIThread, Dictionary> calleeToCallerMap) { - var result = new HashSet(); + var result = new HashSet(SymbolEqualityComparer.Default); void MarkMethod(IMethodSymbol method) { @@ -208,7 +208,7 @@ void MarkMethod(IMethodSymbol method) private static Dictionary> CreateCalleeToCallerMap(Dictionary> callerToCalleeMap) { - var result = new Dictionary>(); + var result = new Dictionary>(SymbolEqualityComparer.Default); foreach (KeyValuePair> item in callerToCalleeMap) { @@ -307,7 +307,7 @@ public MethodAnalyzer( ImmutableArray membersRequiringMainThread, HashSet methodsDeclaringUIThreadRequirement, HashSet methodsAssertingUIThreadRequirement, - ImmutableDictionary diagnosticProperties) + ImmutableDictionary diagnosticProperties) { this.MainThreadAssertingMethods = mainThreadAssertingMethods; this.MainThreadSwitchingMethods = mainThreadSwitchingMethods; @@ -327,7 +327,7 @@ public MethodAnalyzer( internal HashSet MethodsAssertingUIThreadRequirement { get; } - internal ImmutableDictionary DiagnosticProperties { get; } + internal ImmutableDictionary DiagnosticProperties { get; } internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) { @@ -452,10 +452,10 @@ private static bool IsObjectLikelyToBeCOMObject(ITypeSymbol typeSymbol) } return typeSymbol.GetAttributes().Any(ad => - (ad.AttributeClass.Name == Types.CoClassAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.CoClassAttribute.Namespace)) || - (ad.AttributeClass.Name == Types.ComImportAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.ComImportAttribute.Namespace)) || - (ad.AttributeClass.Name == Types.InterfaceTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.InterfaceTypeAttribute.Namespace)) || - (ad.AttributeClass.Name == Types.TypeLibTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.TypeLibTypeAttribute.Namespace))); + (ad.AttributeClass?.Name == Types.CoClassAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.CoClassAttribute.Namespace)) || + (ad.AttributeClass?.Name == Types.ComImportAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.ComImportAttribute.Namespace)) || + (ad.AttributeClass?.Name == Types.InterfaceTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.InterfaceTypeAttribute.Namespace)) || + (ad.AttributeClass?.Name == Types.TypeLibTypeAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.TypeLibTypeAttribute.Namespace))); } private bool AnalyzeMemberWithinContext(ITypeSymbol type, ISymbol? symbol, SyntaxNodeAnalysisContext context, Location? focusDiagnosticOn = null) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index 8f655edf7..e4ec4f44d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -110,7 +110,7 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) asyncMethodName, includeReducedExtensionMethods: true); - MethodDeclarationSyntax invocationDeclaringMethod = invocationExpressionSyntax.FirstAncestorOrSelf(); + MethodDeclarationSyntax? invocationDeclaringMethod = invocationExpressionSyntax.FirstAncestorOrSelf(); ExpressionSyntax invokedMethodName = CSharpUtils.IsolateMethodName(invocationExpressionSyntax); foreach (IMethodSymbol m in symbols.OfType()) { @@ -120,7 +120,7 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) && m.HasAsyncCompatibleReturnType()) { // An async alternative exists. - ImmutableDictionary? properties = ImmutableDictionary.Empty + ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(AsyncMethodKeyName, asyncMethodName); Diagnostic diagnostic = Diagnostic.Create( @@ -148,7 +148,7 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) /// private static bool HasSupersetOfParameterTypes(IMethodSymbol candidateMethod, IMethodSymbol baselineMethod) { - return candidateMethod.Parameters.All(candidateParameter => baselineMethod.Parameters.Any(baselineParameter => baselineParameter.Type?.Equals(candidateParameter.Type) ?? false)); + return candidateMethod.Parameters.All(candidateParameter => baselineMethod.Parameters.Any(baselineParameter => baselineParameter.Type?.Equals(candidateParameter.Type, SymbolEqualityComparer.Default) ?? false)); } private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext context) @@ -189,7 +189,7 @@ private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, [NotN if (item.Method.IsMatch(memberSymbol)) { Location? location = memberAccessSyntax.Name.GetLocation(); - ImmutableDictionary? properties = ImmutableDictionary.Empty + ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(ExtensionMethodNamespaceKeyName, item.ExtensionMethodNamespace is object ? string.Join(".", item.ExtensionMethodNamespace) : string.Empty); DiagnosticDescriptor descriptor; var messageArgs = new List(2); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs index 642a81a13..e214b5057 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzer.cs @@ -63,7 +63,7 @@ private void AnalyzeNode(SyntaxNodeAnalysisContext context) if (usingStatement.Expression is object) { TypeInfo expressionTypeInfo = context.SemanticModel.GetTypeInfo(usingStatement.Expression, context.CancellationToken); - ITypeSymbol expressionType = expressionTypeInfo.Type; + ITypeSymbol? expressionType = expressionTypeInfo.Type; if (expressionType?.Name == nameof(Task) && expressionType.BelongsToNamespace(Namespaces.SystemThreadingTasks)) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs index 9a412a9c4..8d9fac560 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs @@ -19,7 +19,7 @@ internal static class FixUtils { internal const string BookmarkAnnotationName = "Bookmark"; - internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this AnonymousFunctionExpressionSyntax method, bool hasReturnValue, SemanticModel semanticModel, CancellationToken cancellationToken) + internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this AnonymousFunctionExpressionSyntax method, bool hasReturnValue, SemanticModel? semanticModel, CancellationToken cancellationToken) { if (method.AsyncKeyword.IsKind(SyntaxKind.AsyncKeyword)) { @@ -127,12 +127,7 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous // Fix up any return statements to await on the Task it would have returned. bool returnTypeChanged = method.ReturnType != returnType; - BlockSyntax updatedBody = UpdateStatementsForAsyncMethod( - method.Body, - semanticModel, - hasReturnValue, - returnTypeChanged, - cancellationToken); + BlockSyntax? updatedBody = method.Body is null ? null : UpdateStatementsForAsyncMethod(method.Body, semanticModel, hasReturnValue, returnTypeChanged, cancellationToken); // Apply the changes to the document, and null out stale data. SyntaxAnnotation methodBookmark; @@ -154,7 +149,7 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous string newName = method.Identifier.ValueText + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix; semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); + methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken) ?? throw new InvalidOperationException("Unable to find method symbol."); // Don't rename entrypoint (i.e. "Main") methods. if (!Utils.IsEntrypointMethod(methodSymbol, semanticModel, cancellationToken)) @@ -162,13 +157,14 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous Solution? solution = await Renamer.RenameSymbolAsync( document.Project.Solution, methodSymbol, + ////new SymbolRenameOptions { RenameInComments = true }, // Required by later compiler version newName, document.Project.Solution.Workspace.Options, cancellationToken).ConfigureAwait(false); - document = solution.GetDocument(document.Id); + document = solution.GetDocumentOrThrow(document.Id); semanticModel = null; methodSymbol = null; - SyntaxNode? root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode? root = await document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); method = (MethodDeclarationSyntax)root.GetAnnotatedNodes(methodBookmark).Single(); } } @@ -177,26 +173,26 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous if (returnTypeChanged) { semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken); + methodSymbol = semanticModel.GetDeclaredSymbol(method, cancellationToken) ?? throw new InvalidOperationException("Unable to find method symbol."); SyntaxAnnotation callerAnnotation; Solution solution = document.Project.Solution; List annotatedDocumentIds; (solution, callerAnnotation, annotatedDocumentIds) = await AnnotateAllCallersAsync(solution, methodSymbol, cancellationToken).ConfigureAwait(false); foreach (DocumentId docId in annotatedDocumentIds) { - document = solution.GetDocument(docId); - SyntaxTree? tree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); - SyntaxNode? root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); + document = solution.GetDocumentOrThrow(docId); + SyntaxTree tree = await document.GetSyntaxTreeOrThrowAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); var rewriter = new AwaitCallRewriter(callerAnnotation); root = rewriter.Visit(root); - solution = solution.GetDocument(tree).WithSyntaxRoot(root).Project.Solution; + solution = solution.GetDocumentOrThrow(tree).WithSyntaxRoot(root).Project.Solution; } foreach (DocumentId docId in annotatedDocumentIds) { - document = solution.GetDocument(docId); - SyntaxTree? tree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); - SyntaxNode? root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); + document = solution.GetDocumentOrThrow(docId); + SyntaxTree tree = await document.GetSyntaxTreeOrThrowAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode root = await tree.GetRootAsync(cancellationToken).ConfigureAwait(false); for (SyntaxNode? node = root.GetAnnotatedNodes(callerAnnotation).FirstOrDefault(); node is object; node = root.GetAnnotatedNodes(callerAnnotation).FirstOrDefault()) { MethodDeclarationSyntax? callingMethod = node.FirstAncestorOrSelf(); @@ -207,9 +203,9 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous // Clear all annotations of callers from this method so we don't revisit it. root = await callingMethod.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); var annotationRemover = new RemoveAnnotationRewriter(callerAnnotation); - root = root.ReplaceNode(callingMethod, annotationRemover.Visit(callingMethod)); + root = root.ReplaceNode(callingMethod, annotationRemover.Visit(callingMethod)!); document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + root = await document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); } else { @@ -217,7 +213,7 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous root = await node.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); root = root.ReplaceNode(node, node.WithoutAnnotations(callerAnnotation)); document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + root = await document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); } } @@ -225,9 +221,9 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous } // Make sure we return the latest of everything. - document = solution.GetDocument(documentId); - SyntaxTree? finalTree = await document.GetSyntaxTreeAsync(cancellationToken).ConfigureAwait(false); - SyntaxNode? finalRoot = await finalTree.GetRootAsync(cancellationToken).ConfigureAwait(false); + document = solution.GetDocumentOrThrow(documentId); + SyntaxTree finalTree = await document.GetSyntaxTreeOrThrowAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode finalRoot = await finalTree.GetRootAsync(cancellationToken).ConfigureAwait(false); method = (MethodDeclarationSyntax)finalRoot.GetAnnotatedNodes(methodBookmark).Single(); } @@ -239,9 +235,9 @@ internal static async Task>> var bookmark = new SyntaxAnnotation(); IEnumerable? callers = await SymbolFinder.FindCallersAsync(symbol, solution, cancellationToken).ConfigureAwait(false); IEnumerable>? callersByFile = from caller in callers - from location in caller.Locations - group location by location.SourceTree into file - select file; + from location in caller.Locations + group location by location.SourceTree into file + select file; var updatedDocs = new List(); foreach (IGrouping? callerByFile in callersByFile) { @@ -256,7 +252,7 @@ group location by location.SourceTree into file } } - Document updatedDocument = solution.GetDocument(callerByFile.Key) + Document updatedDocument = solution.GetDocumentOrThrow(callerByFile.Key) .WithSyntaxRoot(root); updatedDocs.Add(updatedDocument.Id); solution = updatedDocument.Project.Solution; @@ -275,12 +271,12 @@ internal static async Task> UpdateDocumentA T? newSyntaxNode = syntaxNodeTransform(syntaxNode); if (!newSyntaxNode.HasAnnotation(bookmark)) { - newSyntaxNode = syntaxNode.CopyAnnotationsTo(newSyntaxNode); + newSyntaxNode = syntaxNode.CopyAnnotationsTo(newSyntaxNode)!; } root = root.ReplaceNode(syntaxNode, newSyntaxNode); document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + root = await document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); newSyntaxNode = (T)root.GetAnnotatedNodes(bookmark).Single(); return Tuple.Create(document, newSyntaxNode, bookmark); @@ -290,10 +286,10 @@ internal static async Task> Boo where T : SyntaxNode { var bookmark = new SyntaxAnnotation(BookmarkAnnotationName); - SyntaxNode? root = await syntaxNode.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode root = await syntaxNode.SyntaxTree.GetRootAsync(cancellationToken).ConfigureAwait(false); root = root.ReplaceNode(syntaxNode, syntaxNode.WithAdditionalAnnotations(bookmark)); document = document.WithSyntaxRoot(root); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false) ?? throw new InvalidOperationException("Unable to find syntax root"); syntaxNode = (T)root.GetAnnotatedNodes(bookmark).Single(); return Tuple.Create(bookmark, document, syntaxNode, root); @@ -326,7 +322,15 @@ internal static NameSyntax QualifyName(IReadOnlyList qualifiers, SimpleN return SyntaxFactory.QualifiedName(result, simpleName); } - private static CSharpSyntaxNode UpdateStatementsForAsyncMethod(CSharpSyntaxNode body, SemanticModel semanticModel, bool hasResultValue, CancellationToken cancellationToken) + internal static Document GetDocumentOrThrow(this Solution solution, DocumentId documentId) => solution.GetDocument(documentId) ?? throw new InvalidOperationException("No document by the ID found."); + + internal static Document GetDocumentOrThrow(this Solution solution, SyntaxTree syntaxTree) => solution.GetDocument(syntaxTree) ?? throw new InvalidOperationException("No document with the given syntax tree found."); + + internal static async Task GetSyntaxTreeOrThrowAsync(this Document document, CancellationToken cancellationToken) => await document.GetSyntaxTreeAsync(cancellationToken) ?? throw new InvalidOperationException("No syntax tree could be obtained from the document."); + + internal static async Task GetSyntaxRootOrThrowAsync(this Document document, CancellationToken cancellationToken) => await document.GetSyntaxRootAsync(cancellationToken) ?? throw new InvalidOperationException("No syntax root could be obtained from the document."); + + private static CSharpSyntaxNode UpdateStatementsForAsyncMethod(CSharpSyntaxNode body, SemanticModel? semanticModel, bool hasResultValue, CancellationToken cancellationToken) { var blockBody = body as BlockSyntax; if (blockBody is object) @@ -344,15 +348,15 @@ private static CSharpSyntaxNode UpdateStatementsForAsyncMethod(CSharpSyntaxNode throw new NotSupportedException(); } - private static BlockSyntax UpdateStatementsForAsyncMethod(BlockSyntax body, SemanticModel semanticModel, bool hasResultValue, bool returnTypeChanged, CancellationToken cancellationToken) + private static BlockSyntax UpdateStatementsForAsyncMethod(BlockSyntax body, SemanticModel? semanticModel, bool hasResultValue, bool returnTypeChanged, CancellationToken cancellationToken) { - BlockSyntax? fixedUpBlock = body.ReplaceNodes( + BlockSyntax fixedUpBlock = body.ReplaceNodes( body.DescendantNodes().OfType(), (f, n) => { if (hasResultValue) { - return returnTypeChanged + return returnTypeChanged || n.Expression is null || f.Expression is null ? n : n.WithExpression(SyntaxFactory.AwaitExpression(n.Expression).TrySimplify(f.Expression, semanticModel, cancellationToken)); } @@ -360,7 +364,9 @@ private static BlockSyntax UpdateStatementsForAsyncMethod(BlockSyntax body, Sema if (body.Statements.Last() == f) { // If it is the last statement in the method, we can remove it since a return is implied. +#pragma warning disable CS8603 // Possible null reference return. - https://github.com/dotnet/roslyn/issues/65537 return null; +#pragma warning restore CS8603 // Possible null reference return. } return n @@ -371,7 +377,7 @@ private static BlockSyntax UpdateStatementsForAsyncMethod(BlockSyntax body, Sema return fixedUpBlock; } - private static ExpressionSyntax TrySimplify(this AwaitExpressionSyntax awaitExpression, ExpressionSyntax originalSyntax, SemanticModel semanticModel, CancellationToken cancellationToken) + private static ExpressionSyntax TrySimplify(this AwaitExpressionSyntax awaitExpression, ExpressionSyntax originalSyntax, SemanticModel? semanticModel, CancellationToken cancellationToken) { if (awaitExpression is null) { @@ -408,7 +414,7 @@ public AwaitCallRewriter(SyntaxAnnotation callAnnotation) this.callAnnotation = callAnnotation ?? throw new ArgumentNullException(nameof(callAnnotation)); } - public override SyntaxNode VisitInvocationExpression(InvocationExpressionSyntax node) + public override SyntaxNode? VisitInvocationExpression(InvocationExpressionSyntax node) { if (node.HasAnnotation(this.callAnnotation)) { @@ -431,7 +437,7 @@ public RemoveAnnotationRewriter(SyntaxAnnotation annotationToRemove) this.annotationToRemove = annotationToRemove ?? throw new ArgumentNullException(nameof(annotationToRemove)); } - public override SyntaxNode Visit(SyntaxNode node) + public override SyntaxNode? Visit(SyntaxNode? node) { return base.Visit( (node?.HasAnnotation(this.annotationToRemove) ?? false) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj index 382b2b63a..ed52c8be7 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj @@ -1,6 +1,6 @@  - netstandard1.3 + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs index 5bce204ea..58850f3eb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD002UseJtfRunCodeFixWithAwait.cs @@ -31,7 +31,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { Diagnostic? diagnostic = context.Diagnostics.First(); - SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode root = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); if (TryFindNodeAtSource(diagnostic, root, out _, out _)) { @@ -77,7 +77,7 @@ private static bool TryFindNodeAtSource(Diagnostic diagnostic, SyntaxNode root, return false; } - SimpleNameSyntax? FindStaticWaitInvocation(ExpressionSyntax from) + SimpleNameSyntax? FindStaticWaitInvocation(ExpressionSyntax? from) { SimpleNameSyntax? name = ((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Name; return name?.Identifier.ValueText switch @@ -101,11 +101,11 @@ private static bool TryFindNodeAtSource(Diagnostic diagnostic, SyntaxNode root, return from.ReplaceToken(name.Identifier, SyntaxFactory.Identifier(newIdentifier)).WithoutAnnotations(FixUtils.BookmarkAnnotationName); } - ExpressionSyntax? FindTwoLevelDeepIdentifierInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => + ExpressionSyntax? FindTwoLevelDeepIdentifierInvocation(ExpressionSyntax? from, CancellationToken cancellationToken = default(CancellationToken)) => ((((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression; - ExpressionSyntax? FindOneLevelDeepIdentifierInvocation(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => + ExpressionSyntax? FindOneLevelDeepIdentifierInvocation(ExpressionSyntax? from, CancellationToken cancellationToken = default(CancellationToken)) => ((from as InvocationExpressionSyntax)?.Expression as MemberAccessExpressionSyntax)?.Expression; - ExpressionSyntax? FindParentMemberAccess(ExpressionSyntax from, CancellationToken cancellationToken = default(CancellationToken)) => + ExpressionSyntax? FindParentMemberAccess(ExpressionSyntax? from, CancellationToken cancellationToken = default(CancellationToken)) => (from as MemberAccessExpressionSyntax)?.Expression; InvocationExpressionSyntax? parentInvocation = syntaxNode.FirstAncestorOrSelf(); @@ -114,31 +114,33 @@ private static bool TryFindNodeAtSource(Diagnostic diagnostic, SyntaxNode root, { // This method will not return null for the provided 'target' argument transform = NullableHelpers.AsNonNullReturnUnchecked(FindTwoLevelDeepIdentifierInvocation); - target = parentInvocation; + target = parentInvocation!; + return true; } else if (FindStaticWaitInvocation(parentInvocation) is object) { // This method will not return null for the provided 'target' argument transform = NullableHelpers.AsNonNullReturnUnchecked(TransformStaticWhatInvocation); - target = parentInvocation; + target = parentInvocation!; + return true; } else if (FindOneLevelDeepIdentifierInvocation(parentInvocation) is object) { // This method will not return null for the provided 'target' argument transform = NullableHelpers.AsNonNullReturnUnchecked(FindOneLevelDeepIdentifierInvocation); - target = parentInvocation; + target = parentInvocation!; + return true; } else if (FindParentMemberAccess(parentMemberAccess) is object) { // This method will not return null for the provided 'target' argument transform = NullableHelpers.AsNonNullReturnUnchecked(FindParentMemberAccess); - target = parentMemberAccess; + target = parentMemberAccess!; + return true; } else { return false; } - - return true; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs index 704ead1c8..c1f5136ad 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD010MainThreadUsageCodeFix.cs @@ -35,8 +35,8 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { Diagnostic? diagnostic = context.Diagnostics.First(); - SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); - var syntaxNode = (ExpressionSyntax)root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true); + SyntaxNode root = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); + var syntaxNode = (ExpressionSyntax?)root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true); CSharpUtils.ContainingFunctionData container = CSharpUtils.GetContainingFunction(syntaxNode); if (container.BlockOrExpression is null) @@ -45,7 +45,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) } SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); + ISymbol? enclosingSymbol = semanticModel?.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); if (enclosingSymbol is null) { return; @@ -62,8 +62,8 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) Regex lookupKey = (container.IsAsync || convertToAsync) ? CommonInterest.FileNamePatternForMethodsThatSwitchToMainThread : CommonInterest.FileNamePatternForMethodsThatAssertMainThread; - string[] options = diagnostic.Properties[lookupKey.ToString()].Split('\n'); - if (options.Length > 0) + string[]? options = diagnostic.Properties[lookupKey.ToString()]?.Split('\n'); + if (options?.Length > 0) { // For any symbol lookups, we want to consider the position of the very first statement in the block. int positionForLookup = container.BlockOrExpression.GetLocation().SourceSpan.Start + 1; @@ -86,7 +86,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { OfferFix(option); } - else + else if (semanticModel is not null) { foreach (Tuple? candidate in Utils.FindInstanceOf(proposedMethod.ContainingType, semanticModel, positionForLookup, context.CancellationToken)) { @@ -140,7 +140,7 @@ Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol, Lazy } BlockSyntax? newBlock = initialBlockSyntax.WithStatements(initialBlockSyntax.Statements.Insert(0, addedStatement)); - return Task.FromResult(context.Document.WithSyntaxRoot(root.ReplaceNode(container.BlockOrExpression.Parent, container.BodyReplacement(newBlock)))); + return Task.FromResult(context.Document.WithSyntaxRoot(root.ReplaceNode(container.BlockOrExpression.Parent!, container.BodyReplacement(newBlock))!)); } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs index 2c85f189a..06ccef274 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs @@ -76,8 +76,8 @@ internal VoidToTaskCodeAction(Document document, Diagnostic diagnostic) protected override async Task GetChangedDocumentAsync(CancellationToken cancellationToken) { - SyntaxNode? root = await this.document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); - MethodDeclarationSyntax? methodDeclaration = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + SyntaxNode? root = await this.document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); + MethodDeclarationSyntax methodDeclaration = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf() ?? throw new InvalidOperationException("Unable to find MethodDeclaration"); TypeSyntax? taskType = SyntaxFactory.ParseTypeName(typeof(Task).FullName) .WithAdditionalAnnotations(Simplifier.Annotation) .WithTrailingTrivia(methodDeclaration.ReturnType.GetTrailingTrivia()); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs index 226f499f6..655c98233 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs @@ -50,14 +50,14 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) // This is particularly useful when the method is an extension method, since the using directive // would need to be present (or the namespace imply it) and we don't yet add missing using directives. bool asyncAlternativeExists = false; - string asyncMethodName = diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; + string? asyncMethodName = diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; if (string.IsNullOrEmpty(asyncMethodName)) { asyncMethodName = "GetAwaiter"; } SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode syntaxRoot = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); var blockingIdentifier = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as IdentifierNameSyntax; var memberAccessExpression = blockingIdentifier?.Parent as MemberAccessExpressionSyntax; @@ -68,7 +68,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { // If we fail to recognize the container, assume it exists since the analyzer thought it would. ITypeSymbol? container = memberAccessExpression is object ? semanticModel.GetTypeInfo(memberAccessExpression.Expression, context.CancellationToken).ConvertedType : null; - asyncAlternativeExists = container is null || semanticModel.LookupSymbols(diagnostic.Location.SourceSpan.Start, name: asyncMethodName, container: container, includeReducedExtensionMethods: true).Any(); + asyncAlternativeExists = container is null || semanticModel?.LookupSymbols(diagnostic.Location.SourceSpan.Start, name: asyncMethodName, container: container, includeReducedExtensionMethods: true).Any() is true; } if (asyncAlternativeExists) @@ -105,14 +105,14 @@ public override string Title /// public override string? EquivalenceKey => null; - private string AlternativeAsyncMethod => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; + private string? AlternativeAsyncMethod => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]; - private string ExtensionMethodNamespace => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.ExtensionMethodNamespaceKeyName]; + private string? ExtensionMethodNamespace => this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.ExtensionMethodNamespaceKeyName]; - protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) + protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) { Document? document = this.document; - SyntaxNode? root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode root = await document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); // Find the synchronously blocking call member, // and bookmark it so we can find it again after some mutations have taken place. @@ -121,14 +121,14 @@ protected override async Task GetChangedSolutionAsync(CancellationToke if (syncMethodName is null) { MemberAccessExpressionSyntax? syncMemberAccess = root.FindNode(this.diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); - syncMethodName = syncMemberAccess.Name; + syncMethodName = syncMemberAccess?.Name ?? throw new InvalidOperationException("Unable to determine method name."); } // When we give the Document a modified SyntaxRoot, yet another is created. So we first assign it to the Document, // then we query for the SyntaxRoot from the Document. document = document.WithSyntaxRoot( root.ReplaceNode(syncMethodName, syncMethodName.WithAdditionalAnnotations(syncAccessBookmark))); - root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + root = await document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); syncMethodName = (SimpleNameSyntax)root.GetAnnotatedNodes(syncAccessBookmark).Single(); // We'll need the semantic model later. But because we've annotated a node, that changes the SyntaxRoot @@ -136,13 +136,13 @@ protected override async Task GetChangedSolutionAsync(CancellationToke // So after acquiring the semantic model, update it with the new method body. SemanticModel? semanticModel = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); AnonymousFunctionExpressionSyntax? originalAnonymousMethodContainerIfApplicable = syncMethodName.FirstAncestorOrSelf(); - MethodDeclarationSyntax? originalMethodDeclaration = syncMethodName.FirstAncestorOrSelf(); + MethodDeclarationSyntax originalMethodDeclaration = syncMethodName.FirstAncestorOrSelf() ?? throw new InvalidOperationException("Unable to find containing method."); - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(this.diagnostic.Location.SourceSpan.Start, cancellationToken); + ISymbol? enclosingSymbol = semanticModel?.GetEnclosingSymbol(this.diagnostic.Location.SourceSpan.Start, cancellationToken); var hasReturnValue = ((enclosingSymbol as IMethodSymbol)?.ReturnType as INamedTypeSymbol)?.IsGenericType ?? false; // Ensure that the method or anonymous delegate is using the async keyword. - MethodDeclarationSyntax updatedMethod; + MethodDeclarationSyntax? updatedMethod; if (originalAnonymousMethodContainerIfApplicable is object) { updatedMethod = originalMethodDeclaration.ReplaceNode( @@ -161,14 +161,14 @@ protected override async Task GetChangedSolutionAsync(CancellationToke syncMethodName = (SimpleNameSyntax)updatedMethod.GetAnnotatedNodes(syncAccessBookmark).Single(); } - ExpressionSyntax? syncExpression = GetSynchronousExpression(syncMethodName); + ExpressionSyntax syncExpression = GetSynchronousExpression(syncMethodName) ?? throw new InvalidOperationException("Unable to find sync expression."); ExpressionSyntax awaitExpression; if (!string.IsNullOrEmpty(this.AlternativeAsyncMethod)) { // Replace the member being called and await the invocation expression. // While doing so, move leading trivia to the surrounding await expression. - SimpleNameSyntax? asyncMethodName = syncMethodName.WithIdentifier(SyntaxFactory.Identifier(this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName])); + SimpleNameSyntax? asyncMethodName = syncMethodName.WithIdentifier(SyntaxFactory.Identifier(this.diagnostic.Properties[VSTHRD103UseAsyncOptionAnalyzer.AsyncMethodKeyName]!)); awaitExpression = SyntaxFactory.AwaitExpression( syncExpression.ReplaceNode(syncMethodName, asyncMethodName).WithoutLeadingTrivia()) .WithLeadingTrivia(syncExpression.GetLeadingTrivia()); @@ -176,7 +176,7 @@ protected override async Task GetChangedSolutionAsync(CancellationToke else { // Remove the member being accessed that causes a synchronous block and simply await the object. - MemberAccessExpressionSyntax? syncMemberAccess = syncMethodName.FirstAncestorOrSelf(); + MemberAccessExpressionSyntax syncMemberAccess = syncMethodName.FirstAncestorOrSelf() ?? throw new InvalidOperationException("Unable to find member access expression."); ExpressionSyntax? syncMemberStrippedExpression = syncMemberAccess.Expression; // Special case a common pattern of calling task.GetAwaiter().GetResult() and remove both method calls. @@ -204,12 +204,12 @@ protected override async Task GetChangedSolutionAsync(CancellationToke return newDocument.Project.Solution; } - private static ExpressionSyntax GetSynchronousExpression(SimpleNameSyntax syncMethodName) + private static ExpressionSyntax? GetSynchronousExpression(SimpleNameSyntax? syncMethodName) { - SyntaxNode current = syncMethodName; + SyntaxNode? current = syncMethodName; while (true) { - switch (current.Kind()) + switch (current?.Kind()) { case SyntaxKind.InvocationExpression: return (ExpressionSyntax)current; @@ -224,6 +224,9 @@ private static ExpressionSyntax GetSynchronousExpression(SimpleNameSyntax syncMe return (ExpressionSyntax)current; } + case null: + return null; + default: current = current.Parent; break; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs index d416427f8..a399d0ec4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD107AwaitTaskWithinUsingExpressionCodeFix.cs @@ -55,8 +55,8 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context) async ct => { Document? document = context.Document; - SyntaxNode? root = await document.GetSyntaxRootAsync(ct).ConfigureAwait(false); - MethodDeclarationSyntax? method = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + SyntaxNode? root = await document.GetSyntaxRootOrThrowAsync(ct).ConfigureAwait(false); + MethodDeclarationSyntax method = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf() ?? throw new InvalidOperationException("Unable to find MethodDeclaration."); (document, method, _) = await FixUtils.UpdateDocumentAsync( document, @@ -64,9 +64,9 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context) m => { root = m.SyntaxTree.GetRoot(ct); - UsingStatementSyntax usingStatement = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf(); + UsingStatementSyntax? usingStatement = root.FindNode(diagnostic.Location.SourceSpan).FirstAncestorOrSelf() ?? throw new InvalidOperationException("Unable to find using statement."); AwaitExpressionSyntax awaitExpression = SyntaxFactory.AwaitExpression( - SyntaxFactory.ParenthesizedExpression(usingStatement.Expression)); + SyntaxFactory.ParenthesizedExpression(usingStatement.Expression!)); UsingStatementSyntax modifiedUsingStatement = usingStatement.WithExpression(awaitExpression) .WithAdditionalAnnotations(Simplifier.Annotation); return m.ReplaceNode(usingStatement, modifiedUsingStatement); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs index 4b2667a6b..d9ecff843 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD109AvoidAssertInAsyncMethodsCodeFix.cs @@ -35,7 +35,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { foreach (Diagnostic? diagnostic in context.Diagnostics) { - SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode root = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); ExpressionSyntax? syntaxNode = root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true) as ExpressionSyntax; if (syntaxNode is null) { @@ -58,7 +58,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) } SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); + ISymbol? enclosingSymbol = semanticModel?.GetEnclosingSymbol(diagnostic.Location.SourceSpan.Start, context.CancellationToken); if (enclosingSymbol is null) { return; @@ -72,7 +72,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { // We're looking for methods that either require no parameters, // or (if we have one to give) that have just one parameter that is a CancellationToken. - IMethodSymbol? proposedMethod = Utils.FindMethodGroup(semanticModel, option) + IMethodSymbol? proposedMethod = semanticModel is null ? null : Utils.FindMethodGroup(semanticModel, option) .FirstOrDefault(m => !m.Parameters.Any(p => !p.HasExplicitDefaultValue) || (cancellationTokenSymbol is object && m.Parameters.Length == 1 && Utils.IsCancellationTokenParameter(m.Parameters[0]))); if (proposedMethod is null) @@ -85,7 +85,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) { OfferFix(option.ToString()); } - else + else if (semanticModel is not null) { foreach (Tuple? candidate in Utils.FindInstanceOf(proposedMethod.ContainingType, semanticModel, positionForLookup, context.CancellationToken)) { @@ -108,7 +108,7 @@ void OfferFix(string fullyQualifiedMethod) async Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol, bool hasReturnValue, CancellationToken cancellationToken) { - StatementSyntax? assertionStatementToRemove = syntaxNode!.FirstAncestorOrSelf(); + StatementSyntax assertionStatementToRemove = syntaxNode!.FirstAncestorOrSelf() ?? throw new InvalidOperationException("Unable to find containing statement."); int typeAndMethodDelimiterIndex = fullyQualifiedMethod.LastIndexOf('.'); IdentifierNameSyntax methodName = SyntaxFactory.IdentifierName(fullyQualifiedMethod.Substring(typeAndMethodDelimiterIndex + 1)); @@ -135,7 +135,7 @@ async Task Fix(string fullyQualifiedMethod, IMethodSymbol methodSymbol CSharpSyntaxNode methodSyntax = container.Function.ReplaceNode(assertionStatementToRemove, addedStatement) .WithAdditionalAnnotations(methodAnnotation); Document newDocument = context.Document.WithSyntaxRoot(root.ReplaceNode(container.Function, methodSyntax)); - SyntaxNode? newSyntaxRoot = await newDocument.GetSyntaxRootAsync(cancellationToken); + SyntaxNode? newSyntaxRoot = await newDocument.GetSyntaxRootOrThrowAsync(cancellationToken); methodSyntax = (CSharpSyntaxNode)newSyntaxRoot.GetAnnotatedNodes(methodAnnotation).Single(); if (!container.IsAsync) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs index a9e79d33f..923d67d7c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs @@ -36,8 +36,12 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) foreach (Diagnostic? diagnostic in context.Diagnostics) { SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode syntaxRoot = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); var awaitedExpression = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as ExpressionSyntax; + if (awaitedExpression is null) + { + return; + } Task ApplyFix(bool captureContext) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs index 5d277500b..8ce2747ce 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD112ImplementSystemIAsyncDisposableCodeFix.cs @@ -39,7 +39,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) continue; } - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken); + SyntaxNode syntaxRoot = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken); var generator = SyntaxGenerator.GetGenerator(context.Document); SyntaxNode? originalTypeDeclaration = generator.TryGetContainingDeclaration(syntaxRoot.FindNode(diagnostic.Location.SourceSpan)); if (originalTypeDeclaration is null) @@ -57,7 +57,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) SyntaxNode? typeDeclaration = generator.AddInterfaceType(originalTypeDeclaration, newBaseType); // Implement the interface, if we're on a non-interface type. - if (semanticModel.GetDeclaredSymbol(originalTypeDeclaration, ct) is ITypeSymbol changedSymbol && changedSymbol.TypeKind != TypeKind.Interface) + if (semanticModel?.GetDeclaredSymbol(originalTypeDeclaration, ct) is ITypeSymbol changedSymbol && changedSymbol.TypeKind != TypeKind.Interface) { var disposeAsyncMethod = (IMethodSymbol)bclAsyncDisposableType.GetMembers().Single(); var statements = new SyntaxNode[] @@ -68,15 +68,14 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) generator.InvocationExpression( generator.MemberAccessExpression(generator.ThisExpression(), "DisposeAsync")))), }; - typeDeclaration = generator.AddMembers( - typeDeclaration, - generator.AsPrivateInterfaceImplementation( - generator.MethodDeclaration( - disposeAsyncMethod.Name, - returnType: generator.TypeExpression(disposeAsyncMethod.ReturnType), - accessibility: Accessibility.Public, - statements: statements), - generator.TypeExpression(bclAsyncDisposableType))); + SyntaxNode privateInterfaceMember = generator.AsPrivateInterfaceImplementation( + generator.MethodDeclaration( + disposeAsyncMethod.Name, + returnType: generator.TypeExpression(disposeAsyncMethod.ReturnType), + accessibility: Accessibility.Public, + statements: statements), + generator.TypeExpression(bclAsyncDisposableType))!; + typeDeclaration = generator.AddMembers(typeDeclaration, privateInterfaceMember); } return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(originalTypeDeclaration, typeDeclaration))); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs index 860bd6634..290a1d838 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD114AvoidReturningNullTaskCodeFix.cs @@ -29,9 +29,9 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) foreach (Diagnostic? diagnostic in context.Diagnostics) { SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); - SyntaxNode? syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); + SyntaxNode syntaxRoot = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); SyntaxNode? nullLiteral = syntaxRoot.FindNode(diagnostic.Location.SourceSpan); - if (semanticModel.GetOperation(nullLiteral, context.CancellationToken) is ILiteralOperation { ConstantValue: { HasValue: true, Value: null } }) + if (semanticModel?.GetOperation(nullLiteral, context.CancellationToken) is ILiteralOperation { ConstantValue: { HasValue: true, Value: null } }) { TypeInfo typeInfo = semanticModel.GetTypeInfo(nullLiteral, context.CancellationToken); if (typeInfo.ConvertedType is INamedTypeSymbol returnType) @@ -61,7 +61,7 @@ Task ApplyTaskFromResultFix(INamedTypeSymbol returnType) var generator = SyntaxGenerator.GetGenerator(context.Document); SyntaxNode taskFromResultExpression = generator.InvocationExpression( generator.MemberAccessExpression( - generator.TypeExpressionForStaticMemberAccess(returnType.BaseType), + generator.TypeExpressionForStaticMemberAccess(returnType.BaseType!), generator.GenericName(nameof(Task.FromResult), returnType.TypeArguments[0])), generator.NullLiteralExpression()); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index d43e9fa07..05b2f389b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -30,8 +30,13 @@ public class VSTHRD200UseAsyncNamingConventionCodeFix : CodeFixProvider /// public override Task RegisterCodeFixesAsync(CodeFixContext context) { - Diagnostic? diagnostic = context.Diagnostics.First(); - context.RegisterCodeFix(new AddAsyncSuffixCodeAction(context.Document, diagnostic), diagnostic); + Diagnostic diagnostic = context.Diagnostics.First(); + string? newName = diagnostic.Properties[VSTHRD200UseAsyncNamingConventionAnalyzer.NewNameKey]; + if (newName is not null) + { + context.RegisterCodeFix(new AddAsyncSuffixCodeAction(context.Document, diagnostic, newName), diagnostic); + } + return Task.FromResult(null); } @@ -42,36 +47,36 @@ private class AddAsyncSuffixCodeAction : CodeAction { private readonly Diagnostic diagnostic; private readonly Document document; + private readonly string newName; - public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic) + public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic, string newName) { this.document = document; this.diagnostic = diagnostic; + this.newName = newName; } public override string Title => string.Format( CultureInfo.CurrentCulture, Strings.VSTHRD200_CodeFix_Title, - this.NewName); + this.newName); /// public override string? EquivalenceKey => null; - private string NewName => this.diagnostic.Properties[VSTHRD200UseAsyncNamingConventionAnalyzer.NewNameKey]; - - protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) + protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) { - SyntaxNode? root = await this.document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false); + SyntaxNode root = await this.document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); var methodDeclaration = (MethodDeclarationSyntax)root.FindNode(this.diagnostic.Location.SourceSpan); SemanticModel? semanticModel = await this.document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - IMethodSymbol? methodSymbol = semanticModel.GetDeclaredSymbol(methodDeclaration, cancellationToken); + IMethodSymbol methodSymbol = semanticModel.GetDeclaredSymbol(methodDeclaration, cancellationToken) ?? throw new InvalidOperationException("Unable to get method symbol."); Solution? solution = this.document.Project.Solution; Solution? updatedSolution = await Renamer.RenameSymbolAsync( solution, methodSymbol, - this.NewName, + this.newName, solution.Workspace.Options, cancellationToken).ConfigureAwait(false); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj index e1a7db4da..4597ac85c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj @@ -1,6 +1,6 @@  - netstandard1.3 + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers false diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs index acb406632..71bdd2feb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs @@ -31,7 +31,7 @@ private VisualBasicUtils() foreach (TypeSyntax? typeSyntax in inheritStatement.Types) { SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) + if (SymbolEqualityComparer.Default.Equals(baseTypeSymbolInfo.Symbol, baseType)) { return typeSyntax.GetLocation(); } @@ -48,7 +48,7 @@ private VisualBasicUtils() foreach (TypeSyntax? typeSyntax in implementStatement.Types) { SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) + if (SymbolEqualityComparer.Default.Equals(baseTypeSymbolInfo.Symbol, baseType)) { return typeSyntax.GetLocation(); } @@ -65,7 +65,7 @@ private VisualBasicUtils() foreach (TypeSyntax? typeSyntax in implementStatement.Types) { SymbolInfo baseTypeSymbolInfo = semanticModel.GetSymbolInfo(typeSyntax, cancellationToken); - if (Equals(baseTypeSymbolInfo.Symbol, baseType)) + if (SymbolEqualityComparer.Default.Equals(baseTypeSymbolInfo.Symbol, baseType)) { return typeSyntax.GetLocation(); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs index 6f906064c..338f1f5b5 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs @@ -33,7 +33,7 @@ public override void Initialize(AnalysisContext context) context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeInvocation), OperationKind.Invocation); - context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzerObjectCreation), OperationKind.ObjectCreation); + context.RegisterOperationAction(Utils.DebuggableWrapper(this.AnalyzeObjectCreation), OperationKind.ObjectCreation); } private static bool IsImportantJtfParameter(IParameterSymbol ps) @@ -42,14 +42,14 @@ private static bool IsImportantJtfParameter(IParameterSymbol ps) || ps.Type.Name == Types.JoinableTaskFactory.TypeName || ps.Type.Name == Types.JoinableTaskCollection.TypeName) && ps.Type.BelongsToNamespace(Namespaces.MicrosoftVisualStudioThreading) - && !ps.GetAttributes().Any(a => a.AttributeClass.Name == "OptionalAttribute"); + && !ps.GetAttributes().Any(a => a.AttributeClass?.Name == "OptionalAttribute"); } private static IArgumentOperation? GetArgumentForParameter(ImmutableArray arguments, IParameterSymbol parameter) { foreach (IArgumentOperation? argument in arguments) { - if (Equals(argument.Parameter, parameter)) + if (SymbolEqualityComparer.Default.Equals(argument.Parameter, parameter)) { return argument; } @@ -104,10 +104,15 @@ private void AnalyzeInvocation(OperationAnalysisContext context) AnalyzeCall(context, invokedMethodName.GetLocation(), argList, methodSymbol, otherOverloads); } - private void AnalyzerObjectCreation(OperationAnalysisContext context) + private void AnalyzeObjectCreation(OperationAnalysisContext context) { var objectCreation = (IObjectCreationOperation)context.Operation; IMethodSymbol? methodSymbol = objectCreation.Constructor; + if (methodSymbol is null) + { + return; + } + AnalyzeCall( context, this.LanguageUtils.IsolateMethodName(objectCreation).GetLocation(), diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs index 37f8b6ba1..45b473d76 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -80,7 +80,7 @@ private static bool IsInConditional(IOperation operation) private static IEnumerable GetAncestorsWithinMethod(IOperation operation) { - for (IOperation current = operation; current is object; current = current.Parent) + for (IOperation? current = operation; current is object; current = current.Parent) { if (current is ILocalFunctionOperation || current is IAnonymousFunctionOperation) { @@ -99,7 +99,7 @@ private static bool IsArgInInvocationToConditionalMethod(OperationAnalysisContex { IMethodSymbol? symbolOfContainingMethodInvocation = containingInvocation.TargetMethod; return symbolOfContainingMethodInvocation?.GetAttributes().Any(a => - a.AttributeClass.BelongsToNamespace(Namespaces.SystemDiagnostics) && + a.AttributeClass?.BelongsToNamespace(Namespaces.SystemDiagnostics) is true && a.AttributeClass.Name == nameof(System.Diagnostics.ConditionalAttribute)) ?? false; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index d5d13878f..65d5904a1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -45,7 +45,7 @@ public override void Initialize(AnalysisContext context) }); } - private void AnalyzeType(SymbolAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + private void AnalyzeType(SymbolAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol? bclAsyncDisposableType) { var symbol = (INamedTypeSymbol)context.Symbol; if (symbol.Interfaces.Contains(vsThreadingAsyncDisposableType)) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index e20572416..33beb7da1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -314,7 +314,7 @@ public QualifiedMember(QualifiedType containingType, string methodName) public string Name { get; } - public bool IsMatch(ISymbol symbol) + public bool IsMatch(ISymbol? symbol) { return symbol?.Name == this.Name && this.ContainingType.IsMatch(symbol.ContainingType); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs index c6bcd4c56..71c6ada4c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs @@ -21,7 +21,7 @@ internal abstract class DiagnosticAnalyzerState { private const string GetAwaiterMethodName = nameof(Task.GetAwaiter); - private readonly ConcurrentDictionary customAwaitableTypes = new ConcurrentDictionary(); + private readonly ConcurrentDictionary customAwaitableTypes = new ConcurrentDictionary(SymbolEqualityComparer.Default); internal bool IsAwaitableType(ITypeSymbol? typeSymbol, Compilation compilation, CancellationToken cancellationToken) { @@ -46,7 +46,7 @@ where ConformsToAwaiterPattern(candidateAwaiterMethod.ReturnType) IEnumerable? awaitableTypesPerAssembly = from assembly in compilation.Assembly.Modules.First().ReferencedAssemblySymbols from awaitableType in GetAwaitableTypes(assembly) select awaitableType; - isAwaitable = awaitableTypesFromThisAssembly.Concat(awaitableTypesPerAssembly).Contains(typeSymbol); + isAwaitable = awaitableTypesFromThisAssembly.Concat(awaitableTypesPerAssembly).Contains(typeSymbol, SymbolEqualityComparer.Default); } this.customAwaitableTypes.TryAdd(typeSymbol, isAwaitable); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj index 1fe51e660..4c8ac6123 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj @@ -1,6 +1,6 @@  - netstandard1.3 + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers.Only false diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index 739dabd5f..7ef775888 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -399,19 +399,19 @@ internal static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) } } - internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, SemanticModel semanticModel, CancellationToken cancellationToken) + internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, SemanticModel? semanticModel, CancellationToken cancellationToken) { - return semanticModel.Compilation is object && IsEntrypointMethod(symbol, semanticModel.Compilation, cancellationToken); + return semanticModel?.Compilation is object && IsEntrypointMethod(symbol, semanticModel.Compilation, cancellationToken); } internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, Compilation compilation, CancellationToken cancellationToken) { - return compilation.GetEntryPoint(cancellationToken)?.Equals(symbol) ?? false; + return compilation.GetEntryPoint(cancellationToken)?.Equals(symbol, SymbolEqualityComparer.Default) ?? false; } internal static bool IsObsolete(this ISymbol symbol) { - return symbol.GetAttributes().Any(a => a.AttributeClass.Name == nameof(ObsoleteAttribute) && a.AttributeClass.BelongsToNamespace(Namespaces.System)); + return symbol.GetAttributes().Any(a => a.AttributeClass?.Name == nameof(ObsoleteAttribute) && a.AttributeClass.BelongsToNamespace(Namespaces.System)); } internal static IEnumerable FindInterfacesImplemented(this ISymbol? symbol) @@ -422,10 +422,10 @@ internal static IEnumerable FindInterfacesImplemented(this ISymbol? } IEnumerable? interfaceImplementations = from iface in symbol.ContainingType.AllInterfaces - from member in iface.GetMembers() - let implementingMember = symbol.ContainingType.FindImplementationForInterfaceMember(member) - where implementingMember?.Equals(symbol) ?? false - select iface; + from member in iface.GetMembers() + let implementingMember = symbol.ContainingType.FindImplementationForInterfaceMember(member) + where implementingMember?.Equals(symbol, SymbolEqualityComparer.Default) ?? false + select iface; return interfaceImplementations; } @@ -492,22 +492,22 @@ internal static string GetHelpLink(string analyzerId) /// The position in the document that must have access to any candidate . /// A token that represents lost interest in this inquiry. /// Candidate symbols. - internal static IEnumerable? FindCancellationToken(SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) + internal static IEnumerable FindCancellationToken(SemanticModel? semanticModel, int positionForLookup, CancellationToken cancellationToken) { if (semanticModel is null) { - throw new ArgumentNullException(nameof(semanticModel)); + return Enumerable.Empty(); } ISymbol? enclosingSymbol = semanticModel.GetEnclosingSymbol(positionForLookup, cancellationToken); if (enclosingSymbol is null) { - return null; + return Enumerable.Empty(); } IOrderedEnumerable? cancellationTokenSymbols = semanticModel.LookupSymbols(positionForLookup) .Where(s => (s.IsStatic || !enclosingSymbol.IsStatic) && s.CanBeReferencedByName && IsSymbolTheRightType(s, nameof(CancellationToken), Namespaces.SystemThreading)) - .OrderBy(s => s.ContainingSymbol.Equals(enclosingSymbol) ? 1 : s.ContainingType.Equals(enclosingSymbol.ContainingType) ? 2 : 3); // prefer locality + .OrderBy(s => s.ContainingSymbol.Equals(enclosingSymbol, SymbolEqualityComparer.Default) ? 1 : s.ContainingType.Equals(enclosingSymbol.ContainingType, SymbolEqualityComparer.Default) ? 2 : 3); // prefer locality return cancellationTokenSymbols; } @@ -517,11 +517,11 @@ internal static string GetHelpLink(string analyzerId) /// The semantic model of the document that must be able to access the methods. /// The fully-qualified name of the method. /// An enumeration of method symbols with a matching name. - internal static IEnumerable FindMethodGroup(SemanticModel semanticModel, string methodAsString) + internal static IEnumerable FindMethodGroup(SemanticModel? semanticModel, string methodAsString) { if (semanticModel is null) { - throw new ArgumentNullException(nameof(semanticModel)); + return Enumerable.Empty(); } if (string.IsNullOrEmpty(methodAsString)) @@ -530,8 +530,6 @@ internal static IEnumerable FindMethodGroup(SemanticModel semanti } (string? fullTypeName, string? methodName) = SplitOffLastElement(methodAsString); - (string? ns, string? leafTypeName) = SplitOffLastElement(fullTypeName); - string[]? namespaces = ns?.Split('.'); if (fullTypeName is null) { return Enumerable.Empty(); @@ -539,7 +537,9 @@ internal static IEnumerable FindMethodGroup(SemanticModel semanti INamedTypeSymbol? proposedType = semanticModel.Compilation.GetTypeByMetadataName(fullTypeName); - return proposedType?.GetMembers(methodName).OfType() ?? Enumerable.Empty(); + return methodName is not null && proposedType is not null + ? proposedType.GetMembers(methodName).OfType() + : Enumerable.Empty(); } /// @@ -585,13 +585,15 @@ internal static IEnumerable> FindInstanceOf(INamedTypeSymbo // Search fields on the declaring type. // Consider local variables too, if they're captured in a closure from some surrounding code block // such that they would presumably be initialized by the time the first statement in our own code block runs. - ITypeSymbol enclosingTypeSymbol = enclosingSymbol as ITypeSymbol ?? enclosingSymbol.ContainingType; +#pragma warning disable CA1508 // Avoid dead conditional code -- compiler bug. It's not dead code. + ITypeSymbol? enclosingTypeSymbol = enclosingSymbol as ITypeSymbol ?? enclosingSymbol?.ContainingType; +#pragma warning restore CA1508 // Avoid dead conditional code if (enclosingTypeSymbol is object) { IEnumerable? candidateMembers = from symbol in semanticModel.LookupSymbols(positionForLookup, enclosingTypeSymbol) - where symbol.IsStatic || !enclosingSymbol.IsStatic - where IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) - select symbol; + where symbol.IsStatic || !enclosingSymbol!.IsStatic + where IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) + select symbol; foreach (ISymbol? candidate in candidateMembers) { yield return Tuple.Create(true, candidate); @@ -600,9 +602,9 @@ where IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespa // Find static fields/properties that return the matching type from other public, non-generic types. IEnumerable? candidateStatics = from offering in semanticModel.LookupStaticMembers(positionForLookup).OfType() - from symbol in offering.GetMembers() - where symbol.IsStatic && symbol.CanBeReferencedByName && IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) - select symbol; + from symbol in offering.GetMembers() + where symbol.IsStatic && symbol.CanBeReferencedByName && IsSymbolTheRightType(symbol, typeSymbol.Name, typeSymbol.ContainingNamespace) + select symbol; foreach (ISymbol? candidate in candidateStatics) { yield return Tuple.Create(false, candidate); @@ -670,7 +672,7 @@ from symbol in offering.GetMembers() }; } - internal static bool IsSameSymbol(IOperation? op1, IOperation? op2) => GetUnderlyingSymbol(op1)?.Equals(GetUnderlyingSymbol(op2)) ?? false; + internal static bool IsSameSymbol(IOperation? op1, IOperation? op2) => GetUnderlyingSymbol(op1)?.Equals(GetUnderlyingSymbol(op2), SymbolEqualityComparer.Default) ?? false; internal static IOperation FindFinalAncestor(IOperation operation) { @@ -715,7 +717,7 @@ private static bool IsSymbolTheRightType(ISymbol symbol, string typeName, INames var parameterSymbol = symbol as IParameterSymbol; var localSymbol = symbol as ILocalSymbol; ITypeSymbol? memberType = fieldSymbol?.Type ?? propertySymbol?.Type ?? parameterSymbol?.Type ?? localSymbol?.Type; - return memberType?.Name == typeName && memberType.ContainingNamespace.Equals(namespaces); + return memberType?.Name == typeName && memberType.ContainingNamespace.Equals(namespaces, SymbolEqualityComparer.Default); } private static bool LaunchDebuggerExceptionFilter() diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs index 879130aca..60c8bbf2d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD113CheckForSystemIAsyncDisposableAnalyzer.cs @@ -52,7 +52,7 @@ public override void Initialize(AnalysisContext context) }); } - private static void AnalyzeTypeCheck(OperationAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + private static void AnalyzeTypeCheck(OperationAnalysisContext context, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol? bclAsyncDisposableType) { switch (context.Operation) { @@ -67,9 +67,9 @@ private static void AnalyzeTypeCheck(OperationAnalysisContext context, INamedTyp break; } - static void ConsiderTypeCheck(OperationAnalysisContext context, ITypeSymbol operand, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol bclAsyncDisposableType) + static void ConsiderTypeCheck(OperationAnalysisContext context, ITypeSymbol operand, INamedTypeSymbol vsThreadingAsyncDisposableType, INamedTypeSymbol? bclAsyncDisposableType) { - if (Equals(vsThreadingAsyncDisposableType, operand)) + if (SymbolEqualityComparer.Default.Equals(vsThreadingAsyncDisposableType, operand)) { // If the System.IAsyncDisposable type is defined, search for a check for that type and skip the diagnostic if we find one. if (bclAsyncDisposableType is object) @@ -91,11 +91,11 @@ static bool IsTypeCheck(IOperation operation, INamedTypeSymbol typeChecked) switch (operation) { case IIsTypeOperation { TypeOperand: { } operand }: - return Equals(typeChecked, operand); + return SymbolEqualityComparer.Default.Equals(typeChecked, operand); case IDeclarationPatternOperation { DeclaredSymbol: ILocalSymbol { Type: { } operand } }: - return Equals(typeChecked, operand); + return SymbolEqualityComparer.Default.Equals(typeChecked, operand); case IConversionOperation { Type: { } operand }: - return Equals(typeChecked, operand); + return SymbolEqualityComparer.Default.Equals(typeChecked, operand); default: return false; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index f22057db7..b09811dea 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -84,7 +84,7 @@ internal void AnalyzeNode(SymbolAnalysisContext context) { // We actively encourage folks to use the Async keyword only for clearly async-focused types. // Not just any awaitable, since some stray extension method shouldn't change the world for everyone. - ImmutableDictionary? properties = ImmutableDictionary.Empty + ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(NewNameKey, methodSymbol.Name + MandatoryAsyncSuffix); context.ReportDiagnostic(Diagnostic.Create( AddAsyncDescriptor, @@ -94,7 +94,7 @@ internal void AnalyzeNode(SymbolAnalysisContext context) else if (!this.IsAwaitableType(methodSymbol.ReturnType, context.Compilation, context.CancellationToken)) { // Only warn about abusing the Async suffix if the return type is not awaitable. - ImmutableDictionary? properties = ImmutableDictionary.Empty + ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(NewNameKey, methodSymbol.Name.Substring(0, methodSymbol.Name.Length - MandatoryAsyncSuffix.Length)); context.ReportDiagnostic(Diagnostic.Create( RemoveAsyncDescriptor, From 1914d5e3a9f83748aeca4d0fbcf39c9acc0ec968 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Nov 2022 09:32:04 -0700 Subject: [PATCH 0628/1753] Suppress MSB3277 in build --- .../Microsoft.VisualStudio.Threading.csproj | 3 +++ .../Microsoft.VisualStudio.Threading.Tests.csproj | 3 +++ 2 files changed, 6 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 3a4e18475..8ceaf82ae 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -7,6 +7,9 @@ Threading Async Lock Synchronization Threadsafe true + + + $(NoWarn);MSB3277 $(TargetFrameworks);net6.0-windows diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index c0ddce1ec..0545e87fb 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -8,6 +8,9 @@ true $(DefineConstants);ISOLATED_TEST_SUPPORT + + + $(NoWarn);MSB3277 $(TargetFrameworks);net472;net6.0-windows From 8ebf3f27b25adbe6d266bc07fbdd01bc94d82a48 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Nov 2022 09:37:48 -0700 Subject: [PATCH 0629/1753] Use `MSBuildTreatWarningsAsErrors` in pipeline This is more comprehensive than `TreatWarningsAsErrors` because it changes the behavior of the MSBuild logging system itself instead of relying on individual tasks and targets to honor the property and elevate their own warnings. --- .github/workflows/build.yml | 2 +- azure-pipelines.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2c4ba94c6..a56a6dda2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,7 +8,7 @@ on: pull_request: env: - TreatWarningsAsErrors: true + MSBuildTreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BUILDCONFIGURATION: Release # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 2cac17bd9..521d4ce6b 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -23,7 +23,7 @@ parameters: default: true variables: - TreatWarningsAsErrors: true + MSBuildTreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ From 73ef446ccb46cf39b434ef004007681624bffc89 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Nov 2022 09:40:20 -0700 Subject: [PATCH 0630/1753] Avoid static graph restore This until the fix for https://github.com/NuGet/Home/issues/12177 is broadly available. --- Directory.Build.props | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 301047d1e..e78128b9b 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -17,7 +17,8 @@ true - true + + false $(MSBuildThisFileDirectory) From ae66da74a2e324d3fc73753c691cfeb882d18daf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 8 Nov 2022 22:24:14 -0700 Subject: [PATCH 0631/1753] Update to the .NET 7 SDK --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 3ce46e096..e5187f36c 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "6.0.402", + "version": "7.0.100", "rollForward": "patch", "allowPrerelease": false } From ca3ab7d086ec1559228a26e454f6dc71e920066e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 21 Nov 2022 20:06:18 -0700 Subject: [PATCH 0632/1753] Enable NuGet CPVM transitive pinning --- Directory.Packages.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Packages.props b/Directory.Packages.props index 924f4b4e0..5ce5b0f00 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -2,6 +2,7 @@ true + true From 6bcec4372bd8508a7513aa6653712b2388a94a9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 22 Nov 2022 09:05:12 -0700 Subject: [PATCH 0633/1753] Fix build on machines with Visual Studio 2022 Update 3 This is a workaround for Azure Pipelines Hosted agents, which haven't upgraded to Dev17.4 yet. --- Directory.Packages.props | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 5ce5b0f00..e9475f7cb 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -15,6 +15,7 @@ + @@ -25,6 +26,7 @@ + @@ -32,4 +34,4 @@ - \ No newline at end of file + From 6a34c4f283848ed96447f3ce5fde429309112fe0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 22 Nov 2022 09:23:41 -0700 Subject: [PATCH 0634/1753] Switch back to `GlobalPackageReference` --- Directory.Packages.props | 27 +++++++-------------------- 1 file changed, 7 insertions(+), 20 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index e9475f7cb..5996640f0 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,28 +10,15 @@ - - - - - - - + + + + + + - - - - - - - - - - - - + From 4e94051d09204f1e5247114ca13cc20656b69e99 Mon Sep 17 00:00:00 2001 From: David Kean Date: Thu, 24 Nov 2022 11:45:22 +1100 Subject: [PATCH 0635/1753] Unhide fields from debugger These fields are important when looking at hangs/dumps to find relationships between the collection and the tasks they are blocked on. Unhide them so its easy to find them in Locals/Autos. --- src/Microsoft.VisualStudio.Threading/JoinableTask.cs | 2 -- src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs | 1 - .../JoinableTaskDependencyGraph.cs | 1 - 3 files changed, 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index cd65c018b..ae03d95d0 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -53,13 +53,11 @@ public partial class JoinableTask : IJoinableTaskDependent /// /// The to track dependencies between tasks. /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] private JoinableTaskDependencyGraph.JoinableTaskDependentData dependentData; /// /// The collections that this job is a member of. /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] private RarelyRemoveItemSet dependencyParents; /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs index c71028d55..348a654db 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs @@ -32,7 +32,6 @@ public class JoinableTaskCollection : IJoinableTaskDependent, IEnumerable /// The to track dependencies between tasks. /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] private JoinableTaskDependencyGraph.JoinableTaskDependentData dependentData; /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs index 4f054bdf9..c0de4ac3f 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskDependencyGraph.cs @@ -297,7 +297,6 @@ internal struct JoinableTaskDependentData /// /// When the value in an entry is decremented to 0, the entry is removed from the map. /// - [DebuggerBrowsable(DebuggerBrowsableState.Never)] private Dictionary childDependentNodes; /// From fb2b395fce67a75e5be07443e204fc5b905b6983 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 24 Nov 2022 13:21:22 -0700 Subject: [PATCH 0636/1753] Drop the .NET compilers toolset pin This reverts "Fix build on machines with Visual Studio 2022 Update 3" since Azure Pipelines now has Update 4 installed. This reverts commit 6bcec4372bd8508a7513aa6653712b2388a94a9a. --- Directory.Packages.props | 1 - 1 file changed, 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 5996640f0..8e696a7e9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,7 +13,6 @@ - From a32f820b0f145106b6a7182079a59adf7e9554a3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Dec 2022 10:45:54 -0700 Subject: [PATCH 0637/1753] Bump Microsoft.CodeCoverage (#182) Bumps [Microsoft.CodeCoverage](https://github.com/microsoft/vstest) from 17.5.0-preview-20221109-01 to 17.5.0-preview-20221201-01. - [Release notes](https://github.com/microsoft/vstest/releases) - [Commits](https://github.com/microsoft/vstest/commits) --- updated-dependencies: - dependency-name: Microsoft.CodeCoverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 8e696a7e9..056c53494 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From b71db19e49607ac305668b92d54055807c4f8447 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Dec 2022 10:49:36 -0700 Subject: [PATCH 0638/1753] Bump MicroBuild version to 2.0.93 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 34bf39a5e..33eb22680 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.87 + 2.0.93 From 18063068d3e00575354c1dfb814b9eedb298a1a0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Dec 2022 13:34:01 -0700 Subject: [PATCH 0639/1753] Bump Xunit.Combinatorial from 1.4.1 to 1.5.25 (#1120) Bumps [Xunit.Combinatorial](https://github.com/AArnott/Xunit.Combinatorial) from 1.4.1 to 1.5.25. - [Release notes](https://github.com/AArnott/Xunit.Combinatorial/releases) - [Commits](https://github.com/AArnott/Xunit.Combinatorial/compare/v1.4.1...v1.5.25) --- updated-dependencies: - dependency-name: Xunit.Combinatorial dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 330f8e822..bebaad045 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -34,7 +34,7 @@ - + From 69441009249e5502b606a3b0113691507f101a60 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Dec 2022 13:34:36 -0700 Subject: [PATCH 0640/1753] Bump Microsoft.Diagnostics.Runtime from 2.2.332302 to 2.2.343001 (#1119) Bumps Microsoft.Diagnostics.Runtime from 2.2.332302 to 2.2.343001. --- updated-dependencies: - dependency-name: Microsoft.Diagnostics.Runtime dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index bebaad045..6e946e5f8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -20,7 +20,7 @@ - + From e7ed3b30668a893d23584ecf05294d7b14f6b445 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Dec 2022 14:46:40 -0700 Subject: [PATCH 0641/1753] Bump Microsoft.CodeCoverage from 17.5.0-preview-20221201-01 to 17.5.0-preview-20221201-06 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 056c53494..f19a9842e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 0b8cf61a60db529de3d5de5f3bdb7ea964b6bc4b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Dec 2022 11:02:22 -0700 Subject: [PATCH 0642/1753] Remove namespace from analyzer tests --- .../Helpers/CSharpCodeFixVerifier`2+Test.cs | 5 ----- .../Helpers/CSharpCodeFixVerifier`2.cs | 3 --- .../Helpers/ReferencesHelper.cs | 1 - .../VisualBasicCodeFixVerifier`2+Test.cs | 3 --- .../Helpers/VisualBasicCodeFixVerifier`2.cs | 3 --- .../MultiAnalyzerTests.cs | 9 ++------- .../Usings.cs | 9 +++++++++ ...UseSwitchToMainThreadAsyncAnalyzerTests.cs | 4 ---- .../VSTHRD002UseJtfRunAnalyzerTests.cs | 6 ------ .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 9 --------- ...aitSwitchToMainThreadAsyncAnalyzerTests.cs | 5 ----- .../VSTHRD010MainThreadUsageAnalyzerTests.cs | 5 ----- .../VSTHRD011UseAsyncLazyAnalyzerTests.cs | 6 ------ .../VSTHRD012SpecifyJtfWhereAllowedTests.cs | 5 ----- .../VSTHRD100AsyncVoidMethodAnalyzerTests.cs | 16 ++++++---------- .../VSTHRD100AsyncVoidMethodCodeFixTests.cs | 8 ++------ .../VSTHRD101AsyncVoidLambdaAnalyzerTests.cs | 5 ----- ...idJtfRunInNonPublicMembersAnalyzerTests.cs | 19 +++++++------------ .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 5 ----- .../VSTHRD104OfferAsyncOptionAnalyzerTests.cs | 8 ++------ ...plicitTaskSchedulerCurrentAnalyzerTests.cs | 5 ----- ...eInvokeAsyncForAsyncEventsAnalyzerTests.cs | 4 ---- ...tTaskWithinUsingExpressionAnalyzerTests.cs | 18 +++++++----------- ...rtThreadRequirementUnconditionallyTests.cs | 16 ++++++---------- ...9AvoidAssertInAsyncMethodsAnalyzerTests.cs | 4 ---- ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 5 ----- ...VSTHRD111UseConfigureAwaitAnalyzerTests.cs | 5 ----- ...mentSystemIAsyncDisposableAnalyzerTests.cs | 4 ---- ...kForSystemIAsyncDisposableAnalyzerTests.cs | 4 ---- ...D114AvoidReturningNullTaskAnalyzerTests.cs | 4 ---- ...RD114AvoidReturningNullTaskCodeFixTests.cs | 4 ---- ...00UseAsyncNamingConventionAnalyzerTests.cs | 6 ------ 32 files changed, 41 insertions(+), 172 deletions(-) create mode 100644 test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs index 219effcd1..ffb4daf5a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs @@ -2,21 +2,16 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Immutable; using System.IO; using System.Linq; using System.Reflection; -using System.Runtime.CompilerServices; -using System.Threading.Tasks; #if WINDOWS using System.Windows.Threading; #endif -using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CSharp; using Microsoft.CodeAnalysis.CSharp.Testing; using Microsoft.CodeAnalysis.Testing.Verifiers; using Microsoft.CodeAnalysis.Text; -using Xunit; using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs index 91cc3de5f..bd605653f 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs @@ -1,12 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.CSharp.Testing; using Microsoft.CodeAnalysis.Diagnostics; -using Microsoft.CodeAnalysis.Testing; using Microsoft.CodeAnalysis.Testing.Verifiers; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 2943dfbbe..77095c232 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -3,7 +3,6 @@ using System.Collections.Immutable; using System.Net; -using Microsoft.CodeAnalysis.Testing; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs index 976fe1c2a..fb0d49708 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs @@ -2,19 +2,16 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Immutable; using System.IO; using System.Linq; using System.Reflection; #if WINDOWS using System.Windows.Threading; #endif -using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Testing.Verifiers; using Microsoft.CodeAnalysis.Text; using Microsoft.CodeAnalysis.VisualBasic; using Microsoft.CodeAnalysis.VisualBasic.Testing; -using Xunit; using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs index 377473909..489890d2e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs @@ -1,11 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.Diagnostics; -using Microsoft.CodeAnalysis.Testing; using Microsoft.CodeAnalysis.Testing.Verifiers; using Microsoft.CodeAnalysis.VisualBasic.Testing; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs index 19438d321..b052dbc59 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs @@ -5,14 +5,9 @@ using System.Collections.Generic; using System.Collections.Immutable; using System.Linq; -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; -using Microsoft.CodeAnalysis.Testing; -using Xunit; -using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.MultiAnalyzerTests.Verifier; - -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; +using Microsoft.VisualStudio.Threading.Analyzers.Tests; +using CSVerify = MultiAnalyzerTests.Verifier; public class MultiAnalyzerTests { diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs new file mode 100644 index 000000000..d38229f3d --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs @@ -0,0 +1,9 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +global using System.Threading.Tasks; +global using Microsoft; +global using Microsoft.CodeAnalysis; +global using Microsoft.CodeAnalysis.Testing; +global using Microsoft.VisualStudio.Threading.Analyzers; +global using Xunit; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs index 0030faa58..c2387b687 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD001UseSwitchToMainThreadAsyncAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs index 173bbf1aa..d57285e35 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD002UseJtfRunAnalyzerTests.cs @@ -1,14 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD002UseJtfRunAnalyzerTests { /// diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 870a0bb7e..213a7441e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1,17 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Diagnostics.Tracing; -using System.Linq; -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.CSharp; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD003UseJtfRunAsyncAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs index 3120a34d4..1271292de 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs index 11048aea2..01c3a3a5c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs @@ -1,14 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using static Microsoft.VisualStudio.Threading.Analyzers.VSTHRD010MainThreadUsageAnalyzer; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD010MainThreadUsageAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs index 19ae3b689..c58a2b281 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD011UseAsyncLazyAnalyzerTests.cs @@ -1,14 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD011UseAsyncLazyAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs index ab361cc79..dce0000a1 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD012SpecifyJtfWhereAllowedTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs index ef848194c..d84e0e61a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodAnalyzerTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD100AsyncVoidMethodAnalyzerTests { [Fact] @@ -20,7 +16,7 @@ async void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -38,7 +34,7 @@ async void F() {} } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 20); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 20); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -53,7 +49,7 @@ async void F(object sender, object e) { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -68,7 +64,7 @@ async void F(string sender, EventArgs e) { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -91,7 +87,7 @@ async System.Threading.Tasks.Task F(object sender, EventArgs e) { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -118,7 +114,7 @@ async System.Threading.Tasks.Task F(object sender, MyEventArgs e) { class MyEventArgs : EventArgs {} "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs index 071b8ed2f..0501ce8dc 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD100AsyncVoidMethodCodeFixTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD100AsyncVoidMethodCodeFixTests { [Fact] @@ -30,7 +26,7 @@ async System.Threading.Tasks.Task F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(5, 16); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -57,7 +53,7 @@ async Task F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(6, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(6, 16); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs index ebd2415f2..9ab1b841a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD101AsyncVoidLambdaAnalyzerTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD101AsyncVoidLambdaAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs index 91486115d..cbe31a6c0 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzerTests { [Fact] @@ -24,7 +19,7 @@ public void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -78,7 +73,7 @@ protected void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -113,7 +108,7 @@ internal void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -131,7 +126,7 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -178,7 +173,7 @@ void IFoo.F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(13, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(13, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -201,7 +196,7 @@ public void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(13, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(13, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -263,7 +258,7 @@ public Test() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(8, 13); await CSVerify.VerifyAnalyzerAsync(test, expected); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index b5221a695..f8f54deb3 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -1,14 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using static Microsoft.VisualStudio.Threading.Analyzers.VSTHRD103UseAsyncOptionAnalyzer; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD103UseAsyncOptionAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs index faa1f1660..8b0acc4eb 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD104OfferAsyncOptionAnalyzerTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD104OfferAsyncOptionAnalyzerTests { [Fact] @@ -27,7 +23,7 @@ public void Foo() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 13, 9, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 13, 9, 16); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -99,7 +95,7 @@ internal async Task FooAsync() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 13, 9, 16); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 13, 9, 16); await CSVerify.VerifyAnalyzerAsync(test, expected); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs index faa14decb..ffeae6a29 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs index 87ac9993e..a22af86b8 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD106UseInvokeAsyncForAsyncEventsAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs index 11966d8b3..2656c456b 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD107AwaitTaskWithinUsingExpressionAnalyzerTests { [Fact] @@ -39,7 +35,7 @@ async Task FAsync() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -77,7 +73,7 @@ async Task FAsync() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -113,7 +109,7 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -147,7 +143,7 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(8, 16, 8, 32); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -183,7 +179,7 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 24); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 24); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } @@ -225,7 +221,7 @@ async Task F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 27); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 27); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -247,7 +243,7 @@ void F() { } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 19); + DiagnosticResult expected = CSVerify.Diagnostic().WithSpan(9, 16, 9, 19); await CSVerify.VerifyAnalyzerAsync(test, expected); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs index 758afb9d0..da099f90e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD108AssertThreadRequirementUnconditionallyTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD108AssertThreadRequirementUnconditionallyTests { [Fact] @@ -43,7 +39,7 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -89,7 +85,7 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -111,7 +107,7 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -133,7 +129,7 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -171,7 +167,7 @@ void F() { } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); await CSVerify.VerifyAnalyzerAsync(test, expected); } @@ -195,7 +191,7 @@ private void ThrowIfNot(bool expr) } } "; - CodeAnalysis.Testing.DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); + DiagnosticResult expected = CSVerify.Diagnostic().WithLocation(0); await CSVerify.VerifyAnalyzerAsync(test, expected); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs index af9ec2064..b9f2ea635 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests.cs @@ -1,12 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD109AvoidAssertInAsyncMethodsAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index d37158985..a2b2d4120 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs index ffcc93e75..4bac72047 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD111UseConfigureAwaitAnalyzerTests.cs @@ -1,13 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD111UseConfigureAwaitAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs index 2962a15a6..7e2ac40cf 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests.cs @@ -1,13 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; using VBVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD112ImplementSystemIAsyncDisposableAnalyzerTests { private const string Preamble = @" diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs index 65e921445..31ff51ed2 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests.cs @@ -1,13 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; using VBVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD113CheckForSystemIAsyncDisposableAnalyzerTests { private const string Preamble = @" diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs index 649d66c38..63822876f 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs @@ -1,13 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; using VerifyVB = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD114AvoidReturningNullTaskAnalyzerTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs index 2edb0cac5..0aba86b77 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskCodeFixTests.cs @@ -1,13 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; using VerifyVB = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD114AvoidReturningNullTaskCodeFixTests { [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs index f7ea5d252..6033b321f 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs @@ -1,14 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.Testing; -using Xunit; using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; -namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; - public class VSTHRD200UseAsyncNamingConventionAnalyzerTests { private static readonly DiagnosticDescriptor AddSuffixDescriptor = VSTHRD200UseAsyncNamingConventionAnalyzer.AddAsyncDescriptor; From c7ceed01d1c73d7d5f2f6c0dd427245b3c7c8d96 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Dec 2022 16:58:57 -0700 Subject: [PATCH 0643/1753] Fix perf issue with VSTHRD110 This also converts the analyzer to an IOperation analyzer and makes it work for VB. Fix #971 --- .../CSharpUtils.cs | 13 + ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 13 + ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 63 - .../VisualBasicUtils.cs | 3 + ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 13 + ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 70 + .../CommonInterest.cs | 217 +++- .../DiagnosticAnalyzerState.cs | 131 -- .../LanguageUtils.cs | 2 + .../Strings.Designer.cs | 1138 ++++++++--------- .../Strings.resx | 2 +- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 90 +- ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 90 +- 13 files changed, 1005 insertions(+), 840 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs delete mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs create mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs create mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs delete mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index faf7549af..386927675 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -262,6 +262,19 @@ internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSy return returnType is not null && returnType.IsKind(SyntaxKind.NullableType); } + internal override bool IsAsyncMethod(SyntaxNode syntaxNode) + { + SyntaxTokenList? modifiers = syntaxNode switch + { + MethodDeclarationSyntax methodDeclaration => methodDeclaration.Modifiers, + SimpleLambdaExpressionSyntax lambda => lambda.Modifiers, + AnonymousMethodExpressionSyntax anonMethod => anonMethod.Modifiers, + ParenthesizedLambdaExpressionSyntax lambda => lambda.Modifiers, + _ => null, + }; + return modifiers?.Any(SyntaxKind.AsyncKeyword) is true; + } + internal readonly struct ContainingFunctionData { internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax? parameterList, CSharpSyntaxNode? blockOrExpression, Func bodyReplacement) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs new file mode 100644 index 000000000..4f64498fd --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -0,0 +1,13 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.CSharp)] +public sealed class CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer : AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer +{ + private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; +} diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs deleted file mode 100644 index 63f205adc..000000000 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using System.Collections.Immutable; -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.CSharp; -using Microsoft.CodeAnalysis.CSharp.Syntax; -using Microsoft.CodeAnalysis.Diagnostics; - -namespace Microsoft.VisualStudio.Threading.Analyzers; - -/// -/// Report errors when async methods calls are not awaited or the result used in some way within a synchronous method. -/// -[DiagnosticAnalyzer(LanguageNames.CSharp)] -public class VSTHRD110ObserveResultOfAsyncCallsAnalyzer : DiagnosticAnalyzer -{ - public const string Id = "VSTHRD110"; - - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( - id: Id, - title: new LocalizableResourceString(nameof(Strings.VSTHRD110_Title), Strings.ResourceManager, typeof(Strings)), - messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD110_MessageFormat), Strings.ResourceManager, typeof(Strings)), - helpLinkUri: Utils.GetHelpLink(Id), - category: "Usage", - defaultSeverity: DiagnosticSeverity.Warning, - isEnabledByDefault: true); - - /// - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - - /// - public override void Initialize(AnalysisContext context) - { - context.EnableConcurrentExecution(); - context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - - context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(new PerCompilation().AnalyzeInvocation), SyntaxKind.InvocationExpression); - } - - private class PerCompilation : DiagnosticAnalyzerState - { - internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) - { - var invocation = (InvocationExpressionSyntax)context.Node; - - // Only consider invocations that are direct statements. Otherwise, we assume their - // result is awaited, assigned, or otherwise consumed. - if (invocation.Parent is ExpressionStatementSyntax || invocation.Parent is ConditionalAccessExpressionSyntax) - { - var methodSymbol = context.SemanticModel.GetSymbolInfo(context.Node).Symbol as IMethodSymbol; - if (this.IsAwaitableType(methodSymbol?.ReturnType, context.Compilation, context.CancellationToken)) - { - if (!CSharpUtils.GetContainingFunction(invocation).IsAsync) - { - Location? location = (CSharpUtils.IsolateMethodName(invocation) ?? invocation.Expression).GetLocation(); - context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); - } - } - } - } - } -} diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs index 71bdd2feb..dc2c2a787 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs @@ -5,6 +5,7 @@ using System.Threading; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Operations; +using Microsoft.CodeAnalysis.VisualBasic; using Microsoft.CodeAnalysis.VisualBasic.Syntax; namespace Microsoft.VisualStudio.Threading.Analyzers; @@ -93,4 +94,6 @@ internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSy // VB.NET doesn't support nullable reference types return false; } + + internal override bool IsAsyncMethod(SyntaxNode syntaxNode) => syntaxNode is MethodBlockSyntax methodDeclaration && methodDeclaration.BlockStatement.Modifiers.Any(SyntaxKind.AsyncKeyword); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs new file mode 100644 index 000000000..3b6110b0f --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -0,0 +1,13 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; + +namespace Microsoft.VisualStudio.Threading.Analyzers; + +[DiagnosticAnalyzer(LanguageNames.VisualBasic)] +public sealed class VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer : AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer +{ + private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; +} diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs new file mode 100644 index 000000000..720d7f525 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -0,0 +1,70 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System.Collections.Generic; +using System.Collections.Immutable; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; + +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Report errors when async methods calls are not awaited or the result used in some way within a synchronous method. +/// +public abstract class AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer : DiagnosticAnalyzer +{ + public const string Id = "VSTHRD110"; + + internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + id: Id, + title: new LocalizableResourceString(nameof(Strings.VSTHRD110_Title), Strings.ResourceManager, typeof(Strings)), + messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD110_MessageFormat), Strings.ResourceManager, typeof(Strings)), + helpLinkUri: Utils.GetHelpLink(Id), + category: "Usage", + defaultSeverity: DiagnosticSeverity.Warning, + isEnabledByDefault: true); + + /// + public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); + + private protected abstract LanguageUtils LanguageUtils { get; } + + /// + public override void Initialize(AnalysisContext context) + { + context.EnableConcurrentExecution(); + context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); + + context.RegisterCompilationStartAction(context => + { + CommonInterest.AwaitableTypeTester awaitableTypes = CommonInterest.CollectAwaitableTypes(context.Compilation, context.CancellationToken); + context.RegisterOperationAction(Utils.DebuggableWrapper(context => this.AnalyzeInvocation(context, awaitableTypes)), OperationKind.Invocation); + }); + } + + private void AnalyzeInvocation(OperationAnalysisContext context, CommonInterest.AwaitableTypeTester awaitableTypes) + { + var operation = (IInvocationOperation)context.Operation; + if (operation.Type is null) + { + return; + } + + if (operation.GetContainingFunction() is { } function && this.LanguageUtils.IsAsyncMethod(function.Syntax)) + { + // CS4014 should already take care of this case. + return; + } + + // Only consider invocations that are direct statements. Otherwise, we assume their + // result is awaited, assigned, or otherwise consumed. + if (operation.Parent is IExpressionStatementOperation || operation.Parent is IConditionalAccessOperation) + { + if (awaitableTypes.IsAwaitableType(operation.Type)) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, operation.Syntax.GetLocation())); + } + } + } +} diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index 33beb7da1..5a82d0b0a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -14,6 +14,7 @@ using System.Threading.Tasks; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; using Microsoft.CodeAnalysis.Text; namespace Microsoft.VisualStudio.Threading.Analyzers; @@ -63,6 +64,8 @@ internal static class CommonInterest private const RegexOptions FileNamePatternRegexOptions = RegexOptions.IgnoreCase | RegexOptions.Singleline; + private const string GetAwaiterMethodName = "GetAwaiter"; + private static readonly TimeSpan RegexMatchTimeout = TimeSpan.FromSeconds(5); // Prevent expensive CPU hang in Regex.Match if backtracking occurs due to pathological input (see #485). private static readonly Regex NegatableTypeOrMemberReferenceRegex = new Regex(@"^(?!)?\[(?[^\[\]\:]+)+\](?:\:\:(?\S+))?\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); @@ -124,10 +127,10 @@ internal static IEnumerable ReadAdditionalFiles(AnalyzerOptions analyzer } IEnumerable? docs = from file in analyzerOptions.AdditionalFiles.OrderBy(x => x.Path, StringComparer.Ordinal) - let fileName = Path.GetFileName(file.Path) - where fileNamePattern.IsMatch(fileName) - let text = file.GetText(cancellationToken) - select text; + let fileName = Path.GetFileName(file.Path) + where fileNamePattern.IsMatch(fileName) + let text = file.GetText(cancellationToken) + select text; return docs.SelectMany(ReadLinesFromAdditionalFile); } @@ -166,6 +169,159 @@ internal static bool Contains(this ImmutableArray types, [NotNull return !matching.IsEmpty && !matching.InvertedLogic; } + internal static CommonInterest.AwaitableTypeTester CollectAwaitableTypes(Compilation compilation, CancellationToken cancellationToken) + { + HashSet awaitableTypes = new(SymbolEqualityComparer.Default); + void AddAwaitableType(ITypeSymbol type) + { + if (type is INamedTypeSymbol { IsGenericType: true, IsUnboundGenericType: false } genericType) + { + awaitableTypes.Add(genericType.ConstructUnboundGenericType()); + } + else + { + awaitableTypes.Add(type); + } + } + + foreach (ISymbol getAwaiterMember in compilation.GetSymbolsWithName(GetAwaiterMethodName, SymbolFilter.Member, cancellationToken)) + { + if (TryGetAwaitableType(getAwaiterMember, out ITypeSymbol? awaitableType)) + { + AddAwaitableType(awaitableType); + } + } + + foreach (IAssemblySymbol referenceAssembly in compilation.Assembly.Modules.First().ReferencedAssemblySymbols) + { + CollectNamespace(referenceAssembly.GlobalNamespace); + + void CollectNamespace(INamespaceOrTypeSymbol nsOrType) + { + if (nsOrType is INamespaceSymbol ns) + { + foreach (INamespaceSymbol nestedNs in ns.GetNamespaceMembers()) + { + CollectNamespace(nestedNs); + } + } + + foreach (INamedTypeSymbol nestedType in nsOrType.GetTypeMembers()) + { + CollectNamespace(nestedType); + } + + foreach (ISymbol getAwaiterMember in nsOrType.GetMembers(GetAwaiterMethodName)) + { + if (TryGetAwaitableType(getAwaiterMember, out ITypeSymbol? awaitableType)) + { + AddAwaitableType(awaitableType); + } + } + } + } + + bool TryGetAwaitableType(ISymbol getAwaiterMember, [NotNullWhen(true)] out ITypeSymbol? awaitableType) + { + if (getAwaiterMember is IMethodSymbol getAwaiterMethod && compilation.IsSymbolAccessibleWithin(getAwaiterMember, compilation.Assembly) && TestGetAwaiterMethod(getAwaiterMethod)) + { + awaitableType = getAwaiterMethod.IsExtensionMethod ? getAwaiterMethod.Parameters[0].Type : getAwaiterMethod.ContainingType; + return true; + } + + awaitableType = null; + return false; + } + + return new AwaitableTypeTester(awaitableTypes); + } + + internal static bool IsAwaitable(this ITypeSymbol? typeSymbol) + { + if (typeSymbol is null) + { + return false; + } + + foreach (ISymbol symbol in typeSymbol.GetMembers(GetAwaiterMethodName)) + { + if (symbol is IMethodSymbol getAwaiterMethod && TestGetAwaiterMethod(getAwaiterMethod)) + { + return true; + } + } + + return false; + } + + internal static bool IsAwaitable(this ITypeSymbol? typeSymbol, SemanticModel semanticModel, int position) + { + if (typeSymbol is null) + { + return false; + } + + // We're able to do a more comprehensive job by detecting extension methods as well when we have a semantic model. + foreach (ISymbol symbol in semanticModel.LookupSymbols(position, typeSymbol, name: GetAwaiterMethodName, includeReducedExtensionMethods: true)) + { + if (symbol is IMethodSymbol getAwaiterMethod && TestGetAwaiterMethod(getAwaiterMethod)) + { + return true; + } + } + + return false; + } + + internal static IOperation? GetContainingFunction(this IOperation? operation) + { + while (operation?.Parent is not null) + { + if (operation.Parent is IAnonymousFunctionOperation or IMethodBodyOperation) + { + return operation.Parent; + } + + if (operation.Language == LanguageNames.VisualBasic) + { + if (operation.Parent is IBlockOperation) + { + return operation.Parent; + } + } + + operation = operation.Parent; + } + + return null; + } + + internal static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) + { + if (typeSymbol is null) + { + return false; + } + + var hasGetResultMethod = false; + var hasOnCompletedMethod = false; + var hasIsCompletedProperty = false; + + foreach (ISymbol? member in typeSymbol.GetMembers()) + { + hasGetResultMethod |= member.Name == nameof(TaskAwaiter.GetResult) && member is IMethodSymbol m && m.Parameters.IsEmpty; + hasOnCompletedMethod |= member.Name == nameof(TaskAwaiter.OnCompleted) && member is IMethodSymbol; + hasIsCompletedProperty |= member.Name == nameof(TaskAwaiter.IsCompleted) && member is IPropertySymbol; + + if (hasGetResultMethod && hasOnCompletedMethod && hasIsCompletedProperty) + { + return true; + } + } + + return false; + } + internal static IEnumerable ReadLinesFromAdditionalFile(SourceText text) { if (text is null) @@ -208,6 +364,31 @@ internal static QualifiedMember ParseAdditionalFileMethodLine(string line) return new QualifiedMember(containingType, methodName); } + private static bool TestGetAwaiterMethod(IMethodSymbol getAwaiterMethod) + { + if (getAwaiterMethod.IsExtensionMethod) + { + if (getAwaiterMethod.Parameters.Length != 1) + { + return false; + } + } + else + { + if (!getAwaiterMethod.Parameters.IsEmpty) + { + return false; + } + } + + if (!CommonInterest.ConformsToAwaiterPattern(getAwaiterMethod.ReturnType)) + { + return false; + } + + return true; + } + internal readonly struct TypeMatchSpec { internal TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) @@ -339,4 +520,32 @@ public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethod public IReadOnlyList? ExtensionMethodNamespace { get; } } + + internal class AwaitableTypeTester + { + private readonly HashSet awaitableTypes; + + internal AwaitableTypeTester(HashSet awaitableTypes) + { + this.awaitableTypes = awaitableTypes; + } + + internal bool IsAwaitableType(ITypeSymbol typeSymbol) + { + if (this.awaitableTypes.Contains(typeSymbol)) + { + return true; + } + + if (typeSymbol is INamedTypeSymbol { IsGenericType: true } genericTypeSymbol) + { + if (this.awaitableTypes.Contains(genericTypeSymbol.ConstructUnboundGenericType())) + { + return true; + } + } + + return false; + } + } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs deleted file mode 100644 index 71c6ada4c..000000000 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/DiagnosticAnalyzerState.cs +++ /dev/null @@ -1,131 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using System; -using System.Collections.Concurrent; -using System.Collections.Generic; -using System.Collections.Immutable; -using System.Linq; -using System.Runtime.CompilerServices; -using System.Threading; -using System.Threading.Tasks; -using Microsoft.CodeAnalysis; - -namespace Microsoft.VisualStudio.Threading.Analyzers; - -/// -/// A class for our analyzers that provide per-compilation caching by way of its private fields -/// to support common utility methods. -/// -internal abstract class DiagnosticAnalyzerState -{ - private const string GetAwaiterMethodName = nameof(Task.GetAwaiter); - - private readonly ConcurrentDictionary customAwaitableTypes = new ConcurrentDictionary(SymbolEqualityComparer.Default); - - internal bool IsAwaitableType(ITypeSymbol? typeSymbol, Compilation compilation, CancellationToken cancellationToken) - { - if (typeSymbol is null) - { - return false; - } - - if (!this.customAwaitableTypes.TryGetValue(typeSymbol, out bool isAwaitable)) - { - IMethodSymbol? getAwaiterMethod = typeSymbol.GetMembers(nameof(Task.GetAwaiter)).OfType().FirstOrDefault(m => m.Parameters.IsEmpty); - if (getAwaiterMethod is object) - { - isAwaitable = ConformsToAwaiterPattern(getAwaiterMethod.ReturnType); - } - else - { - IEnumerable? awaitableTypesFromThisAssembly = from candidateAwaiterMethod in compilation.GetSymbolsWithName(m => m == GetAwaiterMethodName, SymbolFilter.Member, cancellationToken).OfType() - where candidateAwaiterMethod.IsExtensionMethod && !candidateAwaiterMethod.Parameters.IsEmpty - where ConformsToAwaiterPattern(candidateAwaiterMethod.ReturnType) - select candidateAwaiterMethod.Parameters[0].Type; - IEnumerable? awaitableTypesPerAssembly = from assembly in compilation.Assembly.Modules.First().ReferencedAssemblySymbols - from awaitableType in GetAwaitableTypes(assembly) - select awaitableType; - isAwaitable = awaitableTypesFromThisAssembly.Concat(awaitableTypesPerAssembly).Contains(typeSymbol, SymbolEqualityComparer.Default); - } - - this.customAwaitableTypes.TryAdd(typeSymbol, isAwaitable); - } - - return isAwaitable; - } - - private static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) - { - if (typeSymbol is null) - { - return false; - } - - var hasGetResultMethod = false; - var hasOnCompletedMethod = false; - var hasIsCompletedProperty = false; - - foreach (ISymbol? member in typeSymbol.GetMembers()) - { - hasGetResultMethod |= member.Name == nameof(TaskAwaiter.GetResult) && member is IMethodSymbol m && m.Parameters.IsEmpty; - hasOnCompletedMethod |= member.Name == nameof(TaskAwaiter.OnCompleted) && member is IMethodSymbol; - hasIsCompletedProperty |= member.Name == nameof(TaskAwaiter.IsCompleted) && member is IPropertySymbol; - - if (hasGetResultMethod && hasOnCompletedMethod && hasIsCompletedProperty) - { - return true; - } - } - - return false; - } - - private static IEnumerable GetAwaitableTypes(IAssemblySymbol assembly) - { - if (assembly is null) - { - throw new ArgumentNullException(nameof(assembly)); - } - - if (!assembly.MightContainExtensionMethods) - { - return Enumerable.Empty(); - } - - return GetAwaitableTypes(assembly.GlobalNamespace); - } - - private static IEnumerable GetAwaitableTypes(INamespaceOrTypeSymbol namespaceOrTypeSymbol) - { - if (namespaceOrTypeSymbol is null || namespaceOrTypeSymbol.DeclaredAccessibility != Accessibility.Public) - { - yield break; - } - - foreach (ISymbol? member in namespaceOrTypeSymbol.GetMembers()) - { - switch (member) - { - case INamespaceOrTypeSymbol nsOrType: - foreach (ITypeSymbol? nested in GetAwaitableTypes(nsOrType)) - { - yield return nested; - } - - break; - case IMethodSymbol method: - if (method.DeclaredAccessibility == Accessibility.Public && - method.IsExtensionMethod && - method.Name == GetAwaiterMethodName && - !method.Parameters.IsEmpty && - ConformsToAwaiterPattern(method.ReturnType)) - { - yield return method.Parameters[0].Type; - } - - break; - } - } - } -} diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs index a48261e63..c97085c26 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs @@ -16,4 +16,6 @@ internal abstract class LanguageUtils internal abstract SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation); internal abstract bool MethodReturnsNullableReferenceType(IMethodSymbol method); + + internal abstract bool IsAsyncMethod(SyntaxNode syntaxNode); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs index 3ac90eeb4..0e0d5f400 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs @@ -8,642 +8,642 @@ // //------------------------------------------------------------------------------ -namespace Microsoft.VisualStudio.Threading.Analyzers; -using System; -using System.Reflection; - - -/// -/// A strongly-typed resource class, for looking up localized strings, etc. -/// -// This class was auto-generated by the StronglyTypedResourceBuilder -// class via a tool like ResGen or Visual Studio. -// To add or remove a member, edit your .ResX file then rerun ResGen -// with the /str option, or rebuild your VS project. -[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] -[global::System.Diagnostics.DebuggerNonUserCodeAttribute()] -[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] -internal class Strings { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal Strings() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Analyzers.Strings", typeof(Strings).GetTypeInfo().Assembly); - resourceMan = temp; +namespace Microsoft.VisualStudio.Threading.Analyzers { + using System; + + + /// + /// A strongly-typed resource class, for looking up localized strings, etc. + /// + // This class was auto-generated by the StronglyTypedResourceBuilder + // class via a tool like ResGen or Visual Studio. + // To add or remove a member, edit your .ResX file then rerun ResGen + // with the /str option, or rebuild your VS project. + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Strings { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Strings() { + } + + /// + /// Returns the cached ResourceManager instance used by this class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Analyzers.Strings", typeof(Strings).Assembly); + resourceMan = temp; + } + return resourceMan; } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; } - set { - resourceCulture = value; + + /// + /// Overrides the current thread's CurrentUICulture property for all + /// resource lookups using this strongly typed resource class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } } - } - - /// - /// Looks up a localized string similar to Await {0} instead. - /// - internal static string AwaitXInstead { - get { - return ResourceManager.GetString("AwaitXInstead", resourceCulture); + + /// + /// Looks up a localized string similar to Await {0} instead. + /// + internal static string AwaitXInstead { + get { + return ResourceManager.GetString("AwaitXInstead", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to The System.IAsyncDisposable interface is defined in the Microsoft.Bcl.AsyncInterfaces NuGet package.. - /// - internal static string SystemIAsyncDisposablePackageNote { - get { - return ResourceManager.GetString("SystemIAsyncDisposablePackageNote", resourceCulture); + + /// + /// Looks up a localized string similar to The System.IAsyncDisposable interface is defined in the Microsoft.Bcl.AsyncInterfaces NuGet package.. + /// + internal static string SystemIAsyncDisposablePackageNote { + get { + return ResourceManager.GetString("SystemIAsyncDisposablePackageNote", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use await instead. - /// - internal static string UseAwaitInstead { - get { - return ResourceManager.GetString("UseAwaitInstead", resourceCulture); + + /// + /// Looks up a localized string similar to Use await instead. + /// + internal static string UseAwaitInstead { + get { + return ResourceManager.GetString("UseAwaitInstead", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Await JoinableTaskFactory.SwitchToMainThreadAsync() to switch to the UI thread instead of APIs that can deadlock or require specifying a priority. - /// - internal static string VSTHRD001_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD001_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Await JoinableTaskFactory.SwitchToMainThreadAsync() to switch to the UI thread instead of APIs that can deadlock or require specifying a priority. + /// + internal static string VSTHRD001_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD001_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid legacy thread switching APIs. - /// - internal static string VSTHRD001_Title { - get { - return ResourceManager.GetString("VSTHRD001_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid legacy thread switching APIs. + /// + internal static string VSTHRD001_Title { + get { + return ResourceManager.GetString("VSTHRD001_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use await instead. - /// - internal static string VSTHRD002_CodeFix_Await_Title { - get { - return ResourceManager.GetString("VSTHRD002_CodeFix_Await_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Use await instead. + /// + internal static string VSTHRD002_CodeFix_Await_Title { + get { + return ResourceManager.GetString("VSTHRD002_CodeFix_Await_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.. - /// - internal static string VSTHRD002_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD002_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.. + /// + internal static string VSTHRD002_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD002_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid problematic synchronous waits. - /// - internal static string VSTHRD002_Title { - get { - return ResourceManager.GetString("VSTHRD002_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid problematic synchronous waits. + /// + internal static string VSTHRD002_Title { + get { + return ResourceManager.GetString("VSTHRD002_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid awaiting or returning a Task representing work that was not started within your context as that can lead to deadlocks. - ///Start the work within this context, or use JoinableTaskFactory.RunAsync to start the task and await the returned JoinableTask instead.. - /// - internal static string VSTHRD003_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD003_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid awaiting or returning a Task representing work that was not started within your context as that can lead to deadlocks. + ///Start the work within this context, or use JoinableTaskFactory.RunAsync to start the task and await the returned JoinableTask instead.. + /// + internal static string VSTHRD003_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD003_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid awaiting foreign Tasks. - /// - internal static string VSTHRD003_Title { - get { - return ResourceManager.GetString("VSTHRD003_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid awaiting foreign Tasks. + /// + internal static string VSTHRD003_Title { + get { + return ResourceManager.GetString("VSTHRD003_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Calls to JoinableTaskFactory.SwitchToMainThreadAsync() must be awaited. - /// - internal static string VSTHRD004_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD004_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Calls to JoinableTaskFactory.SwitchToMainThreadAsync() must be awaited. + /// + internal static string VSTHRD004_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD004_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Await SwitchToMainThreadAsync. - /// - internal static string VSTHRD004_Title { - get { - return ResourceManager.GetString("VSTHRD004_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Await SwitchToMainThreadAsync. + /// + internal static string VSTHRD004_Title { + get { + return ResourceManager.GetString("VSTHRD004_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Await JoinableTaskFactory.SwitchToMainThreadAsync() first.. - /// - internal static string VSTHRD010_MessageFormat_Async { - get { - return ResourceManager.GetString("VSTHRD010_MessageFormat_Async", resourceCulture); + + /// + /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Await JoinableTaskFactory.SwitchToMainThreadAsync() first.. + /// + internal static string VSTHRD010_MessageFormat_Async { + get { + return ResourceManager.GetString("VSTHRD010_MessageFormat_Async", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Call {1}() first.. - /// - internal static string VSTHRD010_MessageFormat_Sync { - get { - return ResourceManager.GetString("VSTHRD010_MessageFormat_Sync", resourceCulture); + + /// + /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Call {1}() first.. + /// + internal static string VSTHRD010_MessageFormat_Sync { + get { + return ResourceManager.GetString("VSTHRD010_MessageFormat_Sync", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Invoke single-threaded types on Main thread. - /// - internal static string VSTHRD010_Title { - get { - return ResourceManager.GetString("VSTHRD010_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Invoke single-threaded types on Main thread. + /// + internal static string VSTHRD010_Title { + get { + return ResourceManager.GetString("VSTHRD010_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Lazy<Task<T>>.Value can deadlock. Use AsyncLazy<T> instead.. - /// - internal static string VSTHRD011_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD011_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Lazy<Task<T>>.Value can deadlock. Use AsyncLazy<T> instead.. + /// + internal static string VSTHRD011_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD011_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use AsyncLazy<T>. - /// - internal static string VSTHRD011_Title { - get { - return ResourceManager.GetString("VSTHRD011_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Use AsyncLazy<T>. + /// + internal static string VSTHRD011_Title { + get { + return ResourceManager.GetString("VSTHRD011_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Invoking or blocking on async code in a Lazy<T> value factory can deadlock. Use AsyncLazy<T> instead.. - /// - internal static string VSTHRD011b_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD011b_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Invoking or blocking on async code in a Lazy<T> value factory can deadlock. Use AsyncLazy<T> instead.. + /// + internal static string VSTHRD011b_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD011b_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Provide an instance of JoinableTaskFactory in this call (or another overload) to avoid deadlocks with the main thread. - /// - internal static string VSTHRD012_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD012_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Provide an instance of JoinableTaskFactory in this call (or another overload) to avoid deadlocks with the main thread. + /// + internal static string VSTHRD012_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD012_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Provide JoinableTaskFactory where allowed. - /// - internal static string VSTHRD012_Title { - get { - return ResourceManager.GetString("VSTHRD012_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Provide JoinableTaskFactory where allowed. + /// + internal static string VSTHRD012_Title { + get { + return ResourceManager.GetString("VSTHRD012_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Change return type to Task. - /// - internal static string VSTHRD100_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD100_CodeFix_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Change return type to Task. + /// + internal static string VSTHRD100_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD100_CodeFix_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid "async void" methods, because any exceptions not handled by the method will crash the process. - /// - internal static string VSTHRD100_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD100_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid "async void" methods, because any exceptions not handled by the method will crash the process. + /// + internal static string VSTHRD100_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD100_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid async void methods. - /// - internal static string VSTHRD100_Title { - get { - return ResourceManager.GetString("VSTHRD100_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid async void methods. + /// + internal static string VSTHRD100_Title { + get { + return ResourceManager.GetString("VSTHRD100_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process. - /// - internal static string VSTHRD101_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD101_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process. + /// + internal static string VSTHRD101_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD101_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid unsupported async delegates. - /// - internal static string VSTHRD101_Title { - get { - return ResourceManager.GetString("VSTHRD101_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid unsupported async delegates. + /// + internal static string VSTHRD101_Title { + get { + return ResourceManager.GetString("VSTHRD101_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Limit use of synchronously blocking method calls such as JoinableTaskFactory.Run or Task.Result to public entrypoint members where you must be synchronous. Using it for internal members can needlessly add synchronous frames between asynchronous frames, leading to threadpool exhaustion.. - /// - internal static string VSTHRD102_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD102_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Limit use of synchronously blocking method calls such as JoinableTaskFactory.Run or Task.Result to public entrypoint members where you must be synchronous. Using it for internal members can needlessly add synchronous frames between asynchronous frames, leading to threadpool exhaustion.. + /// + internal static string VSTHRD102_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD102_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Implement internal logic asynchronously. - /// - internal static string VSTHRD102_Title { - get { - return ResourceManager.GetString("VSTHRD102_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Implement internal logic asynchronously. + /// + internal static string VSTHRD102_Title { + get { + return ResourceManager.GetString("VSTHRD102_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to {0} synchronously blocks. Await {1} instead.. - /// - internal static string VSTHRD103_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD103_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to {0} synchronously blocks. Await {1} instead.. + /// + internal static string VSTHRD103_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD103_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to {0} synchronously blocks. Use await instead.. - /// - internal static string VSTHRD103_MessageFormat_UseAwaitInstead { - get { - return ResourceManager.GetString("VSTHRD103_MessageFormat_UseAwaitInstead", resourceCulture); + + /// + /// Looks up a localized string similar to {0} synchronously blocks. Use await instead.. + /// + internal static string VSTHRD103_MessageFormat_UseAwaitInstead { + get { + return ResourceManager.GetString("VSTHRD103_MessageFormat_UseAwaitInstead", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Call async methods when in an async method. - /// - internal static string VSTHRD103_Title { - get { - return ResourceManager.GetString("VSTHRD103_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Call async methods when in an async method. + /// + internal static string VSTHRD103_Title { + get { + return ResourceManager.GetString("VSTHRD103_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.. - /// - internal static string VSTHRD104_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD104_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.. + /// + internal static string VSTHRD104_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD104_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Offer async methods. - /// - internal static string VSTHRD104_Title { - get { - return ResourceManager.GetString("VSTHRD104_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Offer async methods. + /// + internal static string VSTHRD104_Title { + get { + return ResourceManager.GetString("VSTHRD104_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. Use an overload that accepts a TaskScheduler and specify TaskScheduler.Default (or any other) explicitly.. - /// - internal static string VSTHRD105_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD105_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. Use an overload that accepts a TaskScheduler and specify TaskScheduler.Default (or any other) explicitly.. + /// + internal static string VSTHRD105_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD105_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. - /// - internal static string VSTHRD105_Title { - get { - return ResourceManager.GetString("VSTHRD105_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. + /// + internal static string VSTHRD105_Title { + get { + return ResourceManager.GetString("VSTHRD105_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to AsyncEventHandler delegates should be invoked via the extension method "TplExtensions.InvokeAsync()" defined in Microsoft.VisualStudio.Threading assembly. - /// - internal static string VSTHRD106_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD106_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to AsyncEventHandler delegates should be invoked via the extension method "TplExtensions.InvokeAsync()" defined in Microsoft.VisualStudio.Threading assembly. + /// + internal static string VSTHRD106_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD106_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use InvokeAsync to raise async events. - /// - internal static string VSTHRD106_Title { - get { - return ResourceManager.GetString("VSTHRD106_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Use InvokeAsync to raise async events. + /// + internal static string VSTHRD106_Title { + get { + return ResourceManager.GetString("VSTHRD106_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Await using expression. - /// - internal static string VSTHRD107_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD107_CodeFix_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Await using expression. + /// + internal static string VSTHRD107_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD107_CodeFix_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Missing await operator for "using" expression. - /// - internal static string VSTHRD107_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD107_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Missing await operator for "using" expression. + /// + internal static string VSTHRD107_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD107_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Await Task within using expression. - /// - internal static string VSTHRD107_Title { - get { - return ResourceManager.GetString("VSTHRD107_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Await Task within using expression. + /// + internal static string VSTHRD107_Title { + get { + return ResourceManager.GetString("VSTHRD107_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Thread affinity checks should be unconditional. - /// - internal static string VSTHRD108_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD108_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Thread affinity checks should be unconditional. + /// + internal static string VSTHRD108_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD108_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Assert thread affinity unconditionally. - /// - internal static string VSTHRD108_Title { - get { - return ResourceManager.GetString("VSTHRD108_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Assert thread affinity unconditionally. + /// + internal static string VSTHRD108_Title { + get { + return ResourceManager.GetString("VSTHRD108_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid throwing when not on the main thread while in an async or Task-returning method. Switch to the thread required instead.. - /// - internal static string VSTHRD109_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD109_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid throwing when not on the main thread while in an async or Task-returning method. Switch to the thread required instead.. + /// + internal static string VSTHRD109_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD109_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Switch instead of assert in async methods. - /// - internal static string VSTHRD109_Title { - get { - return ResourceManager.GetString("VSTHRD109_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Switch instead of assert in async methods. + /// + internal static string VSTHRD109_Title { + get { + return ResourceManager.GetString("VSTHRD109_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method.. - /// - internal static string VSTHRD110_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD110_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method. + /// + internal static string VSTHRD110_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD110_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Observe result of async calls. - /// - internal static string VSTHRD110_Title { - get { - return ResourceManager.GetString("VSTHRD110_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Observe result of async calls. + /// + internal static string VSTHRD110_Title { + get { + return ResourceManager.GetString("VSTHRD110_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(false). - /// - internal static string VSTHRD111_CodeFix_False_Title { - get { - return ResourceManager.GetString("VSTHRD111_CodeFix_False_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Add .ConfigureAwait(false). + /// + internal static string VSTHRD111_CodeFix_False_Title { + get { + return ResourceManager.GetString("VSTHRD111_CodeFix_False_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(true). - /// - internal static string VSTHRD111_CodeFix_True_Title { - get { - return ResourceManager.GetString("VSTHRD111_CodeFix_True_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Add .ConfigureAwait(true). + /// + internal static string VSTHRD111_CodeFix_True_Title { + get { + return ResourceManager.GetString("VSTHRD111_CodeFix_True_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(bool) to your await expression. - /// - internal static string VSTHRD111_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD111_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Add .ConfigureAwait(bool) to your await expression. + /// + internal static string VSTHRD111_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD111_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use ConfigureAwait(bool). - /// - internal static string VSTHRD111_Title { - get { - return ResourceManager.GetString("VSTHRD111_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Use ConfigureAwait(bool). + /// + internal static string VSTHRD111_Title { + get { + return ResourceManager.GetString("VSTHRD111_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Add implementation of System.IAsyncDisposable.. - /// - internal static string VSTHRD112_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD112_CodeFix_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Add implementation of System.IAsyncDisposable.. + /// + internal static string VSTHRD112_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD112_CodeFix_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Implement the System.IAsyncDisposable interface when implementing the obsolete Microsoft.VisualStudio.Threading.IAsyncDisposable interface. - /// - internal static string VSTHRD112_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD112_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Implement the System.IAsyncDisposable interface when implementing the obsolete Microsoft.VisualStudio.Threading.IAsyncDisposable interface. + /// + internal static string VSTHRD112_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD112_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Implement System.IAsyncDisposable. - /// - internal static string VSTHRD112_Title { - get { - return ResourceManager.GetString("VSTHRD112_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Implement System.IAsyncDisposable. + /// + internal static string VSTHRD112_Title { + get { + return ResourceManager.GetString("VSTHRD112_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Add a check for System.IAsyncDisposable in the same code block that checks for Microsoft.VisualStudio.Threading.IAsyncDisposable that behaves similarly. - /// - internal static string VSTHRD113_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD113_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Add a check for System.IAsyncDisposable in the same code block that checks for Microsoft.VisualStudio.Threading.IAsyncDisposable that behaves similarly. + /// + internal static string VSTHRD113_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD113_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Check for System.IAsyncDisposable. - /// - internal static string VSTHRD113_Title { - get { - return ResourceManager.GetString("VSTHRD113_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Check for System.IAsyncDisposable. + /// + internal static string VSTHRD113_Title { + get { + return ResourceManager.GetString("VSTHRD113_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use 'Task.CompletedTask' instead. - /// - internal static string VSTHRD114_CodeFix_CompletedTask { - get { - return ResourceManager.GetString("VSTHRD114_CodeFix_CompletedTask", resourceCulture); + + /// + /// Looks up a localized string similar to Use 'Task.CompletedTask' instead. + /// + internal static string VSTHRD114_CodeFix_CompletedTask { + get { + return ResourceManager.GetString("VSTHRD114_CodeFix_CompletedTask", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use 'Task.FromResult' instead. - /// - internal static string VSTHRD114_CodeFix_FromResult { - get { - return ResourceManager.GetString("VSTHRD114_CodeFix_FromResult", resourceCulture); + + /// + /// Looks up a localized string similar to Use 'Task.FromResult' instead. + /// + internal static string VSTHRD114_CodeFix_FromResult { + get { + return ResourceManager.GetString("VSTHRD114_CodeFix_FromResult", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid returning null from a Task-returning method. - /// - internal static string VSTHRD114_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD114_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid returning null from a Task-returning method. + /// + internal static string VSTHRD114_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD114_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid returning a null Task. - /// - internal static string VSTHRD114_Title { - get { - return ResourceManager.GetString("VSTHRD114_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid returning a null Task. + /// + internal static string VSTHRD114_Title { + get { + return ResourceManager.GetString("VSTHRD114_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use "Async" suffix in names of methods that return an awaitable type. - /// - internal static string VSTHRD200_AddAsync_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD200_AddAsync_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Use "Async" suffix in names of methods that return an awaitable type. + /// + internal static string VSTHRD200_AddAsync_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD200_AddAsync_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Rename to {0}. - /// - internal static string VSTHRD200_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD200_CodeFix_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Rename to {0}. + /// + internal static string VSTHRD200_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD200_CodeFix_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Avoid "Async" suffix in names of methods that do not return an awaitable type. - /// - internal static string VSTHRD200_RemoveAsync_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD200_RemoveAsync_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Avoid "Async" suffix in names of methods that do not return an awaitable type. + /// + internal static string VSTHRD200_RemoveAsync_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD200_RemoveAsync_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Use "Async" suffix for async methods. - /// - internal static string VSTHRD200_Title { - get { - return ResourceManager.GetString("VSTHRD200_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Use "Async" suffix for async methods. + /// + internal static string VSTHRD200_Title { + get { + return ResourceManager.GetString("VSTHRD200_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Call ThrowIfCancellationRequested(). - /// - internal static string VSTHRD201_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD201_CodeFix_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Call ThrowIfCancellationRequested(). + /// + internal static string VSTHRD201_CodeFix_Title { + get { + return ResourceManager.GetString("VSTHRD201_CodeFix_Title", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Check for cancellation after calling SwitchToMainThreadAsync(CancellationToken).. - /// - internal static string VSTHRD201_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD201_MessageFormat", resourceCulture); + + /// + /// Looks up a localized string similar to Check for cancellation after calling SwitchToMainThreadAsync(CancellationToken).. + /// + internal static string VSTHRD201_MessageFormat { + get { + return ResourceManager.GetString("VSTHRD201_MessageFormat", resourceCulture); + } } - } - - /// - /// Looks up a localized string similar to Check cancellation after SwitchToMainThreadAsync. - /// - internal static string VSTHRD201_Title { - get { - return ResourceManager.GetString("VSTHRD201_Title", resourceCulture); + + /// + /// Looks up a localized string similar to Check cancellation after SwitchToMainThreadAsync. + /// + internal static string VSTHRD201_Title { + get { + return ResourceManager.GetString("VSTHRD201_Title", resourceCulture); + } } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.resx b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.resx index 236a96b45..40b76e27f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.resx +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.resx @@ -271,7 +271,7 @@ Start the work within this context, or use JoinableTaskFactory.RunAsync to start Do not translate either of these. The first is a keyword, the second is a method name. - Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method. + Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method Observe result of async calls diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index b09811dea..9e5c92b5e 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -2,8 +2,11 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; +using System.Collections.Concurrent; +using System.Collections.Generic; using System.Collections.Immutable; using System.Linq; +using System.Threading; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; @@ -47,60 +50,61 @@ public override void Initialize(AnalysisContext context) context.EnableConcurrentExecution(); context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterSymbolAction(Utils.DebuggableWrapper(new PerCompilation().AnalyzeNode), SymbolKind.Method); + context.RegisterCompilationStartAction(context => + { + CommonInterest.AwaitableTypeTester awaitableTypes = CommonInterest.CollectAwaitableTypes(context.Compilation, context.CancellationToken); + context.RegisterSymbolAction(Utils.DebuggableWrapper(context => this.AnalyzeNode(context, awaitableTypes)), SymbolKind.Method); + }); } - private class PerCompilation : DiagnosticAnalyzerState + private void AnalyzeNode(SymbolAnalysisContext context, CommonInterest.AwaitableTypeTester awaitableTypes) { - internal void AnalyzeNode(SymbolAnalysisContext context) + var methodSymbol = (IMethodSymbol)context.Symbol; + if (methodSymbol.AssociatedSymbol is IPropertySymbol) + { + // Skip accessor methods associated with properties. + return; + } + + // Skip entrypoint methods since their name is non-negotiable. + if (Utils.IsEntrypointMethod(methodSymbol, context.Compilation, context.CancellationToken)) { - var methodSymbol = (IMethodSymbol)context.Symbol; - if (methodSymbol.AssociatedSymbol is IPropertySymbol) + return; + } + + bool hasAsyncFocusedReturnType = Utils.HasAsyncCompatibleReturnType(methodSymbol); + + bool actuallyEndsWithAsync = methodSymbol.Name.EndsWith(MandatoryAsyncSuffix, StringComparison.CurrentCulture); + + if (hasAsyncFocusedReturnType != actuallyEndsWithAsync) + { + // Now that we have done the cheap checks to find that this method may deserve a diagnostic, + // Do deeper checks to skip over methods that implement API contracts that are controlled elsewhere. + if (methodSymbol.FindInterfacesImplemented().Any() || methodSymbol.IsOverride) { - // Skip accessor methods associated with properties. return; } - // Skip entrypoint methods since their name is non-negotiable. - if (Utils.IsEntrypointMethod(methodSymbol, context.Compilation, context.CancellationToken)) + if (hasAsyncFocusedReturnType) { - return; + // We actively encourage folks to use the Async keyword only for clearly async-focused types. + // Not just any awaitable, since some stray extension method shouldn't change the world for everyone. + ImmutableDictionary? properties = ImmutableDictionary.Empty + .Add(NewNameKey, methodSymbol.Name + MandatoryAsyncSuffix); + context.ReportDiagnostic(Diagnostic.Create( + AddAsyncDescriptor, + methodSymbol.Locations[0], + properties)); } - - bool hasAsyncFocusedReturnType = Utils.HasAsyncCompatibleReturnType(methodSymbol); - - bool actuallyEndsWithAsync = methodSymbol.Name.EndsWith(MandatoryAsyncSuffix, StringComparison.CurrentCulture); - - if (hasAsyncFocusedReturnType != actuallyEndsWithAsync) + else if (!awaitableTypes.IsAwaitableType(methodSymbol.ReturnType)) { - // Now that we have done the cheap checks to find that this method may deserve a diagnostic, - // Do deeper checks to skip over methods that implement API contracts that are controlled elsewhere. - if (methodSymbol.FindInterfacesImplemented().Any() || methodSymbol.IsOverride) - { - return; - } - - if (hasAsyncFocusedReturnType) - { - // We actively encourage folks to use the Async keyword only for clearly async-focused types. - // Not just any awaitable, since some stray extension method shouldn't change the world for everyone. - ImmutableDictionary? properties = ImmutableDictionary.Empty - .Add(NewNameKey, methodSymbol.Name + MandatoryAsyncSuffix); - context.ReportDiagnostic(Diagnostic.Create( - AddAsyncDescriptor, - methodSymbol.Locations[0], - properties)); - } - else if (!this.IsAwaitableType(methodSymbol.ReturnType, context.Compilation, context.CancellationToken)) - { - // Only warn about abusing the Async suffix if the return type is not awaitable. - ImmutableDictionary? properties = ImmutableDictionary.Empty - .Add(NewNameKey, methodSymbol.Name.Substring(0, methodSymbol.Name.Length - MandatoryAsyncSuffix.Length)); - context.ReportDiagnostic(Diagnostic.Create( - RemoveAsyncDescriptor, - methodSymbol.Locations[0], - properties)); - } + // Only warn about abusing the Async suffix if the return type is not awaitable. + ImmutableDictionary? properties = ImmutableDictionary.Empty + .Add(NewNameKey, methodSymbol.Name.Substring(0, methodSymbol.Name.Length - MandatoryAsyncSuffix.Length)); + context.ReportDiagnostic(Diagnostic.Create( + RemoveAsyncDescriptor, + methodSymbol.Locations[0], + properties)); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index a2b2d4120..7169b44df 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -1,7 +1,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; +using CSVerify = Microsoft.VisualStudio.Threading.Analyzers.Tests.CSharpCodeFixVerifier; +using VerifyVB = Microsoft.VisualStudio.Threading.Analyzers.Tests.VisualBasicCodeFixVerifier; public class VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests { @@ -14,15 +15,34 @@ public async Task SyncMethod_ProducesDiagnostic() class Test { void Foo() { - BarAsync(); + [|BarAsync()|]; } Task BarAsync() => null; } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 9, 8); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task SyncMethod_ProducesDiagnostic_VB() + { + var test = @" +Imports System.Threading.Tasks + +Class Test + Sub Foo + [|BarAsync()|] + End Sub + + Function BarAsync() As Task + Return Nothing + End Function +End Class +"; + + await VerifyVB.VerifyAnalyzerAsync(test); } [Fact] @@ -35,7 +55,7 @@ class Test { async Task Foo() { await Task.Run(delegate { - BarAsync(); + [|BarAsync()|]; }); } @@ -43,8 +63,7 @@ await Task.Run(delegate { } "; - DiagnosticResult expected = this.CreateDiagnostic(8, 13, 8); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -158,7 +177,7 @@ public async Task ContinueWith_ProducesDiagnostic() class Test { void Foo() { - BarAsync().ContinueWith(_ => { }); // ContinueWith returns the dropped task + [|BarAsync().ContinueWith(_ => { })|]; // ContinueWith returns the dropped task } Task BarAsync() => null; @@ -167,8 +186,7 @@ void OtherMethod(Task t) { } } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, 12); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -190,6 +208,26 @@ async Task FooAsync() await CSVerify.VerifyAnalyzerAsync(test); // CS4014 should already take care of this case. } + [Fact] + public async Task AsyncMethod_ProducesNoDiagnostic_VB() + { + var test = @" +Imports System.Threading.Tasks + +Class Test + Async Function Foo() As Task + BarAsync() + End Function + + Function BarAsync() As Task + Return Nothing + End Function +End Class +"; + + await VerifyVB.VerifyAnalyzerAsync(test); // CS4014 should already take care of this case. + } + [Fact] public async Task CallToNonExistentMethod() { @@ -218,15 +256,14 @@ public async Task ConfigureAwait_ProducesDiagnostics() class Test { void Foo() { - BarAsync().ConfigureAwait(false); + [|BarAsync().ConfigureAwait(false)|]; } Task BarAsync() => Task.CompletedTask; } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -238,15 +275,14 @@ public async Task ConfigureAwaitGenerics_ProducesDiagnostics() class Test { void Foo() { - BarAsync().ConfigureAwait(false); + [|BarAsync().ConfigureAwait(false)|]; } Task BarAsync() => Task.FromResult(0); } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -259,7 +295,7 @@ public async Task CustomAwaitable_ProducesDiagnostics() class Test { void Foo() { - BarAsync(); + [|BarAsync()|]; } CustomTask BarAsync() => new CustomTask(); @@ -283,8 +319,7 @@ public void GetResult() } } "; - DiagnosticResult expected = this.CreateDiagnostic(8, 9, 8); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -327,15 +362,14 @@ public async Task SyncMethodWithValueTask_ProducesDiagnostic() class Test { void Foo() { - BarAsync(); + [|BarAsync()|]; } ValueTask BarAsync() => default; } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 9, 8); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -347,15 +381,14 @@ public async Task ConfigureAwaitValueTask_ProducesDiagnostics() class Test { void Foo() { - BarAsync().ConfigureAwait(false); + [|BarAsync().ConfigureAwait(false)|]; } ValueTask BarAsync() => default; } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 20, nameof(Task.ConfigureAwait).Length); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -367,15 +400,14 @@ public async Task ConditionalAccess_ProducesDiagnostic() class Test { void Foo(Test? tester) { - tester?.BarAsync(); + tester?[|.BarAsync()|]; } Task BarAsync() => null; } "; - DiagnosticResult expected = this.CreateDiagnostic(7, 17, 8); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -408,7 +440,7 @@ public class Test : IAsyncDisposable { ~Test() { - Task.[|Run|](async () => await DisposeAsync().ConfigureAwait(false)); + [|Task.Run(async () => await DisposeAsync().ConfigureAwait(false))|]; } public async ValueTask DisposeAsync() From a24d8a1e51e439376edc8cf3753f4460c2044204 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 15 Dec 2022 09:05:55 -0700 Subject: [PATCH 0644/1753] Drop netcoreapp3.1 targeting Also update the .NET SDK to 7.0.101 --- .devcontainer/Dockerfile | 3 ++- global.json | 2 +- test/Library.Tests/CalculatorTests.cs | 2 +- test/Library.Tests/Library.Tests.csproj | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 5c1bdc7ab..7ffd07efb 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,4 +1,5 @@ -FROM mcr.microsoft.com/dotnet/sdk:6.0.401-focal +# Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions +FROM mcr.microsoft.com/dotnet/sdk:7.0.101-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index e5187f36c..cc08211e2 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.100", + "version": "7.0.101", "rollForward": "patch", "allowPrerelease": false } diff --git a/test/Library.Tests/CalculatorTests.cs b/test/Library.Tests/CalculatorTests.cs index 042e7d940..0e7e83391 100644 --- a/test/Library.Tests/CalculatorTests.cs +++ b/test/Library.Tests/CalculatorTests.cs @@ -14,7 +14,7 @@ public CalculatorTests() public void AddOrSubtract() { // This tests aggregation of code coverage across test runs. -#if NETCOREAPP3_1 +#if NET6_0_OR_GREATER Assert.Equal(3, Calculator.Add(1, 2)); #else Assert.Equal(-1, Calculator.Subtract(1, 2)); diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 2eb4afe1e..d557e4c72 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -1,7 +1,7 @@ - net6.0;netcoreapp3.1;net472 + net6.0;net472 From 2da647834cdc78b9399967a813a4d2ef6461c437 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 15 Dec 2022 09:22:45 -0700 Subject: [PATCH 0645/1753] Multitarget the library .NET Standard 2.0 is still relevant because it's the last TFM that works on all .NET runtimes. But it's also very old, depriving the developer of the nullable ref annotations that are in later versions of .NET that can help reduce bugs. There are also newer APIs that can be *automatically* consumed by the compiler based on newer TFMs even without using `#if` in your code that can improve runtime performance of the code. --- src/Library/Library.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index a7547da10..b6b926ab7 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,6 +1,6 @@ - netstandard2.0 + net6.0;netstandard2.0 README.md From dfd69e0a9d0062a445e6bd4c2c0131d41f588a77 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 15 Dec 2022 09:26:42 -0700 Subject: [PATCH 0646/1753] Avoid System.Net.Http compile error when targeting net472 --- Directory.Build.targets | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Directory.Build.targets b/Directory.Build.targets index 65a15bfc8..cbe19ca0e 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -4,5 +4,10 @@ false + + + + + From 8121dad9b92d083ef3500956182a84f4674ea2b4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 15 Dec 2022 09:48:06 -0700 Subject: [PATCH 0647/1753] Drop obsolete WPF workarounds --- Directory.Build.props | 8 -------- Directory.Build.targets | 2 -- 2 files changed, 10 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index e78128b9b..7980f5280 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -62,23 +62,15 @@ - <_WpfTempProjectNuGetFilePathNoExt>$(BaseIntermediateOutputPath)..\$(_TargetAssemblyProjectName)\$(_TargetAssemblyProjectName)$(MSBuildProjectExtension).nuget.g - false false false false - - - diff --git a/Directory.Build.targets b/Directory.Build.targets index cbe19ca0e..ea7b6e6f8 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -8,6 +8,4 @@ - - From 435bda683b3d32c46261684af3c5291e81ed5acd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 15 Dec 2022 09:03:17 -0700 Subject: [PATCH 0648/1753] Add emoticons to github workflows --- .github/workflows/build.yml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a56a6dda2..7718f84ad 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -30,7 +30,7 @@ jobs: - uses: actions/checkout@v2 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: Install prerequisites + - name: ⚙ Install prerequisites run: | ./init.ps1 -UpgradePrerequisites dotnet --info @@ -40,75 +40,75 @@ jobs: mono --version } shell: pwsh - - name: Set pipeline variables based on source + - name: ⚙️ Set pipeline variables based on source run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - - name: build + - name: 🛠 build run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - - name: test + - name: 🧪 test run: azure-pipelines/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} shell: pwsh - - name: Update pipeline variables based on build outputs + - name: ⚙ Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - - name: Collect artifacts + - name: 📥 Collect artifacts run: azure-pipelines/artifacts/_stage_all.ps1 shell: pwsh if: always() - - name: Upload project.assets.json files + - name: 📢 Upload project.assets.json files if: always() uses: actions/upload-artifact@v1 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - - name: Upload variables + - name: 📢 Upload variables uses: actions/upload-artifact@v1 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - - name: Upload build_logs + - name: 📢 Upload build_logs if: always() uses: actions/upload-artifact@v1 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - - name: Upload test_logs + - name: 📢 Upload test_logs if: always() uses: actions/upload-artifact@v1 with: name: test_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/test_logs continue-on-error: true - - name: Upload testResults + - name: 📢 Upload testResults if: always() uses: actions/upload-artifact@v1 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - - name: Upload coverageResults + - name: 📢 Upload coverageResults if: always() uses: actions/upload-artifact@v1 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - - name: Upload symbols + - name: 📢 Upload symbols uses: actions/upload-artifact@v1 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - - name: Upload deployables + - name: 📢 Upload deployables uses: actions/upload-artifact@v1 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables if: always() - - name: Publish code coverage results to codecov.io + - name: 📢 Publish code coverage results to codecov.io run: ./azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}Host,${{ env.BUILDCONFIGURATION }}" shell: pwsh timeout-minutes: 3 From 13d0d88272f1d8fd8c92c7aaee54c3df3d7ef0c6 Mon Sep 17 00:00:00 2001 From: Ryan Toth Date: Thu, 15 Dec 2022 10:33:53 -0800 Subject: [PATCH 0649/1753] Version Stabilization: Update version.json to 17.5 --- version.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.json b/version.json index b249956a2..c87cb25f2 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.5-alpha", + "version": "17.5", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} \ No newline at end of file +} From 2107c6a84526544f8c00f4f86bc6390f234a4036 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 17 Dec 2022 16:40:56 -0700 Subject: [PATCH 0650/1753] Bump C# language version to 11 Just use `latest` so it'll be whatever the SDK version permits. Dropping the property altogether would use the formally recommended version for the TFM, which is less desirable. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 7980f5280..d722f5e49 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -5,7 +5,7 @@ $(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - 10.0 + latest enable enable latest From 7e26321035767c832e5205ad71be7e666b4d8d2a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 17 Dec 2022 17:14:19 -0700 Subject: [PATCH 0651/1753] Bump Microsoft.NET.Test.Sdk to 17.4.1 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index f19a9842e..9ec9d10c9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ - + From 75cdbdd12dccd1fc93715ee91f3910ee8810219c Mon Sep 17 00:00:00 2001 From: CSIGS Date: Mon, 19 Dec 2022 13:20:56 +0000 Subject: [PATCH 0652/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20221219132054778. --- .../CHS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../CHT/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../CSY/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 5 ++++- .../DEU/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../ESN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 5 ++++- .../FRA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../ITA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../JPN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../KOR/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../PLK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../PTB/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../RUS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- .../TRK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl | 7 +++++-- 13 files changed, 63 insertions(+), 24 deletions(-) diff --git a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index d29692d15..f94f0a725 100644 --- a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index 4b94fba62..3e1ee8bea 100644 --- a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index f9169a1d8..0eee65806 100644 --- a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + + + + diff --git a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index 030eeb5d4..e29547d82 100644 --- a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index 1296ec295..65eb09a18 100644 --- a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + + + + diff --git a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index 313a5d809..24e0b2e80 100644 --- a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index bfca7dddc..f8255ce7b 100644 --- a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index 883c12231..1d0526df7 100644 --- a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index d1f557eb9..d2ab48b3f 100644 --- a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index c1090d0a1..a5c918f2f 100644 --- a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index e14c91a49..d23ebe9dd 100644 --- a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index ce0eb6d48..4a82fbc98 100644 --- a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + diff --git a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl index 4fb573710..0dbbe62f4 100644 --- a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl +++ b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.Analyzers.dll.lcl @@ -432,10 +432,13 @@ - + - + + + + From 73ed0f8cc96286dc9a188662178e64e2aaf2ee73 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 3 Jan 2023 09:47:36 -0700 Subject: [PATCH 0653/1753] Bump Microsoft.CodeCoverage (#187) Bumps [Microsoft.CodeCoverage](https://github.com/microsoft/vstest) from 17.5.0-preview-20221201-06 to 17.5.0-release-20221220-01. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/commits) --- updated-dependencies: - dependency-name: Microsoft.CodeCoverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 9ec9d10c9..bfa98614d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From cf891c81e364b59c9cf2f9c1fdc1ad8cd370367f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Jan 2023 10:51:07 -0700 Subject: [PATCH 0654/1753] Add code coverage to test projects --- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 3 ++- .../Microsoft.VisualStudio.Threading.Tests.csproj | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 2be252d4d..19f9fe70a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -1,4 +1,4 @@ - + netcoreapp3.1;net6.0 true @@ -22,6 +22,7 @@ + diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 0545e87fb..d2ca7b0c1 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -31,6 +31,7 @@ + From aa84763e6d6a3f03941b01840a8784ae8525b83e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Jan 2023 10:54:50 -0700 Subject: [PATCH 0655/1753] Drop netcoreapp3.1 TFM This runtime version is no longer serviced by Microsoft, so no one should be using it. --- .../Microsoft.VisualStudio.Threading.csproj | 2 +- .../Helpers/ReferencesHelper.cs | 2 -- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 +- .../Microsoft.VisualStudio.Threading.Tests.csproj | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 8ceaf82ae..e92ec77b9 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -1,6 +1,6 @@  - netstandard2.0;netcoreapp3.1;net6.0;net472 + netstandard2.0;net6.0;net472 Async synchronization primitives, async collections, TPL and dataflow extensions. Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 2943dfbbe..0795f962c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -11,8 +11,6 @@ internal static class ReferencesHelper { #if NETFRAMEWORK public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetFramework.Net471.Default -#elif NETCOREAPP3_1 - public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetCore.NetCoreApp31 #elif NET6_0 public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.Net.Net60 #else diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index b9371b7c3..3095943c1 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -1,6 +1,6 @@  - netcoreapp3.1;net6.0 + net6.0 true true true diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 0545e87fb..1b992ffcd 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -1,6 +1,6 @@  - net6.0;netcoreapp3.1 + net6.0 true true From e7c3989245c9f48c63ad664761496317afad9fee Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 3 Jan 2023 11:59:09 -0700 Subject: [PATCH 0656/1753] Bump Microsoft.VisualStudio.Validation from 17.0.65 to 17.0.71 (#1134) Bumps [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) from 17.0.65 to 17.0.71. - [Release notes](https://github.com/microsoft/vs-validation/releases) - [Commits](https://github.com/microsoft/vs-validation/commits) --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Validation dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6e946e5f8..762e651ef 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -25,7 +25,7 @@ - + From 1d09284ec92f9a50dc84d7c15a009688a22c889d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Jan 2023 09:23:52 -0700 Subject: [PATCH 0657/1753] Switch code coverage from static to dynamic instrumentation --- azure-pipelines/test.runsettings | 2 -- 1 file changed, 2 deletions(-) diff --git a/azure-pipelines/test.runsettings b/azure-pipelines/test.runsettings index 975b71233..4e24a0a65 100644 --- a/azure-pipelines/test.runsettings +++ b/azure-pipelines/test.runsettings @@ -36,8 +36,6 @@ False True - True - False From 9b6da4bd15d3cdc81e564edcf3002b8d91d82918 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Jan 2023 10:29:22 -0700 Subject: [PATCH 0658/1753] Build 17.6-alpha --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index c87cb25f2..684628be0 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.5", + "version": "17.6-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 6ca4c8ee51e4da85adbebb221b663cce159a79df Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Jan 2023 10:30:25 -0700 Subject: [PATCH 0659/1753] Insert into rel/d17.5 --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..e9733ab8f 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.5' From 1f2c9c766cea2bf319b7587eefa762646e61270c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Jan 2023 12:47:03 -0700 Subject: [PATCH 0660/1753] Remove DllExport package reference --- .github/dependabot.yml | 1 - Directory.Packages.props | 1 - azure-pipelines/artifacts/deployables.ps1 | 2 +- azure-pipelines/dotnet.yml | 14 ++------------ src/SosThreadingTools/SosThreadingTools.csproj | 9 --------- src/SosThreadingTools/SosThreadingTools.targets | 2 +- 6 files changed, 4 insertions(+), 25 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f743dc361..5be11b36a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,4 +9,3 @@ updates: interval: monthly ignore: - dependency-name: Microsoft.CodeAnalysis* # We intentionally target older VS versions. - - dependency-name: DllExport # Later versions don't offer what we want. diff --git a/Directory.Packages.props b/Directory.Packages.props index e0b5ab829..5e1d671c7 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,6 @@ 1.1.1 - diff --git a/azure-pipelines/artifacts/deployables.ps1 b/azure-pipelines/artifacts/deployables.ps1 index 6d8330def..ee9f3ec8b 100644 --- a/azure-pipelines/artifacts/deployables.ps1 +++ b/azure-pipelines/artifacts/deployables.ps1 @@ -17,7 +17,7 @@ if (Test-Path $SosThreadingToolsRoot) { $ArchiveLayout = "$RepoRoot\obj\SosThreadingTools\ArchiveLayout" if (Test-Path $ArchiveLayout) { Remove-Item -Force $ArchiveLayout -Recurse } New-Item -Path $ArchiveLayout -ItemType Directory | Out-Null - Copy-Item -Force -Path "$SosThreadingToolsRoot" -Recurse -Exclude "DllExport.dll","*.xml" -Destination $ArchiveLayout + Copy-Item -Force -Path "$SosThreadingToolsRoot" -Recurse -Exclude "*.xml" -Destination $ArchiveLayout Rename-Item -Path $ArchiveLayout\net472 $ArchiveLayout\SosThreadingTools Get-ChildItem -Path $ArchiveLayout\symstore -Recurse | Remove-Item Compress-Archive -Force -Path $ArchiveLayout\SosThreadingTools -DestinationPath $ArchivePath diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 342b394c9..4b73d5d01 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -2,18 +2,8 @@ parameters: RunTests: steps: -# We use VSBuild instead of "dotnet build" on Windows because dllexport doesn't work on dotnet build. -- task: VSBuild@1 - displayName: 🛠️ Build Visual Studio solution - inputs: - msbuildArgs: /t:build,pack /m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog" - platform: Any CPU - configuration: $(BuildConfiguration) - condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - -- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /p:Platform=NonWindows /v:m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" - displayName: 🛠 dotnet build & pack - condition: and(succeeded(), ne(variables['Agent.OS'], 'Windows_NT')) +- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" + displayName: 🛠 dotnet build - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults displayName: 🧪 dotnet test diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 7d45b6cb1..1edad06c4 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -6,10 +6,6 @@ $(MSBuildProjectName) true - false - - - false A WinDBG extension that contains the !DumpAsync command for .NET Framework processes. @@ -22,14 +18,9 @@ false - - - - - diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index de0dcec75..1a19dbb76 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -31,7 +31,7 @@ - + From 7f6fd59154c65c0f89d91788394387fe51f1bacf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 4 Jan 2023 13:58:45 -0700 Subject: [PATCH 0661/1753] Use DNNE for our exporting native functions --- Directory.Packages.props | 1 + src/SosThreadingTools/Commands.cs | 17 +++++++------ src/SosThreadingTools/DebuggerContext.cs | 24 ------------------- src/SosThreadingTools/DumpAsyncCommand.cs | 3 +-- src/SosThreadingTools/ExtensionContext.cs | 24 ++++--------------- .../SosThreadingTools.csproj | 12 ++++++++-- .../SosThreadingTools.targets | 4 ++-- 7 files changed, 27 insertions(+), 58 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 5e1d671c7..e8f24eb02 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,6 +10,7 @@ 1.1.1 + diff --git a/src/SosThreadingTools/Commands.cs b/src/SosThreadingTools/Commands.cs index b894551b0..f8c9dd619 100644 --- a/src/SosThreadingTools/Commands.cs +++ b/src/SosThreadingTools/Commands.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.Runtime.CompilerServices; using System.Runtime.InteropServices; namespace CpsDbg; @@ -13,19 +14,19 @@ internal static class Commands private static readonly Dictionary CommandHandlers = new Dictionary(StringComparer.OrdinalIgnoreCase) { - { "dumpasync", new DumpAsyncCommand() }, + { DumpAsyncCommand, new DumpAsyncCommand() }, }; - [DllExport(DumpAsyncCommand, CallingConvention.StdCall)] - internal static void DumpAsync(IntPtr client, [MarshalAs(UnmanagedType.LPStr)] string args) + [UnmanagedCallersOnly(EntryPoint = DumpAsyncCommand, CallConvs = new[] { typeof(CallConvStdcall) })] + public static unsafe void DumpAsync(IntPtr client, byte* pstrArgs) { + string? args = Marshal.PtrToStringUTF8((nint)pstrArgs); ExecuteCommand(client, DumpAsyncCommand, args); } - private static void ExecuteCommand(IntPtr client, string command, [MarshalAs(UnmanagedType.LPStr)] string args) + private static void ExecuteCommand(IntPtr client, string command, string? args) { - ICommandHandler handler; - if (!CommandHandlers.TryGetValue(command, out handler)) + if (!CommandHandlers.TryGetValue(command, out ICommandHandler? handler)) { return; } @@ -38,11 +39,9 @@ private static void ExecuteCommand(IntPtr client, string command, [MarshalAs(Unm try { - handler.Execute(context, args); + handler.Execute(context, args!); } -#pragma warning disable CA1031 // Do not catch general exception types catch (Exception ex) -#pragma warning restore CA1031 // Do not catch general exception types { context.Output.WriteLine($"Encountered an unhandled exception running '{command}':"); context.Output.WriteLine(ex.ToString()); diff --git a/src/SosThreadingTools/DebuggerContext.cs b/src/SosThreadingTools/DebuggerContext.cs index 85cadcd04..ba16ec10b 100644 --- a/src/SosThreadingTools/DebuggerContext.cs +++ b/src/SosThreadingTools/DebuggerContext.cs @@ -22,11 +22,6 @@ internal class DebuggerContext /// private static DebuggerContext? instance; - static DebuggerContext() - { - AppDomain.CurrentDomain.AssemblyResolve += ResolveAssembly; - } - private DebuggerContext(IDebugClient debugClient, DataTarget dataTarget, ClrRuntime runtime, DebuggerOutput output) { this.DebugClient = debugClient; @@ -103,23 +98,4 @@ private DebuggerContext(IDebugClient debugClient, DataTarget dataTarget, ClrRunt return instance; } - - private static Assembly? ResolveAssembly(object sender, ResolveEventArgs args) - { - if (args.Name.Contains(ClrMD)) - { - string codebase = Assembly.GetExecutingAssembly().CodeBase; - - if (codebase.StartsWith("file://", StringComparison.OrdinalIgnoreCase)) - { - codebase = codebase.Substring(8).Replace('/', '\\'); - } - - string directory = Path.GetDirectoryName(codebase); - string path = Path.Combine(directory, ClrMD) + ".dll"; - return Assembly.LoadFile(path); - } - - return null; - } } diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index 606565a77..df6745d28 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -225,8 +225,7 @@ private static void ChainStateMachineBasedOnTaskContinuations(Dictionary - net472 + net7.0-windows win-x86;win-x64 true + true + true - $(MSBuildProjectName) + + false + + $(MSBuildProjectName) + $(MSBuildProjectName)Managed + $(MSBuildProjectName) true A WinDBG extension that contains the !DumpAsync command for .NET Framework processes. @@ -21,6 +28,7 @@ + diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index 1a19dbb76..2b36e2618 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -1,5 +1,5 @@ - + @@ -7,7 +7,6 @@ - @@ -30,6 +29,7 @@ + From c36559cdfe5273db85685f965919b7ee86452571 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 Jan 2023 13:44:09 -0700 Subject: [PATCH 0662/1753] Upgrade Microsoft.CodeCoverage --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index bfa98614d..1acbd174c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 3254ecb5486b68c9900ce3be23bc75d986df42ba Mon Sep 17 00:00:00 2001 From: Lee Culver Date: Thu, 5 Jan 2023 13:27:58 -0800 Subject: [PATCH 0663/1753] Update plugin to use NativeAOT - Update the dbgeng extension to use NativeAOT. - Update the dbgeng extension to use the new debugger plugin paradigm in the most recent ClrMD. --- src/SosThreadingTools/Commands.cs | 34 +--- src/SosThreadingTools/DebuggerContext.cs | 125 ------------- src/SosThreadingTools/DebuggerOutput.cs | 53 ------ src/SosThreadingTools/DumpAsyncCommand.cs | 166 ++++++++++-------- src/SosThreadingTools/ExtensionContext.cs | 28 +-- src/SosThreadingTools/ICommandHandler.cs | 2 +- src/SosThreadingTools/SOSLinkedCommand.cs | 50 ++++++ .../SosThreadingTools.csproj | 8 +- 8 files changed, 157 insertions(+), 309 deletions(-) delete mode 100644 src/SosThreadingTools/DebuggerContext.cs delete mode 100644 src/SosThreadingTools/DebuggerOutput.cs create mode 100644 src/SosThreadingTools/SOSLinkedCommand.cs diff --git a/src/SosThreadingTools/Commands.cs b/src/SosThreadingTools/Commands.cs index b894551b0..203787385 100644 --- a/src/SosThreadingTools/Commands.cs +++ b/src/SosThreadingTools/Commands.cs @@ -2,7 +2,7 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Generic; +using System.Runtime.CompilerServices; using System.Runtime.InteropServices; namespace CpsDbg; @@ -11,41 +11,25 @@ internal static class Commands { private const string DumpAsyncCommand = "dumpasync"; - private static readonly Dictionary CommandHandlers = new Dictionary(StringComparer.OrdinalIgnoreCase) + [UnmanagedCallersOnly(EntryPoint = nameof(DumpAsyncCommand), CallConvs = new Type[] { typeof(CallConvStdcall) })] + internal static void DumpAsync(IntPtr client, nint args) { - { "dumpasync", new DumpAsyncCommand() }, - }; - - [DllExport(DumpAsyncCommand, CallingConvention.StdCall)] - internal static void DumpAsync(IntPtr client, [MarshalAs(UnmanagedType.LPStr)] string args) - { - ExecuteCommand(client, DumpAsyncCommand, args); + ExecuteCommand(new DumpAsyncCommand(client), args); } - private static void ExecuteCommand(IntPtr client, string command, [MarshalAs(UnmanagedType.LPStr)] string args) + private static void ExecuteCommand(ICommandHandler command, nint args) { - ICommandHandler handler; - if (!CommandHandlers.TryGetValue(command, out handler)) - { - return; - } - - DebuggerContext? context = DebuggerContext.GetDebuggerContext(client); - if (context is null) - { - return; - } - try { - handler.Execute(context, args); + string? strArgs = Marshal.PtrToStringAnsi(args); + command.Execute(strArgs ?? ""); } #pragma warning disable CA1031 // Do not catch general exception types catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types { - context.Output.WriteLine($"Encountered an unhandled exception running '{command}':"); - context.Output.WriteLine(ex.ToString()); + Console.WriteLine($"Encountered an unhandled exception running '{command}':"); + Console.WriteLine(ex.ToString()); } } } diff --git a/src/SosThreadingTools/DebuggerContext.cs b/src/SosThreadingTools/DebuggerContext.cs deleted file mode 100644 index 85cadcd04..000000000 --- a/src/SosThreadingTools/DebuggerContext.cs +++ /dev/null @@ -1,125 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using System; -using System.Diagnostics; -using System.Globalization; -using System.IO; -using System.Linq; -using System.Reflection; -using System.Runtime.InteropServices; -using Microsoft.Diagnostics.Runtime; -using Microsoft.Diagnostics.Runtime.Interop; - -namespace CpsDbg; - -internal class DebuggerContext -{ - private const string ClrMD = "Microsoft.Diagnostics.Runtime"; - - /// - /// The singleton instance used in a debug session. - /// - private static DebuggerContext? instance; - - static DebuggerContext() - { - AppDomain.CurrentDomain.AssemblyResolve += ResolveAssembly; - } - - private DebuggerContext(IDebugClient debugClient, DataTarget dataTarget, ClrRuntime runtime, DebuggerOutput output) - { - this.DebugClient = debugClient; - this.DataTarget = dataTarget; - this.Runtime = runtime; - this.Output = output; - } - - internal ClrRuntime Runtime { get; } - - internal DebuggerOutput Output { get; } - - internal IDebugClient DebugClient { get; } - - internal IDebugControl DebugControl => (IDebugControl)this.DebugClient; - - private DataTarget DataTarget { get; } - - internal static DebuggerContext? GetDebuggerContext(IntPtr ptrClient) - { - // On our first call to the API: - // 1. Store a copy of IDebugClient in DebugClient. - // 2. Replace Console's output stream to be the debugger window. - // 3. Create an instance of DataTarget using the IDebugClient. - if (instance is null) - { - object client = Marshal.GetUniqueObjectForIUnknown(ptrClient); - var debugClient = (IDebugClient)client; - - var output = new DebuggerOutput(debugClient); - -#pragma warning disable CA2000 // Dispose objects before losing scope - var dataTarget = DataTarget.CreateFromDbgEng(ptrClient); -#pragma warning restore CA2000 // Dispose objects before losing scope - - ClrRuntime? runtime = null; - - // If our ClrRuntime instance is null, it means that this is our first call, or - // that the dac wasn't loaded on any previous call. Find the dac loaded in the - // process (the user must use .cordll), then construct our runtime from it. - - // Just find a module named mscordacwks and assume it's the one the user - // loaded into windbg. - Process p = Process.GetCurrentProcess(); - foreach (ProcessModule module in p.Modules) - { - if (module.FileName.ToUpperInvariant().Contains("MSCORDACWKS")) - { - // TODO: This does not support side-by-side CLRs. - runtime = dataTarget.ClrVersions.Single().CreateRuntime(module.FileName); - break; - } - } - - // Otherwise, the user didn't run .cordll. - if (runtime is null) - { - output.WriteLine("Mscordacwks.dll not loaded into the debugger."); - output.WriteLine("Run .cordll to load the dac before running this command."); - } - - if (runtime is object) - { - instance = new DebuggerContext(debugClient, dataTarget, runtime, output); - } - } - else - { - // If we already had a runtime, flush it for this use. This is ONLY required - // for a live process or iDNA trace. If you use the IDebug* apis to detect - // that we are debugging a crash dump you may skip this call for better perf. - // instance.Runtime.Flush(); - } - - return instance; - } - - private static Assembly? ResolveAssembly(object sender, ResolveEventArgs args) - { - if (args.Name.Contains(ClrMD)) - { - string codebase = Assembly.GetExecutingAssembly().CodeBase; - - if (codebase.StartsWith("file://", StringComparison.OrdinalIgnoreCase)) - { - codebase = codebase.Substring(8).Replace('/', '\\'); - } - - string directory = Path.GetDirectoryName(codebase); - string path = Path.Combine(directory, ClrMD) + ".dll"; - return Assembly.LoadFile(path); - } - - return null; - } -} diff --git a/src/SosThreadingTools/DebuggerOutput.cs b/src/SosThreadingTools/DebuggerOutput.cs deleted file mode 100644 index bfa0c1dbd..000000000 --- a/src/SosThreadingTools/DebuggerOutput.cs +++ /dev/null @@ -1,53 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using Microsoft.Diagnostics.Runtime.Interop; - -namespace CpsDbg; - -internal class DebuggerOutput -{ - private IDebugClient client; - private IDebugControl control; - - internal DebuggerOutput(IDebugClient client) - { - this.client = client; - this.control = (IDebugControl)client; - } - - internal void WriteString(string message) - { - this.control.ControlledOutput(DEBUG_OUTCTL.ALL_CLIENTS, DEBUG_OUTPUT.NORMAL, message); - } - - internal void WriteLine(string message) - { - this.WriteString(message + "\n"); - } - - internal void WriteObjectAddress(ulong address) - { - this.WriteDml($"{address:x8}"); - } - - internal void WriteThreadLink(uint threadId) - { - this.WriteDml($"Thread TID:[{threadId:x}]"); - } - - internal void WriteMethodInfo(string name, ulong address) - { - this.WriteDml($"{name}"); - } - - internal void WriteStringWithLink(string message, string linkCommand) - { - this.WriteDml($"{message}"); - } - - private void WriteDml(string dml) - { - this.control.ControlledOutput(DEBUG_OUTCTL.AMBIENT_DML, DEBUG_OUTPUT.NORMAL, dml); - } -} diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index 606565a77..50d3e43fb 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -5,32 +5,41 @@ using System.Collections.Generic; using System.Linq; using Microsoft.Diagnostics.Runtime; -using Microsoft.Diagnostics.Runtime.Interop; +using Microsoft.Diagnostics.Runtime.Utilities.DbgEng; namespace CpsDbg; -internal class DumpAsyncCommand : ICommandHandler +internal class DumpAsyncCommand : SOSLinkedCommand, ICommandHandler { - public void Execute(DebuggerContext context, string args) + internal DumpAsyncCommand(nint pUnknown) + : base(pUnknown, redirectConsoleOutput: true) { - ClrHeap heap = context.Runtime.Heap; + } + + public void Execute(string args) + { + // There can be multiple CLR runtimes loaded into + foreach (ClrRuntime runtime in this.Runtimes) + { + ClrHeap heap = runtime.Heap; - var allStateMachines = new List(); - var knownStateMachines = new Dictionary(); + var allStateMachines = new List(); + var knownStateMachines = new Dictionary(); - GetAllStateMachines(context, heap, allStateMachines, knownStateMachines); + GetAllStateMachines(heap, allStateMachines, knownStateMachines); - ChainStateMachinesBasedOnTaskContinuations(context, knownStateMachines); - ChainStateMachinesBasedOnJointableTasks(context, allStateMachines); - MarkThreadingBlockTasks(context, allStateMachines); - MarkUIThreadDependingTasks(allStateMachines); - FixBrokenDependencies(allStateMachines); + ChainStateMachinesBasedOnTaskContinuations(knownStateMachines); + ChainStateMachinesBasedOnJointableTasks(allStateMachines); + this.MarkThreadingBlockTasks(allStateMachines); + MarkUIThreadDependingTasks(allStateMachines); + FixBrokenDependencies(allStateMachines); - PrintOutStateMachines(allStateMachines, context.Output); - LoadCodePages(context, allStateMachines); + this.PrintOutStateMachines(allStateMachines); + this.LoadCodePages(allStateMachines); + } } - private static void GetAllStateMachines(DebuggerContext context, ClrHeap heap, List allStateMachines, Dictionary knownStateMachines) + private static void GetAllStateMachines(ClrHeap heap, List allStateMachines, Dictionary knownStateMachines) { foreach (ClrObject obj in heap.GetObjectsOfType("System.Runtime.CompilerServices.AsyncMethodBuilderCore+MoveNextRunner")) { @@ -156,7 +165,7 @@ private static void GetAllStateMachines(DebuggerContext context, ClrHeap heap, L catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types { - context.Output.WriteLine($"Fail to process state machine {stateMachine.Address:x} Type:'{stateMachine.Type?.Name}' Module:'{stateMachine.Type?.Module?.Name}' Error: {ex.Message}"); + Console.WriteLine($"Fail to process state machine {stateMachine.Address:x} Type:'{stateMachine.Type?.Name}' Module:'{stateMachine.Type?.Module?.Name}' Error: {ex.Message}"); } } } @@ -164,12 +173,12 @@ private static void GetAllStateMachines(DebuggerContext context, ClrHeap heap, L catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types { - context.Output.WriteLine($"Fail to process AsyncStateMachine Runner {obj.Address:x} Error: {ex.Message}"); + Console.WriteLine($"Fail to process AsyncStateMachine Runner {obj.Address:x} Error: {ex.Message}"); } } } - private static void ChainStateMachinesBasedOnTaskContinuations(DebuggerContext context, Dictionary knownStateMachines) + private static void ChainStateMachinesBasedOnTaskContinuations(Dictionary knownStateMachines) { foreach (AsyncStateMachine? stateMachine in knownStateMachines.Values) { @@ -197,7 +206,7 @@ private static void ChainStateMachinesBasedOnTaskContinuations(DebuggerContext c catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types { - context.Output.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); + Console.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); } } } @@ -263,7 +272,7 @@ private static void ChainStateMachineBasedOnTaskContinuations(Dictionary allStateMachines) + private static void ChainStateMachinesBasedOnJointableTasks(List allStateMachines) { foreach (AsyncStateMachine? stateMachine in allStateMachines) { @@ -289,50 +298,53 @@ private static void ChainStateMachinesBasedOnJointableTasks(DebuggerContext cont catch (Exception ex) #pragma warning restore CA1031 // Do not catch general exception types { - context.Output.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); + Console.WriteLine($"Fail to fix continuation of state {stateMachine.StateMachine.Address:x} Error: {ex.Message}"); } } } } - private static void MarkThreadingBlockTasks(DebuggerContext context, List allStateMachines) + private void MarkThreadingBlockTasks(List allStateMachines) { - foreach (ClrThread? thread in context.Runtime.Threads) + foreach (ClrRuntime runtime in this.Runtimes) { - ClrStackFrame? stackFrame = thread.EnumerateStackTrace().Take(50).FirstOrDefault( - f => f.Method is { } method - && string.Equals(f.Method.Name, "CompleteOnCurrentThread", StringComparison.Ordinal) - && string.Equals(f.Method.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)); - - if (stackFrame is object) + foreach (ClrThread? thread in runtime.Threads) { - var visitedObjects = new HashSet(); - foreach (IClrStackRoot stackRoot in thread.EnumerateStackRoots()) + ClrStackFrame? stackFrame = thread.EnumerateStackTrace().Take(50).FirstOrDefault( + f => f.Method is { } method + && string.Equals(f.Method.Name, "CompleteOnCurrentThread", StringComparison.Ordinal) + && string.Equals(f.Method.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)); + + if (stackFrame is object) { - ClrObject stackObject = stackRoot.Object; - if (string.Equals(stackObject.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || - string.Equals(stackObject.Type?.BaseType?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)) + var visitedObjects = new HashSet(); + foreach (IClrStackRoot stackRoot in thread.EnumerateStackRoots()) { - if (visitedObjects.Add(stackObject.Address)) + ClrObject stackObject = stackRoot.Object; + if (string.Equals(stackObject.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || + string.Equals(stackObject.Type?.BaseType?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)) { - var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); - int state = joinableTaskObject.ReadField("state"); - if ((state & 0x10) == 0x10) + if (visitedObjects.Add(stackObject.Address)) { - // This flag indicates the JTF is blocking the thread - ClrObject wrappedTask = joinableTaskObject.TryGetObjectField("wrappedTask"); - if (!wrappedTask.IsNull) + var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); + int state = joinableTaskObject.ReadField("state"); + if ((state & 0x10) == 0x10) { - AsyncStateMachine? blockingStateMachine = allStateMachines - .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); - if (blockingStateMachine is object) + // This flag indicates the JTF is blocking the thread + ClrObject wrappedTask = joinableTaskObject.TryGetObjectField("wrappedTask"); + if (!wrappedTask.IsNull) { - blockingStateMachine.BlockedThread = thread.OSThreadId; - blockingStateMachine.BlockedJoinableTask = joinableTaskObject; + AsyncStateMachine? blockingStateMachine = allStateMachines + .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); + if (blockingStateMachine is object) + { + blockingStateMachine.BlockedThread = thread.OSThreadId; + blockingStateMachine.BlockedJoinableTask = joinableTaskObject; + } } - } - break; + break; + } } } } @@ -381,7 +393,7 @@ private static void FixBrokenDependencies(List allStateMachin } } - private static void PrintOutStateMachines(List allStateMachines, DebuggerOutput output) + private void PrintOutStateMachines(List allStateMachines) { int loopMark = -1; foreach (AsyncStateMachine? stateMachine in allStateMachines) @@ -419,30 +431,30 @@ private static void PrintOutStateMachines(List allStateMachin .OrderByDescending(m => m.Depth) .ThenByDescending(m => m.SwitchToMainThreadTask.Address)) { - bool multipleLineBlock = PrintAsyncStateMachineChain(output, node, printedMachines); + bool multipleLineBlock = this.PrintAsyncStateMachineChain(node, printedMachines); if (multipleLineBlock) { - output.WriteLine(string.Empty); + Console.WriteLine(string.Empty); } } // Print nodes which we didn't print because of loops. if (allStateMachines.Count > printedMachines.Count) { - output.WriteLine("States form dependencies loop -- could be an error caused by the analysis tool"); + Console.WriteLine("States form dependencies loop -- could be an error caused by the analysis tool"); foreach (AsyncStateMachine? node in allStateMachines) { if (!printedMachines.Contains(node)) { - PrintAsyncStateMachineChain(output, node, printedMachines); - output.WriteLine(string.Empty); + this.PrintAsyncStateMachineChain(node, printedMachines); + Console.WriteLine(string.Empty); } } } } - private static bool PrintAsyncStateMachineChain(DebuggerOutput output, AsyncStateMachine node, HashSet printedMachines) + private bool PrintAsyncStateMachineChain(AsyncStateMachine node, HashSet printedMachines) { int nLevel = 0; bool multipleLineBlock = false; @@ -454,53 +466,53 @@ private static bool PrintAsyncStateMachineChain(DebuggerOutput output, AsyncStat if (nLevel > 0) { - output.WriteString(".."); + this.WriteString(".."); multipleLineBlock = true; } else if (p.AlterPrevious is object) { - output.WriteObjectAddress(p.AlterPrevious.StateMachine.Address); - output.WriteString($" <{p.AlterPrevious.State}> * {p.AlterPrevious.StateMachine.Type?.Name} @ "); - output.WriteMethodInfo($"{p.AlterPrevious.CodeAddress:x}", p.AlterPrevious.CodeAddress); - output.WriteLine(string.Empty); - output.WriteString(".."); + this.WriteObjectAddress(p.AlterPrevious.StateMachine.Address); + this.WriteString($" <{p.AlterPrevious.State}> * {p.AlterPrevious.StateMachine.Type?.Name} @ "); + this.WriteMethodInfo($"{p.AlterPrevious.CodeAddress:x}", p.AlterPrevious.CodeAddress); + this.WriteLine(string.Empty); + this.WriteString(".."); multipleLineBlock = true; } else if (!p.SwitchToMainThreadTask.IsNull) { - output.WriteObjectAddress(p.SwitchToMainThreadTask.Address); - output.WriteLine(".SwitchToMainThreadAsync"); - output.WriteString(".."); + this.WriteObjectAddress(p.SwitchToMainThreadTask.Address); + this.WriteLine(".SwitchToMainThreadAsync"); + this.WriteString(".."); multipleLineBlock = true; } - output.WriteObjectAddress(p.StateMachine.Address); + this.WriteObjectAddress(p.StateMachine.Address); string doubleDependentTaskMark = p.DependentCount > 1 ? " * " : " "; - output.WriteString($" <{p.State}>{doubleDependentTaskMark}{p.StateMachine.Type?.Name} @ "); - output.WriteMethodInfo($"{p.CodeAddress:x}", p.CodeAddress); - output.WriteLine(string.Empty); + this.WriteString($" <{p.State}>{doubleDependentTaskMark}{p.StateMachine.Type?.Name} @ "); + this.WriteMethodInfo($"{p.CodeAddress:x}", p.CodeAddress); + this.WriteLine(string.Empty); if (!loopDetection.Add(p)) { - output.WriteLine("!!Loop task dependencies"); + this.WriteLine("!!Loop task dependencies"); break; } if (p.Next is null && p.BlockedThread.HasValue) { - output.WriteString("-- "); - output.WriteThreadLink(p.BlockedThread.Value); - output.WriteString(" - JoinableTask: "); - output.WriteObjectAddress(p.BlockedJoinableTask.Address); + this.WriteString("-- "); + this.WriteThreadLink(p.BlockedThread.Value); + this.WriteString(" - JoinableTask: "); + this.WriteObjectAddress(p.BlockedJoinableTask.Address); int state = p.BlockedJoinableTask.ReadField("state"); if ((state & 0x20) == 0x20) { - output.WriteLine(" SynchronouslyBlockingMainThread"); + this.WriteLine(" SynchronouslyBlockingMainThread"); } else { - output.WriteLine(string.Empty); + this.WriteLine(string.Empty); } multipleLineBlock = true; @@ -512,7 +524,7 @@ private static bool PrintAsyncStateMachineChain(DebuggerOutput output, AsyncStat return multipleLineBlock; } - private static void LoadCodePages(DebuggerContext context, List allStateMachines) + private void LoadCodePages(List allStateMachines) { var loadedAddresses = new HashSet(); foreach (AsyncStateMachine? stateMachine in allStateMachines) @@ -520,7 +532,7 @@ private static void LoadCodePages(DebuggerContext context, List{address:x8}"); + } + + protected void WriteThreadLink(uint threadId) + { + this.WriteDml($"Thread TID:[{threadId:x}]"); + } + + protected void WriteMethodInfo(string name, ulong address) + { + this.WriteDml($"{name}"); + } + + protected void WriteStringWithLink(string message, string linkCommand) + { + this.WriteDml($"{message}"); + } + + protected void WriteDml(string dml) + { + this.DebugControl.ControlledOutput(DEBUG_OUTCTL.AMBIENT_DML, DEBUG_OUTPUT.NORMAL, dml); + } +} diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 7d45b6cb1..10677f98d 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -1,8 +1,9 @@  - net472 + net7.0-windows win-x86;win-x64 true + true $(MSBuildProjectName) true @@ -21,14 +22,11 @@ full false + True - - - - From 77e4b5106dd74aa25564ba0631212146184a1f2d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Jan 2023 09:30:23 -0700 Subject: [PATCH 0664/1753] Fix merge coverage error when output directory already exists --- azure-pipelines/Merge-CodeCoverage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 9fe925cf6..02ff12b00 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -41,7 +41,7 @@ if ($reports) { $Inputs = $reports |% { Resolve-Path -relative $_.FullName } - if (Split-Path $OutputFile) { + if ((Split-Path $OutputFile) -and -not (Test-Path (Split-Path $OutputFile))) { New-Item -Type Directory -Path (Split-Path $OutputFile) | Out-Null } From 1dcbcd75a2a8e9167806af0a110bd9a1a90e7178 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Jan 2023 10:46:32 -0700 Subject: [PATCH 0665/1753] Update package references to resolve compilation failure --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index e8f24eb02..215911679 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -21,8 +21,8 @@ - - + + From 46c24ccb9e9738804ddabcbc05f194161e8a779e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Jan 2023 10:59:10 -0700 Subject: [PATCH 0666/1753] Fix a pack break and a build warning --- src/SosThreadingTools/SosThreadingTools.csproj | 3 +++ src/SosThreadingTools/SosThreadingTools.targets | 1 - 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 2da1905f7..b79cc66d2 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -6,6 +6,9 @@ true true + + $(NoWarn);IL3053 + true A WinDBG extension that contains the !DumpAsync command for .NET Framework processes. diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index 2b36e2618..8fe701486 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -29,7 +29,6 @@ - From 477dd91ce96e2c6c2805a04d5f88113aaab7a0c7 Mon Sep 17 00:00:00 2001 From: Lee Culver Date: Fri, 6 Jan 2023 10:12:23 -0800 Subject: [PATCH 0667/1753] Allow for standalone debugging --- src/SosThreadingTools/DumpAsyncCommand.cs | 10 ++++- src/SosThreadingTools/SOSLinkedCommand.cs | 54 ++++++++++++++++++++--- 2 files changed, 56 insertions(+), 8 deletions(-) diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index 71375515e..9e047c960 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -11,8 +11,14 @@ namespace CpsDbg; internal class DumpAsyncCommand : SOSLinkedCommand, ICommandHandler { - internal DumpAsyncCommand(IntPtr pUnknown) - : base(pUnknown, redirectConsoleOutput: true) + internal DumpAsyncCommand(IntPtr pUnknown, bool isRunningAsExtension) + : base(pUnknown, isRunningAsExtension) + { + } + + + internal DumpAsyncCommand(IDisposable dbgEng, bool isRunningAsExtension = false) + : base(dbgEng, isRunningAsExtension) { } diff --git a/src/SosThreadingTools/SOSLinkedCommand.cs b/src/SosThreadingTools/SOSLinkedCommand.cs index fc9d4f654..f1d24c25d 100644 --- a/src/SosThreadingTools/SOSLinkedCommand.cs +++ b/src/SosThreadingTools/SOSLinkedCommand.cs @@ -1,6 +1,9 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; +using System.Net; +using System.Xml.Linq; using DbgEngExtension; using Microsoft.Diagnostics.Runtime.Utilities.DbgEng; @@ -8,11 +11,22 @@ namespace CpsDbg; internal class SOSLinkedCommand : DbgEngCommand { - protected SOSLinkedCommand(nint pUnknown, bool redirectConsoleOutput) - : base(pUnknown, redirectConsoleOutput) + private readonly bool isRunningAsExtension; + + protected SOSLinkedCommand(nint pUnknown, bool isRunningAsExtension) + : base(pUnknown, redirectConsoleOutput: isRunningAsExtension) + { + this.isRunningAsExtension = isRunningAsExtension; + } + + + protected SOSLinkedCommand(IDisposable dbgEng, bool isRunningAsExtension) + : base(dbgEng, redirectConsoleOutput: isRunningAsExtension) { + this.isRunningAsExtension = isRunningAsExtension; } + protected void WriteString(string message) { this.DebugControl.ControlledOutput(DEBUG_OUTCTL.ALL_CLIENTS, DEBUG_OUTPUT.NORMAL, message); @@ -25,22 +39,50 @@ protected void WriteLine(string message) protected void WriteObjectAddress(ulong address) { - this.WriteDml($"{address:x8}"); + if (this.isRunningAsExtension) + { + this.WriteDml($"{address:x8}"); + } + else + { + Console.WriteLine(address.ToString("x")); + } } protected void WriteThreadLink(uint threadId) { - this.WriteDml($"Thread TID:[{threadId:x}]"); + if (this.isRunningAsExtension) + { + this.WriteDml($"Thread TID:[{threadId:x}]"); + } + else + { + Console.WriteLine($"Thread TID:[{threadId:x}]"); + } } protected void WriteMethodInfo(string name, ulong address) { - this.WriteDml($"{name}"); + if (this.isRunningAsExtension) + { + this.WriteDml($"{name}"); + } + else + { + Console.WriteLine(name); + } } protected void WriteStringWithLink(string message, string linkCommand) { - this.WriteDml($"{message}"); + if (this.isRunningAsExtension) + { + this.WriteDml($"{message}"); + } + else + { + Console.WriteLine(message); + } } protected void WriteDml(string dml) From 62a2538112ddee19b30e33a0b0084dcf40cc828d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Jan 2023 11:33:02 -0700 Subject: [PATCH 0668/1753] Fix !dumpasync on x86 windbg processes --- src/SosThreadingTools/Commands.cs | 2 +- src/SosThreadingTools/ExtensionContext.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SosThreadingTools/Commands.cs b/src/SosThreadingTools/Commands.cs index f8c9dd619..68657b976 100644 --- a/src/SosThreadingTools/Commands.cs +++ b/src/SosThreadingTools/Commands.cs @@ -17,7 +17,7 @@ internal static class Commands { DumpAsyncCommand, new DumpAsyncCommand() }, }; - [UnmanagedCallersOnly(EntryPoint = DumpAsyncCommand, CallConvs = new[] { typeof(CallConvStdcall) })] + [UnmanagedCallersOnly(EntryPoint = DumpAsyncCommand, CallConvs = new[] { typeof(CallConvCdecl) })] public static unsafe void DumpAsync(IntPtr client, byte* pstrArgs) { string? args = Marshal.PtrToStringUTF8((nint)pstrArgs); diff --git a/src/SosThreadingTools/ExtensionContext.cs b/src/SosThreadingTools/ExtensionContext.cs index c49d237ce..d0da596eb 100644 --- a/src/SosThreadingTools/ExtensionContext.cs +++ b/src/SosThreadingTools/ExtensionContext.cs @@ -11,7 +11,7 @@ namespace CpsDbg; internal static class ExtensionContext { - [UnmanagedCallersOnly(CallConvs = new[] { typeof(CallConvStdcall) })] + [UnmanagedCallersOnly(CallConvs = new[] { typeof(CallConvCdecl) })] public static unsafe int DebugExtensionInitialize(uint* pVersion, uint* pFlags) { // Set the extension version to 1, which expects exports with this signature: From 3ed59ae20a1c27ce844f931a4cd87d12df1f3247 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Sep 2022 13:21:44 -0600 Subject: [PATCH 0669/1753] Switch to one public feed --- azure-pipelines/OptProf.yml | 2 -- azure-pipelines/official.yml | 3 --- nuget.config | 16 +--------------- 3 files changed, 1 insertion(+), 20 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index c623cf709..d3567d76e 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -33,8 +33,6 @@ variables: - name: SignType value: real - group: Library.Template -- name: NugetSecurityAnalysisWarningLevel - value: none # nuget.config requires signed packages by trusted owners stages: - stage: Library diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index ce4696ed6..50d4aa0b4 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -29,9 +29,6 @@ parameters: type: boolean default: false -variables: - NugetSecurityAnalysisWarningLevel: none # nuget.config requires signed packages by trusted owners - stages: - stage: Build diff --git a/nuget.config b/nuget.config index f0bfc47b8..0de1d856b 100644 --- a/nuget.config +++ b/nuget.config @@ -2,23 +2,9 @@ - - - - - + - - - Microsoft;xunit;manuel.roemer;sharwell;jamesnk;aarnott;MarcoRossignoli;Thecentury;clairernovotny;reg;mmanela - - - - - - - From c4828a78ed03517d2ed651a93281820da98177b7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Jan 2023 16:32:41 -0700 Subject: [PATCH 0670/1753] Switch back from AOT to DNNE This is because AOT doesn't support win-x86. --- Directory.Packages.props | 5 +++-- src/SosThreadingTools/Commands.cs | 4 ++-- src/SosThreadingTools/DumpAsyncCommand.cs | 1 - src/SosThreadingTools/ExtensionContext.cs | 2 +- src/SosThreadingTools/SOSLinkedCommand.cs | 2 -- src/SosThreadingTools/SosThreadingTools.csproj | 11 +++++++---- src/SosThreadingTools/SosThreadingTools.targets | 1 + 7 files changed, 14 insertions(+), 12 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 215911679..49b2c3728 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,6 +8,7 @@ 3.11.0 4.4.0 1.1.1 + 2.3.405501 @@ -21,8 +22,8 @@ - - + + diff --git a/src/SosThreadingTools/Commands.cs b/src/SosThreadingTools/Commands.cs index b72e64c13..2decbd170 100644 --- a/src/SosThreadingTools/Commands.cs +++ b/src/SosThreadingTools/Commands.cs @@ -10,9 +10,9 @@ namespace CpsDbg; internal static class Commands { [UnmanagedCallersOnly(EntryPoint = "dumpasync", CallConvs = new[] { typeof(CallConvStdcall) })] - private static unsafe void DumpAsync(IntPtr client, byte* args) + public static unsafe void DumpAsync(IntPtr client, byte* args) { - ExecuteCommand(new DumpAsyncCommand(client), args); + ExecuteCommand(new DumpAsyncCommand(client, isRunningAsExtension: true), args); } private static unsafe void ExecuteCommand(ICommandHandler command, byte* args) diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index 9e047c960..e4c2531e8 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -16,7 +16,6 @@ internal DumpAsyncCommand(IntPtr pUnknown, bool isRunningAsExtension) { } - internal DumpAsyncCommand(IDisposable dbgEng, bool isRunningAsExtension = false) : base(dbgEng, isRunningAsExtension) { diff --git a/src/SosThreadingTools/ExtensionContext.cs b/src/SosThreadingTools/ExtensionContext.cs index 6dc45878c..897d4f641 100644 --- a/src/SosThreadingTools/ExtensionContext.cs +++ b/src/SosThreadingTools/ExtensionContext.cs @@ -10,7 +10,7 @@ namespace CpsDbg; internal static class ExtensionContext { [UnmanagedCallersOnly(EntryPoint = nameof(DebugExtensionInitialize), CallConvs = new[] { typeof(CallConvStdcall) })] - private static unsafe int DebugExtensionInitialize(uint* pVersion, uint* pFlags) + public static unsafe int DebugExtensionInitialize(uint* pVersion, uint* pFlags) { // Set the extension version to 1, which expects exports with this signature: // void _stdcall function(IDebugClient *client, const char *args) diff --git a/src/SosThreadingTools/SOSLinkedCommand.cs b/src/SosThreadingTools/SOSLinkedCommand.cs index f1d24c25d..14d6a334e 100644 --- a/src/SosThreadingTools/SOSLinkedCommand.cs +++ b/src/SosThreadingTools/SOSLinkedCommand.cs @@ -19,14 +19,12 @@ protected SOSLinkedCommand(nint pUnknown, bool isRunningAsExtension) this.isRunningAsExtension = isRunningAsExtension; } - protected SOSLinkedCommand(IDisposable dbgEng, bool isRunningAsExtension) : base(dbgEng, redirectConsoleOutput: isRunningAsExtension) { this.isRunningAsExtension = isRunningAsExtension; } - protected void WriteString(string message) { this.DebugControl.ControlledOutput(DEBUG_OUTCTL.ALL_CLIENTS, DEBUG_OUTPUT.NORMAL, message); diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index b79cc66d2..d737ba515 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -3,12 +3,15 @@ net7.0-windows win-x86;win-x64 true + true true - true - - $(NoWarn);IL3053 + + false + $(MSBuildProjectName) + $(MSBuildProjectName)Managed + $(MSBuildProjectName) true A WinDBG extension that contains the !DumpAsync command for .NET Framework processes. @@ -23,8 +26,8 @@ false - + diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index 8fe701486..2b36e2618 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -29,6 +29,7 @@ + From 565cba8cae42aa2fa783f891e300bcbeaa769c7a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Jan 2023 18:34:11 -0700 Subject: [PATCH 0671/1753] A better way to fix the MSBuild RAR warnings (#1116) --- Directory.Packages.props | 10 +++++----- .../Microsoft.VisualStudio.Threading.csproj | 7 +++---- .../Microsoft.VisualStudio.Threading.Tests.csproj | 3 --- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 49b2c3728..b9d9333c0 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,18 +13,19 @@ + - + - - + + @@ -37,13 +38,12 @@ + - - diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index e92ec77b9..90241afe6 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -7,9 +7,6 @@ Threading Async Lock Synchronization Threadsafe true - - - $(NoWarn);MSB3277 $(TargetFrameworks);net6.0-windows @@ -54,7 +51,9 @@ - + diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 8191c761a..f1b47eebf 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -8,9 +8,6 @@ true $(DefineConstants);ISOLATED_TEST_SUPPORT - - - $(NoWarn);MSB3277 $(TargetFrameworks);net472;net6.0-windows From eb847be2bae977a110c44d683d43e253cea8ec8c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 13 Jan 2023 06:54:39 -0700 Subject: [PATCH 0672/1753] .gitignore .DS_Store --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 3bb499198..69599b879 100644 --- a/.gitignore +++ b/.gitignore @@ -349,3 +349,6 @@ MigrationBackup/ # dotnet tool local install directory .store/ + +# mac-created file to track user view preferences for a directory +.DS_Store From ef51aae8523a668e0a59bb231982b9d56f0f494c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 13 Jan 2023 08:49:21 -0700 Subject: [PATCH 0673/1753] Update AzureRepos package version --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 240095ed5..34bd522c9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -22,7 +22,7 @@ - + From 6c3e5ea0f32bfa74ebab3fc753b7f4a32220a25a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 13 Jan 2023 08:50:38 -0700 Subject: [PATCH 0674/1753] Use MSBuildTreatWarningsAsErrors on official microbuild too --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index ad1544c02..61cbb6315 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -46,7 +46,7 @@ stages: - stage: Build variables: - TreatWarningsAsErrors: true + MSBuildTreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages From 75e94355201ff3cd4e68048e4b7a5d51e47cda20 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 16 Jan 2023 12:58:33 -0800 Subject: [PATCH 0675/1753] Prevent sending ETW inside lock This code amplifies overhead of ETW tracing into thread pool issues, and increases noise in perf tests. --- .../AsyncReaderWriterLock.cs | 25 +++++++++++-------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index 4960f2b84..c69a7d71c 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -1067,6 +1067,8 @@ private void CheckSynchronizationContextAppropriateForLock(Awaiter? awaiter) [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendingWriteLockCheck = false) { + bool issued = false; + lock (this.syncObject) { if (this.completeInvoked && !previouslyQueued) @@ -1079,7 +1081,6 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi } } - bool issued = false; if (this.reenterConcurrencyPrepRunning is null) { if (this.issuedWriteLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedReadLocks.Count == 0) @@ -1166,20 +1167,24 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi if (issued) { this.GetActiveLockSet(awaiter.Kind).Add(awaiter); - this.etw.Issued(awaiter); } + } - if (!issued) - { - this.etw.WaitStart(awaiter); + if (issued) + { + this.etw.Issued(awaiter); + } - // If the lock is immediately available, we don't need to coordinate with other threads. - // But if it is NOT available, we'd have to wait potentially for other threads to do more work. - Debugger.NotifyOfCrossThreadDependency(); - } + if (!issued) + { + this.etw.WaitStart(awaiter); - return issued; + // If the lock is immediately available, we don't need to coordinate with other threads. + // But if it is NOT available, we'd have to wait potentially for other threads to do more work. + Debugger.NotifyOfCrossThreadDependency(); } + + return issued; } /// From 1d32bd17ce6fa258a2054be399ea4bf2a1cb538c Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 16 Jan 2023 13:01:15 -0800 Subject: [PATCH 0676/1753] merge conditional block --- src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index c69a7d71c..c0ea76470 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -1174,8 +1174,7 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi { this.etw.Issued(awaiter); } - - if (!issued) + else { this.etw.WaitStart(awaiter); From 5078159bd7d7a6064466bc3985bc7b2b93a44603 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Jan 2023 15:50:20 -0700 Subject: [PATCH 0677/1753] Fix schedule trigger for source archival --- azure-pipelines/Archive-SourceCode.ps1 | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index 8f605a8ed..cfc30d2d2 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -116,11 +116,10 @@ if (!$OwnerAlias) { if ($env:BUILD_REQUESTEDFOREMAIL) { Write-Verbose 'Using $env:BUILD_REQUESTEDFOREMAIL and slicing to just the alias for OwnerAlias.' $OwnerAlias = ($env:BUILD_REQUESTEDFOREMAIL -split '@')[0] + } else { + $OwnerAlias = $TeamAlias } - else { - Write-Verbose 'Using $env:USERNAME for OwnerAlias.' - $OwnerAlias = $env:USERNAME - } + if (!$OwnerAlias) { Write-Error "Unable to determine default value for -OwnerAlias." } From 08405d839a4d97f4ec28d74a711eb433fc3fc09f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Jan 2023 15:51:06 -0700 Subject: [PATCH 0678/1753] Fix schedule trigger for source archival --- azure-pipelines/Archive-SourceCode.ps1 | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index 8f605a8ed..cfc30d2d2 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -116,11 +116,10 @@ if (!$OwnerAlias) { if ($env:BUILD_REQUESTEDFOREMAIL) { Write-Verbose 'Using $env:BUILD_REQUESTEDFOREMAIL and slicing to just the alias for OwnerAlias.' $OwnerAlias = ($env:BUILD_REQUESTEDFOREMAIL -split '@')[0] + } else { + $OwnerAlias = $TeamAlias } - else { - Write-Verbose 'Using $env:USERNAME for OwnerAlias.' - $OwnerAlias = $env:USERNAME - } + if (!$OwnerAlias) { Write-Error "Unable to determine default value for -OwnerAlias." } From 2f2a66ad5971bde78d69347c556207b0c9ce1ce8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Sep 2021 10:01:09 -0600 Subject: [PATCH 0679/1753] Switch to the VSEngSS-MicroBuild2019-1ES pool --- azure-pipelines/OptProf.yml | 2 +- azure-pipelines/official.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index d3567d76e..0a6750bf5 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -41,7 +41,7 @@ stages: jobs: - template: build.yml parameters: - windowsPool: VSEngSS-MicroBuild2019 + windowsPool: VSEngSS-MicroBuild2019-1ES ShouldSkipOptimize: true - stage: QueueVSBuild jobs: diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 50d4aa0b4..89d2cef8f 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -44,7 +44,7 @@ stages: jobs: - template: build.yml parameters: - windowsPool: VSEngSS-MicroBuild2019 + windowsPool: VSEngSS-MicroBuild2019-1ES ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - stage: symbol_archive From a992392b6ed70e166e35db785bd2ebd48cf47db5 Mon Sep 17 00:00:00 2001 From: Alex Hsu Date: Fri, 20 Jan 2023 06:23:37 -0800 Subject: [PATCH 0680/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20230120121750397. (#1147) --- loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl | 59 ++++++++++++++++++++ 13 files changed, 767 insertions(+) create mode 100644 loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl create mode 100644 loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl diff --git a/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl b/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..e00ea61b0 --- /dev/null +++ b/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl b/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..42e34176a --- /dev/null +++ b/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl b/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..3f8a5c07c --- /dev/null +++ b/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl b/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..33e682c28 --- /dev/null +++ b/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl b/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..14d09220c --- /dev/null +++ b/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl b/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..4225d055f --- /dev/null +++ b/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl b/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..6eae528e2 --- /dev/null +++ b/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl b/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..b57b85a5d --- /dev/null +++ b/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl b/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..71ddc0fc1 --- /dev/null +++ b/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl b/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..8a9754914 --- /dev/null +++ b/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl b/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..2e3414b67 --- /dev/null +++ b/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl b/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..8a88899db --- /dev/null +++ b/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl b/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl new file mode 100644 index 000000000..013edd91f --- /dev/null +++ b/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file From c4d099cb455f118c23cd10a2b53553fc38aba490 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 22 Jan 2023 09:06:39 -0700 Subject: [PATCH 0681/1753] Increase likelihood that folks set PackageProjectUrl property --- .editorconfig | 6 +++--- Directory.Build.props | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.editorconfig b/.editorconfig index c8b5de9ac..078687778 100644 --- a/.editorconfig +++ b/.editorconfig @@ -19,12 +19,12 @@ indent_size = 4 insert_final_newline = true trim_trailing_whitespace = true -# Xml project files -[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,msbuildproj}] +# MSBuild project files +[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,msbuildproj,props,targets}] indent_size = 2 # Xml config files -[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct,runsettings}] +[*.{ruleset,config,nuspec,resx,vsixmanifest,vsct,runsettings}] indent_size = 2 # JSON files diff --git a/Directory.Build.props b/Directory.Build.props index d722f5e49..35fd4f69a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -29,6 +29,7 @@ true $(MSBuildThisFileDirectory)strongname.snk + COMPANY-PLACEHOLDER COMPANY-PLACEHOLDER © COMPANY-PLACEHOLDER. All rights reserved. @@ -50,8 +51,7 @@ - - + $(PackageProjectUrl)/releases/tag/v$(Version) From 07df47ef04adb71c6d6a3e6bf8b560e5ff4c96db Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 22 Jan 2023 13:29:41 -0700 Subject: [PATCH 0682/1753] Bump Microsoft.CodeCoverage to 17.5.0-release-20230106-01 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1acbd174c..02f1d7072 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 344a85d9371242d8af359d0eb067b0037d416866 Mon Sep 17 00:00:00 2001 From: Alex Hsu Date: Mon, 23 Jan 2023 14:22:03 -0800 Subject: [PATCH 0683/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20230122124950525. (#1148) --- loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl | 14 ++++++++++++-- loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl | 14 ++++++++++++-- loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl | 14 ++++++++++++-- loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl | 20 ++++++++++++++++++-- loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl | 14 ++++++++++++-- 13 files changed, 210 insertions(+), 26 deletions(-) diff --git a/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl b/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl index e00ea61b0..00cfa65ef 100644 --- a/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/CHS/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl b/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl index 42e34176a..78d6af340 100644 --- a/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/CHT/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl b/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl index 3f8a5c07c..66f11ce0f 100644 --- a/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/CSY/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl b/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl index 33e682c28..f2e27faa4 100644 --- a/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,12 +14,18 @@ + + + + + + @@ -37,6 +44,9 @@ + + + @@ -56,4 +66,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl b/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl index 14d09220c..f656626ab 100644 --- a/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/ESN/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl b/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl index 4225d055f..765e54c11 100644 --- a/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/FRA/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl b/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl index 6eae528e2..f78b50ee0 100644 --- a/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,12 +14,18 @@ + + + + + + @@ -37,6 +44,9 @@ + + + @@ -56,4 +66,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl b/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl index b57b85a5d..726a90ec1 100644 --- a/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/JPN/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl b/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl index 71ddc0fc1..a32886dd5 100644 --- a/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/KOR/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl b/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl index 8a9754914..f02a24cb0 100644 --- a/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,12 +14,18 @@ + + + + + + @@ -37,6 +44,9 @@ + + + @@ -56,4 +66,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl b/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl index 2e3414b67..a1f959844 100644 --- a/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/PTB/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl b/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl index 8a88899db..243dc11ef 100644 --- a/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/RUS/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,18 +14,27 @@ + + + + + + + + + @@ -37,6 +47,9 @@ + + + @@ -49,6 +62,9 @@ + + + @@ -56,4 +72,4 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl b/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl index 013edd91f..8c3d34f5c 100644 --- a/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl @@ -1,10 +1,11 @@  - + + @@ -13,12 +14,18 @@ + + + + + + @@ -37,6 +44,9 @@ + + + @@ -56,4 +66,4 @@ - \ No newline at end of file + \ No newline at end of file From dd8b255527b6b03655caa606b8ba8a1f7301e385 Mon Sep 17 00:00:00 2001 From: Alex Hsu Date: Mon, 23 Jan 2023 15:12:47 -0800 Subject: [PATCH 0684/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20230123125108526. (#1149) --- loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl | 6 ++++++ loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl | 6 ++++++ loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl | 6 ++++++ loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl | 6 ++++++ 4 files changed, 24 insertions(+) diff --git a/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl b/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl index f2e27faa4..28dd3e6d9 100644 --- a/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/DEU/SosThreadingToolsManaged.dll.lcl @@ -32,6 +32,9 @@ + + + @@ -59,6 +62,9 @@ + + + diff --git a/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl b/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl index f78b50ee0..305fa7c23 100644 --- a/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/ITA/SosThreadingToolsManaged.dll.lcl @@ -32,6 +32,9 @@ + + + @@ -59,6 +62,9 @@ + + + diff --git a/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl b/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl index f02a24cb0..9a6320236 100644 --- a/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/PLK/SosThreadingToolsManaged.dll.lcl @@ -32,6 +32,9 @@ + + + @@ -59,6 +62,9 @@ + + + diff --git a/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl b/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl index 8c3d34f5c..6837c42be 100644 --- a/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl +++ b/loc/lcl/TRK/SosThreadingToolsManaged.dll.lcl @@ -32,6 +32,9 @@ + + + @@ -59,6 +62,9 @@ + + + From 7c9e1620b7af1570fb0b5ffb838efe1e94aa36f2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Jan 2023 07:23:40 -0700 Subject: [PATCH 0685/1753] Bump MicroBuildVersion from 2.0.93 to 2.0.107 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 34bd522c9..97ed7febc 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.93 + 2.0.107 From f7f6ed362751d7a3fd9d11026a0a42ec10e1cf0b Mon Sep 17 00:00:00 2001 From: Kartheek Penagamuri <52756182+kartheekp-ms@users.noreply.github.com> Date: Tue, 31 Jan 2023 17:32:49 -0800 Subject: [PATCH 0686/1753] Use latest NuGet.exe version (#188) * Use latest NuGet.exe version * Use 6.4.0 NuGet.exe version --- azure-pipelines/Get-NuGetTool.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Get-NuGetTool.ps1 b/azure-pipelines/Get-NuGetTool.ps1 index 4431adb91..3097c8736 100644 --- a/azure-pipelines/Get-NuGetTool.ps1 +++ b/azure-pipelines/Get-NuGetTool.ps1 @@ -6,7 +6,7 @@ #> Param( [Parameter()] - [string]$NuGetVersion='5.2.0' + [string]$NuGetVersion='6.4.0' ) $toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" From 4de45d4b12398d099da69b59a2a18dcb4782ba87 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Feb 2023 10:39:21 -0700 Subject: [PATCH 0687/1753] Bump Microsoft.CodeCoverage (#189) Bumps [Microsoft.CodeCoverage](https://github.com/microsoft/vstest) from 17.5.0-release-20230106-01 to 17.5.0-release-20230131-04. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/commits) --- updated-dependencies: - dependency-name: Microsoft.CodeCoverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 02f1d7072..a46323fa9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 2bf28739e8302b517e3be5c3747942cc4059ad57 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 1 Feb 2023 17:37:59 -0700 Subject: [PATCH 0688/1753] Fix working directory assumption made in init --- init.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.ps1 b/init.ps1 index 4a576ac28..3ea5f2103 100755 --- a/init.ps1 +++ b/init.ps1 @@ -106,7 +106,7 @@ try { } } - $InstallNuGetPkgScriptPath = ".\azure-pipelines\Install-NuGetPackage.ps1" + $InstallNuGetPkgScriptPath = "$PSScriptRoot\azure-pipelines\Install-NuGetPackage.ps1" $nugetVerbosity = 'quiet' if ($Verbose) { $nugetVerbosity = 'normal' } $MicroBuildPackageSource = 'https://pkgs.dev.azure.com/devdiv/_packaging/MicroBuildToolset%40Local/nuget/v3/index.json' From d7eefe10bf621ded5c27ecf703c7449c6a347565 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Feb 2023 11:24:54 -0700 Subject: [PATCH 0689/1753] Update .NET references to 7.0.0 --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c23e5b9df..24ab59f63 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + @@ -33,7 +33,7 @@ - + From eed2e31372eab822b4b920e6f702491595f3c17e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Feb 2023 12:35:41 -0700 Subject: [PATCH 0690/1753] Skip generating the NOTICE file on PR builds NOTICE generation fails frequently due to throttling, so this will both help keep PRs going, and reduce the demand on the network resource. --- azure-pipelines/microbuild.before.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index a27cf36bd..9320b1c2d 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -7,6 +7,7 @@ steps: inputs: outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE outputformat: text + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - task: MicroBuildSigningPlugin@3 inputs: From 4b758e6d0d47691ea4fc012b19f4e92a52dcef0c Mon Sep 17 00:00:00 2001 From: Bertan Aygun Date: Thu, 2 Feb 2023 15:14:59 -0800 Subject: [PATCH 0691/1753] Update dumpasync.md Update dumpasync documentation to explain the case where top frame points to an await call with no other frames present. --- doc/dumpasync.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/dumpasync.md b/doc/dumpasync.md index efbf4c920..7fbb0e30a 100644 --- a/doc/dumpasync.md +++ b/doc/dumpasync.md @@ -68,4 +68,26 @@ In the first stack above, `SendRequestAsync` method is on top, so it is the meth | -1 | The async method is currently executing (you should find it on a real thread's callstack somewhere). | >= 0 | The 0-index into which "await" has most recently yielded. The list of awaits for the method are in strict syntax appearance order. That is, regardless of code execution, if branching, etc., it's the index into which await in code syntax order has yielded. For example, if you position the caret at the top of the method definition and search for "await ", and count how many times you hit a match, starting from 0, when you arrive at the number that you found in the state field, you've found the await that has most recently yielded. Note that when the code being debugged is compiled with certain Dev14 prerelease versions of the Roslyn compiler, this index is 1-based instead of 0-based. +In some cases, the top most frame may point to an `await` on an async method without other frames present at the top such as: + +``` +0730c750 <0> MyClass+d__23 +.0730c17c <0> MyClass+d__2 +``` + +where `ExecuteAsync` may look like: + +```csharp +async Task ExecuteAsync(...) +{ + await ExecuteInternalAsync(..); +} +``` + +This could mean either: + +- `ExecuteInternalAsync` method is executing code before its first `await`, in which case it should be visible on thread callstacks. +- `ExecuteInternalAsync` is completed and continuation is scheduled for execution but is not started yet. In Visual Studio case this could be because continuation is scheduled +for main thread but main thread is busy and/or not allowing the task to be executed yet. + [WinDbg]: https://aka.ms/windbg-direct-download From 42c492681f3dc60e094452dbae0ca2f950338bf2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Feb 2023 13:55:03 -0700 Subject: [PATCH 0692/1753] Resolve or ignore loc warnings --- azure-pipelines/official.yml | 2 +- loc/lci/Microsoft.VisualStudio.Threading.Analyzers.dll.lci | 7 +++++++ loc/lci/Microsoft.VisualStudio.Threading.dll.lci | 7 +++++++ loc/lci/SosThreadingToolsManaged.dll.lci | 7 +++++++ 4 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 loc/lci/Microsoft.VisualStudio.Threading.Analyzers.dll.lci create mode 100644 loc/lci/Microsoft.VisualStudio.Threading.dll.lci create mode 100644 loc/lci/SosThreadingToolsManaged.dll.lci diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index fac3834b0..464a7feed 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -51,7 +51,7 @@ stages: - stage: Build variables: - MSBuildTreatWarningsAsErrors: true + MSBuildTreatWarningsAsErrors: false # re-enable after LOC warnings have been resolved DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages diff --git a/loc/lci/Microsoft.VisualStudio.Threading.Analyzers.dll.lci b/loc/lci/Microsoft.VisualStudio.Threading.Analyzers.dll.lci new file mode 100644 index 000000000..de341924d --- /dev/null +++ b/loc/lci/Microsoft.VisualStudio.Threading.Analyzers.dll.lci @@ -0,0 +1,7 @@ + + + + + + + diff --git a/loc/lci/Microsoft.VisualStudio.Threading.dll.lci b/loc/lci/Microsoft.VisualStudio.Threading.dll.lci new file mode 100644 index 000000000..4b271fc27 --- /dev/null +++ b/loc/lci/Microsoft.VisualStudio.Threading.dll.lci @@ -0,0 +1,7 @@ + + + + + + + diff --git a/loc/lci/SosThreadingToolsManaged.dll.lci b/loc/lci/SosThreadingToolsManaged.dll.lci new file mode 100644 index 000000000..3c773f4de --- /dev/null +++ b/loc/lci/SosThreadingToolsManaged.dll.lci @@ -0,0 +1,7 @@ + + + + + + + From 57423065d7124a39c3d96ee31668672d8f22cb85 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Feb 2023 10:15:19 -0700 Subject: [PATCH 0693/1753] Insert the VSInsertionMetadata package into .props file --- azure-pipelines/variables/InsertConfigValues.ps1 | 10 +++++++--- azure-pipelines/variables/InsertPropsValues.ps1 | 8 +++----- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index 3ae11de94..6631dd354 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -1,8 +1,12 @@ -$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") +$config = $env:BUILDCONFIGURATION +if (!$config) { $config = 'Debug' } +$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$config") +$dirsToSearch = "$BinPath\NuGet\*.nupkg" |? { Test-Path $_ } $icv=@() -foreach ($kvp in $InsertedPkgs.GetEnumerator()) { - $kvp.Value |% { + +if ($dirsToSearch) { + Get-ChildItem -Path $dirsToSearch |% { if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] diff --git a/azure-pipelines/variables/InsertPropsValues.ps1 b/azure-pipelines/variables/InsertPropsValues.ps1 index 427198cad..3ae11de94 100644 --- a/azure-pipelines/variables/InsertPropsValues.ps1 +++ b/azure-pipelines/variables/InsertPropsValues.ps1 @@ -1,10 +1,8 @@ -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BUILDCONFIGURATION") +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") -$dirsToSearch = "$BinPath\NuGet\*.nupkg" |? { Test-Path $_ } $icv=@() - -if ($dirsToSearch) { - Get-ChildItem -Path $dirsToSearch |% { +foreach ($kvp in $InsertedPkgs.GetEnumerator()) { + $kvp.Value |% { if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] From f17518be33e4b76fafc8f4b3a6096aa00ca8ceb1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Feb 2023 16:46:32 -0700 Subject: [PATCH 0694/1753] Update the dotnet-install.ps1 script This enables downloading newer SDK versions. --- tools/Install-DotNetSdk.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 2bac3b9bc..a71ff3fd1 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -234,10 +234,10 @@ if ($IncludeX86) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/781752509a890ca7520f1182e8bae71f9a53d754/src/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/88bd34f089b8a023e3523f22c92abd0ab88e4409/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/781752509a890ca7520f1182e8bae71f9a53d754/src/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/88bd34f089b8a023e3523f22c92abd0ab88e4409/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } From 551183c1e900d30e0e8b7623c910be160a690b4e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Feb 2023 16:52:41 -0700 Subject: [PATCH 0695/1753] Improve error message for unsupported versions --- tools/Install-DotNetSdk.ps1 | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index a71ff3fd1..14f4c8c4d 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -98,7 +98,12 @@ Function Get-InstallerExe( [string]$sku ) { # Get the latest/actual version for the specified one - $TypedVersion = [Version]$Version + $TypedVersion = $null + if (![Version]::TryParse($Version, [ref] $TypedVersion)) { + Write-Error "Unable to parse $Version into an a.b.c.d version. This version cannot be installed machine-wide." + exit 1 + } + if ($TypedVersion.Build -eq -1) { $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sku/$Version/latest.version" -UseBasicParsing) $Version = $versionInfo[-1] From 8381192a53608e7a655dfaf4f58a6edf64f8fa76 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Feb 2023 17:00:31 -0700 Subject: [PATCH 0696/1753] Remove references to "Core" in .NET Core --- tools/Install-DotNetSdk.ps1 | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 14f4c8c4d..47ccf22ed 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -3,7 +3,7 @@ <# .SYNOPSIS Installs the .NET SDK specified in the global.json file at the root of this repository, - along with supporting .NET Core runtimes used for testing. + along with supporting .NET runtimes used for testing. .DESCRIPTION This MAY not require elevation, as the SDK and runtimes are installed locally to this repo location, unless `-InstallLocality machine` is specified. @@ -43,7 +43,7 @@ if (!$arch) { # Windows Powershell leaves this blank if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { $arch = 'ARM64' } } -# Search for all .NET Core runtime versions referenced from MSBuild projects and arrange to install them. +# Search for all .NET runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() $windowsDesktopRuntimeVersions = @() Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { @@ -145,9 +145,9 @@ Function Get-InstallerExe( } Function Install-DotNet($Version, $Architecture, [ValidateSet('Sdk','Runtime','WindowsDesktop')][string]$sku = 'Sdk') { - Write-Host "Downloading .NET Core $sku $Version..." + Write-Host "Downloading .NET $sku $Version..." $Installer = Get-InstallerExe -Version $Version -Architecture $Architecture -sku $sku - Write-Host "Installing .NET Core $sku $Version..." + Write-Host "Installing .NET $sku $Version..." cmd /c start /wait $Installer /install /passive /norestart if ($LASTEXITCODE -eq 3010) { Write-Verbose "Restart required" @@ -290,7 +290,7 @@ if ($IncludeX86) { $dotnetRuntimeSwitches = $switches + '-Runtime','dotnet' $runtimeVersions | Sort-Object -Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core $Arch runtime $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET $Arch runtime $_", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $dotnetRuntimeSwitches" @@ -303,7 +303,7 @@ $runtimeVersions | Sort-Object -Unique |% { } if ($IncludeX86) { - if ($PSCmdlet.ShouldProcess(".NET Core x86 runtime $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET x86 runtime $_", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $dotnetRuntimeSwitches" @@ -320,7 +320,7 @@ $runtimeVersions | Sort-Object -Unique |% { $windowsDesktopRuntimeSwitches = $switches + '-Runtime','windowsdesktop' $windowsDesktopRuntimeVersions | Sort-Object -Unique |% { - if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop $arch runtime $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET WindowsDesktop $arch runtime $_", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $windowsDesktopRuntimeSwitches" @@ -333,7 +333,7 @@ $windowsDesktopRuntimeVersions | Sort-Object -Unique |% { } if ($IncludeX86) { - if ($PSCmdlet.ShouldProcess(".NET Core WindowsDesktop x86 runtime $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET WindowsDesktop x86 runtime $_", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $windowsDesktopRuntimeSwitches" @@ -352,5 +352,5 @@ if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these } if ($anythingInstalled -and ($InstallLocality -ne 'machine') -and !$env:TF_BUILD -and !$env:GITHUB_ACTIONS) { - Write-Warning ".NET Core runtimes or SDKs were installed to a non-machine location. Perform your builds or open Visual Studio from this same environment in order for tools to discover the location of these dependencies." + Write-Warning ".NET runtimes or SDKs were installed to a non-machine location. Perform your builds or open Visual Studio from this same environment in order for tools to discover the location of these dependencies." } From d19033347c00cf09ef9201a6a4d25a19673d8de4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Feb 2023 17:07:26 -0700 Subject: [PATCH 0697/1753] Add -SdkOnly switch --- tools/Install-DotNetSdk.ps1 | 53 ++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 24 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 47ccf22ed..39e47eb60 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -15,6 +15,8 @@ When using 'repo', environment variables are set to cause the locally installed dotnet SDK to be used. Per-repo can lead to file locking issues when dotnet.exe is left running as a build server and can be mitigated by running `dotnet build-server shutdown`. Per-machine requires elevation and will download and install all SDKs and runtimes to machine-wide locations so all applications can find it. +.PARAMETER SdkOnly + Skips installing the runtime. .PARAMETER IncludeX86 Installs a x86 SDK and runtimes in addition to the x64 ones. Only supported on Windows. Ignored on others. #> @@ -22,6 +24,7 @@ Param ( [ValidateSet('repo','user','machine')] [string]$InstallLocality='user', + [switch]$SdkOnly, [switch]$IncludeX86 ) @@ -46,34 +49,36 @@ if (!$arch) { # Windows Powershell leaves this blank # Search for all .NET runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() $windowsDesktopRuntimeVersions = @() -Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { - $projXml = [xml](Get-Content -Path $_) - $pg = $projXml.Project.PropertyGroup - if ($pg) { - $targetFrameworks = @() - $tf = $pg.TargetFramework - $targetFrameworks += $tf - $tfs = $pg.TargetFrameworks - if ($tfs) { - $targetFrameworks = $tfs -Split ';' +if (!$SdkOnly) { + Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { + $projXml = [xml](Get-Content -Path $_) + $pg = $projXml.Project.PropertyGroup + if ($pg) { + $targetFrameworks = @() + $tf = $pg.TargetFramework + $targetFrameworks += $tf + $tfs = $pg.TargetFrameworks + if ($tfs) { + $targetFrameworks = $tfs -Split ';' + } } - } - $targetFrameworks |? { $_ -match 'net(?:coreapp)?(\d+\.\d+)' } |% { - $v = $Matches[1] - $runtimeVersions += $v - if ($v -ge '3.0' -and -not ($IsMacOS -or $IsLinux)) { - $windowsDesktopRuntimeVersions += $v + $targetFrameworks |? { $_ -match 'net(?:coreapp)?(\d+\.\d+)' } |% { + $v = $Matches[1] + $runtimeVersions += $v + if ($v -ge '3.0' -and -not ($IsMacOS -or $IsLinux)) { + $windowsDesktopRuntimeVersions += $v + } } - } - # Add target frameworks of the form: netXX - $targetFrameworks |? { $_ -match 'net(\d+\.\d+)' } |% { - $v = $Matches[1] - $runtimeVersions += $v - if (-not ($IsMacOS -or $IsLinux)) { - $windowsDesktopRuntimeVersions += $v + # Add target frameworks of the form: netXX + $targetFrameworks |? { $_ -match 'net(\d+\.\d+)' } |% { + $v = $Matches[1] + $runtimeVersions += $v + if (-not ($IsMacOS -or $IsLinux)) { + $windowsDesktopRuntimeVersions += $v + } } - } + } } Function Get-FileFromWeb([Uri]$Uri, $OutDir) { From dcd78387fdbb4176e69cf725bf51bea0cccfcadc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 10 Feb 2023 12:45:25 -0700 Subject: [PATCH 0698/1753] Add emojis to insertion pipeline steps --- azure-pipelines/prepare-insertion-stages.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index a707454c4..dcd1e6d8f 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -9,17 +9,17 @@ stages: - checkout: none - download: current artifact: Variables-Windows - displayName: Download Variables-Windows artifact + displayName: 🔻 Download Variables-Windows artifact - task: PowerShell@2 - displayName: Set pipeline variables based on artifacts + displayName: ⚙️ Set pipeline variables based on artifacts inputs: targetType: filePath filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 - download: current artifact: symbols-legacy - displayName: Download symbols-legacy artifact + displayName: 🔻 Download symbols-legacy artifact - task: MicroBuildArchiveSymbols@1 - displayName: Archive symbols to Symweb + displayName: 🔣 Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) SymbolsSymwebProject: VS @@ -27,7 +27,7 @@ stages: SymbolsEmailContacts: vsidemicrobuild SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy - task: MicroBuildCleanup@1 - displayName: Send Telemetry + displayName: ☎️ Send Telemetry # - stage: azure_public_vsimpl_feed # displayName: azure-public/vs-impl feed @@ -41,16 +41,16 @@ stages: # - checkout: none # - download: current # artifact: deployables-Windows -# displayName: Download deployables-Windows artifact +# displayName: 🔻 Download deployables-Windows artifact # - task: UseDotNet@2 -# displayName: Install .NET SDK +# displayName: ⚙️ Install .NET SDK # inputs: # packageType: sdk # version: 6.x # - task: NuGetAuthenticate@1 -# displayName: Authenticate NuGet feeds +# displayName: 🔏 Authenticate NuGet feeds # inputs: # nuGetServiceConnections: azure-public/vs-impl # forceReinstallCredentialProvider: true # - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate -# displayName: Push nuget packages +# displayName: 📦 Push nuget packages From c01126d8e995b239a17341ecec2e85bd0e02129b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Feb 2023 16:19:46 -0700 Subject: [PATCH 0699/1753] Simplify Version cast in ps1 script --- tools/Install-DotNetSdk.ps1 | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 2bac3b9bc..a8635f497 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -92,19 +92,18 @@ Function Get-FileFromWeb([Uri]$Uri, $OutDir) { } Function Get-InstallerExe( - $Version, + [Version]$Version, $Architecture, [ValidateSet('Sdk','Runtime','WindowsDesktop')] [string]$sku ) { # Get the latest/actual version for the specified one - $TypedVersion = [Version]$Version - if ($TypedVersion.Build -eq -1) { + if ($Version.Build -eq -1) { $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sku/$Version/latest.version" -UseBasicParsing) $Version = $versionInfo[-1] } - $majorMinor = "$($TypedVersion.Major).$($TypedVersion.Minor)" + $majorMinor = "$($Version.Major).$($Version.Minor)" $ReleasesFile = Join-Path $DotNetInstallScriptRoot "$majorMinor\releases.json" if (!(Test-Path $ReleasesFile)) { Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata/$majorMinor/releases.json" -OutDir (Split-Path $ReleasesFile) | Out-Null From 0fc6c4f57e3b180da230264669a3c24be17903e9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Feb 2023 09:49:03 -0700 Subject: [PATCH 0700/1753] Add more emojis and use simpler powershell task syntax --- azure-pipelines/prepare-insertion-stages.yml | 5 +---- azure-pipelines/release-deployment-prep.yml | 9 +++----- azure-pipelines/vs-insertion.yml | 16 +++++++------- azure-pipelines/vs-validation.yml | 23 +++++++++----------- 4 files changed, 22 insertions(+), 31 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index dcd1e6d8f..bb955d688 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -10,11 +10,8 @@ stages: - download: current artifact: Variables-Windows displayName: 🔻 Download Variables-Windows artifact - - task: PowerShell@2 + - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 displayName: ⚙️ Set pipeline variables based on artifacts - inputs: - targetType: filePath - filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 - download: current artifact: symbols-legacy displayName: 🔻 Download symbols-legacy artifact diff --git a/azure-pipelines/release-deployment-prep.yml b/azure-pipelines/release-deployment-prep.yml index 059fd1d0a..d9a9ffd39 100644 --- a/azure-pipelines/release-deployment-prep.yml +++ b/azure-pipelines/release-deployment-prep.yml @@ -1,9 +1,6 @@ steps: - download: CI artifact: Variables-Windows - displayName: Download Variables-Windows artifact -- task: PowerShell@2 - displayName: Set pipeline variables based on artifacts - inputs: - targetType: filePath - filePath: $(Pipeline.Workspace)/CI/Variables-Windows/_pipelines.ps1 + displayName: 🔻 Download Variables-Windows artifact +- powershell: $(Pipeline.Workspace)/CI/Variables-Windows/_pipelines.ps1 + displayName: ⚙️ Set pipeline variables based on artifacts diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 112dd92f6..c75245594 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -19,24 +19,24 @@ jobs: steps: - checkout: none - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - displayName: Set pipeline name + displayName: ⚙️ Set pipeline name - task: UseDotNet@2 - displayName: Install .NET SDK + displayName: ⚙️ Install .NET SDK inputs: packageType: sdk version: 6.x - task: NuGetAuthenticate@1 - displayName: Authenticate NuGet feeds + displayName: 🔏 Authenticate NuGet feeds inputs: forceReinstallCredentialProvider: true - template: release-deployment-prep.yml - download: CI artifact: VSInsertion-Windows - displayName: Download VSInsertion-Windows artifact + displayName: 🔻 Download VSInsertion-Windows artifact - script: dotnet nuget push $(Pipeline.Workspace)\CI\VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate - displayName: Push CoreXT packages to VS feed + displayName: 📦 Push CoreXT packages to VS feed - task: MicroBuildInsertVsPayload@4 - displayName: Insert VS Payload + displayName: 🏭 Insert VS Payload inputs: TeamName: $(TeamName) TeamEmail: $(TeamEmail) @@ -45,7 +45,7 @@ jobs: AutoCompletePR: true AutoCompleteMergeStrategy: Squash - task: MicroBuildCleanup@1 - displayName: Send Telemetry + displayName: ☎️ Send Telemetry - powershell: | $contentType = 'application/json'; $headers = @{ Authorization = 'Bearer $(System.AccessToken)' }; @@ -54,4 +54,4 @@ jobs: Write-Host $request $uri = "$(System.CollectionUri)$(System.TeamProject)/_apis/build/retention/leases?api-version=6.0-preview.1"; Invoke-RestMethod -uri $uri -method POST -Headers $headers -ContentType $contentType -Body $request; - displayName: Retain inserted builds + displayName: 🗻 Retain inserted builds diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 3cbc196ed..82a82aa01 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -36,30 +36,27 @@ stages: clean: true fetchDepth: 1 - task: UseDotNet@2 - displayName: Install .NET SDK + displayName: ⚙️ Install .NET SDK inputs: packageType: sdk version: 6.x - task: NuGetAuthenticate@1 - displayName: Authenticate NuGet feeds + displayName: 🔏 Authenticate NuGet feeds inputs: forceReinstallCredentialProvider: true - download: current artifact: Variables-Windows - displayName: Download Variables-Windows artifact - - task: PowerShell@2 - displayName: Set pipeline variables based on artifacts - inputs: - targetType: filePath - filePath: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + displayName: 🔻 Download Variables-Windows artifact + - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + displayName: ⚙️ Set pipeline variables based on artifacts - download: current artifact: VSInsertion-Windows - displayName: Download VSInsertion-Windows artifact + displayName: 🔻 Download VSInsertion-Windows artifact - script: dotnet nuget push VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate - displayName: Push CoreXT packages to VS feed + displayName: 📦 Push CoreXT packages to VS feed workingDirectory: $(Pipeline.Workspace) - task: MicroBuildInsertVsPayload@4 - displayName: Insert VS Payload + displayName: 🏭 Insert VS Payload inputs: TeamName: $(TeamName) TeamEmail: $(TeamEmail) @@ -78,7 +75,7 @@ stages: Remember to Abandon and (if allowed) to Delete Source Branch on that insertion PR when validation is complete. "@ azure-pipelines/PostPRMessage.ps1 -AccessToken '$(System.AccessToken)' -Markdown $Markdown -Verbose - displayName: Comment on pull request + displayName: ✏️ Comment on pull request condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest')) - task: MicroBuildCleanup@1 - displayName: Send Telemetry + displayName: ☎️ Send Telemetry From b3a68a9e4a6c37996ef969a54ac059ab62eae3d2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Feb 2023 13:02:03 -0700 Subject: [PATCH 0701/1753] Use LF line endings for plist files The mac tools that read these files are sticklers for LF endings. --- .gitattributes | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitattributes b/.gitattributes index c22a129ef..1f35e683d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -7,6 +7,9 @@ *.sh eol=lf *.ps1 eol=lf +# The macOS codesign tool is extremely picky, and requires LF line endings. +*.plist eol=lf + ############################################################################### # Set default behavior for command prompt diff. # From b579c7cabdad15c7b0b86446309f5297bd71cbb4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Feb 2023 13:04:55 -0700 Subject: [PATCH 0702/1753] Add `-interactive` switch to init.ps1 --- init.ps1 | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/init.ps1 b/init.ps1 index 774ead583..ad3b4145c 100755 --- a/init.ps1 +++ b/init.ps1 @@ -30,6 +30,8 @@ Skips the package restore step. .PARAMETER AccessToken An optional access token for authenticating to Azure Artifacts authenticated feeds. +.PARAMETER Interactive + Runs NuGet restore in interactive mode. This can turn authentication failures into authentication challenges. #> [CmdletBinding(SupportsShouldProcess = $true)] Param ( @@ -44,7 +46,9 @@ Param ( [Parameter()] [switch]$NoRestore, [Parameter()] - [string]$AccessToken + [string]$AccessToken, + [Parameter()] + [switch]$Interactive ) $EnvVars = @{} @@ -76,8 +80,14 @@ try { $HeaderColor = 'Green' if (!$NoRestore -and $PSCmdlet.ShouldProcess("NuGet packages", "Restore")) { + $RestoreArguments = @() + if ($Interactive) + { + $RestoreArguments += '--interactive' + } + Write-Host "Restoring NuGet packages" -ForegroundColor $HeaderColor - dotnet restore + dotnet restore @RestoreArguments if ($lastexitcode -ne 0) { throw "Failure while restoring packages." } From c6b825e9e71cc57c7275e81f8281cb74a1d41f57 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Feb 2023 07:54:46 -0700 Subject: [PATCH 0703/1753] Bump MicroBuild to 2.0.112 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ae621d842..e1bd2e7d7 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.107 + 2.0.112 From 8b342da2060fe53954b1630d00a6c02a2b923383 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Feb 2023 15:12:36 -0700 Subject: [PATCH 0704/1753] Remove certain tasks on non-Windows agents --- azure-pipelines/microbuild.after.yml | 3 ++- azure-pipelines/microbuild.before.yml | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 4c3554abd..3dbbad9cc 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -8,6 +8,7 @@ steps: inputs: TargetFolders: | $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet + condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - task: MicroBuildCleanup@1 condition: succeededOrFailed() @@ -23,7 +24,7 @@ steps: /repoName:$(Build.Repository.Name) /additionalCodexArguments:-bld /additionalCodexArguments:$(Build.ArtifactStagingDirectory)/build_logs - condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'), ne(variables['Build.Reason'], 'PullRequest')) + condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'), ne(variables['Build.Reason'], 'PullRequest'), eq(variables['Agent.OS'], 'Windows_NT')) continueOnError: true - ${{ if eq(parameters.EnableCompliance, 'true') }}: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 9320b1c2d..d048af4bb 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -14,6 +14,8 @@ steps: signType: $(SignType) zipSources: false displayName: 🔧 Install MicroBuild Signing Plugin + condition: and(succeeded(), or(eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['SignType'], 'real'))) - task: MicroBuildSbomPlugin@1 displayName: 🔧 Install MicroBuild Sbom Plugin + condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) From 6415323a89947e6d5d2229cd606cb02d18c1c474 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 24 Feb 2023 13:07:15 -0700 Subject: [PATCH 0705/1753] Bump dependencies to 17.5.0 versions --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index a46323fa9..b792f3f6b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,8 +5,8 @@ true - - + + From a24603fd9fd33e38c87bae4d2d356df6e08ecdcc Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sat, 25 Feb 2023 18:40:30 -0800 Subject: [PATCH 0706/1753] Fix integer overflow. --- src/Microsoft.VisualStudio.Threading/InternalUtilities.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs index 61ad43124..f8049bad9 100644 --- a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs +++ b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs @@ -62,7 +62,7 @@ internal static bool RemoveMidQueue(this Queue queue, T valueToRemove) } /// - /// Walk the continuation objects inside "async state machines" to generate the return callstack. + /// Walk the continuation objects inside "async state machines" to generate the return call stack. /// FOR DIAGNOSTIC PURPOSES ONLY. /// /// The delegate that represents the head of an async continuation chain. @@ -85,7 +85,7 @@ internal static IEnumerable GetAsyncReturnStackFrames(this Delegate cont stateMachine.GetType().FullName, state, AsyncReturnStackPrefix, - (int)GetAddress(stateMachine)); // the int cast allows hex formatting + (long)GetAddress(stateMachine)); // the int cast allows hex formatting Delegate[]? continuationDelegates = FindContinuationDelegates(stateMachine).ToArray(); if (continuationDelegates.Length == 0) From 6d73d6ed685a962fcd368f8185b32f32547d1f16 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sat, 25 Feb 2023 18:53:26 -0800 Subject: [PATCH 0707/1753] Fix a problem that reader/writer lock hardcoded task scheduler. Preparing resource is a common routine to access evaluated project, most of the time, it is close to no-op when the evaluation is up to date. Because the code always schedules the call to the thread pool, it defeats the very reason to have a priority queue for high priority work when thread pool is too busy. It also makes it hard to throttle project evaluations through special task scheduler. The change is to try not to change the behavior, when the code is called on UI thread (as it can lead into new problems), but try to use the current task scheduler if possible. --- .../AsyncReaderWriterResourceLock`2.cs | 36 +++++++++++-------- .../CancellableJoinComputation.cs | 24 +++++++------ 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs index 2a8379541..49e66e998 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs @@ -503,7 +503,7 @@ internal class Helper /// /// A map of resources to the status of tasks that most recently began evaluating them. /// - private WeakKeyDictionary resourcePreparationStates = new WeakKeyDictionary(capacity: 2); + private readonly WeakKeyDictionary resourcePreparationStates = new WeakKeyDictionary(capacity: 2); /// /// Initializes a new instance of the class. @@ -697,7 +697,7 @@ internal async Task GetResourceAsync(TMoniker resourceMoniker, Cancel { using (AsyncReaderWriterResourceLock.ResourceReleaser resourceLock = this.AcquirePreexistingLockOrThrow()) { - TResource? resource = await this.service.GetResourceAsync(resourceMoniker, cancellationToken).ConfigureAwait(false); + TResource? resource = await this.service.GetResourceAsync(resourceMoniker, cancellationToken).ConfigureAwaitRunInline(); Task preparationTask; lock (this.service.SyncObject) @@ -707,7 +707,7 @@ internal async Task GetResourceAsync(TMoniker resourceMoniker, Cancel preparationTask = this.PrepareResourceAsync(resource, cancellationToken); } - await preparationTask.ConfigureAwait(false); + await preparationTask.ConfigureAwaitRunInline(); return resource; } } @@ -733,6 +733,7 @@ private void SetUnknownResourceState(TResource resource) this.resourcePreparationStates[resource] = ResourcePreparationTaskState.Create( _ => previousState?.InnerTask ?? Task.CompletedTask, ResourceState.Unknown, + TaskScheduler.Default, CancellationToken.None).PreparationState; } } @@ -768,6 +769,7 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella AsyncReaderWriterResourceLock.Helper.ResourceState finalState = forConcurrentUse ? ResourceState.Concurrent : ResourceState.Exclusive; Task? preparationTask = null; + TaskScheduler taskScheduler = TaskScheduler.Current.MaximumConcurrencyLevel > 1 ? TaskScheduler.Current : TaskScheduler.Default; if (!this.resourcePreparationStates.TryGetValue(resource, out ResourcePreparationTaskState? preparationState)) { @@ -778,7 +780,7 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella // We kick this off on a new task because we're currently holding a private lock // and don't want to execute arbitrary code. // Let's also hide the ARWL from the delegate if this is a shared lock request. - using (forConcurrentUse ? this.service.HideLocks() : default(Suppression)) + using (forConcurrentUse ? this.service.HideLocks() : default) { // We can't currently use the caller's cancellation token for this task because // this task may be shared with others or call this method later, and we wouldn't @@ -789,8 +791,9 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella forConcurrentUse ? Tuple.Create(resource, combinedCancellationToken) : Tuple.Create(resource, this.service.GetAggregateLockFlags(), combinedCancellationToken), combinedCancellationToken, TaskCreationOptions.None, - TaskScheduler.Default).Unwrap(), + taskScheduler).Unwrap(), finalState, + taskScheduler, cancellationToken); } } @@ -803,7 +806,7 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella ? this.prepareResourceConcurrentContinuationDelegate : this.prepareResourceExclusiveContinuationDelegate; } - else if (!preparationState.TryJoinPrepationTask(out preparationTask, cancellationToken)) + else if (!preparationState.TryJoinPreparationTask(out preparationTask, taskScheduler, cancellationToken)) { preparationDelegate = forConcurrentUse ? this.prepareResourceConcurrentContinuationOnPossibleCancelledTaskDelegate @@ -817,7 +820,7 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella // We kick this off on a new task because we're currently holding a private lock // and don't want to execute arbitrary code. // Let's also hide the ARWL from the delegate if this is a shared lock request. - using (forConcurrentUse ? this.service.HideLocks() : default(Suppression)) + using (forConcurrentUse ? this.service.HideLocks() : default) { (preparationState, preparationTask) = ResourcePreparationTaskState.Create( combinedCancellationToken => preparationState.InnerTask.ContinueWith( @@ -825,8 +828,9 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella forConcurrentUse ? Tuple.Create(resource, combinedCancellationToken) : Tuple.Create(resource, this.service.GetAggregateLockFlags(), combinedCancellationToken), CancellationToken.None, TaskContinuationOptions.RunContinuationsAsynchronously, - TaskScheduler.Default).Unwrap(), + taskScheduler).Unwrap(), finalState, + taskScheduler, cancellationToken); } } @@ -879,12 +883,13 @@ internal ResourcePreparationTaskState(Func taskCreation /// /// A callback method to create the preparation task. /// The final resource state when the preparation is done. + /// A task scheduler for continuation. /// A cancellation token to abort the preparation task. /// The preparation task and its status to be used to join more waiting tasks later. - internal static (ResourcePreparationTaskState PreparationState, Task InitialTask) Create(Func taskCreation, ResourceState finalState, CancellationToken cancellationToken) + internal static (ResourcePreparationTaskState PreparationState, Task InitialTask) Create(Func taskCreation, ResourceState finalState, TaskScheduler taskScheduler, CancellationToken cancellationToken) { var preparationState = new ResourcePreparationTaskState(taskCreation, finalState, cancellationToken.CanBeCanceled); - Assumes.True(preparationState.TryJoinComputation(isInitialTask: true, out Task? initialTask, cancellationToken)); + Assumes.True(preparationState.TryJoinComputation(isInitialTask: true, out Task? initialTask, taskScheduler, cancellationToken)); return (preparationState, initialTask); } @@ -892,12 +897,13 @@ internal static (ResourcePreparationTaskState PreparationState, Task InitialTask /// /// Try to join an existing preparation task. /// - /// The new waiting task to be compeleted when the resource preparation is done. - /// A cancellation token to abandone the new waiting task. - /// True if it joins sucessfully, it return false, if the current task has been cancelled. - internal bool TryJoinPrepationTask([NotNullWhen(true)] out Task? task, CancellationToken cancellationToken) + /// The new waiting task to be completed when the resource preparation is done. + /// A task scheduler for continuation. + /// A cancellation token to abandon the new waiting task. + /// True if it joins successfully, it return false, if the current task has been cancelled. + internal bool TryJoinPreparationTask([NotNullWhen(true)] out Task? task, TaskScheduler taskScheduler, CancellationToken cancellationToken) { - return this.TryJoinComputation(isInitialTask: false, out task, cancellationToken); + return this.TryJoinComputation(isInitialTask: false, out task, taskScheduler, cancellationToken); } } } diff --git a/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs b/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs index 150a136f7..b121d2c1c 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellableJoinComputation.cs @@ -22,7 +22,7 @@ internal class CancellableJoinComputation /// /// A list of task completion sources which represents joined waiting requests with cancellable cancellation tokens. - /// When an individule cancellation token is triggered, we may allow that specific waiting task to continue, and only all of them abandone the computation then we may + /// When an individual cancellation token is triggered, we may allow that specific waiting task to continue, and only all of them abandon the computation then we may /// cancel the inner computation. /// private List? joinedWaitingList; @@ -142,13 +142,14 @@ internal CancellableJoinComputation(Func taskFactory, b /// /// It is true for the initial task starting the computation. This must be called once right after the constructor. /// Returns a task which can be waited on. + /// A task scheduler for continuation. /// A cancellation token to abort this waiting. /// It returns false, if the inner task is aborted. In which case, no way to join the existing computation. - internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Task? task, CancellationToken cancellationToken) + internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Task? task, TaskScheduler taskScheduler, CancellationToken cancellationToken) { if (!this.isCancellationAllowed) { - task = this.JoinNotCancellableTaskAsync(isInitialTask, cancellationToken); + task = this.JoinNotCancellableTaskAsync(isInitialTask, taskScheduler, cancellationToken); return true; } @@ -184,7 +185,7 @@ internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Tas } } - // if the inner task is joined by a new uncancellable task, we will abandone the cancellation token source because we will never use it anymore. + // if the inner task is joined by a new not cancellable task, we will abandon the cancellation token source because we will never use it anymore. // we do it outside of our lock. CancellationTokenSource? combinedCancellationTokenSourceToDispose = null; @@ -213,11 +214,11 @@ internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Tas this.isCancellationAllowed = false; - task = this.JoinNotCancellableTaskAsync(isInitialTask, CancellationToken.None); + task = this.JoinNotCancellableTaskAsync(isInitialTask, taskScheduler, CancellationToken.None); } else if (!this.isCancellationAllowed) { - task = this.JoinNotCancellableTaskAsync(isInitialTask, cancellationToken); + task = this.JoinNotCancellableTaskAsync(isInitialTask, taskScheduler, cancellationToken); } else { @@ -225,7 +226,7 @@ internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Tas WaitingCancellationStatus status; - // we need increase the outstanding count before creating WiatingCancellationStatus. + // we need increase the outstanding count before creating WaitingCancellationStatus. // Under a rare race condition the cancellation token can be trigger with this time frame, and lead OnWaitingTaskCancelled to be called recursively // within this lock. It would be critical to make sure the outstandingWaitingCount to increase before decreasing there. this.outstandingWaitingCount++; @@ -257,14 +258,15 @@ internal bool TryJoinComputation(bool isInitialTask, [NotNullWhen(true)] out Tas /// A simple way to join if the inner task cannot be cancelled. /// /// Whether it is the first task to start the computation. + /// A task scheduler for continuation. /// A cancellation token to abort the waiting. /// A task to complete when the computation ends. - private Task JoinNotCancellableTaskAsync(bool isInitialTask, CancellationToken cancellationToken) + private Task JoinNotCancellableTaskAsync(bool isInitialTask, TaskScheduler taskScheduler, CancellationToken cancellationToken) { if (this.InnerTask.IsCompleted || (isInitialTask && !cancellationToken.CanBeCanceled)) { // Note: we don't reuse the inner task directly even for second request which is not cancellable. - // This is to prevent two task sychorized continuations, which can be blocking each other causing unexpected deadlocks. + // This is to prevent two task synchronized continuations, which can be blocking each other causing unexpected deadlocks. // Adding an extra async task continuation prevents this problem, because all async continuation will be queued before calling synchronized task continuations, // which are called one by one. return this.InnerTask; @@ -282,7 +284,7 @@ private Task JoinNotCancellableTaskAsync(bool isInitialTask, CancellationToken c t => t.GetAwaiter().GetResult(), cancellationToken, TaskContinuationOptions.RunContinuationsAsynchronously, - TaskScheduler.Default); + taskScheduler); } /// @@ -327,7 +329,7 @@ private class WaitingCancellationStatus : TaskCompletionSource /// /// The cancellation registration to handle the cancellation token of the request. /// - private CancellationTokenRegistration cancellationTokenRegistration; + private readonly CancellationTokenRegistration cancellationTokenRegistration; /// /// Initializes a new instance of the class. From 01417e7cf159ec365b421d9a6bcd1e2dbcb03cf2 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sat, 25 Feb 2023 18:53:42 -0800 Subject: [PATCH 0708/1753] Fix some warnings/spellings. --- .../AsyncReaderWriterLock.cs | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index c0ea76470..ced7522fb 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -126,6 +126,11 @@ public partial class AsyncReaderWriterLock : IDisposable /// private readonly Queue> beforeWriteReleasedCallbacks = new Queue>(); + /// + /// A helper class to produce ETW trace events. + /// + private readonly EventsHelper etw; + /// /// A value indicating whether extra resources should be spent to collect diagnostic information /// that may be useful in deadlock investigations. @@ -144,11 +149,6 @@ public partial class AsyncReaderWriterLock : IDisposable /// private bool completeInvoked; - /// - /// A helper class to produce ETW trace events. - /// - private EventsHelper etw; - /// /// A timer to recheck potential deadlock caused by pending writer locks. /// @@ -676,11 +676,11 @@ protected virtual Task OnBeforeExclusiveLockReleasedAsync() /// /// Get the task scheduler to execute the continuation when the lock is acquired. - /// AsyncReaderWriterLock uses a special to handle execusive locks, and will ignore task scheduler provided, so this is only used in a read lock scenario. + /// AsyncReaderWriterLock uses a special to handle exclusive locks, and will ignore task scheduler provided, so this is only used in a read lock scenario. /// This method is called within the execution context to wait the read lock, so it can pick up based on the current execution context. /// Note: the task scheduler is only used, when the lock is issued later. If the lock is issued immediately when returns true, it will be ignored. /// - /// A task scheduler to schedule the continutation task when a lock is issued. + /// A task scheduler to schedule the continuation task when a lock is issued. protected virtual TaskScheduler GetTaskSchedulerForReadLockRequest() { return TaskScheduler.Default; @@ -2198,32 +2198,41 @@ public class Awaiter : ICriticalNotifyCompletion /// /// The instance of the lock class to which this awaiter is affiliated. /// - private AsyncReaderWriterLock lck; + private readonly AsyncReaderWriterLock lck; /// /// The type of lock requested. /// - private LockKind kind; + private readonly LockKind kind; /// /// The "parent" lock (i.e. the lock within which this lock is nested) if any. /// - private Awaiter? nestingLock; + private readonly Awaiter? nestingLock; /// /// The cancellation token that would terminate waiting for a lock that is not yet available. /// - private CancellationToken cancellationToken; + private readonly CancellationToken cancellationToken; /// - /// The cancellation token event that should be disposed of to free memory when we no longer need to receive cancellation notifications. + /// The flags applied to this lock. /// - private CancellationTokenRegistration cancellationRegistration; + private readonly LockFlags options; /// - /// The flags applied to this lock. + /// The stack trace of the caller originally requesting the lock. /// - private LockFlags options; + /// + /// This field is initialized only when is constructed with + /// the captureDiagnostics parameter set to . + /// + private readonly StackTrace? requestingStackTrace; + + /// + /// The cancellation token event that should be disposed of to free memory when we no longer need to receive cancellation notifications. + /// + private CancellationTokenRegistration cancellationRegistration; /// /// Any exception to throw back to the lock requestor. @@ -2258,15 +2267,6 @@ public class Awaiter : ICriticalNotifyCompletion /// private SynchronizationContext? synchronizationContext; - /// - /// The stacktrace of the caller originally requesting the lock. - /// - /// - /// This field is initialized only when is constructed with - /// the captureDiagnostics parameter set to . - /// - private StackTrace? requestingStackTrace; - /// /// An arbitrary object that may be set by a derived type of the containing lock class. /// From b14c241a02a020ef7f483a3748dfffa640bbc7b6 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sun, 26 Feb 2023 18:27:17 -0800 Subject: [PATCH 0709/1753] Add a unit test. --- .../AsyncReaderWriterResourceLockTests.cs | 84 +++++++++++++++++-- 1 file changed, 77 insertions(+), 7 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs index d250161a5..6e2b28336 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs @@ -762,6 +762,31 @@ public async Task PreparationReservesLock() Assert.True(!preparationStartTask.Result.CanBeCanceled); } + [Fact] + public async Task PreparationReservesThrottlingScheduler() + { + var resourceTask = new TaskCompletionSource(); + + this.resourceLock.SetPreparationCallback( + this.resources[1], + (r, c) => + { + resourceTask.SetResult(TaskScheduler.Current); + return Task.CompletedTask; + }); + + var schedulerPair = new ConcurrentExclusiveSchedulerPair(TaskScheduler.Default, 2); + + await schedulerPair.ConcurrentScheduler.SwitchTo(); + + using (AsyncReaderWriterResourceLock.ResourceReleaser access = await this.resourceLock.ReadLockAsync()) + { + _ = await access.GetResourceAsync(1); + } + + Assert.Equal(schedulerPair.ConcurrentScheduler, await resourceTask.Task); + } + [Fact] public async Task PreparationResourceTaskCanBeCancelled() { @@ -1519,7 +1544,7 @@ private class ResourceLockWrapper : AsyncReaderWriterResourceLock { private readonly List resources; - private readonly Dictionary, Task>> preparationTasks = new Dictionary, Task>>(); + private readonly Dictionary preparationTasks = new Dictionary(); private readonly AsyncAutoResetEvent preparationTaskBegun = new AsyncAutoResetEvent(); @@ -1538,6 +1563,11 @@ internal ResourceLockWrapper(List resources, ITestOutputHelper logger, this.logger = logger; } + private interface IResourcePreparation + { + Task PrepareResourceAsync(Resource resource, CancellationToken cancellationToken); + } + internal AsyncAutoResetEvent PreparationTaskBegun { get { return this.preparationTaskBegun; } @@ -1553,12 +1583,20 @@ internal Task SetPreparationTask(Resource resource, Task task var tcs = new TaskCompletionSource(); lock (this.preparationTasks) { - this.preparationTasks[resource] = Tuple.Create(tcs, task); + this.preparationTasks[resource] = new ResourcePreparationState(tcs, task); } return tcs.Task; } + internal void SetPreparationCallback(Resource resource, Func callback) + { + lock (this.preparationTasks) + { + this.preparationTasks[resource] = new ResourcePreparationCallback(callback); + } + } + internal new void SetResourceAsAccessed(Resource resource) { base.SetResourceAsAccessed(resource); @@ -1615,22 +1653,54 @@ private async Task GetPreparationTask(Resource resource, CancellationToken cance Assert.True(this.IsWriteLockHeld || !this.IsAnyLockHeld); Assert.False(Monitor.IsEntered(this.SyncObject)); - Tuple, Task>? tuple; + IResourcePreparation? resourcePreparation; lock (this.preparationTasks) { - if (this.preparationTasks.TryGetValue(resource, out tuple)) + if (this.preparationTasks.TryGetValue(resource, out resourcePreparation)) { this.preparationTasks.Remove(resource); // consume task } } - if (tuple is object) + if (resourcePreparation is object) { - tuple.Item1.SetResult(cancellationToken); // signal that the preparation method has been entered - await tuple.Item2; + await resourcePreparation.PrepareResourceAsync(resource, cancellationToken); } Assert.True(this.IsWriteLockHeld || !this.IsAnyLockHeld); } + + private class ResourcePreparationState : IResourcePreparation + { + private readonly TaskCompletionSource preparationStart; + private readonly Task preparationTask; + + public ResourcePreparationState(TaskCompletionSource preparationStart, Task preparationTask) + { + this.preparationStart = preparationStart; + this.preparationTask = preparationTask; + } + + public Task PrepareResourceAsync(Resource resource, CancellationToken cancellationToken) + { + this.preparationStart.SetResult(cancellationToken); // signal that the preparation method has been entered + return this.preparationTask; + } + } + + private class ResourcePreparationCallback : IResourcePreparation + { + private readonly Func callback; + + public ResourcePreparationCallback(Func callback) + { + this.callback = callback; + } + + public Task PrepareResourceAsync(Resource resource, CancellationToken cancellationToken) + { + return this.callback(resource, cancellationToken); + } + } } } From 34f1344df70ea081e1875a83bf852c7bc4709954 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Feb 2023 09:28:14 -0700 Subject: [PATCH 0710/1753] Add msbuild extension for VS Code --- .vscode/extensions.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 4ca016163..ca3a2aa9d 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -11,7 +11,8 @@ "davidanson.vscode-markdownlint", "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", - "ms-azuretools.vscode-docker" + "ms-azuretools.vscode-docker", + "tintoy.msbuild-project-tools" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. "unwantedRecommendations": [] From fb2395d9a7cc483f5f1a37a82b104fde93883b34 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Feb 2023 09:46:58 -0700 Subject: [PATCH 0711/1753] Add dotnet CLI tools --- .config/dotnet-tools.json | 18 ++++++++++++++++++ init.ps1 | 5 +++++ 2 files changed, 23 insertions(+) create mode 100644 .config/dotnet-tools.json diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 000000000..2599e26ad --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,18 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "powershell": { + "version": "7.3.3", + "commands": [ + "pwsh" + ] + }, + "dotnet-format": { + "version": "5.1.250801", + "commands": [ + "dotnet-format" + ] + } + } +} \ No newline at end of file diff --git a/init.ps1 b/init.ps1 index ad3b4145c..5bace1e62 100755 --- a/init.ps1 +++ b/init.ps1 @@ -91,6 +91,11 @@ try { if ($lastexitcode -ne 0) { throw "Failure while restoring packages." } + + dotnet tool restore @RestoreArguments + if ($lastexitcode -ne 0) { + throw "Failure while restoring dotnet CLI tools." + } } & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars -PrependPath $PrependPath | Out-Null From 0bfecd61cceeeb70cbe038c00fd8aac38b7ce32e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Feb 2023 15:23:55 -0700 Subject: [PATCH 0712/1753] Drop test-tools as a nuget feed source We don't need it now that we're using stable Microsoft.CodeCoverage package versions. --- nuget.config | 9 --------- 1 file changed, 9 deletions(-) diff --git a/nuget.config b/nuget.config index 6ce7cfd05..22f7b8098 100644 --- a/nuget.config +++ b/nuget.config @@ -7,18 +7,9 @@ - - - - - - - - - From 00d95df58e51bbee9500ff17fff9b41354978433 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Feb 2023 15:32:56 -0700 Subject: [PATCH 0713/1753] Bump DNNE to 2.0.0 --- Directory.Packages.props | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 07493f646..ccead37bd 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -3,7 +3,6 @@ true true - 2.0.112 3.11.0 4.4.0 @@ -11,7 +10,7 @@ 2.3.405501 - + @@ -55,4 +54,4 @@ - + \ No newline at end of file From a2e5072684449a9cd90380edc97175a28b7b1a54 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 27 Feb 2023 14:43:43 -0800 Subject: [PATCH 0714/1753] Update test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs Co-authored-by: Andrew Arnott --- .../AsyncReaderWriterResourceLockTests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs index 6e2b28336..286e4a45c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs @@ -763,7 +763,7 @@ public async Task PreparationReservesLock() } [Fact] - public async Task PreparationReservesThrottlingScheduler() + public async Task PreparationPreservesThrottlingScheduler() { var resourceTask = new TaskCompletionSource(); From 81fccf20e373f07d5ff6f94fb33334bb35bbea0f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Feb 2023 15:44:04 -0700 Subject: [PATCH 0715/1753] Bump MicroBuild version --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 880aec415..a3769e310 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.112 + 2.0.113 From e2ed02143747f23559028b446ec94ce18cf2f2d8 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 27 Feb 2023 14:44:04 -0800 Subject: [PATCH 0716/1753] Update src/Microsoft.VisualStudio.Threading/InternalUtilities.cs Co-authored-by: Andrew Arnott --- src/Microsoft.VisualStudio.Threading/InternalUtilities.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs index f8049bad9..ab6150081 100644 --- a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs +++ b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs @@ -85,7 +85,7 @@ internal static IEnumerable GetAsyncReturnStackFrames(this Delegate cont stateMachine.GetType().FullName, state, AsyncReturnStackPrefix, - (long)GetAddress(stateMachine)); // the int cast allows hex formatting + (long)GetAddress(stateMachine)); // the long cast allows hex formatting Delegate[]? continuationDelegates = FindContinuationDelegates(stateMachine).ToArray(); if (continuationDelegates.Length == 0) From d4525181ccc5e6912945defe758ca92b9acfc23d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Feb 2023 15:58:49 -0700 Subject: [PATCH 0717/1753] Update more dependency versions --- Directory.Packages.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ccead37bd..c5ce78128 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -3,7 +3,7 @@ true true - 2.0.112 + 2.0.113 3.11.0 4.4.0 1.1.1 @@ -30,11 +30,11 @@ - + - + From a47420bdc55b79fbc1b8a2c6a9713695193b4628 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 28 Feb 2023 11:48:02 -0800 Subject: [PATCH 0718/1753] Add a virtual method to compute TaskScheduler. --- .../AsyncReaderWriterResourceLock`2.cs | 12 +++++++++++- .../net6.0-windows/PublicAPI.Unshipped.txt | 1 + .../AsyncReaderWriterResourceLockTests.cs | 5 +++++ 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs index 49e66e998..42cbbd914 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterResourceLock`2.cs @@ -213,6 +213,16 @@ protected void SetAllResourcesToUnknownState() return (LockFlags)base.GetAggregateLockFlags(); } + /// + /// Gets a task scheduler to prepare a resource for concurrent access. + /// + /// The resource to prepare. + /// A . + protected virtual TaskScheduler GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource resource) + { + return TaskScheduler.Default; + } + /// /// Prepares a resource for concurrent access. /// @@ -769,7 +779,7 @@ private Task PrepareResourceAsync(TResource resource, CancellationToken cancella AsyncReaderWriterResourceLock.Helper.ResourceState finalState = forConcurrentUse ? ResourceState.Concurrent : ResourceState.Exclusive; Task? preparationTask = null; - TaskScheduler taskScheduler = TaskScheduler.Current.MaximumConcurrencyLevel > 1 ? TaskScheduler.Current : TaskScheduler.Default; + TaskScheduler taskScheduler = this.service.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(resource); if (!this.resourcePreparationStates.TryGetValue(resource, out ResourcePreparationTaskState? preparationState)) { diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index e69de29bb..6fe70cc92 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs index 6e2b28336..b2b4c0546 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs @@ -1617,6 +1617,11 @@ protected override Task GetResourceAsync(int resourceMoniker, Cancella return Task.FromResult(this.resources[resourceMoniker]); } + protected override TaskScheduler GetTaskSchedulerToPrepareResourcesForConcurrentAccess(Resource resource) + { + return TaskScheduler.Current.MaximumConcurrencyLevel > 1 ? TaskScheduler.Current : TaskScheduler.Default; + } + protected override async Task PrepareResourceForConcurrentAccessAsync(Resource resource, CancellationToken cancellationToken) { cancellationToken.ThrowIfCancellationRequested(); From cf594560a1421c941f6882074357d06470c40ed4 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 28 Feb 2023 11:51:24 -0800 Subject: [PATCH 0719/1753] Update unit test name. --- .../AsyncReaderWriterResourceLockTests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs index b9ab7ed35..8a6dc242a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs @@ -763,7 +763,7 @@ public async Task PreparationReservesLock() } [Fact] - public async Task PreparationPreservesThrottlingScheduler() + public async Task LockServiceMayPreservesThrottlingScheduler() { var resourceTask = new TaskCompletionSource(); From c88393b9045e620d19880b6e4f61316376ed993e Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 28 Feb 2023 14:01:59 -0800 Subject: [PATCH 0720/1753] Update public API for other target frameworks. --- .../net472/PublicAPI.Unshipped.txt | 1 + .../net6.0/PublicAPI.Unshipped.txt | 1 + .../netstandard2.0/PublicAPI.Unshipped.txt | 1 + 3 files changed, 3 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index e69de29bb..6fe70cc92 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index e69de29bb..6fe70cc92 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index e69de29bb..6fe70cc92 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! \ No newline at end of file From 2f9e9dfe464e2e5b5b7ebddc0997ae70d11e11d9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 28 Feb 2023 21:06:24 -0700 Subject: [PATCH 0721/1753] Add ability to serialize a `JoinableTask` across multiple `JoinableTaskContext` objects and processes --- Directory.Packages.props | 1 + .../JoinableTask.cs | 115 ++++++++- .../JoinableTaskContext.cs | 189 ++++++++++++++- .../JoinableTaskFactory.cs | 193 ++++++---------- .../JoinableTask`1.cs | 13 +- .../net472/PublicAPI.Unshipped.txt | 3 + .../net6.0-windows/PublicAPI.Unshipped.txt | 3 + .../net6.0/PublicAPI.Unshipped.txt | 3 + .../netstandard2.0/PublicAPI.Unshipped.txt | 3 + .../JoinableTaskTokenTests.cs | 218 ++++++++++++++++++ 10 files changed, 612 insertions(+), 129 deletions(-) create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs diff --git a/Directory.Packages.props b/Directory.Packages.props index 24ab59f63..25da1daaf 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -48,6 +48,7 @@ + diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index ae03d95d0..703c35323 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -43,6 +43,15 @@ public partial class JoinableTask : IJoinableTaskDependent [DebuggerBrowsable(DebuggerBrowsableState.Never)] private readonly JoinableTaskCreationOptions creationOptions; + /// + /// The serializable token associated with this particular . + /// + /// + /// This will be created when the was created with a parent token + /// or lazily created when this needs to be serialized. + /// + private SerializableToken? token; + /// /// Other instances of that should be posted /// to with any main thread bound work. @@ -125,9 +134,10 @@ public partial class JoinableTask : IJoinableTaskDependent /// /// The instance that began the async operation. /// A value indicating whether the launching thread will synchronously block for this job's completion. + /// An optional token that identifies one or more instances, typically in other processes, that serve as 'parents' to this one. /// The used to customize the task's behavior. /// The entry method's info for diagnostics. - internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate initialDelegate) + internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, string? parentToken, JoinableTaskCreationOptions creationOptions, Delegate initialDelegate) { Requires.NotNull(owner, nameof(owner)); @@ -147,6 +157,7 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, Joi } this.creationOptions = creationOptions; + this.token = SerializableToken.From(parentToken, this); this.owner.Context.OnJoinableTaskStarted(this); this.initialDelegate = initialDelegate; } @@ -654,6 +665,32 @@ void IJoinableTaskDependent.OnDependencyRemoved(IJoinableTaskDependent joinChild { } + /// + /// Gets the full token that should be serialized when this owns the context to be shared. + /// + /// The token; or when this task is already completed. + internal string? GetSerializableToken() + { + if (this.token is null && !this.IsCompleteRequested) + { + using (this.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.JoinableTaskContext.SyncContextLock) + { + this.token ??= SerializableToken.New(this); + } + } + } + + return this.token?.ToString(); + } + + /// + /// Looks up the that serves as this instance's parent due to the token provided when this was created. + /// + /// A task; or if no parent token was provided at construction time or no match was found (possibly due to the parent having already completed). + internal JoinableTask? GetTokenizedParent() => this.JoinableTaskContext.Lookup(this.token?.ParentToken); + /// /// Gets a very likely value whether the main thread is blocked by this . /// @@ -891,6 +928,10 @@ internal void Complete(Task wrappedTask) if (!this.IsCompleteRequested) { this.IsCompleteRequested = true; + if (this.token?.TaskId is ulong taskId) + { + this.JoinableTaskContext.RemoveSerializableIdentifier(taskId); + } if (this.mainThreadQueue is object) { @@ -1243,4 +1284,76 @@ private void AddStateFlags(JoinableTaskFlags flags) } } } + + private class SerializableToken + { + private readonly JoinableTask owner; + private ulong? taskId; + private string? fullToken; + + private SerializableToken(JoinableTask owner) + { + this.owner = owner; + } + + /// + /// Gets the original token provided by the remote parent task. + /// + internal string? ParentToken { get; init; } + + /// + /// Gets the unique ID that identifies the owning in the dictionary. + /// + internal ulong? TaskId + { + get + { + if (this.taskId is null && !this.owner.IsCompleteRequested) + { + using (this.owner.JoinableTaskContext.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.owner.JoinableTaskContext.SyncContextLock) + { + if (this.taskId is null && !this.owner.IsCompleteRequested) + { + this.taskId = this.owner.JoinableTaskContext.AssignUniqueIdentifier(this.owner); + } + } + } + } + + return this.owner.IsCompleteRequested ? null : this.taskId; + } + } + + /// + /// Serializes this token as a string. + /// + /// A string that identifies the owner and retains information about its parents, if any. May be if the owning task has already completed. + public override string? ToString() + { + if (this.fullToken is null && this.TaskId is ulong taskId) + { + this.fullToken = this.owner.JoinableTaskContext.ConstructFullToken(taskId, this.ParentToken); + } + + return this.owner.IsCompleteRequested ? null : this.fullToken; + } + + /// + /// Creates a when a parent token is provided. + /// + /// The parent token, if any. + /// The owning task. + /// The token, if any is required. + [return: NotNullIfNotNull(nameof(parentToken))] + internal static SerializableToken? From(string? parentToken, JoinableTask owner) => parentToken is null ? null : new SerializableToken(owner) { ParentToken = parentToken }; + + /// + /// Creates a for a given if it has not yet completed. + /// + /// The owning task. + /// A token, if the task has not yet completed; otherwise . + internal static SerializableToken? New(JoinableTask owner) => owner.IsCompleteRequested ? null : new SerializableToken(owner); + } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 318fc01ac..e2ea752fe 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -2,17 +2,16 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Concurrent; using System.Collections.Generic; -using System.Collections.Specialized; using System.Diagnostics; +using System.Globalization; using System.Linq; using System.Reflection; -using System.Runtime.CompilerServices; +using System.Text; using System.Threading; using System.Threading.Tasks; +using static System.FormattableString; using JoinableTaskSynchronizationContext = Microsoft.VisualStudio.Threading.JoinableTask.JoinableTaskSynchronizationContext; -using SingleExecuteProtector = Microsoft.VisualStudio.Threading.JoinableTaskFactory.SingleExecuteProtector; namespace Microsoft.VisualStudio.Threading; @@ -66,6 +65,14 @@ namespace Microsoft.VisualStudio.Threading; /// public partial class JoinableTaskContext : IDisposable { + /// + /// The expected length of the serialized task ID. + /// + /// + /// This value is the length required to hex-encode a 64-bit integer. We use for task IDs, so this is appropriate. + /// + private const int TaskIdHexLength = 16; + /// /// A "global" lock that allows the graph of interconnected sync context and JoinableSet instances /// communicate in a thread-safe way without fear of deadlocks due to each taking their own private @@ -116,6 +123,24 @@ public partial class JoinableTaskContext : IDisposable /// private readonly int mainThreadManagedThreadId; + /// + /// A dictionary of incomplete objects for which serializable identifiers have been requested. + /// + /// + /// Only access this while locking . + /// + private readonly Dictionary serializedTasks = new(); + + /// + /// A unique instance ID that is used when creating IDs for JoinableTasks that come from this instance. + /// + private readonly string contextId = Guid.NewGuid().ToString("n"); + + /// + /// The next unique ID to assign to a for which a token is required. + /// + private ulong nextTaskId = 1; + /// /// The count of s blocking the main thread. /// @@ -385,6 +410,18 @@ public JoinableTaskCollection CreateCollection() return new JoinableTaskCollection(this); } + /// + /// Captures the caller's context and serializes it as a string + /// that is suitable for application via a subsequent call to . + /// + /// A string that represent the current context, or if there is none. + /// + /// To optimize calling patterns, this method returns even when inside a context + /// when this was initialized without a , which means no main thread exists + /// and thus there is no need to capture and reapply tokens. + /// + public string? Capture() => this.UnderlyingSynchronizationContext is null ? null : this.AmbientTask?.GetSerializableToken(); + /// public void Dispose() { @@ -500,6 +537,113 @@ internal void DecrementMainThreadBlockingCount() this.mainThreadBlockingJoinableTaskCount--; } + /// + /// Reserves a unique ID for the given and records the association in the table. + /// + /// The to associate with the new ID. + /// + /// An ID assignment that is unique for this . + /// It must be passed to when the task completes to avoid a memory leak. + /// + internal ulong AssignUniqueIdentifier(JoinableTask joinableTask) + { + // The caller must have entered this lock because it's required that it only do it while it has not completed + // so that we don't have a leak in our dictionary, since completion removes the id's from the dictionary. + Assumes.True(Monitor.IsEntered(this.SyncContextLock)); + ulong taskId = checked(this.nextTaskId++); + this.serializedTasks.Add(taskId, joinableTask); + return taskId; + } + + /// + /// Applies the result of a call to to the caller's context. + /// + /// The result of a prior call. + /// The task referenced by the parent token if it came from our context and is still running; otherwise . + internal JoinableTask? Lookup(string? parentToken) + { + if (parentToken is not null) + { +#if NET6_0_OR_GREATER + ReadOnlySpan taskIdChars = this.GetOurTaskId(parentToken); +#else + string taskIdChars = this.GetOurTaskId(parentToken.AsSpan()).ToString(); +#endif + if (ulong.TryParse(taskIdChars, NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture, out ulong taskId)) + { + using (this.NoMessagePumpSynchronizationContext.Apply()) + { + lock (this.SyncContextLock) + { + if (this.serializedTasks.TryGetValue(taskId, out JoinableTask? deserialized)) + { + return deserialized; + } + } + } + } + } + + return null; + } + + /// + /// Assembles a new token based on a parent token and the unique ID for some . + /// + /// The value previously obtained from . + /// The parent token the was created with, if any. + /// A token that may be serialized to recreate the dependency chain for this and its remote parents. + internal string ConstructFullToken(ulong taskId, string? parentToken) + { + const char ContextAndTaskSeparator = ':'; + if (parentToken is null) + { + return Invariant($"{this.contextId}{ContextAndTaskSeparator}{taskId:X16}"); + } + else + { + const char ContextSeparator = ';'; + + StringBuilder builder = new(parentToken.Length + 1 + this.contextId.Length + 1 + TaskIdHexLength); + builder.Append(parentToken); + + string taskIdString = taskId.ToString("X16", CultureInfo.InvariantCulture); + + // Replace our own contextual unique ID if it is found in the parent token. + int ownTaskIdIndex = this.FindOurTaskId(parentToken.AsSpan()); + if (ownTaskIdIndex < 0) + { + // Add our own task ID because we have no presence in the parent token already. + builder.Append(ContextSeparator); + builder.Append(this.contextId); + builder.Append(ContextAndTaskSeparator); + builder.Append(taskIdString); + } + else + { + // Replace our existing task ID that appears in the parent token. + builder.Remove(ownTaskIdIndex, TaskIdHexLength); + builder.Insert(ownTaskIdIndex, taskIdString); + } + + return builder.ToString(); + } + } + + /// + /// Removes an association between a and a unique ID that was generated for it + /// from the table. + /// + /// The value previously obtained from . + /// + /// This method must be called when a is completed to avoid a memory leak. + /// + internal void RemoveSerializableIdentifier(ulong taskId) + { + Assumes.True(Monitor.IsEntered(this.SyncContextLock)); + Assumes.True(this.serializedTasks.Remove(taskId)); + } + /// /// Invoked when a hang is suspected to have occurred involving the main thread. /// @@ -590,6 +734,43 @@ protected virtual void Dispose(bool disposing) { } + /// + /// Searches a parent token for a task ID that belongs to this instance. + /// + /// A parent token. + /// The 0-based index into the string where the context of the local task ID begins, if found; otherwise -1. + private int FindOurTaskId(ReadOnlySpan parentToken) + { + // Fetch the unique id for the JoinableTask that came from *this* context, if any. + int matchingContextIndex = parentToken.IndexOf(this.contextId.AsSpan(), StringComparison.Ordinal); + if (matchingContextIndex < 0) + { + return -1; + } + + // IMPORTANT: As the parent token frequently comes in over RPC, take care to never throw exceptions based on bad input + // as we're called on a critical scheduling callstack where an exception would lead to an Environment.FailFast call. + // To that end, only report that we found the task id if the remaining string is long enough to support it. + int uniqueIdStartIndex = matchingContextIndex + this.contextId.Length + 1; + if (parentToken.Length < uniqueIdStartIndex + TaskIdHexLength) + { + return -1; + } + + return uniqueIdStartIndex; + } + + /// + /// Gets the task ID that came from this that is carried in a given a parent token. + /// + /// A parent token. + /// The characters that formulate the task ID that originally came from this instance, if found; otherwise an empty span. + private ReadOnlySpan GetOurTaskId(ReadOnlySpan parentToken) + { + int index = this.FindOurTaskId(parentToken); + return index < 0 ? default : parentToken.Slice(index, TaskIdHexLength); + } + /// /// A structure that clears CallContext and SynchronizationContext async/thread statics and /// restores those values when this structure is disposed. diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 91b489790..c24f07553 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -203,62 +203,19 @@ protected SynchronizationContext? UnderlyingSynchronizationContext return new MainThreadAwaitable(this, this.Context.AmbientTask, cancellationToken, alwaysYield); } - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The asynchronous method to execute. - /// - /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// - /// - /// // On threadpool or Main thread, this method will block - /// // the calling thread until all async operations in the - /// // delegate complete. - /// joinableTaskFactory.Run(async delegate { - /// // still on the threadpool or Main thread as before. - /// await OperationAsync(); - /// // still on the threadpool or Main thread as before. - /// await Task.Run(async delegate { - /// // Now we're on a threadpool thread. - /// await Task.Yield(); - /// // still on a threadpool thread. - /// }); - /// // Now back on the Main thread (or threadpool thread if that's where we started). - /// }); - /// - /// - /// + /// public void Run(Func asyncMethod) { this.Run(asyncMethod, JoinableTaskCreationOptions.None, entrypointOverride: null); } - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The asynchronous method to execute. - /// The used to customize the task's behavior. + /// public void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions) { this.Run(asyncMethod, creationOptions, entrypointOverride: null); } - /// - /// Runs the specified asynchronous method to completion while synchronously blocking the calling thread. - /// - /// The type of value returned by the asynchronous operation. - /// The asynchronous method to execute. - /// The result of the Task returned by . - /// - /// Any exception thrown by the delegate is rethrown in its original type to the caller of this method. - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// See the overload documentation for an example. - /// + /// public T Run(Func> asyncMethod) { return this.Run(asyncMethod, JoinableTaskCreationOptions.None); @@ -276,92 +233,66 @@ public T Run(Func> asyncMethod) /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + /// + /// /// public T Run(Func> asyncMethod, JoinableTaskCreationOptions creationOptions) { VerifyNoNonConcurrentSyncContext(); - JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, creationOptions: creationOptions); + JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, parentToken: null, creationOptions: creationOptions); return joinable.CompleteOnCurrentThread(); } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The method that, when executed, will begin the async operation. - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// + /// public JoinableTask RunAsync(Func asyncMethod) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: JoinableTaskCreationOptions.None); + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken: null, creationOptions: JoinableTaskCreationOptions.None); } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The method that, when executed, will begin the async operation. - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// The used to customize the task's behavior. - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// + /// public JoinableTask RunAsync(Func asyncMethod, JoinableTaskCreationOptions creationOptions) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: creationOptions); + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken: null, creationOptions: creationOptions); } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The type of value returned by the asynchronous operation. - /// The method that, when executed, will begin the async operation. - /// - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// + /// + public JoinableTask RunAsync(Func asyncMethod, string? parentToken, JoinableTaskCreationOptions creationOptions) + { + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken, creationOptions: creationOptions); + } + + /// public JoinableTask RunAsync(Func> asyncMethod) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: JoinableTaskCreationOptions.None); + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken: null, creationOptions: JoinableTaskCreationOptions.None); } - /// - /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. - /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method - /// requires the main thread while the main thread is blocked waiting for the async method's completion. - /// - /// The type of value returned by the asynchronous operation. - /// The method that, when executed, will begin the async operation. - /// The used to customize the task's behavior. - /// - /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. - /// - /// - /// Exceptions thrown by the delegate are captured by the returned . - /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context - /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution - /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. - /// + /// public JoinableTask RunAsync(Func> asyncMethod, JoinableTaskCreationOptions creationOptions) { - return this.RunAsync(asyncMethod, synchronouslyBlocking: false, creationOptions: creationOptions); + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken: null, creationOptions: creationOptions); + } + + /// + public JoinableTask RunAsync(Func> asyncMethod, string? parentToken, JoinableTaskCreationOptions creationOptions) + { + return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken, creationOptions: creationOptions); } /// @@ -394,6 +325,7 @@ internal SingleExecuteProtector RequestSwitchToMainThread(Action callback) return Task.CompletedTask; }, synchronouslyBlocking: false, + parentToken: null, creationOptions: JoinableTaskCreationOptions.None, entrypointOverride: callback); @@ -438,7 +370,7 @@ internal void PostToUnderlyingSynchronizationContextOrThreadPool(SingleExecutePr internal void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride) { VerifyNoNonConcurrentSyncContext(); - JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, creationOptions: creationOptions, entrypointOverride: entrypointOverride); + JoinableTask? joinable = this.RunAsync(asyncMethod, synchronouslyBlocking: true, parentToken: null, creationOptions, entrypointOverride); joinable.CompleteOnCurrentThread(); } @@ -674,23 +606,43 @@ private static void VerifyNoNonConcurrentSyncContext() /// synchronously completed (waited on) in the future. /// /// The asynchronous method to execute. - /// A value indicating whether the launching thread will synchronously block for this job's completion. - /// The used to customize the task's behavior. + /// + /// + /// /// The entry method's info for diagnostics. - private JoinableTask RunAsync(Func asyncMethod, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride = null) + private JoinableTask RunAsync(Func asyncMethod, bool synchronouslyBlocking, string? parentToken, JoinableTaskCreationOptions creationOptions, Delegate? entrypointOverride = null) { Requires.NotNull(asyncMethod, nameof(asyncMethod)); - var job = new JoinableTask(this, synchronouslyBlocking, creationOptions, entrypointOverride ?? asyncMethod); + var job = new JoinableTask(this, synchronouslyBlocking, parentToken, creationOptions, entrypointOverride ?? asyncMethod); this.ExecuteJob(asyncMethod, job); return job; } - private JoinableTask RunAsync(Func> asyncMethod, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions) + /// + /// Invokes an async delegate on the caller's thread, and yields back to the caller when the async method yields. + /// The async delegate is invoked in such a way as to mitigate deadlocks in the event that the async method + /// requires the main thread while the main thread is blocked waiting for the async method's completion. + /// + /// The type of value returned by the asynchronous operation. + /// The method that, when executed, will begin the async operation. + /// A value indicating whether the caller is synchronously blocking. + /// An optional token that identifies one or more instances, typically in other processes, that serve as 'parents' to this one. + /// The used to customize the task's behavior. + /// + /// An object that tracks the completion of the async operation, and allows for later synchronous blocking of the main thread for completion if necessary. + /// + /// + /// Exceptions thrown by the delegate are captured by the returned . + /// When the delegate resumes from a yielding await, the default behavior is to resume in its original context + /// as an ordinary async method execution would. For example, if the caller was on the main thread, execution + /// resumes after an await on the main thread; but if it started on a threadpool thread it resumes on a threadpool thread. + /// + private JoinableTask RunAsync(Func> asyncMethod, bool synchronouslyBlocking, string? parentToken, JoinableTaskCreationOptions creationOptions) { Requires.NotNull(asyncMethod, nameof(asyncMethod)); - var job = new JoinableTask(this, synchronouslyBlocking, creationOptions, asyncMethod); + var job = new JoinableTask(this, synchronouslyBlocking, parentToken, creationOptions, asyncMethod); this.ExecuteJob(asyncMethod, job); return job; } @@ -1049,6 +1001,11 @@ internal RunFramework(JoinableTaskFactory factory, JoinableTask joinable) this.joinable.NestingFactories = nestingFactories; } + + if (joinable.GetTokenizedParent() is JoinableTask tokenizedParent) + { + JoinableTaskDependencyGraph.AddDependency(tokenizedParent, joinable); + } } /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index caa99dba3..1ebead4ee 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -27,12 +27,13 @@ public class JoinableTask : JoinableTask /// /// Initializes a new instance of the class. /// - /// The instance that began the async operation. - /// A value indicating whether the launching thread will synchronously block for this job's completion. - /// The used to customize the task's behavior. - /// The entry method's info for diagnostics. - internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, JoinableTaskCreationOptions creationOptions, Delegate initialDelegate) - : base(owner, synchronouslyBlocking, creationOptions, initialDelegate) + /// + /// + /// + /// + /// + internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, string? parentToken, JoinableTaskCreationOptions creationOptions, Delegate initialDelegate) + : base(owner, synchronouslyBlocking, parentToken, creationOptions, initialDelegate) { } diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index e69de29bb..df9e7698e 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -0,0 +1,3 @@ +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index e69de29bb..df9e7698e 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -0,0 +1,3 @@ +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index e69de29bb..df9e7698e 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -0,0 +1,3 @@ +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index e69de29bb..df9e7698e 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -0,0 +1,3 @@ +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs new file mode 100644 index 000000000..25c078496 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs @@ -0,0 +1,218 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.VisualStudio.Threading; +using Xunit; +using Xunit.Abstractions; + +public class JoinableTaskTokenTests : JoinableTaskTestBase +{ + public JoinableTaskTokenTests(ITestOutputHelper logger) + : base(logger) + { + } + + [Fact] + public void Capture_NoContext() + { + Assert.Null(this.context.Capture()); + } + + [Fact] + public void Capture_InsideRunContext() + { + string? token = null; + this.asyncPump.Run(delegate + { + token = this.context.Capture(); + return Task.CompletedTask; + }); + Assert.NotNull(token); + this.Logger.WriteLine($"Token {token}"); + } + + [Fact] + public void Capture_InsideRunContextWithoutSyncContext() + { + SynchronizationContext.SetSynchronizationContext(null); + JoinableTaskContext asyncPump = new(); + asyncPump.Factory.Run(delegate + { + Assert.Null(asyncPump.Capture()); + return Task.CompletedTask; + }); + } + + [Fact] + public void Capture_InheritsFromParent() + { + const string UnknownParent = "97f67c3ce2c74dc6bdb1d8a58edb9176:13"; + string? token = null; + this.asyncPump.RunAsync( + delegate + { + token = this.context.Capture(); + return Task.CompletedTask; + }, + UnknownParent, + JoinableTaskCreationOptions.None).Join(); + Assert.NotNull(token); + this.Logger.WriteLine($"Token {token}"); + Assert.Contains(UnknownParent, token); + Assert.True(token.Length > UnknownParent.Length); + } + + [Fact] + public void Capture_ReplacesParent() + { + AsyncManualResetEvent unblockParent = new(); + string? parentToken = null; + JoinableTask parent = this.asyncPump.RunAsync( + async delegate + { + parentToken = this.context.Capture(); + await unblockParent; + }); + Assert.NotNull(parentToken); + this.Logger.WriteLine($"Parent: {parentToken}"); + + string? childToken = null; + this.asyncPump.RunAsync( + delegate + { + childToken = this.context.Capture(); + unblockParent.Set(); + return Task.CompletedTask; + }, + parentToken, + JoinableTaskCreationOptions.None).Join(); + Assert.NotNull(childToken); + this.Logger.WriteLine($"Child: {childToken}"); + + // Assert that the child token *replaced* the parent token since they both came from the same context. + Assert.Equal(parentToken.Length, childToken.Length); + Assert.NotEqual(parentToken, childToken); + } + + [Fact] + public void RunAsync_AfterParentCompletes() + { + string? token = null; + this.asyncPump.Run(delegate + { + token = this.context.Capture(); + return Task.CompletedTask; + }); + Assert.NotNull(token); + this.Logger.WriteLine($"Token: {token}"); + + this.asyncPump.RunAsync( + () => Task.CompletedTask, + token, + JoinableTaskCreationOptions.None).Join(); + } + + [Theory, PairwiseData] + public async Task RunAsync_AvoidsDeadlockWithParent(bool includeOtherContexts) + { + string? parentToken = includeOtherContexts ? "abc:dead;ghi:coffee" : null; + TaskCompletionSource tokenSource = new(); + AsyncManualResetEvent releaseOuterTask = new(); + + JoinableTask outerTask = this.asyncPump.RunAsync( + async delegate + { + try + { + tokenSource.SetResult(this.context.Capture()); + await releaseOuterTask; + } + catch (Exception ex) + { + tokenSource.SetException(ex); + } + }, + parentToken, + JoinableTaskCreationOptions.None); + + string? token = await tokenSource.Task; + Assert.NotNull(token); + this.Logger.WriteLine($"Token: {token}"); + if (parentToken is not null) + { + Assert.Contains(parentToken, token); + token += ";even=feed"; + this.Logger.WriteLine($"Token (modified): {token}"); + } + + JoinableTask innerTask = this.asyncPump.RunAsync( + async delegate + { + await Task.Yield(); + releaseOuterTask.Set(); + }, + token, + JoinableTaskCreationOptions.None); + + // Sync block the main thread using the outer task. + // No discernable dependency chain exists from outer to inner task, + // yet one subtly exists. Only the serialized context should allow inner + // to complete and thus unblock outer and avoid a deadlock. + outerTask.Join(this.TimeoutToken); + } + + [Theory, PairwiseData] + public async Task RunAsyncOfT_AvoidsDeadlockWithParent(bool includeOtherContexts) + { + string? parentToken = includeOtherContexts ? "abc:dead;ghi:coffee" : null; + TaskCompletionSource tokenSource = new(); + AsyncManualResetEvent releaseOuterTask = new(); + + JoinableTask outerTask = this.asyncPump.RunAsync( + async delegate + { + try + { + tokenSource.SetResult(this.context.Capture()); + await releaseOuterTask; + } + catch (Exception ex) + { + tokenSource.SetException(ex); + } + + return true; + }, + parentToken, + JoinableTaskCreationOptions.None); + + string? token = await tokenSource.Task; + Assert.NotNull(token); + this.Logger.WriteLine($"Token: {token}"); + if (parentToken is not null) + { + Assert.Contains(parentToken, token); + token += ";even=feed"; + this.Logger.WriteLine($"Token (modified): {token}"); + } + + JoinableTask innerTask = this.asyncPump.RunAsync( + async delegate + { + await Task.Yield(); + releaseOuterTask.Set(); + return true; + }, + token, + JoinableTaskCreationOptions.None); + + // Sync block the main thread using the outer task. + // No discernable dependency chain exists from outer to inner task, + // yet one subtly exists. Only the serialized context should allow inner + // to complete and thus unblock outer and avoid a deadlock. + outerTask.Join(this.TimeoutToken); + } +} From a4933921ab1b95ee514db2a9be61e41e5cf8d007 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Mar 2023 10:06:21 -0700 Subject: [PATCH 0722/1753] Update DNNE to 2.0.1 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d6ed94965..f93dc06c8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ 2.3.405501 - + From 0c53252e19f959f85758e757aa22261b42db0dbc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 Mar 2023 10:20:49 -0700 Subject: [PATCH 0723/1753] Bump Microsoft.Diagnostics.Runtime to 2.4.412801 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index f93dc06c8..2aeac24a5 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ 3.11.0 4.4.0 1.1.1 - 2.3.405501 + 2.4.412801 From 3eb1436057301cf295b4a895fa2e2d5fe87339c1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 10 Mar 2023 08:32:03 -0700 Subject: [PATCH 0724/1753] Bump MicroBuildVersion to 2.0.115 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index a3769e310..62d2ccc07 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.113 + 2.0.115 From 5132c2206f248cc3ff0e65c0a087a74b6d734d77 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Mar 2023 16:30:55 -0700 Subject: [PATCH 0725/1753] Add ASP.NET Core runtime installation support --- tools/Install-DotNetSdk.ps1 | 59 ++++++++++++++++++++++++++++++++++--- 1 file changed, 55 insertions(+), 4 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 39e47eb60..6bff5c278 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -19,13 +19,16 @@ Skips installing the runtime. .PARAMETER IncludeX86 Installs a x86 SDK and runtimes in addition to the x64 ones. Only supported on Windows. Ignored on others. +.PARAMETER IncludeAspNetCore + Installs the ASP.NET Core runtime along with the .NET runtime. #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] Param ( [ValidateSet('repo','user','machine')] [string]$InstallLocality='user', [switch]$SdkOnly, - [switch]$IncludeX86 + [switch]$IncludeX86, + [switch]$IncludeAspNetCore ) $DotNetInstallScriptRoot = "$PSScriptRoot/../obj/tools" @@ -49,6 +52,7 @@ if (!$arch) { # Windows Powershell leaves this blank # Search for all .NET runtime versions referenced from MSBuild projects and arrange to install them. $runtimeVersions = @() $windowsDesktopRuntimeVersions = @() +$aspnetRuntimeVersions = @() if (!$SdkOnly) { Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { $projXml = [xml](Get-Content -Path $_) @@ -65,6 +69,7 @@ if (!$SdkOnly) { $targetFrameworks |? { $_ -match 'net(?:coreapp)?(\d+\.\d+)' } |% { $v = $Matches[1] $runtimeVersions += $v + $aspnetRuntimeVersions += $v if ($v -ge '3.0' -and -not ($IsMacOS -or $IsLinux)) { $windowsDesktopRuntimeVersions += $v } @@ -74,6 +79,7 @@ if (!$SdkOnly) { $targetFrameworks |? { $_ -match 'net(\d+\.\d+)' } |% { $v = $Matches[1] $runtimeVersions += $v + $aspnetRuntimeVersions += $v if (-not ($IsMacOS -or $IsLinux)) { $windowsDesktopRuntimeVersions += $v } @@ -81,6 +87,10 @@ if (!$SdkOnly) { } } +if (!$IncludeAspNetCore) { + $aspnetRuntimeVersions = @() +} + Function Get-FileFromWeb([Uri]$Uri, $OutDir) { $OutFile = Join-Path $OutDir $Uri.Segments[-1] if (!(Test-Path $OutFile)) { @@ -149,7 +159,7 @@ Function Get-InstallerExe( } } -Function Install-DotNet($Version, $Architecture, [ValidateSet('Sdk','Runtime','WindowsDesktop')][string]$sku = 'Sdk') { +Function Install-DotNet($Version, $Architecture, [ValidateSet('Sdk','Runtime','WindowsDesktop','AspNetCore')][string]$sku = 'Sdk') { Write-Host "Downloading .NET $sku $Version..." $Installer = Get-InstallerExe -Version $Version -Architecture $Architecture -sku $sku Write-Host "Installing .NET $sku $Version..." @@ -206,6 +216,17 @@ if ($InstallLocality -eq 'machine') { } } + $aspnetRuntimeVersions | Sort-Object | Get-Unique |% { + if ($PSCmdlet.ShouldProcess("ASP.NET Core $_", "Install")) { + Install-DotNet -Version $_ -sku AspNetCore -Architecture $arch + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + + if ($IncludeX86) { + Install-DotNet -Version $_ -sku AspNetCore -Architecture x86 + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } + } + } if ($restartRequired) { Write-Host -ForegroundColor Yellow "System restart required" Exit 3010 @@ -244,10 +265,10 @@ if ($IncludeX86) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/88bd34f089b8a023e3523f22c92abd0ab88e4409/src/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/0b09de9bc136cacb5f849a6957ebd4062173c148/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/88bd34f089b8a023e3523f22c92abd0ab88e4409/src/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/0b09de9bc136cacb5f849a6957ebd4062173c148/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } @@ -352,6 +373,36 @@ $windowsDesktopRuntimeVersions | Sort-Object -Unique |% { } } +$aspnetRuntimeSwitches = $switches + '-Runtime','aspnetcore' + +$aspnetRuntimeVersions | Sort-Object -Unique |% { + if ($PSCmdlet.ShouldProcess(".NET ASP.NET Core $arch runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $aspnetRuntimeSwitches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture $arch -InstallDir $DotNetInstallDir $aspnetRuntimeSwitches -DryRun" + } + + if ($IncludeX86) { + if ($PSCmdlet.ShouldProcess(".NET ASP.NET Core x86 runtime $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $aspnetRuntimeSwitches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Channel $_ -Architecture x86 -InstallDir $DotNetX86InstallDir $aspnetRuntimeSwitches -DryRun" + } + } +} + if ($PSCmdlet.ShouldProcess("Set DOTNET environment variables to discover these installed runtimes?")) { & "$PSScriptRoot/Set-EnvVars.ps1" -Variables $envVars -PrependPath $DotNetInstallDir | Out-Null } From a921f8dcaf0ba4f93dfec660f503d17ce19d58ea Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Mar 2023 16:40:50 -0700 Subject: [PATCH 0726/1753] Drop Microsoft.CodeCoverage reference It's brought in via Microsoft.NET.Test.Sdk anyway. --- Directory.Packages.props | 1 - test/Library.Tests/Library.Tests.csproj | 1 - 2 files changed, 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b792f3f6b..b523e5c63 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,6 @@ true - diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index d557e4c72..3a6cc044c 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -10,7 +10,6 @@ - From ea48c8eaa182f224ca3ed1a38f2a8034d15dacce Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Mar 2023 15:27:56 -0600 Subject: [PATCH 0727/1753] Updated SDK installer script to be able to find 7.0.200 --- tools/Install-DotNetSdk.ps1 | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 6bff5c278..10af50411 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -137,6 +137,14 @@ Function Get-InstallerExe( if ($release.$sku.version -eq $Version) { $filesElement = $release.$sku.files } + if (!$filesElement -and ($sku -eq 'sdk') -and $release.sdks) { + foreach ($sdk in $release.sdks) { + if ($sdk.version -eq $Version) { + $filesElement = $sdk.files + break + } + } + } if ($filesElement) { foreach ($file in $filesElement) { @@ -155,7 +163,7 @@ Function Get-InstallerExe( if ($url) { Get-FileFromWeb -Uri $url -OutDir $DotNetInstallScriptRoot } else { - Write-Error "Unable to find release of $sku v$Version" + throw "Unable to find release of $sku v$Version" } } From 2987b4457b0242e91913e9d9f4b43b5db079fd50 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Mar 2023 15:31:46 -0600 Subject: [PATCH 0728/1753] Bump SDK version to 7.0.201 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index cc08211e2..cf9eefa6e 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.101", + "version": "7.0.201", "rollForward": "patch", "allowPrerelease": false } From b47983de022de491725e8e9d4a27bb90166b9947 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Mar 2023 08:28:44 -0600 Subject: [PATCH 0729/1753] Update MicroBuild signing plugin version --- azure-pipelines/microbuild.before.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index d048af4bb..c933df239 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -9,7 +9,7 @@ steps: outputformat: text condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) -- task: MicroBuildSigningPlugin@3 +- task: MicroBuildSigningPlugin@4 inputs: signType: $(SignType) zipSources: false From cc3d33cdc22ea4eabd804623a60e750357abf541 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Mar 2023 17:51:13 -0600 Subject: [PATCH 0730/1753] Build stable version --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index 684628be0..d691a2761 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.6-alpha", + "version": "17.6", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 99df8185b1a6aa6abb1cc98aa7f4c0245f8d9012 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 28 Mar 2023 15:53:46 -0600 Subject: [PATCH 0731/1753] Move `dotnet-coverage` to repo-level tool --- .config/dotnet-tools.json | 8 ++++- azure-pipelines/Merge-CodeCoverage.ps1 | 46 +++++++++++++------------- 2 files changed, 30 insertions(+), 24 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 2599e26ad..610b59c97 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -13,6 +13,12 @@ "commands": [ "dotnet-format" ] + }, + "dotnet-coverage": { + "version": "17.6.11", + "commands": [ + "dotnet-coverage" + ] } } -} \ No newline at end of file +} diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 02ff12b00..5ecabbc9b 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -20,32 +20,32 @@ Param( ) $RepoRoot = [string](Resolve-Path $PSScriptRoot/..) - -if (!(Test-Path $RepoRoot/obj/dotnet-coverage*)) { - dotnet tool install --tool-path $RepoRoot/obj dotnet-coverage --version 17.4.3 --configfile $PSScriptRoot/justnugetorg.nuget.config -} - -Write-Verbose "Searching $Path for *.cobertura.xml files" -$reports = Get-ChildItem -Recurse $Path -Filter *.cobertura.xml - -if ($reports) { - $reports |% { $_.FullName } |% { - # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. - $xml = [xml](Get-Content -Path $_) - $xml.coverage.packages.package.classes.class |? { $_.filename} |% { - $_.filename = $_.filename.Replace('{reporoot}', $RepoRoot).Replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) +Push-Location $RepoRoot +try { + Write-Verbose "Searching $Path for *.cobertura.xml files" + $reports = Get-ChildItem -Recurse $Path -Filter *.cobertura.xml + + if ($reports) { + $reports |% { $_.FullName } |% { + # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. + $xml = [xml](Get-Content -Path $_) + $xml.coverage.packages.package.classes.class |? { $_.filename} |% { + $_.filename = $_.filename.Replace('{reporoot}', $RepoRoot).Replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) + } + + $xml.Save($_) } - $xml.Save($_) - } + $Inputs = $reports |% { Resolve-Path -relative $_.FullName } - $Inputs = $reports |% { Resolve-Path -relative $_.FullName } + if ((Split-Path $OutputFile) -and -not (Test-Path (Split-Path $OutputFile))) { + New-Item -Type Directory -Path (Split-Path $OutputFile) | Out-Null + } - if ((Split-Path $OutputFile) -and -not (Test-Path (Split-Path $OutputFile))) { - New-Item -Type Directory -Path (Split-Path $OutputFile) | Out-Null + & dotnet tool run dotnet-coverage merge $Inputs -o $OutputFile -f cobertura + } else { + Write-Error "No reports found to merge." } - - & "$RepoRoot/obj/dotnet-coverage" merge $Inputs -o $OutputFile -f cobertura -} else { - Write-Error "No reports found to merge." +} finally { + Pop-Location } From 14699417fbde409397e7efec56c1b33268ed3634 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 28 Mar 2023 15:58:33 -0600 Subject: [PATCH 0732/1753] Move `nbgv` into dotnet-tools.json --- .config/dotnet-tools.json | 6 ++++++ azure-pipelines/Get-nbgv.ps1 | 24 ------------------------ azure-pipelines/build.yml | 2 +- 3 files changed, 7 insertions(+), 25 deletions(-) delete mode 100644 azure-pipelines/Get-nbgv.ps1 diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 610b59c97..5d3dae876 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -19,6 +19,12 @@ "commands": [ "dotnet-coverage" ] + }, + "nbgv": { + "version": "3.5.119", + "commands": [ + "nbgv" + ] } } } diff --git a/azure-pipelines/Get-nbgv.ps1 b/azure-pipelines/Get-nbgv.ps1 deleted file mode 100644 index a5be2cf7c..000000000 --- a/azure-pipelines/Get-nbgv.ps1 +++ /dev/null @@ -1,24 +0,0 @@ -<# -.SYNOPSIS - Gets the path to the nbgv CLI tool, installing it if necessary. -#> -Param( -) - -$existingTool = Get-Command "nbgv" -ErrorAction SilentlyContinue -if ($existingTool) { - return $existingTool.Path -} - -$toolInstallDir = & "$PSScriptRoot/Get-TempToolsPath.ps1" - -$toolPath = "$toolInstallDir/nbgv" -if (!(Test-Path $toolInstallDir)) { New-Item -Path $toolInstallDir -ItemType Directory | Out-Null } - -if (!(Get-Command $toolPath -ErrorAction SilentlyContinue)) { - Write-Host "Installing nbgv to $toolInstallDir" - dotnet tool install --tool-path "$toolInstallDir" nbgv --configfile "$PSScriptRoot/justnugetorg.nuget.config" | Out-Null -} - -# Normalize the path on the way out. -return (Get-Command $toolPath).Path diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index c8687859b..2e2f426e0 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -17,7 +17,7 @@ jobs: clean: true - template: install-dependencies.yml - - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -c' + - script: dotnet tool run nbgv cloud -c displayName: ⚙ Set build number - template: dotnet.yml From 3f1e85823fac9136c058aaf48f4b8febed1d0843 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 28 Mar 2023 16:34:38 -0600 Subject: [PATCH 0733/1753] Install tools except when `-NoToolRestore` is specified --- init.ps1 | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/init.ps1 b/init.ps1 index 5bace1e62..6211304f8 100755 --- a/init.ps1 +++ b/init.ps1 @@ -28,6 +28,8 @@ No effect if -NoPrerequisites is specified. .PARAMETER NoRestore Skips the package restore step. +.PARAMETER NoToolRestore + Skips the dotnet tool restore step. .PARAMETER AccessToken An optional access token for authenticating to Azure Artifacts authenticated feeds. .PARAMETER Interactive @@ -46,6 +48,8 @@ Param ( [Parameter()] [switch]$NoRestore, [Parameter()] + [switch]$NoToolRestore, + [Parameter()] [string]$AccessToken, [Parameter()] [switch]$Interactive @@ -91,11 +95,13 @@ try { if ($lastexitcode -ne 0) { throw "Failure while restoring packages." } + } - dotnet tool restore @RestoreArguments - if ($lastexitcode -ne 0) { - throw "Failure while restoring dotnet CLI tools." - } + if (!$NoToolRestore -and $PSCmdlet.ShouldProcess("dotnet tool", "restore")) { + dotnet tool restore @RestoreArguments + if ($lastexitcode -ne 0) { + throw "Failure while restoring dotnet CLI tools." + } } & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars -PrependPath $PrependPath | Out-Null From 98e8ab00e59c27b786ef35db9b9751f01cf2781d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Mar 2023 17:42:04 -0600 Subject: [PATCH 0734/1753] Insert 17.6 into the VS servicing branch --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..559ce866d 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.6' From e6830a5e033c56cb9317abc549101b7f137cec36 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Mar 2023 17:42:27 -0600 Subject: [PATCH 0735/1753] Build 17.7-preview --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- version.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index 559ce866d..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.6' +'main' diff --git a/version.json b/version.json index d691a2761..25e4c41b3 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.6", + "version": "17.7-preview", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 0ab8cbce07a48cd5fc12a574369871eededcb174 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Apr 2023 13:17:35 -0600 Subject: [PATCH 0736/1753] Bump Microsoft.VisualStudio.Validation from 17.0.71 to 17.6.11 (#1172) Bumps [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) from 17.0.71 to 17.6.11. - [Release notes](https://github.com/microsoft/vs-validation/releases) - [Commits](https://github.com/microsoft/vs-validation/commits) --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Validation dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2aeac24a5..6d7222907 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -28,7 +28,7 @@ - + From 8ba38742fdc439b8ff55cac69b1e2e0ccd8f0cf5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 3 Apr 2023 13:41:57 -0600 Subject: [PATCH 0737/1753] Remove Get-NBGV.ps1 references --- azure-pipelines/Archive-SourceCode.ps1 | 2 +- azure-pipelines/archive-sourcecode.yml | 2 ++ azure-pipelines/variables/InsertVersionsValues.ps1 | 3 +-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index cfc30d2d2..0fec3e9b3 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -155,7 +155,7 @@ if (!$RepoUrl) { } Push-Location $PSScriptRoot -$versionsObj = & (& "$PSScriptRoot/Get-nbgv.ps1") get-version -f json | ConvertFrom-Json +$versionsObj = dotnet tool run nbgv get-version -f json | ConvertFrom-Json Pop-Location $ReleaseDateString = $ReleaseDate.ToShortDateString() diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 0c99a236b..33705a93d 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -34,6 +34,8 @@ steps: fetchDepth: 0 - powershell: tools/Install-DotNetSdk.ps1 displayName: ⚙ Install .NET SDK +- script: dotnet tool restore + displayName: Restore CLI tools - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: ⚙ Set pipeline variables based on source diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index 515e05716..c3a035590 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -4,7 +4,6 @@ # your libraries as defined in the src\ProductData\AssemblyVersions.tt file. return -$nbgv = & "$PSScriptRoot\..\Get-nbgv.ps1" [string]::join(',',(@{ - ('LibraryNoDotsVersion') = & { (& $nbgv get-version --project "$PSScriptRoot\..\..\src\LibraryName" --format json | ConvertFrom-Json).AssemblyVersion }; + ('LibraryNoDotsVersion') = & { (dotnet tool run nbgv get-version --project "$PSScriptRoot\..\..\src\LibraryName" --format json | ConvertFrom-Json).AssemblyVersion }; }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) From 705fdd89152e05b007d72fc9189d2759f07a411a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 6 Apr 2023 09:06:49 -0600 Subject: [PATCH 0738/1753] Bump MicrosoftDiagnosticsRuntimeVersion from 2.4.412801 to 2.4.416101 (#1170) Bumps `MicrosoftDiagnosticsRuntimeVersion` from 2.4.412801 to 2.4.416101. Updates `Microsoft.Diagnostics.Runtime.Utilities` from 2.4.412801 to 2.4.416101 Updates `Microsoft.Diagnostics.Runtime` from 2.4.412801 to 2.4.416101 --- updated-dependencies: - dependency-name: Microsoft.Diagnostics.Runtime.Utilities dependency-type: direct:production update-type: version-update:semver-patch - dependency-name: Microsoft.Diagnostics.Runtime dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7877b8417..9f5f1a7da 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ 3.11.0 4.4.0 1.1.1 - 2.4.412801 + 2.4.416101 From 2381c7276720eb8084c1006baf16e6ac6aae2c9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 14 Apr 2023 20:54:34 -0600 Subject: [PATCH 0739/1753] Fix ARM64 detection on Windows Powershell --- tools/Install-DotNetSdk.ps1 | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 10af50411..e190fcfbf 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -47,6 +47,7 @@ $arch = [System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture if (!$arch) { # Windows Powershell leaves this blank $arch = 'x64' if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { $arch = 'ARM64' } + if (${env:ProgramFiles(Arm)}) { $arch = 'ARM64' } } # Search for all .NET runtime versions referenced from MSBuild projects and arrange to install them. From b3e9f4ee3722b395ea4e3cdae74e812b9884d8aa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 16 Apr 2023 07:29:40 -0600 Subject: [PATCH 0740/1753] Bump up SDK and tools versions --- .config/dotnet-tools.json | 4 ++-- global.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 5d3dae876..151689b63 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.3", + "version": "7.3.4", "commands": [ "pwsh" ] @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.6.11", + "version": "17.7.0", "commands": [ "dotnet-coverage" ] diff --git a/global.json b/global.json index cf9eefa6e..c7d7e468c 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.201", + "version": "7.0.203", "rollForward": "patch", "allowPrerelease": false } From 05b6c17376c6da127a9b887b2d9a6263717098c1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Apr 2023 12:13:34 -0600 Subject: [PATCH 0741/1753] Skip symbol archival and checks for val-builds --- azure-pipelines/prepare-insertion-stages.yml | 58 +++++++++++--------- azure-pipelines/vs-validation.yml | 4 +- 2 files changed, 35 insertions(+), 27 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index bb955d688..ed6b19c2b 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -1,30 +1,36 @@ +parameters: +- name: ArchiveSymbols + type: boolean + default: true + stages: -- stage: symbol_archive - displayName: Symbol archival - condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) - jobs: - - job: archive - pool: VSEng-ReleasePool-1ES - steps: - - checkout: none - - download: current - artifact: Variables-Windows - displayName: 🔻 Download Variables-Windows artifact - - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 - displayName: ⚙️ Set pipeline variables based on artifacts - - download: current - artifact: symbols-legacy - displayName: 🔻 Download symbols-legacy artifact - - task: MicroBuildArchiveSymbols@1 - displayName: 🔣 Archive symbols to Symweb - inputs: - SymbolsFeatureName: $(SymbolsFeatureName) - SymbolsSymwebProject: VS - SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival - SymbolsEmailContacts: vsidemicrobuild - SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy - - task: MicroBuildCleanup@1 - displayName: ☎️ Send Telemetry +- ${{ if parameters.ArchiveSymbols }}: + - stage: symbol_archive + displayName: Symbol archival + condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) + jobs: + - job: archive + pool: VSEng-ReleasePool-1ES + steps: + - checkout: none + - download: current + artifact: Variables-Windows + displayName: 🔻 Download Variables-Windows artifact + - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + displayName: ⚙️ Set pipeline variables based on artifacts + - download: current + artifact: symbols-legacy + displayName: 🔻 Download symbols-legacy artifact + - task: MicroBuildArchiveSymbols@1 + displayName: 🔣 Archive symbols to Symweb + inputs: + SymbolsFeatureName: $(SymbolsFeatureName) + SymbolsSymwebProject: VS + SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival + SymbolsEmailContacts: vsidemicrobuild + SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy + - task: MicroBuildCleanup@1 + displayName: ☎️ Send Telemetry # - stage: azure_public_vsimpl_feed # displayName: azure-public/vs-impl feed diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 82a82aa01..d32634c70 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -24,6 +24,8 @@ stages: RunTests: false - template: prepare-insertion-stages.yml + parameters: + ArchiveSymbols: false - stage: insertion displayName: VS insertion @@ -60,7 +62,7 @@ stages: inputs: TeamName: $(TeamName) TeamEmail: $(TeamEmail) - InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) + InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) [Skip-SymbolCheck] InsertionDescription: | This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 From 0c36c87330bb89a4b39d69703263dc14f10831ab Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Apr 2023 12:13:59 -0600 Subject: [PATCH 0742/1753] Copy the .config file when applying the template --- Apply-Template.ps1 | 1 + 1 file changed, 1 insertion(+) diff --git a/Apply-Template.ps1 b/Apply-Template.ps1 index 12bfaa129..1c7733558 100644 --- a/Apply-Template.ps1 +++ b/Apply-Template.ps1 @@ -31,6 +31,7 @@ try { Write-Host "Updating $Path" robocopy /mir $PSScriptRoot/azure-pipelines $Path/azure-pipelines +robocopy /mir $PSScriptRoot/.config $Path/.config robocopy /mir $PSScriptRoot/.devcontainer $Path/.devcontainer robocopy /mir $PSScriptRoot/.github $Path/.github robocopy /mir $PSScriptRoot/.vscode $Path/.vscode From 591d64ee9e9fbe3311308d3c57cdb80f66353086 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 25 Apr 2023 09:50:33 -0600 Subject: [PATCH 0743/1753] Upgrade `actions/checkout` GitHub action to v3 This resolves a warning about old node.js version based github actions. --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 7718f84ad..3fc278de2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -27,7 +27,7 @@ jobs: - windows-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites From 30cf33841a0e98dd1901643cb3a5dce277c30a99 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 25 Apr 2023 10:14:19 -0600 Subject: [PATCH 0744/1753] Fix source archival pipeline nuget auth failures --- azure-pipelines/archive-sourcecode.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 33705a93d..d9e794417 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -34,6 +34,10 @@ steps: fetchDepth: 0 - powershell: tools/Install-DotNetSdk.ps1 displayName: ⚙ Install .NET SDK +- task: NuGetAuthenticate@1 + displayName: 🔏 Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true - script: dotnet tool restore displayName: Restore CLI tools - powershell: azure-pipelines/variables/_pipelines.ps1 From 1afa3e42190709e07ef276b076897335e0c87451 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 26 Apr 2023 10:28:56 -0600 Subject: [PATCH 0745/1753] Fix and simplify BinSkim --- azure-pipelines/archive-sourcecode.yml | 2 +- azure-pipelines/secure-development-tools.yml | 21 +++++++++++--------- azure-pipelines/variables/BinSkimTargets.ps1 | 4 ---- 3 files changed, 13 insertions(+), 14 deletions(-) delete mode 100644 azure-pipelines/variables/BinSkimTargets.ps1 diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index d9e794417..db270eb9e 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -39,7 +39,7 @@ steps: inputs: forceReinstallCredentialProvider: true - script: dotnet tool restore - displayName: Restore CLI tools + displayName: ⚙️ Restore CLI tools - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: ⚙ Set pipeline variables based on source diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index ac540aead..0ca483da5 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -16,25 +16,28 @@ steps: targetArgument: $(System.DefaultWorkingDirectory) optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml -- task: BinSkim@4 - displayName: 🔍 Run BinSkim - inputs: - InputType: Basic - Function: analyze - TargetPattern: guardianGlob - AnalyzeTargetGlob: $(BinSkimTargets) - - task: CopyFiles@2 - displayName: 🔍 Collect APIScan inputs + displayName: 📂 Collect APIScan/BinSkim inputs inputs: SourceFolder: $(Build.ArtifactStagingDirectory)/Symbols-$(Agent.JobName) # Exclude any patterns from the Contents (e.g. `!**/git2*`) that we have symbols for but do not need to run APIScan on. Contents: | ** !**/arm64/** + !**/win-arm64/** + !**/linux-*/** + !**/osx*/** TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) +- task: BinSkim@4 + displayName: 🔍 Run BinSkim + inputs: + InputType: Basic + Function: analyze + TargetPattern: guardianGlob + AnalyzeTargetGlob: $(Build.ArtifactStagingDirectory)/APIScanInputs/**/*.dll;$(Build.ArtifactStagingDirectory)/APIScanInputs/**/*.exe + - task: APIScan@2 displayName: 🔍 Run APIScan inputs: diff --git a/azure-pipelines/variables/BinSkimTargets.ps1 b/azure-pipelines/variables/BinSkimTargets.ps1 deleted file mode 100644 index 723b28ce4..000000000 --- a/azure-pipelines/variables/BinSkimTargets.ps1 +++ /dev/null @@ -1,4 +0,0 @@ -$Path = "$PSScriptRoot\..\..\bin" -if (Test-Path $Path) { - [string]::join(';', (& "$PSScriptRoot\..\Get-SymbolFiles.ps1" -Path $Path)) -} From e45848775d23805e530d9e0475307afc936a6d24 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 29 Apr 2023 12:04:57 -0600 Subject: [PATCH 0746/1753] Elevate CA1062 for shipping code --- .editorconfig | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.editorconfig b/.editorconfig index 078687778..fce73c076 100644 --- a/.editorconfig +++ b/.editorconfig @@ -176,5 +176,8 @@ dotnet_diagnostic.DOC108.severity = warning dotnet_diagnostic.DOC200.severity = warning dotnet_diagnostic.DOC202.severity = warning +# CA1062: Validate arguments of public methods +dotnet_diagnostic.CA1062.severity = warning + [*.sln] indent_style = tab From c3c23f7e91194f845d8df92755edb6803f6cea47 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 May 2023 08:10:45 -0600 Subject: [PATCH 0747/1753] Bump Nerdbank.GitVersioning to 3.6.128 --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 151689b63..54fc58866 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -21,7 +21,7 @@ ] }, "nbgv": { - "version": "3.5.119", + "version": "3.6.128", "commands": [ "nbgv" ] diff --git a/Directory.Packages.props b/Directory.Packages.props index b523e5c63..5758824bf 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + From a390a08ba6ada914225981f4b1fb80bf6191eb49 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 May 2023 09:32:31 -0600 Subject: [PATCH 0748/1753] Add documentation on installing and configuring analyzers Closes #1095 --- .../AppWithMainThread.editorconfig | 4 ++ .../AppWithoutMainThread.editorconfig | 8 +++ .../JTFFocusedLibrary.editorconfig | 4 ++ doc/analyzers/editorconfigs/README.md | 53 +++++++++++++++ .../editorconfigs/SharedLibrary.editorconfig | 2 + .../editorconfigs/Tests.editorconfig | 4 ++ doc/analyzers/index.md | 1 + doc/analyzers/installation.md | 68 +++++++++++++++++++ 8 files changed, 144 insertions(+) create mode 100644 doc/analyzers/editorconfigs/AppWithMainThread.editorconfig create mode 100644 doc/analyzers/editorconfigs/AppWithoutMainThread.editorconfig create mode 100644 doc/analyzers/editorconfigs/JTFFocusedLibrary.editorconfig create mode 100644 doc/analyzers/editorconfigs/README.md create mode 100644 doc/analyzers/editorconfigs/SharedLibrary.editorconfig create mode 100644 doc/analyzers/editorconfigs/Tests.editorconfig create mode 100644 doc/analyzers/installation.md diff --git a/doc/analyzers/editorconfigs/AppWithMainThread.editorconfig b/doc/analyzers/editorconfigs/AppWithMainThread.editorconfig new file mode 100644 index 000000000..41ad1294f --- /dev/null +++ b/doc/analyzers/editorconfigs/AppWithMainThread.editorconfig @@ -0,0 +1,4 @@ +# This file applies to applications with a main thread, and libraries that may run in them. + +# This file is intentionally empty because the default severity levels for the threading analyzers +# are optimized for these types of projects. diff --git a/doc/analyzers/editorconfigs/AppWithoutMainThread.editorconfig b/doc/analyzers/editorconfigs/AppWithoutMainThread.editorconfig new file mode 100644 index 000000000..51bd71f2d --- /dev/null +++ b/doc/analyzers/editorconfigs/AppWithoutMainThread.editorconfig @@ -0,0 +1,8 @@ +# These settings are appropriate for most projects that *never* run inside a process with a main thread and `SynchronizationContext`. +# Examples of such applications are ASP.NET Core and console applications. + +# VSTHRD012: Provide JoinableTaskFactory where allowed +dotnet_diagnostic.VSTHRD012.severity = none + +# VSTHRD003: Avoid awaiting foreign Tasks +dotnet_diagnostic.VSTHRD003.severity = none diff --git a/doc/analyzers/editorconfigs/JTFFocusedLibrary.editorconfig b/doc/analyzers/editorconfigs/JTFFocusedLibrary.editorconfig new file mode 100644 index 000000000..9aef6834c --- /dev/null +++ b/doc/analyzers/editorconfigs/JTFFocusedLibrary.editorconfig @@ -0,0 +1,4 @@ +# These settings are appropriate for libraries that always run within a process that follows the JoinableTaskFactory rules. + +# VSTHRD111: Use .ConfigureAwait(bool) +dotnet_diagnostic.VSTHRD111.severity = silent diff --git a/doc/analyzers/editorconfigs/README.md b/doc/analyzers/editorconfigs/README.md new file mode 100644 index 000000000..d5e54ba4e --- /dev/null +++ b/doc/analyzers/editorconfigs/README.md @@ -0,0 +1,53 @@ +# About these .editorconfig files + +This folder contains sample .editorconfig files applicable to various project types. + +Choose the most applicable .editorconfig file based on your project type and its filename and the introductory comments that may be included as a header in each file. +Append the contents of that file to your own `.editorconfig` file in your repo. + +## Use of `warning` severity levels + +When the analyzers use the `warning` severity level by default, or when the `.editorconfig` files in this folder set them, it is with the expectation that compilation warnings cause build breaks in PR/CI builds. +Using `warning` allows for a faster inner dev-loop because certain threading violations are permissible while drafting code changes, but _should_ be fixed before code is merged into the main branch. + +You can configure your CI/PR build to fail on compilation warnings by setting the `MSBuildTreatWarningsAsErrors` environment or pipeline variable to `true`. + +If your repo does _not_ have builds configured to fail on compilation warnings, consider elevating all the warning severites to error severities to ensure these serious issues do not get ignored. + +## More about specific project types + +While several project types have specific .editorconfig files defined in this folder, some merit some additional explanation and guidance. + +### Broadly shared libraries (non-Visual Studio specific) + +[SharedLibrary.editorconfig](SharedLibrary.editorconfig) + +Libraries that may run in any process, whether they have a main thread or not, should code themselves defensively to avoid any dependency on the main thread so that applications that do not follow `JoinableTaskFactory` rules can avoid deadlocks even when synchronously blocking their main thread using `Task.Wait()` on code running inside your library. +In particular, shared libraries of general interest should _always_ use `.ConfigureAwait(false)` when awaiting on tasks. + +[Learn more about authoring libraries following best threading practices](../library_with_jtf.md). + +### Libraries that run inside a JoinableTaskFactory-compliant application + +[JTFFocusedLibrary.editorconfig](JTFFocusedLibrary.editorconfig) + +These are libraries that always run within a process that follows the JoinableTaskFactory rules, such as the Visual Studio process. +Because these processes _may_ block the main thread using `JoinableTaskFactor.Run` or similar APIs, the most efficient thing for a library to do is _not_ use `.ConfigureAwait(false)` everywhere so that its continuations may resume on the thread that is already blocking on its completion. + +### GUI applications and libraries specific to them + +[AppWithMainThread.editorconfig](AppWithMainThread.editorconfig) + +This essentially captures all projects that are designed specifically to run inside an application that uses a `SynchronizationContext` on its main thread to keep code on the main thread, such as WinForms, WPF, Maui and Avalonia. + +These projects are strongly encouraged to include the `Microsoft.VisualStudio.Threading` NuGet package as a dependency and the analyzer modifications below are consistent with that recommendation. + +### ASP.NET Core and console applications + +[AppWithoutMainThread.editorconfig](AppWithoutMainThread.editorconfig) + +### Test projects + +[Tests.editorconfig](Tests.editorconfig) + +Test projects have a high tendency to define async test methods that are only called by reflection, and the `Async` method name suffix is usually unwelcome there. diff --git a/doc/analyzers/editorconfigs/SharedLibrary.editorconfig b/doc/analyzers/editorconfigs/SharedLibrary.editorconfig new file mode 100644 index 000000000..3128e3141 --- /dev/null +++ b/doc/analyzers/editorconfigs/SharedLibrary.editorconfig @@ -0,0 +1,2 @@ +# VSTHRD111: Use .ConfigureAwait(bool) +dotnet_diagnostic.VSTHRD111.severity = warning diff --git a/doc/analyzers/editorconfigs/Tests.editorconfig b/doc/analyzers/editorconfigs/Tests.editorconfig new file mode 100644 index 000000000..5b854513b --- /dev/null +++ b/doc/analyzers/editorconfigs/Tests.editorconfig @@ -0,0 +1,4 @@ +# These settings are appropriate for test projects. + +# VSTHRD200: Use `Async` naming convention +dotnet_diagnostic.VSTHRD200.severity = none diff --git a/doc/analyzers/index.md b/doc/analyzers/index.md index 038fdd038..fcbbb5ab6 100644 --- a/doc/analyzers/index.md +++ b/doc/analyzers/index.md @@ -2,6 +2,7 @@ The following are the diagnostic analyzers installed with the [Microsoft.VisualStudio.Threading.Analyzers][1] NuGet package. +Learn more about [how to install and configure these analyzers](installation.md). ID | Title | Severity | Supports | Default diagnostic severity ---- | --- | --- | --- | --- | diff --git a/doc/analyzers/installation.md b/doc/analyzers/installation.md new file mode 100644 index 000000000..a00c99297 --- /dev/null +++ b/doc/analyzers/installation.md @@ -0,0 +1,68 @@ +# Installing the threading analyzers + +The threading analyzers built from this repo and consumable via [the Microsoft.VisualStudio.Threading.Analyzers nuget package][NuGet] are useful for virtually every app library and most libraries. +In particular, projects do not need to be related to Visual Studio in order for these analyzers to apply and improve the quality of your code. + +This document outlines how to install the analyzers and offer guidance on how to optimally configure them. + +## How to install the threading analyzers + +If you are using the `Microsoft.VisualStudio.Threading` NuGet package, you should already have the analyzers installed because they are brought in as a dependency of this package. + +Some projects may not want a runtime dependency on `Microsoft.VisualStudio.Threading`, but the analyzers may still apply. +Install the analyzers using any of the methods described on [the package landing page on nuget.org][NuGet]. +For example, you might add this tag to your project file: + +```xml + +``` + +Or even better, add this to some broad `Directory.Build.targets` file so it can apply to all of your projects. + +Remember to periodically update the version of the analyzer package you reference. +You should generally use the latest version available, without regard to the version of the application or threading library in use, so you get the best diagnostics. + +## Configuring the analyzers + +There are [many rules](index.md) in the analyzer package. +The default severity levels for the various rules are not appropriate for every type of project. +To get the best default severity levels for your project type, please review [these editorconfig recommendations](editorconfigs/README.md) and apply them to your project. + +Some analyzers allow for [specialized configuration](configuration.md) that allows you to tailor them to your specific application or library to provide even more value to your team. + +## Dealing with suppressions + +In some projects we find that some of the threading analyzers have been disabled because they were producing warnings that the project owner did not want to fix at the time. +We generally discourage disabling rules that apply to a project because of the deadlocks that may already exist or that can creep into a codebase over time. +If installing analyzers produces blocking errors or warnings and you cannot fix them all at once, suppress the warnings and schedule time to go back to review them soon. +The recommended way to suppress your "baseline" of warnings is with in-situ `#pragma` suppressions such as: + +```css +#pragma warning disable VSTHRD010 // Suppress warning in baseline when installing analyzers -- should review soon +bad.Code(); +#pragma warning restore VSTHRD010 +``` + +Suppressing specific occurrences in this way can be done in bulk using an automated C# code fix within Visual Studio. +Doing it for each individual occurrence is better than suppressing the entire rule ID because the analyzers will be allowed to flag newly introduced code while you have not yet reviewed your old code and re-enabled the rule. + +If you suspect your project may have suppressed an analyzer rule project-wide, please look in the following common places for broad suppressions and remove them so that your project gets the analyzers run on them: + +1. MSBuild project file `` properties that contain `VSTHRD*` warning IDs. +1. MSBuild project files with `` to the analyzer package but set `ExcludeAssets="analyzers"`, `ExcludeAssets="all"` or `IncludeAssets="none"` to explicitly turn them off. +1. .ruleset files that decrease severity or turn off `VSTHRD*` rule IDs. +1. .editorconfig files that decrease severity or turn off `VSTHRD*` rule IDs. + +## Visual Studio specific analyzers + +When a project targets Visual Studio specifically, it should also reference the [Microsoft.VisualStudio.Sdk.Analyzers][SdkAnalyzers] NuGet package. +This package delivers additional analyzers and configures _these_ threading analyzers to be more aware of VS-specific APIs so that better diagnostics can be produced. + +```xml + +``` + +Note that although the SDK analyzers automatically brings in the threading analyzers due to a package dependency, you should reference the threading analyzers directly as well to bring in the latest version, since the SDK analyzers ships infrequently and thus brings in older versions of the threading analyzers by default. + +[NuGet]: https://www.nuget.org/packages/microsoft.visualstudio.threading.analyzers +[SdkAnalyzers]: https://www.nuget.org/packages/microsoft.visualstudio.sdk.analyzers From 08b8e5001362d947866a14ec285047daf4b7e6f4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 May 2023 09:37:21 -0600 Subject: [PATCH 0749/1753] Fix new CA1062 warning --- .../CancellationTokenExtensions.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs index 0978d3406..e63d09437 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs @@ -145,6 +145,7 @@ public static CombinedCancellationToken CombineWith(this CancellationToken origi /// The cancellation token source. public CombinedCancellationToken(CancellationTokenSource cancellationTokenSource) { + Requires.NotNull(cancellationTokenSource); this.cts = cancellationTokenSource; this.Token = cancellationTokenSource.Token; } From dfcf3754d53d0a959c97c14fbfd8696177273aaa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 May 2023 09:40:39 -0600 Subject: [PATCH 0750/1753] Bump MicroBuild version --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index fc9f6c679..8e2703df3 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.115 + 2.0.117 From e90465acd44c421921f48cca04fc4c7e73dd7034 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 May 2023 22:48:46 -0600 Subject: [PATCH 0751/1753] Update Dockerfile --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 7ffd07efb..01c94a90e 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:7.0.101-jammy +FROM mcr.microsoft.com/dotnet/sdk:7.0.203-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 46b4f565e380906d043528f2442c0cb1591f585c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 May 2023 07:41:53 -0600 Subject: [PATCH 0752/1753] Fix placement of $RestoreArguments construction --- init.ps1 | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/init.ps1 b/init.ps1 index 6211304f8..00a9589ba 100755 --- a/init.ps1 +++ b/init.ps1 @@ -83,13 +83,13 @@ Push-Location $PSScriptRoot try { $HeaderColor = 'Green' - if (!$NoRestore -and $PSCmdlet.ShouldProcess("NuGet packages", "Restore")) { - $RestoreArguments = @() - if ($Interactive) - { - $RestoreArguments += '--interactive' - } + $RestoreArguments = @() + if ($Interactive) + { + $RestoreArguments += '--interactive' + } + if (!$NoRestore -and $PSCmdlet.ShouldProcess("NuGet packages", "Restore")) { Write-Host "Restoring NuGet packages" -ForegroundColor $HeaderColor dotnet restore @RestoreArguments if ($lastexitcode -ne 0) { From 4d4c330486ea2fe98d9ae70ed1c05fb5bba31c92 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 May 2023 08:51:17 -0600 Subject: [PATCH 0753/1753] Switch from `MSBuildTreatWarningsAsErrors` to `-warnaserror` This is per @rainersigwald's suggestion in https://github.com/dotnet/msbuild/issues/8735#issuecomment-1544076504 --- .github/workflows/build.yml | 3 +-- azure-pipelines.yml | 1 - azure-pipelines/dotnet.yml | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3fc278de2..33502820a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,7 +8,6 @@ on: pull_request: env: - MSBuildTreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BUILDCONFIGURATION: Release # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ @@ -44,7 +43,7 @@ jobs: run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - name: 🛠 build - run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} /v:m /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" + run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnaserror /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - name: 🧪 test run: azure-pipelines/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} shell: pwsh diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 521d4ce6b..9867b3db8 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -23,7 +23,6 @@ parameters: default: true variables: - MSBuildTreatWarningsAsErrors: true DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 79babd4d4..512415497 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -3,7 +3,7 @@ parameters: steps: -- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" +- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnaserror /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: 🛠 dotnet build - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults From c84fe06b9701ea6ac7b6bebed8a6f5f0064c9561 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 May 2023 07:04:10 -0600 Subject: [PATCH 0754/1753] Fix BinSkim when ApiScan won't run --- azure-pipelines/secure-development-tools.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 0ca483da5..ce8ac94cf 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -28,7 +28,6 @@ steps: !**/linux-*/** !**/osx*/** TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs - condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) - task: BinSkim@4 displayName: 🔍 Run BinSkim From aefd199847243c1e0a6a8224db00ccb25a5bc9e0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 May 2023 10:56:28 -0600 Subject: [PATCH 0755/1753] Bump .NET SDK to 7.0.302 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 01c94a90e..6d2f30da6 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:7.0.203-jammy +FROM mcr.microsoft.com/dotnet/sdk:7.0.302-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index c7d7e468c..abde95a8b 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.203", + "version": "7.0.302", "rollForward": "patch", "allowPrerelease": false } From 9f65c54c5f01a2c38efa9dfbda9e74165ab7c008 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 May 2023 21:13:48 -0600 Subject: [PATCH 0756/1753] Stop building v16 branches nightly --- azure-pipelines/official.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 89d2cef8f..8ba2a0072 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -16,7 +16,6 @@ schedules: branches: include: - main - - 'v16.*' parameters: - name: SignTypeSelection From 4406d85960e468f19f0868991757aae74fbf7224 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 May 2023 06:23:33 -0600 Subject: [PATCH 0757/1753] Parameterize and add diagnostics to InsertVersionsValues.ps1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It's been failing ever since switching from `Get-Nbgv.ps1` to `dotnet tool run nbgv`, but only on Azure Pipelines, and only on certain commits. Quite literally, it fails repeatedly on some particular commit, and if I push a new *empty* commit, it succeeds. This makes me believe that somehow, the git database or git commit id itself or something is causing `nbgv` to fail. I have no idea why it would fail with this output though: ``` Computing InsertVersionsValues variable Option '--project' expects a single argument but 2 were provided. ConvertFrom-Json: /home/vsts/work/1/s/azure-pipelines/variables/InsertVersionsValues.ps1:2 Line | 2 | … oft.VisualStudio.Validation" --format json | ConvertFrom-Json).Assemb … | ~~~~~~~~~~~~~~~~ | Conversion from JSON failed with error: Unexpected character encountered | while parsing value: D. Path '', line 0, position 0. ``` The output suggests a malformed command line, but I simply see no possible way for that to happen. Nor can I repro it locally. --- .../variables/InsertVersionsValues.ps1 | 30 +++++++++++++++++-- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index c3a035590..9bc7bc83b 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -4,6 +4,30 @@ # your libraries as defined in the src\ProductData\AssemblyVersions.tt file. return -[string]::join(',',(@{ - ('LibraryNoDotsVersion') = & { (dotnet tool run nbgv get-version --project "$PSScriptRoot\..\..\src\LibraryName" --format json | ConvertFrom-Json).AssemblyVersion }; -}.GetEnumerator() |% { "$($_.key)=$($_.value)" })) +$MacroName = 'LibraryNoDotsVersion' +$SampleProject = "$PSScriptRoot\..\..\src\LibraryName" +try { + return [string]::join(',',(@{ + ($MacroName) = & { (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; + }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) +} +catch { + Write-Error $_ + Write-Error "Failed. Diagnostic data proceeds:" + [string]::join(',',(@{ + ($MacroName) = & { + Write-Host "dotnet tool run nbgv get-version --project `"$SampleProject`" --format json" + $result1 = dotnet tool run nbgv get-version --project $SampleProject --format json + Write-Host $result1 + $result2 = dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json + Write-Host $result2 + Write-Host $result2.AssemblyVersion + Write-Host (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion + Write-Output (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion + }; + }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) + + Write-Host "one more..." + $r = & { (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; + Write-Host $r +} From 1d5a893061a5e97cb1945c96719376916975ca4b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 May 2023 09:54:57 -0600 Subject: [PATCH 0758/1753] Another attempt to catch this InsertVersionsValues bug --- azure-pipelines/variables/InsertVersionsValues.ps1 | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index e58892111..68b937bdc 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -1,8 +1,14 @@ $MacroName = 'MicrosoftVisualStudioThreadingVersion' $SampleProject = "$PSScriptRoot\..\..\src\Microsoft.VisualStudio.Threading" try { - return [string]::join(',',(@{ - ($MacroName) = & { (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; + $json = dotnet tool run nbgv get-version --project $SampleProject --format json + if ($LASTEXITCODE -ne 0) { + Write-Error "Exit code is $LASTEXITCODE. STDOUT follows" + Write-Error $json + throw + } + [string]::join(',',(@{ + ($MacroName) = & { ($json | ConvertFrom-Json).AssemblyVersion }; }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) } catch { From b33fad3f1fab1559e672d4cacb92d763568a9bd3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 May 2023 13:32:53 -0600 Subject: [PATCH 0759/1753] Fix schedule triggered source code archival --- azure-pipelines/Archive-SourceCode.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index 0fec3e9b3..9158c9b34 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -135,7 +135,7 @@ if (!$Requester) { $Requester = $env:USERNAME } if (!$Requester) { - Write-Error "Unable to determine default value for -Requester." + $Requester = $OwnerAlias } } From 8f6c4d6ba6875dc382b4ad7ea148c7871e3e7cc4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 May 2023 16:38:05 -0600 Subject: [PATCH 0760/1753] Upgrade archive symbols task to v4 --- azure-pipelines/prepare-insertion-stages.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index ed6b19c2b..e194ff444 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -10,7 +10,7 @@ stages: condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) jobs: - job: archive - pool: VSEng-ReleasePool-1ES + pool: VSEngSS-MicroBuild2022-1ES steps: - checkout: none - download: current @@ -21,14 +21,13 @@ stages: - download: current artifact: symbols-legacy displayName: 🔻 Download symbols-legacy artifact - - task: MicroBuildArchiveSymbols@1 + - task: MicroBuildArchiveSymbols@4 displayName: 🔣 Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) - SymbolsSymwebProject: VS - SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival - SymbolsEmailContacts: vsidemicrobuild + SymbolsProject: VS SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy + azureSubscription: Symbols Upload (DevDiv) - task: MicroBuildCleanup@1 displayName: ☎️ Send Telemetry From b46d049fc37c9d0537ddb9b2b8653d2de8c88e14 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 May 2023 16:40:50 -0600 Subject: [PATCH 0761/1753] Consolidate two stages to just one --- azure-pipelines/prepare-insertion-stages.yml | 60 ++++++++++---------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index e194ff444..bb3a400cc 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -4,12 +4,13 @@ parameters: default: true stages: -- ${{ if parameters.ArchiveSymbols }}: - - stage: symbol_archive - displayName: Symbol archival - condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) - jobs: - - job: archive +- stage: release + displayName: Publish + condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) + jobs: + - ${{ if parameters.ArchiveSymbols }}: + - job: symbol_archive + displayName: Archive symbols pool: VSEngSS-MicroBuild2022-1ES steps: - checkout: none @@ -31,28 +32,27 @@ stages: - task: MicroBuildCleanup@1 displayName: ☎️ Send Telemetry -# - stage: azure_public_vsimpl_feed +# - job: push # displayName: azure-public/vs-impl feed -# condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) -# jobs: -# - job: push -# pool: -# name: AzurePipelines-EO -# vmImage: AzurePipelinesUbuntu20.04compliant -# steps: -# - checkout: none -# - download: current -# artifact: deployables-Windows -# displayName: 🔻 Download deployables-Windows artifact -# - task: UseDotNet@2 -# displayName: ⚙️ Install .NET SDK -# inputs: -# packageType: sdk -# version: 6.x -# - task: NuGetAuthenticate@1 -# displayName: 🔏 Authenticate NuGet feeds -# inputs: -# nuGetServiceConnections: azure-public/vs-impl -# forceReinstallCredentialProvider: true -# - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate -# displayName: 📦 Push nuget packages +# ${{ if parameters.ArchiveSymbols }}: +# dependsOn: symbol_archive +# pool: +# name: AzurePipelines-EO +# vmImage: AzurePipelinesUbuntu20.04compliant +# steps: +# - checkout: none +# - download: current +# artifact: deployables-Windows +# displayName: 🔻 Download deployables-Windows artifact +# - task: UseDotNet@2 +# displayName: ⚙️ Install .NET SDK +# inputs: +# packageType: sdk +# version: 6.x +# - task: NuGetAuthenticate@1 +# displayName: 🔏 Authenticate NuGet feeds +# inputs: +# nuGetServiceConnections: azure-public/vs-impl +# forceReinstallCredentialProvider: true +# - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate +# displayName: 📦 Push nuget packages From 354b522a12ab85fd819356484a63e7cf38ae2579 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 20 May 2023 13:25:55 -0600 Subject: [PATCH 0762/1753] Bump NB.GV to 3.6.132 --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 54fc58866..93547faf7 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -21,7 +21,7 @@ ] }, "nbgv": { - "version": "3.6.128", + "version": "3.6.132", "commands": [ "nbgv" ] diff --git a/Directory.Packages.props b/Directory.Packages.props index 5758824bf..7cf54cc17 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + From 4f2a6d8391ae5f2b9a577bd3c3bbb03a201a4ff8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 20 May 2023 13:28:47 -0600 Subject: [PATCH 0763/1753] Bump CSharpIsNullAnalyzer from 0.1.329 to 0.1.495 (#204) * Crank up dependabot * Bump CSharpIsNullAnalyzer from 0.1.329 to 0.1.495 Bumps [CSharpIsNullAnalyzer](https://github.com/AArnott/CSharpIsNull) from 0.1.329 to 0.1.495. - [Release notes](https://github.com/AArnott/CSharpIsNull/releases) - [Commits](https://github.com/AArnott/CSharpIsNull/commits) --- updated-dependencies: - dependency-name: CSharpIsNullAnalyzer dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --------- Signed-off-by: dependabot[bot] Co-authored-by: Andrew Arnott Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/dependabot.yml | 4 ++-- Directory.Packages.props | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index b9b0f54a2..63e3e890b 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,9 +1,9 @@ # Please see the documentation for all configuration options: -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file version: 2 updates: - package-ecosystem: nuget directory: / schedule: - interval: monthly + interval: weekly diff --git a/Directory.Packages.props b/Directory.Packages.props index 7cf54cc17..74916ca21 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 119ce0770abc0ad1a3b8bdab3ca622470579ec92 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 20 May 2023 13:29:01 -0600 Subject: [PATCH 0764/1753] Bump Microsoft.NET.Test.Sdk from 17.5.0 to 17.6.0 (#202) * Crank up dependabot * Bump Microsoft.NET.Test.Sdk from 17.5.0 to 17.6.0 Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.5.0 to 17.6.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.5.0...v17.6.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --------- Signed-off-by: dependabot[bot] Co-authored-by: Andrew Arnott Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 74916ca21..061f8ed44 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 0991fe932a245d50f30ebab193a3cd50dc520939 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 20 May 2023 13:29:13 -0600 Subject: [PATCH 0765/1753] Bump dotnet-coverage from 17.7.0 to 17.7.1 (#205) * Crank up dependabot * Bump dotnet-coverage from 17.7.0 to 17.7.1 Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.7.0 to 17.7.1. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --------- Signed-off-by: dependabot[bot] Co-authored-by: Andrew Arnott Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 93547faf7..5ed46cc1c 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.7.0", + "version": "17.7.1", "commands": [ "dotnet-coverage" ] From 9729af69671ee9547a9dd1a1c10a7623b6cec74d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 May 2023 07:54:19 -0600 Subject: [PATCH 0766/1753] add -- switch separator --- azure-pipelines/variables/InsertVersionsValues.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index 68b937bdc..f47e93c06 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -1,7 +1,7 @@ $MacroName = 'MicrosoftVisualStudioThreadingVersion' $SampleProject = "$PSScriptRoot\..\..\src\Microsoft.VisualStudio.Threading" try { - $json = dotnet tool run nbgv get-version --project $SampleProject --format json + $json = dotnet tool run nbgv -- get-version --project $SampleProject --format json if ($LASTEXITCODE -ne 0) { Write-Error "Exit code is $LASTEXITCODE. STDOUT follows" Write-Error $json From ed457962d89aa2ee73a5069eb441d7bfc6f08d5e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 May 2023 08:26:36 -0600 Subject: [PATCH 0767/1753] Fix LCE warnings --- .../Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj | 1 + .../Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj | 1 + ...Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj | 1 + src/SosThreadingTools/SosThreadingTools.csproj | 1 + 4 files changed, 4 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj index 393de50bd..689fd8109 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj @@ -2,6 +2,7 @@ netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers + false false diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj index ed52c8be7..4ed0a0aa6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj @@ -2,6 +2,7 @@ netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers + false Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. true diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj index 4597ac85c..b8c437ca0 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj @@ -2,6 +2,7 @@ netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers + false false diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index d737ba515..8ecfd2915 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -5,6 +5,7 @@ true true true + false false From 2e6a2d1c2f93069381266ae7e49a4a4e6bf43b8c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 May 2023 08:31:09 -0600 Subject: [PATCH 0768/1753] (Hopefully) fix `nbgv` failures with `--` argument separator I believe `dotnet tool run` may be stealing the `--project` parameter non-deterministically (perhaps due to string hashing inputs that change in every process). By adding `--` in front of all parameters for the `nbgv` tool, I believe and hope this will resolve the issue by forcing the command line parser to interpret all subsequent command line arguments to be directed to `nbgv`. --- .../variables/InsertVersionsValues.ps1 | 28 ++----------------- 1 file changed, 3 insertions(+), 25 deletions(-) diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index 9bc7bc83b..2eb2fcea9 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -6,28 +6,6 @@ return $MacroName = 'LibraryNoDotsVersion' $SampleProject = "$PSScriptRoot\..\..\src\LibraryName" -try { - return [string]::join(',',(@{ - ($MacroName) = & { (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; - }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) -} -catch { - Write-Error $_ - Write-Error "Failed. Diagnostic data proceeds:" - [string]::join(',',(@{ - ($MacroName) = & { - Write-Host "dotnet tool run nbgv get-version --project `"$SampleProject`" --format json" - $result1 = dotnet tool run nbgv get-version --project $SampleProject --format json - Write-Host $result1 - $result2 = dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json - Write-Host $result2 - Write-Host $result2.AssemblyVersion - Write-Host (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion - Write-Output (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion - }; - }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) - - Write-Host "one more..." - $r = & { (dotnet tool run nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; - Write-Host $r -} +[string]::join(',',(@{ + ($MacroName) = & { (dotnet tool run nbgv -- get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; +}.GetEnumerator() |% { "$($_.key)=$($_.value)" })) From 6ed5201ef0c74f14f07fa87b3ff1db64187fab2f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 May 2023 08:43:08 -0600 Subject: [PATCH 0769/1753] Fix indentation of commented section --- azure-pipelines/prepare-insertion-stages.yml | 48 ++++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index bb3a400cc..a41be0320 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -32,27 +32,27 @@ stages: - task: MicroBuildCleanup@1 displayName: ☎️ Send Telemetry -# - job: push -# displayName: azure-public/vs-impl feed -# ${{ if parameters.ArchiveSymbols }}: -# dependsOn: symbol_archive -# pool: -# name: AzurePipelines-EO -# vmImage: AzurePipelinesUbuntu20.04compliant -# steps: -# - checkout: none -# - download: current -# artifact: deployables-Windows -# displayName: 🔻 Download deployables-Windows artifact -# - task: UseDotNet@2 -# displayName: ⚙️ Install .NET SDK -# inputs: -# packageType: sdk -# version: 6.x -# - task: NuGetAuthenticate@1 -# displayName: 🔏 Authenticate NuGet feeds -# inputs: -# nuGetServiceConnections: azure-public/vs-impl -# forceReinstallCredentialProvider: true -# - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate -# displayName: 📦 Push nuget packages + # - job: push + # displayName: azure-public/vs-impl feed + # ${{ if parameters.ArchiveSymbols }}: + # dependsOn: symbol_archive + # pool: + # name: AzurePipelines-EO + # vmImage: AzurePipelinesUbuntu20.04compliant + # steps: + # - checkout: none + # - download: current + # artifact: deployables-Windows + # displayName: 🔻 Download deployables-Windows artifact + # - task: UseDotNet@2 + # displayName: ⚙️ Install .NET SDK + # inputs: + # packageType: sdk + # version: 6.x + # - task: NuGetAuthenticate@1 + # displayName: 🔏 Authenticate NuGet feeds + # inputs: + # nuGetServiceConnections: azure-public/vs-impl + # forceReinstallCredentialProvider: true + # - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate + # displayName: 📦 Push nuget packages From 6af106ecbd6cf2b13e0a187db66d19921b815631 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 23 May 2023 10:46:52 -0600 Subject: [PATCH 0770/1753] Beef up VSTHRD001 documentation --- doc/analyzers/VSTHRD001.md | 57 ++++++++++++++++++++++++++++++++++---- 1 file changed, 51 insertions(+), 6 deletions(-) diff --git a/doc/analyzers/VSTHRD001.md b/doc/analyzers/VSTHRD001.md index 5c9dbcdee..1dd47c1ac 100644 --- a/doc/analyzers/VSTHRD001.md +++ b/doc/analyzers/VSTHRD001.md @@ -7,16 +7,22 @@ This avoids deadlocks and can reduce threadpool starvation. ## Examples of patterns that are flagged by this analyzer ```csharp -void Foo() { - ThreadHelper.Generic.Invoke(delegate { - DoSomething(); - }); -} +ThreadHelper.Generic.Invoke(delegate { + DoSomething(); +}); +``` + +or + +```cs +Dispatcher.CurrentDispatcher.BeginInvoke(delegate { + DoSomething(); +}); ``` ## Solution -Use `await SwitchToMainThreadAsync()` instead, wrapping with `JoinableTaskFactory.Run` if necessary: +Use `await SwitchToMainThreadAsync()` instead, wrapping with the `JoinableTaskFactory`'s `Run` or `RunAsync` method if necessary: ```csharp void Foo() { @@ -31,6 +37,45 @@ In the above example, we obtain a `JoinableTaskFactory` instance from the `Threa as it exists within Visual Studio itself. Other applications should create and expose their own `JoinableTaskContext` and/or `JoinableTaskFactory` for use in code that run in these applications. See our doc on [consuming `JoinableTaskFactory` from a library](https://github.com/microsoft/vs-threading/blob/main/doc/library_with_jtf.md) for more information. +### Replacing Dispatcher.BeginInvoke + +When updating calls to `Dispatcher.BeginInvoke`, there are a few considerations to consider. + +1. `BeginInvoke` schedules the delegate for execution later. +1. `BeginInvoke` always executes the delegate on the dispatcher's thread. +1. `BeginInvoke` schedules the delegate at some given priority, or default priority determined by the dispatcher. + +To resolve a warning for such code, it is often sufficient to replace it with this, which is *roughly* equivalent: + +```cs +await joinableTaskFactory.RunAsync(async delegate { + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); + DoSomething(); +}) +``` + +The first line in the delegate is necessary to match the behaviors of 1 and 2 on the above list. +When the caller is known to already be on the main thread, you can simplify it slightly to this: + +```cs +await joinableTaskFactory.RunAsync(async delegate { + await Task.Yield(); + DoSomething(); +}) +``` + +Matching behavior 3 on the list above may be important when the dispatcher priority is specified in the BeginInvoke call and was chosen for a particular reason. +In such a case, you can ensure that `JoinableTaskFactory` matches that priority instead of using its default by creating a special `JoinableTaskFactory` instance with the priority setting you require using the [`JoinableTaskFactory.WithPriority`](https://learn.microsoft.com/dotnet/api/microsoft.visualstudio.threading.dispatcherextensions.withpriority?view=visualstudiosdk-2022) method. + +Altogether, this might look like: + +```cs +await joinableTaskFactory.WithPriority(DispatcherPriority.DataBind).RunAsync(async delegate { + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); + DoSomething(); +}) +``` + ## Configuration This analyzer is configurable via the `vs-threading.LegacyThreadSwitchingMembers.txt` file. From e50278a744ac29ee6f066b9406d2933c898f3eea Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 27 May 2023 07:48:43 -0600 Subject: [PATCH 0771/1753] Bump Nerdbank.GitVersioning to 3.6.133 --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 5ed46cc1c..fa4ceb59c 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -21,7 +21,7 @@ ] }, "nbgv": { - "version": "3.6.132", + "version": "3.6.133", "commands": [ "nbgv" ] diff --git a/Directory.Packages.props b/Directory.Packages.props index 061f8ed44..738a2f99d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + From 1579bbaf76e95e700c4aef5311fd5aefc0dd2e18 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Jun 2023 07:21:57 -0600 Subject: [PATCH 0772/1753] Bump Microsoft.NET.Test.Sdk to 17.6.1 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 738a2f99d..386c6eecb 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 8243627d0160e17171825519500a29a68900cf2e Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Tue, 6 Jul 2021 17:07:36 -0700 Subject: [PATCH 0773/1753] Add NoThrowAwaitable for MainThreadAwaitable Fixes #877 --- .../JoinableTaskFactory.cs | 176 +++++++++++++++++- .../TplExtensions.cs | 12 +- .../net472/PublicAPI.Unshipped.txt | 8 + .../net6.0-windows/PublicAPI.Unshipped.txt | 8 + .../net6.0/PublicAPI.Unshipped.txt | 8 + .../netstandard2.0/PublicAPI.Unshipped.txt | 8 + 6 files changed, 211 insertions(+), 9 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index c24f07553..a1c468c87 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -709,6 +709,19 @@ internal MainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, this.alwaysYield = alwaysYield; } + internal NoThrowMainThreadAwaitable NoThrowAwaitable + { + get + { + if (this.jobFactory is null) + { + return default; + } + + return new NoThrowMainThreadAwaitable(this.jobFactory, this.job, this.cancellationToken, this.alwaysYield); + } + } + /// /// Gets the awaiter. /// @@ -723,10 +736,146 @@ public MainThreadAwaiter GetAwaiter() } } + /// + /// An awaitable struct that facilitates an asynchronous transition to the Main thread. + /// + public readonly struct NoThrowMainThreadAwaitable + { + private readonly JoinableTaskFactory? jobFactory; + + private readonly JoinableTask? job; + + private readonly CancellationToken cancellationToken; + + private readonly bool alwaysYield; + + /// + /// Initializes a new instance of the struct. + /// + internal NoThrowMainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, CancellationToken cancellationToken, bool alwaysYield = false) + { + Requires.NotNull(jobFactory, nameof(jobFactory)); + + this.jobFactory = jobFactory; + this.job = job; + this.cancellationToken = cancellationToken; + this.alwaysYield = alwaysYield; + } + + /// + /// Gets the awaiter. + /// + public NoThrowMainThreadAwaiter GetAwaiter() + { + if (this.jobFactory is null) + { + return default; + } + + return new NoThrowMainThreadAwaiter(this.jobFactory, this.job, this.alwaysYield, this.cancellationToken); + } + } + /// /// An awaiter struct that facilitates an asynchronous transition to the Main thread. /// public readonly struct MainThreadAwaiter : ICriticalNotifyCompletion + { + private readonly MainThreadAwaiterImpl impl; + + /// + /// Initializes a new instance of the struct. + /// + internal MainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) + { + this.impl = new MainThreadAwaiterImpl(jobFactory, job, alwaysYield, throwOnCancellation: true, cancellationToken); + } + + /// + /// Gets a value indicating whether the caller is already on the Main thread. + /// + public bool IsCompleted => this.impl.IsCompleted; + + /// + /// Schedules a continuation for execution on the Main thread + /// without capturing the ExecutionContext. + /// + /// The action to invoke when the operation completes. + public void UnsafeOnCompleted(Action continuation) + { + this.impl.UnsafeOnCompleted(continuation); + } + + /// + /// Schedules a continuation for execution on the Main thread. + /// + /// The action to invoke when the operation completes. + public void OnCompleted(Action continuation) + { + this.impl.OnCompleted(continuation); + } + + /// + /// Called on the Main thread to prepare it to execute the continuation. + /// + public void GetResult() + { + this.impl.GetResult(); + } + } + + /// + /// An awaiter struct that facilitates an asynchronous transition to the Main thread. + /// + public readonly struct NoThrowMainThreadAwaiter : ICriticalNotifyCompletion + { + private readonly MainThreadAwaiterImpl impl; + + /// + /// Initializes a new instance of the struct. + /// + internal NoThrowMainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) + { + this.impl = new MainThreadAwaiterImpl(jobFactory, job, alwaysYield, throwOnCancellation: false, cancellationToken); + } + + /// + /// Gets a value indicating whether the caller is already on the Main thread. + /// + public bool IsCompleted => this.impl.IsCompleted; + + /// + /// Schedules a continuation for execution on the Main thread + /// without capturing the ExecutionContext. + /// + /// The action to invoke when the operation completes. + public void UnsafeOnCompleted(Action continuation) + { + this.impl.UnsafeOnCompleted(continuation); + } + + /// + /// Schedules a continuation for execution on the Main thread. + /// + /// The action to invoke when the operation completes. + public void OnCompleted(Action continuation) + { + this.impl.OnCompleted(continuation); + } + + /// + /// Called on the Main thread to prepare it to execute the continuation. + /// + public bool GetResult() + { + return this.impl.GetResult(); + } + } + + /// + /// An awaiter struct that facilitates an asynchronous transition to the Main thread. + /// + private readonly struct MainThreadAwaiterImpl : ICriticalNotifyCompletion { private static readonly Action SafeCancellationAction = state => ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, state); @@ -738,6 +887,8 @@ public MainThreadAwaiter GetAwaiter() private readonly bool alwaysYield; + private readonly bool throwOnCancellation; + private readonly JoinableTask? job; private readonly bool synchronousCancellation; @@ -760,15 +911,16 @@ public MainThreadAwaiter GetAwaiter() private readonly StrongBox? cancellationRegistrationPtr; /// - /// Initializes a new instance of the struct. + /// Initializes a new instance of the struct. /// - internal MainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) + internal MainThreadAwaiterImpl(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, bool throwOnCancellation, CancellationToken cancellationToken) { this.jobFactory = jobFactory; this.job = job; this.cancellationToken = cancellationToken; this.synchronousCancellation = cancellationToken.IsCancellationRequested && !alwaysYield; this.alwaysYield = alwaysYield; + this.throwOnCancellation = throwOnCancellation; // Don't allocate the pointer if the cancellation token can't be canceled (or already is): this.cancellationRegistrationPtr = cancellationToken.CanBeCanceled && !this.synchronousCancellation @@ -817,7 +969,7 @@ public void OnCompleted(Action continuation) /// /// Called on the Main thread to prepare it to execute the continuation. /// - public void GetResult() + public bool GetResult() { Assumes.True(this.jobFactory is object); if (!(this.jobFactory.Context.IsOnMainThread || this.jobFactory.Context.UnderlyingSynchronizationContext is null || this.cancellationToken.IsCancellationRequested)) @@ -867,11 +1019,19 @@ public void GetResult() SynchronizationContext? syncContext = this.job is object ? this.job.ApplicableJobSyncContext : this.jobFactory.ApplicableJobSyncContext; syncContext.Apply(); - // Cancel if requested, even if we arrived on the main thread. - // Unlike most async methods where throwing OperationCanceledException after completing the work may not be a good idea, - // SwitchToMainThreadAsync is a scheduler method, and always precedes some work by the caller that almost certainly should - // not be carried out if cancellation was requested. - this.cancellationToken.ThrowIfCancellationRequested(); + if (this.throwOnCancellation) + { + // Cancel if requested, even if we arrived on the main thread. + // Unlike most async methods where throwing OperationCanceledException after completing the work may not be a good idea, + // SwitchToMainThreadAsync is a scheduler method, and always precedes some work by the caller that almost certainly should + // not be carried out if cancellation was requested. + this.cancellationToken.ThrowIfCancellationRequested(); + return true; + } + else + { + return !this.cancellationToken.IsCancellationRequested; + } } /// diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index b62198fc3..40de50e49 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -4,7 +4,6 @@ using System; using System.Collections.Generic; using System.Runtime.CompilerServices; -using System.Security; using System.Threading; using System.Threading.Tasks; @@ -241,6 +240,17 @@ public static NoThrowTaskAwaitable NoThrowAwaitable(this Task task, bool capture return new NoThrowTaskAwaitable(task, captureContext); } + /// + /// Returns an awaitable for the specified + /// operation that will return a Boolean value indicating cancellation rather than throwing an exception. + /// + /// The task whose completion should signal the completion of the returned awaitable. + /// An awaitable. + public static JoinableTaskFactory.NoThrowMainThreadAwaitable NoThrowAwaitable(this JoinableTaskFactory.MainThreadAwaitable awaitable) + { + return awaitable.NoThrowAwaitable; + } + /// /// Consumes a task and doesn't do anything with it. Useful for fire-and-forget calls to async methods within async methods. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index eea3008f0..cb749cf12 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,3 +1,11 @@ +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index eea3008f0..cb749cf12 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -1,3 +1,11 @@ +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index eea3008f0..cb749cf12 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -1,3 +1,11 @@ +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index eea3008f0..cb749cf12 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,3 +1,11 @@ +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! From 3a3034a7890d2c74c6ecc168358a5d06591ba91a Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Mon, 5 Jun 2023 11:22:35 -0500 Subject: [PATCH 0774/1753] Simplify implementation of no-throw switch to main thread --- .../JoinableTaskFactory.cs | 170 +++--------------- .../TplExtensions.cs | 12 +- .../net472/PublicAPI.Unshipped.txt | 9 +- .../net6.0-windows/PublicAPI.Unshipped.txt | 9 +- .../net6.0/PublicAPI.Unshipped.txt | 9 +- .../netstandard2.0/PublicAPI.Unshipped.txt | 9 +- 6 files changed, 26 insertions(+), 192 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index a1c468c87..05d25f268 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -696,10 +696,20 @@ public readonly struct MainThreadAwaitable private readonly bool alwaysYield; + private readonly bool throwOnCancellation; + /// /// Initializes a new instance of the struct. /// internal MainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, CancellationToken cancellationToken, bool alwaysYield = false) + : this(jobFactory, job, alwaysYield, throwOnCancellation: true, cancellationToken) + { + } + + /// + /// Initializes a new instance of the struct. + /// + private MainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, bool throwOnCancellation, CancellationToken cancellationToken) { Requires.NotNull(jobFactory, nameof(jobFactory)); @@ -707,72 +717,35 @@ internal MainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, this.job = job; this.cancellationToken = cancellationToken; this.alwaysYield = alwaysYield; - } - - internal NoThrowMainThreadAwaitable NoThrowAwaitable - { - get - { - if (this.jobFactory is null) - { - return default; - } - - return new NoThrowMainThreadAwaitable(this.jobFactory, this.job, this.cancellationToken, this.alwaysYield); - } + this.throwOnCancellation = throwOnCancellation; } /// - /// Gets the awaiter. + /// Returns an awaitable for the specified + /// operation that will not throw an exception if cancellation is requested. /// - public MainThreadAwaiter GetAwaiter() + /// An awaitable. + public MainThreadAwaitable NoThrowAwaitable() { if (this.jobFactory is null) { return default; } - return new MainThreadAwaiter(this.jobFactory, this.job, this.alwaysYield, this.cancellationToken); - } - } - - /// - /// An awaitable struct that facilitates an asynchronous transition to the Main thread. - /// - public readonly struct NoThrowMainThreadAwaitable - { - private readonly JoinableTaskFactory? jobFactory; - - private readonly JoinableTask? job; - - private readonly CancellationToken cancellationToken; - - private readonly bool alwaysYield; - - /// - /// Initializes a new instance of the struct. - /// - internal NoThrowMainThreadAwaitable(JoinableTaskFactory jobFactory, JoinableTask? job, CancellationToken cancellationToken, bool alwaysYield = false) - { - Requires.NotNull(jobFactory, nameof(jobFactory)); - - this.jobFactory = jobFactory; - this.job = job; - this.cancellationToken = cancellationToken; - this.alwaysYield = alwaysYield; + return new MainThreadAwaitable(this.jobFactory, this.job, this.alwaysYield, throwOnCancellation: false, this.cancellationToken); } /// /// Gets the awaiter. /// - public NoThrowMainThreadAwaiter GetAwaiter() + public MainThreadAwaiter GetAwaiter() { if (this.jobFactory is null) { return default; } - return new NoThrowMainThreadAwaiter(this.jobFactory, this.job, this.alwaysYield, this.cancellationToken); + return new MainThreadAwaiter(this.jobFactory, this.job, this.alwaysYield, this.throwOnCancellation, this.cancellationToken); } } @@ -780,102 +753,6 @@ public NoThrowMainThreadAwaiter GetAwaiter() /// An awaiter struct that facilitates an asynchronous transition to the Main thread. /// public readonly struct MainThreadAwaiter : ICriticalNotifyCompletion - { - private readonly MainThreadAwaiterImpl impl; - - /// - /// Initializes a new instance of the struct. - /// - internal MainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) - { - this.impl = new MainThreadAwaiterImpl(jobFactory, job, alwaysYield, throwOnCancellation: true, cancellationToken); - } - - /// - /// Gets a value indicating whether the caller is already on the Main thread. - /// - public bool IsCompleted => this.impl.IsCompleted; - - /// - /// Schedules a continuation for execution on the Main thread - /// without capturing the ExecutionContext. - /// - /// The action to invoke when the operation completes. - public void UnsafeOnCompleted(Action continuation) - { - this.impl.UnsafeOnCompleted(continuation); - } - - /// - /// Schedules a continuation for execution on the Main thread. - /// - /// The action to invoke when the operation completes. - public void OnCompleted(Action continuation) - { - this.impl.OnCompleted(continuation); - } - - /// - /// Called on the Main thread to prepare it to execute the continuation. - /// - public void GetResult() - { - this.impl.GetResult(); - } - } - - /// - /// An awaiter struct that facilitates an asynchronous transition to the Main thread. - /// - public readonly struct NoThrowMainThreadAwaiter : ICriticalNotifyCompletion - { - private readonly MainThreadAwaiterImpl impl; - - /// - /// Initializes a new instance of the struct. - /// - internal NoThrowMainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, CancellationToken cancellationToken) - { - this.impl = new MainThreadAwaiterImpl(jobFactory, job, alwaysYield, throwOnCancellation: false, cancellationToken); - } - - /// - /// Gets a value indicating whether the caller is already on the Main thread. - /// - public bool IsCompleted => this.impl.IsCompleted; - - /// - /// Schedules a continuation for execution on the Main thread - /// without capturing the ExecutionContext. - /// - /// The action to invoke when the operation completes. - public void UnsafeOnCompleted(Action continuation) - { - this.impl.UnsafeOnCompleted(continuation); - } - - /// - /// Schedules a continuation for execution on the Main thread. - /// - /// The action to invoke when the operation completes. - public void OnCompleted(Action continuation) - { - this.impl.OnCompleted(continuation); - } - - /// - /// Called on the Main thread to prepare it to execute the continuation. - /// - public bool GetResult() - { - return this.impl.GetResult(); - } - } - - /// - /// An awaiter struct that facilitates an asynchronous transition to the Main thread. - /// - private readonly struct MainThreadAwaiterImpl : ICriticalNotifyCompletion { private static readonly Action SafeCancellationAction = state => ThreadPool.QueueUserWorkItem(SingleExecuteProtector.ExecuteOnceWaitCallback, state); @@ -911,9 +788,9 @@ public bool GetResult() private readonly StrongBox? cancellationRegistrationPtr; /// - /// Initializes a new instance of the struct. + /// Initializes a new instance of the struct. /// - internal MainThreadAwaiterImpl(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, bool throwOnCancellation, CancellationToken cancellationToken) + internal MainThreadAwaiter(JoinableTaskFactory jobFactory, JoinableTask? job, bool alwaysYield, bool throwOnCancellation, CancellationToken cancellationToken) { this.jobFactory = jobFactory; this.job = job; @@ -969,7 +846,7 @@ public void OnCompleted(Action continuation) /// /// Called on the Main thread to prepare it to execute the continuation. /// - public bool GetResult() + public void GetResult() { Assumes.True(this.jobFactory is object); if (!(this.jobFactory.Context.IsOnMainThread || this.jobFactory.Context.UnderlyingSynchronizationContext is null || this.cancellationToken.IsCancellationRequested)) @@ -1026,11 +903,6 @@ public bool GetResult() // SwitchToMainThreadAsync is a scheduler method, and always precedes some work by the caller that almost certainly should // not be carried out if cancellation was requested. this.cancellationToken.ThrowIfCancellationRequested(); - return true; - } - else - { - return !this.cancellationToken.IsCancellationRequested; } } diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index 40de50e49..b62198fc3 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -4,6 +4,7 @@ using System; using System.Collections.Generic; using System.Runtime.CompilerServices; +using System.Security; using System.Threading; using System.Threading.Tasks; @@ -240,17 +241,6 @@ public static NoThrowTaskAwaitable NoThrowAwaitable(this Task task, bool capture return new NoThrowTaskAwaitable(task, captureContext); } - /// - /// Returns an awaitable for the specified - /// operation that will return a Boolean value indicating cancellation rather than throwing an exception. - /// - /// The task whose completion should signal the completion of the returned awaitable. - /// An awaitable. - public static JoinableTaskFactory.NoThrowMainThreadAwaitable NoThrowAwaitable(this JoinableTaskFactory.MainThreadAwaitable awaitable) - { - return awaitable.NoThrowAwaitable; - } - /// /// Consumes a task and doesn't do anything with it. Useful for fire-and-forget calls to async methods within async methods. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index cb749cf12..9cf850548 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,11 +1,4 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index cb749cf12..9cf850548 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -1,11 +1,4 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index cb749cf12..9cf850548 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -1,11 +1,4 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index cb749cf12..9cf850548 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,11 +1,4 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.GetResult() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable awaitable) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.NoThrowMainThreadAwaitable +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! From a094f9b633f701cda77840aa6403f8d62b2b62e9 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Mon, 5 Jun 2023 11:42:04 -0500 Subject: [PATCH 0775/1753] Add tests for no-throw switch to main thread --- .../JoinableTaskTests.cs | 121 ++++++++++++++++++ 1 file changed, 121 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index 7b615f24d..fd0f54f20 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -306,6 +306,21 @@ public void SwitchToMainThreadCancellable() Assert.True(task.Wait(TestTimeout * 3), "Test timed out."); } + [Fact] + public void SwitchToMainThreadNoThrowCancellable() + { + var task = Task.Run(async delegate + { + var cts = new CancellationTokenSource(AsyncDelay); + await this.asyncPump.SwitchToMainThreadAsync(cts.Token).NoThrowAwaitable(); + + Assert.Null(SynchronizationContext.Current); + Assert.NotEqual(this.originalThreadManagedId, Environment.CurrentManagedThreadId); + }); + + Assert.True(task.Wait(TestTimeout * 3), "Test timed out."); + } + [Fact] public void SwitchToMainThreadCancellableWithinRun() { @@ -364,6 +379,26 @@ public void SwitchToMainThreadAsync_Await_Canceled_CapturesExecutionContext() task.Wait(this.TimeoutToken); } + [Fact] + public void SwitchToMainThreadAsync_NoThrowAwait_Canceled_CapturesExecutionContext() + { + var factory = (DerivedJoinableTaskFactory)this.asyncPump; + var cts = new CancellationTokenSource(); + var transitionRequested = new ManualResetEventSlim(); + factory.TransitioningToMainThreadCallback = jt => transitionRequested.Set(); + var task = Task.Run(async delegate + { + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + await this.asyncPump.SwitchToMainThreadAsync(cts.Token).NoThrowAwaitable(); + Assert.NotEqual(this.originalThreadManagedId, Environment.CurrentManagedThreadId); + Assert.Equal("expected", asyncLocal.Value); + }); + transitionRequested.Wait(); + cts.Cancel(); + task.Wait(this.TimeoutToken); + } + [Fact] public void SwitchToMainThreadAsync_UnsafeOnCompleted_DoesNotCaptureExecutionContext() { @@ -489,6 +524,21 @@ public void SwitchToMainThread_PrecanceledOnMainThread() }); } + [Fact] + public void SwitchToMainThread_PrecanceledOnMainThread_NoThrow() + { + this.SimulateUIThread(async delegate + { + JoinableTaskFactory.MainThreadAwaiter awaiter = this.asyncPump.SwitchToMainThreadAsync(new CancellationToken(true)).NoThrowAwaitable().GetAwaiter(); + Assert.True(awaiter.IsCompleted); + awaiter.GetResult(); + + // Verify that the SynchronizationContext remains such that we stay on the main thread after yielding. + await Task.Yield(); + Assert.True(this.context.IsOnMainThread); + }); + } + [Fact] public void SwitchToMainThread_PrecanceledOnMainThread_StillYieldsWhenRequired() { @@ -514,6 +564,31 @@ public void SwitchToMainThread_PrecanceledOnMainThread_StillYieldsWhenRequired() }); } + [Fact] + public void SwitchToMainThread_PrecanceledOnMainThread_StillYieldsWhenRequired_NoThrow() + { + this.SimulateUIThread(async delegate + { + JoinableTaskFactory.MainThreadAwaiter awaiter = this.asyncPump.SwitchToMainThreadAsync(alwaysYield: true, new CancellationToken(true)).NoThrowAwaitable().GetAwaiter(); + Assert.False(awaiter.IsCompleted); + var testResult = new TaskCompletionSource(); + awaiter.OnCompleted(delegate + { + try + { + awaiter.GetResult(); + Assert.Equal(this.context.IsOnMainThread, SynchronizationContext.Current is object); + testResult.SetResult(null); + } + catch (Exception ex) + { + testResult.SetException(ex); + } + }); + await testResult.Task.WithCancellation(this.TimeoutToken); + }); + } + [Fact] public void SwitchToMainThreadAsync_CompletesSynchronouslyWhenPreCanceledOffMainThread() { @@ -531,6 +606,22 @@ public void SwitchToMainThreadAsync_CompletesSynchronouslyWhenPreCanceledOffMain }); } + [Fact] + public void SwitchToMainThreadAsync_CompletesSynchronouslyWhenPreCanceledOffMainThread_NoThrow() + { + this.SimulateUIThread(delegate + { + return Task.Run(delegate + { + var precanceled = new CancellationToken(canceled: true); + JoinableTaskFactory.MainThreadAwaiter awaiter = this.asyncPump.SwitchToMainThreadAsync(precanceled).NoThrowAwaitable().GetAwaiter(); + Assert.True(awaiter.IsCompleted); + awaiter.GetResult(); + Assert.Null(SynchronizationContext.Current); + }); + }); + } + [Fact] public void SwitchToMainThreadAsync_CanceledToBackgroundThreadWithSyncContext() { @@ -604,6 +695,36 @@ public void SwitchToMainThreadAsync_ThrowsOnCancellationAfterReachingMainThread( }); } + [Fact] + public void SwitchToMainThreadAsync_NoThrowOnCancellationAfterReachingMainThread() + { + this.SimulateUIThread(delegate + { + return Task.Run(async delegate + { + var cts = new CancellationTokenSource(); + JoinableTaskFactory.MainThreadAwaiter awaiter = this.asyncPump.SwitchToMainThreadAsync(cts.Token).NoThrowAwaitable().GetAwaiter(); + Assert.False(awaiter.IsCompleted); + var testResult = new TaskCompletionSource(); + awaiter.OnCompleted(delegate + { + try + { + Assert.True(this.context.IsOnMainThread); + cts.Cancel(); + awaiter.GetResult(); + testResult.SetResult(null); + } + catch (Exception ex) + { + testResult.SetException(ex); + } + }); + await testResult.Task.WithCancellation(this.TimeoutToken); + }); + }); + } + /// /// Verify that if the was initialized /// without a whose From 7625533a14ab9b7713af550cc81fac3240810d86 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Thu, 1 Jul 2021 14:52:59 -0700 Subject: [PATCH 0776/1753] Implement NoThrowAwaitable for ValueTask --- .../TplExtensions.cs | 112 ++++++++++++++++++ .../net472/PublicAPI.Unshipped.txt | 10 ++ .../net6.0-windows/PublicAPI.Unshipped.txt | 10 ++ .../net6.0/PublicAPI.Unshipped.txt | 10 ++ .../netstandard2.0/PublicAPI.Unshipped.txt | 10 ++ .../TplExtensionsTests.cs | 99 ++++++++++++++++ 6 files changed, 251 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index b62198fc3..d929ff1ea 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Runtime.CompilerServices; using System.Security; using System.Threading; @@ -241,6 +242,19 @@ public static NoThrowTaskAwaitable NoThrowAwaitable(this Task task, bool capture return new NoThrowTaskAwaitable(task, captureContext); } + /// + /// Returns an awaitable for the specified task that will never throw, even if the source task + /// faults or is canceled. + /// + /// The task whose completion should signal the completion of the returned awaitable. + /// if set to the continuation will be scheduled on the caller's context; to always execute the continuation on the threadpool. + /// An awaitable. + [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "The receiver type is disjoint.")] + public static NoThrowValueTaskAwaitable NoThrowAwaitable(this ValueTask task, bool captureContext = true) + { + return new NoThrowValueTaskAwaitable(task, captureContext); + } + /// /// Consumes a task and doesn't do anything with it. Useful for fire-and-forget calls to async methods within async methods. /// @@ -764,6 +778,104 @@ public void GetResult() } } + /// + /// An awaitable that wraps a task and never throws an exception when waited on. + /// + public readonly struct NoThrowValueTaskAwaitable + { + /// + /// The task. + /// + private readonly ValueTask task; + + /// + /// A value indicating whether the continuation should be scheduled on the current sync context. + /// + private readonly bool captureContext; + + /// + /// Initializes a new instance of the struct. + /// + /// The task. + /// Whether the continuation should be scheduled on the current sync context. + public NoThrowValueTaskAwaitable(ValueTask task, bool captureContext) + { + this.task = task.Preserve(); + this.captureContext = captureContext; + } + + /// + /// Gets the awaiter. + /// + /// The awaiter. + public NoThrowValueTaskAwaiter GetAwaiter() + { + return new NoThrowValueTaskAwaiter(this.task, this.captureContext); + } + } + + /// + /// An awaiter that wraps a task and never throws an exception when waited on. + /// + public readonly struct NoThrowValueTaskAwaiter : ICriticalNotifyCompletion + { + /// + /// The task. + /// + private readonly ValueTask task; + + /// + /// A value indicating whether the continuation should be scheduled on the current sync context. + /// + private readonly bool captureContext; + + /// + /// Initializes a new instance of the struct. + /// + /// The task. + /// if set to [capture context]. + public NoThrowValueTaskAwaiter(ValueTask task, bool captureContext) + { + this.task = task; + this.captureContext = captureContext; + } + + /// + /// Gets a value indicating whether the task has completed. + /// + public bool IsCompleted + { + get { return this.task.IsCompleted; } + } + + /// + /// Schedules a delegate for execution at the conclusion of a task's execution. + /// + /// The action. + public void OnCompleted(Action continuation) + { + this.task.ConfigureAwait(this.captureContext).GetAwaiter().OnCompleted(continuation); + } + + /// + /// Schedules a delegate for execution at the conclusion of a task's execution + /// without capturing the ExecutionContext. + /// + /// The action. + public void UnsafeOnCompleted(Action continuation) + { + this.task.ConfigureAwait(this.captureContext).GetAwaiter().UnsafeOnCompleted(continuation); + } + + /// + /// Does nothing. + /// + public void GetResult() + { + // No need to do anything with 'task' because we already called Preserve on it. + } + } + /// /// A state bag for the method. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 9cf850548..753755055 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,4 +1,14 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index 9cf850548..753755055 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -1,4 +1,14 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index 9cf850548..753755055 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -1,4 +1,14 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 9cf850548..753755055 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,4 +1,14 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs index 4e66eeeb2..5adb16b60 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs @@ -430,6 +430,105 @@ public async Task NoThrowAwaitable_UnsafeOnCompleted_DoesNotCaptureExecutionCont await testResultTcs.Task.WithTimeout(UnexpectedTimeout); } + [Fact] + public async Task NoThrowAwaitable_ValueTask() + { + var tcs = new TaskCompletionSource(); + TplExtensions.NoThrowValueTaskAwaitable nothrowTask = new ValueTask(tcs.Task).NoThrowAwaitable(); + Assert.False(nothrowTask.GetAwaiter().IsCompleted); + tcs.SetException(new InvalidOperationException()); + await nothrowTask; + + tcs = new TaskCompletionSource(); + nothrowTask = new ValueTask(tcs.Task).NoThrowAwaitable(); + Assert.False(nothrowTask.GetAwaiter().IsCompleted); + tcs.SetCanceled(); + await nothrowTask; + } + + /// + /// Verifies that independent of whether the or + /// is captured and used to schedule the continuation, the is always captured and applied. + /// + [Theory] + [CombinatorialData] + public async Task NoThrowAwaitable_ValueTask_Await_CapturesExecutionContext(bool captureContext) + { + var awaitableTcs = new TaskCompletionSource(); + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + var testResult = Task.Run(async delegate + { + await new ValueTask(awaitableTcs.Task).NoThrowAwaitable(captureContext); // uses UnsafeOnCompleted + Assert.Equal("expected", asyncLocal.Value); + }); + asyncLocal.Value = null; + await Task.Delay(AsyncDelay); // Make sure the delegate above has time to yield + awaitableTcs.SetResult(null); + + await testResult.WithTimeout(UnexpectedTimeout); + } + + /// + /// Verifies that independent of whether the or + /// is captured and used to schedule the continuation, the is always captured and applied. + /// + [Theory] + [CombinatorialData] + public async Task NoThrowAwaitable_ValueTask_OnCompleted_CapturesExecutionContext(bool captureContext) + { + var testResultTcs = new TaskCompletionSource(); + var awaitableTcs = new TaskCompletionSource(); + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + TplExtensions.NoThrowValueTaskAwaiter awaiter = new ValueTask(awaitableTcs.Task).NoThrowAwaitable(captureContext).GetAwaiter(); + awaiter.OnCompleted(delegate + { + try + { + Assert.Equal("expected", asyncLocal.Value); + testResultTcs.SetResult(null); + } + catch (Exception ex) + { + testResultTcs.SetException(ex); + } + }); + asyncLocal.Value = null; + await Task.Yield(); + awaitableTcs.SetResult(null); + + await testResultTcs.Task.WithTimeout(UnexpectedTimeout); + } + + [Theory] + [CombinatorialData] + public async Task NoThrowAwaitable_ValueTask_UnsafeOnCompleted_DoesNotCaptureExecutionContext(bool captureContext) + { + var testResultTcs = new TaskCompletionSource(); + var awaitableTcs = new TaskCompletionSource(); + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + TplExtensions.NoThrowValueTaskAwaiter awaiter = new ValueTask(awaitableTcs.Task).NoThrowAwaitable(captureContext).GetAwaiter(); + awaiter.UnsafeOnCompleted(delegate + { + try + { + Assert.Null(asyncLocal.Value); + testResultTcs.SetResult(null); + } + catch (Exception ex) + { + testResultTcs.SetException(ex); + } + }); + asyncLocal.Value = null; + await Task.Yield(); + awaitableTcs.SetResult(null); + + await testResultTcs.Task.WithTimeout(UnexpectedTimeout); + } + [Fact] public void InvokeAsyncNullEverything() { From d3cab5e1bbc0c5a8ba2885c98dd4201c98fc966f Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Thu, 1 Jul 2021 15:17:56 -0700 Subject: [PATCH 0777/1753] Implement NoThrowAwaitable for ValueTask --- .../TplExtensions.cs | 132 ++++++++++++++++ .../net472/PublicAPI.Unshipped.txt | 10 ++ .../net6.0-windows/PublicAPI.Unshipped.txt | 10 ++ .../net6.0/PublicAPI.Unshipped.txt | 10 ++ .../netstandard2.0/PublicAPI.Unshipped.txt | 10 ++ .../TplExtensionsTests.cs | 147 ++++++++++++++++++ 6 files changed, 319 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index d929ff1ea..7fe2a473d 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -255,6 +255,38 @@ public static NoThrowValueTaskAwaitable NoThrowAwaitable(this ValueTask task, bo return new NoThrowValueTaskAwaitable(task, captureContext); } + /// + /// Returns an awaitable for the specified task that will never throw, even if the source task + /// faults or is canceled. + /// + /// + /// The awaitable returned by this method does not provide access to the result of a successfully-completed + /// . To await without throwing and use the resulting value, the following + /// pattern may be used: + /// + /// + /// var methodValueTask = MethodAsync().Preserve(); + /// await methodValueTask.NoThrowAwaitable(true); + /// if (methodValueTask.IsCompletedSuccessfully) + /// { + /// var result = methodValueTask.Result; + /// } + /// else + /// { + /// var exception = methodValueTask.AsTask().Exception.InnerException; + /// } + /// + /// + /// The task whose completion should signal the completion of the returned awaitable. + /// if set to the continuation will be scheduled on the caller's context; to always execute the continuation on the threadpool. + /// An awaitable. + /// The type of the result. + [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "The receiver type is disjoint.")] + public static NoThrowValueTaskAwaitable NoThrowAwaitable(this ValueTask task, bool captureContext = true) + { + return new NoThrowValueTaskAwaitable(task, captureContext); + } + /// /// Consumes a task and doesn't do anything with it. Useful for fire-and-forget calls to async methods within async methods. /// @@ -876,6 +908,106 @@ public void GetResult() } } + /// + /// An awaitable that wraps a and never throws an exception when waited on. + /// + /// The type of the result. + public readonly struct NoThrowValueTaskAwaitable + { + /// + /// The task. + /// + private readonly ValueTask task; + + /// + /// A value indicating whether the continuation should be scheduled on the current sync context. + /// + private readonly bool captureContext; + + /// + /// Initializes a new instance of the struct. + /// + /// The task. + /// Whether the continuation should be scheduled on the current sync context. + public NoThrowValueTaskAwaitable(ValueTask task, bool captureContext) + { + this.task = task.Preserve(); + this.captureContext = captureContext; + } + + /// + /// Gets the awaiter. + /// + /// The awaiter. + public NoThrowValueTaskAwaiter GetAwaiter() + { + return new NoThrowValueTaskAwaiter(this.task, this.captureContext); + } + } + + /// + /// An awaiter that wraps a task and never throws an exception when waited on. + /// + /// The type of the result. + public readonly struct NoThrowValueTaskAwaiter : ICriticalNotifyCompletion + { + /// + /// The task. + /// + private readonly ValueTask task; + + /// + /// A value indicating whether the continuation should be scheduled on the current sync context. + /// + private readonly bool captureContext; + + /// + /// Initializes a new instance of the struct. + /// + /// The task. + /// if set to [capture context]. + public NoThrowValueTaskAwaiter(ValueTask task, bool captureContext) + { + this.task = task; + this.captureContext = captureContext; + } + + /// + /// Gets a value indicating whether the task has completed. + /// + public bool IsCompleted + { + get { return this.task.IsCompleted; } + } + + /// + /// Schedules a delegate for execution at the conclusion of a task's execution. + /// + /// The action. + public void OnCompleted(Action continuation) + { + this.task.ConfigureAwait(this.captureContext).GetAwaiter().OnCompleted(continuation); + } + + /// + /// Schedules a delegate for execution at the conclusion of a task's execution + /// without capturing the ExecutionContext. + /// + /// The action. + public void UnsafeOnCompleted(Action continuation) + { + this.task.ConfigureAwait(this.captureContext).GetAwaiter().UnsafeOnCompleted(continuation); + } + + /// + /// Does nothing. + /// + public void GetResult() + { + // No need to do anything with 'task' because we already called Preserve on it. + } + } + /// /// A state bag for the method. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 753755055..4b6e53cb5 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -2,13 +2,23 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrow Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index 753755055..4b6e53cb5 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -2,13 +2,23 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrow Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index 753755055..4b6e53cb5 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -2,13 +2,23 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrow Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 753755055..4b6e53cb5 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -2,13 +2,23 @@ Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrow Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs index 5adb16b60..3dd1c13d8 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs @@ -529,6 +529,153 @@ public async Task NoThrowAwaitable_ValueTask_UnsafeOnCompleted_DoesNotCaptureExe await testResultTcs.Task.WithTimeout(UnexpectedTimeout); } + [Fact] + public async Task NoThrowAwaitable_ValueTaskT_Succeeds() + { + var barrier = new TaskCompletionSource(); + var result = new object(); + var tcs = new TaskCompletionSource(); + var test = Task.Run(async () => + { + ValueTask awaitable = MethodAsync(barrier, result).Preserve(); + await awaitable.NoThrowAwaitable(); + Assert.True(awaitable.IsCompletedSuccessfully); + Assert.Same(result, awaitable.Result); + }); + + barrier.SetResult(null); + await test; + + static async ValueTask MethodAsync(TaskCompletionSource barrier, object result) + { + await barrier.Task; + return result; + } + } + + [Fact] + public async Task NoThrowAwaitable_ValueTaskT_Fails() + { + var barrier = new TaskCompletionSource(); + var result = new InvalidOperationException(); + var tcs = new TaskCompletionSource(); + var test = Task.Run(async () => + { + ValueTask awaitable = MethodAsync(barrier, result).Preserve(); + await awaitable.NoThrowAwaitable(); + Assert.True(awaitable.IsFaulted); + Assert.Same(result, awaitable.AsTask().Exception!.InnerException); + }); + + barrier.SetResult(null); + await test; + + static async ValueTask MethodAsync(TaskCompletionSource barrier, Exception result) + { + await barrier.Task; + throw result; + } + } + + [Fact] + public async Task NoThrowAwaitable_ValueTaskT() + { + var tcs = new TaskCompletionSource(); + TplExtensions.NoThrowValueTaskAwaitable nothrowTask = new ValueTask(tcs.Task).NoThrowAwaitable(); + Assert.False(nothrowTask.GetAwaiter().IsCompleted); + tcs.SetException(new InvalidOperationException()); + await nothrowTask; + + tcs = new TaskCompletionSource(); + nothrowTask = new ValueTask(tcs.Task).NoThrowAwaitable(); + Assert.False(nothrowTask.GetAwaiter().IsCompleted); + tcs.SetCanceled(); + await nothrowTask; + } + + /// + /// Verifies that independent of whether the or + /// is captured and used to schedule the continuation, the is always captured and applied. + /// + [Theory] + [CombinatorialData] + public async Task NoThrowAwaitable_ValueTaskT_Await_CapturesExecutionContext(bool captureContext) + { + var awaitableTcs = new TaskCompletionSource(); + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + var testResult = Task.Run(async delegate + { + await new ValueTask(awaitableTcs.Task).NoThrowAwaitable(captureContext); // uses UnsafeOnCompleted + Assert.Equal("expected", asyncLocal.Value); + }); + asyncLocal.Value = null; + await Task.Delay(AsyncDelay); // Make sure the delegate above has time to yield + awaitableTcs.SetResult(null); + + await testResult.WithTimeout(UnexpectedTimeout); + } + + /// + /// Verifies that independent of whether the or + /// is captured and used to schedule the continuation, the is always captured and applied. + /// + [Theory] + [CombinatorialData] + public async Task NoThrowAwaitable_ValueTaskT_OnCompleted_CapturesExecutionContext(bool captureContext) + { + var testResultTcs = new TaskCompletionSource(); + var awaitableTcs = new TaskCompletionSource(); + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + TplExtensions.NoThrowValueTaskAwaiter awaiter = new ValueTask(awaitableTcs.Task).NoThrowAwaitable(captureContext).GetAwaiter(); + awaiter.OnCompleted(delegate + { + try + { + Assert.Equal("expected", asyncLocal.Value); + testResultTcs.SetResult(null); + } + catch (Exception ex) + { + testResultTcs.SetException(ex); + } + }); + asyncLocal.Value = null; + await Task.Yield(); + awaitableTcs.SetResult(null); + + await testResultTcs.Task.WithTimeout(UnexpectedTimeout); + } + + [Theory] + [CombinatorialData] + public async Task NoThrowAwaitable_ValueTaskT_UnsafeOnCompleted_DoesNotCaptureExecutionContext(bool captureContext) + { + var testResultTcs = new TaskCompletionSource(); + var awaitableTcs = new TaskCompletionSource(); + var asyncLocal = new System.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + TplExtensions.NoThrowValueTaskAwaiter awaiter = new ValueTask(awaitableTcs.Task).NoThrowAwaitable(captureContext).GetAwaiter(); + awaiter.UnsafeOnCompleted(delegate + { + try + { + Assert.Null(asyncLocal.Value); + testResultTcs.SetResult(null); + } + catch (Exception ex) + { + testResultTcs.SetException(ex); + } + }); + asyncLocal.Value = null; + await Task.Yield(); + awaitableTcs.SetResult(null); + + await testResultTcs.Task.WithTimeout(UnexpectedTimeout); + } + [Fact] public void InvokeAsyncNullEverything() { From 0ba0030cbccba29085cb85cfec8702596645a62b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Jun 2023 14:30:51 -0600 Subject: [PATCH 0778/1753] Enable dependabot for Azure Repos --- .azuredevops/dependabot.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .azuredevops/dependabot.yml diff --git a/.azuredevops/dependabot.yml b/.azuredevops/dependabot.yml new file mode 100644 index 000000000..4d848fb58 --- /dev/null +++ b/.azuredevops/dependabot.yml @@ -0,0 +1,9 @@ +# Please see the documentation for all configuration options: +# https://eng.ms/docs/products/dependabot/configuration/version_updates + +version: 2 +updates: +- package-ecosystem: nuget + directory: / + schedule: + interval: monthly From e22efe97b08fa4795d834d7e16310143195345d6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Jun 2023 15:52:58 -0600 Subject: [PATCH 0779/1753] Bump Microsoft.NET.Test.Sdk to 17.6.2 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 386c6eecb..1de332842 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From b077dd9451c6676f9a9a0ad9cda0bee636e49c67 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Jun 2023 08:31:07 -0600 Subject: [PATCH 0780/1753] Bump MicroBuild to 2.0.125 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2fe653ee3..7c07eff15 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.117 + 2.0.125 From 6686cb46405f3692156a6dc9a37b26f7c43a3b4a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Jun 2023 09:09:21 -0600 Subject: [PATCH 0781/1753] Merge latest Library.Template --- .config/dotnet-tools.json | 4 ++-- .github/dependabot.yml | 4 ++-- Directory.Packages.props | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 54fc58866..fa4ceb59c 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,13 +15,13 @@ ] }, "dotnet-coverage": { - "version": "17.7.0", + "version": "17.7.1", "commands": [ "dotnet-coverage" ] }, "nbgv": { - "version": "3.6.128", + "version": "3.6.133", "commands": [ "nbgv" ] diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5be11b36a..6cc61b83c 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,11 +1,11 @@ # Please see the documentation for all configuration options: -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file version: 2 updates: - package-ecosystem: nuget directory: / schedule: - interval: monthly + interval: weekly ignore: - dependency-name: Microsoft.CodeAnalysis* # We intentionally target older VS versions. diff --git a/Directory.Packages.props b/Directory.Packages.props index 930fc8e29..c81ba0a0a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -3,7 +3,7 @@ true true - 2.0.117 + 2.0.125 3.11.0 4.4.0 1.1.1 @@ -22,7 +22,7 @@ - + @@ -44,11 +44,11 @@ - + - + From 61c1f4ac81899d6574177475f13fdb63b6932349 Mon Sep 17 00:00:00 2001 From: ekoppel <36491636+ekoppel@users.noreply.github.com> Date: Mon, 12 Jun 2023 14:29:03 -0700 Subject: [PATCH 0782/1753] Stabilize 17.7 --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index 25e4c41b3..0bda8e59c 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.7-preview", + "version": "17.7", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 5a7ce31fa8a9a4aba53bc853529bc7bf308e9111 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Jun 2023 14:17:25 -0600 Subject: [PATCH 0783/1753] Fix symbol file selection for R2R outputs --- azure-pipelines/Get-SymbolFiles.ps1 | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index 0ce229fc2..b5063cec6 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -43,8 +43,13 @@ $PDBs |% { } } |% { # Collect the DLLs/EXEs as well. - $dllPath = "$($_.Directory)/$($_.BaseName).dll" - $exePath = "$($_.Directory)/$($_.BaseName).exe" + $rootName = "$($_.Directory)/$($_.BaseName)" + if ($rootName.EndsWith('.ni')) { + $rootName = $rootName.Substring(0, $rootName.Length - 3) + } + + $dllPath = "$rootName.dll" + $exePath = "$rootName.exe" if (Test-Path $dllPath) { $BinaryImagePath = $dllPath } elseif (Test-Path $exePath) { From 0913be2eddc4012c3a3c4eac5b7a4e2d427a2b35 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Jun 2023 07:39:46 -0600 Subject: [PATCH 0784/1753] Simplify `nbgv` invocation in ps1 scripts This is another attempt to address the mysterious instability. --- azure-pipelines/Archive-SourceCode.ps1 | 2 +- azure-pipelines/Merge-CodeCoverage.ps1 | 2 +- azure-pipelines/variables/InsertVersionsValues.ps1 | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index 9158c9b34..e44dad008 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -155,7 +155,7 @@ if (!$RepoUrl) { } Push-Location $PSScriptRoot -$versionsObj = dotnet tool run nbgv get-version -f json | ConvertFrom-Json +$versionsObj = dotnet nbgv get-version -f json | ConvertFrom-Json Pop-Location $ReleaseDateString = $ReleaseDate.ToShortDateString() diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 5ecabbc9b..b126268ca 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -42,7 +42,7 @@ try { New-Item -Type Directory -Path (Split-Path $OutputFile) | Out-Null } - & dotnet tool run dotnet-coverage merge $Inputs -o $OutputFile -f cobertura + & dotnet dotnet-coverage merge $Inputs -o $OutputFile -f cobertura } else { Write-Error "No reports found to merge." } diff --git a/azure-pipelines/variables/InsertVersionsValues.ps1 b/azure-pipelines/variables/InsertVersionsValues.ps1 index 2eb2fcea9..7475f6bec 100644 --- a/azure-pipelines/variables/InsertVersionsValues.ps1 +++ b/azure-pipelines/variables/InsertVersionsValues.ps1 @@ -7,5 +7,5 @@ return $MacroName = 'LibraryNoDotsVersion' $SampleProject = "$PSScriptRoot\..\..\src\LibraryName" [string]::join(',',(@{ - ($MacroName) = & { (dotnet tool run nbgv -- get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; + ($MacroName) = & { (dotnet nbgv get-version --project $SampleProject --format json | ConvertFrom-Json).AssemblyVersion }; }.GetEnumerator() |% { "$($_.key)=$($_.value)" })) From 654a3a6ea2205d30d56bc9f617a619e5f613c019 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Jun 2023 12:19:28 -0600 Subject: [PATCH 0785/1753] Fix optprof runs --- azure-pipelines/secure-development-tools.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index ce8ac94cf..73be82db4 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -72,6 +72,7 @@ steps: GdnBreakSuppressionSets: falsepositives GdnBreakOutputSuppressionFile: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions/ GdnBreakOutputSuppressionSet: falsepositives + condition: and(succeeded(), ne(variables['OptProf'], 'true')) # This is useful when false positives appear so we can copy some of the output into the suppressions file. - publish: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions From 3ea9ad353e5975832ef7952f1298ff099e03a7d9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Jun 2023 13:23:29 -0600 Subject: [PATCH 0786/1753] Skip compliance checks by default for build.yml But it's still on by default for official builds. --- azure-pipelines/build.yml | 4 ++-- azure-pipelines/vs-validation.yml | 2 -- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 2a50cea95..59d9a987e 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -9,10 +9,10 @@ parameters: default: true - name: EnableCompliance type: boolean - default: true + default: false - name: EnableAPIScan type: boolean - default: true + default: false jobs: - job: Windows diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index d32634c70..cb9a2072e 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -17,8 +17,6 @@ stages: jobs: - template: build.yml parameters: - EnableCompliance: false - EnableAPIScan: false windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: false RunTests: false From 9109dfc1add45b5367ecbcb3c540098f0d4d61d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 19 Jun 2023 15:40:05 -0600 Subject: [PATCH 0787/1753] Bump MicroBuild to 2.0.127 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 76b8ab2ad..230fe810a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.125 + 2.0.127 From dfd047b7be229f1a17e307137a3d9ae3ae47673a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 Jun 2023 15:40:34 -0600 Subject: [PATCH 0788/1753] Bump MicroBuildVersion from 2.0.125 to 2.0.127 (#1201) Bumps `MicroBuildVersion` from 2.0.125 to 2.0.127. Updates `Microsoft.VisualStudio.Internal.MicroBuild.NonShipping` from 2.0.125 to 2.0.127 Updates `Microsoft.VisualStudio.Internal.MicroBuild.VisualStudio` from 2.0.125 to 2.0.127 --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Internal.MicroBuild.NonShipping dependency-type: direct:production update-type: version-update:semver-patch - dependency-name: Microsoft.VisualStudio.Internal.MicroBuild.VisualStudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c81ba0a0a..c9e884294 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -3,7 +3,7 @@ true true - 2.0.125 + 2.0.127 3.11.0 4.4.0 1.1.1 From 15e70c69933222abb7f541b2819bbbf2d31c2fc7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 Jun 2023 15:40:55 -0600 Subject: [PATCH 0789/1753] Bump CSharpIsNullAnalyzer from 0.1.329 to 0.1.495 (#1189) Bumps [CSharpIsNullAnalyzer](https://github.com/AArnott/CSharpIsNull) from 0.1.329 to 0.1.495. - [Release notes](https://github.com/AArnott/CSharpIsNull/releases) - [Commits](https://github.com/AArnott/CSharpIsNull/commits) --- updated-dependencies: - dependency-name: CSharpIsNullAnalyzer dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> From 18710500489c2cac5d146411be32e3fc8bf79a9e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 19 Jun 2023 15:41:52 -0600 Subject: [PATCH 0790/1753] Bump dotnet-coverage to 17.7.2 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index fa4ceb59c..a8478486c 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.7.1", + "version": "17.7.2", "commands": [ "dotnet-coverage" ] From ba056964139aaa2ede6ce37019e1b9f2073c7484 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 26 Jun 2023 17:10:49 -0600 Subject: [PATCH 0791/1753] Bump StyleCop.Analyzers.Unstable from 1.2.0.435 to 1.2.0.507 (#207) Bumps [StyleCop.Analyzers.Unstable](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) from 1.2.0.435 to 1.2.0.507. - [Release notes](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/releases) - [Changelog](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/KnownChanges.md) - [Commits](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commits) --- updated-dependencies: - dependency-name: StyleCop.Analyzers.Unstable dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1de332842..6942b31ec 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -14,7 +14,7 @@ - + From 03de5e6821c5b280fcd006eb240486a0df519b49 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 26 Jun 2023 17:10:58 -0600 Subject: [PATCH 0792/1753] Bump dotnet-coverage from 17.7.2 to 17.7.3 (#208) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.7.2 to 17.7.3. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index a8478486c..970744649 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.7.2", + "version": "17.7.3", "commands": [ "dotnet-coverage" ] From 2822cf0ca631c2b69a9b01a2f347b61756c86904 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Jun 2023 15:36:49 -0600 Subject: [PATCH 0793/1753] Bump MicroBuildVersion to 2.0.130 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6fe0d352f..8ce96a8fc 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.127 + 2.0.130 From 1769c8a9a3f4a23e0c8bd81f8d0c84500c889513 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Jun 2023 15:58:44 -0600 Subject: [PATCH 0794/1753] Allow VS Code its changes --- .vscode/settings.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 3ae1371c6..92408eb68 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -3,6 +3,7 @@ "files.insertFinalNewline": true, "files.trimFinalNewlines": true, "omnisharp.enableEditorConfigSupport": true, - "omnisharp.enableImportCompletion": true, - "omnisharp.enableRoslynAnalyzers": true + "omnisharp.enableRoslynAnalyzers": true, + "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true, + "dotnet.defaultSolution": "Microsoft.VisualStudio.Threading.sln" } From 71f5f3617c3e64c99c0613c700bf227da2af37e6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Jun 2023 06:57:44 -0600 Subject: [PATCH 0795/1753] Bump Microsoft.NET.Test.Sdk to 17.6.3 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6942b31ec..c15928bee 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 88e70184a887b05249cb829b8cefcca1b834b342 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Jun 2023 07:01:02 -0600 Subject: [PATCH 0796/1753] Bump powershell to 7.3.5 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 970744649..e344d8b0d 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.4", + "version": "7.3.5", "commands": [ "pwsh" ] From b0f343dba369555ef366435a8c7e9181fe98ea88 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Jun 2023 09:06:47 -0600 Subject: [PATCH 0797/1753] Automatically include a README.md from the project directory --- src/Directory.Build.props | 8 ++++++++ src/Library/Library.csproj | 4 ---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 052fe3ef0..5be1dd441 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,3 +1,11 @@ + + + README.md + + + + + diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index b6b926ab7..50aff9973 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,9 +1,5 @@ net6.0;netstandard2.0 - README.md - - - From 1fb79097c93093d778a2f4709b5365c206873fd1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Jun 2023 09:27:29 -0600 Subject: [PATCH 0798/1753] Update and restructure README --- README.md | 63 ++++++------------- .../README.md | 5 ++ .../README.md | 28 +++++++++ 3 files changed, 53 insertions(+), 43 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md create mode 100644 src/Microsoft.VisualStudio.Threading/README.md diff --git a/README.md b/README.md index d1e841e86..ba08fea4f 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,24 @@ -Microsoft.VisualStudio.Threading -================================= +# vs-threading -[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Threading) [![Build Status](https://dev.azure.com/azure-public/vside/_apis/build/status/vs-threading)](https://dev.azure.com/azure-public/vside/_build/latest?definitionId=12) [![Join the chat at https://gitter.im/vs-threading/Lobby](https://badges.gitter.im/vs-threading/Lobby.svg)](https://gitter.im/vs-threading/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -Analyzers: [![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.Analyzers.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Threading.Analyzers) - -## Features - -* Async versions of many threading synchronization primitives - * `AsyncAutoResetEvent` - * `AsyncBarrier` - * `AsyncCountdownEvent` - * `AsyncManualResetEvent` - * `AsyncReaderWriterLock` - * `AsyncSemaphore` - * `ReentrantSemaphore` -* Async versions of very common types - * `AsyncEventHandler` - * `AsyncLazy` - * `AsyncLazyInitializer` - * `AsyncLocal` - * `AsyncQueue` -* Await extension methods - * Await on a `TaskScheduler` to switch to it. - Switch to a background thread with `await TaskScheduler.Default;` - * Await on a `Task` with a timeout - * Await on a `Task` with cancellation -* `JoinableTaskFactory` that allows you to schedule asynchronous or synchronous work - that does not deadlock with the UI thread even when the UI thread needs to - synchronously block on the result. - -## Documentation - -* [Overview documentation](doc/index.md) -* [Diagnostic analyzer rules](doc/analyzers/index.md) - -## Supported platforms - -* .NET 4.5 -* .NET 4.6 -* .NET Standard 1.3 -* .NET Standard 2.0 - -[1]: https://nuget.org/packages/Microsoft.VisualStudio.Threading "Microsoft.VisualStudio.Threading NuGet package" +## Microsoft.VisualStudio.Threading + +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Threading) + +Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). + +[Overview documentation](doc/index.md). + +[See the full list of features](src/Microsoft.VisualStudio.Threading/README.md). + +## Microsoft.VisualStudio.Threading.Analyzers + +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.Analyzers.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Threading.Analyzers) + +Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. + +[Diagnostic analyzer rules](doc/analyzers/index.md). + +[See the full list of features](src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md). diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md new file mode 100644 index 000000000..b6955d52e --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md @@ -0,0 +1,5 @@ +# Microsoft.VisualStudio.Threading.Analyzers + +Static code analyzers to detect common mistakes or potential issues regarding threading and async coding. + +[Diagnostic analyzer rules](https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/index.md). diff --git a/src/Microsoft.VisualStudio.Threading/README.md b/src/Microsoft.VisualStudio.Threading/README.md new file mode 100644 index 000000000..465ce9f1d --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/README.md @@ -0,0 +1,28 @@ +# Microsoft.VisualStudio.Threading + +Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). + +## Features + +* Async versions of many threading synchronization primitives + * `AsyncAutoResetEvent` + * `AsyncBarrier` + * `AsyncCountdownEvent` + * `AsyncManualResetEvent` + * `AsyncReaderWriterLock` + * `AsyncSemaphore` + * `ReentrantSemaphore` +* Async versions of very common types + * `AsyncEventHandler` + * `AsyncLazy` + * `AsyncLazyInitializer` + * `AsyncLocal` + * `AsyncQueue` +* Await extension methods + * Await on a `TaskScheduler` to switch to it. + Switch to a background thread with `await TaskScheduler.Default;` + * Await on a `Task` with a timeout + * Await on a `Task` with cancellation +* `JoinableTaskFactory` that allows you to schedule asynchronous or synchronous work + that does not deadlock with the UI thread even when the UI thread needs to + synchronously block on the result. From a3626ffcae544c8963e1ced03f30f7ee918f26bf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 3 Jul 2023 08:39:11 -0600 Subject: [PATCH 0799/1753] Set version to '17.8-alpha' --- version.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/version.json b/version.json index 0bda8e59c..3617e7bb4 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { - "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.7", + "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", + "version": "17.8-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} +} \ No newline at end of file From 7d92b4ab86281d8f041d79c1b01018c98a211286 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Jul 2023 15:02:28 -0600 Subject: [PATCH 0800/1753] Bump xunit.runner.visualstudio from 2.4.5 to 2.5.0 (#210) Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.4.5 to 2.5.0. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/compare/v2.4.5...2.5.0) --- updated-dependencies: - dependency-name: xunit.runner.visualstudio dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c15928bee..3ac312f9d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ - + From 4822f178831d771c1d28288703651b687e22f593 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Jul 2023 15:07:54 -0600 Subject: [PATCH 0801/1753] Bump MicroBuildVersion to 2.0.131 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 250a08a52..e58842843 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.130 + 2.0.131 From 2e19c89761d8d7f934250f4effca22136c48cf39 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Jul 2023 21:08:52 +0000 Subject: [PATCH 0802/1753] Bump xunit from 2.4.2 to 2.5.0 (#209) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 3ac312f9d..6af95c882 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 75b0953f6e91e66076030f20fa0bc4a2990ad906 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Jul 2023 15:25:18 -0600 Subject: [PATCH 0803/1753] Remove `tool run` from `dotnet nbgv` invocation I have an Azure Pipeline where `InsertVersionsValues.ps1` (in the microbuild branch) works but this step fails, and the only difference is that one omits `tool run` from `dotnet nbgv`. I continue to believe this is a bug in the `dotnet tool` command. --- azure-pipelines/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 2e2f426e0..9c445f727 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -17,7 +17,7 @@ jobs: clean: true - template: install-dependencies.yml - - script: dotnet tool run nbgv cloud -c + - script: dotnet nbgv cloud -c displayName: ⚙ Set build number - template: dotnet.yml From 442ca7c6e521a55a39351b9ef3a3b81207fa4ef5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Jul 2023 16:12:43 -0600 Subject: [PATCH 0804/1753] Dependabot to ignore dotnet-format --- .github/dependabot.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 63e3e890b..484f2bfcd 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,3 +7,7 @@ updates: directory: / schedule: interval: weekly + ignore: + # This package has unlisted versions on nuget.org that are not supported. Avoid them. + - dependency-name: dotnet-format + versions: ["6.x", "7.x", "8.x"] From b379933ef3581bd4904e883d92ebcd72a018a321 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Jul 2023 19:46:17 -0600 Subject: [PATCH 0805/1753] Set tab settings for .ps1 files --- .editorconfig | 4 ++++ .vscode/settings.json | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index fce73c076..959801c2e 100644 --- a/.editorconfig +++ b/.editorconfig @@ -32,6 +32,10 @@ indent_size = 2 indent_size = 2 indent_style = space +[*.ps1] +indent_style = space +indent_size = 4 + # Dotnet code style settings: [*.{cs,vb}] # Sort using and Import directives with System.* appearing first diff --git a/.vscode/settings.json b/.vscode/settings.json index 3ae1371c6..54c5c6896 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -3,6 +3,6 @@ "files.insertFinalNewline": true, "files.trimFinalNewlines": true, "omnisharp.enableEditorConfigSupport": true, - "omnisharp.enableImportCompletion": true, - "omnisharp.enableRoslynAnalyzers": true + "omnisharp.enableRoslynAnalyzers": true, + "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true } From 5234be7c0ca6b6e03d5118a95fca5b539e3af585 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jul 2023 16:16:56 -0600 Subject: [PATCH 0806/1753] Promote unshipped to shipped APIs Also delete unused netcoreapp3.1 API files. --- .../net472/PublicAPI.Shipped.txt | 25 + .../net472/PublicAPI.Unshipped.txt | 25 - .../net6.0-windows/PublicAPI.Shipped.txt | 25 + .../net6.0-windows/PublicAPI.Unshipped.txt | 25 - .../net6.0/PublicAPI.Shipped.txt | 25 + .../net6.0/PublicAPI.Unshipped.txt | 25 - .../netcoreapp3.1/PublicAPI.Shipped.txt | 470 ------------------ .../netcoreapp3.1/PublicAPI.Unshipped.txt | 0 .../netstandard2.0/PublicAPI.Shipped.txt | 25 + .../netstandard2.0/PublicAPI.Unshipped.txt | 25 - 10 files changed, 100 insertions(+), 570 deletions(-) delete mode 100644 src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt index 99f3cea34..591cdfcc6 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt @@ -470,3 +470,28 @@ Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedExcep Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 4b6e53cb5..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,25 +0,0 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt index 99f3cea34..591cdfcc6 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt @@ -470,3 +470,28 @@ Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedExcep Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index 4b6e53cb5..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -1,25 +0,0 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt index 21783f9f2..c11a2e452 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt @@ -468,3 +468,28 @@ Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedExcep Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index 4b6e53cb5..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -1,25 +0,0 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt deleted file mode 100644 index 21783f9f2..000000000 --- a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Shipped.txt +++ /dev/null @@ -1,470 +0,0 @@ -#nullable enable -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncBarrier -Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncLazy -Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool -Microsoft.VisualStudio.Threading.AsyncLocal -Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void -Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? -Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue -Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int -Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void -Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T -Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncSemaphore -Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void -Microsoft.VisualStudio.Threading.HangReportContribution -Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! -Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? -Microsoft.VisualStudio.Threading.IAsyncDisposable -Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.IHangReportContributor -Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext -Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContextException -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskFactory -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ReentrantSemaphore -Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void -Microsoft.VisualStudio.Threading.SpecializedSyncContext -Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void -Microsoft.VisualStudio.Threading.ThreadingTools -Microsoft.VisualStudio.Threading.TplExtensions -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask -override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! -static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! -static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void -virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void -virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter diff --git a/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netcoreapp3.1/PublicAPI.Unshipped.txt deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt index 21783f9f2..c11a2e452 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt @@ -468,3 +468,28 @@ Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedExcep Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter +Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void +Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable +virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! +Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 4b6e53cb5..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,25 +0,0 @@ -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! From 62ed6137a6d4e307a0190a590cf24f7dadf82708 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jul 2023 17:29:04 -0600 Subject: [PATCH 0807/1753] Adapt to xunit breaking changes --- .../AssertEx.cs | 8 +++---- .../AsyncAutoResetEventTests.cs | 4 ++-- .../AsyncReaderWriterLockTests.cs | 24 +++++++++---------- .../AsyncReaderWriterResourceLockTests.cs | 14 +++++------ .../AsyncSemaphoreTests.cs | 4 ++-- .../AwaitExtensionsTests.cs | 12 +++++----- ...inableTaskAndAsyncReaderWriterLockTests.cs | 4 ++-- .../JoinableTaskTests.cs | 10 ++++---- .../ThreadingToolsTests.cs | 2 +- .../TplExtensionsTests.cs | 6 ++--- 10 files changed, 44 insertions(+), 44 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs b/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs index 090b99259..0867a7998 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs @@ -10,7 +10,7 @@ public static void Equal(T expected, T actual, string message) { if (!EqualityComparer.Default.Equals(expected, actual)) { - throw new Xunit.Sdk.AssertActualExpectedException(expected, actual, message); + throw Xunit.Sdk.EqualException.ForMismatchedValues(expected, actual, message); } } @@ -18,7 +18,7 @@ public static void Equal(T expected, T actual, string formattingMessage, para { if (!EqualityComparer.Default.Equals(expected, actual)) { - throw new Xunit.Sdk.AssertActualExpectedException(expected, actual, string.Format(CultureInfo.CurrentCulture, formattingMessage, formattingArgs)); + throw Xunit.Sdk.EqualException.ForMismatchedValues(expected, actual, string.Format(CultureInfo.CurrentCulture, formattingMessage, formattingArgs)); } } @@ -26,7 +26,7 @@ public static void NotEqual(T expected, T actual, string message) { if (EqualityComparer.Default.Equals(expected, actual)) { - throw new Xunit.Sdk.AssertActualExpectedException(expected, actual, message); + throw Xunit.Sdk.NotEqualException.ForEqualValues(expected?.ToString() ?? "", actual?.ToString() ?? "", message); } } @@ -34,7 +34,7 @@ public static void NotEqual(T expected, T actual, string formattingMessage, p { if (EqualityComparer.Default.Equals(expected, actual)) { - throw new Xunit.Sdk.AssertActualExpectedException(expected, actual, string.Format(CultureInfo.CurrentCulture, formattingMessage, formattingArgs)); + throw Xunit.Sdk.NotEqualException.ForEqualValues(expected?.ToString() ?? "", actual?.ToString() ?? "", string.Format(CultureInfo.CurrentCulture, formattingMessage, formattingArgs)); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs index c3114327a..fffb45d83 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs @@ -121,7 +121,7 @@ public void WaitAsync_WithCancellationToken_DoesNotClaimSignal() try { waitTask.GetAwaiter().GetResult(); - Assert.True(false, "Task was expected to transition to a canceled state."); + Assert.Fail("Task was expected to transition to a canceled state."); } catch (OperationCanceledException ex) { @@ -148,7 +148,7 @@ public void WaitAsync_WithCancellationToken_PrecanceledDoesNotClaimExistingSigna try { this.evt.WaitAsync(token).GetAwaiter().GetResult(); - Assert.True(false, "Task was expected to transition to a canceled state."); + Assert.Fail("Task was expected to transition to a canceled state."); } catch (OperationCanceledException ex) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index d5a9f10bf..4f0a78ab5 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -2652,7 +2652,7 @@ await Task.Run(delegate try { awaiter.GetResult(); - Assert.True(false, "Expected OperationCanceledException not thrown."); + Assert.Fail("Expected OperationCanceledException not thrown."); } catch (OperationCanceledException) { @@ -2670,7 +2670,7 @@ public void PrecancelledWriteLockAsyncRequestOnSTA() try { awaiter.GetResult(); - Assert.True(false, "Expected OperationCanceledException not thrown."); + Assert.Fail("Expected OperationCanceledException not thrown."); } catch (OperationCanceledException) { @@ -2702,7 +2702,7 @@ await Task.WhenAll( try { awaiter.GetResult(); - cancellationTestConcluded.SetException(new ThrowsException(typeof(OperationCanceledException))); + cancellationTestConcluded.SetException(ThrowsException.ForNoException(typeof(OperationCanceledException))); } catch (OperationCanceledException) { @@ -2740,7 +2740,7 @@ await Task.WhenAll( try { awaiter.GetResult(); - cancellationTestConcluded.SetException(new ThrowsException(typeof(OperationCanceledException))); + cancellationTestConcluded.SetException(ThrowsException.ForNoException(typeof(OperationCanceledException))); } catch (OperationCanceledException) { @@ -3026,7 +3026,7 @@ public void CompleteBlocksNewTopLevelLocksSTA() try { awaiter.GetResult(); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (InvalidOperationException) { @@ -3047,7 +3047,7 @@ await Task.Run(delegate try { awaiter.GetResult(); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (InvalidOperationException) { @@ -3448,7 +3448,7 @@ public async Task OnBeforeWriteLockReleasedDelegateThrows() this.asyncLock.Complete(); } - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (AggregateException ex) { @@ -4184,7 +4184,7 @@ public async Task WriteNestsReadWithWriteReleasedFirstWithoutTaskRun() try { await completingTask; // observe any exception. - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (CriticalErrorException ex) { @@ -4993,7 +4993,7 @@ private async Task MitigationAgainstAccidentalLockForkingHelper(Func { Assert.Same(state, s); - Assert.True(false, "Read locks should not invoke this."); + Assert.Fail("Read locks should not invoke this."); return false; }, state); @@ -1216,7 +1216,7 @@ public async Task GetResourceAsyncRetriesFaultedPreparation() try { await access.GetResourceAsync(1); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (ApplicationException) { @@ -1242,7 +1242,7 @@ public async Task PrepareResourceForConcurrentAccessAsync_ThrowsDuringReadShould try { Resource? resource = await access.GetResourceAsync(1); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (ApplicationException) { @@ -1275,7 +1275,7 @@ public async Task PrepareResourceForConcurrentAccessAsync_ThrowsReleasingWriteSh try { await writeAccess.ReleaseAsync(); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (ApplicationException) { @@ -1285,7 +1285,7 @@ public async Task PrepareResourceForConcurrentAccessAsync_ThrowsReleasingWriteSh } // Exiting the using block should also throw. - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (ApplicationException) { @@ -1308,7 +1308,7 @@ public async Task PrepareResourceForConcurrentAccessAsync_ThrowsReleasingWriteSh try { await readAccess.GetResourceAsync(1); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (ApplicationException) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs index 39c8bc4e0..b5cd20d64 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs @@ -158,7 +158,7 @@ public async Task ContestedAndCancelledWithTimeoutSpecified() try { await second; - Assert.True(false, "Expected OperationCanceledException not thrown."); + Assert.Fail("Expected OperationCanceledException not thrown."); } catch (OperationCanceledException ex) { @@ -176,7 +176,7 @@ public void PreCancelled() try { enterAsyncTask.GetAwaiter().GetResult(); - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (OperationCanceledException ex) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index 447ae6689..c304e8a9c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -507,7 +507,7 @@ public async Task ConfigureAwaitForAggregateException_ThrowsAggregateException() try { await joint.ConfigureAwaitForAggregateException(); - Assert.False(true, "Exception was not thrown."); + Assert.Fail("Exception was not thrown."); } catch (AggregateException ex) { @@ -523,7 +523,7 @@ public async Task ConfigureAwaitForAggregateException_Canceled() try { await canceled.ConfigureAwaitForAggregateException(); - Assert.False(true, "Exception was not thrown."); + Assert.Fail("Exception was not thrown."); } catch (OperationCanceledException) { @@ -540,7 +540,7 @@ public async Task ConfigureAwaitForAggregateException_InnerCanceled() try { await joint.ConfigureAwaitForAggregateException(); - Assert.False(true, "Exception was not thrown."); + Assert.Fail("Exception was not thrown."); } catch (OperationCanceledException) { @@ -557,7 +557,7 @@ public async Task ConfigureAwaitForAggregateException_InnerCanceledAndFaulted() try { await joint.ConfigureAwaitForAggregateException(); - Assert.False(true, "Exception was not thrown."); + Assert.Fail("Exception was not thrown."); } catch (AggregateException ex) { @@ -718,7 +718,7 @@ public async Task AwaitRegKeyChange_Canceled() try { await changeWatcherTask; - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (OperationCanceledException ex) { @@ -756,7 +756,7 @@ public async Task AwaitRegKeyChange_CanceledAndImmediatelyDisposed() try { await watchingTask; - Assert.True(false, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (OperationCanceledException ex) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs index 67cbc3d1b..2c05ec10f 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs @@ -163,7 +163,7 @@ public async Task RunWithinUpgradeableReadLockThrows() try { this.asyncPump.Run(() => Task.CompletedTask); - Assert.False(true, "Expected InvalidOperationException not thrown."); + Assert.Fail("Expected InvalidOperationException not thrown."); } catch (InvalidOperationException) { @@ -190,7 +190,7 @@ public async Task RunWithinWriteLockThrows() try { this.asyncPump.Run(() => Task.CompletedTask); - Assert.True(false, "Expected InvalidOperationException not thrown."); + Assert.Fail("Expected InvalidOperationException not thrown."); } catch (InvalidOperationException) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index fd0f54f20..0ec61cb6a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -293,7 +293,7 @@ public void SwitchToMainThreadCancellable() try { await this.asyncPump.SwitchToMainThreadAsync(cts.Token); - Assert.True(false, "Expected OperationCanceledException not thrown."); + Assert.Fail("Expected OperationCanceledException not thrown."); } catch (OperationCanceledException) { @@ -337,7 +337,7 @@ public void SwitchToMainThreadCancellableWithinRun() }); } }); - Assert.True(false, "Expected OperationCanceledException not thrown."); + Assert.Fail("Expected OperationCanceledException not thrown."); } catch (OperationCanceledException) { @@ -2500,7 +2500,7 @@ public void PostedMessagesAlsoSentToDispatcher() if (ex is object) { - Assert.True(false, $"Posted message threw an exception: {ex}"); + Assert.Fail($"Posted message threw an exception: {ex}"); } return Task.CompletedTask; @@ -3491,7 +3491,7 @@ public void RunAsyncExceptionsCapturedInResult() try { awaiter.GetResult(); - Assert.True(false, "Expected exception not rethrown."); + Assert.Fail("Expected exception not rethrown."); } catch (InvalidOperationException ex) { @@ -3513,7 +3513,7 @@ public void RunAsyncOfTExceptionsCapturedInResult() try { awaiter.GetResult(); - Assert.True(false, "Expected exception not rethrown."); + Assert.Fail("Expected exception not rethrown."); } catch (InvalidOperationException ex) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs index 839c15bfc..aec072c82 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs @@ -179,7 +179,7 @@ public void WithCancellationOfTNoDeadlockFromSyncContext() try { tcs.Task.WithCancellation(cts.Token).Wait(TestTimeout); - Assert.True(false, "Expected OperationCanceledException not thrown."); + Assert.Fail("Expected OperationCanceledException not thrown."); } catch (AggregateException ex) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs index 3dd1c13d8..d73549251 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs @@ -299,7 +299,7 @@ public void WaitWithoutInlining_Canceled() try { tcs.Task.WaitWithoutInlining(); - Assert.False(true, "Expected exception not thrown."); + Assert.Fail("Expected exception not thrown."); } catch (AggregateException ex) { @@ -765,7 +765,7 @@ public void InvokeAsyncAggregatesExceptions() try { task.GetAwaiter().GetResult(); - Assert.True(false, "Expected AggregateException not thrown."); + Assert.Fail("Expected AggregateException not thrown."); } catch (AggregateException ex) { @@ -792,7 +792,7 @@ public void InvokeAsyncOfTAggregatesExceptions() try { task.GetAwaiter().GetResult(); - Assert.True(false, "Expected AggregateException not thrown."); + Assert.Fail("Expected AggregateException not thrown."); } catch (AggregateException ex) { From 0f7accdd5ed39690633bba7a7f9f83f3caf0b970 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Jul 2023 07:37:40 -0600 Subject: [PATCH 0808/1753] Bump powershell from 7.3.5 to 7.3.6 (#212) Bumps [powershell](https://github.com/PowerShell/PowerShell) from 7.3.5 to 7.3.6. - [Release notes](https://github.com/PowerShell/PowerShell/releases) - [Commits](https://github.com/PowerShell/PowerShell/compare/v7.3.5...v7.3.6) --- updated-dependencies: - dependency-name: powershell dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index e344d8b0d..f8713e90a 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.5", + "version": "7.3.6", "commands": [ "pwsh" ] From 05a925a4be9598efcffce2fdd7fb3135d5f7f8be Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Jul 2023 07:38:14 -0600 Subject: [PATCH 0809/1753] Bump dotnet-coverage from 17.7.3 to 17.8.0 (#211) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.7.3 to 17.8.0. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index f8713e90a..05b6b5bb1 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.7.3", + "version": "17.8.0", "commands": [ "dotnet-coverage" ] From 1ee6a1b38ffbac2498bd45ae666dde258a40c76a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Jul 2023 12:21:52 -0600 Subject: [PATCH 0810/1753] Adapt to new xunit version --- test/IsolatedTestHost/App.config | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index 03a0834b7..a464805c8 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -10,13 +10,13 @@ - + - + From 0cc89db1dda3f9c7a436bea77e903f17baf7a989 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 22 Jul 2023 11:14:58 -0600 Subject: [PATCH 0811/1753] Bump dotnet-coverage to 17.8.2 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 05b6b5bb1..a20f90b96 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.8.0", + "version": "17.8.2", "commands": [ "dotnet-coverage" ] From 5c6330dc1ad8a1a4406915d4cfaa2defb08ebeea Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 24 Jul 2023 09:22:56 -0600 Subject: [PATCH 0812/1753] Bump MicroBuild version to 2.0.134 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7d021ab8e..fa07578dd 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.131 + 2.0.134 From 2651c692388aa2e27213c7b89959de56b81f1ecb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 7 Aug 2023 10:09:53 -0600 Subject: [PATCH 0813/1753] Bump Microsoft.NET.Test.Sdk from 17.6.3 to 17.7.0 (#213) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.6.3 to 17.7.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.6.3...v17.7.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6af95c882..58a5a2656 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 492d96f3c3c136ba9a504a4524ca8616df222779 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 11 Aug 2023 08:15:54 -0600 Subject: [PATCH 0814/1753] Bump Microbuild version to 2.0.137 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index fa07578dd..fb6c9c8fa 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.134 + 2.0.137 From 821514da53b285a41ce1188f98dcb94faaacadff Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 17 Aug 2023 15:51:51 -0600 Subject: [PATCH 0815/1753] Tolerate NOTICE file task network failures --- azure-pipelines/microbuild.before.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index c933df239..adb5ccc89 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -8,6 +8,7 @@ steps: outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE outputformat: text condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) + retryCountOnTaskFailure: 3 # fails when the cloud service is overloaded - task: MicroBuildSigningPlugin@4 inputs: From f764c84caec60eff9579c03ce16db43b142c2d74 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 21 Aug 2023 09:15:30 -0600 Subject: [PATCH 0816/1753] Bump Microsoft.NET.Test.Sdk from 17.7.0 to 17.7.1 (#214) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.7.0 to 17.7.1. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.7.0...v17.7.1) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 58a5a2656..8d5408940 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 05f9dd77512332bdd8a312db97bd07d26084b935 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 21 Aug 2023 15:18:33 +0000 Subject: [PATCH 0817/1753] Bump dotnet-coverage from 17.8.2 to 17.8.4 (#215) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.8.2 to 17.8.4. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index a20f90b96..2b62ebce6 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.8.2", + "version": "17.8.4", "commands": [ "dotnet-coverage" ] From 3078cca367c292ffa120022eda3e25e6a4773158 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 10 Aug 2023 09:41:10 -0600 Subject: [PATCH 0818/1753] Add `AsyncMutex` class --- .../AsyncCrossProcessMutex.cs | 202 ++++++++++++++++ .../net472/PublicAPI.Unshipped.txt | 10 + .../net6.0-windows/PublicAPI.Unshipped.txt | 10 + .../net6.0/PublicAPI.Unshipped.txt | 10 + .../netstandard2.0/PublicAPI.Unshipped.txt | 10 + .../AsyncCrossProcessMutexTests.cs | 219 ++++++++++++++++++ 6 files changed, 461 insertions(+) create mode 100644 src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs diff --git a/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs b/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs new file mode 100644 index 000000000..dbe0162c1 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs @@ -0,0 +1,202 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using System.Collections.Concurrent; +using System.Threading; +using System.Threading.Tasks; + +namespace Microsoft.VisualStudio.Threading; + +/// +/// A mutex that can be entered asynchronously. +/// +/// +/// +/// This class utilizes the OS mutex synchronization primitive, which is fundamentally thread-affinitized and requires synchronously blocking the thread that will own the mutex. +/// This makes a native mutex unsuitable for use in async methods, where the thread that enters the mutex may not be the same thread that exits it. +/// This class solves that problem by using a private dedicated thread to enter and release the mutex, but otherwise allows its owner to execute async code, switch threads, etc. +/// +/// +/// +public class AsyncCrossProcessMutex + : IDisposable +{ +#pragma warning disable SA1310 // Field names should not contain underscore + private const int STATE_READY = 0; + private const int STATE_HELD_OR_WAITING = 1; + private const int STATE_DISPOSED = 2; +#pragma warning restore SA1310 // Field names should not contain underscore + + private static readonly Action ExitSentinel = new Action(() => { }); + private readonly Thread namedMutexOwner; + private readonly BlockingCollection mutexWorkQueue = new(); + private readonly Mutex mutex; + private int state; + + /// + /// Initializes a new instance of the class. + /// + /// + /// A non-empty name for the mutex, which follows standard mutex naming rules. + /// This name will share a namespace with other processes in the system and collisions will result in the processes sharing a single mutex across processes. + /// + /// + /// See the help docs on the underlying class for more information on the parameter. + /// Consider when reading that the initiallyOwned parameter for that constructor is always for this class. + /// + public AsyncCrossProcessMutex(string name) + { + Requires.NotNullOrEmpty(name); + this.namedMutexOwner = new Thread(this.MutexOwnerThread, 100 * 1024) + { + Name = $"{nameof(AsyncCrossProcessMutex)}-{name}", + }; + this.mutex = new Mutex(false, name); + this.namedMutexOwner.Start(); + this.Name = name; + } + + /// + /// Gets the name of the mutex. + /// + public string Name { get; } + + /// + /// Disposes of the underlying native objects. + /// + public void Dispose() + { + int priorState = Interlocked.Exchange(ref this.state, STATE_DISPOSED); + if (priorState != STATE_DISPOSED) + { + this.mutexWorkQueue.Add(ExitSentinel); + this.mutexWorkQueue.CompleteAdding(); + } + } + + /// + public Task EnterAsync() => this.EnterAsync(Timeout.InfiniteTimeSpan); + + /// + /// Acquires the mutex asynchronously. + /// + /// The maximum time to wait before timing out. Use for no timeout, or to acquire the mutex only if it is immediately available. + /// A value whose disposal will release the mutex. + /// Thrown from the awaited result if the mutex could not be acquired within the specified timeout. + /// Thrown from the awaited result if the is a negative number other than -1 milliseconds, which represents an infinite timeout. + /// Thrown if called before a prior call to this method has completed, with its releaser disposed if the mutex was entered. + public async Task EnterAsync(TimeSpan timeout) => await this.TryEnterAsync(timeout) ?? throw new TimeoutException(); + + /// + /// Acquires the mutex asynchronously, allowing for timeouts without throwing exceptions. + /// + /// The maximum time to wait before timing out. Use for no timeout, or to acquire the mutex only if it is immediately available. + /// + /// If the mutex was acquired, the result is a value whose disposal will release the mutex. + /// In the event of a timeout, the result in a value. + /// + /// Thrown from the awaited result if the is a negative number other than -1 milliseconds, which represents an infinite timeout. + /// Thrown if called before a prior call to this method has completed, with its releaser disposed if the mutex was entered. + public Task TryEnterAsync(TimeSpan timeout) + { + int priorState = Interlocked.CompareExchange(ref this.state, STATE_HELD_OR_WAITING, STATE_READY); + switch (priorState) + { + case STATE_HELD_OR_WAITING: + throw new InvalidOperationException(); + case STATE_DISPOSED: + throw new ObjectDisposedException(this.GetType().FullName); + } + + // Pass `this` as the state simply to assist in debugging dumps. + TaskCompletionSource tcs = new(this, TaskCreationOptions.RunContinuationsAsynchronously); + this.mutexWorkQueue.Add(delegate + { + try + { + if (this.mutex.WaitOne(timeout)) + { + tcs.SetResult(new LockReleaser(this)); + } + else + { + Assumes.True(Interlocked.CompareExchange(ref this.state, STATE_READY, STATE_HELD_OR_WAITING) == STATE_HELD_OR_WAITING); + tcs.SetResult(null); + } + } + catch (AbandonedMutexException) + { + tcs.SetResult(new LockReleaser(this, abandoned: true)); + } + catch (Exception ex) + { + Assumes.True(Interlocked.CompareExchange(ref this.state, STATE_READY, STATE_HELD_OR_WAITING) == STATE_HELD_OR_WAITING); + tcs.SetException(ex); + } + }); + + return tcs.Task; + } + + private void Release() + { + Assumes.True(Interlocked.CompareExchange(ref this.state, STATE_READY, STATE_HELD_OR_WAITING) == STATE_HELD_OR_WAITING); + this.mutexWorkQueue.Add(this.mutex.ReleaseMutex); + } + + private void MutexOwnerThread() + { + try + { + while (!this.mutexWorkQueue.IsCompleted) + { + Action work = this.mutexWorkQueue.Take(); + if (work == ExitSentinel) + { + // We use an exit sentinel to avoid an exception having to be thrown and caught on disposal when we call Take() and CompleteAdding() is called. + break; + } + + work(); + } + } + finally + { + this.mutex.Dispose(); + } + } + + /// + /// The value returned from that must be disposed to release the mutex. + /// + public struct LockReleaser : IDisposable + { + private AsyncCrossProcessMutex? owner; + + internal LockReleaser(AsyncCrossProcessMutex mutex, bool abandoned = false) + { + this.owner = mutex; + this.IsAbandoned = abandoned; + } + + /// + /// Gets a value indicating whether the mutex was abandoned by its previous owner. + /// + public bool IsAbandoned { get; } + + /// + /// Releases the named mutex. + /// + public void Dispose() + { + Interlocked.Exchange(ref this.owner, null)?.Release(); + } + } +} diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index e69de29bb..f47308efb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -0,0 +1,10 @@ +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index e69de29bb..f47308efb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -0,0 +1,10 @@ +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index e69de29bb..f47308efb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -0,0 +1,10 @@ +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index e69de29bb..f47308efb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -0,0 +1,10 @@ +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs new file mode 100644 index 000000000..9c72d1d8a --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs @@ -0,0 +1,219 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.VisualStudio.Threading; +using Xunit; +using Xunit.Abstractions; + +public class AsyncCrossProcessMutexTests : TestBase, IDisposable +{ + private readonly AsyncCrossProcessMutex mutex = new($"test {Guid.NewGuid()}"); + + public AsyncCrossProcessMutexTests(ITestOutputHelper logger) + : base(logger) + { + } + + public void Dispose() + { + this.mutex.Dispose(); + } + + [Fact] + public void DisposeWithoutUse() + { + // This test intentionally left blank. The tested functionality is in the constructor and Dispose method. + } + + [Fact] + public void Dispose_Twice() + { + // The second disposal happens in the Dispose method of this class. + this.mutex.Dispose(); + } + + [Fact] + public async Task EnterAsync_Release_Uncontested() + { + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task EnterAsync_DoubleRelease() + { + AsyncCrossProcessMutex.LockReleaser releaser = await this.mutex.EnterAsync(); + releaser.Dispose(); + releaser.Dispose(); + } + + [Fact] + public async Task EnterAsync_Reentrancy() + { + using (AsyncCrossProcessMutex.LockReleaser releaser = await this.mutex.EnterAsync()) + { + await Assert.ThrowsAsync(async () => await this.mutex.EnterAsync()); + } + + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task TryEnterAsync_Reentrancy() + { + using (AsyncCrossProcessMutex.LockReleaser releaser = await this.mutex.EnterAsync()) + { + await Assert.ThrowsAsync(async () => await this.mutex.TryEnterAsync(Timeout.InfiniteTimeSpan)); + } + + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task EnterAsync_Contested() + { + // We don't allow attempted reentrancy, so create a new mutex object to use for the contested locks. + AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); + + // Acquire and hold the mutex so that we can test timeout behavior. + using (AsyncCrossProcessMutex.LockReleaser releaser = await this.mutex.EnterAsync()) + { + // Verify that we can't acquire the mutex within a timeout. + await Assert.ThrowsAsync(async () => await mutex2.EnterAsync(TimeSpan.Zero)); + await Assert.ThrowsAsync(async () => await mutex2.EnterAsync(TimeSpan.FromMilliseconds(1))); + } + + // Verify that we can acquire the mutex after it is released. + using (AsyncCrossProcessMutex.LockReleaser releaser2 = await mutex2.EnterAsync()) + { + } + + // Verify that the main mutex still functions. + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task TryEnterAsync_Contested() + { + // We don't allow attempted reentrancy, so create a new mutex object to use for the contested locks. + AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); + + // Acquire and hold the mutex so that we can test timeout behavior. + using (AsyncCrossProcessMutex.LockReleaser? releaser = await this.mutex.TryEnterAsync(Timeout.InfiniteTimeSpan)) + { + // Verify that we can't acquire the mutex within a timeout. + Assert.Null(await mutex2.TryEnterAsync(TimeSpan.Zero)); + Assert.Null(await mutex2.TryEnterAsync(TimeSpan.FromMilliseconds(1))); + + // Just verify that the syntax is nice. + using (AsyncCrossProcessMutex.LockReleaser? releaser2 = await mutex2.TryEnterAsync(TimeSpan.Zero)) + { + Assert.Null(releaser2); + } + } + + // Verify that we can acquire the mutex after it is released. + using (AsyncCrossProcessMutex.LockReleaser releaser2 = await mutex2.EnterAsync()) + { + } + + // Verify that the main mutex still functions. + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task EnterAsync_InvalidNegativeTimeout() + { + await Assert.ThrowsAsync(async () => await this.mutex.EnterAsync(TimeSpan.FromMilliseconds(-2))); + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task TryEnterAsync_InvalidNegativeTimeout() + { + await Assert.ThrowsAsync(async () => await this.mutex.TryEnterAsync(TimeSpan.FromMilliseconds(-2))); + await this.VerifyMutexEnterReleaseAsync(); + } + + [Fact] + public async Task EnterAsync_AbandonedMutex() + { + using AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); + + AsyncCrossProcessMutex.LockReleaser abandonedReleaser = await this.mutex.EnterAsync(); + Assert.False(abandonedReleaser.IsAbandoned); + + // Dispose the mutex WITHOUT first releasing it. + this.mutex.Dispose(); + + using (AsyncCrossProcessMutex.LockReleaser releaser2 = await mutex2.EnterAsync()) + { + Assert.True(releaser2.IsAbandoned); + } + } + + [Fact] + public async Task TryEnterAsync_AbandonedMutex() + { + using AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); + + AsyncCrossProcessMutex.LockReleaser? abandonedReleaser = await this.mutex.TryEnterAsync(Timeout.InfiniteTimeSpan); + Assert.False(abandonedReleaser.Value.IsAbandoned); + + // Dispose the mutex WITHOUT first releasing it. + this.mutex.Dispose(); + + using (AsyncCrossProcessMutex.LockReleaser? releaser2 = await mutex2.TryEnterAsync(Timeout.InfiniteTimeSpan)) + { + Assert.True(releaser2.Value.IsAbandoned); + } + } + + [Fact] + public async Task EnterAsync_ThrowsObjectDisposedException() + { + this.mutex.Dispose(); + await Assert.ThrowsAsync(async () => await this.mutex.EnterAsync()); + } + + [Fact] + public async Task TryEnterAsync_ThrowsObjectDisposedException() + { + this.mutex.Dispose(); + await Assert.ThrowsAsync(async () => await this.mutex.TryEnterAsync(Timeout.InfiniteTimeSpan)); + } + + [Fact] + public async Task TryEnterAsync_Twice() + { + using (AsyncCrossProcessMutex.LockReleaser? releaser = await this.mutex.TryEnterAsync(TimeSpan.Zero)) + { + } + + using (AsyncCrossProcessMutex.LockReleaser? releaser = await this.mutex.TryEnterAsync(TimeSpan.Zero)) + { + } + } + + /// + /// Asserts behavior or the .NET Mutex class that we may be emulating in our class. + /// + [Fact] + public void Mutex_BaselineBehaviors() + { + // Verify reentrant behavior. + using Mutex mutex = new(false, $"test {Guid.NewGuid()}"); + mutex.WaitOne(); + mutex.WaitOne(); + mutex.ReleaseMutex(); + mutex.ReleaseMutex(); + Assert.Throws(mutex.ReleaseMutex); + } + + private async Task VerifyMutexEnterReleaseAsync() + { + using AsyncCrossProcessMutex.LockReleaser releaser = await this.mutex.EnterAsync(); + } +} From 0e383a35039314d2f374e8ee8afeeb380183ae9b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 13 Jul 2023 15:57:53 -0600 Subject: [PATCH 0819/1753] Add `AsyncLazy.Dispose()` method This addresses a common need for a class with an `AsyncLazy` field where the value is disposable to ensure on the class disposal that it can dispose of the value if and when it is constructed. --- .../AsyncLazy`1.cs | 136 ++++++++++++++- .../net472/PublicAPI.Unshipped.txt | 5 +- .../net6.0-windows/PublicAPI.Unshipped.txt | 5 +- .../net6.0/PublicAPI.Unshipped.txt | 5 +- .../netstandard2.0/PublicAPI.Unshipped.txt | 5 +- .../AsyncLazyTests.cs | 156 ++++++++++++++++++ 6 files changed, 305 insertions(+), 7 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 55a9448cc..057d4621a 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -12,6 +12,11 @@ namespace Microsoft.VisualStudio.Threading; /// A thread-safe, lazily and asynchronously evaluated value factory. /// /// The type of value generated by the value factory. +/// +/// This class does not itself carry any resources needful of disposing. +/// But the value factory may produce a value that needs to be disposed of, +/// which is why this class carries a method but does not implement . +/// public class AsyncLazy { /// @@ -20,6 +25,11 @@ public class AsyncLazy /// private static readonly object RecursiveCheckSentinel = new object(); + /// + /// A value set on the field when this object is disposed. + /// + private static readonly Task DisposedSentinel = Task.FromException(new ObjectDisposedException(nameof(AsyncLazy))); + /// /// The object to lock to provide thread-safety. /// @@ -65,27 +75,42 @@ public AsyncLazy(Func> valueFactory, JoinableTaskFactory? joinableTaskFa /// /// Gets a value indicating whether the value factory has been invoked. /// + /// + /// This returns after a call to . + /// public bool IsValueCreated { get { + // This is carefully written to interact well with the DisposeValueAsync method + // without requiring a lock here. + bool result = Volatile.Read(ref this.valueFactory) is null; Interlocked.MemoryBarrier(); - return this.valueFactory is null; + result &= Volatile.Read(ref this.value) != DisposedSentinel; + return result; } } /// /// Gets a value indicating whether the value factory has been invoked and has run to completion. /// + /// + /// This returns after a call to . + /// public bool IsValueFactoryCompleted { get { - Interlocked.MemoryBarrier(); - return this.value is object && this.value.IsCompleted; + Task? value = Volatile.Read(ref this.value); + return value is object && value.IsCompleted && value != DisposedSentinel; } } + /// + /// Gets a value indicating whether has already been called. + /// + public bool IsValueDisposed => Volatile.Read(ref this.value) == DisposedSentinel; + /// /// Gets the task that produces or has produced the value. /// @@ -93,6 +118,7 @@ public bool IsValueFactoryCompleted /// /// Thrown when the value factory calls on this instance. /// + /// Thrown after is called. public Task GetValueAsync() => this.GetValueAsync(CancellationToken.None); /// @@ -108,6 +134,7 @@ public bool IsValueFactoryCompleted /// /// Thrown when the value factory calls on this instance. /// + /// Thrown after is called. public Task GetValueAsync(CancellationToken cancellationToken) { if (!((this.value is object && this.value.IsCompleted) || this.recursiveFactoryCheck.Value is null)) @@ -234,6 +261,109 @@ public T GetValue(CancellationToken cancellationToken) } } + /// + /// Disposes of the lazily-initialized value if disposable, and causes all subsequent attempts to obtain the value to fail. + /// + /// + /// This call will block on disposal (which may include construction of the value itself if it has already started but not yet finished) if it is the first call to dispose of the value. + /// Calling this method will put this object into a disposed state where future calls to obtain the value will throw . + /// If the value has already been produced and implements or , it will be disposed of. + /// If the value factory has already started but has not yet completed, its value will be disposed of when the value factory completes. + /// If prior calls to obtain the value are in flight when this method is called, those calls may complete and their callers may obtain the value, although + /// may have been or will soon be called on the value, leading those users to experience a . + /// Note all conditions based on the value implementing or is based on the actual value, rather than the type argument. + /// This means that although may be IFoo (which does not implement ), the concrete type that implements IFoo may implement + /// and thus be treated as a disposable object as described above. + /// + public void DisposeValue() + { + if (!this.IsValueDisposed) + { + if (this.jobFactory is JoinableTaskFactory jtf) + { + jtf.Run(this.DisposeValueAsync); + } + else + { + this.DisposeValueAsync().GetAwaiter().GetResult(); + } + } + } + + /// + /// Disposes of the lazily-initialized value if disposable, and causes all subsequent attempts to obtain the value to fail. + /// + /// + /// A task that completes when the value has been disposed of, or immediately if the value has already been disposed of or has been scheduled for disposal by a prior call. + /// + /// + /// Calling this method will put this object into a disposed state where future calls to obtain the value will throw . + /// If the value has already been produced and implements , , or it will be disposed of. + /// If the value factory has already started but has not yet completed, its value will be disposed of when the value factory completes. + /// If prior calls to obtain the value are in flight when this method is called, those calls may complete and their callers may obtain the value, although + /// may have been or will soon be called on the value, leading those users to experience a . + /// Note all conditions based on the value implementing or is based on the actual value, rather than the type argument. + /// This means that although may be IFoo (which does not implement ), the concrete type that implements IFoo may implement + /// and thus be treated as a disposable object as described above. + /// + public async Task DisposeValueAsync() + { + Task? localValueTask = null; + object? localValue = default; + lock (this.syncObject) + { + if (this.value == DisposedSentinel) + { + return; + } + + switch (this.value?.Status) + { + case TaskStatus.RanToCompletion: + // We'll dispose of the value inline, outside the lock. + localValue = this.value.Result; + break; + case TaskStatus.Faulted: + case TaskStatus.Canceled: + // Nothing left to do. + break; + default: + // We'll schedule the value for disposal outside the lock so it can be synchronous with the value factory, + // but will not execute within our lock. + localValueTask = this.value; + break; + } + + // Shut out all future callers from obtaining the value. + this.value = DisposedSentinel; + + // We want value to be set before valueFactory is cleared so that IsValueCreated never returns true incorrectly. + Interlocked.MemoryBarrier(); + + // Release associated memory. + this.joinableTask = null; + this.valueFactory = null; + } + + if (localValueTask is not null) + { + localValue = await localValueTask.ConfigureAwait(false); + } + + if (localValue is System.IAsyncDisposable systemAsyncDisposable) + { + await systemAsyncDisposable.DisposeAsync().ConfigureAwait(false); + } + else if (localValue is IAsyncDisposable asyncDisposable) + { + await asyncDisposable.DisposeAsync().ConfigureAwait(false); + } + else if (localValue is IDisposable disposable) + { + disposable.Dispose(); + } + } + /// /// Renders a string describing an uncreated value, or the string representation of the created value. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index f47308efb..c5cb0a27a 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -7,4 +7,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index f47308efb..c5cb0a27a 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -7,4 +7,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index f47308efb..c5cb0a27a 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -7,4 +7,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index f47308efb..c5cb0a27a 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -7,4 +7,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 02d598949..9c3e3981e 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -6,6 +6,7 @@ using System.Runtime.CompilerServices; using System.Threading; using System.Threading.Tasks; +using Microsoft; using Microsoft.VisualStudio.Threading; using Xunit; using Xunit.Abstractions; @@ -18,6 +19,13 @@ public AsyncLazyTests(ITestOutputHelper logger) { } + public enum DisposeStyle + { + IDisposable, + SystemIAsyncDisposable, + ThreadingIAsyncDisposable, + } + [Fact] public async Task Basic() { @@ -644,6 +652,106 @@ public async Task ExecutionContextFlowsFromFirstCaller_JTF() await asyncLazy.GetValueAsync(); } + [Fact] + public async Task Dispose_ValueType_Completed() + { + AsyncLazy lazy = new(() => Task.FromResult(3)); + lazy.GetValue(); + lazy.DisposeValue(); + await this.AssertDisposedLazyAsync(lazy); + } + + [Theory, CombinatorialData] + public async Task Dispose_Disposable_Completed(DisposeStyle variety) + { + AsyncLazy lazy = new(() => Task.FromResult(DisposableFactory(variety))); + DisposableBase value = (DisposableBase)lazy.GetValue(); + lazy.DisposeValue(); + Assert.True(value.IsDisposed); + await this.AssertDisposedLazyAsync(lazy); + } + + [Fact] + public async Task Dispose_NonDisposable_Completed() + { + AsyncLazy lazy = new(() => Task.FromResult(new object())); + lazy.GetValue(); + lazy.DisposeValue(); + await this.AssertDisposedLazyAsync(lazy); + } + + [Theory, CombinatorialData] + public async Task Dispose_Disposable_Incomplete(DisposeStyle variety) + { + AsyncManualResetEvent unblock = new(); + AsyncLazy lazy = new(async delegate + { + await unblock; + return DisposableFactory(variety); + }); + Task lazyTask = lazy.GetValueAsync(this.TimeoutToken); + Task disposeTask = lazy.DisposeValueAsync(); + await Assert.ThrowsAnyAsync(() => disposeTask.WithTimeout(ExpectedTimeout)); + unblock.Set(); + await disposeTask.WithCancellation(this.TimeoutToken); + DisposableBase value = (DisposableBase)await lazyTask; + await this.AssertDisposedLazyAsync(lazy); + await value.Disposed.WithCancellation(this.TimeoutToken); + } + + [Fact] + public async Task Dispose_NonDisposable_Incomplete() + { + AsyncManualResetEvent unblock = new(); + AsyncLazy lazy = new(async delegate + { + await unblock; + return new object(); + }); + Task lazyTask = lazy.GetValueAsync(this.TimeoutToken); + Task disposeTask = lazy.DisposeValueAsync(); + await Assert.ThrowsAnyAsync(() => disposeTask.WithTimeout(ExpectedTimeout)); + unblock.Set(); + await disposeTask.WithCancellation(this.TimeoutToken); + await lazyTask; + await this.AssertDisposedLazyAsync(lazy); + } + + [Fact] + public async Task Dispose_CalledTwice_NotStarted() + { + bool valueFactoryExecuted = false; + AsyncLazy lazy = new(() => + { + valueFactoryExecuted = true; + return Task.FromResult(new object()); + }); + lazy.DisposeValue(); + lazy.DisposeValue(); + await this.AssertDisposedLazyAsync(lazy); + Assert.False(valueFactoryExecuted); + } + + [Fact] + public async Task Dispose_CalledTwice_NonDisposable_Completed() + { + AsyncLazy lazy = new(() => Task.FromResult(new object())); + lazy.GetValue(); + lazy.DisposeValue(); + lazy.DisposeValue(); + await this.AssertDisposedLazyAsync(lazy); + } + + [Fact] + public async Task Dispose_CalledTwice_Disposable_Completed() + { + AsyncLazy lazy = new(() => Task.FromResult(new Disposable())); + lazy.GetValue(); + lazy.DisposeValue(); + lazy.DisposeValue(); + await this.AssertDisposedLazyAsync(lazy); + } + [Fact(Skip = "Hangs. This test documents a deadlock scenario that is not fixed (by design, IIRC).")] public async Task ValueFactoryRequiresReadLockHeldByOther() { @@ -689,6 +797,14 @@ async delegate } } + private static DisposableBase DisposableFactory(DisposeStyle variety) => variety switch + { + DisposeStyle.IDisposable => new Disposable(), + DisposeStyle.SystemIAsyncDisposable => new SystemAsyncDisposable(), + DisposeStyle.ThreadingIAsyncDisposable => new ThreadingAsyncDisposable(), + _ => throw new NotSupportedException(), + }; + private JoinableTaskContext InitializeJTCAndSC() { SynchronizationContext.SetSynchronizationContext(SingleThreadedTestSynchronizationContext.New()); @@ -727,4 +843,44 @@ private async Task AsyncPumpReleasedAfterExecution_Helper(bool th await lazy.GetValueAsync().NoThrowAwaitable(); return collectible; } + + private async Task AssertDisposedLazyAsync(AsyncLazy lazy) + { + Assert.False(lazy.IsValueCreated); + Assert.False(lazy.IsValueFactoryCompleted); + Assert.Throws(() => lazy.GetValue()); + await Assert.ThrowsAsync(lazy.GetValueAsync); + } + + private abstract class DisposableBase + { + protected readonly AsyncManualResetEvent disposalEvent = new(); + + public Task Disposed => this.disposalEvent.WaitAsync(); + + public bool IsDisposed => this.disposalEvent.IsSet; + } + + private class Disposable : DisposableBase, IDisposableObservable + { + public void Dispose() => this.disposalEvent.Set(); + } + + private class SystemAsyncDisposable : DisposableBase, System.IAsyncDisposable + { + public ValueTask DisposeAsync() + { + this.disposalEvent.Set(); + return default; + } + } + + private class ThreadingAsyncDisposable : DisposableBase, Microsoft.VisualStudio.Threading.IAsyncDisposable + { + public Task DisposeAsync() + { + this.disposalEvent.Set(); + return Task.CompletedTask; + } + } } From c8abc41f0afd07c570d13d6ac41134da00485d91 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 31 Aug 2023 10:41:26 -0600 Subject: [PATCH 0820/1753] Align YAML indentation more consistently --- .github/dependabot.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 484f2bfcd..a0e8933bb 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -8,6 +8,6 @@ updates: schedule: interval: weekly ignore: - # This package has unlisted versions on nuget.org that are not supported. Avoid them. - - dependency-name: dotnet-format - versions: ["6.x", "7.x", "8.x"] + # This package has unlisted versions on nuget.org that are not supported. Avoid them. + - dependency-name: dotnet-format + versions: ["6.x", "7.x", "8.x"] From 295313bfbc59d3c6fe8fa4c9e5f080d86d236f95 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 31 Aug 2023 11:27:21 -0600 Subject: [PATCH 0821/1753] Bump Microsoft.NET.Test.Sdk from 17.7.1 to 17.7.2 (#218) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.7.1 to 17.7.2. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.7.1...v17.7.2) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 8d5408940..76d18e0d8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 0a35e80ec55441fc0c10d2ea68cd03e6b4c64004 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 5 Sep 2023 15:31:49 -0600 Subject: [PATCH 0822/1753] Fix typo in comment --- src/Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 5be1dd441..5e648d5ee 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,5 +1,5 @@ - + README.md From c6e02104201b8614d37bfdb4f4dddc0c0b55cdb5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 5 Sep 2023 15:35:53 -0600 Subject: [PATCH 0823/1753] Build 17.8 stable version --- version.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.json b/version.json index 3617e7bb4..acf636d1e 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.8-alpha", + "version": "17.8", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} \ No newline at end of file +} From 32ad8867b7b3ba1a37772ac82f1da6b939295c14 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 5 Sep 2023 15:42:38 -0600 Subject: [PATCH 0824/1753] Bump MicroBuildVersion to 2.0.146 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 963ff8fed..d8c93d288 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.137 + 2.0.146 From cf980d71f2dc30d777674b77a1afef6a1e8ddd72 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 8 Sep 2023 10:43:58 -0600 Subject: [PATCH 0825/1753] Bump dotnet-coverage to 17.8.6 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 2b62ebce6..d93241f4c 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.8.4", + "version": "17.8.6", "commands": [ "dotnet-coverage" ] From 2d1e11ee8e88404c1a3a0b6411228c60e3e47de0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:03:20 -0600 Subject: [PATCH 0826/1753] Bump Microsoft.VisualStudio.Validation from 17.6.11 to 17.8.8 (#1230) Bumps [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) from 17.6.11 to 17.8.8. - [Release notes](https://github.com/microsoft/vs-validation/releases) - [Commits](https://github.com/microsoft/vs-validation/commits) --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Validation dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6ec31e502..686bff69c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -27,7 +27,7 @@ - + From 39bdb37ead87044bad1ae12b4cb8ce8800a863dc Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 20 Sep 2023 08:50:51 -0600 Subject: [PATCH 0827/1753] Bump xunit from 2.5.0 to 2.5.1 (#219) Bumps [xunit](https://github.com/xunit/xunit) from 2.5.0 to 2.5.1. - [Commits](https://github.com/xunit/xunit/compare/2.5.0...2.5.1) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 76d18e0d8..b3cdf478c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From a7f083d5fa0dd1107a04d6b724b117ac6e3c0eb4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 20 Sep 2023 14:58:32 +0000 Subject: [PATCH 0828/1753] Bump xunit.runner.visualstudio from 2.5.0 to 2.5.1 (#220) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b3cdf478c..2cc8fe04a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ - + From 5d99f303c0357175a0d1932e9ee5255f2476b5a5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 20 Sep 2023 16:13:36 -0600 Subject: [PATCH 0829/1753] Bump powershell to 7.3.7 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index d93241f4c..08f5c1eb2 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.6", + "version": "7.3.7", "commands": [ "pwsh" ] From 7726859b29c1290b01e5c6dc0fa1449664596429 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 21 Sep 2023 11:08:45 -0600 Subject: [PATCH 0830/1753] Fix LangVersion at 11 Using `latest` allows VS previews to encourage use of syntax that will later fail when built with the SDK prescribed in our global.json file. --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index 35fd4f69a..22986f2f3 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -5,7 +5,7 @@ $(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - latest + 11 enable enable latest From 9ed3b099a203939b40046d582a795d5a4becfb60 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 27 Sep 2023 05:49:40 -0600 Subject: [PATCH 0831/1753] Bump dotnet-coverage to 17.8.7 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 08f5c1eb2..3e0ec525a 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.8.6", + "version": "17.8.7", "commands": [ "dotnet-coverage" ] From 75d85ec086b0c8592941927776f6032fec432148 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 1 Oct 2023 22:26:59 -0600 Subject: [PATCH 0832/1753] Revert "Bump dotnet-coverage to 17.8.7" This reverts commit 9ed3b099a203939b40046d582a795d5a4becfb60. --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 3e0ec525a..08f5c1eb2 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.8.7", + "version": "17.8.6", "commands": [ "dotnet-coverage" ] From 7d6e6c0f51518bce724bc45d7f58ea1c31dd7681 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Oct 2023 08:18:18 -0600 Subject: [PATCH 0833/1753] Stop trying (and failing) to run optprof on older servicing branches --- azure-pipelines/OptProf.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 0a6750bf5..44e4e83ce 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -5,7 +5,7 @@ schedules: displayName: Weekly OptProf run branches: include: - - 'v1*' +# - 'v1*' Old servicing branches are failing - main always: true # we must keep data fresh since optimizationdata drops are purged after 30 days From 68ff5e479a8764bcf913e076e87c740e2d1cbac0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Oct 2023 08:30:16 -0600 Subject: [PATCH 0834/1753] Shift optprof runs to DD-CB-TestSignVS-devCI VS Eng wants us to avoid using DD-CB-PR for non-PR builds, such as optprof runs. --- azure-pipelines/OptProf.yml | 4 ++-- azure-pipelines/OptProf_part2.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index b6a3af1ac..5e427d084 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -91,9 +91,9 @@ stages: SkipCreatePR: true CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 - displayName: Trigger a new build of DD-CB-PR + displayName: Trigger a new build of DD-CB-TestSignVS-devCI inputs: - buildDefinition: DD-CB-PR + buildDefinition: DD-CB-TestSignVS-devCI useSameBranch: false branchToUse: $(InsertTopicBranch) storeInEnvironmentVariable: true diff --git a/azure-pipelines/OptProf_part2.yml b/azure-pipelines/OptProf_part2.yml index edef0ec96..97cfe2546 100644 --- a/azure-pipelines/OptProf_part2.yml +++ b/azure-pipelines/OptProf_part2.yml @@ -4,7 +4,7 @@ pr: none resources: pipelines: - pipeline: VisualStudioBuildUnderTest - source: DD-CB-PR + source: DD-CB-TestSignVS-devCI trigger: tags: - vs-threading-insertion From fb33219174d12ac21aa6ec2a67ae61f9e77ee082 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Oct 2023 08:32:05 -0600 Subject: [PATCH 0835/1753] Insert into `rel/d17.8` --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..bd65511b8 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.8' From e45693ce5a0e896c33d469425e174c12c9a774ca Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Oct 2023 08:32:37 -0600 Subject: [PATCH 0836/1753] Build v17.9 and insert to main --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- version.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index bd65511b8..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.8' +'main' diff --git a/version.json b/version.json index acf636d1e..4c605c5cd 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.8", + "version": "17.9-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From e08e77360db0796fee268942bd99323cfa5d915d Mon Sep 17 00:00:00 2001 From: MartyIX <203266+MartyIX@users.noreply.github.com> Date: Fri, 6 Oct 2023 21:18:27 +0200 Subject: [PATCH 0837/1753] `VSTHRD200` ignores `DisposeAsyncCore` mentioned in https://learn.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-disposeasync#the-disposeasynccore-method --- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 6 +++++ ...00UseAsyncNamingConventionAnalyzerTests.cs | 23 +++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index 9e5c92b5e..4b0a28cf2 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -72,6 +72,12 @@ private void AnalyzeNode(SymbolAnalysisContext context, CommonInterest.Awaitable return; } + // Skip the method of the recommended dispose pattern. + if (methodSymbol.Name == "DisposeAsyncCore") + { + return; + } + bool hasAsyncFocusedReturnType = Utils.HasAsyncCompatibleReturnType(methodSymbol); bool actuallyEndsWithAsync = methodSymbol.Name.EndsWith(MandatoryAsyncSuffix, StringComparison.CurrentCulture); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs index 6033b321f..c05cb25a8 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs @@ -558,6 +558,29 @@ public async Task TaskReturningPropertyWithoutSuffix_GeneratesNoWarning() class Test { Task Foo => null; } +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task MethodDisposeAsyncCore_GeneratesNoWarning() + { + var test = @" +using System; +using System.Threading.Tasks; + +class Test : IAsyncDisposable +{ + public async ValueTask DisposeAsync() + { + await DisposeAsyncCore().ConfigureAwait(false); + GC.SuppressFinalize(this); + } + + protected virtual async ValueTask DisposeAsyncCore() + { + } +} "; await CSVerify.VerifyAnalyzerAsync(test); } From b0d89f938752bb23c4019dd2f2180cababcfbc89 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 8 Oct 2023 08:19:50 -0600 Subject: [PATCH 0838/1753] Bump .NET SDK to 7.0.401 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 6d2f30da6..cef7ac6f7 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:7.0.302-jammy +FROM mcr.microsoft.com/dotnet/sdk:7.0.401-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index abde95a8b..f153194c4 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.302", + "version": "7.0.401", "rollForward": "patch", "allowPrerelease": false } From 2214ca952dbc76efce9af5226a7320803acec85b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 07:47:59 -0600 Subject: [PATCH 0839/1753] Bump xunit.runner.visualstudio from 2.5.1 to 2.5.3 (#224) Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.5.1 to 2.5.3. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/compare/2.5.1...2.5.3) --- updated-dependencies: - dependency-name: xunit.runner.visualstudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2cc8fe04a..536511dc2 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ - + From 7df665541e0d93f5e9c0e20e5e62a29337619e6f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 07:48:29 -0600 Subject: [PATCH 0840/1753] Bump dotnet-coverage from 17.8.6 to 17.9.1 (#222) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.8.6 to 17.9.1. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 08f5c1eb2..e7623fce4 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.8.6", + "version": "17.9.1", "commands": [ "dotnet-coverage" ] From 646c1791371e7ad5cdb923b8e054dc1b5b93f95d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 07:48:35 -0600 Subject: [PATCH 0841/1753] Bump powershell from 7.3.7 to 7.3.8 (#221) Bumps [powershell](https://github.com/PowerShell/PowerShell) from 7.3.7 to 7.3.8. - [Release notes](https://github.com/PowerShell/PowerShell/releases) - [Commits](https://github.com/PowerShell/PowerShell/compare/v7.3.7...v7.3.8) --- updated-dependencies: - dependency-name: powershell dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index e7623fce4..c13b4c68a 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.7", + "version": "7.3.8", "commands": [ "pwsh" ] From 125983c0dd2f8fae5171b321f5258b6ebbea4894 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 13:55:23 +0000 Subject: [PATCH 0842/1753] Bump xunit from 2.5.1 to 2.5.2 (#223) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 536511dc2..6f6fe2ef4 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 6a1799bbac2ee4f6766d54b7aac308495f775bf6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 16:07:53 -0600 Subject: [PATCH 0843/1753] Workaround roslyn analyzer and xunit version incompatibility It only shows up when failures occur. --- Directory.Packages.props | 2 ++ .../Helpers/CSharpCodeFixVerifier`2+Test.cs | 3 +-- .../Helpers/CSharpCodeFixVerifier`2.cs | 5 ++--- .../Helpers/VisualBasicCodeFixVerifier`2+Test.cs | 3 +-- .../Helpers/VisualBasicCodeFixVerifier`2.cs | 5 ++--- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 4 ++-- 6 files changed, 10 insertions(+), 12 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 686bff69c..6f1a74d75 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -16,9 +16,11 @@ + + diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs index ffb4daf5a..298425a59 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs @@ -10,7 +10,6 @@ #endif using Microsoft.CodeAnalysis.CSharp; using Microsoft.CodeAnalysis.CSharp.Testing; -using Microsoft.CodeAnalysis.Testing.Verifiers; using Microsoft.CodeAnalysis.Text; using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider; @@ -18,7 +17,7 @@ namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; public static partial class CSharpCodeFixVerifier { - public class Test : CSharpCodeFixTest + public class Test : CSharpCodeFixTest { public Test() { diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs index bd605653f..57c5eb259 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2.cs @@ -4,7 +4,6 @@ using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.CSharp.Testing; using Microsoft.CodeAnalysis.Diagnostics; -using Microsoft.CodeAnalysis.Testing.Verifiers; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; @@ -13,10 +12,10 @@ public static partial class CSharpCodeFixVerifier where TCodeFix : CodeFixProvider, new() { public static DiagnosticResult Diagnostic() - => CSharpCodeFixVerifier.Diagnostic(); + => CSharpCodeFixVerifier.Diagnostic(); public static DiagnosticResult Diagnostic(string diagnosticId) - => CSharpCodeFixVerifier.Diagnostic(diagnosticId); + => CSharpCodeFixVerifier.Diagnostic(diagnosticId); public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) => new DiagnosticResult(descriptor); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs index fb0d49708..8793d3d8c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs @@ -8,7 +8,6 @@ #if WINDOWS using System.Windows.Threading; #endif -using Microsoft.CodeAnalysis.Testing.Verifiers; using Microsoft.CodeAnalysis.Text; using Microsoft.CodeAnalysis.VisualBasic; using Microsoft.CodeAnalysis.VisualBasic.Testing; @@ -18,7 +17,7 @@ namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; public static partial class VisualBasicCodeFixVerifier { - public class Test : VisualBasicCodeFixTest + public class Test : VisualBasicCodeFixTest { public Test() { diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs index 489890d2e..7be9a7b25 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2.cs @@ -3,7 +3,6 @@ using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.Diagnostics; -using Microsoft.CodeAnalysis.Testing.Verifiers; using Microsoft.CodeAnalysis.VisualBasic.Testing; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; @@ -13,10 +12,10 @@ public static partial class VisualBasicCodeFixVerifier where TCodeFix : CodeFixProvider, new() { public static DiagnosticResult Diagnostic() - => VisualBasicCodeFixVerifier.Diagnostic(); + => VisualBasicCodeFixVerifier.Diagnostic(); public static DiagnosticResult Diagnostic(string diagnosticId) - => VisualBasicCodeFixVerifier.Diagnostic(diagnosticId); + => VisualBasicCodeFixVerifier.Diagnostic(diagnosticId); public static DiagnosticResult Diagnostic(DiagnosticDescriptor descriptor) => new DiagnosticResult(descriptor); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 5f5111187..57b74d502 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -22,8 +22,8 @@ - - + + From 35a0d84e7a3e5b17cf42ffc2f124492419fc820f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 16:08:36 -0600 Subject: [PATCH 0844/1753] VSTHRD103 should flag violations amidst use of `?.` expressions Fixes #1235 --- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 30 ++++++++----- .../VSTHRD103UseAsyncOptionCodeFix.cs | 6 +++ .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 42 ++++++++++++++++++- 3 files changed, 66 insertions(+), 12 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index e4ec4f44d..c1bbaa06d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -72,6 +72,7 @@ public override void Initialize(AnalysisContext context) { ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeConditionalAccessExpression), SyntaxKind.ConditionalAccessExpression); }); } @@ -82,7 +83,21 @@ internal static void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; if (IsInTaskReturningMethodOrDelegate(context)) { - InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingProperties); + InspectMemberAccess(context, memberAccessSyntax.Name, CommonInterest.SyncBlockingProperties); + } + } + + internal static void AnalyzeConditionalAccessExpression(SyntaxNodeAnalysisContext context) + { + var conditionalAccessSyntax = (ConditionalAccessExpressionSyntax)context.Node; + if (IsInTaskReturningMethodOrDelegate(context)) + { + ExpressionSyntax rightSide = conditionalAccessSyntax.WhenNotNull switch + { + MemberBindingExpressionSyntax bindingExpr => bindingExpr.Name, + _ => conditionalAccessSyntax.WhenNotNull, + }; + InspectMemberAccess(context, rightSide, CommonInterest.SyncBlockingProperties); } } @@ -92,7 +107,7 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) { var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; var memberAccessSyntax = invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax; - if (InspectMemberAccess(context, memberAccessSyntax, CommonInterest.SyncBlockingMethods)) + if (memberAccessSyntax is not null && InspectMemberAccess(context, memberAccessSyntax.Name, CommonInterest.SyncBlockingMethods)) { // Don't return double-diagnostics. return; @@ -174,21 +189,16 @@ private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext return methodSymbol.HasAsyncCompatibleReturnType(); } - private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, [NotNullWhen(true)] MemberAccessExpressionSyntax? memberAccessSyntax, IEnumerable problematicMethods) + private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, ExpressionSyntax memberName, IEnumerable problematicMethods) { - if (memberAccessSyntax is null) - { - return false; - } - - ISymbol? memberSymbol = context.SemanticModel.GetSymbolInfo(memberAccessSyntax, context.CancellationToken).Symbol; + ISymbol? memberSymbol = context.SemanticModel.GetSymbolInfo(memberName, context.CancellationToken).Symbol; if (memberSymbol is object) { foreach (CommonInterest.SyncBlockingMethod item in problematicMethods) { if (item.Method.IsMatch(memberSymbol)) { - Location? location = memberAccessSyntax.Name.GetLocation(); + Location? location = memberName.GetLocation(); ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(ExtensionMethodNamespaceKeyName, item.ExtensionMethodNamespace is object ? string.Join(".", item.ExtensionMethodNamespace) : string.Empty); DiagnosticDescriptor descriptor; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs index 655c98233..7400af2b6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs @@ -59,6 +59,12 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context) SemanticModel? semanticModel = await context.Document.GetSemanticModelAsync(context.CancellationToken).ConfigureAwait(false); SyntaxNode syntaxRoot = await context.Document.GetSyntaxRootOrThrowAsync(context.CancellationToken).ConfigureAwait(false); var blockingIdentifier = syntaxRoot.FindNode(diagnostic.Location.SourceSpan) as IdentifierNameSyntax; + if (blockingIdentifier?.Parent is MemberBindingExpressionSyntax) // ?. conditional access expressions. + { + // Fixes for these are complex, and the violations rare. So we won't automate a code fix for them. + return; + } + var memberAccessExpression = blockingIdentifier?.Parent as MemberAccessExpressionSyntax; // Check whether this code was already calling the awaiter (in a synchronous fashion). diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index f8f54deb3..b665feb5d 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -409,7 +409,7 @@ public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning() class Test { Task T() { Task t = null; - int result = t.Result; + int result = t.{|#0:Result|}; return Task.FromResult(result); } } @@ -427,10 +427,48 @@ async Task T() { } "; - DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(7, 24).WithArguments("Result"); + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Result"); await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } + [Fact] + public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_ConditionalAccess() + { + var test = @" +using System.Threading.Tasks; + +class Test { + Task T() { + Task t = null; + int? result = t?.{|#0:Result|}; + return Task.FromResult(result); + } +} +"; + + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Result"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + + [Fact] + public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_ConditionalAccess2() + { + var test = @" +using System.Threading.Tasks; + +class Test { + Task T() { + Task t = null; + int result = t?.{|#0:Result|} ?? 1; + return Task.FromResult(result); + } +} +"; + + DiagnosticResult expected = CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithLocation(0).WithArguments("Result"); + await CSVerify.VerifyAnalyzerAsync(test, expected); + } + [Fact] public async Task TaskOfTResultInTaskReturningMethodGeneratesWarning_FixPreservesCall() { From 047a498a4a986d9fe626a4497d60214583ac148c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 16:24:10 -0600 Subject: [PATCH 0845/1753] Fix VSTHRD004 mis-fire on `NoThrowAwaitable()` Fixes #1232 --- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 19 ++++++++++++++---- ...aitSwitchToMainThreadAsyncAnalyzerTests.cs | 20 +++++++++++++++++++ 2 files changed, 35 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 5156134d1..177770600 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -45,12 +45,23 @@ private void AnalyzeInvocation(OperationAnalysisContext context) methodSymbol.ContainingType.Name == Types.JoinableTaskFactory.TypeName && methodSymbol.ContainingType.BelongsToNamespace(Types.JoinableTaskFactory.Namespace)) { - // This is a call to JTF.SwitchToMainThreadAsync(). Is it being (directly) awaited? - if (!(invocation.Parent is IAwaitOperation)) + // This is a call to JTF.SwitchToMainThreadAsync(). Is it being awaited in some ancestor? + for (IOperation? parentOp = invocation.Parent; parentOp is not null; parentOp = parentOp.Parent) { - Location? location = (this.LanguageUtils.IsolateMethodName(invocation) ?? invocation.Syntax).GetLocation(); - context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); + if (parentOp is IAwaitOperation) + { + return; + } + + if (parentOp is IExpressionStatementOperation or IReturnOperation) + { + // We've reached the top of the statement without finding an await. + break; + } } + + Location? location = (this.LanguageUtils.IsolateMethodName(invocation) ?? invocation.Syntax).GetLocation(); + context.ReportDiagnostic(Diagnostic.Create(Descriptor, location)); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs index 1271292de..54483b7d9 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD004AwaitSwitchToMainThreadAsyncAnalyzerTests.cs @@ -104,6 +104,26 @@ async Task FooAsync() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task AsyncMethodWithAwaitNoThrowAwaitable_ProducesNoDiagnostic() + { + var test = @" +using System.Threading.Tasks; + +class Test +{ + Microsoft.VisualStudio.Threading.JoinableTaskFactory jtf; + + async Task FooAsync() + { + await jtf.SwitchToMainThreadAsync().NoThrowAwaitable(); + } +} +"; + + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task TaskReturningSyncMethod_ProducesDiagnostic() { From 156ffa86667264ca4aa0f8b95596b413d4ba95a1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 16:49:07 -0600 Subject: [PATCH 0846/1753] Emit VSTHRD003 warning when awaiting on foreign tasks from properties Fixes #1224 --- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 45 +++++++++------ .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 56 +++++++++++++++++++ 2 files changed, 85 insertions(+), 16 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 25328fdb5..e57dec834 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -71,6 +71,30 @@ public override void Initialize(AnalysisContext context) context.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(this.AnalyzeLambdaExpression), SyntaxKind.ParenthesizedLambdaExpression); } + private static bool IsSymbolAlwaysOkToAwait(ISymbol? symbol) + { + if (symbol is IFieldSymbol field) + { + // Allow the TplExtensions.CompletedTask and related fields. + if (field.ContainingType.Name == Types.TplExtensions.TypeName && field.BelongsToNamespace(Types.TplExtensions.Namespace) && + (field.Name == Types.TplExtensions.CompletedTask || field.Name == Types.TplExtensions.CanceledTask || field.Name == Types.TplExtensions.TrueTask || field.Name == Types.TplExtensions.FalseTask)) + { + return true; + } + } + else if (symbol is IPropertySymbol property) + { + // Explicitly allow Task.CompletedTask + if (property.ContainingType.Name == Types.Task.TypeName && property.BelongsToNamespace(Types.Task.Namespace) && + property.Name == Types.Task.CompletedTask) + { + return true; + } + } + + return false; + } + private void AnalyzeArrowExpressionClause(SyntaxNodeAnalysisContext context) { var arrowExpressionClause = (ArrowExpressionClauseSyntax)context.Node; @@ -156,6 +180,9 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) symbolType = localSymbol.Type; dataflowAnalysisCompatibleVariable = true; break; + case IPropertySymbol propertySymbol when !IsSymbolAlwaysOkToAwait(propertySymbol): + symbolType = propertySymbol.Type; + break; case IParameterSymbol parameterSymbol: symbolType = parameterSymbol.Type; dataflowAnalysisCompatibleVariable = true; @@ -209,23 +236,9 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) } ISymbol? definition = declarationSemanticModel.GetSymbolInfo(memberAccessSyntax, cancellationToken).Symbol; - if (definition is IFieldSymbol field) - { - // Allow the TplExtensions.CompletedTask and related fields. - if (field.ContainingType.Name == Types.TplExtensions.TypeName && field.BelongsToNamespace(Types.TplExtensions.Namespace) && - (field.Name == Types.TplExtensions.CompletedTask || field.Name == Types.TplExtensions.CanceledTask || field.Name == Types.TplExtensions.TrueTask || field.Name == Types.TplExtensions.FalseTask)) - { - return null; - } - } - else if (definition is IPropertySymbol property) + if (IsSymbolAlwaysOkToAwait(definition)) { - // Explicitly allow Task.CompletedTask - if (property.ContainingType.Name == Types.Task.TypeName && property.BelongsToNamespace(Types.Task.Namespace) && - property.Name == Types.Task.CompletedTask) - { - return null; - } + return null; } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 213a7441e..0ecc075d6 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1243,6 +1243,62 @@ async Task FooAsync() { await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task ReportWarningWhenAwaitingTaskReturningProperty() + { + var test = @" +using System.Threading.Tasks; + +class Tests +{ + async Task GetTask(TaskCompletionSource tcs) + { + await [|tcs.Task|]; + } +} +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskPropertyThatWasSetInContext() + { + var test = @" +using System.Threading.Tasks; + +class Tests +{ + private Task MyTaskProperty { get; set; } + + async Task GetTask() + { + this.MyTaskProperty = Task.Run(() => {}); + await this.MyTaskProperty; + } +} +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task ReportWarningWhenAwaitingTaskPropertyThatWasNotSetInContext() + { + var test = @" +using System.Threading.Tasks; + +class Tests +{ + private Task MyTaskProperty { get; set; } = Task.Run(() => {}); + + async Task GetTask() + { + await [|this.MyTaskProperty|]; + } +} +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length) => CSVerify.Diagnostic().WithSpan(line, column, line, column + length); } From dc308483bae82ff929de4a85f5275d5742c6c1e8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 17:18:40 -0600 Subject: [PATCH 0847/1753] Fix VSTHRD110 to not misfire due to parentheses in invocation expressions Fixes #1168 --- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 29 +++++++++++++++---- ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 18 ++++++++++++ 2 files changed, 42 insertions(+), 5 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index 720d7f525..f4c22dd59 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -57,14 +57,33 @@ private void AnalyzeInvocation(OperationAnalysisContext context, CommonInterest. return; } - // Only consider invocations that are direct statements. Otherwise, we assume their - // result is awaited, assigned, or otherwise consumed. - if (operation.Parent is IExpressionStatementOperation || operation.Parent is IConditionalAccessOperation) + // Only consider invocations that are direct statements (or are statements through limited steps). + // Otherwise, we assume their result is awaited, assigned, or otherwise consumed. + IOperation? parentOperation = operation.Parent; + while (parentOperation is not null) { - if (awaitableTypes.IsAwaitableType(operation.Type)) + if (parentOperation is IExpressionStatementOperation) { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, operation.Syntax.GetLocation())); + // This expression is directly used in a statement. + break; } + + // This check is where we allow for specific operation types that may appear between the invocation + // and the statement that don't disqualify the invocation search for an invalid pattern. + if (parentOperation is IConditionalAccessOperation) + { + parentOperation = parentOperation.Parent; + } + else + { + // This expression is not directly used in a statement. + return; + } + } + + if (awaitableTypes.IsAwaitableType(operation.Type)) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, operation.Syntax.GetLocation())); } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index 7169b44df..5ee67c6fb 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -453,6 +453,24 @@ public async ValueTask DisposeAsync() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task ParentheticalUseOfTaskResult_ProducesNoDiagnostic() + { + string test = """ + using System; + using System.Threading.Tasks; + + class Class1 + { + public Func>? VCLoadMethod; + + public int? VirtualCurrencyBalances => (VCLoadMethod?.Invoke()).GetAwaiter().GetResult(); + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length) => CSVerify.Diagnostic().WithSpan(line, column, line, column + length); } From b56438f98c9ced446ff71bd091babefd93bfaa21 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 17:49:56 -0600 Subject: [PATCH 0848/1753] VSTHRD200 catches local function naming Fixes #1130 --- ...STHRD200UseAsyncNamingConventionCodeFix.cs | 9 ++-- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 41 +++++++++++++------ ...00UseAsyncNamingConventionAnalyzerTests.cs | 35 ++++++++++++++++ 3 files changed, 67 insertions(+), 18 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index 05b2f389b..99c8f7b06 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -2,18 +2,15 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Generic; using System.Collections.Immutable; using System.Globalization; using System.Linq; -using System.Text; using System.Threading; using System.Threading.Tasks; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CodeActions; using Microsoft.CodeAnalysis.CodeFixes; using Microsoft.CodeAnalysis.CSharp; -using Microsoft.CodeAnalysis.CSharp.Syntax; using Microsoft.CodeAnalysis.Rename; namespace Microsoft.VisualStudio.Threading.Analyzers; @@ -67,12 +64,12 @@ public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic, string protected override async Task GetChangedSolutionAsync(CancellationToken cancellationToken) { SyntaxNode root = await this.document.GetSyntaxRootOrThrowAsync(cancellationToken).ConfigureAwait(false); - var methodDeclaration = (MethodDeclarationSyntax)root.FindNode(this.diagnostic.Location.SourceSpan); + SyntaxNode declaration = root.FindNode(this.diagnostic.Location.SourceSpan); SemanticModel? semanticModel = await this.document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false); - IMethodSymbol methodSymbol = semanticModel.GetDeclaredSymbol(methodDeclaration, cancellationToken) ?? throw new InvalidOperationException("Unable to get method symbol."); - Solution? solution = this.document.Project.Solution; + IMethodSymbol? methodSymbol = semanticModel?.GetDeclaredSymbol(declaration, cancellationToken) as IMethodSymbol ?? throw new InvalidOperationException("Unable to get method symbol."); + Solution? updatedSolution = await Renamer.RenameSymbolAsync( solution, methodSymbol, diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index 4b0a28cf2..899d7a5c9 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -2,13 +2,12 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Concurrent; -using System.Collections.Generic; using System.Collections.Immutable; using System.Linq; using System.Threading; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Operations; namespace Microsoft.VisualStudio.Threading.Analyzers; @@ -54,28 +53,44 @@ public override void Initialize(AnalysisContext context) { CommonInterest.AwaitableTypeTester awaitableTypes = CommonInterest.CollectAwaitableTypes(context.Compilation, context.CancellationToken); context.RegisterSymbolAction(Utils.DebuggableWrapper(context => this.AnalyzeNode(context, awaitableTypes)), SymbolKind.Method); + context.RegisterOperationAction(Utils.DebuggableWrapper(context => this.AnalyzeLocalFunction(context, awaitableTypes)), OperationKind.LocalFunction); }); } + private void AnalyzeLocalFunction(OperationAnalysisContext context, CommonInterest.AwaitableTypeTester awaitableTypes) + { + if (this.AnalyzeMethodSymbol(context.Compilation, ((ILocalFunctionOperation)context.Operation).Symbol, awaitableTypes, context.CancellationToken) is Diagnostic diagnostic) + { + context.ReportDiagnostic(diagnostic); + } + } + private void AnalyzeNode(SymbolAnalysisContext context, CommonInterest.AwaitableTypeTester awaitableTypes) { - var methodSymbol = (IMethodSymbol)context.Symbol; + if (this.AnalyzeMethodSymbol(context.Compilation, (IMethodSymbol)context.Symbol, awaitableTypes, context.CancellationToken) is Diagnostic diagnostic) + { + context.ReportDiagnostic(diagnostic); + } + } + + private Diagnostic? AnalyzeMethodSymbol(Compilation compilation, IMethodSymbol methodSymbol, CommonInterest.AwaitableTypeTester awaitableTypes, CancellationToken cancellationToken) + { if (methodSymbol.AssociatedSymbol is IPropertySymbol) { // Skip accessor methods associated with properties. - return; + return null; } // Skip entrypoint methods since their name is non-negotiable. - if (Utils.IsEntrypointMethod(methodSymbol, context.Compilation, context.CancellationToken)) + if (Utils.IsEntrypointMethod(methodSymbol, compilation, cancellationToken)) { - return; + return null; } // Skip the method of the recommended dispose pattern. if (methodSymbol.Name == "DisposeAsyncCore") { - return; + return null; } bool hasAsyncFocusedReturnType = Utils.HasAsyncCompatibleReturnType(methodSymbol); @@ -88,7 +103,7 @@ private void AnalyzeNode(SymbolAnalysisContext context, CommonInterest.Awaitable // Do deeper checks to skip over methods that implement API contracts that are controlled elsewhere. if (methodSymbol.FindInterfacesImplemented().Any() || methodSymbol.IsOverride) { - return; + return null; } if (hasAsyncFocusedReturnType) @@ -97,21 +112,23 @@ private void AnalyzeNode(SymbolAnalysisContext context, CommonInterest.Awaitable // Not just any awaitable, since some stray extension method shouldn't change the world for everyone. ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(NewNameKey, methodSymbol.Name + MandatoryAsyncSuffix); - context.ReportDiagnostic(Diagnostic.Create( + return Diagnostic.Create( AddAsyncDescriptor, methodSymbol.Locations[0], - properties)); + properties); } else if (!awaitableTypes.IsAwaitableType(methodSymbol.ReturnType)) { // Only warn about abusing the Async suffix if the return type is not awaitable. ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(NewNameKey, methodSymbol.Name.Substring(0, methodSymbol.Name.Length - MandatoryAsyncSuffix.Length)); - context.ReportDiagnostic(Diagnostic.Create( + return Diagnostic.Create( RemoveAsyncDescriptor, methodSymbol.Locations[0], - properties)); + properties); } } + + return null; } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs index c05cb25a8..9e4d60ac6 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs @@ -584,4 +584,39 @@ protected virtual async ValueTask DisposeAsyncCore() "; await CSVerify.VerifyAnalyzerAsync(test); } + + [Fact] + public async Task LocalFunctionUsesAsyncSuffix() + { + string test = """ + using System.Threading.Tasks; + + class MyClass + { + void Foo() + { + async Task {|#0:Bar|}() + { + } + } + } + """; + + string fix = """ + using System.Threading.Tasks; + + class MyClass + { + void Foo() + { + async Task BarAsync() + { + } + } + } + """; + + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithLocation(0); + await CSVerify.VerifyCodeFixAsync(test, expected, fix); + } } From cc63319000132eeb68f91f12fe1daf7a53fe168a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 20:48:33 -0600 Subject: [PATCH 0849/1753] Fix VSTHRD012 false positive due to inaccessible overloads Fixes #1111 --- ...AbstractVSTHRD012SpecifyJtfWhereAllowed.cs | 6 +- .../Utils.cs | 16 ++++++ .../VSTHRD012SpecifyJtfWhereAllowedTests.cs | 57 +++++++++++++++++++ 3 files changed, 77 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs index 338f1f5b5..969e32176 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs @@ -81,8 +81,10 @@ private static void AnalyzeCall(OperationAnalysisContext context, Location locat // The method being invoked doesn't take any JTC/JTF parameters. // Look for an overload that does. bool preferableAlternativesExist = otherOverloads - .Where(m => !m.IsObsolete()) - .Any(m => m.Parameters.Skip(m.IsExtensionMethod ? 1 : 0).Any(IsImportantJtfParameter)); + .Any(m => + !m.IsObsolete() && + m.Parameters.Skip(m.IsExtensionMethod ? 1 : 0).Any(IsImportantJtfParameter) && + context.ContainingSymbol.FindContainingNamedOrAssemblySymbol() is ISymbol containingSymbol && context.Compilation.IsSymbolAccessibleWithin(m, containingSymbol)); if (preferableAlternativesExist) { Diagnostic diagnostic = Diagnostic.Create( diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index 7ef775888..77d0cc712 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -700,6 +700,22 @@ internal static IOperation FindFinalAncestor(IOperation operation) return default; } + internal static ISymbol? FindContainingNamedOrAssemblySymbol(this ISymbol? symbol) + { + ISymbol? candidate = symbol; + while (candidate is not null) + { + if (candidate is INamedTypeSymbol or IAssemblySymbol) + { + return candidate; + } + + candidate = candidate.ContainingSymbol; + } + + return null; + } + private static bool IsSymbolTheRightType(ISymbol symbol, string typeName, IReadOnlyList namespaces) { var fieldSymbol = symbol as IFieldSymbol; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs index dce0000a1..a9cfa155a 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD012SpecifyJtfWhereAllowedTests.cs @@ -254,4 +254,61 @@ void F() { await CSVerify.VerifyAnalyzerAsync(test); } + + [Fact] + public async Task InaccessibleMembers_Private_GeneratesNoWarning() + { + string test = """ + using System; + using Microsoft.VisualStudio.Threading; + + static class Extensions + { + public static void OnMainThread(Action action) => OnMainThread(null, action); + + private static void OnMainThread(JoinableTaskFactory factory, Action action) => factory.Run(async delegate + { + await factory.SwitchToMainThreadAsync(); + action(); + }); + } + + class Foo + { + void Bar() + { + Extensions.OnMainThread(() => { }); + } + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task AccessibleMembers_Private_GeneratesWarning() + { + string test = """ + using System; + using Microsoft.VisualStudio.Threading; + + static class Extensions + { + public static void OnMainThread(Action action) => OnMainThread(null, action); + + private static void OnMainThread(JoinableTaskFactory factory, Action action) => factory.Run(async delegate + { + await factory.SwitchToMainThreadAsync(); + action(); + }); + + static void Bar() + { + [|OnMainThread|](() => { }); + } + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } } From 1784af8b172ce82691c9e4266284705d7749d0de Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 20:51:14 -0600 Subject: [PATCH 0850/1753] Offer `.ConfigureAwait(false)` as the first code fix Closes #980 --- .../VSTHRD111UseConfigureAwaitCodeFix.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs index 923d67d7c..658a20e07 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD111UseConfigureAwaitCodeFix.cs @@ -57,8 +57,8 @@ Task ApplyFix(bool captureContext) return Task.FromResult(context.Document.WithSyntaxRoot(syntaxRoot.ReplaceNode(awaitedExpression, configuredAwaitExpression))); } - context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_True_Title, ct => ApplyFix(true), true.ToString()), diagnostic); context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_False_Title, ct => ApplyFix(false), false.ToString()), diagnostic); + context.RegisterCodeFix(CodeAction.Create(Strings.VSTHRD111_CodeFix_True_Title, ct => ApplyFix(true), true.ToString()), diagnostic); } } } From ba76e6100b9d0586974eb10d15afed3e92d798b5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 23 Oct 2023 20:54:18 -0600 Subject: [PATCH 0851/1753] Bump xunit from 2.5.2 to 2.5.3 (#226) Bumps [xunit](https://github.com/xunit/xunit) from 2.5.2 to 2.5.3. - [Commits](https://github.com/xunit/xunit/compare/2.5.2...2.5.3) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6f6fe2ef4..47b1fc9c7 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 7ef6ca07b8f5c03398958a4e3c7482f7129499cb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 23 Oct 2023 20:54:29 -0600 Subject: [PATCH 0852/1753] Bump dotnet-coverage from 17.9.1 to 17.9.3 (#225) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.9.1 to 17.9.3. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index c13b4c68a..b935d933f 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,7 +15,7 @@ ] }, "dotnet-coverage": { - "version": "17.9.1", + "version": "17.9.3", "commands": [ "dotnet-coverage" ] From 689f9936d5bb02228e116d788bf66cbf7eee1577 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 21:05:19 -0600 Subject: [PATCH 0853/1753] Handle new warnings --- test/Microsoft.VisualStudio.Threading.Tests/.editorconfig | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/.editorconfig diff --git a/test/Microsoft.VisualStudio.Threading.Tests/.editorconfig b/test/Microsoft.VisualStudio.Threading.Tests/.editorconfig new file mode 100644 index 000000000..f13764289 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/.editorconfig @@ -0,0 +1,5 @@ +[*.cs] +# xUnit1030: Test methods should not call ConfigureAwait(false) +dotnet_diagnostic.xUnit1030.severity = none +# xUnit1031: Test methods should not use blocking task operations +dotnet_diagnostic.xUnit1031.severity = none From a74240f37809485c1fbbde844acf3e056a3ff41c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Oct 2023 21:14:04 -0600 Subject: [PATCH 0854/1753] Fix v17.2 official build --- nuget.config | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/nuget.config b/nuget.config index 40c3009ef..0a73357e8 100644 --- a/nuget.config +++ b/nuget.config @@ -2,24 +2,13 @@ - - - - - + - - - Microsoft;xunit;manuel.roemer;sharwell;jamesnk;aarnott;MarcoRossignoli;Thecentury;clairernovotny;reg;mmanela;onovotny - - - - - - - - + + + + From 9965b55c9ee092e262109112b9635d42bf838a55 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Oct 2023 09:15:10 -0600 Subject: [PATCH 0855/1753] Fix dependency version conflicts --- Directory.Packages.props | 2 ++ test/IsolatedTestHost/App.config | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 201e8c267..3d6845a2f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -31,7 +31,9 @@ + + diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index a464805c8..2a58d341c 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -10,13 +10,13 @@ - + - + From 79b0eeba24fc452c819d4b3285d099c52fadc09a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Oct 2023 13:19:15 -0600 Subject: [PATCH 0856/1753] Add test to demonstrate that #881 no longer repros Closes #881 --- ...10ObserveResultOfAsyncCallsAnalyzerTests.cs | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index 5ee67c6fb..bae3ec25c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -429,6 +429,21 @@ async Task Foo(Test? tester) await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task NullCoalescing_ProducesNoDiagnostic() + { + string test = """ + using System.Threading.Tasks; + + class Tree { + static Task ShakeTreeAsync(Tree? tree) => tree?.ShakeAsync() ?? Task.CompletedTask; + Task ShakeAsync() => Task.CompletedTask; + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task TaskInFinalizer() { @@ -470,7 +485,4 @@ class Class1 await CSVerify.VerifyAnalyzerAsync(test); } - - private DiagnosticResult CreateDiagnostic(int line, int column, int length) - => CSVerify.Diagnostic().WithSpan(line, column, line, column + length); } From 73ee84e49796e9fddde2e563ca95e57c815ede9b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Oct 2023 15:23:06 -0600 Subject: [PATCH 0857/1753] Recognize local functions in VSTHRD103 This prevents false positives in synchronous local functions that appear within async methods. Fixes #1003 --- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 30 ++++++++++++------- .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 25 ++++++++++++++++ 2 files changed, 44 insertions(+), 11 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index c1bbaa06d..05cef3c9f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -171,22 +171,30 @@ private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext // We want to scan invocations that occur inside Task and Task-returning delegates or methods. // That is: methods that either are or could be made async. IMethodSymbol? methodSymbol = null; - AnonymousFunctionExpressionSyntax? anonymousFunc = context.Node.FirstAncestorOrSelf(); - if (anonymousFunc is object) + for (SyntaxNode? focusedNode = context.Node; focusedNode is not null; focusedNode = focusedNode.Parent) { - SymbolInfo symbolInfo = context.SemanticModel.GetSymbolInfo(anonymousFunc, context.CancellationToken); - methodSymbol = symbolInfo.Symbol as IMethodSymbol; - } - else - { - MethodDeclarationSyntax? methodDecl = context.Node.FirstAncestorOrSelf(); - if (methodDecl is object) + switch (focusedNode) { - methodSymbol = context.SemanticModel.GetDeclaredSymbol(methodDecl, context.CancellationToken); + case AnonymousFunctionExpressionSyntax anonFunc: + SymbolInfo symbolInfo = context.SemanticModel.GetSymbolInfo(anonFunc, context.CancellationToken); + methodSymbol = symbolInfo.Symbol as IMethodSymbol; + break; + case LocalFunctionStatementSyntax localFunc: + methodSymbol = context.SemanticModel.GetDeclaredSymbol(localFunc, context.CancellationToken) as IMethodSymbol; + break; + case MethodDeclarationSyntax methodDecl: + methodSymbol = context.SemanticModel.GetDeclaredSymbol(methodDecl, context.CancellationToken); + break; + default: + // We want to continue iteration of the for loop. + continue; } + + // We encountered one of our case statements, so whether or not we have a methodSymbol, we shouldn't look further. + break; } - return methodSymbol.HasAsyncCompatibleReturnType(); + return methodSymbol?.HasAsyncCompatibleReturnType() is true; } private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, ExpressionSyntax memberName, IEnumerable problematicMethods) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index b665feb5d..b4ff2da62 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -1314,6 +1314,31 @@ Task MethodAsync() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotRaiseInSyncLocalFunctionInsideAsyncMethod() + { + string test = """ + using System.Threading.Tasks; + + class SomeClass { + Task Foo() + { + return Task.CompletedTask; + + void CompletionHandler() + { + this.Bar(); + } + } + + void Bar() {} + Task BarAsync() => Task.CompletedTask; + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName) => CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(line, column, line, column + length).WithArguments(methodName); From b561132447eba0469db2c6911431b7eee1152d8a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Oct 2023 13:51:49 -0600 Subject: [PATCH 0858/1753] Fix VSTHRD003 to allow for awaiting more Task properties When integrating into the VS repo, recent enhancements to VSTHRD003 made insertion of the new analyzers problematic. In particular, two patterns were quite common and arguably should be allowed: - Awaiting on the `JoinableTask.Task` property on the result of a `JoinableTaskFactory.RunAsync` method call. In general, if a method returns an object, awaiting one of that object's properties *might not* be fair game, but it seems more likely than not. So in this change, that is now allowed. - Awaiting a `TaskCompletionSource.Task` property on a TCS that was created in that same method. Test methods often do this. Awaiting a TCS.Task property is never guaranteed to be safe as far as analyzers can tell (though the 3rd threading rule can make it safe), and when common patterns appear that are _typically_ safe, we should allow it. --- .../CSharpUtils.cs | 35 ++++++-- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 54 +++++++++---- .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 79 ++++++++++++++++--- 3 files changed, 134 insertions(+), 34 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index 386927675..9db145608 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -49,6 +49,11 @@ internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode? s return new ContainingFunctionData(simpleLambda, simpleLambda.AsyncKeyword != default(SyntaxToken), SyntaxFactory.ParameterList().AddParameters(simpleLambda.Parameter), simpleLambda.Body, simpleLambda.WithBody); } + if (syntaxNode is LocalFunctionStatementSyntax localFunc) + { + return new ContainingFunctionData(localFunc, localFunc.Modifiers.Any(SyntaxKind.AsyncKeyword), localFunc.ParameterList, (CSharpSyntaxNode?)localFunc.ExpressionBody ?? localFunc.Body, localFunc.WithBody); + } + if (syntaxNode is AnonymousMethodExpressionSyntax anonymousMethod) { return new ContainingFunctionData(anonymousMethod, anonymousMethod.AsyncKeyword != default(SyntaxToken), anonymousMethod.ParameterList, anonymousMethod.Body, anonymousMethod.WithBody); @@ -125,7 +130,7 @@ internal static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode) return false; } - internal static bool IsAssignedWithin(SyntaxNode container, SemanticModel semanticModel, ISymbol variable, CancellationToken cancellationToken) + internal static IEnumerable FindAssignedValuesWithin(SyntaxNode container, SemanticModel semanticModel, ISymbol variable, CancellationToken cancellationToken) { if (semanticModel is null) { @@ -139,22 +144,36 @@ internal static bool IsAssignedWithin(SyntaxNode container, SemanticModel semant if (container is null) { - return false; + yield break; } - foreach (SyntaxNode? node in container.DescendantNodesAndSelf(n => !(n is AnonymousFunctionExpressionSyntax))) + foreach (SyntaxNode? node in container.DescendantNodesAndSelf(n => !(n is AnonymousFunctionExpressionSyntax or LocalFunctionStatementSyntax))) { + cancellationToken.ThrowIfCancellationRequested(); if (node is AssignmentExpressionSyntax assignment) { ISymbol? assignedSymbol = semanticModel.GetSymbolInfo(assignment.Left, cancellationToken).Symbol; if (variable.Equals(assignedSymbol, SymbolEqualityComparer.Default)) { - return true; + yield return assignment.Right; } } - } - return false; + if (node is LocalDeclarationStatementSyntax localDeclarationStatement) + { + foreach (VariableDeclaratorSyntax localDeclVar in localDeclarationStatement.Declaration.Variables) + { + if (localDeclVar.Initializer is not null) + { + ISymbol? assignedSymbol = semanticModel.GetDeclaredSymbol(localDeclVar, cancellationToken); + if (variable.Equals(assignedSymbol, SymbolEqualityComparer.Default)) + { + yield return localDeclVar.Initializer.Value; + } + } + } + } + } } internal static MemberAccessExpressionSyntax MemberAccess(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) @@ -277,7 +296,7 @@ internal override bool IsAsyncMethod(SyntaxNode syntaxNode) internal readonly struct ContainingFunctionData { - internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax? parameterList, CSharpSyntaxNode? blockOrExpression, Func bodyReplacement) + internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax? parameterList, CSharpSyntaxNode? blockOrExpression, Func bodyReplacement) { this.Function = function; this.IsAsync = isAsync; @@ -294,6 +313,6 @@ internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, Paramet internal CSharpSyntaxNode? BlockOrExpression { get; } - internal Func BodyReplacement { get; } + internal Func BodyReplacement { get; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index e57dec834..884881890 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -155,25 +155,28 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) return null; } - SymbolInfo symbolToConsider = semanticModel.GetSymbolInfo(expressionSyntax, cancellationToken); + ExpressionSyntax focusedExpression = expressionSyntax; + SymbolInfo symbolToConsider = semanticModel.GetSymbolInfo(focusedExpression, cancellationToken); if (CommonInterest.TaskConfigureAwait.Any(configureAwait => configureAwait.IsMatch(symbolToConsider.Symbol))) { // If the invocation is wrapped inside parentheses then drill down to get the invocation. - while (expressionSyntax is ParenthesizedExpressionSyntax parenthesizedExprSyntax) + while (focusedExpression is ParenthesizedExpressionSyntax parenthesizedExprSyntax) { - expressionSyntax = parenthesizedExprSyntax.Expression; + focusedExpression = parenthesizedExprSyntax.Expression; } - Debug.Assert(expressionSyntax is InvocationExpressionSyntax, "expressionSyntax should be an invocation"); + Debug.Assert(focusedExpression is InvocationExpressionSyntax, "focusedExpression should be an invocation"); - if (((InvocationExpressionSyntax)expressionSyntax).Expression is MemberAccessExpressionSyntax memberAccessExpression) + if (((InvocationExpressionSyntax)focusedExpression).Expression is MemberAccessExpressionSyntax memberAccessExpression) { + focusedExpression = memberAccessExpression.Expression; symbolToConsider = semanticModel.GetSymbolInfo(memberAccessExpression.Expression, cancellationToken); } } ITypeSymbol symbolType; bool dataflowAnalysisCompatibleVariable = false; + CSharpUtils.ContainingFunctionData? containingFunc = null; switch (symbolToConsider.Symbol) { case ILocalSymbol localSymbol: @@ -182,6 +185,29 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) break; case IPropertySymbol propertySymbol when !IsSymbolAlwaysOkToAwait(propertySymbol): symbolType = propertySymbol.Type; + + if (focusedExpression is MemberAccessExpressionSyntax memberAccessExpression) + { + // Do not report a warning if the task is a member of an object that was returned from an invocation made in this method. + if (memberAccessExpression.Expression is InvocationExpressionSyntax) + { + return null; + } + + // Do not report a warning if the task is a member of an object that was created in this method. + if (memberAccessExpression.Expression is IdentifierNameSyntax identifier && + semanticModel.GetSymbolInfo(identifier, cancellationToken).Symbol is ILocalSymbol local) + { + // Search for assignments to the local and see if it was to a new object. + containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); + if (containingFunc.Value.BlockOrExpression is not null && + CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any(v => v is ObjectCreationExpressionSyntax)) + { + return null; + } + } + } + break; case IParameterSymbol parameterSymbol: symbolType = parameterSymbol.Type; @@ -247,7 +273,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) break; case IMethodSymbol methodSymbol: - if (Utils.IsTask(methodSymbol.ReturnType) && expressionSyntax is InvocationExpressionSyntax invocationExpressionSyntax) + if (Utils.IsTask(methodSymbol.ReturnType) && focusedExpression is InvocationExpressionSyntax invocationExpressionSyntax) { // Consider all arguments IEnumerable? expressionsToConsider = invocationExpressionSyntax.ArgumentList.Arguments.Select(a => a.Expression); @@ -275,8 +301,8 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) } // Report warning if the task was not initialized within the current delegate or lambda expression - CSharpUtils.ContainingFunctionData containingFunc = CSharpUtils.GetContainingFunction(expressionSyntax); - if (containingFunc.BlockOrExpression is BlockSyntax delegateBlock) + containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); + if (containingFunc.Value.BlockOrExpression is BlockSyntax delegateBlock) { if (dataflowAnalysisCompatibleVariable) { @@ -285,9 +311,9 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) // When possible (await is direct child of the block and not a field), execute data flow analysis by passing first and last statement to capture only what happens before the await // Check if the await is direct child of the code block (first parent is ExpressionStantement, second parent is the block itself) - if (delegateBlock.Equals(expressionSyntax.Parent?.Parent?.Parent)) + if (delegateBlock.Equals(focusedExpression.Parent?.Parent?.Parent)) { - dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock.ChildNodes().First(), expressionSyntax.Parent.Parent); + dataFlowAnalysis = semanticModel.AnalyzeDataFlow(delegateBlock.ChildNodes().First(), focusedExpression.Parent.Parent); } else { @@ -297,22 +323,22 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) if (dataFlowAnalysis?.WrittenInside.Contains(symbolToConsider.Symbol) is false) { - return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); + return Diagnostic.Create(Descriptor, focusedExpression.GetLocation()); } } else { // Do the best we can searching for assignment statements. - if (!CSharpUtils.IsAssignedWithin(containingFunc.BlockOrExpression, semanticModel, symbolToConsider.Symbol, cancellationToken)) + if (!CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, symbolToConsider.Symbol, cancellationToken).Any()) { - return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); + return Diagnostic.Create(Descriptor, focusedExpression.GetLocation()); } } } else { // It's not a block, it's just a lambda expression, so the variable must be external. - return Diagnostic.Create(Descriptor, expressionSyntax.GetLocation()); + return Diagnostic.Create(Descriptor, focusedExpression.GetLocation()); } return null; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 0ecc075d6..1003c7c24 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -201,12 +201,11 @@ class Tests public async Task AwaitAndGetResult() {{ - await task.ConfigureAwait({(continueOnCapturedContext ? "true" : "false")}); + await [|task|].ConfigureAwait({(continueOnCapturedContext ? "true" : "false")}); }} }} "; - DiagnosticResult expected = this.CreateDiagnostic(10, 15, 21 + continueOnCapturedContext.ToString().Length); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Theory] @@ -223,12 +222,11 @@ class Tests public async Task AwaitAndGetResult() {{ - return await task.ConfigureAwait({(continueOnCapturedContext ? "true" : "false")}); + return await [|task|].ConfigureAwait({(continueOnCapturedContext ? "true" : "false")}); }} }} "; - DiagnosticResult expected = this.CreateDiagnostic(10, 22, 21 + continueOnCapturedContext.ToString().Length); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -244,12 +242,11 @@ class Tests public async Task AwaitAndGetResult() { - await task.ConfigureAwaitRunInline(); + await [|task|].ConfigureAwaitRunInline(); } } "; - DiagnosticResult expected = this.CreateDiagnostic(11, 15, 30); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -265,12 +262,11 @@ class Tests public async Task AwaitAndGetResult() { - return await task.ConfigureAwaitRunInline(); + return await [|task|].ConfigureAwaitRunInline(); } } "; - DiagnosticResult expected = this.CreateDiagnostic(11, 22, 30); - await CSVerify.VerifyAnalyzerAsync(test, expected); + await CSVerify.VerifyAnalyzerAsync(test); } [Fact] @@ -1280,6 +1276,64 @@ async Task GetTask() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskPropertyOfObjectCreatedInContext() + { + var test = @" +using System.Threading.Tasks; + +class Tests +{ + private Task MyTaskProperty { get; set; } + + static async Task GetTask() + { + // our own property. + var obj = new Tests(); + await obj.MyTaskProperty; + + // local with initializer + var tcs = new TaskCompletionSource(); + await tcs.Task; + + // Assign later + TaskCompletionSource tcs2; + tcs2 = new TaskCompletionSource(); + await tcs2.Task; + + // Assigned, but not to a newly created object. + TaskCompletionSource tcs3 = tcs2; + await [|tcs3.Task|]; + } +} +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + + /// + /// This is important to allow folks to return jtf.RunAsync(...).Task from a method. + /// + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskPropertyOfObjectReturnedFromMethod() + { + var test = @" +using System.Threading.Tasks; + +class Tests +{ + private Task MyTaskProperty { get; set; } + + static Tests NewTests() => new Tests(); + + static async Task GetTask() + { + await NewTests().MyTaskProperty; + } +} +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task ReportWarningWhenAwaitingTaskPropertyThatWasNotSetInContext() { @@ -1293,6 +1347,7 @@ class Tests async Task GetTask() { await [|this.MyTaskProperty|]; + await [|MyTaskProperty|]; } } "; From 62691614bbd61856e40986df43f8e9a43274b48f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 30 Oct 2023 12:50:05 -0600 Subject: [PATCH 0859/1753] Bump powershell from 7.3.8 to 7.3.9 (#227) Bumps [powershell](https://github.com/PowerShell/PowerShell) from 7.3.8 to 7.3.9. - [Release notes](https://github.com/PowerShell/PowerShell/releases) - [Commits](https://github.com/PowerShell/PowerShell/compare/v7.3.8...v7.3.9) --- updated-dependencies: - dependency-name: powershell dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index b935d933f..de46e939b 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.8", + "version": "7.3.9", "commands": [ "pwsh" ] From e864cda130ec3628d756b57192eee8551752d1c5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 30 Oct 2023 14:33:46 -0600 Subject: [PATCH 0860/1753] Add `AsyncLazy.SuppressRelevance()` method This allows value factories to identify their own code blocks that won't be awaited on and therefore shouldn't trigger reentrancy detection. --- .../AsyncLazy`1.cs | 95 ++++++++++++++++++ .../net472/PublicAPI.Unshipped.txt | 5 +- .../net6.0-windows/PublicAPI.Unshipped.txt | 5 +- .../net6.0/PublicAPI.Unshipped.txt | 5 +- .../netstandard2.0/PublicAPI.Unshipped.txt | 5 +- .../AsyncLazyTests.cs | 96 +++++++++++++++++++ 6 files changed, 207 insertions(+), 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 057d4621a..630bc2b6f 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -261,6 +261,65 @@ public T GetValue(CancellationToken cancellationToken) } } + /// + /// Marks the code that follows as irrelevant to the receiving value factory. + /// + /// A value to dispose of to restore relevance into the value factory. + /// + /// In some cases asynchronous work may be spun off inside a value factory. + /// When the value factory does not require this work to finish before the value factory can complete, + /// it can be useful to use this method to mark that code as irrelevant to the value factory. + /// In particular, this can be necessary when the spun off task may actually include code that may itself + /// await the completion of the value factory itself. + /// Such a situation would lead to an being thrown from + /// if the value factory has not completed already, + /// which can introduce non-determinstic failures in the program. + /// A using block around the spun off code can help your program achieve reliable behavior, as shown below. + /// + /// numberOfApples; + /// + /// public MyClass() { + /// this.numberOfApples = new AsyncLazy(async delegate { + /// // We have some fire-and-forget code to run. + /// // This is *not* relevant to the value factory, which is allowed to complete without waiting for this code to finish. + /// using (this.numberOfApples.SuppressRelevance()) { + /// this.FireOffNotificationsAsync(); + /// } + /// + /// // This code is relevant to the value factory, and must complete before the value factory can complete. + /// return await this.CountNumberOfApplesAsync(); + /// }); + /// } + /// + /// public event EventHandler? ApplesCountingHasBegun; + /// + /// public async Task GetApplesCountAsync(CancellationToken cancellationToken) { + /// return await this.numberOfApples.GetValueAsync(cancellationToken); + /// } + /// + /// private async Task CountNumberOfApplesAsync() { + /// await Task.Delay(1000); + /// return 5; + /// } + /// + /// private async Task FireOffNotificationsAsync() { + /// // This may call to 3rd party code, which may happen to call back into GetApplesCountAsync (and thus into our AsyncLazy instance), + /// // but such calls should *not* be interpreted as value factory reentrancy. They should just wait for the value factory to finish. + /// // We accomplish this by suppressing relevance of the value factory while this code runs (see the caller of this method above). + /// this.ApplesCountingHasBegun?.Invoke(this, EventArgs.Empty); + /// } + /// } + /// ]]> + /// + /// If the was created with a , + /// this method also calls on the + /// associated with that factory. + /// + /// + public RevertRelevance SuppressRelevance() => new RevertRelevance(this); + /// /// Disposes of the lazily-initialized value if disposable, and causes all subsequent attempts to obtain the value to fail. /// @@ -373,4 +432,40 @@ public override string ToString() ? (this.value.Status == TaskStatus.RanToCompletion ? $"{this.value.Result}" : Strings.LazyValueFaulted) : Strings.LazyValueNotCreated; } + + /// + /// A structure that hides relevance of a block of code from a particular and the it was created with. + /// + public readonly struct RevertRelevance : IDisposable + { + private readonly AsyncLazy? owner; + private readonly object? oldCheckValue; + private readonly JoinableTaskContext.RevertRelevance? joinableRelevance; + + /// + /// Initializes a new instance of the struct. + /// + /// The instance that created this value. + internal RevertRelevance(AsyncLazy owner) + { + Requires.NotNull(owner, nameof(owner)); + this.owner = owner; + + (this.oldCheckValue, owner.recursiveFactoryCheck.Value) = (owner.recursiveFactoryCheck.Value, null); + this.joinableRelevance = owner.jobFactory?.Context.SuppressRelevance(); + } + + /// + /// Reverts the async local and thread static values to their original values. + /// + public void Dispose() + { + if (this.owner is object) + { + this.owner.recursiveFactoryCheck.Value = this.oldCheckValue; + } + + this.joinableRelevance?.Dispose(); + } + } } diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index c5cb0a27a..1a9888196 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -10,4 +10,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index c5cb0a27a..1a9888196 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -10,4 +10,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index c5cb0a27a..1a9888196 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -10,4 +10,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index c5cb0a27a..1a9888196 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -10,4 +10,7 @@ Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool \ No newline at end of file +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 9c3e3981e..2077d81c3 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -652,6 +652,102 @@ public async Task ExecutionContextFlowsFromFirstCaller_JTF() await asyncLazy.GetValueAsync(); } + [Fact] + public async Task SuppressRelevance_WithoutJTF() + { + AsyncManualResetEvent allowValueFactoryToFinish = new(); + Task? fireAndForgetTask = null; + AsyncLazy asyncLazy = null!; + asyncLazy = new AsyncLazy( + async delegate + { + using (asyncLazy.SuppressRelevance()) + { + fireAndForgetTask = FireAndForgetCodeAsync(); + } + + await allowValueFactoryToFinish; + return 1; + }, + null); + + bool fireAndForgetCodeAsyncEntered = false; + Task lazyValue = asyncLazy.GetValueAsync(); + Assert.True(fireAndForgetCodeAsyncEntered); + allowValueFactoryToFinish.Set(); + + // Assert that the value factory was allowed to finish. + Assert.Equal(1, await lazyValue.WithCancellation(this.TimeoutToken)); + + // Assert that the fire-and-forget task was allowed to finish and did so without throwing. + Assert.Equal(1, await fireAndForgetTask!.WithCancellation(this.TimeoutToken)); + + async Task FireAndForgetCodeAsync() + { + fireAndForgetCodeAsyncEntered = true; + return await asyncLazy.GetValueAsync(); + } + } + + [Fact] + public async Task SuppressRelevance_WithJTF() + { + JoinableTaskContext? context = this.InitializeJTCAndSC(); + SingleThreadedTestSynchronizationContext.IFrame frame = SingleThreadedTestSynchronizationContext.NewFrame(); + + JoinableTaskFactory? jtf = context.Factory; + AsyncManualResetEvent allowValueFactoryToFinish = new(); + Task? fireAndForgetTask = null; + AsyncLazy asyncLazy = null!; + asyncLazy = new AsyncLazy( + async delegate + { + using (asyncLazy.SuppressRelevance()) + { + fireAndForgetTask = FireAndForgetCodeAsync(); + } + + await allowValueFactoryToFinish; + return 1; + }, + jtf); + + bool fireAndForgetCodeAsyncEntered = false; + bool fireAndForgetCodeAsyncReachedUIThread = false; + jtf.Run(async delegate + { + Task lazyValue = asyncLazy.GetValueAsync(); + Assert.True(fireAndForgetCodeAsyncEntered); + await Task.Delay(AsyncDelay); + Assert.False(fireAndForgetCodeAsyncReachedUIThread); + allowValueFactoryToFinish.Set(); + + // Assert that the value factory was allowed to finish. + Assert.Equal(1, await lazyValue.WithCancellation(this.TimeoutToken)); + }); + + // Run a main thread pump so the fire-and-forget task can finish. + SingleThreadedTestSynchronizationContext.PushFrame(SynchronizationContext.Current!, frame); + + // Assert that the fire-and-forget task was allowed to finish and did so without throwing. + Assert.Equal(1, await fireAndForgetTask!.WithCancellation(this.TimeoutToken)); + + async Task FireAndForgetCodeAsync() + { + fireAndForgetCodeAsyncEntered = true; + + // Yield the caller's thread. + // Resuming will require the main thread, since the caller was on the main thread. + await Task.Yield(); + + fireAndForgetCodeAsyncReachedUIThread = true; + + int result = await asyncLazy.GetValueAsync(); + frame.Continue = false; + return result; + } + } + [Fact] public async Task Dispose_ValueType_Completed() { From e4778ffbaa57204baabfe22f554bcba642eff5fd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 30 Oct 2023 15:19:32 -0600 Subject: [PATCH 0861/1753] Drop reference to very old and removed document --- src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index e2ea752fe..3eb58fbcb 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -18,11 +18,6 @@ namespace Microsoft.VisualStudio.Threading; /// /// A common context within which joinable tasks may be created and interact to avoid deadlocks. /// -/// -/// Lots of documentation and FAQ on Joinable Tasks is available on OneNote: . -/// /// /// There are three rules that should be strictly followed when using or interacting /// with JoinableTasks: From 2e6c239bbcb193809c4379a7f7797e734d0c988c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 6 Nov 2023 11:09:57 -0700 Subject: [PATCH 0862/1753] Bump xunit from 2.5.3 to 2.6.1 (#228) Bumps [xunit](https://github.com/xunit/xunit) from 2.5.3 to 2.6.1. - [Commits](https://github.com/xunit/xunit/compare/2.5.3...2.6.1) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 47b1fc9c7..c5b4d4835 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 4337ca1c8ebf7bff355d024ab525e9428d8a0bb4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Nov 2023 06:41:30 -0700 Subject: [PATCH 0863/1753] Ignore `dotnet-format` v9 versions --- .github/dependabot.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a0e8933bb..9053ac863 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -10,4 +10,4 @@ updates: ignore: # This package has unlisted versions on nuget.org that are not supported. Avoid them. - dependency-name: dotnet-format - versions: ["6.x", "7.x", "8.x"] + versions: ["6.x", "7.x", "8.x", "9.x"] From 5a0cd156d0da7a37b76ac60b8c5245494958f51f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 13 Nov 2023 06:49:02 -0700 Subject: [PATCH 0864/1753] Bump Microsoft.NET.Test.Sdk from 17.7.2 to 17.8.0 (#229) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.7.2 to 17.8.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.7.2...v17.8.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c5b4d4835..faa3fc68b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true - + From 0fcb1d81a073695876aca758d81881c182de864b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Nov 2023 15:26:34 -0700 Subject: [PATCH 0865/1753] Apply Directory.Packages.props in Apply-Template.ps1 --- Apply-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Apply-Template.ps1 b/Apply-Template.ps1 index 1c7733558..42ed33623 100644 --- a/Apply-Template.ps1 +++ b/Apply-Template.ps1 @@ -36,7 +36,7 @@ robocopy /mir $PSScriptRoot/.devcontainer $Path/.devcontainer robocopy /mir $PSScriptRoot/.github $Path/.github robocopy /mir $PSScriptRoot/.vscode $Path/.vscode robocopy /mir $PSScriptRoot/tools $Path/tools -robocopy $PSScriptRoot $Path Directory.Build.* global.json init.* azure-pipelines.yml .gitignore .gitattributes .editorconfig +robocopy $PSScriptRoot $Path Directory.Build.* Directory.Packages.props global.json init.* azure-pipelines.yml .gitignore .gitattributes .editorconfig robocopy $PSScriptRoot/src $Path/src Directory.Build.* .editorconfig AssemblyInfo.cs robocopy $PSScriptRoot/test $Path/test Directory.Build.* .editorconfig Remove-Item $Path/azure-pipelines/expand-template.yml From e678b457c03adcff1f5459586095c27a3a88f15d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Nov 2023 21:38:21 -0700 Subject: [PATCH 0866/1753] Bump to the .NET 8.0.100 SDK --- .devcontainer/Dockerfile | 2 +- Directory.Build.props | 2 +- global.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index cef7ac6f7..b680b1dbc 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:7.0.401-jammy +FROM mcr.microsoft.com/dotnet/sdk:8.0.100-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/Directory.Build.props b/Directory.Build.props index 22986f2f3..d3edacc82 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -5,7 +5,7 @@ $(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - 11 + 12 enable enable latest diff --git a/global.json b/global.json index f153194c4..d24a9b70b 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "7.0.401", + "version": "8.0.100", "rollForward": "patch", "allowPrerelease": false } From 2558a26be137965b04230b7ed7ce30f4ec90759d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:13:10 -0700 Subject: [PATCH 0867/1753] Bump DNNE from 2.0.1 to 2.0.6 (#1257) Bumps DNNE from 2.0.1 to 2.0.6. --- updated-dependencies: - dependency-name: DNNE dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6000edb4b..4749e3b87 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ 2.4.416101 - + From a5d42f8fabe6c1b548075125ce2f16e266cd5e2d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Nov 2023 14:28:59 -0700 Subject: [PATCH 0868/1753] Fix optprof pipeline VS Eng wants us to avoid using DD-CB-PR for non-PR builds, such as optprof runs. --- azure-pipelines/OptProf.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 3201f263f..abb2f2fb5 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -93,9 +93,9 @@ stages: SkipCreatePR: true CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 - displayName: Trigger a new build of DD-CB-PR + displayName: Trigger a new build of DD-CB-TestSignVS-devCI inputs: - buildDefinition: DD-CB-PR + buildDefinition: DD-CB-TestSignVS-devCI useSameBranch: false branchToUse: $(InsertTopicBranch) storeInEnvironmentVariable: true From 11d58a89267475da272059caf56319abb58792a3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Nov 2023 12:40:34 -0700 Subject: [PATCH 0869/1753] Fix VSTHRD003 false positive around implicitly typed object creation expressions --- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 2 +- .../Helpers/CSharpCodeFixVerifier`2+Test.cs | 2 +- .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 23 +++++++++++++++++++ 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 884881890..76655d528 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -201,7 +201,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) // Search for assignments to the local and see if it was to a new object. containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); if (containingFunc.Value.BlockOrExpression is not null && - CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any(v => v is ObjectCreationExpressionSyntax)) + CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any(v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax)) { return null; } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs index 298425a59..18ae7d018 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs @@ -73,7 +73,7 @@ where resourceName.StartsWith(additionalFilePrefix, StringComparison.Ordinal) protected override ParseOptions CreateParseOptions() { - return ((CSharpParseOptions)base.CreateParseOptions()).WithLanguageVersion(LanguageVersion.CSharp8); + return ((CSharpParseOptions)base.CreateParseOptions()).WithLanguageVersion(LanguageVersion.CSharp11); } private static string ReadManifestResource(Assembly assembly, string resourceName) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 1003c7c24..d1f7f0047 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1310,6 +1310,29 @@ static async Task GetTask() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskPropertyOfObjectCreatedInContext_TargetTypeCreation() + { + string test = """ + using System.Threading.Tasks; + + class Test + { + static Task Exec2Async(string executable, params string[] args) + { + Process p = new(); + return p.Task; + } + } + + class Process + { + public Task Task { get; } + } + """; + await CSVerify.VerifyAnalyzerAsync(test); + } + /// /// This is important to allow folks to return jtf.RunAsync(...).Task from a method. /// From 8fae01d6279c93633e36c759108780a635e0159b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Nov 2023 12:47:11 -0700 Subject: [PATCH 0870/1753] Avoid VSTHRD003 analyzer diagnostic when accessing property on an object returned from an invocation We assume that the method is returning something fresh, such that the accessed Task belongs to the caller's context. --- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 5 ++-- .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 25 +++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 76655d528..83c05e30d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -198,10 +198,11 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) if (memberAccessExpression.Expression is IdentifierNameSyntax identifier && semanticModel.GetSymbolInfo(identifier, cancellationToken).Symbol is ILocalSymbol local) { - // Search for assignments to the local and see if it was to a new object. + // Search for assignments to the local and see if it was to a new object or the result of an invocation. containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); if (containingFunc.Value.BlockOrExpression is not null && - CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any(v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax)) + CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any( + v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax or InvocationExpressionSyntax)) { return null; } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index d1f7f0047..7fe0bf1dc 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1357,6 +1357,31 @@ static async Task GetTask() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskPropertyOfObjectReturnedFromMethodViaLocal() + { + var test = """ + using System.Threading.Tasks; + + class JsonRpc + { + internal static JsonRpc Attach() => throw new System.NotImplementedException(); + + internal Task Completion { get; } + } + + class Tests + { + static async Task ListenAndWait() + { + var jsonRpc = JsonRpc.Attach(); + await jsonRpc.Completion; + } + } + """; + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task ReportWarningWhenAwaitingTaskPropertyThatWasNotSetInContext() { From 350dc7f180212132c339127c2bc251b783dae00c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Nov 2023 13:09:45 -0700 Subject: [PATCH 0871/1753] VSTHRD003 to allow returning foreign tasks from lambda expressions --- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 30 ++++++++++++++----- .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 26 ++++++++++++++++ 2 files changed, 48 insertions(+), 8 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 83c05e30d..897fde8fa 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -195,16 +195,30 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) } // Do not report a warning if the task is a member of an object that was created in this method. - if (memberAccessExpression.Expression is IdentifierNameSyntax identifier && - semanticModel.GetSymbolInfo(identifier, cancellationToken).Symbol is ILocalSymbol local) + if (memberAccessExpression.Expression is IdentifierNameSyntax identifier) { - // Search for assignments to the local and see if it was to a new object or the result of an invocation. - containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); - if (containingFunc.Value.BlockOrExpression is not null && - CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any( - v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax or InvocationExpressionSyntax)) + ISymbol? symbol = semanticModel.GetSymbolInfo(identifier, cancellationToken).Symbol; + switch (symbol) { - return null; + case ILocalSymbol local: + // Search for assignments to the local and see if it was to a new object or the result of an invocation. + containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); + if (containingFunc.Value.BlockOrExpression is not null && + CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any( + v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax or InvocationExpressionSyntax)) + { + return null; + } + + break; + case IParameterSymbol parameter: + // We allow returning members of a parameter in a lambda, to support `.Select(x => x.Completion)` syntax. + if (parameter.ContainingSymbol is IMethodSymbol method && method.MethodKind == MethodKind.AnonymousFunction) + { + return null; + } + + break; } } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 7fe0bf1dc..4a410ae02 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1402,6 +1402,32 @@ async Task GetTask() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotReportWarningWhenReturningTaskFromLambdaArgument() + { + var test = """ + using System.Linq; + using System.Threading.Tasks; + + class JsonRpc + { + internal static JsonRpc Attach() => throw new System.NotImplementedException(); + + internal Task Completion { get; } + } + + class Tests + { + static async Task ListenAndWait() + { + JsonRpc[] rpcs = new [] { JsonRpc.Attach(), JsonRpc.Attach() }; + await Task.WhenAll(rpcs.Select(r => r.Completion)); + } + } + """; + await CSVerify.VerifyAnalyzerAsync(test); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length) => CSVerify.Diagnostic().WithSpan(line, column, line, column + length); } From c81ceff2c3da4b0fc97670ea9be50f3c33314497 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 10:56:23 +0000 Subject: [PATCH 0872/1753] Bump MicrosoftDiagnosticsRuntimeVersion from 2.4.416101 to 3.1.456501 Bumps `MicrosoftDiagnosticsRuntimeVersion` from 2.4.416101 to 3.1.456501. Updates `Microsoft.Diagnostics.Runtime.Utilities` from 2.4.416101 to 3.1.456501 Updates `Microsoft.Diagnostics.Runtime` from 2.4.416101 to 3.1.456501 --- updated-dependencies: - dependency-name: Microsoft.Diagnostics.Runtime.Utilities dependency-type: direct:production update-type: version-update:semver-major - dependency-name: Microsoft.Diagnostics.Runtime dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 4749e3b87..a3bfa007d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ 3.11.0 4.4.0 1.1.1 - 2.4.416101 + 3.1.456501 From d1ffce8a4b3a570dc97532af7cb7d6cf47ccc82d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 12:36:51 -0700 Subject: [PATCH 0873/1753] Bump xunit from 2.6.1 to 2.6.2 (#234) Bumps [xunit](https://github.com/xunit/xunit) from 2.6.1 to 2.6.2. - [Commits](https://github.com/xunit/xunit/compare/2.6.1...2.6.2) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index faa3fc68b..272353bff 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From ccd2c89fa9aa2e2e991cd15f16827bcbe654fc10 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 12:37:45 -0700 Subject: [PATCH 0874/1753] Bump Microsoft.SourceLink.GitHub from 1.1.1 to 8.0.0 (#232) Bumps [Microsoft.SourceLink.GitHub](https://github.com/dotnet/sourcelink) from 1.1.1 to 8.0.0. - [Release notes](https://github.com/dotnet/sourcelink/releases) - [Commits](https://github.com/dotnet/sourcelink/compare/1.1.1...8.0.0) --- updated-dependencies: - dependency-name: Microsoft.SourceLink.GitHub dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 272353bff..9ac2f3710 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -17,6 +17,6 @@ - + From 42894612a6492693491c9a91b3e314d8f10658e8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 12:37:58 -0700 Subject: [PATCH 0875/1753] Bump powershell from 7.3.9 to 7.4.0 (#231) Bumps [powershell](https://github.com/PowerShell/PowerShell) from 7.3.9 to 7.4.0. - [Release notes](https://github.com/PowerShell/PowerShell/releases) - [Commits](https://github.com/PowerShell/PowerShell/compare/v7.3.9...v7.4.0) --- updated-dependencies: - dependency-name: powershell dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index de46e939b..7a4b9444e 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.3.9", + "version": "7.4.0", "commands": [ "pwsh" ] From 7e872d33dbd08fce619141103e8c8c7bcf7cd966 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 19:43:19 +0000 Subject: [PATCH 0876/1753] Bump xunit.runner.visualstudio from 2.5.3 to 2.5.4 (#233) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 9ac2f3710..3ad9b7937 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ - + From 73f5441fe87e50b70653635a0094dc80c5af652c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Nov 2023 12:41:11 -0700 Subject: [PATCH 0877/1753] Avoid VSTHRD003 diagnostic for properties on objects created by async methods We already avoided such cases when the creating method was synchronous, but we missed the async case. This came up when trying to update the analyzers version used by the VS repo. --- .../VSTHRD003UseJtfRunAsyncAnalyzer.cs | 2 +- .../VSTHRD003UseJtfRunAsyncAnalyzerTests.cs | 25 +++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs index 897fde8fa..19864c651 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD003UseJtfRunAsyncAnalyzer.cs @@ -205,7 +205,7 @@ private void AnalyzeAwaitExpression(SyntaxNodeAnalysisContext context) containingFunc ??= CSharpUtils.GetContainingFunction(focusedExpression); if (containingFunc.Value.BlockOrExpression is not null && CSharpUtils.FindAssignedValuesWithin(containingFunc.Value.BlockOrExpression, semanticModel, local, cancellationToken).Any( - v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax or InvocationExpressionSyntax)) + v => v is ObjectCreationExpressionSyntax or ImplicitObjectCreationExpressionSyntax or InvocationExpressionSyntax or AwaitExpressionSyntax { Expression: InvocationExpressionSyntax })) { return null; } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs index 4a410ae02..ce64483d5 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD003UseJtfRunAsyncAnalyzerTests.cs @@ -1382,6 +1382,31 @@ static async Task ListenAndWait() await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotReportWarningWhenAwaitingTaskPropertyOfObjectReturnedFromAsyncMethodViaLocal() + { + var test = """ + using System.Threading.Tasks; + + class JsonRpc + { + internal static Task AttachAsync() => throw new System.NotImplementedException(); + + internal Task Completion { get; } + } + + class Tests + { + static async Task ListenAndWait() + { + var jsonRpc = await JsonRpc.AttachAsync(); + await jsonRpc.Completion; + } + } + """; + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task ReportWarningWhenAwaitingTaskPropertyThatWasNotSetInContext() { From 5da8083e9f0a5f79f906d27e8d8dda3386f02bb1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Nov 2023 11:58:24 -0700 Subject: [PATCH 0878/1753] Validate formatted code in builds --- azure-pipelines/build.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 9c445f727..5d1835d56 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -36,6 +36,8 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} + - script: dotnet format --verify-no-changes --no-restore + displayName: 💅 Verify formatted code - template: expand-template.yml - job: macOS From c4890509d2ef60e24bbed0ec213882bcead28848 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Nov 2023 13:42:32 -0700 Subject: [PATCH 0879/1753] Enable auto-format on save in VS and VS Code --- .vscode/settings.json | 3 ++- settings.VisualStudio.json | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 settings.VisualStudio.json diff --git a/.vscode/settings.json b/.vscode/settings.json index 54c5c6896..5101737c1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,5 +4,6 @@ "files.trimFinalNewlines": true, "omnisharp.enableEditorConfigSupport": true, "omnisharp.enableRoslynAnalyzers": true, - "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true + "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true, + "editor.formatOnSave": true } diff --git a/settings.VisualStudio.json b/settings.VisualStudio.json new file mode 100644 index 000000000..7abb4a060 --- /dev/null +++ b/settings.VisualStudio.json @@ -0,0 +1,3 @@ +{ + "textEditor.codeCleanup.profile": "profile1" +} From 41f6d2704083294ec0338f68e2bc54f461177c58 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Nov 2023 14:37:47 -0700 Subject: [PATCH 0880/1753] Remove `dotnet-format` as a tool It's part of the SDK now, and the version on nuget.org is no longer maintained. --- .config/dotnet-tools.json | 8 +------- .github/dependabot.yml | 4 ---- 2 files changed, 1 insertion(+), 11 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 7a4b9444e..0e4a78462 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -8,12 +8,6 @@ "pwsh" ] }, - "dotnet-format": { - "version": "5.1.250801", - "commands": [ - "dotnet-format" - ] - }, "dotnet-coverage": { "version": "17.9.3", "commands": [ @@ -27,4 +21,4 @@ ] } } -} +} \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 9053ac863..63e3e890b 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,7 +7,3 @@ updates: directory: / schedule: interval: weekly - ignore: - # This package has unlisted versions on nuget.org that are not supported. Avoid them. - - dependency-name: dotnet-format - versions: ["6.x", "7.x", "8.x", "9.x"] From eb605ed639a2a753dc562fa866565b7433debca6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 28 Nov 2023 11:21:22 -0700 Subject: [PATCH 0881/1753] Insert into rel/d17.2 --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..49d6dadfb 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.2' From ac3f1dff5d485d6e8c56998c87bb3665f0d4bbf9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 29 Nov 2023 07:09:14 -0700 Subject: [PATCH 0882/1753] Make symbolic link failures more detectable --- azure-pipelines/artifacts/_stage_all.ps1 | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index d81d16d46..b077931cc 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -30,6 +30,12 @@ function Create-SymbolicLink { } else { cmd /c "mklink `"$Link`" `"$Target`"" | Out-Null } + + if ($LASTEXITCODE -ne 0) { + # Windows requires admin privileges to create symbolic links + # unless Developer Mode has been enabled. + throw "Failed to create symbolic link at $Link that points to $Target" + } } # Stage all artifacts From 44669275d39315b5177b6b1c5b0d6ff4a70ea613 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 29 Nov 2023 13:25:39 -0700 Subject: [PATCH 0883/1753] Fix v17.2 optprof's inclusion of the `VSInsertionMetadata` package --- azure-pipelines/artifacts/VSInsertion.ps1 | 37 ++++++++++++++----- .../variables/InsertConfigValues.ps1 | 7 ++-- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 0e848f3c2..b3b4661b6 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -1,20 +1,33 @@ # This artifact captures everything needed to insert into VS (NuGet packages, insertion metadata, etc.) +<# +.PARAMETER SbomNotRequired + Indicates that returning the artifacts available is preferable to nothing at all when the SBOM has not yet been generated. +#> +[CmdletBinding()] +Param ( + [switch]$SbomNotRequired +) + if ($IsMacOS -or $IsLinux) { # We only package up for insertions on Windows agents since they are where optprof can happen. - Write-Verbose "Skipping VSInsertion artifact since we're not on Windows" + Write-Verbose "Skipping VSInsertion artifact since we're not on Windows." return @{} } $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") -$config = 'Debug' -if ($env:BUILDCONFIGURATION) { $config = $env:BUILDCONFIGURATION } -$NuGetPackages = "$RepoRoot\bin\Packages\$config\NuGet" -$CoreXTPackages = "$RepoRoot\bin\Packages\$config\CoreXT" -if (-not (Test-Path $NuGetPackages)) { Write-Warning "No NuGet packages found. Has a build been run?"; return @{} } +$BuildConfiguration = $env:BUILDCONFIGURATION +if (!$BuildConfiguration) { + $BuildConfiguration = 'Debug' +} -# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $NuGetPackages/_manifest)) { return @{} } +$NuGetPackages = "$RepoRoot\bin\Packages\$BuildConfiguration\NuGet" +$CoreXTPackages = "$RepoRoot\bin\Packages\$BuildConfiguration\CoreXT" + +if (!(Test-Path $NuGetPackages)) { + Write-Warning "Skipping because NuGet packages haven't been built yet." + return @{} +} $ArtifactBasePath = "$RepoRoot\obj\_artifacts" $ArtifactPath = "$ArtifactBasePath\VSInsertion" @@ -39,7 +52,13 @@ if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } +# This artifact is not ready if we're running on the devdiv AzDO account and we don't have an SBOM yet. +if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9' -and -not (Test-Path $NuGetPackages/_manifest) -and -not $SbomNotRequired) { + Write-Host "Skipping because SBOM isn't generated yet." + return @{} +} + @{ - "$NuGetPackages" = (Get-ChildItem -Recurse $NuGetPackages); + "$NuGetPackages" = (Get-ChildItem $NuGetPackages -Recurse) "$CoreXTPackages" = (Get-ChildItem "$CoreXTPackages\Microsoft.VisualStudio.Threading.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); } diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index a8aafb460..1ab53f34e 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -1,9 +1,8 @@ -$BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin\Packages\$env:BUILDCONFIGURATION") +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1" -SbomNotRequired) -$dirsToSearch = "$BinPath\NuGet\*.nupkg","$BinPath\CoreXT\*.nupkg" |? { Test-Path $_ } $icv=@() -if ($dirsToSearch) { - Get-ChildItem -Path $dirsToSearch |% { +foreach ($kvp in $InsertedPkgs.GetEnumerator()) { + $kvp.Value |% { if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { $id = $Matches[1] $version = $Matches[2] From d0e3bf5b2a3af31b97b7013bd10cb7ebc065db61 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Nov 2023 11:54:14 -0700 Subject: [PATCH 0884/1753] Update TeamName comment --- azure-pipelines/variables/TeamName.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/TeamName.ps1 b/azure-pipelines/variables/TeamName.ps1 index 5f2822c50..ba9c82310 100644 --- a/azure-pipelines/variables/TeamName.ps1 +++ b/azure-pipelines/variables/TeamName.ps1 @@ -1,2 +1,2 @@ -# This value is used to craft a \\cpvsbuild\drops path for symbol archival. +# This value is used as an input to the MicroBuild Insert VS task. 'VS IDE' From 41771506014fc409c68858d14c2e061d4c2de665 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Nov 2023 11:56:35 -0700 Subject: [PATCH 0885/1753] Add xml header to msbuild files MSBuild doesn't need them, but Azure Repos won't recognize .targets and .props files as xml files without it. And recognizing them means syntax coloring, which is worthwhile. --- Directory.Build.props | 1 + Directory.Build.targets | 1 + Directory.Packages.props | 1 + src/Directory.Build.props | 1 + src/Directory.Build.targets | 1 + test/Directory.Build.props | 1 + test/Directory.Build.targets | 1 + 7 files changed, 7 insertions(+) diff --git a/Directory.Build.props b/Directory.Build.props index d3edacc82..e42ac60a6 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,3 +1,4 @@ + Debug diff --git a/Directory.Build.targets b/Directory.Build.targets index ea7b6e6f8..cc8184aac 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -1,3 +1,4 @@ + diff --git a/Directory.Packages.props b/Directory.Packages.props index 3ad9b7937..6cf06aef4 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -1,3 +1,4 @@ + diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 5e648d5ee..9ba7818d4 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,3 +1,4 @@ + diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index c1d929a5b..07f413461 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,3 +1,4 @@ + diff --git a/test/Directory.Build.props b/test/Directory.Build.props index ad4a4b6c5..6c7aa71dc 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -1,3 +1,4 @@ + diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index 052fe3ef0..a6e0f4ace 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,3 +1,4 @@ + From 140a33b14a9c0846c28974745ad70d9d4dbdac75 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Nov 2023 15:42:28 -0700 Subject: [PATCH 0886/1753] Update Microsoft.SourceLink.AzureRepos.Git to 8.0.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index da5ca7c6e..a7a2c0374 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -21,7 +21,7 @@ - + From db4440205ad8c7adac61bea7aea42a63496599d7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 1 Dec 2023 12:28:16 -0700 Subject: [PATCH 0887/1753] Stop VS Code from wrapping xml files --- .vscode/settings.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 5101737c1..ce72437ca 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,5 +5,8 @@ "omnisharp.enableEditorConfigSupport": true, "omnisharp.enableRoslynAnalyzers": true, "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true, - "editor.formatOnSave": true + "editor.formatOnSave": true, + "[xml]": { + "editor.wordWrap": "off" + } } From b12fd05f458f559442e083da53cab71570c847e5 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Wed, 6 Dec 2023 14:31:44 -0800 Subject: [PATCH 0888/1753] Build 17.9 stable version (#1264) --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index 4c605c5cd..b98347691 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.9-alpha", + "version": "17.9", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From c011c77aa30dde13d94ddb137e5f04e5f186debf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 8 Dec 2023 13:49:28 -0700 Subject: [PATCH 0889/1753] Fix symbol archival in servicing branches --- azure-pipelines/official.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index f49cf5301..25cfc6751 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -81,14 +81,13 @@ stages: - download: current artifact: symbols-Windows displayName: Download symbols-Windows artifact - - task: MicroBuildArchiveSymbols@1 - displayName: Archive symbols to Symweb + - task: MicroBuildArchiveSymbols@4 + displayName: 🔣 Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) - SymbolsSymwebProject: VS - SymbolsUncPath: \\cpvsbuild\drops\$(TeamName)\$(Build.DefinitionName)\$(Build.SourceBranchName)\$(Build.BuildId)\Symbols.Archival - SymbolsEmailContacts: vsidemicrobuild + SymbolsProject: VS SymbolsAgentPath: $(Pipeline.Workspace)/symbols-Windows + azureSubscription: Symbols Upload (DevDiv) - task: MicroBuildCleanup@1 displayName: Send Telemetry From 3a5c8f0ee6540b10f7c58f6489bd0b3ca286c6b2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Dec 2023 13:19:20 -0700 Subject: [PATCH 0890/1753] Add dotnet_separate_import_directive_groups to .editorconfig This is the default setting in VS, but folks who have changed the setting can cause noise in PRs unless we pin the setting at the repo level. --- .editorconfig | 1 + 1 file changed, 1 insertion(+) diff --git a/.editorconfig b/.editorconfig index 959801c2e..ffae180a8 100644 --- a/.editorconfig +++ b/.editorconfig @@ -40,6 +40,7 @@ indent_size = 4 [*.{cs,vb}] # Sort using and Import directives with System.* appearing first dotnet_sort_system_directives_first = true +dotnet_separate_import_directive_groups = false dotnet_style_qualification_for_field = true:warning dotnet_style_qualification_for_property = true:warning dotnet_style_qualification_for_method = true:warning From f8f3f9e2501d480a8d313c2e36bdd978c4191813 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:12:47 -0700 Subject: [PATCH 0891/1753] Bump xunit from 2.6.2 to 2.6.3 (#239) Bumps [xunit](https://github.com/xunit/xunit) from 2.6.2 to 2.6.3. - [Commits](https://github.com/xunit/xunit/compare/2.6.2...2.6.3) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6cf06aef4..041ea3d1e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ - + From 20c7541a3ca7b7cd4c7fa30335be69e31b1d41a8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:13:10 -0700 Subject: [PATCH 0892/1753] Bump dotnet-coverage from 17.9.3 to 17.9.5 (#238) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.9.3 to 17.9.5. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 0e4a78462..c08307f6e 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.9.3", + "version": "17.9.5", "commands": [ "dotnet-coverage" ] From 37705a891a10e45737c3c8d4fb8708141738ec1b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 12 Dec 2023 00:20:18 +0000 Subject: [PATCH 0893/1753] Bump xunit.runner.visualstudio from 2.5.4 to 2.5.5 (#237) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 041ea3d1e..4cf7998db 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 580044b1fd288cb638d855bfc0c9a2fde0fdd10b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Dec 2023 17:45:21 -0700 Subject: [PATCH 0894/1753] Use precise assembly version for analyzers project This removes an MSBuild property that makes version calculating happen only once per build, under the (incorrect) assumption that only one version.json file exists in this repo. But the analyzers project has a unique one, and this msbuild property was causing that to be ignored. --- Directory.Build.props | 3 --- 1 file changed, 3 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index cdb9a747a..c0885cc21 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -13,9 +13,6 @@ true true - - $(MSBuildThisFileDirectory) - embedded From 093d182c256209bdb38a11b6832d32f4b9dc0cca Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Dec 2023 17:39:44 -0700 Subject: [PATCH 0895/1753] Add `AsyncLazy.SuppressRecursiveFactoryDetection` property This allows folks to opt-out of the recursive detection altogether, such that `AsyncLazy.SuppressRelevance()` isn't required (though that call would still carry out the JTF suppression function). --- .../AsyncLazy`1.cs | 51 +++++++-- .../net472/PublicAPI.Unshipped.txt | 2 + .../net6.0-windows/PublicAPI.Unshipped.txt | 2 + .../net6.0/PublicAPI.Unshipped.txt | 2 + .../netstandard2.0/PublicAPI.Unshipped.txt | 2 + .../AsyncLazyTests.cs | 102 ++++++++++++++++++ 6 files changed, 154 insertions(+), 7 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 630bc2b6f..50eedf93e 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -38,7 +38,7 @@ public class AsyncLazy /// /// The unique instance identifier. /// - private readonly AsyncLocal recursiveFactoryCheck = new AsyncLocal(); + private AsyncLocal? recursiveFactoryCheck; /// /// The function to invoke to produce the task. @@ -72,6 +72,31 @@ public AsyncLazy(Func> valueFactory, JoinableTaskFactory? joinableTaskFa this.jobFactory = joinableTaskFactory; } + /// + /// Gets a value indicating whether to suppress detection of a value factory depending on itself. + /// + /// The default value is . + /// + /// + /// A value factory that truly depends on itself (e.g. by calling on the same instance) + /// would deadlock, and by default this class will throw an exception if it detects such a condition. + /// However this detection relies on the .NET ExecutionContext, which can flow to "spin off" contexts that are not awaited + /// by the factory, and thus could legally await the result of the value factory without deadlocking. + /// + /// + /// When this flows improperly, it can cause to be thrown, but only when the value factory + /// has not already been completed, leading to a difficult to reproduce race condition. + /// Such a case can be resolved by calling around the non-awaited fork in , + /// or the entire instance can be configured to suppress this check by setting this property to . + /// + /// + /// When this property is set to , the recursive factory check will not be performed, + /// but will still call into + /// if a was provided to the constructor. + /// + /// + public bool SuppressRecursiveFactoryDetection { get; init; } + /// /// Gets a value indicating whether the value factory has been invoked. /// @@ -137,7 +162,7 @@ public bool IsValueFactoryCompleted /// Thrown after is called. public Task GetValueAsync(CancellationToken cancellationToken) { - if (!((this.value is object && this.value.IsCompleted) || this.recursiveFactoryCheck.Value is null)) + if (this.value is not { IsCompleted: true } && this.recursiveFactoryCheck is { Value: not null }) { // PERF: we check the condition and *then* retrieve the string resource only on failure // because the string retrieval has shown up as significant on ETL traces. @@ -183,7 +208,12 @@ public Task GetValueAsync(CancellationToken cancellationToken) } }; - this.recursiveFactoryCheck.Value = RecursiveCheckSentinel; + if (!this.SuppressRecursiveFactoryDetection) + { + Assumes.Null(this.recursiveFactoryCheck); + this.recursiveFactoryCheck = new AsyncLocal() { Value = RecursiveCheckSentinel }; + } + try { if (this.jobFactory is object) @@ -201,7 +231,10 @@ public Task GetValueAsync(CancellationToken cancellationToken) } finally { - this.recursiveFactoryCheck.Value = null; + if (this.recursiveFactoryCheck is not null) + { + this.recursiveFactoryCheck.Value = null; + } } } } @@ -451,7 +484,11 @@ internal RevertRelevance(AsyncLazy owner) Requires.NotNull(owner, nameof(owner)); this.owner = owner; - (this.oldCheckValue, owner.recursiveFactoryCheck.Value) = (owner.recursiveFactoryCheck.Value, null); + if (owner.recursiveFactoryCheck is not null) + { + (this.oldCheckValue, owner.recursiveFactoryCheck.Value) = (owner.recursiveFactoryCheck.Value, null); + } + this.joinableRelevance = owner.jobFactory?.Context.SuppressRelevance(); } @@ -460,9 +497,9 @@ internal RevertRelevance(AsyncLazy owner) /// public void Dispose() { - if (this.owner is object) + if (this.owner?.recursiveFactoryCheck is { } check) { - this.owner.recursiveFactoryCheck.Value = this.oldCheckValue; + check.Value = this.oldCheckValue; } this.joinableRelevance?.Dispose(); diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 1a9888196..e099d0429 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -13,4 +13,6 @@ Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Thre Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index 1a9888196..e099d0429 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -13,4 +13,6 @@ Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Thre Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index 1a9888196..e099d0429 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -13,4 +13,6 @@ Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Thre Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 1a9888196..e099d0429 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -13,4 +13,6 @@ Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Thre Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 2077d81c3..5fac9f95c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -6,10 +6,13 @@ using System.Runtime.CompilerServices; using System.Threading; using System.Threading.Tasks; + using Microsoft; using Microsoft.VisualStudio.Threading; + using Xunit; using Xunit.Abstractions; + using NamedSyncContext = AwaitExtensionsTests.NamedSyncContext; public class AsyncLazyTests : TestBase @@ -748,6 +751,105 @@ async Task FireAndForgetCodeAsync() } } + [Fact] + public async Task SuppressRecursiveFactoryDetection_WithoutJTF() + { + AsyncManualResetEvent allowValueFactoryToFinish = new(); + Task? fireAndForgetTask = null; + AsyncLazy asyncLazy = null!; + asyncLazy = new AsyncLazy( + async delegate + { + fireAndForgetTask = FireAndForgetCodeAsync(); + await allowValueFactoryToFinish; + return 1; + }, + null) + { + SuppressRecursiveFactoryDetection = true, + }; + + bool fireAndForgetCodeAsyncEntered = false; + Task lazyValue = asyncLazy.GetValueAsync(); + Assert.True(fireAndForgetCodeAsyncEntered); + allowValueFactoryToFinish.Set(); + + // Assert that the value factory was allowed to finish. + Assert.Equal(1, await lazyValue.WithCancellation(this.TimeoutToken)); + + // Assert that the fire-and-forget task was allowed to finish and did so without throwing. + Assert.Equal(1, await fireAndForgetTask!.WithCancellation(this.TimeoutToken)); + + async Task FireAndForgetCodeAsync() + { + fireAndForgetCodeAsyncEntered = true; + return await asyncLazy.GetValueAsync(); + } + } + + [Theory, PairwiseData] + public async Task SuppressRecursiveFactoryDetection_WithJTF(bool suppressWithJTF) + { + JoinableTaskContext? context = this.InitializeJTCAndSC(); + SingleThreadedTestSynchronizationContext.IFrame frame = SingleThreadedTestSynchronizationContext.NewFrame(); + + JoinableTaskFactory? jtf = context.Factory; + AsyncManualResetEvent allowValueFactoryToFinish = new(); + Task? fireAndForgetTask = null; + AsyncLazy asyncLazy = null!; + asyncLazy = new AsyncLazy( + async delegate + { + using (suppressWithJTF ? jtf.Context.SuppressRelevance() : default) + using (suppressWithJTF ? default : asyncLazy.SuppressRelevance()) + { + fireAndForgetTask = FireAndForgetCodeAsync(); + } + + await allowValueFactoryToFinish; + return 1; + }, + jtf) + { + SuppressRecursiveFactoryDetection = true, + }; + + bool fireAndForgetCodeAsyncEntered = false; + bool fireAndForgetCodeAsyncReachedUIThread = false; + jtf.Run(async delegate + { + Task lazyValue = asyncLazy.GetValueAsync(); + Assert.True(fireAndForgetCodeAsyncEntered); + await Task.Delay(AsyncDelay); + Assert.False(fireAndForgetCodeAsyncReachedUIThread); + allowValueFactoryToFinish.Set(); + + // Assert that the value factory was allowed to finish. + Assert.Equal(1, await lazyValue.WithCancellation(this.TimeoutToken)); + }); + + // Run a main thread pump so the fire-and-forget task can finish. + SingleThreadedTestSynchronizationContext.PushFrame(SynchronizationContext.Current!, frame); + + // Assert that the fire-and-forget task was allowed to finish and did so without throwing. + Assert.Equal(1, await fireAndForgetTask!.WithCancellation(this.TimeoutToken)); + + async Task FireAndForgetCodeAsync() + { + fireAndForgetCodeAsyncEntered = true; + + // Yield the caller's thread. + // Resuming will require the main thread, since the caller was on the main thread. + await Task.Yield(); + + fireAndForgetCodeAsyncReachedUIThread = true; + + int result = await asyncLazy.GetValueAsync(); + frame.Continue = false; + return result; + } + } + [Fact] public async Task Dispose_ValueType_Completed() { From 5af59eca86c56ea86c6027d2231bdf6d1c867ffe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Dec 2023 18:31:07 -0700 Subject: [PATCH 0896/1753] Include SBOM in nuget packages --- Directory.Build.targets | 2 ++ azure-pipelines/NuGetSbom.targets | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 azure-pipelines/NuGetSbom.targets diff --git a/Directory.Build.targets b/Directory.Build.targets index cc8184aac..4549a848c 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -9,4 +9,6 @@ + + diff --git a/azure-pipelines/NuGetSbom.targets b/azure-pipelines/NuGetSbom.targets new file mode 100644 index 000000000..a2599e882 --- /dev/null +++ b/azure-pipelines/NuGetSbom.targets @@ -0,0 +1,12 @@ + + + true + $(TargetsForTfmSpecificBuildOutput);IncludeSbomInNupkg + + + + + + + + From 4b35644de258b6b4de47d1c9de86a69d0bcb0d3f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 12 Dec 2023 18:32:49 -0700 Subject: [PATCH 0897/1753] Fix `Install-NuGetPackage` exit code check Somehow, there is a race condition where the exit code can be null then transition to 0 later. This caused the script to inappropriately fail by throwing, aborting installation of microbuild plugins. --- azure-pipelines/Install-NuGetPackage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/azure-pipelines/Install-NuGetPackage.ps1 index cdac73085..9afde0550 100644 --- a/azure-pipelines/Install-NuGetPackage.ps1 +++ b/azure-pipelines/Install-NuGetPackage.ps1 @@ -45,7 +45,7 @@ try { if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru - if ($p.ExitCode -ne 0) { throw } + if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw } } # Provide the path to the installed package directory to our caller. From c3e46493fe2de84ece6d1fb0ffd1749ef7ca3a3b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 18 Dec 2023 06:47:41 -0700 Subject: [PATCH 0898/1753] Bump dotnet-coverage from 17.9.5 to 17.9.6 (#240) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.9.5 to 17.9.6. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index c08307f6e..b46731160 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.9.5", + "version": "17.9.6", "commands": [ "dotnet-coverage" ] From 9198063d425cd079e19d2f0d2bf523de3cbb343d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 26 Dec 2023 08:01:46 -0700 Subject: [PATCH 0899/1753] Bump xunit.runner.visualstudio from 2.5.5 to 2.5.6 (#243) Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.5.5 to 2.5.6. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/compare/2.5.5...2.5.6) --- updated-dependencies: - dependency-name: xunit.runner.visualstudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 4cf7998db..1d02ad280 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From cd53181413c400fa42418b25329764d69ffc758c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 26 Dec 2023 15:08:21 +0000 Subject: [PATCH 0900/1753] Bump xunit from 2.6.3 to 2.6.4 (#242) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1d02ad280..50ea3701b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ - + From b9d62f310b3bcc9d0397a39d64049bc046e63f6c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 26 Dec 2023 11:16:41 -0700 Subject: [PATCH 0901/1753] Bump StyleCop.Analyzers.Unstable from 1.2.0.507 to 1.2.0.556 (#241) Bumps [StyleCop.Analyzers.Unstable](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) from 1.2.0.507 to 1.2.0.556. - [Release notes](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/releases) - [Changelog](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/KnownChanges.md) - [Commits](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commits) --- updated-dependencies: - dependency-name: StyleCop.Analyzers.Unstable dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 50ea3701b..41167d99a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -15,7 +15,7 @@ - + From b93f09b6a859349ee74c46354959c20947624768 Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Wed, 3 Jan 2024 21:09:04 +0100 Subject: [PATCH 0902/1753] Don't package reference inbox assemblies on .NETCoreApp Microsoft.Win32.Registry got added to the .NETCoreApp shared framework with .NET 5. System.Threading.Tasks.Extensions has been part of the shared framework since I believe .NET Core 2.0. Microsoft.Bcl.AsyncInterfaces since .NET Core 2.1. Don't reference these packages on .NETCoreApp to reduce the dependency graph and with that potential CVEs / CG warnings. --- .../Microsoft.VisualStudio.Threading.csproj | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 90241afe6..52c354523 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -42,10 +42,10 @@ - - + + - + From b95befe84eee9701332c156610c1d028c784fc9b Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Wed, 3 Jan 2024 20:16:54 +0000 Subject: [PATCH 0903/1753] two additional projects --- .../Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj | 2 -- .../Microsoft.VisualStudio.Threading.Analyzers.csproj | 2 -- 2 files changed, 4 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj index 4ed0a0aa6..a58ca1295 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj @@ -35,8 +35,6 @@ - - diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj index 4c8ac6123..35281001e 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj @@ -25,7 +25,5 @@ - - From eee012a4e15a17071df2e242f128a4c1c23e2b65 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Jan 2024 10:03:27 -0700 Subject: [PATCH 0904/1753] Insert 17.9 into servicing branch in VS --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..34932a739 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.9' From 75415b915ae46f659e25592ed4680eb5717fd8c2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Jan 2024 10:04:03 -0700 Subject: [PATCH 0905/1753] Build 17.10-preview --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- version.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index 34932a739..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.9' +'main' diff --git a/version.json b/version.json index b98347691..dcb7e71d6 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.9", + "version": "17.10-preview", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 248800d80bd96641c6b2369e03be0f9c1705c2d6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Sep 2023 10:51:27 +0000 Subject: [PATCH 0906/1753] Bump Xunit.Combinatorial from 1.5.25 to 1.6.24 Bumps Xunit.Combinatorial from 1.5.25 to 1.6.24. --- updated-dependencies: - dependency-name: Xunit.Combinatorial dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index f1d7a495e..d5c9fcca1 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -43,7 +43,7 @@ - + From 67fed581559f70d108fc166a99c61728c0f4b768 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 10:56:31 +0000 Subject: [PATCH 0907/1753] Bump System.Drawing.Common from 7.0.0 to 8.0.0 Bumps System.Drawing.Common from 7.0.0 to 8.0.0. --- updated-dependencies: - dependency-name: System.Drawing.Common dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d5c9fcca1..8484a0e91 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -35,7 +35,7 @@ - + From efdee0b1349ce980deedd8d7ca130e8258d1486d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Jan 2024 11:02:23 -0700 Subject: [PATCH 0908/1753] Fix up build breaks after dependency upgrade --- src/SosThreadingTools/DumpAsyncCommand.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index e4c2531e8..9aedaf999 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -362,7 +362,7 @@ private void MarkThreadingBlockTasks(List allStateMachines) if (stackFrame is object) { var visitedObjects = new HashSet(); - foreach (IClrStackRoot stackRoot in thread.EnumerateStackRoots()) + foreach (ClrStackRoot stackRoot in thread.EnumerateStackRoots()) { ClrObject stackObject = stackRoot.Object; if (string.Equals(stackObject.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || @@ -370,7 +370,7 @@ private void MarkThreadingBlockTasks(List allStateMachines) { if (visitedObjects.Add(stackObject.Address)) { - var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); + ClrObject joinableTaskObject = stackObject.Type is null ? runtime.Heap.GetObject(stackObject.Address) : runtime.Heap.GetObject(stackObject.Address, stackObject.Type); int state = joinableTaskObject.ReadField("state"); if ((state & 0x10) == 0x10) { From 4f0613b131ba27470b14ac346086bae7b354a14c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Jan 2024 15:53:53 -0700 Subject: [PATCH 0909/1753] Update dumpasync.md doc --- doc/dumpasync.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/dumpasync.md b/doc/dumpasync.md index 7fbb0e30a..c7693131f 100644 --- a/doc/dumpasync.md +++ b/doc/dumpasync.md @@ -8,7 +8,8 @@ for an app hang that is waiting for async methods to complete. Using this tool requires that you download and install [WinDbg][WinDbg], which can attach to a running process or DMP file. The `!dumpasync` extension is only available for WinDbg. -The `!dumpasync` extension itself is exported from the `SosThreadingTools.dll` library, which is included in a zip that you can acquire from [our releases page](https://github.com/Microsoft/vs-threading/releases). +The `!dumpasync` extension itself is exported from the `SosThreadingTools.dll` library, which is included in a `SosThreadingTools.*.nupkg` archive that you can acquire from [our releases page](https://github.com/Microsoft/vs-threading/releases). +It will appear under the `tools/win-x64` or `tools/win-x86` folder within that archive. ## Usage From 5544227ba8ff90e21deeb5d48dd4567286c22374 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Jan 2024 12:56:11 -0700 Subject: [PATCH 0910/1753] Fix hang in `AsyncLazy.DisposeValue()` when `T : IAsyncDisposable` `AsyncLazy` had been clearing the `JoinableTaskFactory` field as soon as the value factory had completed. But with the introduction of `DisposeValue()`, we have a subsequent need of the JTF object to avoid deadlocks. --- .../AsyncLazy`1.cs | 21 ++++----- .../AsyncLazyTests.cs | 47 ++++++++++++++++++- 2 files changed, 55 insertions(+), 13 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 057d4621a..8d48f9f06 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -41,14 +41,14 @@ public class AsyncLazy private readonly AsyncLocal recursiveFactoryCheck = new AsyncLocal(); /// - /// The function to invoke to produce the task. + /// An optional means to avoid deadlocks when synchronous APIs are called that must invoke async methods in user code. /// - private Func>? valueFactory; + private readonly JoinableTaskFactory? jobFactory; /// - /// The async pump to Join on calls to . + /// The function to invoke to produce the task. /// - private JoinableTaskFactory? jobFactory; + private Func>? valueFactory; /// /// The result of the value factory. @@ -64,7 +64,10 @@ public class AsyncLazy /// Initializes a new instance of the class. /// /// The async function that produces the value. To be invoked at most once. - /// The factory to use when invoking the value factory in to avoid deadlocks when the main thread is required by the value factory. + /// + /// The to use for avoiding deadlocks when the + /// or the constructed value's method may require the main thread in the process. + /// public AsyncLazy(Func> valueFactory, JoinableTaskFactory? joinableTaskFactory = null) { Requires.NotNull(valueFactory, nameof(valueFactory)); @@ -178,7 +181,6 @@ public Task GetValueAsync(CancellationToken cancellationToken) } finally { - this.jobFactory = null; this.joinableTask = null; } }; @@ -252,11 +254,8 @@ public T GetValue(CancellationToken cancellationToken) } else { - // Capture the factory as a local before comparing and dereferencing it since - // the field can transition to null and we want to gracefully handle that race condition. - JoinableTaskFactory? factory = this.jobFactory; - return factory is object - ? factory.Run(() => this.GetValueAsync(cancellationToken)) + return this.jobFactory is JoinableTaskFactory jtf + ? jtf.Run(() => this.GetValueAsync(cancellationToken)) : this.GetValueAsync(cancellationToken).GetAwaiter().GetResult(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 9c3e3981e..e6cff90d7 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -699,6 +699,44 @@ public async Task Dispose_Disposable_Incomplete(DisposeStyle variety) await value.Disposed.WithCancellation(this.TimeoutToken); } + [Fact] + public void DisposeValue_AsyncDisposableValueRequiresMainThread() + { + JoinableTaskContext context = this.InitializeJTCAndSC(); + SingleThreadedTestSynchronizationContext.IFrame frame = SingleThreadedTestSynchronizationContext.NewFrame(); + + AsyncLazy lazy = new( + delegate + { + return Task.FromResult(new SystemAsyncDisposable { YieldDuringDispose = true }); + }, + context.Factory); + lazy.GetValue(); + + TaskCompletionSource delegateResult = new(); + SynchronizationContext.Current!.Post( + delegate + { + try + { + lazy.DisposeValue(); + + delegateResult.SetResult(true); + } + catch (Exception ex) + { + delegateResult.SetException(ex); + } + finally + { + frame.Continue = false; + } + }, + null); + SingleThreadedTestSynchronizationContext.PushFrame(SynchronizationContext.Current!, frame); + delegateResult.Task.GetAwaiter().GetResult(); // rethrow any exceptions + } + [Fact] public async Task Dispose_NonDisposable_Incomplete() { @@ -868,10 +906,15 @@ private class Disposable : DisposableBase, IDisposableObservable private class SystemAsyncDisposable : DisposableBase, System.IAsyncDisposable { - public ValueTask DisposeAsync() + internal bool YieldDuringDispose { get; set; } + + public async ValueTask DisposeAsync() { this.disposalEvent.Set(); - return default; + if (this.YieldDuringDispose) + { + await Task.Yield(); + } } } From 7ea5ed84e3d1a04f5dec58b41c70db4a06b63e1f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Jan 2024 22:26:16 -0700 Subject: [PATCH 0911/1753] Fix tests --- test/IsolatedTestHost/App.config | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index 2a58d341c..f899e7a15 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -10,13 +10,13 @@ - + - + From e268bc52cca75f44a89198f2849554ea9d110f97 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 6 Jan 2024 14:24:07 +0000 Subject: [PATCH 0912/1753] Fix build break --- init.ps1 | 0 src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs | 8 ++++---- 2 files changed, 4 insertions(+), 4 deletions(-) mode change 100644 => 100755 init.ps1 diff --git a/init.ps1 b/init.ps1 old mode 100644 new mode 100755 diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index a809391a8..0b98fc7ad 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -36,14 +36,14 @@ public class AsyncLazy private readonly object syncObject = new object(); /// - /// The unique instance identifier. + /// An optional means to avoid deadlocks when synchronous APIs are called that must invoke async methods in user code. /// - private AsyncLocal? recursiveFactoryCheck; + private readonly JoinableTaskFactory? jobFactory; /// - /// An optional means to avoid deadlocks when synchronous APIs are called that must invoke async methods in user code. + /// The unique instance identifier. /// - private readonly JoinableTaskFactory? jobFactory; + private AsyncLocal? recursiveFactoryCheck; /// /// The function to invoke to produce the task. From 30e1048a3fe772f6a754c53d29d941d870d6991d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 6 Jan 2024 14:41:58 +0000 Subject: [PATCH 0913/1753] Fix whitespace issues --- .../CommonFixes.cs | 6 +++--- .../AbstractVSTHRD011UseAsyncLazyAnalyzer.cs | 6 +++--- .../TplExtensions.cs | 2 +- .../MultiAnalyzerTests.cs | 4 ++-- .../AsyncAutoResetEventTests.cs | 6 +++--- .../AsyncReaderWriterLockTests.cs | 2 +- .../JoinableTaskContextTests.cs | 12 ++++++------ 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs index c4c7b1838..79015ac8d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/CommonFixes.cs @@ -47,9 +47,9 @@ internal static async Task> ReadAdditionalFilesAsync(IEnu } IEnumerable? docs = from doc in additionalFiles.OrderBy(x => x.FilePath, StringComparer.Ordinal) - let fileName = Path.GetFileName(doc.Name) - where fileNamePattern.IsMatch(fileName) - select doc; + let fileName = Path.GetFileName(doc.Name) + where fileNamePattern.IsMatch(fileName) + select doc; ImmutableArray.Builder? result = ImmutableArray.CreateBuilder(); foreach (TextDocument? doc in docs) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs index 44a599998..7147399f3 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs @@ -71,9 +71,9 @@ private void AnalyzeNode(OperationAnalysisContext context) if (firstArgExpression is IDelegateCreationOperation { Target: IAnonymousFunctionOperation anonFunc }) { System.Collections.Generic.IEnumerable? problems = from invocation in anonFunc.Descendants().OfType() - let invokedSymbol = invocation.TargetMethod - where invokedSymbol is object && CommonInterest.SyncBlockingMethods.Any(m => m.Method.IsMatch(invokedSymbol)) - select invocation; + let invokedSymbol = invocation.TargetMethod + where invokedSymbol is object && CommonInterest.SyncBlockingMethods.Any(m => m.Method.IsMatch(invokedSymbol)) + select invocation; IInvocationOperation? firstProblem = problems.FirstOrDefault(); if (firstProblem is object) { diff --git a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs index 7fe2a473d..9fdb6aa76 100644 --- a/src/Microsoft.VisualStudio.Threading/TplExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/TplExtensions.cs @@ -121,7 +121,7 @@ public static void ApplyResultTo(this Task task, TaskCompletionSource t /// The task whose completion should be applied to another. /// The task that should receive the completion status. public static void ApplyResultTo(this Task task, TaskCompletionSource tcs) - //// where T : defaultable + //// where T : defaultable { Requires.NotNull(task, nameof(task)); Requires.NotNull(tcs, nameof(tcs)); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs index b052dbc59..9d4a61437 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/MultiAnalyzerTests.cs @@ -330,8 +330,8 @@ public class Test : CSharpCodeFixVerifier GetDiagnosticAnalyzers() { IEnumerable? analyzers = from type in typeof(VSTHRD002UseJtfRunAnalyzer).Assembly.GetTypes() - where type.GetCustomAttributes(typeof(DiagnosticAnalyzerAttribute), true).Any() - select (DiagnosticAnalyzer?)Activator.CreateInstance(type) ?? throw Assumes.Fail("Unable to instantiate the analyzer"); + where type.GetCustomAttributes(typeof(DiagnosticAnalyzerAttribute), true).Any() + select (DiagnosticAnalyzer?)Activator.CreateInstance(type) ?? throw Assumes.Fail("Unable to instantiate the analyzer"); return analyzers.ToImmutableArray(); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs index fffb45d83..5bfb23e95 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs @@ -74,9 +74,9 @@ public void SetReturnsBeforeInlinedContinuations() .ContinueWith( delegate { - // Arrange to synchronously block the continuation until Set() has returned, - // which would deadlock if Set does not return until inlined continuations complete. - Assert.True(setReturned.Wait(AsyncDelay)); + // Arrange to synchronously block the continuation until Set() has returned, + // which would deadlock if Set does not return until inlined continuations complete. + Assert.True(setReturned.Wait(AsyncDelay)); }, TaskContinuationOptions.ExecuteSynchronously); this.evt.Set(); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index 4f0a78ab5..40aa53f35 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -4512,7 +4512,7 @@ await Task.WhenAll( await secondLockInQueue.SetAsync(); }), secondLockObtained.Task); - }); + }); } private Task UncontestedTopLevelLocksAllocFreeHelperAsync(Func locker, bool yieldingLock) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index d0b00c42f..e50d64078 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -410,8 +410,8 @@ public void GetHangReportProducesDgmlWithNamedJoinableCollections() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Collection" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Collection" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label == jtcName); return Task.CompletedTask; }); @@ -433,8 +433,8 @@ public void GetHangReportProducesDgmlWithMethodNameRequestingMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.GetHangReportProducesDgmlWithMethodNameRequestingMainThread))); } @@ -456,8 +456,8 @@ public void GetHangReportProducesDgmlWithMethodNameYieldingOnMainThread() this.Logger.WriteLine(report.Content); var dgml = XDocument.Parse(report.Content); IEnumerable? collectionLabels = from node in dgml.Root!.Element(XName.Get("Nodes", DgmlNamespace))!.Elements() - where node.Attribute(XName.Get("Category"))?.Value == "Task" - select node.Attribute(XName.Get("Label"))?.Value; + where node.Attribute(XName.Get("Category"))?.Value == "Task" + select node.Attribute(XName.Get("Label"))?.Value; Assert.Contains(collectionLabels, label => label.Contains(nameof(this.YieldingMethodAsync))); }); } From 52a1e174661987de31061a47df64076f11cb8366 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 6 Jan 2024 14:53:47 +0000 Subject: [PATCH 0914/1753] Disable `dotnet format` check It's buggy, and fails for well-formatted syntax, but only in verify mode. --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 21608fb56..4ffbdc39a 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -70,6 +70,7 @@ jobs: RunTests: ${{ parameters.RunTests }} - script: dotnet format --verify-no-changes --no-restore displayName: 💅 Verify formatted code + enabled: false - job: macOS condition: and(${{ parameters.includeMacOS }}, ne(variables['OptProf'], 'true')) From e757dc7f608e40ee67d31c3bc358035131d23f70 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 9 Jan 2024 06:43:16 -0700 Subject: [PATCH 0915/1753] Bump MicroBuild to 2.0.147 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 4152ee855..3fd15a576 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.146 + 2.0.147 From 130e9c8786fb934a3e1db3adbb480f0a58b72830 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 15 Jan 2024 09:56:35 -0700 Subject: [PATCH 0916/1753] Bump powershell from 7.4.0 to 7.4.1 (#245) Bumps [powershell](https://github.com/PowerShell/PowerShell) from 7.4.0 to 7.4.1. - [Release notes](https://github.com/PowerShell/PowerShell/releases) - [Commits](https://github.com/PowerShell/PowerShell/compare/v7.4.0...v7.4.1) --- updated-dependencies: - dependency-name: powershell dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index b46731160..589f0604b 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.4.0", + "version": "7.4.1", "commands": [ "pwsh" ] From 7fd4b166ea46c8fa4b3a7f0954c9f0f99b6467ac Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jan 2024 22:36:03 -0700 Subject: [PATCH 0917/1753] Bump xunit from 2.6.4 to 2.6.6 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 41167d99a..1438548bb 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ - + From 050805e88f48ff2954489c7a795dda28c5282fb5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 25 Jan 2024 14:04:06 -0700 Subject: [PATCH 0918/1753] Add switch to avoid creating symbolic links Symbolic links present a problem, at least for "1ES PT". --- azure-pipelines/artifacts/_pipelines.ps1 | 5 +++-- azure-pipelines/artifacts/_stage_all.ps1 | 10 ++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 2d3338b24..47321ed5b 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -7,7 +7,8 @@ [CmdletBinding()] param ( [string]$ArtifactNameSuffix, - [switch]$StageOnly + [switch]$StageOnly, + [switch]$AvoidSymbolicLinks ) Function Set-PipelineVariable($name, $value) { @@ -24,7 +25,7 @@ Function Test-ArtifactUploaded($artifactName) { Test-Path "env:$varName" } -& "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix |% { +& "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix -AvoidSymbolicLinks:$AvoidSymbolicLinks |% { # Set a variable which will out-live this script so that a subsequent attempt to collect and upload artifacts # will skip this one from a check in the _all.ps1 script. Set-PipelineVariable "ARTIFACTSTAGED_$($_.Name.ToUpper())" 'true' diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index b077931cc..74d7a38df 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -7,7 +7,8 @@ [CmdletBinding()] param ( - [string]$ArtifactNameSuffix + [string]$ArtifactNameSuffix, + [switch]$AvoidSymbolicLinks ) $ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal @@ -48,7 +49,12 @@ $Artifacts |% { if (-not (Test-Path $DestinationFolder)) { New-Item -ItemType Directory -Path $DestinationFolder | Out-Null } if (Test-Path -PathType Leaf $_.Source) { # skip folders - Create-SymbolicLink -Link (Join-Path $DestinationFolder $Name) -Target $_.Source + $TargetPath = Join-Path $DestinationFolder $Name + if ($AvoidSymbolicLinks) { + Copy-Item -Path $_.Source -Destination $TargetPath + } else { + Create-SymbolicLink -Link $TargetPath -Target $_.Source + } } } From 9466f8ed67a86e5fa195c12beb501e2abf0f1446 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 26 Jan 2024 11:05:24 -0700 Subject: [PATCH 0919/1753] Clarify parameter type in AzP template --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5d1835d56..3d53ed836 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -4,6 +4,7 @@ parameters: default: vmImage: windows-2022 - name: includeMacOS + type: boolean - name: RunTests type: boolean default: true From 89ada64c57cb0dc31794c4c479f702eec86978ce Mon Sep 17 00:00:00 2001 From: trevors20 <49179298+trevors20@users.noreply.github.com> Date: Fri, 26 Jan 2024 10:33:00 -0800 Subject: [PATCH 0920/1753] MicroBuild to 1ES PT template transition (#246) Co-authored-by: Andrew Arnott --- .vscode/settings.json | 1 + azure-pipelines/build.yml | 62 +++++++++++++- azure-pipelines/dotnet.yml | 15 +++- azure-pipelines/microbuild.after.yml | 4 - azure-pipelines/official.yml | 89 +++++++++++++++----- azure-pipelines/secure-development-tools.yml | 26 +----- 6 files changed, 141 insertions(+), 56 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index ce72437ca..1b99a9559 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,6 +2,7 @@ "files.trimTrailingWhitespace": true, "files.insertFinalNewline": true, "files.trimFinalNewlines": true, + "azure-pipelines.1ESPipelineTemplatesSchemaFile": true, "omnisharp.enableEditorConfigSupport": true, "omnisharp.enableRoslynAnalyzers": true, "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true, diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index ecf2f7c4e..64e97cf7a 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -3,6 +3,14 @@ parameters: type: object default: vmImage: windows-2022 +- name: linuxPool + type: object + default: + vmImage: ubuntu-20.04 +- name: macOSPool + type: object + default: + vmImage: macOS-12 - name: includeMacOS type: boolean - name: RunTests @@ -14,6 +22,17 @@ parameters: - name: EnableAPIScan type: boolean default: false +- name: artifact_names + type: object + default: + - build_logs + - coverageResults + - deployables + - projectAssetsJson + - symbols + - testResults + - test_symbols + - Variables jobs: - job: Windows @@ -23,6 +42,25 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline - group: VSCloudServices-APIScan # Expected to provide ApiScanClientId, ApiScanSecret, ApiScanTenant + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-Windows + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Windows + artifactName: ${{ artifact_name }}-Windows + - output: pipelineArtifact + displayName: 📢 Publish VSInsertion-Windows + targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows + artifactName: VSInsertion-Windows + # This is useful when false positives appear so we can copy some of the output into the suppressions file. + - output: pipelineArtifact + displayName: 📢 Publish Guardian failures + targetPath: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions + artifactName: guardian_failures_as_suppressions + condition: failed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. @@ -52,8 +90,16 @@ jobs: - template: expand-template.yml - job: Linux - pool: - vmImage: Ubuntu 20.04 + pool: ${{ parameters.linuxPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-Linux + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux + artifactName: ${{ artifact_name }}-Linux steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. @@ -68,8 +114,16 @@ jobs: - job: macOS condition: ${{ parameters.includeMacOS }} - pool: - vmImage: macOS-12 + pool: ${{ parameters.macOSPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-macOS + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS + artifactName: ${{ artifact_name }}-macOS steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 512415497..61c96a357 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -15,10 +15,17 @@ steps: displayName: ⚙ Update pipeline variables based on build outputs condition: succeededOrFailed() -- powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose - failOnStderr: true - displayName: 📢 Publish artifacts - condition: succeededOrFailed() +- ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + - powershell: azure-pipelines/artifacts/_pipelines.ps1 -StageOnly -AvoidSymbolicLinks -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose + failOnStderr: true + displayName: 📢 Publish artifacts + condition: succeededOrFailed() + +- ${{ if ne(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + - powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose + failOnStderr: true + displayName: 📢 Publish artifacts + condition: succeededOrFailed() - ${{ if and(ne(variables['codecov_token'], ''), parameters.RunTests) }}: - powershell: | diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 3dbbad9cc..7531cf544 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -10,10 +10,6 @@ steps: $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- task: MicroBuildCleanup@1 - condition: succeededOrFailed() - displayName: ⚙️ MicroBuild Cleanup - - task: Ref12Analyze@0 displayName: 📑 Ref12 (Codex) Analyze inputs: diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 6df6f28b7..915c7e765 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -42,24 +42,75 @@ parameters: type: boolean default: true -stages: +resources: + repositories: + - repository: MicroBuildTemplate + type: git + name: 1ESPipelineTemplates/MicroBuildTemplate + ref: refs/tags/release -- stage: Build - variables: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - BuildConfiguration: Release - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages - SignTypeSelection: ${{ parameters.SignTypeSelection }} - Packaging.EnableSBOMSigning: false - Codeql.Enabled: true - - jobs: - - template: build.yml +extends: + ${{ if parameters.EnableCompliance }}: + template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: - EnableCompliance: ${{ parameters.EnableCompliance }} - EnableAPIScan: ${{ parameters.EnableAPIScan }} - windowsPool: VSEngSS-MicroBuild2022-1ES - includeMacOS: ${{ parameters.includeMacOS }} - RunTests: ${{ parameters.RunTests }} - -- template: prepare-insertion-stages.yml + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + stages: + - stage: Build + variables: + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BuildConfiguration: Release + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + SignTypeSelection: ${{ parameters.SignTypeSelection }} + Packaging.EnableSBOMSigning: false + Codeql.Enabled: true + jobs: + - template: /azure-pipelines/build.yml@self + parameters: + EnableCompliance: ${{ parameters.EnableCompliance }} + EnableAPIScan: ${{ parameters.EnableAPIScan }} + windowsPool: VSEngSS-MicroBuild2022-1ES + linuxPool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + os: Linux + macOSPool: + name: Azure Pipelines + vmImage: macOS-12 + os: macOS + includeMacOS: ${{ parameters.includeMacOS }} + RunTests: ${{ parameters.RunTests }} + - template: /azure-pipelines/prepare-insertion-stages.yml@self + ${{ else }}: + template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate + parameters: + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + stages: + - stage: Build + variables: + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BuildConfiguration: Release + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + SignTypeSelection: ${{ parameters.SignTypeSelection }} + Packaging.EnableSBOMSigning: false + Codeql.Enabled: true + jobs: + - template: /azure-pipelines/build.yml@self + parameters: + EnableCompliance: ${{ parameters.EnableCompliance }} + EnableAPIScan: ${{ parameters.EnableAPIScan }} + windowsPool: VSEngSS-MicroBuild2022-1ES + linuxPool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + os: Linux + macOSPool: + name: Azure Pipelines + vmImage: macOS-12 + os: macOS + includeMacOS: ${{ parameters.includeMacOS }} + RunTests: ${{ parameters.RunTests }} + - template: /azure-pipelines/prepare-insertion-stages.yml@self diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index ce8ac94cf..1bbacefed 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -6,18 +6,8 @@ steps: - powershell: echo "##vso[build.addbuildtag]compliance" displayName: 🏷️ Tag run with 'compliance' -- task: CredScan@3 - displayName: 🔍 Run CredScan - -- task: PoliCheck@2 - displayName: 🔍 Run PoliCheck - inputs: - targetType: F - targetArgument: $(System.DefaultWorkingDirectory) - optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml - - task: CopyFiles@2 - displayName: 📂 Collect APIScan/BinSkim inputs + displayName: 📂 Collect APIScan inputs inputs: SourceFolder: $(Build.ArtifactStagingDirectory)/Symbols-$(Agent.JobName) # Exclude any patterns from the Contents (e.g. `!**/git2*`) that we have symbols for but do not need to run APIScan on. @@ -29,14 +19,6 @@ steps: !**/osx*/** TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs -- task: BinSkim@4 - displayName: 🔍 Run BinSkim - inputs: - InputType: Basic - Function: analyze - TargetPattern: guardianGlob - AnalyzeTargetGlob: $(Build.ArtifactStagingDirectory)/APIScanInputs/**/*.dll;$(Build.ArtifactStagingDirectory)/APIScanInputs/**/*.exe - - task: APIScan@2 displayName: 🔍 Run APIScan inputs: @@ -72,9 +54,3 @@ steps: GdnBreakSuppressionSets: falsepositives GdnBreakOutputSuppressionFile: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions/ GdnBreakOutputSuppressionSet: falsepositives - -# This is useful when false positives appear so we can copy some of the output into the suppressions file. -- publish: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions - artifact: guardian_failures_as_suppressions - displayName: 🔍 Publish Guardian failures - condition: failed() From 5c15e00ac2c63b6ad724d36b5356ee2fef5dad31 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 26 Jan 2024 12:24:30 -0700 Subject: [PATCH 0921/1753] Update the other 4 entrypoints for 1ES PT --- azure-pipelines/archive-sourcecode.yml | 83 ++++++---- azure-pipelines/prepare-insertion-stages.yml | 2 - azure-pipelines/release.yml | 109 +++++++------ azure-pipelines/vs-insertion.yml | 97 ++++++------ azure-pipelines/vs-validation.yml | 153 ++++++++++--------- 5 files changed, 249 insertions(+), 195 deletions(-) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index db270eb9e..afdf0f6bf 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -11,6 +11,13 @@ schedules: include: - main +resources: + repositories: + - repository: MicroBuildTemplate + type: git + name: 1ESPipelineTemplates/MicroBuildTemplate + ref: refs/tags/release + parameters: - name: notes displayName: Notes to include in the SCA request @@ -24,35 +31,47 @@ parameters: variables: - group: VS Core team # Expected to provide ManagerAlias, SourceCodeArchivalUri -pool: - name: AzurePipelines-EO - vmImage: AzurePipelinesUbuntu20.04compliant - -steps: -- checkout: self - clean: true - fetchDepth: 0 -- powershell: tools/Install-DotNetSdk.ps1 - displayName: ⚙ Install .NET SDK -- task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: - forceReinstallCredentialProvider: true -- script: dotnet tool restore - displayName: ⚙️ Restore CLI tools -- powershell: azure-pipelines/variables/_pipelines.ps1 - failOnStderr: true - displayName: ⚙ Set pipeline variables based on source -- powershell: > - $TeamAlias = '$(TeamEmail)'.Substring(0, '$(TeamEmail)'.IndexOf('@')) - - azure-pipelines/Archive-SourceCode.ps1 - -ManagerAlias '$(ManagerAlias)' - -TeamAlias $TeamAlias - -BusinessGroupName '$(BusinessGroupName)' - -ProductName '$(SymbolsFeatureName)' - -ProductLanguage English - -Notes '${{ parameters.notes }}' - -Verbose - -WhatIf:$${{ parameters.whatif }} - displayName: 🗃️ Submit archival request +extends: + template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate + parameters: + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + + stages: + - stage: archive + jobs: + - job: archive + pool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + os: Linux + + steps: + - checkout: self + clean: true + fetchDepth: 0 + - powershell: tools/Install-DotNetSdk.ps1 + displayName: ⚙ Install .NET SDK + - task: NuGetAuthenticate@1 + displayName: 🔏 Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true + - script: dotnet tool restore + displayName: ⚙️ Restore CLI tools + - powershell: azure-pipelines/variables/_pipelines.ps1 + failOnStderr: true + displayName: ⚙ Set pipeline variables based on source + - powershell: > + $TeamAlias = '$(TeamEmail)'.Substring(0, '$(TeamEmail)'.IndexOf('@')) + + azure-pipelines/Archive-SourceCode.ps1 + -ManagerAlias '$(ManagerAlias)' + -TeamAlias $TeamAlias + -BusinessGroupName '$(BusinessGroupName)' + -ProductName '$(SymbolsFeatureName)' + -ProductLanguage English + -Notes '${{ parameters.notes }}' + -Verbose + -WhatIf:$${{ parameters.whatif }} + displayName: 🗃️ Submit archival request diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index a41be0320..f805607e0 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -29,8 +29,6 @@ stages: SymbolsProject: VS SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy azureSubscription: Symbols Upload (DevDiv) - - task: MicroBuildCleanup@1 - displayName: ☎️ Send Telemetry # - job: push # displayName: azure-public/vs-impl feed diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 175c37a9d..d949958f4 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -2,6 +2,11 @@ trigger: none # We only want to trigger manually or based on resources pr: none resources: + repositories: + - repository: MicroBuildTemplate + type: git + name: 1ESPipelineTemplates/MicroBuildTemplate + ref: refs/tags/release pipelines: - pipeline: CI source: Library # TODO: This should match the name of your CI pipeline @@ -12,50 +17,60 @@ resources: variables: - group: VS SDK feeds # Expected to provide NuGetOrgApiKey -jobs: -- job: release - pool: - name: AzurePipelines-EO - vmImage: AzurePipelinesUbuntu20.04compliant - steps: - - checkout: none - - powershell: | - Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - if ('$(resources.pipeline.CI.runName)'.Contains('-')) { - Write-Host "##vso[task.setvariable variable=IsPrerelease]true" - } else { - Write-Host "##vso[task.setvariable variable=IsPrerelease]false" - } - displayName: ⚙ Set up pipeline - - task: UseDotNet@2 - displayName: ⚙ Install .NET SDK - inputs: - packageType: sdk - version: 6.x - - download: CI - artifact: deployables-Windows - displayName: 🔻 Download deployables-Windows artifact - patterns: 'deployables-Windows/NuGet/*' - - task: GitHubRelease@1 - displayName: 📢 GitHub release (create) - inputs: - gitHubConnection: # TODO: fill in service connection here - repositoryName: $(Build.Repository.Name) - target: $(resources.pipeline.CI.sourceCommit) - tagSource: userSpecifiedTag - tag: v$(resources.pipeline.CI.runName) - title: v$(resources.pipeline.CI.runName) - isDraft: true # After running this step, visit the new draft release, edit, and publish. - isPreRelease: $(IsPrerelease) - assets: $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg - changeLogCompareToRelease: lastNonDraftRelease - changeLogType: issueBased - changeLogLabels: | - [ - { "label" : "breaking change", "displayName" : "Breaking changes", "state" : "closed" }, - { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, - { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } - ] - - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate - displayName: 📦 Push packages to nuget.org - condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) +extends: + template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate + parameters: + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + + stages: + - stage: release + jobs: + - job: release + pool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + os: Linux + steps: + - checkout: none + - powershell: | + Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + if ('$(resources.pipeline.CI.runName)'.Contains('-')) { + Write-Host "##vso[task.setvariable variable=IsPrerelease]true" + } else { + Write-Host "##vso[task.setvariable variable=IsPrerelease]false" + } + displayName: ⚙ Set up pipeline + - task: UseDotNet@2 + displayName: ⚙ Install .NET SDK + inputs: + packageType: sdk + version: 6.x + - download: CI + artifact: deployables-Windows + displayName: 🔻 Download deployables-Windows artifact + patterns: 'deployables-Windows/NuGet/*' + - task: GitHubRelease@1 + displayName: 📢 GitHub release (create) + inputs: + gitHubConnection: # TODO: fill in service connection here + repositoryName: $(Build.Repository.Name) + target: $(resources.pipeline.CI.sourceCommit) + tagSource: userSpecifiedTag + tag: v$(resources.pipeline.CI.runName) + title: v$(resources.pipeline.CI.runName) + isDraft: true # After running this step, visit the new draft release, edit, and publish. + isPreRelease: $(IsPrerelease) + assets: $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg + changeLogCompareToRelease: lastNonDraftRelease + changeLogType: issueBased + changeLogLabels: | + [ + { "label" : "breaking change", "displayName" : "Breaking changes", "state" : "closed" }, + { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, + { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } + ] + - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate + displayName: 📦 Push packages to nuget.org + condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index c75245594..37257bb2d 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -2,6 +2,11 @@ trigger: none # We only want to trigger manually or based on resources pr: none resources: + repositories: + - repository: MicroBuildTemplate + type: git + name: 1ESPipelineTemplates/MicroBuildTemplate + ref: refs/tags/release pipelines: - pipeline: CI source: Library # TODO: This should match the name of your CI pipeline @@ -12,46 +17,52 @@ resources: - Real signed - auto-insertion -jobs: -- job: insertion - displayName: VS insertion - pool: VSEngSS-MicroBuild2022-1ES - steps: - - checkout: none - - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - displayName: ⚙️ Set pipeline name - - task: UseDotNet@2 - displayName: ⚙️ Install .NET SDK - inputs: - packageType: sdk - version: 6.x - - task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: - forceReinstallCredentialProvider: true - - template: release-deployment-prep.yml - - download: CI - artifact: VSInsertion-Windows - displayName: 🔻 Download VSInsertion-Windows artifact - - script: dotnet nuget push $(Pipeline.Workspace)\CI\VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate - displayName: 📦 Push CoreXT packages to VS feed - - task: MicroBuildInsertVsPayload@4 - displayName: 🏭 Insert VS Payload - inputs: - TeamName: $(TeamName) - TeamEmail: $(TeamEmail) - InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) - InsertionBuildPolicy: Request Perf DDRITs - AutoCompletePR: true - AutoCompleteMergeStrategy: Squash - - task: MicroBuildCleanup@1 - displayName: ☎️ Send Telemetry - - powershell: | - $contentType = 'application/json'; - $headers = @{ Authorization = 'Bearer $(System.AccessToken)' }; - $rawRequest = @{ daysValid = 365 * 2; definitionId = $(resources.pipeline.CI.pipelineID); ownerId = 'User:$(Build.RequestedForId)'; protectPipeline = $false; runId = $(resources.pipeline.CI.runId) }; - $request = ConvertTo-Json @($rawRequest); - Write-Host $request - $uri = "$(System.CollectionUri)$(System.TeamProject)/_apis/build/retention/leases?api-version=6.0-preview.1"; - Invoke-RestMethod -uri $uri -method POST -Headers $headers -ContentType $contentType -Body $request; - displayName: 🗻 Retain inserted builds +extends: + template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate + parameters: + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + + stages: + - stage: insertion + jobs: + - job: insertion + displayName: VS insertion + pool: VSEngSS-MicroBuild2022-1ES + steps: + - checkout: none + - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + displayName: ⚙️ Set pipeline name + - task: UseDotNet@2 + displayName: ⚙️ Install .NET SDK + inputs: + packageType: sdk + version: 6.x + - task: NuGetAuthenticate@1 + displayName: 🔏 Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true + - template: azure-pipelines/release-deployment-prep.yml@self + - download: CI + artifact: VSInsertion-Windows + displayName: 🔻 Download VSInsertion-Windows artifact + - script: dotnet nuget push $(Pipeline.Workspace)\CI\VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate + displayName: 📦 Push CoreXT packages to VS feed + - task: MicroBuildInsertVsPayload@4 + displayName: 🏭 Insert VS Payload + inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) + InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) + InsertionBuildPolicy: Request Perf DDRITs + AutoCompletePR: true + AutoCompleteMergeStrategy: Squash + - powershell: | + $contentType = 'application/json'; + $headers = @{ Authorization = 'Bearer $(System.AccessToken)' }; + $rawRequest = @{ daysValid = 365 * 2; definitionId = $(resources.pipeline.CI.pipelineID); ownerId = 'User:$(Build.RequestedForId)'; protectPipeline = $false; runId = $(resources.pipeline.CI.runId) }; + $request = ConvertTo-Json @($rawRequest); + Write-Host $request + $uri = "$(System.CollectionUri)$(System.TeamProject)/_apis/build/retention/leases?api-version=6.0-preview.1"; + Invoke-RestMethod -uri $uri -method POST -Headers $headers -ContentType $contentType -Body $request; + displayName: 🗻 Retain inserted builds diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index cb9a2072e..d60b67cba 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -5,77 +5,88 @@ trigger: none # We only want to trigger manually or based on resources pr: none -stages: -- stage: Build - variables: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages - SignTypeSelection: Real - BuildConfiguration: Release - ValidationBuild: true +resources: + repositories: + - repository: MicroBuildTemplate + type: git + name: 1ESPipelineTemplates/MicroBuildTemplate + ref: refs/tags/release - jobs: - - template: build.yml - parameters: - windowsPool: VSEngSS-MicroBuild2022-1ES - includeMacOS: false - RunTests: false - -- template: prepare-insertion-stages.yml +extends: + template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: - ArchiveSymbols: false + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + + stages: + - stage: Build + variables: + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + SignTypeSelection: Real + BuildConfiguration: Release + ValidationBuild: true + + jobs: + - template: /azure-pipelines/build.yml@self + parameters: + windowsPool: VSEngSS-MicroBuild2022-1ES + includeMacOS: false + RunTests: false + + - template: /azure-pipelines/prepare-insertion-stages.yml@self + parameters: + ArchiveSymbols: false -- stage: insertion - displayName: VS insertion - jobs: - - job: insertion - displayName: VS insertion - pool: VSEngSS-MicroBuild2022-1ES - steps: - - checkout: self - clean: true - fetchDepth: 1 - - task: UseDotNet@2 - displayName: ⚙️ Install .NET SDK - inputs: - packageType: sdk - version: 6.x - - task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: - forceReinstallCredentialProvider: true - - download: current - artifact: Variables-Windows - displayName: 🔻 Download Variables-Windows artifact - - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 - displayName: ⚙️ Set pipeline variables based on artifacts - - download: current - artifact: VSInsertion-Windows - displayName: 🔻 Download VSInsertion-Windows artifact - - script: dotnet nuget push VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate - displayName: 📦 Push CoreXT packages to VS feed - workingDirectory: $(Pipeline.Workspace) - - task: MicroBuildInsertVsPayload@4 - displayName: 🏭 Insert VS Payload - inputs: - TeamName: $(TeamName) - TeamEmail: $(TeamEmail) - InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) [Skip-SymbolCheck] - InsertionDescription: | - This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. - CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 - InsertionBuildPolicy: Request Perf DDRITs - InsertionReviewers: $(Build.RequestedForEmail) - AutoCompletePR: false - - powershell: | - $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 - $Markdown = @" - Validation insertion pull request created: !$insertionPRId - Please check status there before proceeding to merge this PR. - Remember to Abandon and (if allowed) to Delete Source Branch on that insertion PR when validation is complete. - "@ - azure-pipelines/PostPRMessage.ps1 -AccessToken '$(System.AccessToken)' -Markdown $Markdown -Verbose - displayName: ✏️ Comment on pull request - condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest')) - - task: MicroBuildCleanup@1 - displayName: ☎️ Send Telemetry + - stage: insertion + displayName: VS insertion + jobs: + - job: insertion + displayName: VS insertion + pool: VSEngSS-MicroBuild2022-1ES + steps: + - checkout: self + clean: true + fetchDepth: 1 + - task: UseDotNet@2 + displayName: ⚙️ Install .NET SDK + inputs: + packageType: sdk + version: 6.x + - task: NuGetAuthenticate@1 + displayName: 🔏 Authenticate NuGet feeds + inputs: + forceReinstallCredentialProvider: true + - download: current + artifact: Variables-Windows + displayName: 🔻 Download Variables-Windows artifact + - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + displayName: ⚙️ Set pipeline variables based on artifacts + - download: current + artifact: VSInsertion-Windows + displayName: 🔻 Download VSInsertion-Windows artifact + - script: dotnet nuget push VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate + displayName: 📦 Push CoreXT packages to VS feed + workingDirectory: $(Pipeline.Workspace) + - task: MicroBuildInsertVsPayload@4 + displayName: 🏭 Insert VS Payload + inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) + InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) [Skip-SymbolCheck] + InsertionDescription: | + This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. + CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 + InsertionBuildPolicy: Request Perf DDRITs + InsertionReviewers: $(Build.RequestedForEmail) + AutoCompletePR: false + - powershell: | + $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 + $Markdown = @" + Validation insertion pull request created: !$insertionPRId + Please check status there before proceeding to merge this PR. + Remember to Abandon and (if allowed) to Delete Source Branch on that insertion PR when validation is complete. + "@ + azure-pipelines/PostPRMessage.ps1 -AccessToken '$(System.AccessToken)' -Markdown $Markdown -Verbose + displayName: ✏️ Comment on pull request + condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest')) From 220142fcadc255a686839652b2f11f5c69204095 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 26 Jan 2024 12:47:22 -0700 Subject: [PATCH 0922/1753] Switch vs-validation pipeline to Unofficial template --- azure-pipelines/vs-validation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index d60b67cba..137acbe41 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -13,7 +13,7 @@ resources: ref: refs/tags/release extends: - template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate + template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES From 4d1473c2924f40f02578e70a053ba666e6531ae1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 29 Jan 2024 13:16:00 -0700 Subject: [PATCH 0923/1753] Bump dotnet-coverage from 17.9.6 to 17.10.1Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.9.6 to 17.10.1.- [Commits](https://github.com/microsoft/codecoverage/commits)---updated-dependencies:- dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-minor...Signed-off-by: dependabot[bot] * Bump dotnet-coverage from 17.9.6 to 17.10.1 Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.9.6 to 17.10.1. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 589f0604b..5941f4c88 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.9.6", + "version": "17.10.1", "commands": [ "dotnet-coverage" ] From ebb0607dd933ae5b44ee473eec4ff8716cd211d6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 29 Jan 2024 17:05:36 -0700 Subject: [PATCH 0924/1753] Format init.ps1 --- init.ps1 | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/init.ps1 b/init.ps1 index 00a9589ba..e28498553 100755 --- a/init.ps1 +++ b/init.ps1 @@ -84,8 +84,7 @@ try { $HeaderColor = 'Green' $RestoreArguments = @() - if ($Interactive) - { + if ($Interactive) { $RestoreArguments += '--interactive' } @@ -98,10 +97,10 @@ try { } if (!$NoToolRestore -and $PSCmdlet.ShouldProcess("dotnet tool", "restore")) { - dotnet tool restore @RestoreArguments - if ($lastexitcode -ne 0) { - throw "Failure while restoring dotnet CLI tools." - } + dotnet tool restore @RestoreArguments + if ($lastexitcode -ne 0) { + throw "Failure while restoring dotnet CLI tools." + } } & "$PSScriptRoot/tools/Set-EnvVars.ps1" -Variables $EnvVars -PrependPath $PrependPath | Out-Null From 72b8ba01196c0fcb51db7cf36335d2ce04f15be5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 31 Jan 2024 12:21:32 -0700 Subject: [PATCH 0925/1753] Fix NUGET_PACKAGES path in pipelines By default the NUGET_PACKAGES path has a trailing slash. In our override, we should do this as well or the msbuild property that gets generated is missing the slash, which can break some builds. This follows the pattern in 9805678248d0fbda63f97982f37e35de71890d2f, which only applied to one of the locations that in the microbuild branch we must change. --- azure-pipelines/official.yml | 4 ++-- azure-pipelines/vs-validation.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 915c7e765..a57cdc349 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -60,7 +60,7 @@ extends: variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ SignTypeSelection: ${{ parameters.SignTypeSelection }} Packaging.EnableSBOMSigning: false Codeql.Enabled: true @@ -92,7 +92,7 @@ extends: variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ SignTypeSelection: ${{ parameters.SignTypeSelection }} Packaging.EnableSBOMSigning: false Codeql.Enabled: true diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 137acbe41..8ca0b33ac 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -22,7 +22,7 @@ extends: - stage: Build variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ SignTypeSelection: Real BuildConfiguration: Release ValidationBuild: true From 9f902a1a59452d115c99edf232fbd7635530a755 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 1 Feb 2024 17:06:13 -0700 Subject: [PATCH 0926/1753] Fix the pool for pushing real-signed packages to be 1ES PT compliant --- azure-pipelines/prepare-insertion-stages.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index f805607e0..6b0a91b4b 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -36,7 +36,9 @@ stages: # dependsOn: symbol_archive # pool: # name: AzurePipelines-EO - # vmImage: AzurePipelinesUbuntu20.04compliant + # demands: + # - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + # os: Linux # steps: # - checkout: none # - download: current From 65f2106cda0b367d5471e820458ef73e2206ff68 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 2 Feb 2024 12:14:01 -0700 Subject: [PATCH 0927/1753] Set TeamName variable in `push` job This avoids a pipeline break due to a Microbuild pipeline template injected telemetry task. --- azure-pipelines/prepare-insertion-stages.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 6b0a91b4b..f1d5ab89d 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -42,6 +42,11 @@ stages: # steps: # - checkout: none # - download: current + # artifact: Variables-Windows + # displayName: 🔻 Download Variables-Windows artifact + # - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + # displayName: ⚙️ Set pipeline variables based on artifacts + # - download: current # artifact: deployables-Windows # displayName: 🔻 Download deployables-Windows artifact # - task: UseDotNet@2 From bb38a7296be221aa5b81d54cbd28377ae5973d20 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 2 Feb 2024 10:59:02 -0700 Subject: [PATCH 0928/1753] Fix break when the RunTests parameter is false --- azure-pipelines/build.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 64e97cf7a..481447b2c 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -47,10 +47,11 @@ jobs: outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-Windows - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Windows - artifactName: ${{ artifact_name }}-Windows + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-Windows + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Windows + artifactName: ${{ artifact_name }}-Windows - output: pipelineArtifact displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows From 12367efcf427453bf880b74ce4028e088e7ac6d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 2 Feb 2024 15:06:49 -0700 Subject: [PATCH 0929/1753] Replace publish task with 1ES PT compliant one --- azure-pipelines/build.yml | 5 +++++ azure-pipelines/microbuild.after.yml | 8 -------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 1e39ddbba..f163b45bb 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -56,6 +56,11 @@ jobs: displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows artifactName: VSInsertion-Windows + - output: pipelineArtifact + displayName: 📢 Publish InsertionOutputs + targetPath: $(Build.ArtifactStagingDirectory)/InsertionOutputs + artifactName: InsertionOutputs + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) # This is useful when false positives appear so we can copy some of the output into the suppressions file. - output: pipelineArtifact displayName: 📢 Publish Guardian failures diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index a0c043be0..abb38073d 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -21,14 +21,6 @@ steps: condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) continueOnError: true -- task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/InsertionOutputs - ArtifactName: InsertionOutputs - ArtifactType: Container - displayName: 🔧 Publish InsertionOutputs as Azure DevOps artifacts - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - - task: Ref12Analyze@0 displayName: 📑 Ref12 (Codex) Analyze inputs: From 83d4a12c8b03fa109e7608875ee2225c467fb631 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 12:12:53 -0700 Subject: [PATCH 0930/1753] Push nuget packages in 1ES compliant way --- azure-pipelines/prepare-insertion-stages.yml | 22 +++++++++----------- azure-pipelines/release.yml | 21 +++++++++---------- azure-pipelines/vs-insertion.yml | 16 ++++++-------- azure-pipelines/vs-validation.yml | 17 ++++++--------- 4 files changed, 32 insertions(+), 44 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index f1d5ab89d..98e5232ce 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -39,6 +39,16 @@ stages: # demands: # - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT # os: Linux + # templateContext: + # outputParentDirectory: $(Pipeline.Workspace) + # outputs: + # - output: nuget + # displayName: 📦 Push nuget packages + # packagesToPush: '(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg' + # packageParentPath: (Pipeline.Workspace)/deployables-Windows/NuGet + # allowPackageConflicts: true + # nuGetFeedType: external + # publishFeedCredentials: azure-public/vs-impl # steps: # - checkout: none # - download: current @@ -49,15 +59,3 @@ stages: # - download: current # artifact: deployables-Windows # displayName: 🔻 Download deployables-Windows artifact - # - task: UseDotNet@2 - # displayName: ⚙️ Install .NET SDK - # inputs: - # packageType: sdk - # version: 6.x - # - task: NuGetAuthenticate@1 - # displayName: 🔏 Authenticate NuGet feeds - # inputs: - # nuGetServiceConnections: azure-public/vs-impl - # forceReinstallCredentialProvider: true - # - script: dotnet nuget push $(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg -s https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-impl/nuget/v3/index.json --api-key azdo --skip-duplicate - # displayName: 📦 Push nuget packages diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index d949958f4..8b3717718 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -14,9 +14,6 @@ resources: tags: - auto-release -variables: -- group: VS SDK feeds # Expected to provide NuGetOrgApiKey - extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: @@ -32,6 +29,16 @@ extends: demands: - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT os: Linux + templateContext: + outputParentDirectory: $(Pipeline.Workspace) + outputs: + - output: nuget + displayName: 📦 Push packages to nuget.org + packagesToPush: '$(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg' + packageParentPath: $(Pipeline.Workspace)/CI/deployables-Windows/NuGet + allowPackageConflicts: true + nuGetFeedType: external + publishFeedCredentials: VisualStudioExtensibility (nuget.org) steps: - checkout: none - powershell: | @@ -42,11 +49,6 @@ extends: Write-Host "##vso[task.setvariable variable=IsPrerelease]false" } displayName: ⚙ Set up pipeline - - task: UseDotNet@2 - displayName: ⚙ Install .NET SDK - inputs: - packageType: sdk - version: 6.x - download: CI artifact: deployables-Windows displayName: 🔻 Download deployables-Windows artifact @@ -71,6 +73,3 @@ extends: { "label" : "bug", "displayName" : "Fixes", "state" : "closed" }, { "label" : "enhancement", "displayName": "Enhancements", "state" : "closed" } ] - - script: dotnet nuget push $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg -s https://api.nuget.org/v3/index.json --api-key $(NuGetOrgApiKey) --skip-duplicate - displayName: 📦 Push packages to nuget.org - condition: and(succeeded(), ne(variables['NuGetOrgApiKey'], '')) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 37257bb2d..b958134bd 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -33,21 +33,17 @@ extends: - checkout: none - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" displayName: ⚙️ Set pipeline name - - task: UseDotNet@2 - displayName: ⚙️ Install .NET SDK - inputs: - packageType: sdk - version: 6.x - - task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: - forceReinstallCredentialProvider: true - template: azure-pipelines/release-deployment-prep.yml@self - download: CI artifact: VSInsertion-Windows displayName: 🔻 Download VSInsertion-Windows artifact - - script: dotnet nuget push $(Pipeline.Workspace)\CI\VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate + - task: 1ES.PublishNuget@1 displayName: 📦 Push CoreXT packages to VS feed + inputs: + packagesToPush: '$(Pipeline.Workspace)/CI/VSInsertion-Windows/*.nupkg' + packageParentPath: $(Pipeline.Workspace)/CI/VSInsertion-Windows + allowPackageConflicts: true + publishVstsFeed: VS - task: MicroBuildInsertVsPayload@4 displayName: 🏭 Insert VS Payload inputs: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 8ca0b33ac..176ec1bb1 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -48,15 +48,6 @@ extends: - checkout: self clean: true fetchDepth: 1 - - task: UseDotNet@2 - displayName: ⚙️ Install .NET SDK - inputs: - packageType: sdk - version: 6.x - - task: NuGetAuthenticate@1 - displayName: 🔏 Authenticate NuGet feeds - inputs: - forceReinstallCredentialProvider: true - download: current artifact: Variables-Windows displayName: 🔻 Download Variables-Windows artifact @@ -65,9 +56,13 @@ extends: - download: current artifact: VSInsertion-Windows displayName: 🔻 Download VSInsertion-Windows artifact - - script: dotnet nuget push VSInsertion-windows\*.nupkg -s https://pkgs.dev.azure.com/devdiv/_packaging/VS/nuget/v3/index.json -k azdo --skip-duplicate + - task: 1ES.PublishNuget@1 displayName: 📦 Push CoreXT packages to VS feed - workingDirectory: $(Pipeline.Workspace) + inputs: + packagesToPush: '$(Pipeline.Workspace)/VSInsertion-Windows/*.nupkg' + packageParentPath: $(Pipeline.Workspace)/VSInsertion-Windows + allowPackageConflicts: true + publishVstsFeed: VS - task: MicroBuildInsertVsPayload@4 displayName: 🏭 Insert VS Payload inputs: From fa2fa4a1717ac1f7dfcb3bad56fd24e95a3b7184 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 20:27:23 -0700 Subject: [PATCH 0931/1753] Fix pipeline failures when tests are turned off Finishes what bb38a7296be221 started --- azure-pipelines/build.yml | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 481447b2c..89605d92a 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -97,10 +97,11 @@ jobs: outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-Linux - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux - artifactName: ${{ artifact_name }}-Linux + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-Linux + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux + artifactName: ${{ artifact_name }}-Linux steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. @@ -121,10 +122,11 @@ jobs: outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-macOS - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS - artifactName: ${{ artifact_name }}-macOS + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-macOS + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS + artifactName: ${{ artifact_name }}-macOS steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. From 20d7eb1dec040f5a086e783674d1a6c6f76e8070 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 19:55:23 -0700 Subject: [PATCH 0932/1753] Fix name of stage task --- azure-pipelines/dotnet.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 61c96a357..546e90835 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -18,7 +18,7 @@ steps: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - powershell: azure-pipelines/artifacts/_pipelines.ps1 -StageOnly -AvoidSymbolicLinks -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose failOnStderr: true - displayName: 📢 Publish artifacts + displayName: 📢 Stage artifacts condition: succeededOrFailed() - ${{ if ne(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: From aab283cf8435ed07bab3310201f528dbcd49fd36 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 20:08:30 -0700 Subject: [PATCH 0933/1753] Migrate Microbuild-required variables to a yaml file These need to be set before we have a chance to run our variable ps1 scripts. --- azure-pipelines/GlobalVariables.yml | 4 ++++ azure-pipelines/official.yml | 3 +++ azure-pipelines/variables/TeamEmail.ps1 | 1 - azure-pipelines/variables/TeamName.ps1 | 2 -- azure-pipelines/vs-insertion.yml | 5 +++-- azure-pipelines/vs-validation.yml | 5 +++-- 6 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 azure-pipelines/GlobalVariables.yml delete mode 100644 azure-pipelines/variables/TeamEmail.ps1 delete mode 100644 azure-pipelines/variables/TeamName.ps1 diff --git a/azure-pipelines/GlobalVariables.yml b/azure-pipelines/GlobalVariables.yml new file mode 100644 index 000000000..b2d1d5329 --- /dev/null +++ b/azure-pipelines/GlobalVariables.yml @@ -0,0 +1,4 @@ +variables: + # These variables are required for MicroBuild tasks + TeamName: VS IDE + TeamEmail: vsidemicrobuild@microsoft.com diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index a57cdc349..1769431ef 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -49,6 +49,9 @@ resources: name: 1ESPipelineTemplates/MicroBuildTemplate ref: refs/tags/release +variables: +- template: GlobalVariables.yml + extends: ${{ if parameters.EnableCompliance }}: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate diff --git a/azure-pipelines/variables/TeamEmail.ps1 b/azure-pipelines/variables/TeamEmail.ps1 deleted file mode 100644 index 7cf66982b..000000000 --- a/azure-pipelines/variables/TeamEmail.ps1 +++ /dev/null @@ -1 +0,0 @@ -'vsidemicrobuild@microsoft.com' diff --git a/azure-pipelines/variables/TeamName.ps1 b/azure-pipelines/variables/TeamName.ps1 deleted file mode 100644 index ba9c82310..000000000 --- a/azure-pipelines/variables/TeamName.ps1 +++ /dev/null @@ -1,2 +0,0 @@ -# This value is used as an input to the MicroBuild Insert VS task. -'VS IDE' diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index b958134bd..c948b713e 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -17,6 +17,9 @@ resources: - Real signed - auto-insertion +variables: +- template: GlobalVariables.yml + extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: @@ -47,8 +50,6 @@ extends: - task: MicroBuildInsertVsPayload@4 displayName: 🏭 Insert VS Payload inputs: - TeamName: $(TeamName) - TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) InsertionBuildPolicy: Request Perf DDRITs AutoCompletePR: true diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 176ec1bb1..062a5abfd 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -12,6 +12,9 @@ resources: name: 1ESPipelineTemplates/MicroBuildTemplate ref: refs/tags/release +variables: +- template: GlobalVariables.yml + extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: @@ -66,8 +69,6 @@ extends: - task: MicroBuildInsertVsPayload@4 displayName: 🏭 Insert VS Payload inputs: - TeamName: $(TeamName) - TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) [Skip-SymbolCheck] InsertionDescription: | This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. From 315a51ed3ed287e09d4d72cd4b4e48a285c96b9d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 18:24:12 -0700 Subject: [PATCH 0934/1753] Migrate SBOM plugin installation to the new template style --- azure-pipelines/build.yml | 3 +++ azure-pipelines/microbuild.before.yml | 4 ---- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 89605d92a..64daed4fa 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -44,6 +44,9 @@ jobs: - group: VSCloudServices-APIScan # Expected to provide ApiScanClientId, ApiScanSecret, ApiScanTenant ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: + mb: + sbom: + enabled: true outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index adb5ccc89..f5e1047f2 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -16,7 +16,3 @@ steps: zipSources: false displayName: 🔧 Install MicroBuild Signing Plugin condition: and(succeeded(), or(eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['SignType'], 'real'))) - -- task: MicroBuildSbomPlugin@1 - displayName: 🔧 Install MicroBuild Sbom Plugin - condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) From e4fed75c0386011cd6d4d177ecd1bcc22612c3d0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 6 Feb 2024 05:49:52 -0700 Subject: [PATCH 0935/1753] Bump dotnet-coverage from 17.10.1 to 17.10.2 (#250) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.10.1 to 17.10.2. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 5941f4c88..6eff0445b 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.10.1", + "version": "17.10.2", "commands": [ "dotnet-coverage" ] From 9374605db8f41fb296a391c1b73c0c2adbb06c98 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 18:24:31 -0700 Subject: [PATCH 0936/1753] Add placeholder for localization plugin It's disabled by default, but is easy to turn on. --- azure-pipelines/build.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 64daed4fa..2ef058bf6 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -47,6 +47,10 @@ jobs: mb: sbom: enabled: true + localization: + enabled: false + ${{ if eq(variables['Build.Reason'], 'pullRequest') }}: + languages: ENU,JPN outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: From 1c3dadb97af9d7211a927c4229ea07db8b7f42cf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Feb 2024 19:53:56 -0700 Subject: [PATCH 0937/1753] Migrate signing plugin installation to the new template style By requiring opt-in to sign on mac/linux, we remove the need for signing re-approval on pipelines that are already signing. It also avoids signing binaries that typically will not ship anyway. --- azure-pipelines/build.yml | 20 ++++++++++++++++++++ azure-pipelines/microbuild.before.yml | 7 ------- azure-pipelines/official.yml | 17 ++++++++++------- azure-pipelines/prepare-insertion-stages.yml | 5 ++++- azure-pipelines/variables/SignType.ps1 | 11 ----------- azure-pipelines/vs-validation.yml | 3 ++- 6 files changed, 36 insertions(+), 27 deletions(-) delete mode 100644 azure-pipelines/variables/SignType.ps1 diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 2ef058bf6..d110df1d7 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -1,4 +1,7 @@ parameters: +- name: RealSign + type: boolean + default: false - name: windowsPool type: object default: @@ -45,6 +48,13 @@ jobs: ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: mb: + signing: + enabled: true + zipSources: false + ${{ if or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }}: + signType: real + ${{ else }}: + signType: test sbom: enabled: true localization: @@ -101,6 +111,11 @@ jobs: pool: ${{ parameters.linuxPool }} ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: + mb: + ${{ if or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: @@ -126,6 +141,11 @@ jobs: pool: ${{ parameters.macOSPool }} ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: + mb: + ${{ if or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index f5e1047f2..8e9c8c6a3 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -9,10 +9,3 @@ steps: outputformat: text condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) retryCountOnTaskFailure: 3 # fails when the cloud service is overloaded - -- task: MicroBuildSigningPlugin@4 - inputs: - signType: $(SignType) - zipSources: false - displayName: 🔧 Install MicroBuild Signing Plugin - condition: and(succeeded(), or(eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['SignType'], 'real'))) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 1769431ef..3a506b910 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -20,11 +20,10 @@ trigger: # - microbuild parameters: -- name: SignTypeSelection - displayName: Sign type - type: string - default: Test - values: [ 'Test', 'Real' ] +- name: RealSign + displayName: Real sign? + type: boolean + default: false - name: includeMacOS displayName: Build on macOS type: boolean @@ -64,12 +63,12 @@ extends: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ - SignTypeSelection: ${{ parameters.SignTypeSelection }} Packaging.EnableSBOMSigning: false Codeql.Enabled: true jobs: - template: /azure-pipelines/build.yml@self parameters: + RealSign: ${{ parameters.RealSign }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES @@ -85,6 +84,8 @@ extends: includeMacOS: ${{ parameters.includeMacOS }} RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self + parameters: + RealSign: ${{ parameters.RealSign }} ${{ else }}: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: @@ -96,12 +97,12 @@ extends: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ - SignTypeSelection: ${{ parameters.SignTypeSelection }} Packaging.EnableSBOMSigning: false Codeql.Enabled: true jobs: - template: /azure-pipelines/build.yml@self parameters: + RealSign: ${{ parameters.RealSign }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES @@ -117,3 +118,5 @@ extends: includeMacOS: ${{ parameters.includeMacOS }} RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self + parameters: + RealSign: ${{ parameters.RealSign }} diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 98e5232ce..821054aac 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -2,11 +2,14 @@ parameters: - name: ArchiveSymbols type: boolean default: true +- name: RealSign + displayName: Real sign? + type: boolean stages: - stage: release displayName: Publish - condition: and(succeeded(), eq(dependencies.Build.outputs['Windows.SetPipelineVariables.SignType'], 'Real')) + condition: and(succeeded(), eq('${{ parameters.RealSign }}', 'true')) jobs: - ${{ if parameters.ArchiveSymbols }}: - job: symbol_archive diff --git a/azure-pipelines/variables/SignType.ps1 b/azure-pipelines/variables/SignType.ps1 deleted file mode 100644 index 0c1a335aa..000000000 --- a/azure-pipelines/variables/SignType.ps1 +++ /dev/null @@ -1,11 +0,0 @@ -if ($env:SYSTEM_COLLECTIONID -eq '011b8bdf-6d56-4f87-be0d-0092136884d9') { - if ($env:BUILD_REASON -eq 'Schedule') { - 'real' - } else { - if ($env:SIGNTYPESELECTION) { - $env:SIGNTYPESELECTION - } else { - 'test' - } - } - } diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 062a5abfd..742b73d72 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -26,13 +26,13 @@ extends: variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ - SignTypeSelection: Real BuildConfiguration: Release ValidationBuild: true jobs: - template: /azure-pipelines/build.yml@self parameters: + RealSign: true windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: false RunTests: false @@ -40,6 +40,7 @@ extends: - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: ArchiveSymbols: false + RealSign: ${{ parameters.RealSign }} - stage: insertion displayName: VS insertion From 0ed99f2668434d9f3519cd49791de64a3ba338df Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 6 Feb 2024 12:50:10 -0700 Subject: [PATCH 0938/1753] Bump MicroBuild to 2.0.149 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index a2ca4d224..649d94cf9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.147 + 2.0.149 From f8b892b0a524b5bfe70f0dbfd6e34d450bb0d3a4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 6 Feb 2024 18:50:57 -0700 Subject: [PATCH 0939/1753] Remove compliance tasks These are redundant with those injected by 1ES PT. --- azure-pipelines/build.yml | 6 ----- azure-pipelines/secure-development-tools.yml | 24 -------------------- 2 files changed, 30 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index d110df1d7..03fd0ff77 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -73,12 +73,6 @@ jobs: displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows artifactName: VSInsertion-Windows - # This is useful when false positives appear so we can copy some of the output into the suppressions file. - - output: pipelineArtifact - displayName: 📢 Publish Guardian failures - targetPath: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions - artifactName: guardian_failures_as_suppressions - condition: failed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 1bbacefed..ad254e212 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -30,27 +30,3 @@ steps: condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) env: AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) - -- task: SdtReport@2 - displayName: 📃 Create Security Analysis Report - inputs: - GdnExportAllTools: true - -- task: PublishSecurityAnalysisLogs@3 - displayName: 📢 Publish Code Analysis Logs - inputs: - ArtifactName: CodeAnalysisLogs - ArtifactType: Container - PublishProcessedResults: true - AllTools: true - ToolLogsNotFoundAction: Standard - -- task: PostAnalysis@2 - displayName: 🏋️‍♀️ Break on compliance issues - inputs: - GdnBreakAllTools: true - GdnBreakGdnToolBinSkimSeverity: Warning - GdnBreakSuppressionFiles: $(System.DefaultWorkingDirectory)/azure-pipelines/falsepositives.gdnsuppress - GdnBreakSuppressionSets: falsepositives - GdnBreakOutputSuppressionFile: $(Build.ArtifactStagingDirectory)/guardian_failures_as_suppressions/ - GdnBreakOutputSuppressionSet: falsepositives From 1ce395c70e63b9b6ec8464f8adf74828ddc67cf6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Feb 2024 12:17:39 -0700 Subject: [PATCH 0940/1753] Bring back PoliCheck --- azure-pipelines/secure-development-tools.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index ad254e212..b0c33cf66 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -6,6 +6,13 @@ steps: - powershell: echo "##vso[build.addbuildtag]compliance" displayName: 🏷️ Tag run with 'compliance' +- task: PoliCheck@2 + displayName: 🔍 Run PoliCheck + inputs: + targetType: F + targetArgument: $(System.DefaultWorkingDirectory) + optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml + - task: CopyFiles@2 displayName: 📂 Collect APIScan inputs inputs: From 9e2495e991734fed6c5d26df3eb7cc903fa234a6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Feb 2024 13:54:30 -0700 Subject: [PATCH 0941/1753] Drop Codeql.Enabled variable CodeQL is injected by default by the 1ES PT templates now, so we don't need this variable. --- azure-pipelines/official.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 3a506b910..68af7f75b 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -64,7 +64,6 @@ extends: BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ Packaging.EnableSBOMSigning: false - Codeql.Enabled: true jobs: - template: /azure-pipelines/build.yml@self parameters: @@ -98,7 +97,6 @@ extends: BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ Packaging.EnableSBOMSigning: false - Codeql.Enabled: true jobs: - template: /azure-pipelines/build.yml@self parameters: From 38502866e53e42f2027474bb97e90f1d0fb8ff68 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Feb 2024 14:30:26 -0700 Subject: [PATCH 0942/1753] File bugs for APIScan issues --- azure-pipelines/TSAOptions.json | 19 +++++++++++++++++++ azure-pipelines/secure-development-tools.yml | 8 ++++++++ 2 files changed, 27 insertions(+) create mode 100644 azure-pipelines/TSAOptions.json diff --git a/azure-pipelines/TSAOptions.json b/azure-pipelines/TSAOptions.json new file mode 100644 index 000000000..6dfeac4c5 --- /dev/null +++ b/azure-pipelines/TSAOptions.json @@ -0,0 +1,19 @@ +{ + "tsaVersion": "TsaV2", + "codebase": "NewOrUpdate", + "codebaseName": "LibraryName", + "tsaStamp": "DevDiv", + "tsaEnvironment": "PROD", + "notificationAliases": [ + "vsidemicrobuild@microsoft.com" + ], + "codebaseAdmins": [ + "REDMOND\\andarno" + ], + "instanceUrl": "https://devdiv.visualstudio.com", + "projectName": "DevDiv", + "areaPath": "DevDiv\\VS Core", + "iterationPath": "DevDiv", + "alltools": true, + "repositoryName": "Library.Template" +} diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index b0c33cf66..4ed67dc01 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -37,3 +37,11 @@ steps: condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) env: AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) + +# File bugs when APIScan finds issues +- task: TSAUpload@2 + displayName: 🪳 TSA upload + inputs: + GdnPublishTsaOnboard: True + GdnPublishTsaConfigFile: $(Build.SourcesDirectory)\azure-pipelines\TSAOptions.json + condition: false # enable in individual repos only AFTER updating TSAOptions.json with your own values From 863c52418aea159620ccdba978bf70cff6bfae1f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Feb 2024 14:22:20 -0700 Subject: [PATCH 0943/1753] Move Policheck to the 1ES PT --- azure-pipelines/official.yml | 10 ++++++++++ azure-pipelines/secure-development-tools.yml | 7 ------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 68af7f75b..f48535e4a 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -57,6 +57,11 @@ extends: parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + policheck: + enabled: ${{ parameters.EnableCompliance }} + exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml + suppression: + suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress stages: - stage: Build variables: @@ -90,6 +95,11 @@ extends: parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + policheck: + enabled: ${{ parameters.EnableCompliance }} + exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml + suppression: + suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress stages: - stage: Build variables: diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 4ed67dc01..9b1aeaa0b 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -6,13 +6,6 @@ steps: - powershell: echo "##vso[build.addbuildtag]compliance" displayName: 🏷️ Tag run with 'compliance' -- task: PoliCheck@2 - displayName: 🔍 Run PoliCheck - inputs: - targetType: F - targetArgument: $(System.DefaultWorkingDirectory) - optionsUEPATH: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml - - task: CopyFiles@2 displayName: 📂 Collect APIScan inputs inputs: From 42d183755210479986b9cff6075cddb7f4741e62 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 Feb 2024 14:53:54 -0700 Subject: [PATCH 0944/1753] Disable Policheck on non-compliance runs --- azure-pipelines/official.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index f48535e4a..e1a732bbc 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -58,7 +58,7 @@ extends: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES policheck: - enabled: ${{ parameters.EnableCompliance }} + enabled: true exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml suppression: suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress @@ -95,9 +95,6 @@ extends: parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES - policheck: - enabled: ${{ parameters.EnableCompliance }} - exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml suppression: suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress stages: From 3c87039a3ce8d40e48b9d5f3c3690fba33b8677a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 8 Feb 2024 11:49:42 -0700 Subject: [PATCH 0945/1753] Fix missing TeamEmail and TeamName in insertVS task --- azure-pipelines/vs-insertion.yml | 2 ++ azure-pipelines/vs-validation.yml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index c948b713e..87166f29b 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -50,6 +50,8 @@ extends: - task: MicroBuildInsertVsPayload@4 displayName: 🏭 Insert VS Payload inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) InsertionBuildPolicy: Request Perf DDRITs AutoCompletePR: true diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 742b73d72..5ebf0c71b 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -70,6 +70,8 @@ extends: - task: MicroBuildInsertVsPayload@4 displayName: 🏭 Insert VS Payload inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) [Skip-SymbolCheck] InsertionDescription: | This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. From 5e36c8bed0cc5597783a0a71c013e0f4801064f0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Feb 2024 10:06:45 -0700 Subject: [PATCH 0946/1753] Drop ComponentGovernance from the pipeline 1ES PT includes it already. --- azure-pipelines/microbuild.before.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 8e9c8c6a3..c53ae9a6b 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,7 +1,4 @@ steps: -- task: ComponentGovernanceComponentDetection@0 - displayName: 🔍 Component Detection - - task: notice@0 displayName: 🛠️ Generate NOTICE file inputs: From 218482027bd115467e5fceef14ae4a05b19fb238 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Feb 2024 10:17:56 -0700 Subject: [PATCH 0947/1753] Bring back LocBin artifact publishing --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 6a445aab2..b42c8d881 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -29,6 +29,7 @@ parameters: - build_logs - coverageResults - deployables + - LocBin - projectAssetsJson - symbols - testResults From 420207fd6383bbcea6408fdaf4f719bf8434913f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Feb 2024 19:54:55 +0000 Subject: [PATCH 0948/1753] Recommend prettier --- .prettierrc.yaml | 0 .vscode/extensions.json | 1 + 2 files changed, 1 insertion(+) create mode 100644 .prettierrc.yaml diff --git a/.prettierrc.yaml b/.prettierrc.yaml new file mode 100644 index 000000000..e69de29bb diff --git a/.vscode/extensions.json b/.vscode/extensions.json index ca3a2aa9d..acaf02131 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -7,6 +7,7 @@ "ms-dotnettools.csharp", "k--kato.docomment", "editorconfig.editorconfig", + "esbenp.prettier-vscode", "pflannery.vscode-versionlens", "davidanson.vscode-markdownlint", "dotjoshjohnson.xml", From c70b6560f101b924b4adb85cafab7048ea3e2ee0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Feb 2024 19:55:09 +0000 Subject: [PATCH 0949/1753] Identify AzP-related YAML files --- .vscode/settings.json | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index ce72437ca..efbe74f47 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -8,5 +8,16 @@ "editor.formatOnSave": true, "[xml]": { "editor.wordWrap": "off" - } + }, + // Treat these files as Azure Pipelines files + "files.associations": { + "**/azure-pipelines/**/*.yml": "azure-pipelines", + "azure-pipelines.yml": "azure-pipelines" + }, + // Use Prettier as the default formatter for Azure Pipelines files. + // Needs to be explicitly configured: https://github.com/Microsoft/azure-pipelines-vscode#document-formatting + "[azure-pipelines]": { + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": false // enable this when the conform + }, } From 823f34de13cc1f5a26a7d5186421dbe5461f2c6b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Feb 2024 13:20:43 -0700 Subject: [PATCH 0950/1753] Add missing $ characters in pipeline --- azure-pipelines/prepare-insertion-stages.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 821054aac..58218fa64 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -47,8 +47,8 @@ stages: # outputs: # - output: nuget # displayName: 📦 Push nuget packages - # packagesToPush: '(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg' - # packageParentPath: (Pipeline.Workspace)/deployables-Windows/NuGet + # packagesToPush: '$(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg' + # packageParentPath: $(Pipeline.Workspace)/deployables-Windows/NuGet # allowPackageConflicts: true # nuGetFeedType: external # publishFeedCredentials: azure-public/vs-impl From c11a28ef4247c3847f9df1de2574171401948e43 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 Feb 2024 13:40:57 -0700 Subject: [PATCH 0951/1753] Fix missing LocBin artifact on non-Windows agents --- azure-pipelines/build.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index b42c8d881..c07571b72 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -29,7 +29,6 @@ parameters: - build_logs - coverageResults - deployables - - LocBin - projectAssetsJson - symbols - testResults @@ -58,6 +57,10 @@ jobs: displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows artifactName: VSInsertion-Windows + - output: pipelineArtifact + displayName: 📢 Publish LocBin-Windows + targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows + artifactName: LocBin-Windows - output: pipelineArtifact displayName: 📢 Publish InsertionOutputs targetPath: $(Build.ArtifactStagingDirectory)/InsertionOutputs From 0f2cb2ea14fda56fbe600733c6698a694d2609c8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 12 Feb 2024 09:03:32 -0700 Subject: [PATCH 0952/1753] Bump Microsoft.NET.Test.Sdk from 17.8.0 to 17.9.0 (#251) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.8.0 to 17.9.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.8.0...v17.9.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1438548bb..3096e57cc 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ true - + From f301981ff9d11f86ad176fe99b38630452a1d0ca Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Feb 2024 15:42:31 -0700 Subject: [PATCH 0953/1753] Publish artifacts even on failed pipelines --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 03fd0ff77..1074264f0 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -69,6 +69,7 @@ jobs: displayName: 📢 Publish ${{ artifact_name }}-Windows targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Windows artifactName: ${{ artifact_name }}-Windows + condition: succeededOrFailed() - output: pipelineArtifact displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows From 09f29b8638ddcd07335f629022012229788e5c6c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Feb 2024 15:52:53 -0700 Subject: [PATCH 0954/1753] Switch job disabling style This should reduce merge conflicts going forward since the job's content doesn't entirely change just to enable it. --- azure-pipelines/prepare-insertion-stages.yml | 59 ++++++++++---------- 1 file changed, 30 insertions(+), 29 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 58218fa64..97e6117f2 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -33,32 +33,33 @@ stages: SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy azureSubscription: Symbols Upload (DevDiv) - # - job: push - # displayName: azure-public/vs-impl feed - # ${{ if parameters.ArchiveSymbols }}: - # dependsOn: symbol_archive - # pool: - # name: AzurePipelines-EO - # demands: - # - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT - # os: Linux - # templateContext: - # outputParentDirectory: $(Pipeline.Workspace) - # outputs: - # - output: nuget - # displayName: 📦 Push nuget packages - # packagesToPush: '$(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg' - # packageParentPath: $(Pipeline.Workspace)/deployables-Windows/NuGet - # allowPackageConflicts: true - # nuGetFeedType: external - # publishFeedCredentials: azure-public/vs-impl - # steps: - # - checkout: none - # - download: current - # artifact: Variables-Windows - # displayName: 🔻 Download Variables-Windows artifact - # - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 - # displayName: ⚙️ Set pipeline variables based on artifacts - # - download: current - # artifact: deployables-Windows - # displayName: 🔻 Download deployables-Windows artifact + - ${{ if false }}: # Switch to true to enable, but leave the condition to avoid merge conflicts later. + - job: push + displayName: azure-public/vs-impl feed + ${{ if parameters.ArchiveSymbols }}: + dependsOn: symbol_archive + pool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + os: Linux + templateContext: + outputParentDirectory: $(Pipeline.Workspace) + outputs: + - output: nuget + displayName: 📦 Push nuget packages + packagesToPush: '$(Pipeline.Workspace)/deployables-Windows/NuGet/*.nupkg' + packageParentPath: $(Pipeline.Workspace)/deployables-Windows/NuGet + allowPackageConflicts: true + nuGetFeedType: external + publishFeedCredentials: azure-public/vs-impl + steps: + - checkout: none + - download: current + artifact: Variables-Windows + displayName: 🔻 Download Variables-Windows artifact + - powershell: $(Pipeline.Workspace)/Variables-Windows/_pipelines.ps1 + displayName: ⚙️ Set pipeline variables based on artifacts + - download: current + artifact: deployables-Windows + displayName: 🔻 Download deployables-Windows artifact From 4ac532d55694d202c5bbda47a806121b33bebfae Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Feb 2024 14:52:59 -0700 Subject: [PATCH 0955/1753] Remove `EnableSBOMSigning` variable --- azure-pipelines/official.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index e1a732bbc..793174777 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -68,7 +68,6 @@ extends: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ - Packaging.EnableSBOMSigning: false jobs: - template: /azure-pipelines/build.yml@self parameters: @@ -103,7 +102,6 @@ extends: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ - Packaging.EnableSBOMSigning: false jobs: - template: /azure-pipelines/build.yml@self parameters: From 82795963e2a88b40faca81fe9248c63f64e75d36 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Feb 2024 15:03:30 -0700 Subject: [PATCH 0956/1753] Share variables across all entrypoints --- azure-pipelines.yml | 5 +---- azure-pipelines/BuildStageVariables.yml | 5 +++++ azure-pipelines/official.yml | 8 ++------ 3 files changed, 8 insertions(+), 10 deletions(-) create mode 100644 azure-pipelines/BuildStageVariables.yml diff --git a/azure-pipelines.yml b/azure-pipelines.yml index b4001ab97..6415847e1 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -24,10 +24,7 @@ parameters: default: true variables: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - BuildConfiguration: Release - # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ +- template: /azure-pipelines/BuildStageVariables.yml@self jobs: - template: azure-pipelines/build.yml diff --git a/azure-pipelines/BuildStageVariables.yml b/azure-pipelines/BuildStageVariables.yml new file mode 100644 index 000000000..2a6835691 --- /dev/null +++ b/azure-pipelines/BuildStageVariables.yml @@ -0,0 +1,5 @@ +variables: + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true + BuildConfiguration: Release + NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ + # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 793174777..ccb5a4d19 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -65,9 +65,7 @@ extends: stages: - stage: Build variables: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - BuildConfiguration: Release - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ + - template: /azure-pipelines/BuildStageVariables.yml@self jobs: - template: /azure-pipelines/build.yml@self parameters: @@ -99,9 +97,7 @@ extends: stages: - stage: Build variables: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - BuildConfiguration: Release - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ + - template: /azure-pipelines/BuildStageVariables.yml@self jobs: - template: /azure-pipelines/build.yml@self parameters: From 1f5f12750e115bcbeef07e4757032c2143235de1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Feb 2024 15:31:35 -0700 Subject: [PATCH 0957/1753] Fix Expand-Template.ps1 --- Expand-Template.ps1 | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 8d4c2f4b2..3367d2408 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -149,12 +149,15 @@ try { "(?m)^\s+- microbuild`r?`n"="" } Replace-Placeholders -Path "azure-pipelines\official.yml" -Replacements $YmlReplacements + Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements + + $YmlReplacements = @{} if ($CodeCovToken) { $YmlReplacements['(codecov_token: ).*(#.*)'] = "`$1$CodeCovToken" } else { $YmlReplacements['(codecov_token: ).*(#.*)'] = "#`$1`$2" } - Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements + Replace-Placeholders -Path "azure-pipelines/BuildStageVariables.yml" -Replacements $YmlReplacements Replace-Placeholders -Path "azure-pipelines/variables/InsertVersionsValues.ps1" -Replacements @{ 'LibraryName' = $LibraryName; From 64b2ae3bc6c384919e138cbd3fa50b884e073003 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Feb 2024 17:10:45 -0700 Subject: [PATCH 0958/1753] Clarify purpose of nuGetServiceConnection --- azure-pipelines/install-dependencies.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 0976e548e..dc35ceced 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -7,7 +7,7 @@ steps: displayName: 🔏 Authenticate NuGet feeds inputs: ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - nuGetServiceConnections: azure-public/msft_consumption + nuGetServiceConnections: azure-public/msft_consumption # Only necessary for GitHub-hosted repos forceReinstallCredentialProvider: true - powershell: | From 4475f937772658ebdb1e9b20752c97ec2b32cd9f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Feb 2024 17:11:33 -0700 Subject: [PATCH 0959/1753] Drop Ref12Analyze task It publishes to a web site that no longer operates. --- azure-pipelines/microbuild.after.yml | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 7531cf544..d1f322c08 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -10,19 +10,6 @@ steps: $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- task: Ref12Analyze@0 - displayName: 📑 Ref12 (Codex) Analyze - inputs: - codexoutputroot: $(Build.ArtifactStagingDirectory)\Codex - workflowArguments: | - /sourcesDirectory:$(Build.SourcesDirectory) - /codexRepoUrl:$(Build.Repository.Uri) - /repoName:$(Build.Repository.Name) - /additionalCodexArguments:-bld - /additionalCodexArguments:$(Build.ArtifactStagingDirectory)/build_logs - condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'), ne(variables['Build.Reason'], 'PullRequest'), eq(variables['Agent.OS'], 'Windows_NT')) - continueOnError: true - - ${{ if eq(parameters.EnableCompliance, 'true') }}: - template: secure-development-tools.yml parameters: From 6dc738bcb5a88209e3b4b3eaec9e0fcaee8955d7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 14 Feb 2024 13:55:09 -0700 Subject: [PATCH 0960/1753] Fix publish for scheduled pipeline runs --- azure-pipelines/build.yml | 6 +++--- azure-pipelines/official.yml | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 1074264f0..501c6269f 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -51,7 +51,7 @@ jobs: signing: enabled: true zipSources: false - ${{ if or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }}: + ${{ if parameters.RealSign }}: signType: real ${{ else }}: signType: test @@ -107,7 +107,7 @@ jobs: ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: mb: - ${{ if or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }}: + ${{ if parameters.RealSign }}: signing: enabled: false # enable when building unique artifacts on this agent that must be signed signType: real @@ -137,7 +137,7 @@ jobs: ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: mb: - ${{ if or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }}: + ${{ if parameters.RealSign }}: signing: enabled: false # enable when building unique artifacts on this agent that must be signed signType: real diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index ccb5a4d19..c28137f69 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -69,7 +69,7 @@ extends: jobs: - template: /azure-pipelines/build.yml@self parameters: - RealSign: ${{ parameters.RealSign }} + RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES @@ -86,7 +86,7 @@ extends: RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: - RealSign: ${{ parameters.RealSign }} + RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} ${{ else }}: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: @@ -101,7 +101,7 @@ extends: jobs: - template: /azure-pipelines/build.yml@self parameters: - RealSign: ${{ parameters.RealSign }} + RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES @@ -118,4 +118,4 @@ extends: RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: - RealSign: ${{ parameters.RealSign }} + RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} From a7dbfbc8acacf7293e3c46e4b7e1466c338b5fc8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Feb 2024 10:15:56 -0700 Subject: [PATCH 0961/1753] Add missing elements for turnkey localization --- azure-pipelines/artifacts/LocBin.ps1 | 15 +++++++++++++++ azure-pipelines/build.yml | 10 +++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 azure-pipelines/artifacts/LocBin.ps1 diff --git a/azure-pipelines/artifacts/LocBin.ps1 b/azure-pipelines/artifacts/LocBin.ps1 new file mode 100644 index 000000000..85bf5c7bf --- /dev/null +++ b/azure-pipelines/artifacts/LocBin.ps1 @@ -0,0 +1,15 @@ +# Identify LCE files and the binary files they describe +$BinRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") +$FilesToCopy = @() +$FilesToCopy += Get-ChildItem -Recurse -File -Path $BinRoot |? { $_.FullName -match '\\Localize\\' } + +Get-ChildItem -rec "$BinRoot\*.lce" -File | % { + $FilesToCopy += $_ + $FilesToCopy += $_.FullName.SubString(0, $_.FullName.Length - 4) +} + +$FilesToCopy += Get-ChildItem -rec "$BinRoot\*.lcg" -File | % { [xml](Get-Content $_) } | % { $_.lcx.name } + +@{ + "$BinRoot" = $FilesToCopy; +} diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 501c6269f..5d3fbd063 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -19,6 +19,9 @@ parameters: - name: RunTests type: boolean default: true +- name: EnableLocalization + type: boolean + default: false - name: EnableCompliance type: boolean default: false @@ -58,7 +61,7 @@ jobs: sbom: enabled: true localization: - enabled: false + enabled: ${{ parameters.EnableLocalization }} ${{ if eq(variables['Build.Reason'], 'pullRequest') }}: languages: ENU,JPN outputParentDirectory: $(Build.ArtifactStagingDirectory) @@ -74,6 +77,11 @@ jobs: displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows artifactName: VSInsertion-Windows + - ${{ if parameters.EnableLocalization }}: + - output: pipelineArtifact + displayName: 📢 Publish LocBin-Windows + targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows + artifactName: LocBin-Windows steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. From c7fe3ec5099b2c7648ed53f78b040d9d91adfadf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Feb 2024 11:36:08 -0700 Subject: [PATCH 0962/1753] Fix LocBin to not fail before a build occurs --- azure-pipelines/artifacts/LocBin.ps1 | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/artifacts/LocBin.ps1 b/azure-pipelines/artifacts/LocBin.ps1 index 85bf5c7bf..3b6945f71 100644 --- a/azure-pipelines/artifacts/LocBin.ps1 +++ b/azure-pipelines/artifacts/LocBin.ps1 @@ -1,5 +1,7 @@ # Identify LCE files and the binary files they describe $BinRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..\bin") +if (!(Test-Path $BinRoot)) { return } + $FilesToCopy = @() $FilesToCopy += Get-ChildItem -Recurse -File -Path $BinRoot |? { $_.FullName -match '\\Localize\\' } From 988ff3298ea7d13cd2a4631e2c041d0c53a9e608 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Feb 2024 11:45:52 -0700 Subject: [PATCH 0963/1753] Drop `outputParentDirectory` from release pipelines Setting it to `$(Pipeline.Workspace)` was problematic because it included other files dropped by 1ES PT that credscan then failed on (go figure). And anyway, these jobs have only one output so there's no reason to specify `outputParentDirectory` as no optimization is applicable. --- azure-pipelines/prepare-insertion-stages.yml | 1 - azure-pipelines/release.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 97e6117f2..6ffff5313 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -44,7 +44,6 @@ stages: - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT os: Linux templateContext: - outputParentDirectory: $(Pipeline.Workspace) outputs: - output: nuget displayName: 📦 Push nuget packages diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 8b3717718..7444d7d3c 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -30,7 +30,6 @@ extends: - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT os: Linux templateContext: - outputParentDirectory: $(Pipeline.Workspace) outputs: - output: nuget displayName: 📦 Push packages to nuget.org From e5c43bf44a89dc508fc2a48d26359e8fefa23b53 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Feb 2024 11:53:59 -0700 Subject: [PATCH 0964/1753] Fix release pipeline --- azure-pipelines/release.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 7444d7d3c..2da6ddf01 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -14,6 +14,9 @@ resources: tags: - auto-release +variables: +- template: GlobalVariables.yml + extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: From aa19fdde1dbd4cbb0c2ee4f353563481b8f6d2ea Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 19 Feb 2024 07:35:40 -0700 Subject: [PATCH 0965/1753] Bump .NET SDK from 8.0.100 to 8.0.201 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index b680b1dbc..34e569080 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:8.0.100-jammy +FROM mcr.microsoft.com/dotnet/sdk:8.0.201-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index d24a9b70b..2565f2363 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "8.0.100", + "version": "8.0.201", "rollForward": "patch", "allowPrerelease": false } From 4d78e3c1af91d81e9ed7baac5f2c92ef81b859ca Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 Feb 2024 07:36:25 -0700 Subject: [PATCH 0966/1753] Bump xunit.runner.visualstudio from 2.5.6 to 2.5.7 (#254) Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.5.6 to 2.5.7. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/compare/2.5.6...2.5.7) --- updated-dependencies: - dependency-name: xunit.runner.visualstudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 3096e57cc..32271e50f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 4540dc53c2e406f83a3a547da0f77d31a04591a6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 Feb 2024 07:36:45 -0700 Subject: [PATCH 0967/1753] Bump dotnet-coverage from 17.10.2 to 17.10.3 (#252) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.10.2 to 17.10.3. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 6eff0445b..dfd00e462 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.10.2", + "version": "17.10.3", "commands": [ "dotnet-coverage" ] From 7dec0100751f801cd01cea01bac5f12db6ecf504 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 19 Feb 2024 14:43:08 +0000 Subject: [PATCH 0968/1753] Bump xunit from 2.6.6 to 2.7.0 (#253) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 32271e50f..60ffd9224 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ - + From 9651284db829b94d40ee6e342fcba7f9873935cb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 12:34:45 -0700 Subject: [PATCH 0969/1753] Add team as reviewer for insertion PRs --- azure-pipelines/variables/InsertReviewers.ps1 | 12 ------------ azure-pipelines/vs-insertion.yml | 1 + 2 files changed, 1 insertion(+), 12 deletions(-) delete mode 100644 azure-pipelines/variables/InsertReviewers.ps1 diff --git a/azure-pipelines/variables/InsertReviewers.ps1 b/azure-pipelines/variables/InsertReviewers.ps1 deleted file mode 100644 index 6fd6648b0..000000000 --- a/azure-pipelines/variables/InsertReviewers.ps1 +++ /dev/null @@ -1,12 +0,0 @@ -# This is a list of AzDO account names or email addresses. -# Add your team DL and/or whoever should be notified of insertion PRs. -$contacts = ,$env:BUILD_REQUESTEDFOREMAIL - -if (Test-Path "$PSScriptRoot\TeamEmail.ps1") { - $contacts += & "$PSScriptRoot\TeamEmail.ps1" -} - -$contacts = $contacts |? { $_ } -if ($contacts) { - [string]::Join(',', $contacts) -} diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 87166f29b..9cb597eab 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -54,6 +54,7 @@ extends: TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) InsertionBuildPolicy: Request Perf DDRITs + InsertionReviewers: $(TeamEmail),$(Build.RequestedForEmail) AutoCompletePR: true AutoCompleteMergeStrategy: Squash - powershell: | From be633596de5cb11efe41e2094ec61eb7a8a7549f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 13:00:09 -0700 Subject: [PATCH 0970/1753] Couple APIScan and TSAUpload under the same switch --- azure-pipelines/official.yml | 2 +- azure-pipelines/secure-development-tools.yml | 39 ++++++++++---------- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index c28137f69..8cdf3afb0 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -39,7 +39,7 @@ parameters: - name: EnableAPIScan displayName: Include APIScan with Compliance tools type: boolean - default: true + default: false # enable in individual repos only AFTER updating TSAOptions.json with your own values resources: repositories: diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml index 9b1aeaa0b..409f48d0b 100644 --- a/azure-pipelines/secure-development-tools.yml +++ b/azure-pipelines/secure-development-tools.yml @@ -1,5 +1,7 @@ parameters: - EnableAPIScan: +- name: EnableAPIScan + type: boolean + default: false steps: @@ -19,22 +21,21 @@ steps: !**/osx*/** TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs -- task: APIScan@2 - displayName: 🔍 Run APIScan - inputs: - softwareFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs - softwareName: $(SymbolsFeatureName) - softwareVersionNum: $(NBGV_MajorMinorVersion) - isLargeApp: false - toolVersion: Latest - condition: and(succeeded(), ${{ parameters.EnableAPIScan }}, ne(variables.ApiScanClientId, '')) - env: - AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) +- ${{ if parameters.EnableAPIScan }}: + - task: APIScan@2 + displayName: 🔍 Run APIScan + inputs: + softwareFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs + softwareName: $(SymbolsFeatureName) + softwareVersionNum: $(NBGV_MajorMinorVersion) + isLargeApp: false + toolVersion: Latest + env: + AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) -# File bugs when APIScan finds issues -- task: TSAUpload@2 - displayName: 🪳 TSA upload - inputs: - GdnPublishTsaOnboard: True - GdnPublishTsaConfigFile: $(Build.SourcesDirectory)\azure-pipelines\TSAOptions.json - condition: false # enable in individual repos only AFTER updating TSAOptions.json with your own values + # File bugs when APIScan finds issues + - task: TSAUpload@2 + displayName: 🪳 TSA upload + inputs: + GdnPublishTsaOnboard: True + GdnPublishTsaConfigFile: $(Build.SourcesDirectory)\azure-pipelines\TSAOptions.json From c1c0f767a2be0884351bba2e0807a77466dda678 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 13:33:28 -0700 Subject: [PATCH 0971/1753] Drop RichNav task --- azure-pipelines.yml | 1 - azure-pipelines/richnav.yml | 20 -------------------- 2 files changed, 21 deletions(-) delete mode 100644 azure-pipelines/richnav.yml diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 98f4cbb27..5806f6947 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -35,4 +35,3 @@ jobs: includeMacOS: ${{ parameters.includeMacOS }} ShouldSkipOptimize: RunTests: ${{ parameters.RunTests }} -- template: azure-pipelines/richnav.yml diff --git a/azure-pipelines/richnav.yml b/azure-pipelines/richnav.yml deleted file mode 100644 index 716184f6f..000000000 --- a/azure-pipelines/richnav.yml +++ /dev/null @@ -1,20 +0,0 @@ -jobs: -- job: RichCodeNavUpload - displayName: Rich Code Navigation Upload to Production - pool: - vmImage: windows-2022 - steps: - - template: install-dependencies.yml - - task: VSBuild@1 - displayName: Build Visual Studio solution - inputs: - msbuildArgs: /t:build /m /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog" - platform: Any CPU - configuration: $(BuildConfiguration) - - task: RichCodeNavIndexer@0 - displayName: RichCodeNav Upload - inputs: - languages: 'csharp' - environment: production - isPrivateFeed: false - continueOnError: true From 56f91e1ff4c4cd55b059a0842d9317b251845c5c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 13 Feb 2024 17:10:21 -0700 Subject: [PATCH 0972/1753] Add OptProf support to Library.Template --- Expand-Template.ps1 | 13 ++ azure-pipelines.yml | 1 + .../InsertionMetadataPackage.nuspec | 16 ++ azure-pipelines/OptProf.yml | 112 +++++++++++ azure-pipelines/OptProf_part2.yml | 89 ++++++++ azure-pipelines/ProfilingInputs.props | 5 + azure-pipelines/artifacts/VSInsertion.ps1 | 40 +++- azure-pipelines/build.yml | 190 +++++++++++------- azure-pipelines/dotnet.yml | 24 ++- azure-pipelines/microbuild.after.yml | 36 +++- azure-pipelines/microbuild.before.yml | 37 ++++ azure-pipelines/official.yml | 8 + .../variables/ProfilingInputsDropName.ps1 | 5 + azure-pipelines/vs-validation.yml | 1 + 14 files changed, 484 insertions(+), 93 deletions(-) create mode 100644 azure-pipelines/InsertionMetadataPackage.nuspec create mode 100644 azure-pipelines/OptProf.yml create mode 100644 azure-pipelines/OptProf_part2.yml create mode 100644 azure-pipelines/ProfilingInputs.props create mode 100644 azure-pipelines/variables/ProfilingInputsDropName.ps1 diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 3367d2408..da2f6b7e8 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -168,6 +168,19 @@ try { 'LibraryName' = $LibraryName; } + Replace-Placeholders -Path "azure-pipelines/InsertionMetadataPackage.nuspec" -Replacements @{ + 'LibraryName' = $LibraryName; + } + Replace-Placeholders -Path "azure-pipelines/artifacts/VSInsertion.ps1" -Replacements @{ + 'LibraryName' = $LibraryName; + } + Replace-Placeholders -Path "azure-pipelines/OptProf.yml" -Replacements @{ + 'LibraryName' = $LibraryName; + } + Replace-Placeholders -Path "azure-pipelines/OptProf_part2.yml" -Replacements @{ + 'LibraryName' = $LibraryName; + } + # Self destruct git rm Expand-Template.* Apply-Template.ps1 if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 6415847e1..e6ceafef6 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -29,5 +29,6 @@ variables: jobs: - template: azure-pipelines/build.yml parameters: + Is1ESPT: false includeMacOS: ${{ parameters.includeMacOS }} RunTests: ${{ parameters.RunTests }} diff --git a/azure-pipelines/InsertionMetadataPackage.nuspec b/azure-pipelines/InsertionMetadataPackage.nuspec new file mode 100644 index 000000000..f7aa3e3f6 --- /dev/null +++ b/azure-pipelines/InsertionMetadataPackage.nuspec @@ -0,0 +1,16 @@ + + + + LibraryName.VSInsertionMetadata + $version$ + Microsoft + Microsoft + + false + Contains metadata for insertion into VS. + © Microsoft Corporation. All rights reserved. + + + + + diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml new file mode 100644 index 000000000..6d81439a1 --- /dev/null +++ b/azure-pipelines/OptProf.yml @@ -0,0 +1,112 @@ +trigger: none +pr: none +schedules: +- cron: "0 3 * * Fri" # Thu @ 8 or 9 PM Mountain Time (depending on DST) + displayName: Weekly OptProf run + branches: + include: + - 'v*.*' + - main + always: true # we must keep data fresh since optimizationdata drops are purged after 30 days + +# Avoid errant CI builds: https://developercommunity.visualstudio.com/content/problem/1154409/azure-pipeline-is-triggering-due-to-events-that-ne.html +#resources: +# repositories: +# - repository: scripts +# type: git +# name: DeploymentScripts +# ref: refs/heads/test + +variables: +- template: GlobalVariables.yml +- name: PublicRelease + value: false # avoid using nice version since we're building a preliminary/unoptimized package +- name: IsOptProf + value: true + +stages: +- stage: Library + variables: + - name: OptProf + value: true + - template: BuildStageVariables.yml + jobs: + - template: build.yml + parameters: + Is1ESPT: false + RealSign: true + EnableLocalization: false + EnableCompliance: false + windowsPool: VSEngSS-MicroBuild2022-1ES + includeMacOS: false + ShouldSkipOptimize: true + IsOptProf: true + RunTests: false +- stage: QueueVSBuild + jobs: + - job: QueueOptProf + pool: VSEngSS-MicroBuild2022-1ES + variables: + InsertPayloadName: LibraryName + InsertTopicBranch: team/VS-IDE/LibraryName-OptProf-run-$(Build.BuildId) + steps: + - checkout: none # We don't need source from our own repo + clean: true + + # Pipeline YAML does not yet support checking out other repos. So we'll do it by hand. +# - checkout: scripts # We DO need source from the DeploymentScripts repo +# clean: true +# path: $(Agent.TempDirectory)/DeploymentScripts +# fetchDepth: 1 + - script: 'git -c http.extraheader="AUTHORIZATION: bearer $(System.AccessToken)" clone https://devdiv.visualstudio.com/DevDiv/_git/DeploymentScripts --depth 1 --branch test "$(Agent.TempDirectory)/DeploymentScripts"' + displayName: Download DeploymentScripts repo + + - task: DownloadBuildArtifacts@0 + displayName: Download insertion artifacts + inputs: + artifactName: VSInsertion-Windows + downloadPath: $(Agent.TempDirectory) + - task: DownloadBuildArtifacts@0 + displayName: Download variables artifacts + inputs: + artifactName: Variables-Windows + downloadPath: $(Agent.TempDirectory) + - task: PowerShell@2 + displayName: Set pipeline variables based on artifacts + inputs: + targetType: filePath + filePath: $(Agent.TempDirectory)/Variables-Windows/_pipelines.ps1 + - task: NuGetCommand@2 + displayName: Push CoreXT packages to VS feed + inputs: + command: push + packagesToPush: $(Agent.TempDirectory)/VSInsertion-Windows/*.nupkg + publishVstsFeed: 97a41293-2972-4f48-8c0e-05493ae82010 # VS feed + allowPackageConflicts: true + - task: MicroBuildInsertVsPayload@4 + displayName: Insert VS Payload + inputs: + SkipCreatePR: true + CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 + - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 + displayName: Trigger a new build of DD-CB-TestSignVS-devCI + inputs: + buildDefinition: DD-CB-TestSignVS-devCI + useSameBranch: false + branchToUse: $(InsertTopicBranch) + storeInEnvironmentVariable: true + queueBuildForUserThatTriggeredBuild: false + authenticationMethod: OAuth Token + password: $(System.AccessToken) + - task: PowerShell@2 + displayName: Associate InsertionOutputs artifacts with CloudBuild + inputs: + targetType: filePath + filePath: $(Agent.TempDirectory)/DeploymentScripts/Scripts/Insertion/WriteArtifact.ps1 + arguments: '-oldBuildID $(Build.BuildId) -newBuildID $(TriggeredBuildIds) -artifactName "InsertionOutputs" -accessToken $(System.AccessToken)' + - task: PowerShell@2 + displayName: Tag the build with LibraryName-insertion + inputs: + targetType: filePath + filePath: $(Agent.TempDirectory)/DeploymentScripts/Scripts/Insertion/TagBuild.ps1 + arguments: '-buildID $(TriggeredBuildIds) -tagName "LibraryName-insertion" -accessToken $(System.AccessToken)' diff --git a/azure-pipelines/OptProf_part2.yml b/azure-pipelines/OptProf_part2.yml new file mode 100644 index 000000000..60ac39b86 --- /dev/null +++ b/azure-pipelines/OptProf_part2.yml @@ -0,0 +1,89 @@ +trigger: none +pr: none + +resources: + pipelines: + - pipeline: VisualStudioBuildUnderTest + source: DD-CB-TestSignVS-devCI + trigger: + tags: + - LibraryName-insertion + - pipeline: DartLab + source: DartLab + branch: main + - pipeline: DartLab.OptProf + source: DartLab.OptProf + branch: main + repositories: + - repository: DartLabTemplates + type: git + name: DartLab.Templates + ref: refs/heads/main + - repository: DartLabOptProfTemplates + type: git + name: DartLab.OptProf + ref: refs/heads/main + +parameters: + +# The prefix naming of the OptimizationInputs drop +- name: optimizationDropPrefix + type: string + default: OptimizationInputs/$(System.TeamProject)/$(Build.Repository.Name) + +stages: +- template: \templates\stages\visual-studio\single-runsettings.yml@DartLabOptProfTemplates + parameters: + ##### Required ##### + runSettingsURI: $(Pipeline.Workspace)\VisualStudioBuildUnderTest\BuildArtifacts\runsettings\LibraryName.OptProf.runsettings + visualStudioBootstrapperURI: https://vsdrop.corp.microsoft.com/file/v1/$(VisualStudio.BuildUnderTest.ProductsDropName);bootstrappers/Enterprise/vs_enterprise.exe + ##### Optional ##### + name: OptProfProfilingWorkflow + displayName: OptProf Profiling Workflow + optOptimizationInputsDropName: $(OptimizationInputsDropName) + previousOptimizationInputsDropName: $(PreviousOptimizationInputsDropName) + testLabPoolName: VS-Platform + ##### Step Hooks ##### + preTestMachineConfigurationStepList: + - download: VisualStudioBuildUnderTest + - task: PowerShell@2 + name: SetProductsDropName + displayName: Set 'VisualStudio.BuildUnderTest.ProductsDropName' + inputs: + filePath: $(DartLab.Path)\Scripts\VisualStudio\Build\Get-VisualStudioDropName.ps1 + arguments: -DropNamePrefix 'Products' -VstsDropUrlsJson '$(Pipeline.Workspace)\VisualStudioBuildUnderTest\BuildArtifacts\VstsDropUrls.json' -OutVariableName 'VisualStudio.BuildUnderTest.ProductsDropName' + preDeployAndRunTestsStepList: + - download: VisualStudioBuildUnderTest + prePublishOptimizationInputsDropStepList: + # Set parameter for PreviousOptimizationInputsDropName, MicroBuildCommitID, and OptimizationInputsDropName + - powershell: | + try { + $artifactName = 'InsertionOutputs' + $BuildID = $(resources.pipeline.VisualStudioBuildUnderTest.runID) + $artifact = Get-BuildArtifact -InstanceURL 'https://dev.azure.com/devdiv' -ProjectName 'DevDiv' -BuildID $BuildID -ArtifactName $artifactName -OAuthAccessToken (ConvertTo-SecureString '$(System.AccessToken)' -AsPlainText -Force) + $containerName = $artifact.Resource.Data -Split '/' | Select-Object -Last 1 + $fileName = Join-Path $containerName 'Metadata.json' + $jsonString = Read-BuildArtifactFile -InstanceURL 'https://dev.azure.com/devdiv' -ProjectName 'DevDiv' -BuildID $BuildID -ArtifactName $artifactName -FileName $fileName -OAuthAccessToken (ConvertTo-SecureString '$(System.AccessToken)' -AsPlainText -Force) + $json = $jsonString | ConvertFrom-Json + + Write-Host "The content of the metadata.json file was $json" + + $dropname = $json.OptimizationData + $commitID = $json.CommitID + $OptimizationInputsDropName = "${{parameters.optimizationDropPrefix}}/$($commitID)/$(Build.BuildId)/$(System.StageId)/$(System.StageAttempt)" + + Write-Host "PreviousOptimizationInputsDropName: $dropname" + Set-AzurePipelinesVariable 'PreviousOptimizationInputsDropName' $dropname + + Write-Host "MicroBuildCommitID: $commitID" + Set-AzurePipelinesVariable 'MicroBuildCommitID' $commitID + + Write-Host "OptimizationInputsDropName: $OptimizationInputsDropName" + Set-AzurePipelinesVariable 'OptimizationInputsDropName' $OptimizationInputsDropName + } + catch { + Write-Host $_ + Write-Error "Failed to set OptimizationInputsDropName pipeline variable" + throw + } + displayName: Set MicroBuildCommitID, PreviousOptimizationInputsDropName, and OptimizationInputsDropName diff --git a/azure-pipelines/ProfilingInputs.props b/azure-pipelines/ProfilingInputs.props new file mode 100644 index 000000000..fb19d6048 --- /dev/null +++ b/azure-pipelines/ProfilingInputs.props @@ -0,0 +1,5 @@ + + + + + diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index ba6af3205..4757c9c27 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -16,13 +16,43 @@ if (!$BuildConfiguration) { $BuildConfiguration = 'Debug' } -$PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" +$NuGetPackages = "$RepoRoot/bin/Packages/$BuildConfiguration/NuGet" -if (!(Test-Path $PackagesRoot)) { - Write-Warning "Skipping because packages haven't been built yet." +if (!(Test-Path $NuGetPackages)) { + Write-Warning "Skipping because NuGet packages haven't been built yet." return @{} } -@{ - "$PackagesRoot" = (Get-ChildItem $PackagesRoot -Recurse) +$result = @{ + "$NuGetPackages" = (Get-ChildItem $NuGetPackages -Recurse) } + +if ($env:IsOptProf) { + $CoreXTPackages = "$RepoRoot/bin/Packages/$BuildConfiguration/CoreXT" + + $ArtifactBasePath = "$RepoRoot\obj\_artifacts" + $ArtifactPath = "$ArtifactBasePath\VSInsertion" + if (-not (Test-Path $ArtifactPath)) { New-Item -ItemType Directory -Path $ArtifactPath | Out-Null } + + $profilingInputs = [xml](Get-Content -Path "$PSScriptRoot\..\ProfilingInputs.props") + $profilingInputs.Project.ItemGroup.TestStore.Include = "vstsdrop:" + (& "$PSScriptRoot\..\variables\ProfilingInputsDropName.ps1") + $profilingInputs.Save("$ArtifactPath\ProfilingInputs.props") + + $InsertionMetadataVersion = $(dotnet tool run nbgv get-version -p "$RepoRoot\src" -f json | ConvertFrom-Json).NuGetPackageVersion + if ($env:BUILD_BUILDID) { + # We must ensure unique versions for the insertion metadata package so + # it can contain information that is unique to this build. + # In particular it includes the ProfilingInputsDropName, which contains the BuildId. + # A non-unique package version here may collide with a prior run of this same commit, + # ultimately resulting in a failure of the optprof run. + $InsertionMetadataVersion += '.' + $env:BUILD_BUILDID + } + & (& "$PSScriptRoot\..\Get-NuGetTool.ps1") pack "$PSScriptRoot\..\InsertionMetadataPackage.nuspec" -OutputDirectory $CoreXTPackages -BasePath $ArtifactPath -Version $InsertionMetadataVersion | Out-Null + if ($LASTEXITCODE -ne 0) { + exit $LASTEXITCODE + } + + $result["$CoreXTPackages"] = (Get-ChildItem "$CoreXTPackages\LibraryName.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); +} + +$result diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5d3fbd063..95f3b9d4d 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -1,4 +1,6 @@ parameters: +- name: Is1ESPT + type: boolean - name: RealSign type: boolean default: false @@ -16,6 +18,15 @@ parameters: vmImage: macOS-12 - name: includeMacOS type: boolean +- name: EnableOptProf + type: boolean + default: false +- name: IsOptProf + type: boolean + default: false +- name: ShouldSkipOptimize + type: boolean + default: false - name: RunTests type: boolean default: true @@ -64,6 +75,21 @@ jobs: enabled: ${{ parameters.EnableLocalization }} ${{ if eq(variables['Build.Reason'], 'pullRequest') }}: languages: ENU,JPN + optprof: + enabled: ${{ parameters.EnableOptProf }} + ProfilingInputsDropName: $(ProfilingInputsDropName) + OptimizationInputsLookupMethod: DropPrefix + DropNamePrefix: OptimizationInputs/$(System.TeamProject)/$(Build.Repository.Name) + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + AccessToken: $(System.AccessToken) + mbpresteps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - ${{ if parameters.EnableOptProf }}: + - powershell: Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSDROPNAME]$(azure-pipelines/variables/ProfilingInputsDropName.ps1)" + displayName: ⚙ Set ProfilingInputsDropName for optprof + outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: @@ -83,10 +109,6 @@ jobs: targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows artifactName: LocBin-Windows steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - ${{ if eq(variables['Build.Reason'], 'Schedule') }}: - template: schedule-only-steps.yml @@ -97,94 +119,106 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.before.yml + parameters: + EnableLocalization: ${{ parameters.EnableLocalization }} + EnableOptProf: ${{ parameters.EnableOptProf }} + IsOptProf: ${{ parameters.IsOptProf }} + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - template: dotnet.yml parameters: + Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} + IsOptProf: ${{ parameters.IsOptProf }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml parameters: EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} + EnableOptProf: ${{ parameters.EnableOptProf }} + IsOptProf: ${{ parameters.IsOptProf }} - template: expand-template.yml -- job: Linux - pool: ${{ parameters.linuxPool }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - templateContext: - mb: - ${{ if parameters.RealSign }}: - signing: - enabled: false # enable when building unique artifacts on this agent that must be signed - signType: real - outputParentDirectory: $(Build.ArtifactStagingDirectory) - outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-Linux - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux - artifactName: ${{ artifact_name }}-Linux - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - - template: dotnet.yml - parameters: - RunTests: ${{ parameters.RunTests }} - - script: dotnet format --verify-no-changes --no-restore - displayName: 💅 Verify formatted code - - template: expand-template.yml +- ${{ if not(parameters.IsOptProf) }}: + - job: Linux + pool: ${{ parameters.linuxPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + mb: + ${{ if parameters.RealSign }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-Linux + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux + artifactName: ${{ artifact_name }}-Linux + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + - template: dotnet.yml + parameters: + Is1ESPT: ${{ parameters.Is1ESPT }} + RunTests: ${{ parameters.RunTests }} + - script: dotnet format --verify-no-changes --no-restore + displayName: 💅 Verify formatted code + - template: expand-template.yml -- job: macOS - condition: ${{ parameters.includeMacOS }} - pool: ${{ parameters.macOSPool }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - templateContext: - mb: - ${{ if parameters.RealSign }}: - signing: - enabled: false # enable when building unique artifacts on this agent that must be signed - signType: real - outputParentDirectory: $(Build.ArtifactStagingDirectory) - outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-macOS - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS - artifactName: ${{ artifact_name }}-macOS - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - - template: dotnet.yml - parameters: - RunTests: ${{ parameters.RunTests }} - - template: expand-template.yml + - job: macOS + condition: ${{ parameters.includeMacOS }} + pool: ${{ parameters.macOSPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + mb: + ${{ if parameters.RealSign }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-macOS + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS + artifactName: ${{ artifact_name }}-macOS + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + - template: dotnet.yml + parameters: + Is1ESPT: ${{ parameters.Is1ESPT }} + RunTests: ${{ parameters.RunTests }} + - template: expand-template.yml -- job: WrapUp - dependsOn: - - Windows - - Linux - - macOS - pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). - condition: succeededOrFailed() - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - parameters: - initArgs: -NoRestore - - template: publish-symbols.yml - parameters: - includeMacOS: ${{ parameters.includeMacOS }} - - ${{ if parameters.RunTests }}: - - template: publish-codecoverage.yml + - job: WrapUp + dependsOn: + - Windows + - Linux + - macOS + pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). + condition: succeededOrFailed() + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + parameters: + initArgs: -NoRestore + - template: publish-symbols.yml parameters: includeMacOS: ${{ parameters.includeMacOS }} + - ${{ if parameters.RunTests }}: + - template: publish-codecoverage.yml + parameters: + includeMacOS: ${{ parameters.includeMacOS }} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 546e90835..3f4ac7534 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,27 +1,37 @@ parameters: - RunTests: +- name: RunTests +- name: IsOptProf + type: boolean + default: false +- name: Is1ESPT + type: boolean steps: - script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnaserror /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: 🛠 dotnet build -- powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults - displayName: 🧪 dotnet test - condition: and(succeeded(), ${{ parameters.RunTests }}) +- ${{ if not(parameters.IsOptProf) }}: + - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults + displayName: 🧪 dotnet test + condition: and(succeeded(), ${{ parameters.RunTests }}) + +- ${{ if parameters.IsOptProf }}: + # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertConfigValues.ps1 to notice. + - powershell: azure-pipelines\artifacts\VSInsertion.ps1 + displayName: 🔧 Prepare VSInsertion artifact - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: ⚙ Update pipeline variables based on build outputs condition: succeededOrFailed() -- ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: +- ${{ if parameters.Is1ESPT }}: - powershell: azure-pipelines/artifacts/_pipelines.ps1 -StageOnly -AvoidSymbolicLinks -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose failOnStderr: true displayName: 📢 Stage artifacts condition: succeededOrFailed() - -- ${{ if ne(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: +- ${{ else }}: - powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose failOnStderr: true displayName: 📢 Publish artifacts diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index d1f322c08..f9698e3ee 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,6 +1,16 @@ parameters: - EnableCompliance: - EnableAPIScan: +- name: EnableCompliance + type: boolean + default: false +- name: EnableAPIScan + type: boolean + default: false +- name: EnableOptProf + type: boolean + default: false +- name: IsOptProf + type: boolean + default: false steps: - task: MicroBuildCodesignVerify@3 @@ -10,7 +20,27 @@ steps: $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- ${{ if eq(parameters.EnableCompliance, 'true') }}: +- ${{ if parameters.EnableOptProf }}: + - task: ms-vscs-artifact.build-tasks.artifactDropTask-1.artifactDropTask@0 + inputs: + dropServiceURI: https://devdiv.artifacts.visualstudio.com + buildNumber: $(ProfilingInputsDropName) + sourcePath: $(Build.ArtifactStagingDirectory)\OptProf\ProfilingInputs + toLowerCase: false + usePat: true + displayName: 📢 Publish to Artifact Services - ProfilingInputs + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) + continueOnError: true + + - ${{ if parameters.IsOptProf }}: + - task: PublishBuildArtifacts@1 + inputs: + PathtoPublish: $(Build.ArtifactStagingDirectory)/InsertionOutputs + ArtifactName: InsertionOutputs + ArtifactType: Container + displayName: 📢 Publish InsertionOutputs as Azure DevOps artifacts + +- ${{ if parameters.EnableCompliance }}: - template: secure-development-tools.yml parameters: EnableAPIScan: ${{ parameters.EnableAPIScan }} diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index c53ae9a6b..949b1b47e 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -1,3 +1,17 @@ +parameters: +- name: EnableLocalization + type: boolean + default: false +- name: EnableOptProf + type: boolean + default: false +- name: IsOptProf + type: boolean + default: false +- name: ShouldSkipOptimize + type: boolean + default: false + steps: - task: notice@0 displayName: 🛠️ Generate NOTICE file @@ -6,3 +20,26 @@ steps: outputformat: text condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) retryCountOnTaskFailure: 3 # fails when the cloud service is overloaded + +- ${{ if parameters.IsOptProf }}: + # We have to install these plugins ourselves for Optprof runs because those pipelines haven't migrated to 1ES PT yet. + - task: MicroBuildOptProfPlugin@6 + inputs: + ProfilingInputsDropName: $(ProfilingInputsDropName) + OptimizationInputsLookupMethod: DropPrefix + DropNamePrefix: OptimizationInputs/$(System.TeamProject)/$(Build.Repository.Name) + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + AccessToken: $(System.AccessToken) + displayName: 🔧 Install OptProf Plugin + + - task: MicroBuildSigningPlugin@4 + inputs: + signType: Real + zipSources: false + displayName: 🔧 Install MicroBuild Signing Plugin + + - ${{ if parameters.EnableLocalization }}: + - task: MicroBuildLocalizationPlugin@4 + inputs: + languages: $(LocLanguages) + displayName: 🔧 Install MicroBuild Localization Plugin diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index c28137f69..ed9a0acaa 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -24,6 +24,10 @@ parameters: displayName: Real sign? type: boolean default: false +# - name: ShouldSkipOptimize # Enable this when setting EnableOptProf to true in build.yml. +# displayName: Skip OptProf optimization +# type: boolean +# default: false - name: includeMacOS displayName: Build on macOS type: boolean @@ -69,7 +73,9 @@ extends: jobs: - template: /azure-pipelines/build.yml@self parameters: + Is1ESPT: true RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES @@ -101,7 +107,9 @@ extends: jobs: - template: /azure-pipelines/build.yml@self parameters: + Is1ESPT: true RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES diff --git a/azure-pipelines/variables/ProfilingInputsDropName.ps1 b/azure-pipelines/variables/ProfilingInputsDropName.ps1 new file mode 100644 index 000000000..88d21f699 --- /dev/null +++ b/azure-pipelines/variables/ProfilingInputsDropName.ps1 @@ -0,0 +1,5 @@ +if ($env:SYSTEM_TEAMPROJECT) { + "ProfilingInputs/$env:SYSTEM_TEAMPROJECT/$env:BUILD_REPOSITORY_NAME/$env:BUILD_SOURCEBRANCHNAME/$env:BUILD_BUILDID" +} else { + Write-Warning "No Azure Pipelines build detected. No Azure Pipelines drop name will be computed." +} diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 5ebf0c71b..195bfff33 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -32,6 +32,7 @@ extends: jobs: - template: /azure-pipelines/build.yml@self parameters: + Is1ESPT: true RealSign: true windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: false From 3dd7fab92b6aa1a7c7b9796900ce6bc525c01372 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 13:05:15 -0700 Subject: [PATCH 0973/1753] Disable NOTICE file generation for OptProf runs Just a little something to make optprof runs a little more reliable. --- azure-pipelines/build.yml | 1 + azure-pipelines/microbuild.before.yml | 18 +++++++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 95f3b9d4d..2a69192e3 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -124,6 +124,7 @@ jobs: EnableOptProf: ${{ parameters.EnableOptProf }} IsOptProf: ${{ parameters.IsOptProf }} ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + RealSign: ${{ parameters.RealSign }} - template: dotnet.yml parameters: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 949b1b47e..ce711a0a3 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -11,15 +11,19 @@ parameters: - name: ShouldSkipOptimize type: boolean default: false +- name: RealSign + type: boolean steps: -- task: notice@0 - displayName: 🛠️ Generate NOTICE file - inputs: - outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE - outputformat: text - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - retryCountOnTaskFailure: 3 # fails when the cloud service is overloaded +- ${{ if not(parameters.IsOptProf) }}: + - task: notice@0 + displayName: 🛠️ Generate NOTICE file + inputs: + outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE + outputformat: text + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) + retryCountOnTaskFailure: 5 # fails when the cloud service is overloaded + continueOnError: ${{ not(parameters.RealSign) }} # Tolerate failures when we're not building something that may ship. - ${{ if parameters.IsOptProf }}: # We have to install these plugins ourselves for Optprof runs because those pipelines haven't migrated to 1ES PT yet. From 5a329c4011165e861af9a9724f394b1ec0f4e710 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 14:00:26 -0700 Subject: [PATCH 0974/1753] Update ubuntu image names --- azure-pipelines/archive-sourcecode.yml | 2 +- azure-pipelines/official.yml | 4 ++-- azure-pipelines/prepare-insertion-stages.yml | 2 +- azure-pipelines/release.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index afdf0f6bf..c550e2c2d 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -44,7 +44,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + - ImageOverride -equals 1ESPT-Ubuntu22.04 os: Linux steps: diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 8cdf3afb0..a3d64e68d 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -76,7 +76,7 @@ extends: linuxPool: name: AzurePipelines-EO demands: - - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + - ImageOverride -equals 1ESPT-Ubuntu22.04 os: Linux macOSPool: name: Azure Pipelines @@ -108,7 +108,7 @@ extends: linuxPool: name: AzurePipelines-EO demands: - - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + - ImageOverride -equals 1ESPT-Ubuntu22.04 os: Linux macOSPool: name: Azure Pipelines diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 6ffff5313..da163c76f 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -41,7 +41,7 @@ stages: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + - ImageOverride -equals 1ESPT-Ubuntu22.04 os: Linux templateContext: outputs: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 2da6ddf01..0f425fb6d 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -30,7 +30,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals AzurePipelinesUbuntu20.04compliantGPT + - ImageOverride -equals 1ESPT-Ubuntu22.04 os: Linux templateContext: outputs: From aa4bf5bdf8a1d3289863b4b16b60cfd6dbf07b04 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 14:22:55 -0700 Subject: [PATCH 0975/1753] OptProf pipeline fixes --- azure-pipelines/OptProf.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 6d81439a1..248f57458 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -86,6 +86,8 @@ stages: - task: MicroBuildInsertVsPayload@4 displayName: Insert VS Payload inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) SkipCreatePR: true CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 From 531d1e693d0762b05ebc317a7a7176b506819778 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 15:23:58 -0700 Subject: [PATCH 0976/1753] Fix test `ReadLockAsync_OnCompleted_CapturesExecutionContext` --- .../AsyncReaderWriterLock.cs | 6 +-- .../AsyncReaderWriterLockTests.cs | 44 ++++++++++--------- 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index ced7522fb..9c4e732e6 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -114,7 +114,7 @@ public partial class AsyncReaderWriterLock : IDisposable /// The source of the task, which transitions to completed after /// the method is called and all issued locks have been released. /// - private readonly TaskCompletionSource completionSource = new TaskCompletionSource(); + private readonly TaskCompletionSource completionSource = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); /// /// The queue of callbacks to invoke when the currently held write lock is totally released. @@ -838,9 +838,7 @@ this.reenterConcurrencyPrepRunning is null && this.issuedReadLocks.Count == 0 && this.issuedUpgradeableReadLocks.Count == 0 && this.issuedWriteLocks.Count == 0 && this.waitingReaders.Count == 0 && this.waitingUpgradeableReaders.Count == 0 && this.waitingWriters.Count == 0) { - // We must use another task to asynchronously transition this so we don't inadvertently execute continuations inline - // while we're holding a lock. - Task.Run(delegate { this.completionSource.TrySetResult(null); }); + this.completionSource.TrySetResult(null); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index 40aa53f35..dd6f69eb9 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -4348,30 +4348,34 @@ public async Task ReadLockAsync_Await_CapturesExecutionContext() [Fact] public async Task ReadLockAsync_OnCompleted_CapturesExecutionContext() { - var asyncLocal = new Microsoft.VisualStudio.Threading.AsyncLocal(); - asyncLocal.Value = "expected"; - AsyncReaderWriterLock.Awaiter? awaiter = this.asyncLock.ReadLockAsync().GetAwaiter(); - Assumes.False(awaiter.IsCompleted); - var testResultSource = new TaskCompletionSource(); - awaiter.OnCompleted(delegate + // Set a lock-incompatible synchronization context to ensure the issued lock will require us to yield. + using (new SynchronizationContext().Apply(checkForChangesOnRevert: false)) { - try + var asyncLocal = new Microsoft.VisualStudio.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + AsyncReaderWriterLock.Awaiter? awaiter = this.asyncLock.ReadLockAsync().GetAwaiter(); + Assumes.False(awaiter.IsCompleted); + var testResultSource = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); + awaiter.OnCompleted(delegate { - using (awaiter.GetResult()) + try { - Assert.Equal("expected", asyncLocal.Value); - testResultSource.SetResult(null); + using (awaiter.GetResult()) + { + Assert.Equal("expected", asyncLocal.Value); + testResultSource.SetResult(null); + } } - } - catch (Exception ex) - { - testResultSource.SetException(ex); - } - finally - { - } - }); - await testResultSource.Task; + catch (Exception ex) + { + testResultSource.SetException(ex); + } + finally + { + } + }); + await testResultSource.Task; + } } [Fact] From c2ef9fc6cab13c37d736649e33ad7fb93ec0cd1b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 15:31:53 -0700 Subject: [PATCH 0977/1753] Fix test `AwaitExtensionsTests.SyncContext_Awaiter` --- .../AwaitExtensionsTests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index c304e8a9c..b2d5af6fb 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -575,7 +575,7 @@ public void GetAwaiter_SynchronizationContext_ValidatesArgs() [Fact] public async Task SyncContext_Awaiter() { - TaskCompletionSource syncContextSource = new(); + TaskCompletionSource syncContextSource = new(TaskCreationOptions.RunContinuationsAsynchronously); SingleThreadedSynchronizationContext.Frame frame = new(); Thread? otherThread = null; Task otherThreadTask = Task.Run(delegate From 45895a06a19a91eb85b058ed3163286c66489c76 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 8 Feb 2024 17:50:37 -0700 Subject: [PATCH 0978/1753] Beef up VSTHRD003 documentation --- doc/analyzers/VSTHRD003.md | 181 ++++++++++++++++++++++++++++++++++++- 1 file changed, 178 insertions(+), 3 deletions(-) diff --git a/doc/analyzers/VSTHRD003.md b/doc/analyzers/VSTHRD003.md index 25208871f..49d8ad87b 100644 --- a/doc/analyzers/VSTHRD003.md +++ b/doc/analyzers/VSTHRD003.md @@ -10,7 +10,7 @@ When required to await a task that was started earlier, start it within a delega `JoinableTaskFactory.RunAsync`, storing the resulting `JoinableTask` in a field or variable. You can safely await the `JoinableTask` later. -## Examples of patterns that are flagged by this analyzer +## Simple examples of patterns that are flagged by this analyzer The following example would likely deadlock if `MyMethod` were called on the main thread, since `SomeOperationAsync` cannot gain access to the main thread in order to complete. @@ -51,10 +51,12 @@ class SomeClass } ``` -## Solution +More [advanced examples](#advanced-cases) are further down in this document, below the solution section for the simpler examples. + +## Solution for simpler cases To await the result of an async method from with a JoinableTaskFactory.Run delegate, -invoke the async method within the JoinableTaskFactory.Run delegate: +invoke the async method within the JoinableTaskFactory.Run delegate: ```csharp void MyMethod() @@ -90,3 +92,176 @@ class SomeClass } } ``` + +## Advanced cases + +### `TaskCompletionSource` + +In the next example, a `TaskCompletionSource` is used as a black-box for unblocking functionality. +It too represents awaiting a foreign task: + +```cs +class SomeClass +{ + TaskCompletionSource tcs = new(); + + public async Task MyMethodAsync() + { + await this.tcs.Task; /* This analyzer will report warning on this line. */ + /* do more stuff */ + } + + void UnlockProgress() + { + this.tcs.TrySetResult(true); + } +} +``` + +The problem with the above code is that `MyMethodAsync()` waits for unknown work (whatever work will lead to the completion of the `TaskCompletionSource`) before making progress. +If `UnlockProgress()` is never called, the caller of `MyMethodAsync()` will be awaiting forever. +Now suppose that the caller of `MyMethodAsync()` is actually inside a `JoinableTaskFactory.Run` delegate: + +```cs +void SomeCaller() +{ + joinableTaskFactory.Run(async delegate + { + await someClass.MyMethodAsync(); + }); +} +``` + +If `SomeCaller()` runs on the main thread, then it will effectively block the main thread while waiting for `this.tcs.Task` from `SomeClass` to complete. +Now suppose that another thread comes along and wants to do some work before calling `UnlockProgress()`: + +```cs +partial class SomeClass +{ + async Task KeyMasterAsync() + { + await joinableTaskFactory.SwitchToMainThreadAsync(); + // do some work + // Unblock others + someClass.UnlockProgress(); + } +} +``` + +We have a deadlock, because `SomeCaller()` is blocking the main thread while waiting for `UnlockProgress()` to be called, but `UnlockProgress()` will not be called until `KeyMasterAsync` can reach the main thread. + +Fixing this fundamentally means that `SomeCaller` will need to *join* whatever work may be needed to ultimately call `UnlockProgress`. But for `SomeCaller`, that work is unknown, since it's at least partially inside another class. +`TaskCompletionSource` is fundamentally a blackbox and the most difficult thing to use correctly while avoiding deadlocks. + +Preferred solutions involve replacing `TaskCompletionSource` with another type that makes tracking the work involved automatic. +These include: + +1. Use `JoinableTaskFactory.RunAsync` and store the resulting `JoinableTask` in a field to await later. +1. Use `AsyncLazy` for one-time init work that should only start if required. Be sure to pass in a `JoinableTaskFactory` instance to its constructor. + +Assuming you must keep using `TaskCompletionSource` though, here's how it can be done as safely as possible. +Joining a set of unknown work is best done with the `JoinableTaskCollection` class. +It is the responsibility of `SomeClass` in the example above to work with this collection to avoid deadlocks, like this: + +```cs +class SomeClass +{ + TaskCompletionSource tcs = new(); + JoinableTaskCollection jtc; + JoinableTaskFactory jtf; + + internal SomeClass(JoinableTaskContext joinableTaskContext) + { + this.jtc = joinableTaskContext.CreateCollection(); + this.jtf = joinableTaskContext.CreateFactory(this.jtc); + } + + public async Task MyMethodAsync() + { + // Our caller is interested in completion of the TaskCompletionSource, + // so join the collected effort while waiting, to avoid deadlocks. + using (this.jtc.Join()) + { + await this.tcs.Task; /* This analyzer will report warning on this line. */ + } + + /* do more stuff */ + } + + void UnlockProgress() + { + this.tcs.TrySetResult(true); + } + + async Task KeyMasterAsync() + { + // As this method must complete to signal the TaskCompletionSource, + // all of its work must be done within the context of a JoinableTask + // that belongs to the JoinableTaskCollection. + // jtf.RunAsync will add the JoinableTask it creates to the jtc collection + // because jtf was created with jtc as an argument in our constructor. + await this.jtf.RunAsync(async delegate + { + // Because we're in the jtc collection, anyone waiting on MyMethodAsync + // will automatically lend us use of the main thread if they have it + // to avoid deadlocks. + // It does NOT matter whether we use jtf or another JoinableTaskFactory instance + // at this point. + await anyOldJTF.SwitchToMainThreadAsync(); + + // do some work + // Unblock others + this.UnlockProgress(); + }); + } +} +``` + +Notice how the public API of the class does not need to expose any `JoinableTask`-related types. +It's an implementation detail of the class. + +This works fine when the class itself fully controls the work to complete the `TaskCompletionSource`. +When _other_ classes also do work (independently of work started within `SomeClass`), the placement and access to the `JoinableTaskFactory` that is associated with the `JoinableTaskCollection` may need to be elevated so that other classes can access it as well so that *all* the work required to complete the `TaskCompletionSource` will be tracked. + +### Task chaining or other means to ensure sequential execution + +Task chaining is another technique that can lead to deadlocks. +Task chaining is where a single `Task` is kept in a field and used to call `Task.ContinueWith` to append another Task, and the resulting Task is then assigned to the field, like this: + +```cs +class TaskChainingExample +{ + private readonly object lockObject = new(); + private Task lastTask = Task.CompletedTask; + + internal Task AddWorkToEnd(Funk work) + { + lock (this.lockObject) + { + return this.lastTask = this.lastTask.ContinueWith(_ => work()).Unwrap(); + } + } +} +``` + +(Note: The above example has several *other* issues that would require more code to address, but it illustrates the idea of task chaining.) + +The deadlock risk with task chaining is that again, the chain of tasks come together to form a kind of private queue which the `JoinableTaskFactory` has no visibility into. +When a task is not at the front of the queue but its owner blocks the main thread for its completion, and if any other task ahead of it in the queue needs the main thread, a deadlock will result. + +For this reason (and several others), task chaining is *not* recommended. +Instead, you can achieve a thread-safe queue that executes work sequentially by utilizing the `ReentrantSemaphore` class. + +Fixing the above example would translate to this (allowing for a variety of reentrancy modes): + +```cs +class SequentialExecutingQueueExample +{ + private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(initialCount: 1, joinableTaskContext, ReentrancyMode.Stack); + + internal Task AddWorkToEnd(Func work) + { + return semaphore.ExecuteAsync(work); + } +} +``` From 1eba738358ff53acd1ffa70f7b11b9c102d61b97 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 15:51:50 -0700 Subject: [PATCH 0979/1753] Publish logs on build/test failures for mac/linux We were already doing this right on Windows. --- azure-pipelines/build.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5d3fbd063..4b6aa1646 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -127,6 +127,7 @@ jobs: displayName: 📢 Publish ${{ artifact_name }}-Linux targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux artifactName: ${{ artifact_name }}-Linux + condition: succeededOrFailed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. @@ -157,6 +158,7 @@ jobs: displayName: 📢 Publish ${{ artifact_name }}-macOS targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS artifactName: ${{ artifact_name }}-macOS + condition: succeededOrFailed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. From 1d3bd2b944838856145805c77d12b19a71d3c3e1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 14:22:55 -0700 Subject: [PATCH 0980/1753] OptProf pipeline fixes --- azure-pipelines/OptProf.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 6d81439a1..dc0e4435d 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -35,7 +35,6 @@ stages: parameters: Is1ESPT: false RealSign: true - EnableLocalization: false EnableCompliance: false windowsPool: VSEngSS-MicroBuild2022-1ES includeMacOS: false @@ -86,6 +85,8 @@ stages: - task: MicroBuildInsertVsPayload@4 displayName: Insert VS Payload inputs: + TeamName: $(TeamName) + TeamEmail: $(TeamEmail) SkipCreatePR: true CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 From 891d82b51df52818793084ab6f5e74053ef2648a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 16:02:03 -0700 Subject: [PATCH 0981/1753] Fix `notice@0` task on non-default branches --- azure-pipelines/microbuild.before.yml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index ce711a0a3..05acd3194 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -15,14 +15,18 @@ parameters: type: boolean steps: -- ${{ if not(parameters.IsOptProf) }}: +- ${{ if and(not(parameters.IsOptProf), ne(variables['Build.Reason'], 'PullRequest')) }}: + # notice@0 requires CG detection to run first, and non-default branches don't inject it automatically. + - ${{ if ne(variables['Build.SourceBranch'], 'refs/heads/main') }}: + - task: ComponentGovernanceComponentDetection@0 + displayName: 🔍 Component Detection + - task: notice@0 displayName: 🛠️ Generate NOTICE file inputs: outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE outputformat: text - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - retryCountOnTaskFailure: 5 # fails when the cloud service is overloaded + retryCountOnTaskFailure: 3 # fails when the cloud service is overloaded continueOnError: ${{ not(parameters.RealSign) }} # Tolerate failures when we're not building something that may ship. - ${{ if parameters.IsOptProf }}: From e5e41d4a503ef08a0a0f8e68232e76e5325ba7e6 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Tue, 20 Feb 2024 17:02:18 -0800 Subject: [PATCH 0982/1753] Disable the generation of SBOMs for artifacts in unsigned builds --- azure-pipelines/official.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index a3d64e68d..610900b73 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -62,6 +62,8 @@ extends: exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml suppression: suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress + sbom: + enabled: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} # Disable the generation for SBOMs for artifacts in unsigned builds since it's slow stages: - stage: Build variables: From ae08d6ea4a9efe50ead0ca9e1035d023901f8ed0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 18:36:10 -0700 Subject: [PATCH 0983/1753] Disable `dotnet format` since it's failing at this point --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index aa5e2d0af..39d2fde98 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -169,6 +169,7 @@ jobs: RunTests: ${{ parameters.RunTests }} - script: dotnet format --verify-no-changes --no-restore displayName: 💅 Verify formatted code + enabled: false # enable when we get this to pass - job: macOS condition: ${{ parameters.includeMacOS }} From db7b2f23d3b247d8f8de0466b8093e768f218216 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 18:43:37 -0700 Subject: [PATCH 0984/1753] Appease binskim --- src/SosThreadingTools/SosThreadingTools.csproj | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 8ecfd2915..a9b3a4095 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -13,6 +13,8 @@ $(MSBuildProjectName) $(MSBuildProjectName)Managed $(MSBuildProjectName) + $(DnneCompilerUserFlags) /W3 /guard:cf + $(DnneLinkerUserFlags) /guard:cf true A WinDBG extension that contains the !DumpAsync command for .NET Framework processes. From aac629912eea26ab62de7fa9ea54a56d3c6ca7b4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 Feb 2024 17:30:01 -0700 Subject: [PATCH 0985/1753] Disable test `ReadLockAsync_UseTaskScheduler` The test started hanging after the latest dependency updates. - I exchanged the hangs for timeouts to make things more diagnosable. - I temporarily fixed the timeouts by rolling back the Microsoft.NET.Test.Sdk 17.9.0 upgrade (from 17.8.0), xunit to 2.6.3 and xunit.runner.visualstudio to 2.5.6. - The `Assumes.Equals` was actually calling `object.Equals(object, object)` which returned false silently. I fixed this to call `Assert.Equal`, but then some of the asserts showed their true colors and non-deterministically failed the test, so I commented them out. We'll need to study this test so we can re-enable it. --- .../AsyncReaderWriterLockTests.cs | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index dd6f69eb9..828a10f4d 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -4407,51 +4407,51 @@ public async Task ReadLockAsync_UnsafeOnCompleted_DoesNotCaptureExecutionContext await testResultSource.Task; } - [Fact] + [Fact(Skip = "Disabled after dependency updates introduced failures. See https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1974921")] public async Task ReadLockAsync_UseTaskScheduler() { var asyncLock = new AsyncReaderWriterLockWithSpecialScheduler(); - Assumes.Equals(0, asyncLock.StartedTaskCount); + Assert.Equal(0, asyncLock.StartedTaskCount); // A reader lock issued immediately will not be rescheduled. using (await asyncLock.ReadLockAsync()) { } - Assumes.Equals(0, asyncLock.StartedTaskCount); + Assert.Equal(0, asyncLock.StartedTaskCount); var writeLockObtained = new AsyncManualResetEvent(); var readLockObtained = new AsyncManualResetEvent(); var writeLockToRelease = new AsyncManualResetEvent(); var writeLockTask = Task.Run(async () => { - using (await asyncLock.WriteLockAsync()) + using (await asyncLock.WriteLockAsync(this.TimeoutToken)) { // Write lock is not scheduled through the read lock scheduler. - Assumes.Equals(0, asyncLock.StartedTaskCount); + Assert.Equal(0, asyncLock.StartedTaskCount); writeLockObtained.Set(); - await writeLockToRelease.WaitAsync(); + await writeLockToRelease.WaitAsync(this.TimeoutToken); } }); - await writeLockObtained.WaitAsync(); + await writeLockObtained.WaitAsync(this.TimeoutToken); var readLockTask = Task.Run(async () => { - using (await asyncLock.ReadLockAsync()) + using (await asyncLock.ReadLockAsync(this.TimeoutToken)) { // Newly issued read lock is using the task scheduler. - Assumes.Equals(1, asyncLock.StartedTaskCount); + Assert.Equal(1, asyncLock.StartedTaskCount); // Unstable test. Sometimes it's 1, sometimes it's 2. readLockObtained.Set(); } }); - await asyncLock.ScheduleSemaphore.WaitAsync(); + await asyncLock.ScheduleSemaphore.WaitAsync(this.TimeoutToken); writeLockToRelease.Set(); - await writeLockTask; - await readLockTask; + await writeLockTask.WithCancellation(this.TimeoutToken); + await readLockTask.WithCancellation(this.TimeoutToken); - Assumes.Equals(1, asyncLock.StartedTaskCount); + Assert.Equal(1, asyncLock.StartedTaskCount); // Unstable test. Sometimes it's 1, sometimes it's 2. } [Fact] From d92acd3528bc80128b2a6b6cbc628ffa2b4f7067 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 12:43:59 -0700 Subject: [PATCH 0986/1753] Fix `ShouldSkipOptimize` parameter references --- azure-pipelines/official.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 3caa9f9d3..72dcb4f04 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -24,7 +24,7 @@ parameters: displayName: Real sign? type: boolean default: false -# - name: ShouldSkipOptimize # Enable this when setting EnableOptProf to true in build.yml. +# - name: ShouldSkipOptimize # Enable this and references to it below when setting EnableOptProf to true in build.yml. # displayName: Skip OptProf optimization # type: boolean # default: false @@ -75,7 +75,7 @@ extends: parameters: Is1ESPT: true RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} - ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES @@ -109,7 +109,7 @@ extends: parameters: Is1ESPT: true RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} - ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableCompliance: ${{ parameters.EnableCompliance }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES From 1a422fdefb4aec9bf93d7efd58408703a9897e8f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 12:56:16 -0700 Subject: [PATCH 0987/1753] Rollback xunit to 2.6.3 The upgrade to 2.7.0 will require fixing up some tests. --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 4491797b5..c47e15253 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -46,7 +46,7 @@ - + From 214c048692cc64ff58481c963ceda59d13ad029b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 13:44:49 -0700 Subject: [PATCH 0988/1753] Make mac/linux agents trivially excludable --- azure-pipelines.yml | 4 +- azure-pipelines/OptProf.yml | 2 +- azure-pipelines/build.yml | 145 +++++++++++++---------- azure-pipelines/official.yml | 6 +- azure-pipelines/publish-codecoverage.yml | 24 ++-- azure-pipelines/publish-symbols.yml | 59 ++++----- azure-pipelines/vs-validation.yml | 2 +- 7 files changed, 134 insertions(+), 108 deletions(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index e6ceafef6..79f69c221 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -14,7 +14,7 @@ trigger: - azure-pipelines/release.yml parameters: -- name: includeMacOS +- name: EnableMacOSBuild displayName: Build on macOS type: boolean default: false # macOS is often bogged down in Azure Pipelines @@ -30,5 +30,5 @@ jobs: - template: azure-pipelines/build.yml parameters: Is1ESPT: false - includeMacOS: ${{ parameters.includeMacOS }} + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} RunTests: ${{ parameters.RunTests }} diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index dc0e4435d..0f4ba24f6 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -37,7 +37,7 @@ stages: RealSign: true EnableCompliance: false windowsPool: VSEngSS-MicroBuild2022-1ES - includeMacOS: false + EnableMacOSBuild: false ShouldSkipOptimize: true IsOptProf: true RunTests: false diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 215512c96..f82afad6b 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -16,8 +16,12 @@ parameters: type: object default: vmImage: macOS-12 -- name: includeMacOS +- name: EnableLinuxBuild type: boolean + default: true +- name: EnableMacOSBuild + type: boolean + default: true - name: EnableOptProf type: boolean default: false @@ -39,6 +43,9 @@ parameters: - name: EnableAPIScan type: boolean default: false +- name: EnableDotNetFormatCheck + type: boolean + default: true - name: artifact_names type: object default: @@ -132,6 +139,10 @@ jobs: RunTests: ${{ parameters.RunTests }} IsOptProf: ${{ parameters.IsOptProf }} + - ${{ if and(parameters.EnableDotNetFormatCheck, not(parameters.EnableLinuxBuild)) }}: + - script: dotnet format --verify-no-changes --no-restore + displayName: 💅 Verify formatted code + - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml parameters: @@ -143,72 +154,76 @@ jobs: - template: expand-template.yml - ${{ if not(parameters.IsOptProf) }}: - - job: Linux - pool: ${{ parameters.linuxPool }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - templateContext: - mb: - ${{ if parameters.RealSign }}: - signing: - enabled: false # enable when building unique artifacts on this agent that must be signed - signType: real - outputParentDirectory: $(Build.ArtifactStagingDirectory) - outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-Linux - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux - artifactName: ${{ artifact_name }}-Linux - condition: succeededOrFailed() - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - - template: dotnet.yml - parameters: - Is1ESPT: ${{ parameters.Is1ESPT }} - RunTests: ${{ parameters.RunTests }} - - script: dotnet format --verify-no-changes --no-restore - displayName: 💅 Verify formatted code - - template: expand-template.yml + - ${{ if parameters.EnableLinuxBuild }}: + - job: Linux + pool: ${{ parameters.linuxPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + mb: + ${{ if parameters.RealSign }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-Linux + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux + artifactName: ${{ artifact_name }}-Linux + condition: succeededOrFailed() + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + - template: dotnet.yml + parameters: + Is1ESPT: ${{ parameters.Is1ESPT }} + RunTests: ${{ parameters.RunTests }} + - ${{ if parameters.EnableDotNetFormatCheck }}: + - script: dotnet format --verify-no-changes --no-restore + displayName: 💅 Verify formatted code + - template: expand-template.yml - - job: macOS - condition: ${{ parameters.includeMacOS }} - pool: ${{ parameters.macOSPool }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - templateContext: - mb: - ${{ if parameters.RealSign }}: - signing: - enabled: false # enable when building unique artifacts on this agent that must be signed - signType: real - outputParentDirectory: $(Build.ArtifactStagingDirectory) - outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-macOS - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS - artifactName: ${{ artifact_name }}-macOS - condition: succeededOrFailed() - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - - template: dotnet.yml - parameters: - Is1ESPT: ${{ parameters.Is1ESPT }} - RunTests: ${{ parameters.RunTests }} - - template: expand-template.yml + - ${{ if parameters.EnableMacOSBuild }}: + - job: macOS + pool: ${{ parameters.macOSPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + mb: + ${{ if parameters.RealSign }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact_name in parameters.artifact_names }}: + - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact_name }}-macOS + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS + artifactName: ${{ artifact_name }}-macOS + condition: succeededOrFailed() + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + - template: dotnet.yml + parameters: + Is1ESPT: ${{ parameters.Is1ESPT }} + RunTests: ${{ parameters.RunTests }} + - template: expand-template.yml - job: WrapUp dependsOn: - Windows - - Linux - - macOS + - ${{ if parameters.EnableLinuxBuild }}: + - Linux + - ${{ if parameters.EnableMacOSBuild }}: + - macOS pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). condition: succeededOrFailed() steps: @@ -220,8 +235,10 @@ jobs: initArgs: -NoRestore - template: publish-symbols.yml parameters: - includeMacOS: ${{ parameters.includeMacOS }} + EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - ${{ if parameters.RunTests }}: - template: publish-codecoverage.yml parameters: - includeMacOS: ${{ parameters.includeMacOS }} + EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 72dcb4f04..1bd088b18 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -28,7 +28,7 @@ parameters: # displayName: Skip OptProf optimization # type: boolean # default: false -- name: includeMacOS +- name: EnableMacOSBuild displayName: Build on macOS type: boolean default: false # macOS is often bogged down in Azure Pipelines @@ -88,7 +88,7 @@ extends: name: Azure Pipelines vmImage: macOS-12 os: macOS - includeMacOS: ${{ parameters.includeMacOS }} + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: @@ -122,7 +122,7 @@ extends: name: Azure Pipelines vmImage: macOS-12 os: macOS - includeMacOS: ${{ parameters.includeMacOS }} + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index fbb6a39a7..c6247a115 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -1,20 +1,24 @@ parameters: - includeMacOS: +- name: EnableMacOSBuild + type: boolean +- name: EnableLinuxBuild + type: boolean steps: - download: current artifact: coverageResults-Windows displayName: 🔻 Download Windows code coverage results continueOnError: true -- download: current - artifact: coverageResults-Linux - displayName: 🔻 Download Linux code coverage results - continueOnError: true -- download: current - artifact: coverageResults-macOS - displayName: 🔻 Download macOS code coverage results - continueOnError: true - condition: and(succeeded(), ${{ parameters.includeMacOS }}) +- ${{ if parameters.EnableLinuxBuild }}: + - download: current + artifact: coverageResults-Linux + displayName: 🔻 Download Linux code coverage results + continueOnError: true +- ${{ if parameters.EnableMacOSBuild }}: + - download: current + artifact: coverageResults-macOS + displayName: 🔻 Download macOS code coverage results + continueOnError: true - powershell: azure-pipelines/Merge-CodeCoverage.ps1 -Path '$(Pipeline.Workspace)' -OutputFile coveragereport/merged.cobertura.xml -Format Cobertura -Verbose displayName: ⚙ Merge coverage - task: PublishCodeCoverageResults@1 diff --git a/azure-pipelines/publish-symbols.yml b/azure-pipelines/publish-symbols.yml index 00b5a3a6b..ddf82352f 100644 --- a/azure-pipelines/publish-symbols.yml +++ b/azure-pipelines/publish-symbols.yml @@ -1,5 +1,8 @@ parameters: - includeMacOS: +- name: EnableMacOSBuild + type: boolean +- name: EnableLinuxBuild + type: boolean steps: - task: DownloadPipelineArtifact@2 @@ -8,19 +11,20 @@ steps: path: $(Pipeline.Workspace)/symbols/Windows displayName: 🔻 Download Windows symbols continueOnError: true -- task: DownloadPipelineArtifact@2 - inputs: - artifact: symbols-Linux - path: $(Pipeline.Workspace)/symbols/Linux - displayName: 🔻 Download Linux symbols - continueOnError: true -- task: DownloadPipelineArtifact@2 - inputs: - artifact: symbols-macOS - path: $(Pipeline.Workspace)/symbols/macOS - displayName: 🔻 Download macOS symbols - continueOnError: true - condition: ${{ parameters.includeMacOS }} +- ${{ if parameters.EnableLinuxBuild }}: + - task: DownloadPipelineArtifact@2 + inputs: + artifact: symbols-Linux + path: $(Pipeline.Workspace)/symbols/Linux + displayName: 🔻 Download Linux symbols + continueOnError: true +- ${{ if parameters.EnableMacOSBuild }}: + - task: DownloadPipelineArtifact@2 + inputs: + artifact: symbols-macOS + path: $(Pipeline.Workspace)/symbols/macOS + displayName: 🔻 Download macOS symbols + continueOnError: true - task: DownloadPipelineArtifact@2 inputs: @@ -28,19 +32,20 @@ steps: path: $(Pipeline.Workspace)/test_symbols/Windows displayName: 🔻 Download Windows test symbols continueOnError: true -- task: DownloadPipelineArtifact@2 - inputs: - artifact: test_symbols-Linux - path: $(Pipeline.Workspace)/test_symbols/Linux - displayName: 🔻 Download Linux test symbols - continueOnError: true -- task: DownloadPipelineArtifact@2 - inputs: - artifact: test_symbols-macOS - path: $(Pipeline.Workspace)/test_symbols/macOS - displayName: 🔻 Download macOS test symbols - continueOnError: true - condition: ${{ parameters.includeMacOS }} +- ${{ if parameters.EnableLinuxBuild }}: + - task: DownloadPipelineArtifact@2 + inputs: + artifact: test_symbols-Linux + path: $(Pipeline.Workspace)/test_symbols/Linux + displayName: 🔻 Download Linux test symbols + continueOnError: true +- ${{ if parameters.EnableMacOSBuild }}: + - task: DownloadPipelineArtifact@2 + inputs: + artifact: test_symbols-macOS + path: $(Pipeline.Workspace)/test_symbols/macOS + displayName: 🔻 Download macOS test symbols + continueOnError: true - task: PublishSymbols@2 inputs: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 195bfff33..c541be60f 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -35,7 +35,7 @@ extends: Is1ESPT: true RealSign: true windowsPool: VSEngSS-MicroBuild2022-1ES - includeMacOS: false + EnableMacOSBuild: false RunTests: false - template: /azure-pipelines/prepare-insertion-stages.yml@self From c7d1dd3f26d3d24dee6471114fb7f4381bf10283 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 14:35:54 -0700 Subject: [PATCH 0989/1753] Clarify code comment --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 1bd088b18..cabae2d27 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -24,7 +24,7 @@ parameters: displayName: Real sign? type: boolean default: false -# - name: ShouldSkipOptimize # Enable this and references to it below when setting EnableOptProf to true in build.yml. +# - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. # displayName: Skip OptProf optimization # type: boolean # default: false From f38dd307bfdaf94863b877b085f1ee24ca0d893d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 14:42:12 -0700 Subject: [PATCH 0990/1753] Fix assigning reviewers to insertion PRs --- azure-pipelines/vs-insertion.yml | 2 +- azure-pipelines/vs-validation.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 9cb597eab..8a6ffa0e6 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -54,7 +54,7 @@ extends: TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) InsertionBuildPolicy: Request Perf DDRITs - InsertionReviewers: $(TeamEmail),$(Build.RequestedForEmail) + InsertionReviewers: $(Build.RequestedFor) # Append `,Your team name` (without quotes) AutoCompletePR: true AutoCompleteMergeStrategy: Squash - powershell: | diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index c541be60f..4d385796e 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -78,7 +78,7 @@ extends: This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 InsertionBuildPolicy: Request Perf DDRITs - InsertionReviewers: $(Build.RequestedForEmail) + InsertionReviewers: $(Build.RequestedFor) AutoCompletePR: false - powershell: | $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 From b21987e11f1d74129d02351bc983098706c8a554 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 15:48:10 -0700 Subject: [PATCH 0991/1753] fix typo --- .vscode/settings.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index efbe74f47..45467326c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -18,6 +18,6 @@ // Needs to be explicitly configured: https://github.com/Microsoft/azure-pipelines-vscode#document-formatting "[azure-pipelines]": { "editor.defaultFormatter": "esbenp.prettier-vscode", - "editor.formatOnSave": false // enable this when the conform + "editor.formatOnSave": false // enable this when they conform }, } From aa80117c6126647da771c73d013c0a1614e89bb8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 21 Feb 2024 18:58:30 -0700 Subject: [PATCH 0992/1753] Avoid shallow cloning for optprof pipelines --- azure-pipelines/build.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index f82afad6b..f3b5f2fb4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -116,6 +116,14 @@ jobs: targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows artifactName: LocBin-Windows steps: + - ${{ if not(parameters.Is1ESPT) }}: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - ${{ if parameters.EnableOptProf }}: + - powershell: Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSDROPNAME]$(azure-pipelines/variables/ProfilingInputsDropName.ps1)" + displayName: ⚙ Set ProfilingInputsDropName for optprof + - ${{ if eq(variables['Build.Reason'], 'Schedule') }}: - template: schedule-only-steps.yml From 97d04799454206fb26e94b7a4aa6f6553dad6cb6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Feb 2024 11:53:50 -0700 Subject: [PATCH 0993/1753] Re-enable push to the vssdk feed --- azure-pipelines/prepare-insertion-stages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 7fa8e00ed..4122f39e6 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -33,7 +33,7 @@ stages: SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy azureSubscription: Symbols Upload (DevDiv) - - ${{ if false }}: # Switch to true to enable, but leave the condition to avoid merge conflicts later. + - ${{ if true }}: # leave the condition to avoid merge conflicts later. - job: push displayName: azure-public/vssdk feed ${{ if parameters.ArchiveSymbols }}: From 00f463153e4257899c160f2d0df97c6b97d3b569 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Feb 2024 13:36:20 -0700 Subject: [PATCH 0994/1753] Extract APIScan into its own job --- azure-pipelines/apiscan.yml | 43 ++++++++++++++++++++ azure-pipelines/artifacts/APIScanInputs.ps1 | 24 +++++++++++ azure-pipelines/build.yml | 17 +++++--- azure-pipelines/microbuild.after.yml | 11 ----- azure-pipelines/secure-development-tools.yml | 41 ------------------- 5 files changed, 78 insertions(+), 58 deletions(-) create mode 100644 azure-pipelines/apiscan.yml create mode 100644 azure-pipelines/artifacts/APIScanInputs.ps1 delete mode 100644 azure-pipelines/secure-development-tools.yml diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml new file mode 100644 index 000000000..2f482ca16 --- /dev/null +++ b/azure-pipelines/apiscan.yml @@ -0,0 +1,43 @@ +parameters: +- name: windowsPool + type: object + +jobs: +- job: apiscan + displayName: APIScan + dependsOn: Windows + pool: ${{ parameters.windowsPool }} + variables: + - name: SymbolsFeatureName + value: $[ dependencies.Windows.outputs['SetPipelineVariables.SymbolsFeatureName'] ] + - name: NBGV_MajorMinorVersion + value: $[ dependencies.Windows.outputs['nbgv.NBGV_MajorMinorVersion'] ] + - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline + - group: VSCloudServices-APIScan # Expected to provide ApiScanClientId, ApiScanSecret, ApiScanTenant + steps: + # We need TSAOptions.json + - checkout: self + fetchDepth: 1 + + - download: current + artifact: APIScanInputs + displayName: 🔻 Download APIScanInputs artifact + + - task: APIScan@2 + displayName: 🔍 Run APIScan + inputs: + softwareFolder: $(Pipeline.Workspace)/APIScanInputs + softwareName: $(SymbolsFeatureName) + softwareVersionNum: $(NBGV_MajorMinorVersion) + isLargeApp: false + toolVersion: Latest + env: + AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) + + # File bugs when APIScan finds issues + - task: TSAUpload@2 + displayName: 🪳 TSA upload + inputs: + GdnPublishTsaOnboard: True + GdnPublishTsaConfigFile: $(Build.SourcesDirectory)\azure-pipelines\TSAOptions.json diff --git a/azure-pipelines/artifacts/APIScanInputs.ps1 b/azure-pipelines/artifacts/APIScanInputs.ps1 new file mode 100644 index 000000000..155564130 --- /dev/null +++ b/azure-pipelines/artifacts/APIScanInputs.ps1 @@ -0,0 +1,24 @@ +$inputs = & "$PSScriptRoot/symbols.ps1" + +if (!$inputs) { return } + +# Filter out specific files that APIScan does not support. +# Specifically, APIScan doesn't support Windows ARM64 binaries, nor linux/OSX binaries. +$outputs = @{} +$forbiddenSubPaths = @( + , 'arm64' + , 'win-arm64' + , 'linux-*' + , 'osx*' +) + +$inputs.GetEnumerator() | % { + $list = $_.Value | ? { + $path = $_.Replace('\', '/') + return !($forbiddenSubPaths | ? { $path -like "*/$_/*" }) + } + $outputs[$_.Key] = $list +} + + +$outputs diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index f3b5f2fb4..ba6014ff9 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -62,10 +62,6 @@ jobs: - job: Windows pool: ${{ parameters.windowsPool }} timeoutInMinutes: 180 # Give plenty of time due to real signing - variables: - - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline - - group: VSCloudServices-APIScan # Expected to provide ApiScanClientId, ApiScanSecret, ApiScanTenant ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: mb: @@ -115,6 +111,11 @@ jobs: displayName: 📢 Publish LocBin-Windows targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows artifactName: LocBin-Windows + - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan) }}: + - output: pipelineArtifact + displayName: 📢 Publish APIScanInputs + targetPath: $(Build.ArtifactStagingDirectory)/APIScanInputs-Windows + artifactName: APIScanInputs steps: - ${{ if not(parameters.Is1ESPT) }}: - checkout: self @@ -131,6 +132,7 @@ jobs: - script: dotnet nbgv cloud -ca displayName: ⚙ Set build number + name: nbgv - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.before.yml @@ -154,8 +156,6 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml parameters: - EnableCompliance: ${{ parameters.EnableCompliance }} - EnableAPIScan: ${{ parameters.EnableAPIScan }} EnableOptProf: ${{ parameters.EnableOptProf }} IsOptProf: ${{ parameters.IsOptProf }} @@ -250,3 +250,8 @@ jobs: parameters: EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} + + - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan) }}: + - template: apiscan.yml + parameters: + windowsPool: ${{ parameters.windowsPool }} diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index f9698e3ee..94e83d349 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,10 +1,4 @@ parameters: -- name: EnableCompliance - type: boolean - default: false -- name: EnableAPIScan - type: boolean - default: false - name: EnableOptProf type: boolean default: false @@ -39,8 +33,3 @@ steps: ArtifactName: InsertionOutputs ArtifactType: Container displayName: 📢 Publish InsertionOutputs as Azure DevOps artifacts - -- ${{ if parameters.EnableCompliance }}: - - template: secure-development-tools.yml - parameters: - EnableAPIScan: ${{ parameters.EnableAPIScan }} diff --git a/azure-pipelines/secure-development-tools.yml b/azure-pipelines/secure-development-tools.yml deleted file mode 100644 index 409f48d0b..000000000 --- a/azure-pipelines/secure-development-tools.yml +++ /dev/null @@ -1,41 +0,0 @@ -parameters: -- name: EnableAPIScan - type: boolean - default: false - -steps: - -- powershell: echo "##vso[build.addbuildtag]compliance" - displayName: 🏷️ Tag run with 'compliance' - -- task: CopyFiles@2 - displayName: 📂 Collect APIScan inputs - inputs: - SourceFolder: $(Build.ArtifactStagingDirectory)/Symbols-$(Agent.JobName) - # Exclude any patterns from the Contents (e.g. `!**/git2*`) that we have symbols for but do not need to run APIScan on. - Contents: | - ** - !**/arm64/** - !**/win-arm64/** - !**/linux-*/** - !**/osx*/** - TargetFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs - -- ${{ if parameters.EnableAPIScan }}: - - task: APIScan@2 - displayName: 🔍 Run APIScan - inputs: - softwareFolder: $(Build.ArtifactStagingDirectory)/APIScanInputs - softwareName: $(SymbolsFeatureName) - softwareVersionNum: $(NBGV_MajorMinorVersion) - isLargeApp: false - toolVersion: Latest - env: - AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) - - # File bugs when APIScan finds issues - - task: TSAUpload@2 - displayName: 🪳 TSA upload - inputs: - GdnPublishTsaOnboard: True - GdnPublishTsaConfigFile: $(Build.SourcesDirectory)\azure-pipelines\TSAOptions.json From 617fb13463952ed613bd17231c346651b3a861f2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 22 Feb 2024 15:26:49 -0700 Subject: [PATCH 0995/1753] Skip APIScan on pull requests --- azure-pipelines/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index ba6014ff9..08c9e1d49 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -111,7 +111,7 @@ jobs: displayName: 📢 Publish LocBin-Windows targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows artifactName: LocBin-Windows - - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan) }}: + - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }}: - output: pipelineArtifact displayName: 📢 Publish APIScanInputs targetPath: $(Build.ArtifactStagingDirectory)/APIScanInputs-Windows @@ -251,7 +251,7 @@ jobs: EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan) }}: + - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }}: - template: apiscan.yml parameters: windowsPool: ${{ parameters.windowsPool }} From cdb447aac1c5fecf071265ad5c65edff6acc5e18 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 23 Feb 2024 15:05:09 -0700 Subject: [PATCH 0996/1753] Document pipeline parameters --- azure-pipelines/OptProf.yml | 1 - azure-pipelines/build.yml | 103 +++++++++++++++++++++++------------ azure-pipelines/official.yml | 9 +-- 3 files changed, 73 insertions(+), 40 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 0f4ba24f6..d95c84c8d 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -35,7 +35,6 @@ stages: parameters: Is1ESPT: false RealSign: true - EnableCompliance: false windowsPool: VSEngSS-MicroBuild2022-1ES EnableMacOSBuild: false ShouldSkipOptimize: true diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 08c9e1d49..26b731ca3 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -1,62 +1,95 @@ parameters: -- name: Is1ESPT +##### The following parameters are not set by other YAML files that import this one, +##### but we use parameters because they support rich types and defaults. +##### Feel free to adjust their default value as needed. + +# Whether this repo uses OptProf to optimize the built binaries. +- name: EnableOptProf type: boolean -- name: RealSign + default: false +# Whether this repo is localized. +- name: EnableLocalization type: boolean default: false -- name: windowsPool - type: object - default: - vmImage: windows-2022 -- name: linuxPool - type: object - default: - vmImage: ubuntu-20.04 -- name: macOSPool +# Whether to run `dotnet format` as part of the build to ensure code style consistency. +# This is just one of a a few mechanisms to enforce code style consistency. +- name: EnableDotNetFormatCheck + type: boolean + default: true +# This lists the names of the artifacts that will be published *from every OS build agent*. +# Any new azure-pipelines/artifacts/*.ps1 script needs to be added to this list. +# If an artifact is only generated or collected on one OS, it should NOT be listed here, +# but should be manually added to the `outputs:` field in the appropriate OS job. +- name: artifact_names type: object default: - vmImage: macOS-12 + - build_logs + - coverageResults + - deployables + - projectAssetsJson + - symbols + - testResults + - test_symbols + - Variables +# The Enable*Build parameters turn non-Windows agents on or off. +# Their default value should be based on whether the build and tests are expected/required to pass on that platform. +# Callers (e.g. Official.yml) *may* expose these parameters at queue-time in order to turn OFF optional agents. - name: EnableLinuxBuild type: boolean default: true - name: EnableMacOSBuild type: boolean default: true -- name: EnableOptProf + +##### 👆🏼 You MAY change the defaults above. +##### 👇🏼 You should NOT change the defaults below. + +##### The following parameters are expected to be set by other YAML files that import this one. +##### Those without defaults require explicit values to be provided by our importers. + +# Indicates whether the entrypoint file is 1ESPT compliant. Use this parameter to switch between publish tasks to fit 1ES or non-1ES needs. +- name: Is1ESPT type: boolean - default: false -- name: IsOptProf + +- name: RealSign type: boolean default: false -- name: ShouldSkipOptimize + +# Whether this particular run is an OptProf profiling run. +# This is used to skip unit tests and other non-essential work to improve reliability of the OptProf pipeline. +- name: IsOptProf type: boolean default: false + - name: RunTests type: boolean default: true -- name: EnableLocalization - type: boolean - default: false -- name: EnableCompliance - type: boolean - default: false + - name: EnableAPIScan type: boolean default: false -- name: EnableDotNetFormatCheck + +# This parameter exists to provide a workaround to get a build out even when no OptProf profiling outputs can be found. +# Entrypoint yaml files like official.yml should expose this as a queue-time setting when EnableOptProf is true in this file. +# The OptProf.yml entrypoint sets this parameter to true so that collecting profile data isn't blocked by a prior lack of profile data. +- name: ShouldSkipOptimize type: boolean - default: true -- name: artifact_names + default: false + +# The pool parameters are set to defaults that work in the azure-public AzDO account. +# They are overridden by callers for the devdiv AzDO account to use 1ES compliant pools. +- name: windowsPool + type: object + default: + vmImage: windows-2022 +- name: linuxPool type: object default: - - build_logs - - coverageResults - - deployables - - projectAssetsJson - - symbols - - testResults - - test_symbols - - Variables + vmImage: ubuntu-20.04 +- name: macOSPool + type: object + default: + vmImage: macOS-12 jobs: - job: Windows @@ -111,7 +144,7 @@ jobs: displayName: 📢 Publish LocBin-Windows targetPath: $(Build.ArtifactStagingDirectory)/LocBin-Windows artifactName: LocBin-Windows - - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }}: + - ${{ if parameters.EnableAPIScan }}: - output: pipelineArtifact displayName: 📢 Publish APIScanInputs targetPath: $(Build.ArtifactStagingDirectory)/APIScanInputs-Windows @@ -251,7 +284,7 @@ jobs: EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - - ${{ if and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }}: + - ${{ if parameters.EnableAPIScan }}: - template: apiscan.yml parameters: windowsPool: ${{ parameters.windowsPool }} diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index ee6dc92ca..98e21d223 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -20,6 +20,9 @@ trigger: # - microbuild parameters: +# As an entrypoint pipeline yml file, all parameters here show up in the Queue Run dialog. +# If any paramaters should NOT be queue-time options, they should be removed from here +# and references to them in this file replaced with hard-coded values. - name: RealSign displayName: Real sign? type: boolean @@ -78,8 +81,7 @@ extends: Is1ESPT: true RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - EnableCompliance: ${{ parameters.EnableCompliance }} - EnableAPIScan: ${{ parameters.EnableAPIScan }} + EnableAPIScan: ${{ and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }} windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: name: AzurePipelines-EO @@ -112,8 +114,7 @@ extends: Is1ESPT: true RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - EnableCompliance: ${{ parameters.EnableCompliance }} - EnableAPIScan: ${{ parameters.EnableAPIScan }} + EnableAPIScan: ${{ and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }} windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: name: AzurePipelines-EO From caf95ea5722003e7164c10ca2825d592a53368cb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 26 Feb 2024 15:24:50 -0700 Subject: [PATCH 0997/1753] Remove artifact publish task from non-OptProf runs --- azure-pipelines/microbuild.after.yml | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 94e83d349..34bdb452e 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -14,7 +14,7 @@ steps: $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) -- ${{ if parameters.EnableOptProf }}: +- ${{ if parameters.IsOptProf }}: - task: ms-vscs-artifact.build-tasks.artifactDropTask-1.artifactDropTask@0 inputs: dropServiceURI: https://devdiv.artifacts.visualstudio.com @@ -26,10 +26,9 @@ steps: condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) continueOnError: true - - ${{ if parameters.IsOptProf }}: - - task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/InsertionOutputs - ArtifactName: InsertionOutputs - ArtifactType: Container - displayName: 📢 Publish InsertionOutputs as Azure DevOps artifacts + - task: PublishBuildArtifacts@1 + inputs: + PathtoPublish: $(Build.ArtifactStagingDirectory)/InsertionOutputs + ArtifactName: InsertionOutputs + ArtifactType: Container + displayName: 📢 Publish InsertionOutputs as Azure DevOps artifacts From 8d19841a37fc725ba37da73bb21d47d5cb3e37ad Mon Sep 17 00:00:00 2001 From: Vivian Lim Date: Mon, 26 Feb 2024 21:42:55 -0800 Subject: [PATCH 0998/1753] Extend default timeout for APIScan job I've seen it take over an hour on a handful of repos, so it seems like a longer timeout is a reasonable default to specify. --- azure-pipelines/apiscan.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index 2f482ca16..4e4c0c315 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -7,6 +7,7 @@ jobs: displayName: APIScan dependsOn: Windows pool: ${{ parameters.windowsPool }} + timeoutInMinutes: 120 variables: - name: SymbolsFeatureName value: $[ dependencies.Windows.outputs['SetPipelineVariables.SymbolsFeatureName'] ] From 3598bad8c118453bb492198f5809e58c66a17aee Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Feb 2024 13:44:34 -0700 Subject: [PATCH 0999/1753] Collect APIScan logs as an artifact Also only file bugs when APIScan is run against main. --- azure-pipelines/apiscan.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index 4e4c0c315..554df0ebc 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -8,6 +8,12 @@ jobs: dependsOn: Windows pool: ${{ parameters.windowsPool }} timeoutInMinutes: 120 + templateContext: + outputs: + - output: pipelineArtifact + displayName: 📢 collect apiscan artifact + targetPath: $(Pipeline.Workspace)/.gdn/.r/apiscan/001/Logs + artifactName: apiscan-logs variables: - name: SymbolsFeatureName value: $[ dependencies.Windows.outputs['SetPipelineVariables.SymbolsFeatureName'] ] @@ -42,3 +48,4 @@ jobs: inputs: GdnPublishTsaOnboard: True GdnPublishTsaConfigFile: $(Build.SourcesDirectory)\azure-pipelines\TSAOptions.json + condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main')) From 7ea6f9cb04b3b56bf6a0a6e487c84fa3fb609bb5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Feb 2024 15:44:32 -0700 Subject: [PATCH 1000/1753] Fail OptProf pipeline when profilingInputs can't be published --- azure-pipelines/microbuild.after.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 34bdb452e..6ec083861 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -24,7 +24,6 @@ steps: usePat: true displayName: 📢 Publish to Artifact Services - ProfilingInputs condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - continueOnError: true - task: PublishBuildArtifacts@1 inputs: From 48d18208f3d24fd090680f7ed4e2e4abc3da1aaa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Feb 2024 16:08:44 -0700 Subject: [PATCH 1001/1753] Add missing OptProf.targets file --- azure-pipelines/build.yml | 6 ++++++ src/OptProf.targets | 17 +++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 src/OptProf.targets diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 26b731ca3..237dd54de 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -4,6 +4,12 @@ parameters: ##### Feel free to adjust their default value as needed. # Whether this repo uses OptProf to optimize the built binaries. +# When enabling this, be sure to update these files: +# - OptProf.targets: InstallationPath and match TestCase selection with what's in the VS repo. +# - The project file(s) for the libraries to optimize must import OptProf.targets. +# - OptProf.yml: Search for LibraryName (or your library's name) and verify that those names are appropriate. +# - OptProf_part2.yml: Search for LibraryName (or your library's name) and verify that those names are appropriate. +# and create pipelines for OptProf.yml, OptProf_part2.yml - name: EnableOptProf type: boolean default: false diff --git a/src/OptProf.targets b/src/OptProf.targets new file mode 100644 index 000000000..d0167d7c1 --- /dev/null +++ b/src/OptProf.targets @@ -0,0 +1,17 @@ + + + + IBC + Common7\IDE\PrivateAssemblies\$(TargetFileName) + /ExeConfig:"%VisualStudio.InstallationUnderTest.Path%\Common7\IDE\vsn.exe" + + + + + + + + + + + From 9dce0e27cd6a1014f350d22892c8a997bb1e8458 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Feb 2024 16:18:51 -0700 Subject: [PATCH 1002/1753] Filter VSInsertionMetadata from default.config world --- azure-pipelines/variables/InsertConfigValues.ps1 | 3 ++- azure-pipelines/variables/InsertPropsValues.ps1 | 16 ++++++++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 index 3ae11de94..ae849697a 100644 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ b/azure-pipelines/variables/InsertConfigValues.ps1 @@ -3,7 +3,8 @@ $InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") $icv=@() foreach ($kvp in $InsertedPkgs.GetEnumerator()) { $kvp.Value |% { - if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + # Skip VSInsertionMetadata packages for default.config world, which doesn't use it any more. + if (($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") -and $_.Name -notmatch 'VSInsertionMetadata') { $id = $Matches[1] $version = $Matches[2] $icv += "$id=$version" diff --git a/azure-pipelines/variables/InsertPropsValues.ps1 b/azure-pipelines/variables/InsertPropsValues.ps1 index 8d1e70a11..3ae11de94 100644 --- a/azure-pipelines/variables/InsertPropsValues.ps1 +++ b/azure-pipelines/variables/InsertPropsValues.ps1 @@ -1,2 +1,14 @@ -# These values are commonly the same. -& "$PSScriptRoot/InsertConfigValues.ps1" +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") + +$icv=@() +foreach ($kvp in $InsertedPkgs.GetEnumerator()) { + $kvp.Value |% { + if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + $id = $Matches[1] + $version = $Matches[2] + $icv += "$id=$version" + } + } +} + +Write-Output ([string]::join(',',$icv)) From 2fbec404a9ded799155d83443856d063dd1afdaa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Feb 2024 11:29:55 -0700 Subject: [PATCH 1003/1753] Enable APIScan --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 015e88747..c71c0d3b3 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -47,7 +47,7 @@ parameters: - name: EnableAPIScan displayName: Include APIScan with Compliance tools type: boolean - default: false # enable when we get it passing + default: true resources: repositories: From aa44aabb455656e0adf9d0e640fb6979e6277a2e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 27 Feb 2024 18:02:25 -0700 Subject: [PATCH 1004/1753] Preserve more apiscan logs --- azure-pipelines/apiscan.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index 554df0ebc..c3141d059 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -39,6 +39,7 @@ jobs: softwareVersionNum: $(NBGV_MajorMinorVersion) isLargeApp: false toolVersion: Latest + preserveLogsFolder: true env: AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) From ca4685c283982e530b8494098e160b026ff7b411 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 28 Feb 2024 12:18:00 -0700 Subject: [PATCH 1005/1753] Send TSA notifications to myself only --- azure-pipelines/TSAOptions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/TSAOptions.json b/azure-pipelines/TSAOptions.json index 099fffa81..bee919ce6 100644 --- a/azure-pipelines/TSAOptions.json +++ b/azure-pipelines/TSAOptions.json @@ -5,7 +5,7 @@ "tsaStamp": "DevDiv", "tsaEnvironment": "PROD", "notificationAliases": [ - "vsidemicrobuild@microsoft.com" + "andarno@microsoft.com" ], "codebaseAdmins": [ "REDMOND\\andarno" From 990c095107389e5cc9f88defec36b3c1cc67bea0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 29 Feb 2024 12:37:10 -0700 Subject: [PATCH 1006/1753] Add comment about multi-targeting projects --- azure-pipelines/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 237dd54de..27a4aed96 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -6,7 +6,7 @@ parameters: # Whether this repo uses OptProf to optimize the built binaries. # When enabling this, be sure to update these files: # - OptProf.targets: InstallationPath and match TestCase selection with what's in the VS repo. -# - The project file(s) for the libraries to optimize must import OptProf.targets. +# - The project file(s) for the libraries to optimize must import OptProf.targets (for multi-targeted projects, only import it for ONE target). # - OptProf.yml: Search for LibraryName (or your library's name) and verify that those names are appropriate. # - OptProf_part2.yml: Search for LibraryName (or your library's name) and verify that those names are appropriate. # and create pipelines for OptProf.yml, OptProf_part2.yml From 36a27d828388373b91d424b196ebda381f9ef2cf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 4 Mar 2024 14:15:17 -0700 Subject: [PATCH 1007/1753] Stop filtering out win-arm64 binaries from APIScan --- azure-pipelines/artifacts/APIScanInputs.ps1 | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/artifacts/APIScanInputs.ps1 b/azure-pipelines/artifacts/APIScanInputs.ps1 index 155564130..b1550bfa2 100644 --- a/azure-pipelines/artifacts/APIScanInputs.ps1 +++ b/azure-pipelines/artifacts/APIScanInputs.ps1 @@ -2,12 +2,10 @@ $inputs = & "$PSScriptRoot/symbols.ps1" if (!$inputs) { return } -# Filter out specific files that APIScan does not support. -# Specifically, APIScan doesn't support Windows ARM64 binaries, nor linux/OSX binaries. +# Filter out specific files that target OS's that are not subject to APIScan. +# Files that are subject but are not supported must be scanned and an SEL exception filed. $outputs = @{} $forbiddenSubPaths = @( - , 'arm64' - , 'win-arm64' , 'linux-*' , 'osx*' ) From 2a27d267d990d2a0a7078da1593de322bd051263 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 4 Mar 2024 14:54:06 -0700 Subject: [PATCH 1008/1753] Document use case for nuspec file --- azure-pipelines/InsertionMetadataPackage.nuspec | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/InsertionMetadataPackage.nuspec b/azure-pipelines/InsertionMetadataPackage.nuspec index f7aa3e3f6..aae33f5c4 100644 --- a/azure-pipelines/InsertionMetadataPackage.nuspec +++ b/azure-pipelines/InsertionMetadataPackage.nuspec @@ -1,5 +1,6 @@ - + + LibraryName.VSInsertionMetadata $version$ From b0d6c287cef6b1f4b28b21087aa2a4e1c96b9324 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 11 Mar 2024 14:12:34 -0600 Subject: [PATCH 1009/1753] Build stable 17.10 version --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index dcb7e71d6..e8601b60d 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.10-preview", + "version": "17.10", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 7220c37ffe0189b2e831bdb9fc7b99dd1f28b13d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 15 Mar 2024 11:56:27 -0600 Subject: [PATCH 1010/1753] Fix validation pipeline --- azure-pipelines/vs-validation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 4d385796e..ca2a7a68d 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -41,7 +41,7 @@ extends: - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: ArchiveSymbols: false - RealSign: ${{ parameters.RealSign }} + RealSign: true - stage: insertion displayName: VS insertion From dd4956a1b8fecdd7570c49f1cbb5a77fce2d061b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Mar 2024 10:15:18 -0600 Subject: [PATCH 1011/1753] Switch APIScan to use a managed identity --- azure-pipelines/apiscan.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index c3141d059..73af52596 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -21,7 +21,7 @@ jobs: value: $[ dependencies.Windows.outputs['nbgv.NBGV_MajorMinorVersion'] ] - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: # https://dev.azure.com/devdiv/DevDiv/_wiki/wikis/DevDiv.wiki/25351/APIScan-step-by-step-guide-to-setting-up-a-Pipeline - - group: VSCloudServices-APIScan # Expected to provide ApiScanClientId, ApiScanSecret, ApiScanTenant + - group: VSEng sponsored APIScan # Expected to provide ApiScanClientId steps: # We need TSAOptions.json - checkout: self @@ -41,7 +41,7 @@ jobs: toolVersion: Latest preserveLogsFolder: true env: - AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId);TenantId=$(ApiScanTenant);AppKey=$(ApiScanSecret) + AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId) # File bugs when APIScan finds issues - task: TSAUpload@2 From e2bf1ceee715d4c2a4ee08e2079a8f0f9b17159b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Mar 2024 12:09:32 -0600 Subject: [PATCH 1012/1753] Update PublishCodeCoverageResults task to v2 --- azure-pipelines/publish-codecoverage.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/azure-pipelines/publish-codecoverage.yml b/azure-pipelines/publish-codecoverage.yml index fbb6a39a7..8ec94e64a 100644 --- a/azure-pipelines/publish-codecoverage.yml +++ b/azure-pipelines/publish-codecoverage.yml @@ -17,9 +17,8 @@ steps: condition: and(succeeded(), ${{ parameters.includeMacOS }}) - powershell: azure-pipelines/Merge-CodeCoverage.ps1 -Path '$(Pipeline.Workspace)' -OutputFile coveragereport/merged.cobertura.xml -Format Cobertura -Verbose displayName: ⚙ Merge coverage -- task: PublishCodeCoverageResults@1 +- task: PublishCodeCoverageResults@2 displayName: 📢 Publish code coverage results to Azure DevOps inputs: - codeCoverageTool: cobertura summaryFileLocation: coveragereport/merged.cobertura.xml failIfCoverageEmpty: true From 3271c787c892c1c48264f584c0f3e7b9d602b576 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Mar 2024 16:04:38 +0000 Subject: [PATCH 1013/1753] Bump dotnet-coverage from 17.10.3 to 17.10.4 (#264) --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index dfd00e462..191eceaca 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.10.3", + "version": "17.10.4", "commands": [ "dotnet-coverage" ] From da8a36d6071e13f0980ad3e6090d9d8199d36604 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Fri, 29 Mar 2024 11:59:58 -0700 Subject: [PATCH 1014/1753] Prevent creating two task waiting chains per AsyncLazy.GetValueAsync(CancellationToken) call. Those appeared a lot during the solution open time, because some global AsyncLazy doesn't provide value until the blocking loading time ends. And cancellation token is often used to handle the case loading is aborted. The reason why we didn't eliminate the duplication earlier is the JTF.JoinAsync and task.WithCancellation handles in-middle task continuation differently. The JTF one generally will capture the SynchorizationContext, while the task one would not. The exact performance charcter of the two choices is different. The JTF one prevent additional dependency to the thread pool in some cases, but may add unnecessary dependency to the UI thread in other cases, while the other one is on the reverse side. So eliminating the two chains could impact perf, because the accidental UI thread dependency is more likely to cause performance problems than the other one. It is impossible to decide which behavior is better, because the best choice should be aligned to the ConfiguredAwaiter option to wait the task later. But provide this extra option would make API more complex. In this case, we try to make the behavior matching the exisiting GetValueAsync API. Capturing the context makes little sense for the task which is forgotten in the original code path. --- .../AsyncLazy`1.cs | 7 +- .../JoinableTask`1.cs | 76 +++++++++++-------- 2 files changed, 45 insertions(+), 38 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 0b98fc7ad..24cafee01 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -245,12 +245,7 @@ public Task GetValueAsync(CancellationToken cancellationToken) resumableAwaiter?.Resume(); } - if (!this.value.IsCompleted) - { - this.joinableTask?.JoinAsync(cancellationToken).Forget(); - } - - return this.value.WithCancellation(cancellationToken); + return this.joinableTask?.JoinAsync(continueOnCapturedContext: false, cancellationToken) ?? this.value.WithCancellation(cancellationToken); } /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index 1ebead4ee..b7748174d 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -49,6 +49,46 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, str /// A cancellation token that will exit this method before the task is completed. /// A task that completes after the asynchronous operation completes and the join is reverted, with the result of the operation. public new Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) + { + return this.JoinAsync(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken); + } + + /// + /// Synchronously blocks the calling thread until the operation has completed. + /// If the calling thread is the Main thread, deadlocks are mitigated. + /// + /// A cancellation token that will exit this method before the task is completed. + /// The result of the asynchronous operation. + public new T Join(CancellationToken cancellationToken = default(CancellationToken)) + { + base.Join(cancellationToken); + Assumes.True(this.Task.IsCompleted); + return this.Task.Result; + } + + /// + /// Gets an awaiter that is equivalent to calling . + /// + /// A task whose result is the result of the asynchronous operation. + public new TaskAwaiter GetAwaiter() + { + return this.JoinAsync().GetAwaiter(); + } + + internal new T CompleteOnCurrentThread() + { + base.CompleteOnCurrentThread(); + return this.Task.GetAwaiter().GetResult(); + } + + /// + /// Joins any main thread affinity of the caller with the asynchronous operation to avoid deadlocks + /// in the event that the main thread ultimately synchronously blocks waiting for the operation to complete. + /// + /// A value indicating whether *internal* continuations required to respond to cancellation should run on the current . + /// A cancellation token that will exit this method before the task is completed. + /// A task that completes after the asynchronous operation completes and the join is reverted, with the result of the operation. + internal Task JoinAsync(bool continueOnCapturedContext, CancellationToken cancellationToken = default(CancellationToken)) { cancellationToken.ThrowIfCancellationRequested(); if (this.IsCompleted) @@ -65,18 +105,18 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, str } else { - return JoinSlowAsync(this, cancellationToken); + return JoinSlowAsync(this, continueOnCapturedContext, cancellationToken); } - static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancellationToken) + static async Task JoinSlowAsync(JoinableTask me, bool continueOnCapturedContext, CancellationToken cancellationToken) { // No need to dispose of this except in cancellation case. JoinableTaskCollection.JoinRelease dependency = me.AmbientJobJoinsThis(); try { - await me.Task.WithCancellation(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken).ConfigureAwait(AwaitShouldCaptureSyncContext); - return await me.Task.ConfigureAwait(AwaitShouldCaptureSyncContext); + await me.Task.WithCancellation(continueOnCapturedContext, cancellationToken).ConfigureAwait(continueOnCapturedContext); + return await me.Task.ConfigureAwait(continueOnCapturedContext); } catch (OperationCanceledException) { @@ -86,34 +126,6 @@ static async Task JoinSlowAsync(JoinableTask me, CancellationToken cancell } } - /// - /// Synchronously blocks the calling thread until the operation has completed. - /// If the calling thread is the Main thread, deadlocks are mitigated. - /// - /// A cancellation token that will exit this method before the task is completed. - /// The result of the asynchronous operation. - public new T Join(CancellationToken cancellationToken = default(CancellationToken)) - { - base.Join(cancellationToken); - Assumes.True(this.Task.IsCompleted); - return this.Task.Result; - } - - /// - /// Gets an awaiter that is equivalent to calling . - /// - /// A task whose result is the result of the asynchronous operation. - public new TaskAwaiter GetAwaiter() - { - return this.JoinAsync().GetAwaiter(); - } - - internal new T CompleteOnCurrentThread() - { - base.CompleteOnCurrentThread(); - return this.Task.GetAwaiter().GetResult(); - } - /// internal override object CreateTaskCompletionSource() => new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); From 85dc18ca1748f2c61face07710a93343e6b6e8a0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Apr 2024 17:23:00 -0600 Subject: [PATCH 1015/1753] Update symbol archival task --- azure-pipelines/prepare-insertion-stages.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index da163c76f..ab4507c4e 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -25,13 +25,12 @@ stages: - download: current artifact: symbols-legacy displayName: 🔻 Download symbols-legacy artifact - - task: MicroBuildArchiveSymbols@4 + - task: MicroBuildArchiveSymbols@5 displayName: 🔣 Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) SymbolsProject: VS SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy - azureSubscription: Symbols Upload (DevDiv) - ${{ if false }}: # Switch to true to enable, but leave the condition to avoid merge conflicts later. - job: push From d675ffed83b59aaa4f6d7cc36eb59860af6ae02b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 6 Apr 2024 08:08:34 -0600 Subject: [PATCH 1016/1753] Insert into rel/d17.10 --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..e36ad603d 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.10' From ac039ef3e2bd113c1921cda9257b126bfae98893 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 6 Apr 2024 08:11:47 -0600 Subject: [PATCH 1017/1753] Build 17.11-preview --- .../variables/InsertTargetBranch.ps1 | 2 +- .../net472/PublicAPI.Shipped.txt | 18 ++++++++++++++++++ .../net472/PublicAPI.Unshipped.txt | 18 ------------------ .../net6.0-windows/PublicAPI.Shipped.txt | 19 +++++++++++++++++++ .../net6.0-windows/PublicAPI.Unshipped.txt | 18 ------------------ .../net6.0/PublicAPI.Shipped.txt | 18 ++++++++++++++++++ .../net6.0/PublicAPI.Unshipped.txt | 18 ------------------ .../netstandard2.0/PublicAPI.Shipped.txt | 18 ++++++++++++++++++ .../netstandard2.0/PublicAPI.Unshipped.txt | 18 ------------------ version.json | 2 +- 10 files changed, 75 insertions(+), 74 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index e36ad603d..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.10' +'main' diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt index 591cdfcc6..6f08bf254 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt @@ -495,3 +495,21 @@ virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index e099d0429..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,18 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt index 591cdfcc6..f137c98ce 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Shipped.txt @@ -495,3 +495,22 @@ virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance + diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index e099d0429..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -1,18 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt index c11a2e452..4c48319b5 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Shipped.txt @@ -493,3 +493,21 @@ virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index e099d0429..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -1,18 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt index c11a2e452..4c48319b5 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt @@ -493,3 +493,21 @@ virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock string? Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! +Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! +Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance +Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void +Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index e099d0429..e69de29bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,18 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance \ No newline at end of file diff --git a/version.json b/version.json index e8601b60d..1cb6602dd 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.10", + "version": "17.11-preview", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 0260385f339cc2eca3010d5ee9a628bade39946a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 6 Apr 2024 08:14:26 -0600 Subject: [PATCH 1018/1753] Bump System.Threading.Tasks.Dataflow from 7.0.0 to 8.0.0 (#1292) Bumps [System.Threading.Tasks.Dataflow](https://github.com/dotnet/runtime) from 7.0.0 to 8.0.0. - [Release notes](https://github.com/dotnet/runtime/releases) - [Commits](https://github.com/dotnet/runtime/compare/v7.0.0...v8.0.0) --- updated-dependencies: - dependency-name: System.Threading.Tasks.Dataflow dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c47e15253..77e11c7b5 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -38,7 +38,7 @@ - + From a00169c7ec87178813f3b9780f8f45562dc7c6e7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 6 Apr 2024 08:15:43 -0600 Subject: [PATCH 1019/1753] Bump Microsoft.Bcl.AsyncInterfaces from 7.0.0 to 8.0.0 (#1281) Bumps [Microsoft.Bcl.AsyncInterfaces](https://github.com/dotnet/runtime) from 7.0.0 to 8.0.0. - [Release notes](https://github.com/dotnet/runtime/releases) - [Commits](https://github.com/dotnet/runtime/compare/v7.0.0...v8.0.0) --- updated-dependencies: - dependency-name: Microsoft.Bcl.AsyncInterfaces dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 77e11c7b5..c69ae329a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + From 4f3380c6acb15218f2ed9a195e6ea1dbbc86d0dc Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 15 Apr 2024 17:35:10 -0700 Subject: [PATCH 1020/1753] Skip sending ETW trace event for nested lock which is always granted automatically. Asking nested lock was not considered to be costly, but sending extra ETW event makes them to pop in performance traces. Since they don't provide much value to understand those traces, we should suppress them. (Note: we don't send ETW when lock is released, so there is no work there.) --- .../AsyncReaderWriterLock.cs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index 9c4e732e6..68d488d82 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -1066,6 +1066,7 @@ private void CheckSynchronizationContextAppropriateForLock(Awaiter? awaiter) private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendingWriteLockCheck = false) { bool issued = false; + bool isOrdinaryNestedLock = false; // ordinary nested lock is a nested lock always granted immediately. We don't need write ETW event to reduce noise in traces. lock (this.syncObject) { @@ -1108,10 +1109,12 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi } issued = true; + isOrdinaryNestedLock = true; } else if (hasRead || hasUpgradeableRead) { issued = true; + isOrdinaryNestedLock = true; } break; @@ -1119,6 +1122,7 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi if (hasUpgradeableRead || hasWrite) { issued = true; + isOrdinaryNestedLock = true; } else if (hasRead) { @@ -1137,6 +1141,7 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi if (hasWrite) { issued = true; + isOrdinaryNestedLock = true; } else if (hasRead && !hasUpgradeableRead) { @@ -1170,7 +1175,10 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi if (issued) { - this.etw.Issued(awaiter); + if (!isOrdinaryNestedLock) + { + this.etw.Issued(awaiter); + } } else { From 27edc6c689a72b677dcc0cf9f596ce27f3d8b7a1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Apr 2024 05:54:42 -0600 Subject: [PATCH 1021/1753] Bump dependencies --- .config/dotnet-tools.json | 6 +++--- Directory.Packages.props | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 191eceaca..7e8a502ad 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,13 +3,13 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.4.1", + "version": "7.4.2", "commands": [ "pwsh" ] }, "dotnet-coverage": { - "version": "17.10.4", + "version": "17.11.0", "commands": [ "dotnet-coverage" ] @@ -21,4 +21,4 @@ ] } } -} \ No newline at end of file +} diff --git a/Directory.Packages.props b/Directory.Packages.props index 60ffd9224..525ae9c2d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ - + From f0444bb0bbb116d2406a7ae2c46d970f7e29c8de Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Apr 2024 16:00:55 -0600 Subject: [PATCH 1022/1753] Ensure unique `requestId` values in ETW events Fixes #1302 --- .../AsyncReaderWriterLock.cs | 18 ++++---- .../JoinableTask.cs | 10 +---- .../JoinableTaskFactory.cs | 43 ++++++++++++++++--- 3 files changed, 47 insertions(+), 24 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index 68d488d82..5ada7bbec 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -2717,9 +2717,11 @@ public override void Post(SendOrPostCallback d, object? state) { Requires.NotNull(d, nameof(d)); + int? requestId = null; if (ThreadingEventSource.Instance.IsEnabled()) { - ThreadingEventSource.Instance.PostExecutionStart(d.GetHashCode(), false); + requestId = JoinableTaskFactory.SingleExecuteProtector.GetNextRequestId(); + ThreadingEventSource.Instance.PostExecutionStart(requestId.Value, false); } // Take special care to minimize allocations and overhead by avoiding implicit delegates and closures. @@ -2727,12 +2729,12 @@ public override void Post(SendOrPostCallback d, object? state) // nor any other local variables, which means the only allocations from this call // are our Tuple and the ThreadPool's bare-minimum necessary to track the work. ThreadPool.QueueUserWorkItem( - s => + static s => { - var tuple = (Tuple)s!; - tuple.Item1.PostHelper(tuple.Item2, tuple.Item3); + var tuple = (Tuple)s!; + tuple.Item1.PostHelper(tuple.Item2, tuple.Item3, tuple.Item4); }, - Tuple.Create(this, d, state)); + Tuple.Create(this, d, state, requestId)); } /// @@ -2769,7 +2771,7 @@ internal void EarlyExitSynchronizationContext() /// We use async void instead of async Task because the caller will never /// use the result, and this way the compiler doesn't have to create the Task object. /// - private async void PostHelper(SendOrPostCallback d, object state) + private async void PostHelper(SendOrPostCallback d, object state, int? requestId) { bool delegateInvoked = false; try @@ -2779,9 +2781,9 @@ private async void PostHelper(SendOrPostCallback d, object state) try { SynchronizationContext.SetSynchronizationContext(this); - if (ThreadingEventSource.Instance.IsEnabled()) + if (ThreadingEventSource.Instance.IsEnabled() && requestId.HasValue) { - ThreadingEventSource.Instance.PostExecutionStop(d.GetHashCode()); + ThreadingEventSource.Instance.PostExecutionStop(requestId.Value); } delegateInvoked = true; // set now, before the delegate might throw. diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 703c35323..68440785b 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -737,15 +737,7 @@ internal void Post(SendOrPostCallback d, object? state, bool mainThreadAffinitiz bool backgroundThreadQueueUpdated = false; wrapper = SingleExecuteProtector.Create(this, d, state); - if (ThreadingEventSource.Instance.IsEnabled()) - { - ThreadingEventSource.Instance.PostExecutionStart(wrapper.GetHashCode(), mainThreadAffinitized); - } - - if (mainThreadAffinitized && !synchronouslyBlockingMainThread) - { - wrapper.RaiseTransitioningEvents(); - } + wrapper.RaiseTransitioningEvents(mainThreadAffinitized, synchronouslyBlockingMainThread); lock (this.JoinableTaskContext.SyncContextLock) { diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 05d25f268..a93f5fe87 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -1066,11 +1066,21 @@ internal class SingleExecuteProtector /// internal static readonly WaitCallback ExecuteOnceWaitCallback = state => ((SingleExecuteProtector)state!).TryExecute(); + /// + /// Tracks the next request ID to assign to for a new object. + /// + private static int nextRequestId; + /// /// The job that created this wrapper. /// private JoinableTask? job; + /// + /// The ID to use when calling . + /// + private int? requestId; + private bool raiseTransitionComplete; /// @@ -1118,6 +1128,17 @@ internal string DelegateLabel } } + /// + /// Returns a unique value for use when calling + /// and . + /// + /// The unique value. + /// + /// Values may be negative or zero if more than IDs have been created. + /// Values may be reused if more than 2^32 IDs have been created. + /// + internal static int GetNextRequestId() => Interlocked.Increment(ref nextRequestId); + /// /// Initializes a new instance of the class. /// @@ -1209,13 +1230,21 @@ internal IEnumerable WalkAsyncReturnStackFrames() } } - internal void RaiseTransitioningEvents() + internal void RaiseTransitioningEvents(bool mainThreadAffinitized, bool synchronouslyBlockingMainThread) { - Assumes.False(this.raiseTransitionComplete); // if this method is called twice, that's the sign of a problem. - RoslynDebug.Assert(this.job is object); + if (ThreadingEventSource.Instance.IsEnabled()) + { + this.requestId = GetNextRequestId(); + ThreadingEventSource.Instance.PostExecutionStart(this.requestId.Value, mainThreadAffinitized); + } - this.raiseTransitionComplete = true; - this.job.Factory.OnTransitioningToMainThread(this.job); + if (mainThreadAffinitized && !synchronouslyBlockingMainThread) + { + Assumes.False(this.raiseTransitionComplete); // if this method is called twice, that's the sign of a problem. + this.raiseTransitionComplete = true; + RoslynDebug.Assert(this.job is object); + this.job.Factory.OnTransitioningToMainThread(this.job); + } } /// @@ -1259,9 +1288,9 @@ internal bool TryExecute() /// private void OnExecuting() { - if (ThreadingEventSource.Instance.IsEnabled()) + if (ThreadingEventSource.Instance.IsEnabled() && this.requestId is int requestId) { - ThreadingEventSource.Instance.PostExecutionStop(this.GetHashCode()); + ThreadingEventSource.Instance.PostExecutionStop(requestId); } // While raising the event, automatically remove the handlers since we'll only From 7945f3503caf1ff18dccb41c6b8303e14dfe6928 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 23 Apr 2024 20:45:29 -0600 Subject: [PATCH 1023/1753] Disable scheduled pipeline runs This branch hasn't been upgraded to 1ES PT, and we shouldn't run it in pipelines unless/until it has been. --- azure-pipelines/OptProf.yml | 8 -------- azure-pipelines/official.yml | 8 -------- 2 files changed, 16 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index abb2f2fb5..464f9a806 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -1,13 +1,5 @@ trigger: none pr: none -schedules: - - cron: "0 3 * * Tue" # Mon @ 8 or 9 PM Mountain Time (depending on DST) - displayName: Weekly OptProf run - branches: - include: - - 'v1*' - - main - always: true # we must keep data fresh since optimizationdata drops are purged after 30 days # Avoid errant CI builds: https://developercommunity.visualstudio.com/content/problem/1154409/azure-pipeline-is-triggering-due-to-events-that-ne.html #resources: diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 25cfc6751..219cf19ec 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -12,14 +12,6 @@ trigger: - doc/ - '*.md' - .vscode/ -schedules: -- cron: "0 3 * * *" # Daily @ 8 PM PST - displayName: Daily vs-insertion - branches: - include: - - main - - 'v16.*' - - 'v17.*' parameters: - name: SignTypeSelection From e32832fcfb4a08b437328abcc69ed90535e607d4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 23 Apr 2024 20:54:18 -0600 Subject: [PATCH 1024/1753] Turn off CI for unsupported branch --- azure-pipelines/official.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 219cf19ec..4b459a904 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -3,9 +3,6 @@ trigger: branches: include: - main - - 'v16.*' - - 'v17.*' - - 'validate/*' paths: exclude: - .github/ From dfd8a825c20653ce2e340699571add3f30d65a00 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 24 Apr 2024 11:30:10 -0600 Subject: [PATCH 1025/1753] Remove InsertConfigValues variable MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit CoreXT is no more! 🎈🙌🏼🥳 --- azure-pipelines/OptProf.yml | 2 +- azure-pipelines/artifacts/VSInsertion.ps1 | 6 +++--- azure-pipelines/dotnet.yml | 2 +- azure-pipelines/variables/InsertConfigValues.ps1 | 14 -------------- azure-pipelines/variables/InsertPropsValues.ps1 | 16 ++++++++++++++-- azure-pipelines/vs-insertion.yml | 2 +- azure-pipelines/vs-validation.yml | 2 +- 7 files changed, 21 insertions(+), 23 deletions(-) delete mode 100644 azure-pipelines/variables/InsertConfigValues.ps1 diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index d95c84c8d..059a435c2 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -75,7 +75,7 @@ stages: targetType: filePath filePath: $(Agent.TempDirectory)/Variables-Windows/_pipelines.ps1 - task: NuGetCommand@2 - displayName: Push CoreXT packages to VS feed + displayName: Push VS-repo packages to VS feed inputs: command: push packagesToPush: $(Agent.TempDirectory)/VSInsertion-Windows/*.nupkg diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 4757c9c27..4c528f52f 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -28,7 +28,7 @@ $result = @{ } if ($env:IsOptProf) { - $CoreXTPackages = "$RepoRoot/bin/Packages/$BuildConfiguration/CoreXT" + $VSRepoPackages = "$RepoRoot/bin/Packages/$BuildConfiguration/VSRepo" $ArtifactBasePath = "$RepoRoot\obj\_artifacts" $ArtifactPath = "$ArtifactBasePath\VSInsertion" @@ -47,12 +47,12 @@ if ($env:IsOptProf) { # ultimately resulting in a failure of the optprof run. $InsertionMetadataVersion += '.' + $env:BUILD_BUILDID } - & (& "$PSScriptRoot\..\Get-NuGetTool.ps1") pack "$PSScriptRoot\..\InsertionMetadataPackage.nuspec" -OutputDirectory $CoreXTPackages -BasePath $ArtifactPath -Version $InsertionMetadataVersion | Out-Null + & (& "$PSScriptRoot\..\Get-NuGetTool.ps1") pack "$PSScriptRoot\..\InsertionMetadataPackage.nuspec" -OutputDirectory $VSRepoPackages -BasePath $ArtifactPath -Version $InsertionMetadataVersion | Out-Null if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - $result["$CoreXTPackages"] = (Get-ChildItem "$CoreXTPackages\LibraryName.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); + $result["$VSRepoPackages"] = (Get-ChildItem "$VSRepoPackages\LibraryName.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); } $result diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 3f4ac7534..828bd7b95 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -17,7 +17,7 @@ steps: condition: and(succeeded(), ${{ parameters.RunTests }}) - ${{ if parameters.IsOptProf }}: - # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertConfigValues.ps1 to notice. + # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertPropsValues.ps1 to notice. - powershell: azure-pipelines\artifacts\VSInsertion.ps1 displayName: 🔧 Prepare VSInsertion artifact diff --git a/azure-pipelines/variables/InsertConfigValues.ps1 b/azure-pipelines/variables/InsertConfigValues.ps1 deleted file mode 100644 index 3ae11de94..000000000 --- a/azure-pipelines/variables/InsertConfigValues.ps1 +++ /dev/null @@ -1,14 +0,0 @@ -$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") - -$icv=@() -foreach ($kvp in $InsertedPkgs.GetEnumerator()) { - $kvp.Value |% { - if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { - $id = $Matches[1] - $version = $Matches[2] - $icv += "$id=$version" - } - } -} - -Write-Output ([string]::join(',',$icv)) diff --git a/azure-pipelines/variables/InsertPropsValues.ps1 b/azure-pipelines/variables/InsertPropsValues.ps1 index 8d1e70a11..3ae11de94 100644 --- a/azure-pipelines/variables/InsertPropsValues.ps1 +++ b/azure-pipelines/variables/InsertPropsValues.ps1 @@ -1,2 +1,14 @@ -# These values are commonly the same. -& "$PSScriptRoot/InsertConfigValues.ps1" +$InsertedPkgs = (& "$PSScriptRoot\..\artifacts\VSInsertion.ps1") + +$icv=@() +foreach ($kvp in $InsertedPkgs.GetEnumerator()) { + $kvp.Value |% { + if ($_.Name -match "^(.*?)\.(\d+\.\d+\.\d+(?:\.\d+)?(?:-.*?)?)(?:\.symbols)?\.nupkg$") { + $id = $Matches[1] + $version = $Matches[2] + $icv += "$id=$version" + } + } +} + +Write-Output ([string]::join(',',$icv)) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 8a6ffa0e6..084b84ebe 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -41,7 +41,7 @@ extends: artifact: VSInsertion-Windows displayName: 🔻 Download VSInsertion-Windows artifact - task: 1ES.PublishNuget@1 - displayName: 📦 Push CoreXT packages to VS feed + displayName: 📦 Push VS-repo packages to VS feed inputs: packagesToPush: '$(Pipeline.Workspace)/CI/VSInsertion-Windows/*.nupkg' packageParentPath: $(Pipeline.Workspace)/CI/VSInsertion-Windows diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index ca2a7a68d..4638671ce 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -62,7 +62,7 @@ extends: artifact: VSInsertion-Windows displayName: 🔻 Download VSInsertion-Windows artifact - task: 1ES.PublishNuget@1 - displayName: 📦 Push CoreXT packages to VS feed + displayName: 📦 Push VS-repo packages to VS feed inputs: packagesToPush: '$(Pipeline.Workspace)/VSInsertion-Windows/*.nupkg' packageParentPath: $(Pipeline.Workspace)/VSInsertion-Windows From ace939170b10ea63e17fe6c1b3325eb3f143a80a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 30 Apr 2024 06:55:08 -0600 Subject: [PATCH 1026/1753] Bump xunit to 2.8.0 --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 525ae9c2d..382835c32 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,8 +7,8 @@ - - + + From 6d31ebd6d6374e398f7184ea4e057ea3d52398d4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 30 Apr 2024 06:56:12 -0600 Subject: [PATCH 1027/1753] Bump MicroBuild to 2.0.152 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b63cecc64..6be4e801f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.149 + 2.0.152 From 37db90c1b419212ec938aa5fa6024454691a69ff Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 30 Apr 2024 08:37:36 -0600 Subject: [PATCH 1028/1753] Rollback Microsoft.Bcl.AsyncInterfaces to 6.0.0 This way we're consuming the same version of the dependency whether we're on .NET Framework or the .NET 6 runtime which we also target. Also drop a couple of unnecessary dependencies from the Analyzers.Tests project. --- .github/dependabot.yml | 1 + Directory.Packages.props | 4 +--- .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 -- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 6cc61b83c..537ed1809 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,3 +9,4 @@ updates: interval: weekly ignore: - dependency-name: Microsoft.CodeAnalysis* # We intentionally target older VS versions. + - dependency-name: Microsoft.Bcl.AsyncInterfaces # We want to match the minimum target .NET runtime diff --git a/Directory.Packages.props b/Directory.Packages.props index c47e15253..98e44e5a1 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + @@ -35,10 +35,8 @@ - - diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 57b74d502..edf0c586c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -29,8 +29,6 @@ - - From 67811f45e8f389a65dec7f85fbe994af38783259 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 30 Apr 2024 08:53:22 -0600 Subject: [PATCH 1029/1753] Don't update System.Collections.Immutable automatically We want this to stay in sync with our minimal target .NET runtime version. --- .github/dependabot.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 537ed1809..1149f07e1 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -10,3 +10,4 @@ updates: ignore: - dependency-name: Microsoft.CodeAnalysis* # We intentionally target older VS versions. - dependency-name: Microsoft.Bcl.AsyncInterfaces # We want to match the minimum target .NET runtime + - dependency-name: System.Collections.Immutable # We want to match the minimum target .NET runtime From d9fdbca09241b4367e7c4fe50f88dac89e320356 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 30 Apr 2024 11:39:54 -0600 Subject: [PATCH 1030/1753] Disable tests that fail after xunit update --- .../AsyncAutoResetEventTests.cs | 6 ++++-- .../AsyncQueueTests.cs | 1 + .../AsyncReaderWriterLockTests.cs | 1 + .../Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs | 2 ++ 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs index 5bfb23e95..ad1d4431c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncAutoResetEventTests.cs @@ -200,8 +200,9 @@ public async Task WaitAsync_Canceled_Stress() /// /// Verifies that long-lived, uncanceled CancellationTokens do not result in leaking memory. /// - [SkippableFact] + [SkippableFact(Skip = "It always fails after xunit 2.8 update.")] [Trait("GC", "true")] + [Trait("TestCategory", "FailsInCloudTest")] public async Task WaitAsync_WithCancellationToken_DoesNotLeakWhenNotCanceled() { if (await this.ExecuteInIsolationAsync()) @@ -221,8 +222,9 @@ public async Task WaitAsync_WithCancellationToken_DoesNotLeakWhenNotCanceled() /// /// Verifies that canceled CancellationTokens do not result in leaking memory. /// - [SkippableFact] + [SkippableFact(Skip = "It always fails after xunit 2.8 update.")] [Trait("GC", "true")] + [Trait("TestCategory", "FailsInCloudTest")] public async Task WaitAsync_WithCancellationToken_DoesNotLeakWhenCanceled() { if (await this.ExecuteInIsolationAsync()) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs index ea885b186..65c5700df 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs @@ -544,6 +544,7 @@ public void OnCompletedInvoked() } [SkippableFact, Trait("GC", "true")] + [Trait("TestCategory", "FailsInCloudTest")] public void UnusedQueueGCPressure() { if (this.ExecuteInIsolation()) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index 828a10f4d..8b7690814 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -231,6 +231,7 @@ public async Task CompleteMethodExecutesContinuationsAsynchronously() } [SkippableFact] + [Trait("TestCategory", "FailsInCloudTest")] public async Task NoMemoryLeakForManyLocks() { if (await this.ExecuteInIsolationAsync()) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs index 16e5bdcdb..52853bcb0 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs @@ -91,6 +91,7 @@ public void ExecuteOnDispatcher_PropagatesExceptions() } [SkippableFact] + [Trait("TestCategory", "FailsInCloudTest")] public async Task ExecuteInIsolation_PassingTest() { if (await this.ExecuteInIsolationAsync()) @@ -120,6 +121,7 @@ public async Task ExecuteInIsolation_FailingTest() #if NETFRAMEWORK [StaFact] + [Trait("TestCategory", "FailsInCloudTest")] public async Task ExecuteInIsolation_PassingOnSTA() { if (await this.ExecuteInIsolationAsync()) From 37d34d1e225ad370a4ea2a0f187da6afb1c74337 Mon Sep 17 00:00:00 2001 From: Oscar Obeso Date: Tue, 30 Apr 2024 17:20:13 -0700 Subject: [PATCH 1031/1753] Always include API Scan Logs --- azure-pipelines/apiscan.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index 73af52596..af78f15c0 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -14,6 +14,7 @@ jobs: displayName: 📢 collect apiscan artifact targetPath: $(Pipeline.Workspace)/.gdn/.r/apiscan/001/Logs artifactName: apiscan-logs + condition: succeededOrFailed() variables: - name: SymbolsFeatureName value: $[ dependencies.Windows.outputs['SetPipelineVariables.SymbolsFeatureName'] ] From 1ec03f1869351e57fd74848bc195771f369ff5b6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Apr 2024 17:23:00 -0600 Subject: [PATCH 1032/1753] Update symbol archival task --- azure-pipelines/prepare-insertion-stages.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 4122f39e6..b4d4ad68d 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -25,13 +25,12 @@ stages: - download: current artifact: symbols-legacy displayName: 🔻 Download symbols-legacy artifact - - task: MicroBuildArchiveSymbols@4 + - task: MicroBuildArchiveSymbols@5 displayName: 🔣 Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) SymbolsProject: VS SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy - azureSubscription: Symbols Upload (DevDiv) - ${{ if true }}: # leave the condition to avoid merge conflicts later. - job: push From 36cc299507a718548c186385dff2b5e659671076 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 2 May 2024 08:38:48 -0600 Subject: [PATCH 1033/1753] Increase `AsyncCrossProcessMutex` stack size This avoids a StackOverflowException when dotnet tracing is turned on. --- src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs b/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs index dbe0162c1..599d66d76 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs @@ -54,7 +54,7 @@ public class AsyncCrossProcessMutex public AsyncCrossProcessMutex(string name) { Requires.NotNullOrEmpty(name); - this.namedMutexOwner = new Thread(this.MutexOwnerThread, 100 * 1024) + this.namedMutexOwner = new Thread(this.MutexOwnerThread, 256 * 1024) { Name = $"{nameof(AsyncCrossProcessMutex)}-{name}", }; From 9064f57e0ccdf70cc86c3f8b3824e915673a2e2b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 May 2024 08:55:18 -0600 Subject: [PATCH 1034/1753] Turn off OptProf for v17.9 branch --- azure-pipelines/OptProf.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 5e427d084..c30e6caf7 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -5,7 +5,6 @@ schedules: displayName: Weekly OptProf run branches: include: - - 'v1*' - main always: true # we must keep data fresh since optimizationdata drops are purged after 30 days From d6011ee2192e35411266d5bb1e9232a2e6d9987b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 May 2024 10:06:27 -0600 Subject: [PATCH 1035/1753] Add missing TeamName to source code archival pipeline --- azure-pipelines/archive-sourcecode.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index c550e2c2d..12b4d0c97 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -30,6 +30,7 @@ parameters: variables: - group: VS Core team # Expected to provide ManagerAlias, SourceCodeArchivalUri +- template: GlobalVariables.yml extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate From bc17102e910cd16192d5cec85c72ed8e2852f788 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 May 2024 15:13:40 -0600 Subject: [PATCH 1036/1753] Fix empty optimization inputs drops Skipping optimization in OptProf runs is useful to keep the OptProf pipeline running when no optimization input drops exist (perhaps because they expired, or it's the first run of the optprof pipeline). But skipping optimization breaks the optprof pipeline's LKG feature that reuses older data when a test failure occurs so that the new drop has at least *something* rather than being empty, which breaks the main build pipeline. Lately, empty optimization input drops have broken our pipelines several times. --- azure-pipelines/OptProf.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 059a435c2..db2eead72 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -17,6 +17,12 @@ schedules: # name: DeploymentScripts # ref: refs/heads/test +parameters: + - name: ShouldSkipOptimize + displayName: Skip OptProf optimization + type: boolean + default: false # Should usually be false so that optprof LKG can apply when tests fail, but may need to be set to true in a manually queued pipeline run if all drops have expired. + variables: - template: GlobalVariables.yml - name: PublicRelease @@ -37,7 +43,7 @@ stages: RealSign: true windowsPool: VSEngSS-MicroBuild2022-1ES EnableMacOSBuild: false - ShouldSkipOptimize: true + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} IsOptProf: true RunTests: false - stage: QueueVSBuild From 34afdf35d529690f2338ff26b122f1f396eb8342 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 May 2024 15:07:02 -0600 Subject: [PATCH 1037/1753] Fix documentation around `AsyncQueue` completion Fixes #1306 --- src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs index 6a7a1b5ed..324aa3268 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs @@ -82,7 +82,7 @@ public int Count } /// - /// Gets a value indicating whether the queue has completed. + /// Gets a value indicating whether the queue is both empty and had invoked. /// /// /// This is arguably redundant with .IsCompleted, but this property @@ -101,7 +101,7 @@ public bool IsCompleted } /// - /// Gets a task that transitions to a completed state when is called. + /// Gets a task that transitions to a completed state when is called and the queue is empty. /// public Task Completion { @@ -142,6 +142,11 @@ public Task Completion /// /// Signals that no further elements will be enqueued. /// + /// + /// This method will return immediately. + /// Elements enqueued before calling this method may still be dequeued. + /// will return true only after this method has been called and the queue is empty. + /// public void Complete() { lock (this.SyncRoot) From 06822126471abf75eca6a4bb4b7081872cc040bf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 17 May 2024 16:43:08 -0600 Subject: [PATCH 1038/1753] Add System.Memory as package dependency Fixes #1303 --- Directory.Packages.props | 2 +- .../Microsoft.VisualStudio.Threading.csproj | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 98e44e5a1..c512f5502 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -32,7 +32,7 @@ - + diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 52c354523..75872e763 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -42,6 +42,7 @@ + From 5cdabd6a84ce28b221dd14857a47d4e58c74681a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 19 May 2024 10:54:37 -0600 Subject: [PATCH 1039/1753] Use spaces for xml config files --- .editorconfig | 1 + 1 file changed, 1 insertion(+) diff --git a/.editorconfig b/.editorconfig index ffae180a8..91809344e 100644 --- a/.editorconfig +++ b/.editorconfig @@ -26,6 +26,7 @@ indent_size = 2 # Xml config files [*.{ruleset,config,nuspec,resx,vsixmanifest,vsct,runsettings}] indent_size = 2 +indent_style = space # JSON files [*.json] From c9bb8a56ba2bfaaf1df3984938b80f426cf7cce0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 May 2024 07:47:12 -0600 Subject: [PATCH 1040/1753] Better logging on source code archival failure --- azure-pipelines/Archive-SourceCode.ps1 | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index e44dad008..73f52abd8 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -203,16 +203,25 @@ if ($PSCmdlet.ShouldProcess('source archival request', 'post')) { $Response = Invoke-WebRequest -Uri $SourceCodeArchivalUri -Method POST -Body $RequestJson -ContentType "application/json" -UseBasicParsing -SkipHttpErrorCheck Write-Host "Status Code : " -NoNewline - $responseContent = ConvertFrom-Json ($Response.Content) if ($Response.StatusCode -eq 200) { Write-Host $Response.StatusCode -ForegroundColor Green Write-Host "Ticket ID : " -NoNewline + $responseContent = ConvertFrom-Json ($Response.Content) Write-Host $responseContent } else { - $responseContent = ConvertFrom-Json $Response.Content Write-Host $Response.StatusCode -ForegroundColor Red - Write-Host "Message : $($responseContent.message)" + try { + $responseContent = ConvertFrom-Json $Response.Content + Write-Host "Message : $($responseContent.message)" + } + catch { + Write-Host "JSON Parse Error: $($_.Exception.Message)" + Write-Host "Raw response content:" + Write-Host $Response.Content + } + + exit 2 } } elseif ($SourceCodeArchivalUri) { Write-Host "Would have posted to $SourceCodeArchivalUri" From cc03e789ad18fa81ebfe16df33adc3859429ea3a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 21 May 2024 13:40:39 -0600 Subject: [PATCH 1041/1753] Drop unstable tests from OptProf --- src/Microsoft.VisualStudio.Threading/OptProf.targets | 1 - 1 file changed, 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/OptProf.targets b/src/Microsoft.VisualStudio.Threading/OptProf.targets index 51f826ad0..eaee27dda 100644 --- a/src/Microsoft.VisualStudio.Threading/OptProf.targets +++ b/src/Microsoft.VisualStudio.Threading/OptProf.targets @@ -8,7 +8,6 @@ - From ca08c0f2dd8d034a52e7775ee1629efb5327575e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 21 May 2024 14:45:12 -0600 Subject: [PATCH 1042/1753] Bump .NET SDK to 8.0.300 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 34e569080..6ed7f6e71 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:8.0.201-jammy +FROM mcr.microsoft.com/dotnet/sdk:8.0.300-jammy # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 2565f2363..c83e939e8 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "8.0.201", + "version": "8.0.300", "rollForward": "patch", "allowPrerelease": false } From d87da7a0cd7722051fa125f2a33d857442c69b13 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 May 2024 12:17:47 -1000 Subject: [PATCH 1043/1753] Merge test related dependency updates (#271) * Bump xunit from 2.8.0 to 2.8.1 Bumps [xunit](https://github.com/xunit/xunit) from 2.8.0 to 2.8.1. - [Commits](https://github.com/xunit/xunit/compare/2.8.0...2.8.1) --- updated-dependencies: - dependency-name: xunit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] * Bump Microsoft.NET.Test.Sdk from 17.9.0 to 17.10.0 Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.9.0 to 17.10.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.9.0...v17.10.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Bump xunit.runner.visualstudio from 2.8.0 to 2.8.1 Bumps [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit) from 2.8.0 to 2.8.1. - [Release notes](https://github.com/xunit/visualstudio.xunit/releases) - [Commits](https://github.com/xunit/visualstudio.xunit/compare/2.8.0...2.8.1) --- updated-dependencies: - dependency-name: xunit.runner.visualstudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 382835c32..203681681 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,9 +6,9 @@ true - - - + + + From e90be2e755eb204a173daa23e9316f99be1e1f79 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Jun 2024 11:15:23 -0600 Subject: [PATCH 1044/1753] Bump dotnet-coverage from 17.11.0 to 17.11.3 (#272) Bumps [dotnet-coverage](https://github.com/microsoft/codecoverage) from 17.11.0 to 17.11.3. - [Commits](https://github.com/microsoft/codecoverage/commits) --- updated-dependencies: - dependency-name: dotnet-coverage dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 7e8a502ad..29710eea2 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -9,7 +9,7 @@ ] }, "dotnet-coverage": { - "version": "17.11.0", + "version": "17.11.3", "commands": [ "dotnet-coverage" ] @@ -21,4 +21,4 @@ ] } } -} +} \ No newline at end of file From 48013f00edc27ded210565367038a64366706fdb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Jun 2024 09:50:44 -0600 Subject: [PATCH 1045/1753] Bump Nerdbank.GitVersioning to 3.6.139 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 203681681..7571fff5e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,7 +13,7 @@ - + From 2415b1e21081903457430079e1ff548c4ff9d5a8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Jun 2024 11:10:20 -0600 Subject: [PATCH 1046/1753] Bump nbgv to 3.6.139 --- .config/dotnet-tools.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 29710eea2..49ac8e665 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -15,10 +15,10 @@ ] }, "nbgv": { - "version": "3.6.133", + "version": "3.6.139", "commands": [ "nbgv" ] } } -} \ No newline at end of file +} From 2f713da7b2554e37d2473e376804e0d109503f22 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Tue, 4 Jun 2024 10:44:23 -0700 Subject: [PATCH 1047/1753] Stabilize package version (#1326) --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index 1cb6602dd..96a4e7f00 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.11-preview", + "version": "17.11", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 61b98b5e7cfdeaaa170fcd037a38a6fbb7cba607 Mon Sep 17 00:00:00 2001 From: Pierson Lee Date: Wed, 5 Jun 2024 16:08:30 -0700 Subject: [PATCH 1048/1753] Enable ShallowClone for VSInsertion Enabling shallow cloning will make cloning the VS repo faster when creating the PR. --- azure-pipelines/vs-insertion.yml | 1 + azure-pipelines/vs-validation.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 084b84ebe..bb7349159 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -57,6 +57,7 @@ extends: InsertionReviewers: $(Build.RequestedFor) # Append `,Your team name` (without quotes) AutoCompletePR: true AutoCompleteMergeStrategy: Squash + ShallowClone: true - powershell: | $contentType = 'application/json'; $headers = @{ Authorization = 'Bearer $(System.AccessToken)' }; diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 4638671ce..e8497f813 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -80,6 +80,7 @@ extends: InsertionBuildPolicy: Request Perf DDRITs InsertionReviewers: $(Build.RequestedFor) AutoCompletePR: false + ShallowClone: true - powershell: | $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 $Markdown = @" From 51875f68f788603932a8f05d80a837ede3075002 Mon Sep 17 00:00:00 2001 From: Richard Stanton Date: Fri, 7 Jun 2024 19:46:00 -0700 Subject: [PATCH 1049/1753] Ensure Expand-Template uses UTF-8 when replacing placeholders. --- Expand-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index da2f6b7e8..9cbdee95c 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -36,7 +36,7 @@ function Replace-Placeholders { $Path = Resolve-Path $Path Write-Host "Replacing tokens in `"$Path`"" - $content = Get-Content -Path $Path | Out-String + $content = Get-Content -Encoding UTF8 -Path $Path | Out-String $Replacements.GetEnumerator() |% { $modifiedContent = $content -replace $_.Key,$_.Value if ($modifiedContent -eq $content) { From 8028bf78bf4f96963e962e7f8e83662e9544be1f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 14 Jun 2024 10:45:03 -0600 Subject: [PATCH 1050/1753] Drop SourceLink package reference Per @KirillOsenkov in [this comment](https://github.com/dotnet/sdk/issues/36666#issuecomment-2162173453), SourceLink is now built into the .NET SDK. --- Directory.Packages.props | 3 --- 1 file changed, 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7571fff5e..1efd3c089 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -17,7 +17,4 @@ - - - From 6e225a8c19365540a58ace87d912c8287b2c9a82 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 14 Jun 2024 10:51:33 -0600 Subject: [PATCH 1051/1753] Remove WPF workarounds for bugs fixed years ago --- Directory.Build.props | 19 ------------------- Directory.Build.targets | 5 ----- 2 files changed, 24 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index e42ac60a6..1c77d5d6e 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -55,23 +55,4 @@ $(PackageProjectUrl)/releases/tag/v$(Version) - - - false - true - - - - - false - false - false - false - diff --git a/Directory.Build.targets b/Directory.Build.targets index cc8184aac..b4afce0a7 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -1,10 +1,5 @@ - - - false - - From 267e6f7bcf2b33e070ab4b8adae5c44b58d25e25 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Jun 2024 12:27:42 -0600 Subject: [PATCH 1052/1753] Enable codeSignValidation and exclude non-shipping files --- azure-pipelines/official.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 98e21d223..98cebaaba 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -64,6 +64,10 @@ extends: parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + codeSignValidation: + enabled: true + break: true + additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** policheck: enabled: true exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml From d9450cf5301cbc7e7a9a0082c4eb56442e7ada80 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Jun 2024 13:32:06 -0600 Subject: [PATCH 1053/1753] Consolidate official build and real sign switches Justification: - Official builds will soon be _required_ to sign everything. - Signing outside of an official build would allow bypassing all compliance checks, defeating the intent of all these checks. Therefore: signing must happen if and only if we are running an official build, and thus we should have only one switch that controls both. --- azure-pipelines/official.yml | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 98cebaaba..48cdc190a 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -23,10 +23,10 @@ parameters: # As an entrypoint pipeline yml file, all parameters here show up in the Queue Run dialog. # If any paramaters should NOT be queue-time options, they should be removed from here # and references to them in this file replaced with hard-coded values. -- name: RealSign - displayName: Real sign? +- name: ForceOfficialBuild + displayName: Official build (sign, compliance, etc.) type: boolean - default: false + default: false # this should remain false so PR builds using this pipeline are unofficial # - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. # displayName: Skip OptProf optimization # type: boolean @@ -39,12 +39,8 @@ parameters: displayName: Run tests type: boolean default: true -- name: EnableCompliance - displayName: Run Compliance Tools - type: boolean - default: true - name: EnableAPIScan - displayName: Include APIScan with Compliance tools + displayName: Include APIScan with compliance tools type: boolean default: false # enable in individual repos only AFTER updating TSAOptions.json with your own values @@ -59,7 +55,7 @@ variables: - template: GlobalVariables.yml extends: - ${{ if parameters.EnableCompliance }}: + ${{ if or(parameters.ForceOfficialBuild, eq(variables['Build.Reason'],'Schedule')) }}: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: sdl: @@ -74,7 +70,7 @@ extends: suppression: suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress sbom: - enabled: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} # Disable the generation for SBOMs for artifacts in unsigned builds since it's slow + enabled: true stages: - stage: Build variables: @@ -83,9 +79,9 @@ extends: - template: /azure-pipelines/build.yml@self parameters: Is1ESPT: true - RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} + RealSign: true # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - EnableAPIScan: ${{ and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }} + EnableAPIScan: ${{ and(parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }} windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: name: AzurePipelines-EO @@ -100,7 +96,7 @@ extends: RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: - RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} + RealSign: true ${{ else }}: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: @@ -116,9 +112,9 @@ extends: - template: /azure-pipelines/build.yml@self parameters: Is1ESPT: true - RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} + RealSign: false # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - EnableAPIScan: ${{ and(parameters.EnableCompliance, parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }} + EnableAPIScan: false windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: name: AzurePipelines-EO @@ -133,4 +129,4 @@ extends: RunTests: ${{ parameters.RunTests }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: - RealSign: ${{ or(parameters.RealSign, eq(variables['Build.Reason'],'Schedule')) }} + RealSign: false From 16b4bc059c992fc89dff1921c08bf1cb27d3654f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 18 Jun 2024 10:59:18 -0600 Subject: [PATCH 1054/1753] Switch from PAT-based to WIF-based auth When pulling from or pushing packages to the `azure-public` account, we need to authenticate when doing so from the `devdiv` account. We were previously doing this through PAT-based service connections. With this change, we switch to WIF (Workload Identity Federation) to authenticate. --- azure-pipelines/WIFtoPATauth.yml | 22 ++++++++++++++++++++ azure-pipelines/install-dependencies.yml | 15 +++++++++---- azure-pipelines/prepare-insertion-stages.yml | 4 ++++ 3 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 azure-pipelines/WIFtoPATauth.yml diff --git a/azure-pipelines/WIFtoPATauth.yml b/azure-pipelines/WIFtoPATauth.yml new file mode 100644 index 000000000..cb78f61f2 --- /dev/null +++ b/azure-pipelines/WIFtoPATauth.yml @@ -0,0 +1,22 @@ +parameters: +- name: deadPATServiceConnectionId # The GUID of the PAT-based service connection whose access token must be replaced. + type: string +- name: wifServiceConnectionName # The name of the WIF service connection to use to get the access token. + type: string +- name: resource # The scope for which the access token is requested. + type: string + default: 499b84ac-1321-427f-aa17-267ca6975798 # Azure Artifact feeds (any of them) + +steps: +- task: AzureCLI@2 + displayName: 🔏 Authenticate with WIF service connection + inputs: + azureSubscription: ${{ parameters.wifServiceConnectionName }} + scriptType: pscore + scriptLocation: inlineScript + inlineScript: | + $accessToken = az account get-access-token --query accessToken --resource '${{ parameters.resource }}' -o tsv + # Set the access token as a secret, so it doesn't get leaked in the logs + Write-Host "##vso[task.setsecret]$accessToken" + # Override the apitoken of the nuget service connection, for the duration of this stage + Write-Host "##vso[task.setendpoint id=${{ parameters.deadPATServiceConnectionId }};field=authParameter;key=apitoken]$accessToken" diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index dc35ceced..8e7135217 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -1,14 +1,21 @@ parameters: - initArgs: +- name: initArgs +- name: needsAzurePublicFeeds + type: boolean + default: true # If nuget.config pulls from the azure-public account, we need to authenticate when building on the devdiv account. steps: +- ${{ if and(parameters.needsAzurePublicFeeds, eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9')) }}: + - template: WIFtoPATauth.yml + parameters: + wifServiceConnectionName: azure-public/vside package pull + deadPATServiceConnectionId: 0ae39abc-4d06-4436-a7b5-865833df49db # azure-public/msft_consumption - task: NuGetAuthenticate@1 displayName: 🔏 Authenticate NuGet feeds inputs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - nuGetServiceConnections: azure-public/msft_consumption # Only necessary for GitHub-hosted repos - forceReinstallCredentialProvider: true + ${{ if and(parameters.needsAzurePublicFeeds, eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9')) }}: + nuGetServiceConnections: azure-public/msft_consumption - powershell: | $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index ab4507c4e..e6557bb51 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -61,3 +61,7 @@ stages: - download: current artifact: deployables-Windows displayName: 🔻 Download deployables-Windows artifact + - template: WIFtoPATauth.yml + parameters: + wifServiceConnectionName: azure-public/vside package push + deadPATServiceConnectionId: 207efd62-fd0f-43e7-aeae-17c4febcc660 # azure-public/vs-impl From 3efca79af59ecfc3125d34b8e770a1db1980a170 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 18 Jun 2024 15:43:42 -0600 Subject: [PATCH 1055/1753] Fix initArgs required parameter break --- azure-pipelines/install-dependencies.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 8e7135217..e5d58f412 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -1,5 +1,7 @@ parameters: - name: initArgs + type: string + default: '' - name: needsAzurePublicFeeds type: boolean default: true # If nuget.config pulls from the azure-public account, we need to authenticate when building on the devdiv account. From db5c05423b18852f18b280f9e8d0c56da913c161 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 24 Jun 2024 09:07:14 -0600 Subject: [PATCH 1056/1753] Bump powershell from 7.4.2 to 7.4.3 (#275) Bumps [powershell](https://github.com/PowerShell/PowerShell) from 7.4.2 to 7.4.3. - [Release notes](https://github.com/PowerShell/PowerShell/releases) - [Commits](https://github.com/PowerShell/PowerShell/compare/v7.4.2...v7.4.3) --- updated-dependencies: - dependency-name: powershell dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 49ac8e665..8d8ff3ff5 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.4.2", + "version": "7.4.3", "commands": [ "pwsh" ] @@ -21,4 +21,4 @@ ] } } -} +} \ No newline at end of file From d1ea1326b8663d1ba6f1f4b3ebb35374b28f01f4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 18 Jun 2024 14:35:57 -0600 Subject: [PATCH 1057/1753] Authenticate source code archival requests --- azure-pipelines/Archive-SourceCode.ps1 | 12 +++++++++--- azure-pipelines/archive-sourcecode.yml | 12 +++++++++++- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/Archive-SourceCode.ps1 b/azure-pipelines/Archive-SourceCode.ps1 index 73f52abd8..0360a14fa 100644 --- a/azure-pipelines/Archive-SourceCode.ps1 +++ b/azure-pipelines/Archive-SourceCode.ps1 @@ -35,7 +35,7 @@ .PARAMETER SourceCodeArchivalUri The URI to POST the source code archival request to. This value will typically come automatically by a variable group associated with your pipeline. - You can also look it up at https://dpsrequestforms.azurewebsites.net/#/help -> SCA Request Help -> SCA API Help -> Description + You can also look it up at https://dpsopsrequestforms.azurewebsites.net/#/help -> SCA Request Help -> SCA API Help -> Description #> [CmdletBinding(SupportsShouldProcess = $true, PositionalBinding = $false)] param ( @@ -76,7 +76,9 @@ param ( [Parameter()] [string]$ServerPath = '', [Parameter()] - [Uri]$SourceCodeArchivalUri = $env:SOURCECODEARCHIVALURI + [Uri]$SourceCodeArchivalUri = $env:SOURCECODEARCHIVALURI, + [Parameter(Mandatory = $true)] + [string]$AccessToken ) function Invoke-Git() { @@ -199,9 +201,13 @@ if ($PSCmdlet.ShouldProcess('source archival request', 'post')) { exit 1 } + $headers = @{ + 'Authorization' = "Bearer $AccessToken" + } + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 - $Response = Invoke-WebRequest -Uri $SourceCodeArchivalUri -Method POST -Body $RequestJson -ContentType "application/json" -UseBasicParsing -SkipHttpErrorCheck + $Response = Invoke-WebRequest -Uri $SourceCodeArchivalUri -Method POST -Headers $headers -Body $RequestJson -ContentType "application/json" -UseBasicParsing -SkipHttpErrorCheck Write-Host "Status Code : " -NoNewline if ($Response.StatusCode -eq 200) { Write-Host $Response.StatusCode -ForegroundColor Green diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 12b4d0c97..f5b4781ee 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -63,7 +63,16 @@ extends: - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true displayName: ⚙ Set pipeline variables based on source - - powershell: > + - task: AzureCLI@2 + displayName: 🔏 Authenticate with WIF service connection + inputs: + azureSubscription: VS Core Source Code Archival + scriptType: pscore + scriptLocation: inlineScript + inlineScript: | + $accessToken = az account get-access-token --query accessToken --resource api://177cf50a-4bf5-4481-8b7e-f32900dfc8e6 -o tsv + Write-Host "##vso[task.setvariable variable=scaToken;issecret=true]$accessToken" + - pwsh: > $TeamAlias = '$(TeamEmail)'.Substring(0, '$(TeamEmail)'.IndexOf('@')) azure-pipelines/Archive-SourceCode.ps1 @@ -73,6 +82,7 @@ extends: -ProductName '$(SymbolsFeatureName)' -ProductLanguage English -Notes '${{ parameters.notes }}' + -AccessToken '$(scaToken)' -Verbose -WhatIf:$${{ parameters.whatif }} displayName: 🗃️ Submit archival request From c905111347978e29c17eda67415448f3753ca5bb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 26 Jun 2024 08:47:43 -0600 Subject: [PATCH 1058/1753] Add `AsyncBarrier.SignalAndWait(CancellationToken)` overload Also optimize the pre-existing code. The new overload returns `ValueTask` to leave open the option of optimizing to zero-allocation use via `IValueTaskSource`. --- .../AsyncBarrier.cs | 62 ++++++++++++++----- .../net472/PublicAPI.Unshipped.txt | 1 + .../net6.0-windows/PublicAPI.Unshipped.txt | 1 + .../net6.0/PublicAPI.Unshipped.txt | 1 + .../netstandard2.0/PublicAPI.Unshipped.txt | 1 + .../AsyncBarrierTests.cs | 32 ++++++++++ 6 files changed, 84 insertions(+), 14 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs b/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs index 292cf0430..92d273663 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncBarrier.cs @@ -24,7 +24,7 @@ public class AsyncBarrier /// /// The set of participants who have reached the barrier, with their awaiters that can resume those participants. /// - private readonly Stack> waiters; + private readonly Stack waiters; /// /// Initializes a new instance of the class. @@ -37,15 +37,22 @@ public AsyncBarrier(int participants) // Allocate the stack so no resizing is necessary. // We don't need space for the last participant, since we never have to store it. - this.waiters = new Stack>(participants - 1); + this.waiters = new Stack(participants - 1); } + /// + public Task SignalAndWait() => this.SignalAndWait(CancellationToken.None).AsTask(); + /// /// Signals that a participant is ready, and returns a Task /// that completes when all other participants have also signaled ready. /// - /// A Task, which will complete (or may already be completed) when the last participant calls this method. - public Task SignalAndWait() + /// + /// A token that signals the caller's lost interest in waiting. + /// The signal effect of the method is not canceled with the token. + /// + /// A task which will complete (or may already be completed) when the last participant calls this method. + public ValueTask SignalAndWait(CancellationToken cancellationToken) { lock (this.waiters) { @@ -55,24 +62,51 @@ public Task SignalAndWait() // Unleash everyone that preceded this one. while (this.waiters.Count > 0) { - Task.Factory.StartNew( - state => ((TaskCompletionSource)state!).SetResult(default(EmptyStruct)), - this.waiters.Pop(), - CancellationToken.None, - TaskCreationOptions.None, - TaskScheduler.Default); + Waiter waiter = this.waiters.Pop(); + waiter.CompletionSource.TrySetResult(default); + waiter.CancellationRegistration.Dispose(); } // And allow this one to continue immediately. - return Task.CompletedTask; + return new ValueTask(cancellationToken.IsCancellationRequested + ? Task.FromCanceled(cancellationToken) + : Task.CompletedTask); } else { // We need more folks. So suspend this caller. - var tcs = new TaskCompletionSource(); - this.waiters.Push(tcs); - return tcs.Task; + TaskCompletionSource tcs = new(TaskCreationOptions.RunContinuationsAsynchronously); + CancellationTokenRegistration ctr; + if (cancellationToken.CanBeCanceled) + { +#if NET + ctr = cancellationToken.Register( + static (tcs, ct) => ((TaskCompletionSource)tcs!).TrySetCanceled(ct), tcs); +#else + ctr = cancellationToken.Register( + static s => + { + var t = (Tuple, CancellationToken>)s!; + t.Item1.TrySetCanceled(t.Item2); + }, + Tuple.Create(tcs, cancellationToken)); +#endif + } + else + { + ctr = default; + } + + this.waiters.Push(new Waiter(tcs, ctr)); + return new ValueTask(tcs.Task); } } } + + private readonly struct Waiter(TaskCompletionSource completionSource, CancellationTokenRegistration cancellationRegistration) + { + internal readonly TaskCompletionSource CompletionSource => completionSource; + + internal readonly CancellationTokenRegistration CancellationRegistration => cancellationRegistration; + } } diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index e69de29bb..bb9b5f944 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt index e69de29bb..bb9b5f944 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0-windows/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt index e69de29bb..bb9b5f944 100644 --- a/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net6.0/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index e69de29bb..bb9b5f944 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -0,0 +1 @@ +Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs index 983667e81..5b9c48559 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs @@ -42,6 +42,38 @@ public async Task ManyParticipantsAndSteps() await this.MultipleParticipantsHelperAsync(100, 50); } + [Fact] + public async Task SignalAndWait_PrecanceledButReady() + { + AsyncBarrier barrier = new(1); + CancellationToken precanceled = new(canceled: true); + OperationCanceledException ex = await Assert.ThrowsAnyAsync(async () => await barrier.SignalAndWait(precanceled)).WithCancellation(this.TimeoutToken); + Assert.Equal(precanceled, ex.CancellationToken); + } + + [Fact] + public async Task SignalAndWait_PrecanceledWhileWaiting() + { + AsyncBarrier barrier = new(2); + CancellationToken precanceled = new(canceled: true); + OperationCanceledException ex = await Assert.ThrowsAnyAsync(async () => await barrier.SignalAndWait(precanceled)).WithCancellation(this.TimeoutToken); + Assert.Equal(precanceled, ex.CancellationToken); + } + + [Fact] + public async Task SignalAndWait_CanceledLeavesSignalBehind() + { + AsyncBarrier barrier = new(2); + CancellationTokenSource cts = new(); + Task waiter1 = barrier.SignalAndWait(cts.Token).AsTask(); + cts.Cancel(); + OperationCanceledException ex = await Assert.ThrowsAnyAsync(() => waiter1).WithCancellation(this.TimeoutToken); + Assert.Equal(cts.Token, ex.CancellationToken); + + // Now test that the second awaiter gets in, even though the first was canceled. + await barrier.SignalAndWait().WithCancellation(this.TimeoutToken); + } + /// /// Verifies that with multiple threads constantly fulfilling the participant count /// and resetting and fulfilling it again, it still performs as expected. From 054fc88e85945609e7b86bb4d9b646adbfbe00ac Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 27 Jun 2024 16:39:42 -0600 Subject: [PATCH 1059/1753] Check for signed binaries in a broader scoped path --- azure-pipelines/microbuild.after.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 34bdb452e..67f43b2c5 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -11,7 +11,7 @@ steps: displayName: 🔍 Verify Signed Files inputs: TargetFolders: | - $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration)/NuGet + $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration) condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - ${{ if parameters.IsOptProf }}: From ae01d878e7a8f9c0800618058a357b7001ece3af Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 28 Jun 2024 07:03:43 -0600 Subject: [PATCH 1060/1753] Ignore .sarif files --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 69599b879..3f1c5ed94 100644 --- a/.gitignore +++ b/.gitignore @@ -352,3 +352,6 @@ MigrationBackup/ # mac-created file to track user view preferences for a directory .DS_Store + +# Analysis results +*.sarif From 19e67ad57a852efc0568cda683b5384bda824c07 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 28 Jun 2024 12:17:08 -0600 Subject: [PATCH 1061/1753] Add support for VB.NET projects --- Directory.Build.props | 1 - Directory.Build.targets | 4 ++++ src/AssemblyInfo.vb | 6 ++++++ src/Directory.Build.targets | 3 ++- 4 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 src/AssemblyInfo.vb diff --git a/Directory.Build.props b/Directory.Build.props index 1c77d5d6e..803396d08 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -6,7 +6,6 @@ $(RepoRootPath)obj\$([MSBuild]::MakeRelative($(RepoRootPath), $(MSBuildProjectDirectory)))\ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\ - 12 enable enable latest diff --git a/Directory.Build.targets b/Directory.Build.targets index b4afce0a7..ecd71a31b 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -1,5 +1,9 @@ + + 12 + 16.9 + diff --git a/src/AssemblyInfo.vb b/src/AssemblyInfo.vb new file mode 100644 index 000000000..34b7cbe11 --- /dev/null +++ b/src/AssemblyInfo.vb @@ -0,0 +1,6 @@ +' Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. +' Licensed under the MIT license. See LICENSE file in the project root for full license information. + +Imports System.Runtime.InteropServices + + diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets index 07f413461..654f5c6d3 100644 --- a/src/Directory.Build.targets +++ b/src/Directory.Build.targets @@ -1,7 +1,8 @@ - + + From ebb586f8bb4993a4f2b0e144b1347474cb0c52fb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 28 Jun 2024 13:54:20 -0600 Subject: [PATCH 1062/1753] Fix template expansion --- Apply-Template.ps1 | 2 +- Expand-Template.ps1 | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Apply-Template.ps1 b/Apply-Template.ps1 index 42ed33623..921ceee50 100644 --- a/Apply-Template.ps1 +++ b/Apply-Template.ps1 @@ -37,6 +37,6 @@ robocopy /mir $PSScriptRoot/.github $Path/.github robocopy /mir $PSScriptRoot/.vscode $Path/.vscode robocopy /mir $PSScriptRoot/tools $Path/tools robocopy $PSScriptRoot $Path Directory.Build.* Directory.Packages.props global.json init.* azure-pipelines.yml .gitignore .gitattributes .editorconfig -robocopy $PSScriptRoot/src $Path/src Directory.Build.* .editorconfig AssemblyInfo.cs +robocopy $PSScriptRoot/src $Path/src Directory.Build.* .editorconfig AssemblyInfo.cs AssemblyInfo.vb robocopy $PSScriptRoot/test $Path/test Directory.Build.* .editorconfig Remove-Item $Path/azure-pipelines/expand-template.yml diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index d203d85f0..e9a567c18 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -148,6 +148,9 @@ try { Replace-Placeholders -Path "src/AssemblyInfo.cs" -Replacements @{ 'COMPANY-PLACEHOLDER'=$Author } + Replace-Placeholders -Path "src/AssemblyInfo.vb" -Replacements @{ + 'COMPANY-PLACEHOLDER'=$Author + } Replace-Placeholders -Path "LICENSE" -Replacements @{ 'COMPANY-PLACEHOLDER'=$Author } From 7233fa3c5970df39bdd275f5c68da59ee8a0ae47 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 28 Jun 2024 13:56:21 -0600 Subject: [PATCH 1063/1753] Fix copyright notice --- src/AssemblyInfo.vb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/AssemblyInfo.vb b/src/AssemblyInfo.vb index 34b7cbe11..75fe6ea4c 100644 --- a/src/AssemblyInfo.vb +++ b/src/AssemblyInfo.vb @@ -1,4 +1,4 @@ -' Copyright (c) COMPANY-PLACEHOLDER. All rights reserved. +' Copyright (c) Microsoft Corporation. All rights reserved. ' Licensed under the MIT license. See LICENSE file in the project root for full license information. Imports System.Runtime.InteropServices From 8f52508aaf4bb11b06950c4f31de9a9cde97a515 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Jul 2024 09:02:41 -0600 Subject: [PATCH 1064/1753] Document Join APIs that may propagate exceptions --- src/Microsoft.VisualStudio.Threading/JoinableTask.cs | 8 ++++++++ .../JoinableTaskCollection.cs | 6 ++++++ src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs | 8 ++++++++ 3 files changed, 22 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 68440785b..5a36ca3be 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -568,6 +568,10 @@ private Task QueueNeedProcessEvent /// the caller's access to the Main thread propagates to this JoinableTask so that it may also access the main thread. /// /// A cancellation token that will exit this method before the task is completed. + /// Thrown when is canceled. + /// + /// Any exception thrown by the asynchronous operation is propagated out to the caller of this method. + /// public void Join(CancellationToken cancellationToken = default(CancellationToken)) { cancellationToken.ThrowIfCancellationRequested(); @@ -599,6 +603,10 @@ private Task QueueNeedProcessEvent /// before the async operation has completed. /// /// A task that completes after the asynchronous operation completes and the join is reverted. + /// Thrown when is canceled. + /// + /// Any exception thrown by the asynchronous operation is propagated out to the caller of this method. + /// public Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) { cancellationToken.ThrowIfCancellationRequested(); diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs index 348a654db..e929d97b6 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskCollection.cs @@ -145,6 +145,9 @@ public JoinRelease Join() /// Joins the caller's context to this collection till the collection is empty. /// /// A task that completes when this collection is empty. + /// + /// Any exceptions thrown by the tasks in this collection are not propagated to the returned task. + /// public Task JoinTillEmptyAsync() => this.JoinTillEmptyAsync(CancellationToken.None); /// @@ -152,6 +155,9 @@ public JoinRelease Join() /// /// A cancellation token. /// A task that completes when this collection is empty, or is canceled when is canceled. + /// + /// Any exceptions thrown by the tasks in this collection are not propagated to the returned task. + /// public async Task JoinTillEmptyAsync(CancellationToken cancellationToken) { cancellationToken.ThrowIfCancellationRequested(); diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index b7748174d..c367d5752 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -48,6 +48,10 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, str /// /// A cancellation token that will exit this method before the task is completed. /// A task that completes after the asynchronous operation completes and the join is reverted, with the result of the operation. + /// Thrown when is canceled. + /// + /// Any exception thrown by the asynchronous operation is propagated out to the caller of this method. + /// public new Task JoinAsync(CancellationToken cancellationToken = default(CancellationToken)) { return this.JoinAsync(continueOnCapturedContext: AwaitShouldCaptureSyncContext, cancellationToken); @@ -59,6 +63,10 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, str /// /// A cancellation token that will exit this method before the task is completed. /// The result of the asynchronous operation. + /// Thrown when is canceled. + /// + /// Any exception thrown by the asynchronous operation is propagated out to the caller of this method. + /// public new T Join(CancellationToken cancellationToken = default(CancellationToken)) { base.Join(cancellationToken); From a97bf912ab695bad629755dd8bfbbfa7885a4424 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Jul 2024 12:30:53 -0600 Subject: [PATCH 1065/1753] Sign native dll and exclude test exe from sign check --- azure-pipelines/Get-SymbolFiles.ps1 | 2 +- src/SosThreadingTools/SosThreadingTools.targets | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/azure-pipelines/Get-SymbolFiles.ps1 index b5063cec6..eb80e32c1 100644 --- a/azure-pipelines/Get-SymbolFiles.ps1 +++ b/azure-pipelines/Get-SymbolFiles.ps1 @@ -18,7 +18,7 @@ Write-Progress -Activity $ActivityName -CurrentOperation "Discovery PDB files" $PDBs = Get-ChildItem -rec "$Path/*.pdb" # Filter PDBs to product OR test related. -$testregex = "unittest|tests|\.test\." +$testregex = "unittest|tests|\.test\.|TestHost" Write-Progress -Activity $ActivityName -CurrentOperation "De-duplicating symbols" $PDBsByHash = @{} diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index 2b36e2618..e8788e4b7 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -26,6 +26,12 @@ StampAndIncludeGalleryManifest;$(GenerateNuspecDependsOn) + + + + + + From ee64202ff63f31edc5afbe1f7881d4131c46b1dc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Jul 2024 13:05:07 -0600 Subject: [PATCH 1066/1753] Fix release pipeline --- azure-pipelines/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index dbe9b68c6..5cf21b46b 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -54,7 +54,7 @@ extends: - download: CI artifact: deployables-Windows displayName: 🔻 Download deployables-Windows artifact - patterns: 'deployables-Windows/NuGet/*' + patterns: 'NuGet/*' - task: GitHubRelease@1 displayName: 📢 GitHub release (create) inputs: From ef84c93691ab4b46ec1ca91e87d71a6c02517b26 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Jul 2024 12:37:13 -0600 Subject: [PATCH 1067/1753] Build 17.12-preview --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- version.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index 6ff2d7c20..cdcc91943 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.11' +'main' diff --git a/version.json b/version.json index 96a4e7f00..907aeb713 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.11", + "version": "17.12-preview", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From fe92bf7b8997adbd0f7cf1e1d22c3f7cb2457613 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Jul 2024 12:35:03 -0600 Subject: [PATCH 1068/1753] Insert into rel/d17.11 --- azure-pipelines/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/variables/InsertTargetBranch.ps1 b/azure-pipelines/variables/InsertTargetBranch.ps1 index cdcc91943..6ff2d7c20 100644 --- a/azure-pipelines/variables/InsertTargetBranch.ps1 +++ b/azure-pipelines/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.11' From e69fef21e7bb686d2175c1f24995e7514a9ea21c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Jul 2024 15:13:27 -0600 Subject: [PATCH 1069/1753] Bump several dependencies --- Directory.Packages.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1efd3c089..fe766e309 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,11 +7,11 @@ - - + + - + From ebd7dc1ea948f79a9af8a1de98c2971aee885637 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Jul 2024 15:17:04 -0600 Subject: [PATCH 1070/1753] Bump MicroBuild to 2.0.162 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index a139a39ab..2cafae62e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.152 + 2.0.162 From 31d81eb2a1f04dba69dc2723a1c5841d26e9b0d8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Jul 2024 16:14:55 -0600 Subject: [PATCH 1071/1753] Sign the `GalleryManifest.xml` file --- .../SosThreadingTools.targets | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index e8788e4b7..d53fcec4a 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -23,16 +23,25 @@ $(TargetsForTfmSpecificContentInPackage);PackBuildOutputs - StampAndIncludeGalleryManifest;$(GenerateNuspecDependsOn) + + + + + MicrosoftXmlSHA2 + + + + + - + @@ -40,14 +49,14 @@ - + - + From baf10f7ffd53dee5b61099c371022a15bd6070b5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Jul 2024 10:15:20 -0700 Subject: [PATCH 1072/1753] Fix github actions warnings --- .github/workflows/build.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 33502820a..06d884d90 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -26,7 +26,7 @@ jobs: - windows-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -56,53 +56,53 @@ jobs: if: always() - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload test_logs if: always() - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: test_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/test_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables From f93bdce9c96216e096c5a02927c3176cd9b5699b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Jul 2024 10:19:19 -0700 Subject: [PATCH 1073/1753] Skip codecov publishing without token --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 06d884d90..cdf4ac963 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -112,4 +112,4 @@ jobs: shell: pwsh timeout-minutes: 3 continue-on-error: true - if: always() + if: env.codecov_token != '' From 03d69cfcbb867ac82907ed10b52fddbf71398ec3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 8 Jul 2024 17:53:47 -0600 Subject: [PATCH 1074/1753] Sign the `*.VSInsertionMetadata` optprof package --- Expand-Template.ps1 | 8 +-- .../InsertionMetadataPackage.nuspec | 17 ----- azure-pipelines/artifacts/VSInsertion.ps1 | 25 +------- azure-pipelines/dotnet.yml | 5 +- global.json | 3 + .../Library.VSInsertionMetadata.proj | 11 ++++ .../ProfilingInputs.props | 0 .../VSInsertionMetadata.targets | 64 +++++++++++++++++++ 8 files changed, 83 insertions(+), 50 deletions(-) delete mode 100644 azure-pipelines/InsertionMetadataPackage.nuspec create mode 100644 src/VSInsertionMetadata/Library.VSInsertionMetadata.proj rename {azure-pipelines => src/VSInsertionMetadata}/ProfilingInputs.props (100%) create mode 100644 src/VSInsertionMetadata/VSInsertionMetadata.targets diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 9cbdee95c..f91ab76b7 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -105,6 +105,8 @@ try { if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv test/Library.Tests "test/$LibraryName.Tests" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } + git mv src/VSInsertionMetadata/Library.VSInsertionMetadata.proj "src/VSInsertionMetadata/$LibraryName.VSInsertionMetadata.proj" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Refresh solution file both to update paths and give the projects unique GUIDs dotnet sln remove src/Library/Library.csproj @@ -168,12 +170,6 @@ try { 'LibraryName' = $LibraryName; } - Replace-Placeholders -Path "azure-pipelines/InsertionMetadataPackage.nuspec" -Replacements @{ - 'LibraryName' = $LibraryName; - } - Replace-Placeholders -Path "azure-pipelines/artifacts/VSInsertion.ps1" -Replacements @{ - 'LibraryName' = $LibraryName; - } Replace-Placeholders -Path "azure-pipelines/OptProf.yml" -Replacements @{ 'LibraryName' = $LibraryName; } diff --git a/azure-pipelines/InsertionMetadataPackage.nuspec b/azure-pipelines/InsertionMetadataPackage.nuspec deleted file mode 100644 index aae33f5c4..000000000 --- a/azure-pipelines/InsertionMetadataPackage.nuspec +++ /dev/null @@ -1,17 +0,0 @@ - - - - - LibraryName.VSInsertionMetadata - $version$ - Microsoft - Microsoft - - false - Contains metadata for insertion into VS. - © Microsoft Corporation. All rights reserved. - - - - - diff --git a/azure-pipelines/artifacts/VSInsertion.ps1 b/azure-pipelines/artifacts/VSInsertion.ps1 index 4c528f52f..de7899e60 100644 --- a/azure-pipelines/artifacts/VSInsertion.ps1 +++ b/azure-pipelines/artifacts/VSInsertion.ps1 @@ -29,30 +29,7 @@ $result = @{ if ($env:IsOptProf) { $VSRepoPackages = "$RepoRoot/bin/Packages/$BuildConfiguration/VSRepo" - - $ArtifactBasePath = "$RepoRoot\obj\_artifacts" - $ArtifactPath = "$ArtifactBasePath\VSInsertion" - if (-not (Test-Path $ArtifactPath)) { New-Item -ItemType Directory -Path $ArtifactPath | Out-Null } - - $profilingInputs = [xml](Get-Content -Path "$PSScriptRoot\..\ProfilingInputs.props") - $profilingInputs.Project.ItemGroup.TestStore.Include = "vstsdrop:" + (& "$PSScriptRoot\..\variables\ProfilingInputsDropName.ps1") - $profilingInputs.Save("$ArtifactPath\ProfilingInputs.props") - - $InsertionMetadataVersion = $(dotnet tool run nbgv get-version -p "$RepoRoot\src" -f json | ConvertFrom-Json).NuGetPackageVersion - if ($env:BUILD_BUILDID) { - # We must ensure unique versions for the insertion metadata package so - # it can contain information that is unique to this build. - # In particular it includes the ProfilingInputsDropName, which contains the BuildId. - # A non-unique package version here may collide with a prior run of this same commit, - # ultimately resulting in a failure of the optprof run. - $InsertionMetadataVersion += '.' + $env:BUILD_BUILDID - } - & (& "$PSScriptRoot\..\Get-NuGetTool.ps1") pack "$PSScriptRoot\..\InsertionMetadataPackage.nuspec" -OutputDirectory $VSRepoPackages -BasePath $ArtifactPath -Version $InsertionMetadataVersion | Out-Null - if ($LASTEXITCODE -ne 0) { - exit $LASTEXITCODE - } - - $result["$VSRepoPackages"] = (Get-ChildItem "$VSRepoPackages\LibraryName.VSInsertionMetadata.$InsertionMetadataVersion.nupkg"); + $result["$VSRepoPackages"] = (Get-ChildItem "$VSRepoPackages\*.VSInsertionMetadata.*.nupkg"); } $result diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 828bd7b95..196fd4b52 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -17,9 +17,8 @@ steps: condition: and(succeeded(), ${{ parameters.RunTests }}) - ${{ if parameters.IsOptProf }}: - # We have to artifically run this script so that the extra .nupkg is produced for variables/InsertPropsValues.ps1 to notice. - - powershell: azure-pipelines\artifacts\VSInsertion.ps1 - displayName: 🔧 Prepare VSInsertion artifact + - script: dotnet pack src\VSInsertionMetadata -c $(BuildConfiguration) -warnaserror /bl:"$(Build.ArtifactStagingDirectory)/build_logs/VSInsertion-Pack.binlog" + displayName: 🔧 dotnet pack VSInsertionMetadata - powershell: azure-pipelines/variables/_pipelines.ps1 failOnStderr: true diff --git a/global.json b/global.json index c83e939e8..e32504cac 100644 --- a/global.json +++ b/global.json @@ -3,5 +3,8 @@ "version": "8.0.300", "rollForward": "patch", "allowPrerelease": false + }, + "msbuild-sdks": { + "Microsoft.Build.NoTargets": "3.7.56" } } diff --git a/src/VSInsertionMetadata/Library.VSInsertionMetadata.proj b/src/VSInsertionMetadata/Library.VSInsertionMetadata.proj new file mode 100644 index 000000000..0caaedb94 --- /dev/null +++ b/src/VSInsertionMetadata/Library.VSInsertionMetadata.proj @@ -0,0 +1,11 @@ + + + netstandard2.0 + true + $(RepoRootPath)bin\Packages\$(Configuration)\VSRepo\ + false + false + Contains metadata for insertion into VS. + + + diff --git a/azure-pipelines/ProfilingInputs.props b/src/VSInsertionMetadata/ProfilingInputs.props similarity index 100% rename from azure-pipelines/ProfilingInputs.props rename to src/VSInsertionMetadata/ProfilingInputs.props diff --git a/src/VSInsertionMetadata/VSInsertionMetadata.targets b/src/VSInsertionMetadata/VSInsertionMetadata.targets new file mode 100644 index 000000000..b73e09aac --- /dev/null +++ b/src/VSInsertionMetadata/VSInsertionMetadata.targets @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + + + + $(TargetsForTfmSpecificContentInPackage); + SubstituteProfilingInputsMacro; + SubstituteProfilingInputsMacroWarning; + + + + + + + + + + + + + + + + + + + + $(PackageVersion).$(Build_BuildId) + + + From 0c9771db3042989a06645b5c8f1af9c1d155b32a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 12 Jul 2024 10:20:19 -0600 Subject: [PATCH 1075/1753] Break until the insertion project is renamed --- .../VSInsertionMetadata.targets | 20 ++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/src/VSInsertionMetadata/VSInsertionMetadata.targets b/src/VSInsertionMetadata/VSInsertionMetadata.targets index b73e09aac..9b23536c6 100644 --- a/src/VSInsertionMetadata/VSInsertionMetadata.targets +++ b/src/VSInsertionMetadata/VSInsertionMetadata.targets @@ -25,14 +25,10 @@ $(TargetsForTfmSpecificContentInPackage); SubstituteProfilingInputsMacro; - SubstituteProfilingInputsMacroWarning; - - - - + @@ -43,13 +39,20 @@ OutputFilename="@(ProfilingInputsTarget)" MatchExpression="%TESTSTORE%" ReplacementText="vstsdrop:$(ProfilingInputsDropName)" /> + + + + + Condition="'$(Build_BuildId)' != ''" + AfterTargets="GetBuildVersion"> + diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 108258282..5c106ade4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -37,8 +37,10 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} - - script: dotnet format --verify-no-changes --no-restore + - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code + env: + dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - template: expand-template.yml - job: macOS From 6775c31bac407a3dbb392d37861e3ec01b2d8214 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Nov 2024 13:01:49 -0700 Subject: [PATCH 1152/1753] Update devcontainer for latest SDK and extension --- .devcontainer/Dockerfile | 2 +- .devcontainer/devcontainer.json | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 9626b31b5..42fd12a7a 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:8.0.402-jammy +FROM mcr.microsoft.com/dotnet/sdk:9.0.100-noble # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f4e3b31a3..01a087c7c 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -10,11 +10,12 @@ "ms-dotnettools.csharp", "k--kato.docomment", "editorconfig.editorconfig", + "esbenp.prettier-vscode", "pflannery.vscode-versionlens", "davidanson.vscode-markdownlint", "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", "ms-azuretools.vscode-docker", - "ms-vscode.powershell" + "tintoy.msbuild-project-tools" ] } From 5bd86bbe7bca8843b2f0f0b9ea79d60892d0845e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 19 Nov 2024 17:45:09 -0700 Subject: [PATCH 1153/1753] Get dependabot to help us keep the .NET SDK current https://github.blog/changelog/2024-11-19-dependabot-can-now-perform-version-updates-for-the-net-sdk/ --- .github/dependabot.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 63e3e890b..b168ac6d1 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,3 +7,7 @@ updates: directory: / schedule: interval: weekly +- package-ecosystem: dotnet-sdk + directory: / + schedule: + interval: monthly From 325831ec518b94a4fe7f0622bccf50d93817ce90 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 20 Nov 2024 10:24:33 -0700 Subject: [PATCH 1154/1753] Bump docfx from 2.78.0 to 2.78.1 (#313) Bumps [docfx](https://github.com/dotnet/docfx) from 2.78.0 to 2.78.1. - [Release notes](https://github.com/dotnet/docfx/releases) - [Changelog](https://github.com/dotnet/docfx/blob/main/RELEASENOTE.md) - [Commits](https://github.com/dotnet/docfx/compare/v2.78.0...2.78.1) --- updated-dependencies: - dependency-name: docfx dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 85b44b223..1c5d6944a 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -24,7 +24,7 @@ "rollForward": false }, "docfx": { - "version": "2.78.0", + "version": "2.78.1", "commands": [ "docfx" ], From 2d80693eb0017d6a7cd9bf83d8e19417452bbb11 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 20 Nov 2024 10:24:58 -0700 Subject: [PATCH 1155/1753] Bump Microsoft.NET.Test.Sdk from 17.11.1 to 17.12.0 (#312) Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.11.1 to 17.12.0. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.11.1...v17.12.0) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index aa1a719da..1a464d153 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ true - + From 49241ecb5b85fc42897ae0ec0457d572eff630f7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 22 Nov 2024 18:49:08 -0700 Subject: [PATCH 1156/1753] Use `-LiteralPath` instead of `-Path` in ps1 scripts Fixes #314 --- Expand-Template.ps1 | 4 ++-- azure-pipelines/Get-CodeCovTool.ps1 | 2 +- azure-pipelines/Merge-CodeCoverage.ps1 | 2 +- azure-pipelines/artifacts/Variables.ps1 | 4 ++-- azure-pipelines/artifacts/_pipelines.ps1 | 2 +- azure-pipelines/artifacts/_stage_all.ps1 | 2 +- azure-pipelines/artifacts/coverageResults.ps1 | 4 ++-- azure-pipelines/dotnet-test-cloud.ps1 | 2 +- azure-pipelines/publish-CodeCov.ps1 | 2 +- azure-pipelines/variables/DotNetSdkVersion.ps1 | 2 +- azure-pipelines/variables/_pipelines.ps1 | 4 ++-- tools/Install-DotNetSdk.ps1 | 4 ++-- tools/Install-NuGetCredProvider.ps1 | 2 +- tools/Set-EnvVars.ps1 | 12 ++++++------ 14 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 44ef68266..9f9db676c 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -40,7 +40,7 @@ function Replace-Placeholders { $Path = Resolve-Path $Path Write-Host "Replacing tokens in `"$Path`"" - $content = Get-Content -Path $Path | Out-String + $content = Get-Content -LiteralPath $Path | Out-String $Replacements.GetEnumerator() |% { $modifiedContent = $content -replace $_.Key,$_.Value if ($modifiedContent -eq $content) { @@ -199,7 +199,7 @@ try { # Self-integrity check Get-ChildItem -Recurse -File -Exclude bin,obj,README.md,Expand-Template.* |? { -not $_.FullName.Contains("obj") } |% { - $PLACEHOLDERS = Get-Content -Path $_.FullName |? { $_.Contains('PLACEHOLDER') } + $PLACEHOLDERS = Get-Content -LiteralPath $_.FullName |? { $_.Contains('PLACEHOLDER') } if ($PLACEHOLDERS) { Write-Error "PLACEHOLDER discovered in $($_.FullName)" } diff --git a/azure-pipelines/Get-CodeCovTool.ps1 b/azure-pipelines/Get-CodeCovTool.ps1 index ca580b4db..734ee6079 100644 --- a/azure-pipelines/Get-CodeCovTool.ps1 +++ b/azure-pipelines/Get-CodeCovTool.ps1 @@ -68,7 +68,7 @@ if (!(Test-Path $finalToolPath)) { } Write-Host "Verifying hash on downloaded tool" -ForegroundColor Yellow - $actualHash = (Get-FileHash -Path $tool -Algorithm SHA256).Hash + $actualHash = (Get-FileHash -LiteralPath $tool -Algorithm SHA256).Hash $expectedHash = (Get-Content $sha).Split()[0] if ($actualHash -ne $expectedHash) { # Validation failed. Delete the tool so we can't execute it. diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 5ecabbc9b..308f57546 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -28,7 +28,7 @@ try { if ($reports) { $reports |% { $_.FullName } |% { # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. - $xml = [xml](Get-Content -Path $_) + $xml = [xml](Get-Content -LiteralPath $_) $xml.coverage.packages.package.classes.class |? { $_.filename} |% { $_.filename = $_.filename.Replace('{reporoot}', $RepoRoot).Replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) } diff --git a/azure-pipelines/artifacts/Variables.ps1 b/azure-pipelines/artifacts/Variables.ps1 index 4bc6d2165..7a320c7ea 100644 --- a/azure-pipelines/artifacts/Variables.ps1 +++ b/azure-pipelines/artifacts/Variables.ps1 @@ -32,10 +32,10 @@ Get-ChildItem "$PSScriptRoot/../variables" |% { # If that didn't get us anything, just copy the script itself if (-not $value) { - $value = Get-Content -Path $_.FullName + $value = Get-Content -LiteralPath $_.FullName } - Set-Content -Path "$VariablesArtifactPath/$($_.Name)" -Value $value + Set-Content -LiteralPath "$VariablesArtifactPath/$($_.Name)" -Value $value } @{ diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/artifacts/_pipelines.ps1 index 47321ed5b..5f259a512 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/artifacts/_pipelines.ps1 @@ -16,7 +16,7 @@ Function Set-PipelineVariable($name, $value) { return # already set } - #New-Item -Path "Env:\$name".ToUpper() -Value $value -Force | Out-Null + #New-Item -LiteralPath "Env:\$name".ToUpper() -Value $value -Force | Out-Null Write-Host "##vso[task.setvariable variable=$name]$value" } diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index 74d7a38df..bf961ce57 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -51,7 +51,7 @@ $Artifacts |% { if (Test-Path -PathType Leaf $_.Source) { # skip folders $TargetPath = Join-Path $DestinationFolder $Name if ($AvoidSymbolicLinks) { - Copy-Item -Path $_.Source -Destination $TargetPath + Copy-Item -LiteralPath $_.Source -Destination $TargetPath } else { Create-SymbolicLink -Link $TargetPath -Target $_.Source } diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index 280ff9ae0..a6c8f4200 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -6,8 +6,8 @@ $coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse | Whe if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`"" $coverageFiles |% { - $content = Get-Content -Path $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } - Set-Content -Path $_ -Value $content -Encoding UTF8 + $content = Get-Content -LiteralPath $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } + Set-Content -LiteralPath $_ -Value $content -Encoding UTF8 } } else { Write-Warning "coverageResults: Azure Pipelines not detected. Machine-neutral token replacement skipped." diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 24bf812a1..33ff3d7c0 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -61,7 +61,7 @@ Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { Copy-Item $_ -Destination $ArtifactStagingFolder/test_logs/ if ($PublishResults) { - $x = [xml](Get-Content -Path $_) + $x = [xml](Get-Content -LiteralPath $_) $runTitle = $null if ($x.TestRun.TestDefinitions -and $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')) { $storage = $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')[0].storage -replace '\\','/' diff --git a/azure-pipelines/publish-CodeCov.ps1 b/azure-pipelines/publish-CodeCov.ps1 index 9926f0188..1d7365110 100644 --- a/azure-pipelines/publish-CodeCov.ps1 +++ b/azure-pipelines/publish-CodeCov.ps1 @@ -22,7 +22,7 @@ Param ( $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path -Get-ChildItem -Recurse -Path $PathToCodeCoverage -Filter "*.cobertura.xml" | % { +Get-ChildItem -Recurse -LiteralPath $PathToCodeCoverage -Filter "*.cobertura.xml" | % { $relativeFilePath = Resolve-Path -relative $_.FullName Write-Host "Uploading: $relativeFilePath" -ForegroundColor Yellow diff --git a/azure-pipelines/variables/DotNetSdkVersion.ps1 b/azure-pipelines/variables/DotNetSdkVersion.ps1 index b213fbc27..722cc5845 100644 --- a/azure-pipelines/variables/DotNetSdkVersion.ps1 +++ b/azure-pipelines/variables/DotNetSdkVersion.ps1 @@ -1,2 +1,2 @@ -$globalJson = Get-Content -Path "$PSScriptRoot\..\..\global.json" | ConvertFrom-Json +$globalJson = Get-Content -LiteralPath "$PSScriptRoot\..\..\global.json" | ConvertFrom-Json $globalJson.sdk.version diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/variables/_pipelines.ps1 index 11748b81b..d40e5cf14 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/variables/_pipelines.ps1 @@ -24,8 +24,8 @@ param ( # and the second that works across jobs and stages but must be fully qualified when referenced. Write-Host "##vso[task.setvariable variable=$keyCaps;isOutput=true]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { - Add-Content -Path $env:GITHUB_ENV -Value "$keyCaps=$($_.Value)" + Add-Content -LiteralPath $env:GITHUB_ENV -Value "$keyCaps=$($_.Value)" } - Set-Item -Path "env:$keyCaps" -Value $_.Value + Set-Item -LiteralPath "env:$keyCaps" -Value $_.Value } } diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index e190fcfbf..ffb522030 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -55,8 +55,8 @@ $runtimeVersions = @() $windowsDesktopRuntimeVersions = @() $aspnetRuntimeVersions = @() if (!$SdkOnly) { - Get-ChildItem "$PSScriptRoot\..\src\*.*proj","$PSScriptRoot\..\test\*.*proj","$PSScriptRoot\..\Directory.Build.props" -Recurse |% { - $projXml = [xml](Get-Content -Path $_) + Get-ChildItem "$PSScriptRoot\..\src\*.*proj", "$PSScriptRoot\..\test\*.*proj", "$PSScriptRoot\..\Directory.Build.props" -Recurse | % { + $projXml = [xml](Get-Content -LiteralPath $_) $pg = $projXml.Project.PropertyGroup if ($pg) { $targetFrameworks = @() diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index 857324b64..2b904e33e 100755 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -50,7 +50,7 @@ if ($AccessToken) { $endpointURIs = @() Get-ChildItem "$PSScriptRoot\..\nuget.config" -Recurse |% { - $nugetConfig = [xml](Get-Content -Path $_) + $nugetConfig = [xml](Get-Content -LiteralPath $_) $nugetConfig.configuration.packageSources.add |? { ($_.value -match '^https://pkgs\.dev\.azure\.com/') -or ($_.value -match '^https://[\w\-]+\.pkgs\.visualstudio\.com/') } |% { if ($endpointURIs -notcontains $_.Value) { diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index 3f6f86ba5..2bd3ca4db 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -45,14 +45,14 @@ if ($env:GITHUB_ACTIONS) { $CmdEnvScript = '' $Variables.GetEnumerator() |% { - Set-Item -Path env:$($_.Key) -Value $_.Value + Set-Item -LiteralPath env:$($_.Key) -Value $_.Value # If we're running in a cloud CI, set these environment variables so they propagate. if ($env:TF_BUILD) { Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" } if ($env:GITHUB_ACTIONS) { - Add-Content -Path $env:GITHUB_ENV -Value "$($_.Key)=$($_.Value)" + Add-Content -LiteralPath $env:GITHUB_ENV -Value "$($_.Key)=$($_.Value)" } if ($cmdInstructions) { @@ -70,7 +70,7 @@ if ($IsMacOS -or $IsLinux) { if ($PrependPath) { $PrependPath |% { $newPathValue = "$_$pathDelimiter$env:PATH" - Set-Item -Path env:PATH -Value $newPathValue + Set-Item -LiteralPath env:PATH -Value $newPathValue if ($cmdInstructions) { Write-Host "SET PATH=$newPathValue" } @@ -79,7 +79,7 @@ if ($PrependPath) { Write-Host "##vso[task.prependpath]$_" } if ($env:GITHUB_ACTIONS) { - Add-Content -Path $env:GITHUB_PATH -Value $_ + Add-Content -LiteralPath $env:GITHUB_PATH -Value $_ } $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" @@ -88,10 +88,10 @@ if ($PrependPath) { if ($env:CmdEnvScriptPath) { if (Test-Path $env:CmdEnvScriptPath) { - $CmdEnvScript = (Get-Content -Path $env:CmdEnvScriptPath) + $CmdEnvScript + $CmdEnvScript = (Get-Content -LiteralPath $env:CmdEnvScriptPath) + $CmdEnvScript } - Set-Content -Path $env:CmdEnvScriptPath -Value $CmdEnvScript + Set-Content -LiteralPath $env:CmdEnvScriptPath -Value $CmdEnvScript } return !$cmdInstructions From 110da233b0796e2c3e9a3acfabe9df70334a796e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 25 Nov 2024 06:51:07 -0700 Subject: [PATCH 1157/1753] Replace `Nullable` with `PolySharp` as a dependency PolySharp is far more exhaustive in the polyfills than Nullable is. --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1a464d153..237b3c2c6 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -15,7 +15,7 @@ - + From f8235e44613937e4f524aeae1654c1438fd1d612 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 27 Nov 2024 11:36:45 -0700 Subject: [PATCH 1158/1753] Add docfx verification to build --- .github/workflows/build.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 24bc7d9e4..6b1fb6060 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,8 +3,8 @@ name: CI on: push: branches: - - main - - validate/* + - main + - validate/* pull_request: env: @@ -51,6 +51,9 @@ jobs: run: dotnet format --verify-no-changes --no-restore shell: pwsh if: runner.os == 'Linux' + - name: 📚 Verify docfx build + run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures + if: runner.os == 'Linux' - name: ⚙ Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh From 45279a7aaf81400e9420099490a33c41d87bd2c4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 27 Nov 2024 12:02:22 -0700 Subject: [PATCH 1159/1753] Fix nb.gv failure during docfx build --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6e6e64a08..1820866e7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,6 +25,8 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites run: ./init.ps1 -UpgradePrerequisites From 3a32d099657cdfddc0175cdacbd55a450c171a6e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 30 Nov 2024 09:02:09 -0700 Subject: [PATCH 1160/1753] Remove double word from boilerplate docfx text --- docfx/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docfx/index.md b/docfx/index.md index fc1b9e286..391ee6ec5 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -6,4 +6,4 @@ _layout: landing This is your docfx landing page. -Click "Docs" across the top to get get started. +Click "Docs" across the top to get started. From feb1a4651ff6fcf933deae89478c1f06dab2db6c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 2 Dec 2024 07:10:53 -0700 Subject: [PATCH 1161/1753] Bump docfx to 2.78.2 --- .config/dotnet-tools.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 1c5d6944a..81e88d255 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -24,11 +24,11 @@ "rollForward": false }, "docfx": { - "version": "2.78.1", + "version": "2.78.2", "commands": [ "docfx" ], "rollForward": false } } -} \ No newline at end of file +} From 73469b47e63c83b6fa7b37958e7cee1bc5870bbd Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Mon, 2 Dec 2024 13:45:50 -0800 Subject: [PATCH 1162/1753] Set version to 17.13 --- version.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.json b/version.json index 0a4c364c7..0b00bfe8a 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.12", + "version": "17.13", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} \ No newline at end of file +} From 130ad679bb04f5a57b2cbf111675303eb6f531e1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 8 Dec 2024 18:27:14 -0700 Subject: [PATCH 1163/1753] Bump dotnet-coverage to 17.13.1 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 81e88d255..aaff6e7fc 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "17.12.6", + "version": "17.13.1", "commands": [ "dotnet-coverage" ], From 8a0d319d2a5fdac363f11c092ff83561234eeb0a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 8 Dec 2024 19:56:33 -0700 Subject: [PATCH 1164/1753] Move artifact publishing into a composite action --- .github/actions/publish-artifacts/action.yaml | 67 +++++++++++++++++++ .github/workflows/build.yml | 60 +---------------- 2 files changed, 70 insertions(+), 57 deletions(-) create mode 100644 .github/actions/publish-artifacts/action.yaml diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml new file mode 100644 index 000000000..94b742613 --- /dev/null +++ b/.github/actions/publish-artifacts/action.yaml @@ -0,0 +1,67 @@ +name: Publish artifacts +description: Publish artifacts + +runs: + using: composite + steps: + - name: 📥 Collect artifacts + run: azure-pipelines/artifacts/_stage_all.ps1 + shell: pwsh + if: always() + +# TODO: replace this hard-coded list with a loop that utilizes the NPM package at +# https://github.com/actions/toolkit/tree/main/packages/artifact (or similar) to push the artifacts. + + - name: 📢 Upload project.assets.json files + if: always() + uses: actions/upload-artifact@v4 + with: + name: projectAssetsJson-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/projectAssetsJson + continue-on-error: true + - name: 📢 Upload variables + uses: actions/upload-artifact@v4 + with: + name: variables-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/Variables + continue-on-error: true + - name: 📢 Upload build_logs + if: always() + uses: actions/upload-artifact@v4 + with: + name: build_logs-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/build_logs + continue-on-error: true + - name: 📢 Upload test_logs + if: always() + uses: actions/upload-artifact@v4 + with: + name: test_logs-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/test_logs + continue-on-error: true + - name: 📢 Upload testResults + if: always() + uses: actions/upload-artifact@v4 + with: + name: testResults-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/testResults + continue-on-error: true + - name: 📢 Upload coverageResults + if: always() + uses: actions/upload-artifact@v4 + with: + name: coverageResults-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/coverageResults + continue-on-error: true + - name: 📢 Upload symbols + uses: actions/upload-artifact@v4 + with: + name: symbols-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/symbols + continue-on-error: true + - name: 📢 Upload deployables + uses: actions/upload-artifact@v4 + with: + name: deployables-${{ runner.os }} + path: ${{ runner.temp }}/_artifacts/deployables + if: always() diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6b1fb6060..9d87be99e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -15,6 +15,7 @@ env: jobs: build: + name: 🏭 Build runs-on: ${{ matrix.os }} strategy: @@ -57,63 +58,8 @@ jobs: - name: ⚙ Update pipeline variables based on build outputs run: azure-pipelines/variables/_pipelines.ps1 shell: pwsh - - name: 📥 Collect artifacts - run: azure-pipelines/artifacts/_stage_all.ps1 - shell: pwsh - if: always() - - name: 📢 Upload project.assets.json files - if: always() - uses: actions/upload-artifact@v4 - with: - name: projectAssetsJson-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/projectAssetsJson - continue-on-error: true - - name: 📢 Upload variables - uses: actions/upload-artifact@v4 - with: - name: variables-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/Variables - continue-on-error: true - - name: 📢 Upload build_logs - if: always() - uses: actions/upload-artifact@v4 - with: - name: build_logs-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/build_logs - continue-on-error: true - - name: 📢 Upload test_logs - if: always() - uses: actions/upload-artifact@v4 - with: - name: test_logs-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/test_logs - continue-on-error: true - - name: 📢 Upload testResults - if: always() - uses: actions/upload-artifact@v4 - with: - name: testResults-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/testResults - continue-on-error: true - - name: 📢 Upload coverageResults - if: always() - uses: actions/upload-artifact@v4 - with: - name: coverageResults-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/coverageResults - continue-on-error: true - - name: 📢 Upload symbols - uses: actions/upload-artifact@v4 - with: - name: symbols-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/symbols - continue-on-error: true - - name: 📢 Upload deployables - uses: actions/upload-artifact@v4 - with: - name: deployables-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/deployables - if: always() + - name: 📢 Publish artifacts + uses: ./.github/actions/publish-artifacts - name: 📢 Publish code coverage results to codecov.io run: ./azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" shell: pwsh From 904ff78e41c6c0b5c508080012583a063d4e0eef Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 8 Dec 2024 19:59:31 -0700 Subject: [PATCH 1165/1753] Make the CI workflow dispatchable --- .github/workflows/build.yml | 3 ++- .github/workflows/libtemplate-update.yml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 9d87be99e..5334bac59 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,4 +1,4 @@ -name: CI +name: 🏭 Build on: push: @@ -6,6 +6,7 @@ on: - main - validate/* pull_request: + workflow_dispatch: env: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 0501d5eed..f78c7e08c 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -1,4 +1,4 @@ -name: Library.Template update +name: ⛜ Library.Template update # PREREQUISITE: This workflow requires the repo to be configured to allow workflows to create pull requests. # Visit https://github.com/USER/REPO/settings/actions From 9bbf8a32612f990db1c8972293af5a972febb406 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 9 Dec 2024 11:17:13 -0700 Subject: [PATCH 1166/1753] Fix docfx build on private repos --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1820866e7..70b779b57 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -10,6 +10,7 @@ permissions: actions: read pages: write id-token: write + contents: read # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. From 4fa9e72acb9f30a3cdb4f15c60681fc2b71273f0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 9 Dec 2024 11:17:23 -0700 Subject: [PATCH 1167/1753] Fix code coverage merge on GitHub Actions --- azure-pipelines/artifacts/coverageResults.ps1 | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/azure-pipelines/artifacts/coverageResults.ps1 index a6c8f4200..8c68216ed 100644 --- a/azure-pipelines/artifacts/coverageResults.ps1 +++ b/azure-pipelines/artifacts/coverageResults.ps1 @@ -3,14 +3,16 @@ $RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") $coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse | Where {$_.FullName -notlike "*/In/*" -and $_.FullName -notlike "*\In\*" }) # Prepare code coverage reports for merging on another machine -if ($env:SYSTEM_DEFAULTWORKINGDIRECTORY) { - Write-Host "Substituting $env:SYSTEM_DEFAULTWORKINGDIRECTORY with `"{reporoot}`"" +$repoRoot = $env:SYSTEM_DEFAULTWORKINGDIRECTORY +if (!$repoRoot) { $repoRoot = $env:GITHUB_WORKSPACE } +if ($repoRoot) { + Write-Host "Substituting $repoRoot with `"{reporoot}`"" $coverageFiles |% { - $content = Get-Content -LiteralPath $_ |% { $_ -Replace [regex]::Escape($env:SYSTEM_DEFAULTWORKINGDIRECTORY), "{reporoot}" } + $content = Get-Content -LiteralPath $_ |% { $_ -Replace [regex]::Escape($repoRoot), "{reporoot}" } Set-Content -LiteralPath $_ -Value $content -Encoding UTF8 } } else { - Write-Warning "coverageResults: Azure Pipelines not detected. Machine-neutral token replacement skipped." + Write-Warning "coverageResults: Cloud build not detected. Machine-neutral token replacement skipped." } if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } From 89afbfc38b5726d311954e4902e8f2c75f62f535 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 9 Dec 2024 11:17:37 -0700 Subject: [PATCH 1168/1753] Add release workflow --- .github/workflows/release.yml | 87 +++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000..d6f5cc45d --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,87 @@ +name: 🎁 Release + +on: + release: + types: [published] + workflow_dispatch: + inputs: + ship_run_id: + description: ID of the GitHub workflow run to ship + required: true + +run-name: ${{ github.ref_name }} + +permissions: + actions: read + contents: write + +jobs: + release: + runs-on: ubuntu-22.04 + steps: + - name: ⚙️ Initialization + shell: pwsh + run: | + if ('${{ secrets.NUGET_API_KEY }}') { + echo "NUGET_API_KEY_DEFINED=true" >> $GITHUB_ENV + } + + - name: 🔎 Search for build of ${{ github.ref }} + shell: pwsh + id: findrunid + env: + GH_TOKEN: ${{ github.token }} + run: | + if ('${{ inputs.ship_run_id }}') { + $runid = '${{ inputs.ship_run_id }}' + } else { + $restApiRoot = '/repos/${{ github.repository }}' + + # Resolve the tag reference to a commit sha + $resolvedRef = gh api ` + -H "Accept: application/vnd.github+json" ` + -H "X-GitHub-Api-Version: 2022-11-28" ` + $restApiRoot/git/ref/tags/${{ github.ref_name }} ` + | ConvertFrom-Json + $commitSha = $resolvedRef.object.sha + + Write-Host "Resolved ${{ github.ref_name }} to $commitSha" + + $releases = gh run list -R ${{ github.repository }} -c $commitSha -w .github/workflows/build.yml -s success --json databaseId,startedAt ` + | ConvertFrom-Json | Sort-Object startedAt -Descending + + if ($releases.length -eq 0) { + Write-Error "No successful builds found for ${{ github.ref }}." + } elseif ($releases.length -gt 1) { + Write-Warning "More than one successful run found for ${{ github.ref }}. Artifacts from the most recent successful run will ship." + } + + $runid = $releases[0].databaseId + } + + Write-Host "Using artifacts from run-id: $runid" + + Echo "runid=$runid" >> $env:GITHUB_OUTPUT + + - name: 🔻 Download deployables artifacts + uses: actions/download-artifact@v4 + with: + name: deployables-Linux + path: ${{ runner.temp }}/deployables + run-id: ${{ steps.findrunid.outputs.runid }} + github-token: ${{ github.token }} + + - name: 💽 Upload artifacts to release + shell: pwsh + if: ${{ github.event.release.assets_url }} != '' + env: + GH_TOKEN: ${{ github.token }} + run: | + Get-ChildItem '${{ runner.temp }}/deployables' |% { + Write-Host "Uploading $($_.Name) to release..." + gh release -R ${{ github.repository }} upload "${{ github.ref_name }}" $_.FullName + } + + - name: 🚀 Push NuGet packages + run: dotnet nuget push ${{ runner.temp }}/deployables/*.nupkg --source https://api.nuget.org/v3/index.json -k '${{ secrets.NUGET_API_KEY }}' + if: ${{ env.NUGET_API_KEY_DEFINED == 'true' }} From 1a06053669fe6f6c7d67d8f76ba5b139ab691b5e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 9 Dec 2024 11:53:03 -0700 Subject: [PATCH 1169/1753] Document release process --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ec56f4d6..52d83a882 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,6 +41,29 @@ Building, testing, and packing this repository can be done by using the standard [pwsh]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell?view=powershell-6 +## Releases + +Use `nbgv tag` to create a tag for a particular commit that you mean to release. +[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/doc/nbgv-cli.md). + +Push the tag. + +### GitHub Actions + +When your repo is hosted by GitHub and you are using GitHub Actions, you should create a GitHub Release using the standard GitHub UI. +Having previously used `nbgv tag` and pushing the tag will help you identify the precise commit and name to use for this release. + +After publishing the release, the `.github\workflows\release.yml` workflow will be automatically triggered, which will: + +1. Find the most recent `.github\workflows\build.yml` GitHub workflow run of the tagged release. +1. Upload the `deployables` artifact from that workflow run to your GitHub Release. +1. If you have `NUGET_API_KEY` defined as a secret variable for your repo or org, any nuget packages in the `deployables` artifact will be pushed to nuget.org. + +### Azure Pipelines + +When your repo builds with Azure Pipelines, use the `azure-pipelines/release.yml` pipeline. +Trigger the pipeline by adding the `auto-release` tag on a run of your main `azure-pipelines.yml` pipeline. + ## Tutorial and API documentation API and hand-written docs are found under the `docfx/` directory. and are built by [docfx](https://dotnet.github.io/docfx/). From 7bb9a6c37c9cc09513b5e6c0a950e410dfb8d70e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Dec 2024 10:25:36 -0700 Subject: [PATCH 1170/1753] Publish test results when they fail on github workflows --- .github/workflows/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5334bac59..474d90c20 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -61,6 +61,7 @@ jobs: shell: pwsh - name: 📢 Publish artifacts uses: ./.github/actions/publish-artifacts + if: always() - name: 📢 Publish code coverage results to codecov.io run: ./azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" shell: pwsh From f6204f39ccd73fde0e4890d66f5019d467a9348a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 13 Dec 2024 09:16:31 -0700 Subject: [PATCH 1171/1753] Fix push to nuget.org in github release workflow --- .github/workflows/release.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d6f5cc45d..ed0f5924a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -23,7 +23,8 @@ jobs: shell: pwsh run: | if ('${{ secrets.NUGET_API_KEY }}') { - echo "NUGET_API_KEY_DEFINED=true" >> $GITHUB_ENV + Write-Host "NUGET_API_KEY secret detected. NuGet packages will be pushed." + echo "NUGET_API_KEY_DEFINED=true" >> $env:GITHUB_ENV } - name: 🔎 Search for build of ${{ github.ref }} From 0a42cd9afd1e40f6a5392850a5115ca5f42dfd9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 15 Dec 2024 20:35:38 -0700 Subject: [PATCH 1172/1753] Bump nbgv and Nerdbank.GitVersioning to 3.7.112 --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index aaff6e7fc..3f79bdec4 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -17,7 +17,7 @@ "rollForward": false }, "nbgv": { - "version": "3.6.146", + "version": "3.7.112", "commands": [ "nbgv" ], diff --git a/Directory.Packages.props b/Directory.Packages.props index 237b3c2c6..1023acabf 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -14,7 +14,7 @@ - + From d8df5c88cf22b9a90fb7a48b73ee3fa7dcf7eb07 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 18 Dec 2024 11:29:15 -0700 Subject: [PATCH 1173/1753] Activate GitHub Actions test reporting --- Directory.Packages.props | 1 + azure-pipelines/dotnet-test-cloud.ps1 | 35 ++++++++++++++++++++++++--- test/Directory.Build.props | 3 +++ 3 files changed, 35 insertions(+), 4 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1023acabf..1f94284aa 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,6 +6,7 @@ true + diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index 33ff3d7c0..c0be86721 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -25,6 +25,8 @@ Param( $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path $ArtifactStagingFolder = & "$PSScriptRoot/Get-ArtifactsStagingDirectory.ps1" +$TestLogsPath = "$ArtifactStagingFolder/test_logs" +if (!(Test-Path $TestLogsPath)) { New-Item -ItemType Directory -Path $TestLogsPath | Out-Null } $dotnet = 'dotnet' if ($x86) { @@ -44,21 +46,46 @@ if ($x86) { } } +$dotnetTestArgs = @() +$dotnetTestArgs2 = @() + +# The GitHubActions test logger fails when combined with certain switches, but only on mac/linux. +# We avoid those switches in that specific context. +# Failure symptoms when using the wrong switch combinations on mac/linux are (depending on the switches) EITHER: +# - The test runner fails with exit code 1 (and no error message) +# - The test runner succeeds but the GitHubActions logger only adds annotations on Windows agents. +# See https://github.com/Tyrrrz/GitHubActionsTestLogger/discussions/37 for more info. +# Thus, the mess of conditions you see below, in order to get GitHubActions to work +# without undermining other value we have when running in other contexts. +if ($env:GITHUB_WORKFLOW -and ($IsLinux -or $IsMacOS)) { + $dotnetTestArgs += '--collect','Xplat Code Coverage' + $dotnetTestArgs2 += 'DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover' +} else { + $dotnetTestArgs += '--diag','$$TestLogsPath/diag.log;TraceLevel=info' + $dotnetTestArgs += '--collect','Code Coverage;Format=cobertura' + $dotnetTestArgs += '--settings',"$PSScriptRoot/test.runsettings" +} + +if ($env:GITHUB_WORKFLOW) { + $dotnetTestArgs += '--logger','GitHubActions' + $dotnetTestArgs2 += 'RunConfiguration.CollectSourceInformation=true' +} + & $dotnet test $RepoRoot ` --no-build ` -c $Configuration ` --filter "TestCategory!=FailsInCloudTest" ` - --collect "Code Coverage;Format=cobertura" ` - --settings "$PSScriptRoot/test.runsettings" ` --blame-hang-timeout 60s ` --blame-crash ` -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` - --diag "$ArtifactStagingFolder/test_logs/diag.log;TraceLevel=info" ` --logger trx ` + @dotnetTestArgs ` + -- ` + @dotnetTestArgs2 $unknownCounter = 0 Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { - Copy-Item $_ -Destination $ArtifactStagingFolder/test_logs/ + Copy-Item $_ -Destination $TestLogsPath/ if ($PublishResults) { $x = [xml](Get-Content -LiteralPath $_) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 6c7aa71dc..65b3bade3 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -7,4 +7,7 @@ true + + + From d2f4c5e339b1be2bb8bccff6ef13b0a3fe63c81e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 18 Dec 2024 15:10:28 -0700 Subject: [PATCH 1174/1753] Revert "Merge pull request #319 from AArnott/betterTestingLibTemplate" This reverts commit 01eeb1aff44be490aea525baa92f89240ba2f682, reversing changes made to 0a42cd9afd1e40f6a5392850a5115ca5f42dfd9a. --- Directory.Packages.props | 1 - azure-pipelines/dotnet-test-cloud.ps1 | 35 +++------------------------ test/Directory.Build.props | 3 --- 3 files changed, 4 insertions(+), 35 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1f94284aa..1023acabf 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,6 @@ true - diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/azure-pipelines/dotnet-test-cloud.ps1 index c0be86721..33ff3d7c0 100755 --- a/azure-pipelines/dotnet-test-cloud.ps1 +++ b/azure-pipelines/dotnet-test-cloud.ps1 @@ -25,8 +25,6 @@ Param( $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path $ArtifactStagingFolder = & "$PSScriptRoot/Get-ArtifactsStagingDirectory.ps1" -$TestLogsPath = "$ArtifactStagingFolder/test_logs" -if (!(Test-Path $TestLogsPath)) { New-Item -ItemType Directory -Path $TestLogsPath | Out-Null } $dotnet = 'dotnet' if ($x86) { @@ -46,46 +44,21 @@ if ($x86) { } } -$dotnetTestArgs = @() -$dotnetTestArgs2 = @() - -# The GitHubActions test logger fails when combined with certain switches, but only on mac/linux. -# We avoid those switches in that specific context. -# Failure symptoms when using the wrong switch combinations on mac/linux are (depending on the switches) EITHER: -# - The test runner fails with exit code 1 (and no error message) -# - The test runner succeeds but the GitHubActions logger only adds annotations on Windows agents. -# See https://github.com/Tyrrrz/GitHubActionsTestLogger/discussions/37 for more info. -# Thus, the mess of conditions you see below, in order to get GitHubActions to work -# without undermining other value we have when running in other contexts. -if ($env:GITHUB_WORKFLOW -and ($IsLinux -or $IsMacOS)) { - $dotnetTestArgs += '--collect','Xplat Code Coverage' - $dotnetTestArgs2 += 'DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover' -} else { - $dotnetTestArgs += '--diag','$$TestLogsPath/diag.log;TraceLevel=info' - $dotnetTestArgs += '--collect','Code Coverage;Format=cobertura' - $dotnetTestArgs += '--settings',"$PSScriptRoot/test.runsettings" -} - -if ($env:GITHUB_WORKFLOW) { - $dotnetTestArgs += '--logger','GitHubActions' - $dotnetTestArgs2 += 'RunConfiguration.CollectSourceInformation=true' -} - & $dotnet test $RepoRoot ` --no-build ` -c $Configuration ` --filter "TestCategory!=FailsInCloudTest" ` + --collect "Code Coverage;Format=cobertura" ` + --settings "$PSScriptRoot/test.runsettings" ` --blame-hang-timeout 60s ` --blame-crash ` -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` + --diag "$ArtifactStagingFolder/test_logs/diag.log;TraceLevel=info" ` --logger trx ` - @dotnetTestArgs ` - -- ` - @dotnetTestArgs2 $unknownCounter = 0 Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { - Copy-Item $_ -Destination $TestLogsPath/ + Copy-Item $_ -Destination $ArtifactStagingFolder/test_logs/ if ($PublishResults) { $x = [xml](Get-Content -LiteralPath $_) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 65b3bade3..6c7aa71dc 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -7,7 +7,4 @@ true - - - From 7b18fd08172526499129f394ae71878cfc0acc63 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 20 Dec 2024 08:14:30 -0700 Subject: [PATCH 1175/1753] Resolve schema validation error in VS Code for docfx yml files --- docfx/docs/toc.yml | 2 +- docfx/toc.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docfx/docs/toc.yml b/docfx/docs/toc.yml index 36a380208..518ffadd9 100644 --- a/docfx/docs/toc.yml +++ b/docfx/docs/toc.yml @@ -1,5 +1,5 @@ +items: - name: Features href: features.md - name: Getting Started href: getting-started.md - diff --git a/docfx/toc.yml b/docfx/toc.yml index abd17b8c7..8e9a67007 100644 --- a/docfx/toc.yml +++ b/docfx/toc.yml @@ -1,3 +1,4 @@ +items: - name: Docs href: docs/ - name: API From ad4ff0f092dfc147fdb6f5f2151c7071c9b8bc6e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 20 Dec 2024 10:19:52 -0700 Subject: [PATCH 1176/1753] Bump xunit.runner.visualstudio to 3.0.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1023acabf..b10eaee79 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ - + From 2e9751f002252714719de4d2f914156902b8aae5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 20 Dec 2024 10:19:58 -0700 Subject: [PATCH 1177/1753] Bump .NET SDK to 9.0.101 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index 088f23e11..f3e0b3239 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.100", + "version": "9.0.101", "rollForward": "patch", "allowPrerelease": false } From 0c33c695660191469a486f8f9de195f378f1bd2d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 20 Dec 2024 10:35:40 -0700 Subject: [PATCH 1178/1753] Organize Directory.Packages.props to reduce merge conflicts going forward --- Directory.Packages.props | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Directory.Packages.props b/Directory.Packages.props index b10eaee79..32113f54f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,11 +6,17 @@ true + + + + + + From 99ee1fcd49f2d7ce9cf8e5c1d2927260548d0171 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 22 Dec 2024 18:50:42 -0700 Subject: [PATCH 1179/1753] Bump to Xunit v3 --- Directory.Packages.props | 4 ++-- test/Library.Tests/Library.Tests.csproj | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 32113f54f..63808e7c0 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ - + @@ -24,4 +24,4 @@ - + \ No newline at end of file diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index a853dc7d4..5cbc1e1f2 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -3,6 +3,7 @@ net8.0 $(TargetFrameworks);net472 + Exe @@ -13,7 +14,7 @@ - + From 94eba4a33a15fd28a0693bba3e3e5086d0df8d24 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Dec 2024 09:48:35 -0700 Subject: [PATCH 1180/1753] Build servicing branches --- .github/workflows/build.yml | 1 + azure-pipelines.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474d90c20..fbd7115cb 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -4,6 +4,7 @@ on: push: branches: - main + - 'v*.*' - validate/* pull_request: workflow_dispatch: diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 9867b3db8..4d372fe0c 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -3,6 +3,7 @@ trigger: branches: include: - main + - 'v*.*' - 'validate/*' paths: exclude: From 275a44b6c5cb089a21ac2b2456c55d66ec172236 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Dec 2024 11:39:09 -0700 Subject: [PATCH 1181/1753] Do not publish artifacts on cancelled GitHub workflows --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fbd7115cb..58e56ccc0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -62,7 +62,7 @@ jobs: shell: pwsh - name: 📢 Publish artifacts uses: ./.github/actions/publish-artifacts - if: always() + if: cancelled() == false - name: 📢 Publish code coverage results to codecov.io run: ./azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" shell: pwsh From 8870497c3473ebc75324c5356b36b4361f2a9065 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2024 09:12:10 -0700 Subject: [PATCH 1182/1753] Move scripts that apply to github workflows from azp to tools --- .github/workflows/build.yml | 4 ++-- .github/workflows/libtemplate-update.yml | 2 +- azure-pipelines/artifacts/_stage_all.ps1 | 2 +- azure-pipelines/artifacts/build_logs.ps1 | 2 +- azure-pipelines/dotnet.yml | 6 +++--- azure-pipelines/libtemplate-update.yml | 2 +- init.ps1 | 2 +- .../Get-ArtifactsStagingDirectory.ps1 | 0 {azure-pipelines => tools}/Get-CodeCovTool.ps1 | 0 {azure-pipelines => tools}/Get-LibTemplateBasis.ps1 | 0 {azure-pipelines => tools}/Get-NuGetTool.ps1 | 0 {azure-pipelines => tools}/Get-ProcDump.ps1 | 0 {azure-pipelines => tools}/Get-TempToolsPath.ps1 | 0 tools/Install-NuGetCredProvider.ps1 | 2 +- tools/MergeFrom-Template.ps1 | 2 +- {azure-pipelines => tools}/dotnet-test-cloud.ps1 | 0 {azure-pipelines => tools}/publish-CodeCov.ps1 | 0 {azure-pipelines => tools}/test.runsettings | 0 18 files changed, 12 insertions(+), 12 deletions(-) rename {azure-pipelines => tools}/Get-ArtifactsStagingDirectory.ps1 (100%) rename {azure-pipelines => tools}/Get-CodeCovTool.ps1 (100%) rename {azure-pipelines => tools}/Get-LibTemplateBasis.ps1 (100%) rename {azure-pipelines => tools}/Get-NuGetTool.ps1 (100%) rename {azure-pipelines => tools}/Get-ProcDump.ps1 (100%) rename {azure-pipelines => tools}/Get-TempToolsPath.ps1 (100%) rename {azure-pipelines => tools}/dotnet-test-cloud.ps1 (100%) mode change 100755 => 100644 rename {azure-pipelines => tools}/publish-CodeCov.ps1 (100%) rename {azure-pipelines => tools}/test.runsettings (100%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 58e56ccc0..5e338ffa1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -48,7 +48,7 @@ jobs: - name: 🛠 build run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - name: 🧪 test - run: azure-pipelines/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} + run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} shell: pwsh - name: 💅🏻 Verify formatted code run: dotnet format --verify-no-changes --no-restore @@ -64,7 +64,7 @@ jobs: uses: ./.github/actions/publish-artifacts if: cancelled() == false - name: 📢 Publish code coverage results to codecov.io - run: ./azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" + run: ./tools/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" shell: pwsh timeout-minutes: 3 continue-on-error: true diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index f78c7e08c..c6b8fb4ab 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -25,7 +25,7 @@ jobs: id: merge shell: pwsh run: | - $LibTemplateBranch = & ./azure-pipelines/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated + $LibTemplateBranch = & ./tools/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/azure-pipelines/artifacts/_stage_all.ps1 index bf961ce57..08e9844c3 100644 --- a/azure-pipelines/artifacts/_stage_all.ps1 +++ b/azure-pipelines/artifacts/_stage_all.ps1 @@ -11,7 +11,7 @@ param ( [switch]$AvoidSymbolicLinks ) -$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal +$ArtifactStagingFolder = & "$PSScriptRoot/../../tools/Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal function Create-SymbolicLink { param ( diff --git a/azure-pipelines/artifacts/build_logs.ps1 b/azure-pipelines/artifacts/build_logs.ps1 index f05358e03..10c5478b3 100644 --- a/azure-pipelines/artifacts/build_logs.ps1 +++ b/azure-pipelines/artifacts/build_logs.ps1 @@ -1,4 +1,4 @@ -$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" +$ArtifactStagingFolder = & "$PSScriptRoot/../../tools/Get-ArtifactsStagingDirectory.ps1" if (!(Test-Path $ArtifactStagingFolder/build_logs)) { return } diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 2444928fb..2ce80af35 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -6,7 +6,7 @@ steps: - script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: 🛠 dotnet build -- powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults +- powershell: tools/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) @@ -22,9 +22,9 @@ steps: - ${{ if and(ne(variables['codecov_token'], ''), parameters.RunTests) }}: - powershell: | - $ArtifactStagingFolder = & "azure-pipelines/Get-ArtifactsStagingDirectory.ps1" + $ArtifactStagingFolder = & "tools/Get-ArtifactsStagingDirectory.ps1" $CoverageResultsFolder = Join-Path $ArtifactStagingFolder "coverageResults-$(Agent.JobName)" - azure-pipelines/publish-CodeCov.ps1 -CodeCovToken "$(codecov_token)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)" + tools/publish-CodeCov.ps1 -CodeCovToken "$(codecov_token)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)" displayName: 📢 Publish code coverage results to codecov.io timeoutInMinutes: 3 continueOnError: true diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index 87302b067..fdfa1df54 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -28,7 +28,7 @@ stages: fetchDepth: 0 clean: true - pwsh: | - $LibTemplateBranch = & ./azure-pipelines/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated + $LibTemplateBranch = & ./tools/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } diff --git a/init.ps1 b/init.ps1 index e28498553..b4004e792 100755 --- a/init.ps1 +++ b/init.ps1 @@ -71,7 +71,7 @@ if (!$NoPrerequisites) { # The procdump tool and env var is required for dotnet test to collect hang/crash dumps of tests. # But it only works on Windows. if ($env:OS -eq 'Windows_NT') { - $EnvVars['PROCDUMP_PATH'] = & "$PSScriptRoot\azure-pipelines\Get-ProcDump.ps1" + $EnvVars['PROCDUMP_PATH'] = & "$PSScriptRoot\tools\Get-ProcDump.ps1" } } diff --git a/azure-pipelines/Get-ArtifactsStagingDirectory.ps1 b/tools/Get-ArtifactsStagingDirectory.ps1 similarity index 100% rename from azure-pipelines/Get-ArtifactsStagingDirectory.ps1 rename to tools/Get-ArtifactsStagingDirectory.ps1 diff --git a/azure-pipelines/Get-CodeCovTool.ps1 b/tools/Get-CodeCovTool.ps1 similarity index 100% rename from azure-pipelines/Get-CodeCovTool.ps1 rename to tools/Get-CodeCovTool.ps1 diff --git a/azure-pipelines/Get-LibTemplateBasis.ps1 b/tools/Get-LibTemplateBasis.ps1 similarity index 100% rename from azure-pipelines/Get-LibTemplateBasis.ps1 rename to tools/Get-LibTemplateBasis.ps1 diff --git a/azure-pipelines/Get-NuGetTool.ps1 b/tools/Get-NuGetTool.ps1 similarity index 100% rename from azure-pipelines/Get-NuGetTool.ps1 rename to tools/Get-NuGetTool.ps1 diff --git a/azure-pipelines/Get-ProcDump.ps1 b/tools/Get-ProcDump.ps1 similarity index 100% rename from azure-pipelines/Get-ProcDump.ps1 rename to tools/Get-ProcDump.ps1 diff --git a/azure-pipelines/Get-TempToolsPath.ps1 b/tools/Get-TempToolsPath.ps1 similarity index 100% rename from azure-pipelines/Get-TempToolsPath.ps1 rename to tools/Get-TempToolsPath.ps1 diff --git a/tools/Install-NuGetCredProvider.ps1 b/tools/Install-NuGetCredProvider.ps1 index 2b904e33e..b776f56d9 100755 --- a/tools/Install-NuGetCredProvider.ps1 +++ b/tools/Install-NuGetCredProvider.ps1 @@ -21,7 +21,7 @@ Param ( $envVars = @{} -$toolsPath = & "$PSScriptRoot\..\azure-pipelines\Get-TempToolsPath.ps1" +$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" if ($IsMacOS -or $IsLinux) { $installerScript = "installcredprovider.sh" diff --git a/tools/MergeFrom-Template.ps1 b/tools/MergeFrom-Template.ps1 index 3f721c6ac..240a57097 100644 --- a/tools/MergeFrom-Template.ps1 +++ b/tools/MergeFrom-Template.ps1 @@ -36,7 +36,7 @@ Function Spawn-Tool($command, $commandArgs, $workingDirectory, $allowFailures) { } } -$remoteBranch = & $PSScriptRoot\..\azure-pipelines\Get-LibTemplateBasis.ps1 -ErrorIfNotRelated +$remoteBranch = & $PSScriptRoot\Get-LibTemplateBasis.ps1 -ErrorIfNotRelated if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } diff --git a/azure-pipelines/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 old mode 100755 new mode 100644 similarity index 100% rename from azure-pipelines/dotnet-test-cloud.ps1 rename to tools/dotnet-test-cloud.ps1 diff --git a/azure-pipelines/publish-CodeCov.ps1 b/tools/publish-CodeCov.ps1 similarity index 100% rename from azure-pipelines/publish-CodeCov.ps1 rename to tools/publish-CodeCov.ps1 diff --git a/azure-pipelines/test.runsettings b/tools/test.runsettings similarity index 100% rename from azure-pipelines/test.runsettings rename to tools/test.runsettings From bb60632aa68a206d37505999b65228f2de86b032 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2024 09:25:56 -0700 Subject: [PATCH 1183/1753] Remove unused nuget.config file --- azure-pipelines/justnugetorg.nuget.config | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 azure-pipelines/justnugetorg.nuget.config diff --git a/azure-pipelines/justnugetorg.nuget.config b/azure-pipelines/justnugetorg.nuget.config deleted file mode 100644 index 765346e53..000000000 --- a/azure-pipelines/justnugetorg.nuget.config +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - From abbd6b001e55897f9922dd90ddce51b8ad6bb818 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2024 09:33:58 -0700 Subject: [PATCH 1184/1753] Move artifacts and variables scripts to `tools` --- .github/actions/publish-artifacts/action.yaml | 2 +- .github/workflows/build.yml | 4 ++-- .../{variables/_pipelines.ps1 => define_variables.ps1} | 2 +- azure-pipelines/dotnet.yml | 4 ++-- azure-pipelines/install-dependencies.yml | 2 +- .../{artifacts/_pipelines.ps1 => publish_artifacts.ps1} | 2 +- {azure-pipelines => tools}/Get-SymbolFiles.ps1 | 0 tools/Install-DotNetSdk.ps1 | 2 +- {azure-pipelines => tools}/artifacts/Variables.ps1 | 0 {azure-pipelines => tools}/artifacts/_all.ps1 | 0 {azure-pipelines => tools}/artifacts/_stage_all.ps1 | 0 {azure-pipelines => tools}/artifacts/build_logs.ps1 | 0 {azure-pipelines => tools}/artifacts/coverageResults.ps1 | 0 {azure-pipelines => tools}/artifacts/deployables.ps1 | 0 {azure-pipelines => tools}/artifacts/projectAssetsJson.ps1 | 0 {azure-pipelines => tools}/artifacts/symbols.ps1 | 0 {azure-pipelines => tools}/artifacts/testResults.ps1 | 0 {azure-pipelines => tools}/artifacts/test_symbols.ps1 | 0 {azure-pipelines => tools}/variables/DotNetSdkVersion.ps1 | 0 {azure-pipelines => tools}/variables/_all.ps1 | 0 20 files changed, 9 insertions(+), 9 deletions(-) rename azure-pipelines/{variables/_pipelines.ps1 => define_variables.ps1} (95%) rename azure-pipelines/{artifacts/_pipelines.ps1 => publish_artifacts.ps1} (92%) rename {azure-pipelines => tools}/Get-SymbolFiles.ps1 (100%) rename {azure-pipelines => tools}/artifacts/Variables.ps1 (100%) rename {azure-pipelines => tools}/artifacts/_all.ps1 (100%) mode change 100755 => 100644 rename {azure-pipelines => tools}/artifacts/_stage_all.ps1 (100%) rename {azure-pipelines => tools}/artifacts/build_logs.ps1 (100%) rename {azure-pipelines => tools}/artifacts/coverageResults.ps1 (100%) rename {azure-pipelines => tools}/artifacts/deployables.ps1 (100%) rename {azure-pipelines => tools}/artifacts/projectAssetsJson.ps1 (100%) rename {azure-pipelines => tools}/artifacts/symbols.ps1 (100%) rename {azure-pipelines => tools}/artifacts/testResults.ps1 (100%) rename {azure-pipelines => tools}/artifacts/test_symbols.ps1 (100%) rename {azure-pipelines => tools}/variables/DotNetSdkVersion.ps1 (100%) rename {azure-pipelines => tools}/variables/_all.ps1 (100%) mode change 100755 => 100644 diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 94b742613..228b6404d 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -5,7 +5,7 @@ runs: using: composite steps: - name: 📥 Collect artifacts - run: azure-pipelines/artifacts/_stage_all.ps1 + run: tools/artifacts/_stage_all.ps1 shell: pwsh if: always() diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5e338ffa1..e6ffd3019 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,7 +43,7 @@ jobs: } shell: pwsh - name: ⚙️ Set pipeline variables based on source - run: azure-pipelines/variables/_pipelines.ps1 + run: azure-pipelines/define_variables.ps1 shell: pwsh - name: 🛠 build run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" @@ -58,7 +58,7 @@ jobs: run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures if: runner.os == 'Linux' - name: ⚙ Update pipeline variables based on build outputs - run: azure-pipelines/variables/_pipelines.ps1 + run: azure-pipelines/define_variables.ps1 shell: pwsh - name: 📢 Publish artifacts uses: ./.github/actions/publish-artifacts diff --git a/azure-pipelines/variables/_pipelines.ps1 b/azure-pipelines/define_variables.ps1 similarity index 95% rename from azure-pipelines/variables/_pipelines.ps1 rename to azure-pipelines/define_variables.ps1 index d40e5cf14..9cf362860 100644 --- a/azure-pipelines/variables/_pipelines.ps1 +++ b/azure-pipelines/define_variables.ps1 @@ -11,7 +11,7 @@ param ( ) -(& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { +(& "$PSScriptRoot\..\tools\variables\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. $keyCaps = $_.Key.ToUpper() if ((Test-Path "env:$keyCaps") -and (Get-Content "env:$keyCaps")) { diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 2ce80af35..f09422388 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -10,12 +10,12 @@ steps: displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) -- powershell: azure-pipelines/variables/_pipelines.ps1 +- powershell: azure-pipelines/define_variables.ps1 failOnStderr: true displayName: ⚙ Update pipeline variables based on build outputs condition: succeededOrFailed() -- powershell: azure-pipelines/artifacts/_pipelines.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose +- powershell: azure-pipelines/publish_artifacts.ps1 -ArtifactNameSuffix "-$(Agent.JobName)" -Verbose failOnStderr: true displayName: 📢 Publish artifacts condition: succeededOrFailed() diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 817826689..ce88b25ef 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -19,7 +19,7 @@ steps: } displayName: ⚙ Install prerequisites -- powershell: azure-pipelines/variables/_pipelines.ps1 +- powershell: azure-pipelines/define_variables.ps1 failOnStderr: true displayName: ⚙ Set pipeline variables based on source name: SetPipelineVariables diff --git a/azure-pipelines/artifacts/_pipelines.ps1 b/azure-pipelines/publish_artifacts.ps1 similarity index 92% rename from azure-pipelines/artifacts/_pipelines.ps1 rename to azure-pipelines/publish_artifacts.ps1 index 5f259a512..3f35cc6e1 100644 --- a/azure-pipelines/artifacts/_pipelines.ps1 +++ b/azure-pipelines/publish_artifacts.ps1 @@ -25,7 +25,7 @@ Function Test-ArtifactUploaded($artifactName) { Test-Path "env:$varName" } -& "$PSScriptRoot/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix -AvoidSymbolicLinks:$AvoidSymbolicLinks |% { +& "$PSScriptRoot/../tools/artifacts/_stage_all.ps1" -ArtifactNameSuffix $ArtifactNameSuffix -AvoidSymbolicLinks:$AvoidSymbolicLinks |% { # Set a variable which will out-live this script so that a subsequent attempt to collect and upload artifacts # will skip this one from a check in the _all.ps1 script. Set-PipelineVariable "ARTIFACTSTAGED_$($_.Name.ToUpper())" 'true' diff --git a/azure-pipelines/Get-SymbolFiles.ps1 b/tools/Get-SymbolFiles.ps1 similarity index 100% rename from azure-pipelines/Get-SymbolFiles.ps1 rename to tools/Get-SymbolFiles.ps1 diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index ffb522030..e08571bc7 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -36,7 +36,7 @@ if (!(Test-Path $DotNetInstallScriptRoot)) { New-Item -ItemType Directory -Path $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot # Look up actual required .NET SDK version from global.json -$sdkVersion = & "$PSScriptRoot/../azure-pipelines/variables/DotNetSdkVersion.ps1" +$sdkVersion = & "$PSScriptRoot/variables/DotNetSdkVersion.ps1" If ($IncludeX86 -and ($IsMacOS -or $IsLinux)) { Write-Verbose "Ignoring -IncludeX86 switch because 32-bit runtimes are only supported on Windows." diff --git a/azure-pipelines/artifacts/Variables.ps1 b/tools/artifacts/Variables.ps1 similarity index 100% rename from azure-pipelines/artifacts/Variables.ps1 rename to tools/artifacts/Variables.ps1 diff --git a/azure-pipelines/artifacts/_all.ps1 b/tools/artifacts/_all.ps1 old mode 100755 new mode 100644 similarity index 100% rename from azure-pipelines/artifacts/_all.ps1 rename to tools/artifacts/_all.ps1 diff --git a/azure-pipelines/artifacts/_stage_all.ps1 b/tools/artifacts/_stage_all.ps1 similarity index 100% rename from azure-pipelines/artifacts/_stage_all.ps1 rename to tools/artifacts/_stage_all.ps1 diff --git a/azure-pipelines/artifacts/build_logs.ps1 b/tools/artifacts/build_logs.ps1 similarity index 100% rename from azure-pipelines/artifacts/build_logs.ps1 rename to tools/artifacts/build_logs.ps1 diff --git a/azure-pipelines/artifacts/coverageResults.ps1 b/tools/artifacts/coverageResults.ps1 similarity index 100% rename from azure-pipelines/artifacts/coverageResults.ps1 rename to tools/artifacts/coverageResults.ps1 diff --git a/azure-pipelines/artifacts/deployables.ps1 b/tools/artifacts/deployables.ps1 similarity index 100% rename from azure-pipelines/artifacts/deployables.ps1 rename to tools/artifacts/deployables.ps1 diff --git a/azure-pipelines/artifacts/projectAssetsJson.ps1 b/tools/artifacts/projectAssetsJson.ps1 similarity index 100% rename from azure-pipelines/artifacts/projectAssetsJson.ps1 rename to tools/artifacts/projectAssetsJson.ps1 diff --git a/azure-pipelines/artifacts/symbols.ps1 b/tools/artifacts/symbols.ps1 similarity index 100% rename from azure-pipelines/artifacts/symbols.ps1 rename to tools/artifacts/symbols.ps1 diff --git a/azure-pipelines/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 similarity index 100% rename from azure-pipelines/artifacts/testResults.ps1 rename to tools/artifacts/testResults.ps1 diff --git a/azure-pipelines/artifacts/test_symbols.ps1 b/tools/artifacts/test_symbols.ps1 similarity index 100% rename from azure-pipelines/artifacts/test_symbols.ps1 rename to tools/artifacts/test_symbols.ps1 diff --git a/azure-pipelines/variables/DotNetSdkVersion.ps1 b/tools/variables/DotNetSdkVersion.ps1 similarity index 100% rename from azure-pipelines/variables/DotNetSdkVersion.ps1 rename to tools/variables/DotNetSdkVersion.ps1 diff --git a/azure-pipelines/variables/_all.ps1 b/tools/variables/_all.ps1 old mode 100755 new mode 100644 similarity index 100% rename from azure-pipelines/variables/_all.ps1 rename to tools/variables/_all.ps1 From fe7350fbebf12912487fa3397bd5c9bd95127859 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 24 Dec 2024 09:51:28 -0700 Subject: [PATCH 1185/1753] Move variable definition script --- .github/workflows/build.yml | 4 ++-- azure-pipelines/dotnet.yml | 2 +- azure-pipelines/install-dependencies.yml | 2 +- .../define_variables.ps1 => tools/variables/_define.ps1 | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) rename azure-pipelines/define_variables.ps1 => tools/variables/_define.ps1 (95%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e6ffd3019..5b4fc7beb 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,7 +43,7 @@ jobs: } shell: pwsh - name: ⚙️ Set pipeline variables based on source - run: azure-pipelines/define_variables.ps1 + run: tools/variables/_define.ps1 shell: pwsh - name: 🛠 build run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" @@ -58,7 +58,7 @@ jobs: run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures if: runner.os == 'Linux' - name: ⚙ Update pipeline variables based on build outputs - run: azure-pipelines/define_variables.ps1 + run: tools/variables/_define.ps1 shell: pwsh - name: 📢 Publish artifacts uses: ./.github/actions/publish-artifacts diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index f09422388..30bb4107d 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -10,7 +10,7 @@ steps: displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) -- powershell: azure-pipelines/define_variables.ps1 +- powershell: tools/variables/_define.ps1 failOnStderr: true displayName: ⚙ Update pipeline variables based on build outputs condition: succeededOrFailed() diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index ce88b25ef..5944bc9e2 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -19,7 +19,7 @@ steps: } displayName: ⚙ Install prerequisites -- powershell: azure-pipelines/define_variables.ps1 +- powershell: tools/variables/_define.ps1 failOnStderr: true displayName: ⚙ Set pipeline variables based on source name: SetPipelineVariables diff --git a/azure-pipelines/define_variables.ps1 b/tools/variables/_define.ps1 similarity index 95% rename from azure-pipelines/define_variables.ps1 rename to tools/variables/_define.ps1 index 9cf362860..d40e5cf14 100644 --- a/azure-pipelines/define_variables.ps1 +++ b/tools/variables/_define.ps1 @@ -11,7 +11,7 @@ param ( ) -(& "$PSScriptRoot\..\tools\variables\_all.ps1").GetEnumerator() |% { +(& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. $keyCaps = $_.Key.ToUpper() if ((Test-Path "env:$keyCaps") -and (Get-Content "env:$keyCaps")) { From bd10eaad9c1069e96c282383132765797b0344de Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 26 Dec 2024 15:16:12 -0700 Subject: [PATCH 1186/1753] Group dependabot update PRs --- .github/dependabot.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index b168ac6d1..a7a1782f5 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,6 +7,14 @@ updates: directory: / schedule: interval: weekly + groups: + nerdbank-gitversioning: + patterns: + - nbgv + - nerdbank.gitversioning + xunit: + patterns: + - 'xunit*' - package-ecosystem: dotnet-sdk directory: / schedule: From 05072c1f50722d8eaa99e1a17299c57d5f1a5365 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 26 Dec 2024 16:06:41 -0700 Subject: [PATCH 1187/1753] Switch from Dependabot to Renovate --- .github/dependabot.yml | 21 --------------------- .github/renovate.json | 24 ++++++++++++++++++++++++ CONTRIBUTING.md | 10 ++++++++++ 3 files changed, 34 insertions(+), 21 deletions(-) delete mode 100644 .github/dependabot.yml create mode 100644 .github/renovate.json diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index a7a1782f5..000000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,21 +0,0 @@ -# Please see the documentation for all configuration options: -# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file - -version: 2 -updates: -- package-ecosystem: nuget - directory: / - schedule: - interval: weekly - groups: - nerdbank-gitversioning: - patterns: - - nbgv - - nerdbank.gitversioning - xunit: - patterns: - - 'xunit*' -- package-ecosystem: dotnet-sdk - directory: / - schedule: - interval: monthly diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 000000000..a9fbeb23d --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:recommended" + ], + "semanticCommits": "disabled", + "prHourlyLimit": 5, + "labels": ["dependencies"], + "packageRules": [ + { + "matchPackageNames": ["nbgv", "nerdbank.gitversioning"], + "groupName": "nbgv and nerdbank.gitversioning updates" + }, + { + "matchPackageNames": ["xunit*"], + "groupName": "xunit" + }, + { + "matchDatasources": ["dotnet-version", "docker"], + "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], + "groupName": "Dockerfile and global.json updates" + } + ] +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52d83a882..77f5e0a3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,3 +72,13 @@ You can make changes and host the site locally to preview them by switching to t After making a change, you can rebuild the docs site while the localhost server is running by running `dotnet docfx` again from a separate terminal. The `.github/workflows/docs.yml` GitHub Actions workflow publishes the content of these docs to github.io if the workflow itself and [GitHub Pages is enabled for your repository](https://docs.github.com/en/pages/quickstart). + +## Updating dependencies + +This repo uses Renovate to keep dependencies current. +Configuration is in the `.github/renovate.json` file. +[Learn more about configuring Renovate](https://docs.renovatebot.com/configuration-options/). + +When changing the renovate.json file, follow [these validation steps](https://docs.renovatebot.com/config-validation/). + +If Renovate is not creating pull requests when you expect it to, check that the [Renovate GitHub App](https://github.com/apps/renovate) is configured for your account or repo. From 72caf2d7baaa56bb5638dfd71e60e42de014e12f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 26 Dec 2024 23:08:25 +0000 Subject: [PATCH 1188/1753] Update mcr.microsoft.com/dotnet/sdk Docker tag to v9.0.101 --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 42fd12a7a..3674e182a 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.100-noble +FROM mcr.microsoft.com/dotnet/sdk:9.0.101-noble # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From b353d1fb965bd85f73fee096eda88de20ae206dc Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 26 Dec 2024 23:08:30 +0000 Subject: [PATCH 1189/1753] Update dependency ubuntu to v24 --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ed0f5924a..766ebaf56 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -17,7 +17,7 @@ permissions: jobs: release: - runs-on: ubuntu-22.04 + runs-on: ubuntu-24.04 steps: - name: ⚙️ Initialization shell: pwsh From 147f846d07821941e3c40f8ba8747d2bd62fa76b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 26 Dec 2024 18:00:17 -0700 Subject: [PATCH 1190/1753] Drop renovate PR hourly limit back to default --- .github/renovate.json | 1 - README.md | 2 ++ 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/renovate.json b/.github/renovate.json index a9fbeb23d..498ca4202 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -4,7 +4,6 @@ "config:recommended" ], "semanticCommits": "disabled", - "prHourlyLimit": 5, "labels": ["dependencies"], "packageRules": [ { diff --git a/README.md b/README.md index 33ddbfab6..610e65049 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,8 @@ Further customize your repo by: 1. Verify the license is suitable for your goal as it appears in the LICENSE and stylecop.json files and the Directory.Build.props file's `PackageLicenseExpression` property. 1. Reset or replace the badges at the top of this file. +[Activate Renovate automated dependency updates](https://docs.renovatebot.com/getting-started/installing-onboarding/) for your repo. + ### Maintaining your repo based on this template The best way to keep your repo in sync with this template's evolving features and best practices is to periodically merge the template into your repo: From ddc4c2d1b86ea10672fb07e69279d94308dc76aa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 28 Dec 2024 08:39:07 -0700 Subject: [PATCH 1191/1753] Use JSON5 for renovate configuration --- .devcontainer/devcontainer.json | 3 ++- .github/.editorconfig | 2 ++ .github/renovate.json | 23 ----------------------- .github/renovate.json5 | 21 +++++++++++++++++++++ .vscode/extensions.json | 3 ++- 5 files changed, 27 insertions(+), 25 deletions(-) create mode 100644 .github/.editorconfig delete mode 100644 .github/renovate.json create mode 100644 .github/renovate.json5 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 01a087c7c..8f77d2887 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -16,6 +16,7 @@ "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", "ms-azuretools.vscode-docker", - "tintoy.msbuild-project-tools" + "tintoy.msbuild-project-tools", + "mrmlnc.vscode-json5" ] } diff --git a/.github/.editorconfig b/.github/.editorconfig new file mode 100644 index 000000000..2b7682efb --- /dev/null +++ b/.github/.editorconfig @@ -0,0 +1,2 @@ +[renovate.json*] +indent_style = tab diff --git a/.github/renovate.json b/.github/renovate.json deleted file mode 100644 index 498ca4202..000000000 --- a/.github/renovate.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": [ - "config:recommended" - ], - "semanticCommits": "disabled", - "labels": ["dependencies"], - "packageRules": [ - { - "matchPackageNames": ["nbgv", "nerdbank.gitversioning"], - "groupName": "nbgv and nerdbank.gitversioning updates" - }, - { - "matchPackageNames": ["xunit*"], - "groupName": "xunit" - }, - { - "matchDatasources": ["dotnet-version", "docker"], - "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], - "groupName": "Dockerfile and global.json updates" - } - ] -} diff --git a/.github/renovate.json5 b/.github/renovate.json5 new file mode 100644 index 000000000..76f2fb1fb --- /dev/null +++ b/.github/renovate.json5 @@ -0,0 +1,21 @@ +{ + $schema: "https://docs.renovatebot.com/renovate-schema.json", + extends: ["config:recommended"], + semanticCommits: "disabled", + labels: ["dependencies"], + packageRules: [ + { + matchPackageNames: ["nbgv", "nerdbank.gitversioning"], + groupName: "nbgv and nerdbank.gitversioning updates", + }, + { + matchPackageNames: ["xunit*"], + groupName: "xunit", + }, + { + matchDatasources: ["dotnet-version", "docker"], + matchDepNames: ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], + groupName: "Dockerfile and global.json updates", + }, + ], +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json index acaf02131..b289e5072 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -13,7 +13,8 @@ "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", "ms-azuretools.vscode-docker", - "tintoy.msbuild-project-tools" + "tintoy.msbuild-project-tools", + "mrmlnc.vscode-json5" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. "unwantedRecommendations": [] From 7e3ea7889b92003802fa9222740226ed2bb78f8c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 28 Dec 2024 08:40:04 -0700 Subject: [PATCH 1192/1753] Update devcontainer schema --- .devcontainer/devcontainer.json | 38 ++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 8f77d2887..3be99af42 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,22 +1,26 @@ { "name": "Dev space", "dockerFile": "Dockerfile", - "settings": { - "terminal.integrated.shell.linux": "/usr/bin/pwsh" + "customizations": { + "vscode": { + "settings": { + "terminal.integrated.shell.linux": "/usr/bin/pwsh" + }, + "extensions": [ + "ms-azure-devops.azure-pipelines", + "ms-dotnettools.csharp", + "k--kato.docomment", + "editorconfig.editorconfig", + "esbenp.prettier-vscode", + "pflannery.vscode-versionlens", + "davidanson.vscode-markdownlint", + "dotjoshjohnson.xml", + "ms-vscode-remote.remote-containers", + "ms-azuretools.vscode-docker", + "tintoy.msbuild-project-tools", + "mrmlnc.vscode-json5" + ] + } }, - "postCreateCommand": "./init.ps1 -InstallLocality machine", - "extensions": [ - "ms-azure-devops.azure-pipelines", - "ms-dotnettools.csharp", - "k--kato.docomment", - "editorconfig.editorconfig", - "esbenp.prettier-vscode", - "pflannery.vscode-versionlens", - "davidanson.vscode-markdownlint", - "dotjoshjohnson.xml", - "ms-vscode-remote.remote-containers", - "ms-azuretools.vscode-docker", - "tintoy.msbuild-project-tools", - "mrmlnc.vscode-json5" - ] + "postCreateCommand": "./init.ps1 -InstallLocality machine" } From 6ad0c9460ff72b51497e102fde1f3029a1442792 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 29 Dec 2024 18:48:38 -0700 Subject: [PATCH 1193/1753] Rename renovate config back to .json .json5 was fine, but VS Code doesn't have native support for it, and the popular JSON5 extension doesn't support JSON schema. --- .devcontainer/devcontainer.json | 3 +-- .github/renovate.json | 21 +++++++++++++++++++++ .github/renovate.json5 | 21 --------------------- .vscode/extensions.json | 3 +-- 4 files changed, 23 insertions(+), 25 deletions(-) create mode 100644 .github/renovate.json delete mode 100644 .github/renovate.json5 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 3be99af42..1a3a00866 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -17,8 +17,7 @@ "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", "ms-azuretools.vscode-docker", - "tintoy.msbuild-project-tools", - "mrmlnc.vscode-json5" + "tintoy.msbuild-project-tools" ] } }, diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 000000000..c140014f9 --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,21 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["config:recommended"], + "semanticCommits": "disabled", + "labels": ["dependencies"], + "packageRules": [ + { + "matchPackageNames": ["nbgv", "nerdbank.gitversioning"], + "groupName": "nbgv and nerdbank.gitversioning updates" + }, + { + "matchPackageNames": ["xunit*"], + "groupName": "xunit" + }, + { + "matchDatasources": ["dotnet-version", "docker"], + "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], + "groupName": "Dockerfile and global.json updates" + } + ] +} diff --git a/.github/renovate.json5 b/.github/renovate.json5 deleted file mode 100644 index 76f2fb1fb..000000000 --- a/.github/renovate.json5 +++ /dev/null @@ -1,21 +0,0 @@ -{ - $schema: "https://docs.renovatebot.com/renovate-schema.json", - extends: ["config:recommended"], - semanticCommits: "disabled", - labels: ["dependencies"], - packageRules: [ - { - matchPackageNames: ["nbgv", "nerdbank.gitversioning"], - groupName: "nbgv and nerdbank.gitversioning updates", - }, - { - matchPackageNames: ["xunit*"], - groupName: "xunit", - }, - { - matchDatasources: ["dotnet-version", "docker"], - matchDepNames: ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], - groupName: "Dockerfile and global.json updates", - }, - ], -} diff --git a/.vscode/extensions.json b/.vscode/extensions.json index b289e5072..acaf02131 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -13,8 +13,7 @@ "dotjoshjohnson.xml", "ms-vscode-remote.remote-containers", "ms-azuretools.vscode-docker", - "tintoy.msbuild-project-tools", - "mrmlnc.vscode-json5" + "tintoy.msbuild-project-tools" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. "unwantedRecommendations": [] From fadd4eb10683551901b3b04899c3dd74b2b7ec1f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 31 Dec 2024 16:16:17 -0700 Subject: [PATCH 1194/1753] Fix test logs collection They are intended to be collected as part of the `testResults` artifact. --- .github/actions/publish-artifacts/action.yaml | 7 ------- tools/artifacts/testResults.ps1 | 3 ++- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 228b6404d..2a75c4d22 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -32,13 +32,6 @@ runs: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - - name: 📢 Upload test_logs - if: always() - uses: actions/upload-artifact@v4 - with: - name: test_logs-${{ runner.os }} - path: ${{ runner.temp }}/_artifacts/test_logs - continue-on-error: true - name: 📢 Upload testResults if: always() uses: actions/upload-artifact@v4 diff --git a/tools/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 index 301a43763..071469578 100644 --- a/tools/artifacts/testResults.ps1 +++ b/tools/artifacts/testResults.ps1 @@ -7,7 +7,8 @@ $result = @{} $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) -$testlogsPath = "$env:BUILD_ARTIFACTSTAGINGDIRECTORY\test_logs" +$artifactStaging = & "$PSScriptRoot\..\Get-ArtifactsStagingDirectory.ps1" +$testlogsPath = Join-Path $artifactStaging "test_logs" if (Test-Path $testlogsPath) { $result[$testlogsPath] = Get-ChildItem "$testlogsPath\*"; } From 16f72e358da97fb5058f32eef4002a1dc33a6e3d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 1 Jan 2025 10:30:13 -0700 Subject: [PATCH 1195/1753] Take care to use proper slashes per OS for testing --- tools/Get-ArtifactsStagingDirectory.ps1 | 2 +- tools/artifacts/testResults.ps1 | 2 +- tools/dotnet-test-cloud.ps1 | 7 +++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/tools/Get-ArtifactsStagingDirectory.ps1 b/tools/Get-ArtifactsStagingDirectory.ps1 index 391e5713a..18967f4c1 100644 --- a/tools/Get-ArtifactsStagingDirectory.ps1 +++ b/tools/Get-ArtifactsStagingDirectory.ps1 @@ -4,7 +4,7 @@ Param( if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { $ArtifactStagingFolder = $env:BUILD_ARTIFACTSTAGINGDIRECTORY } elseif ($env:RUNNER_TEMP) { - $ArtifactStagingFolder = "$env:RUNNER_TEMP\_artifacts" + $ArtifactStagingFolder = Join-Path $env:RUNNER_TEMP _artifacts } else { $ArtifactStagingFolder = [System.IO.Path]::GetFullPath("$PSScriptRoot/../obj/_artifacts") if ($CleanIfLocal -and (Test-Path $ArtifactStagingFolder)) { diff --git a/tools/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 index 071469578..519a63c0c 100644 --- a/tools/artifacts/testResults.ps1 +++ b/tools/artifacts/testResults.ps1 @@ -10,7 +10,7 @@ $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory $artifactStaging = & "$PSScriptRoot\..\Get-ArtifactsStagingDirectory.ps1" $testlogsPath = Join-Path $artifactStaging "test_logs" if (Test-Path $testlogsPath) { - $result[$testlogsPath] = Get-ChildItem "$testlogsPath\*"; + $result[$testlogsPath] = Get-ChildItem $testlogsPath -Recurse; } $result diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 33ff3d7c0..10cd4311a 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -44,6 +44,9 @@ if ($x86) { } } +$testBinLog = Join-Path $ArtifactStagingFolder (Join-Path build_logs test.binlog) +$testDiagLog = Join-Path $ArtifactStagingFolder (Join-Path test_logs diag.log) + & $dotnet test $RepoRoot ` --no-build ` -c $Configuration ` @@ -52,8 +55,8 @@ if ($x86) { --settings "$PSScriptRoot/test.runsettings" ` --blame-hang-timeout 60s ` --blame-crash ` - -bl:"$ArtifactStagingFolder/build_logs/test.binlog" ` - --diag "$ArtifactStagingFolder/test_logs/diag.log;TraceLevel=info" ` + -bl:"$testBinLog" ` + --diag "$testDiagLog;TraceLevel=info" ` --logger trx ` $unknownCounter = 0 From 656c5ff5cb3897ca2151842a1e050598c422b140 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 5 Jan 2025 13:15:50 -0700 Subject: [PATCH 1196/1753] Match test assemblies that are built as exe's Fixes #332 --- tools/dotnet-test-cloud.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 10cd4311a..02891d975 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -68,7 +68,7 @@ Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { $runTitle = $null if ($x.TestRun.TestDefinitions -and $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')) { $storage = $x.TestRun.TestDefinitions.GetElementsByTagName('UnitTest')[0].storage -replace '\\','/' - if ($storage -match '/(?net[^/]+)/(?:(?[^/]+)/)?(?[^/]+)\.dll$') { + if ($storage -match '/(?net[^/]+)/(?:(?[^/]+)/)?(?[^/]+)\.(dll|exe)$') { if ($matches.rid) { $runTitle = "$($matches.lib) ($($matches.tfm), $($matches.rid), $Agent)" } else { From 5f9a3444985dc683c096209870eb7bff36f26e67 Mon Sep 17 00:00:00 2001 From: Richard Stanton Date: Fri, 7 Jun 2024 19:46:00 -0700 Subject: [PATCH 1197/1753] Ensure Expand-Template uses UTF-8 when replacing placeholders. --- Expand-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 9f9db676c..ae1623131 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -40,7 +40,7 @@ function Replace-Placeholders { $Path = Resolve-Path $Path Write-Host "Replacing tokens in `"$Path`"" - $content = Get-Content -LiteralPath $Path | Out-String + $content = Get-Content -Encoding UTF8 -LiteralPath $Path | Out-String $Replacements.GetEnumerator() |% { $modifiedContent = $content -replace $_.Key,$_.Value if ($modifiedContent -eq $content) { From b3fc0f3f597580e67990716ef8aad9cb47d74b9d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 6 Jan 2025 19:34:39 -0700 Subject: [PATCH 1198/1753] Simplify certain ps1 script paths --- tools/artifacts/_stage_all.ps1 | 2 +- tools/artifacts/build_logs.ps1 | 2 +- tools/artifacts/testResults.ps1 | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/artifacts/_stage_all.ps1 b/tools/artifacts/_stage_all.ps1 index 08e9844c3..bf961ce57 100644 --- a/tools/artifacts/_stage_all.ps1 +++ b/tools/artifacts/_stage_all.ps1 @@ -11,7 +11,7 @@ param ( [switch]$AvoidSymbolicLinks ) -$ArtifactStagingFolder = & "$PSScriptRoot/../../tools/Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal +$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" -CleanIfLocal function Create-SymbolicLink { param ( diff --git a/tools/artifacts/build_logs.ps1 b/tools/artifacts/build_logs.ps1 index 10c5478b3..f05358e03 100644 --- a/tools/artifacts/build_logs.ps1 +++ b/tools/artifacts/build_logs.ps1 @@ -1,4 +1,4 @@ -$ArtifactStagingFolder = & "$PSScriptRoot/../../tools/Get-ArtifactsStagingDirectory.ps1" +$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" if (!(Test-Path $ArtifactStagingFolder/build_logs)) { return } diff --git a/tools/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 index 519a63c0c..5310fb52a 100644 --- a/tools/artifacts/testResults.ps1 +++ b/tools/artifacts/testResults.ps1 @@ -7,7 +7,7 @@ $result = @{} $testRoot = Resolve-Path "$PSScriptRoot\..\..\test" $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) -$artifactStaging = & "$PSScriptRoot\..\Get-ArtifactsStagingDirectory.ps1" +$artifactStaging = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" $testlogsPath = Join-Path $artifactStaging "test_logs" if (Test-Path $testlogsPath) { $result[$testlogsPath] = Get-ChildItem $testlogsPath -Recurse; From 048010c3a101eb0b26965759e55b188dd576c37f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 10 Jan 2025 07:14:33 -0700 Subject: [PATCH 1199/1753] Update xunit (#336) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 63808e7c0..c3f32204d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,8 +10,8 @@ - - + + From 6ac5aae85808499ecfe561ffeac39a50aaa21b84 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Fri, 10 Jan 2025 12:19:51 -0800 Subject: [PATCH 1200/1753] Fix InsertJsonValues script (#337) * Fix InsertJsonValues script I believe that `LibraryName` here is a typo considering that it is in a loop and we couldn't just replace it with a fixed string (even one that is specific to the repo) * Fix vsman file URL formatting * Update Expand-Template.ps1 --- Expand-Template.ps1 | 4 ---- tools/variables/InsertJsonValues.ps1 | 2 +- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 70191c724..0bc5f440e 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -172,10 +172,6 @@ try { 'LibraryNoDots' = $LibraryName.Replace('.',''); } - Replace-Placeholders -Path "tools/variables/InsertJsonValues.ps1" -Replacements @{ - 'LibraryName' = $LibraryName; - } - Replace-Placeholders -Path "tools/variables/SymbolsFeatureName.ps1" -Replacements @{ 'LibraryName' = $LibraryName; } diff --git a/tools/variables/InsertJsonValues.ps1 b/tools/variables/InsertJsonValues.ps1 index 807ca1cbb..7aa8d30c1 100644 --- a/tools/variables/InsertJsonValues.ps1 +++ b/tools/variables/InsertJsonValues.ps1 @@ -11,7 +11,7 @@ if (Test-Path $BasePath) { Get-ChildItem $BasePath *.vsman -Recurse -File |% { $version = (Get-Content $_.FullName | ConvertFrom-Json).info.buildVersion $fn = $_.Name - $vsmanFiles += "LibraryName.vsman{$version}=https://vsdrop.corp.microsoft.com/file/v1/$vstsDropNames;$fn" + $vsmanFiles += "$fn{$version}=https://vsdrop.corp.microsoft.com/file/v1/$vstsDropNames;$fn" } [string]::join(',',$vsmanFiles) From b47196d0fd54776d22fea52f03d75086cc071ffe Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 10 Jan 2025 18:43:52 -0700 Subject: [PATCH 1201/1753] Update nbgv and nerdbank.gitversioning updates to 3.7.115 (#338) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 3f79bdec4..3a7b9b698 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -17,7 +17,7 @@ "rollForward": false }, "nbgv": { - "version": "3.7.112", + "version": "3.7.115", "commands": [ "nbgv" ], diff --git a/Directory.Packages.props b/Directory.Packages.props index c3f32204d..8811c1ea8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -20,7 +20,7 @@ - + From 71eb73a8aecd164e429a93cb8950f809ade97d95 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jan 2025 14:05:31 -0700 Subject: [PATCH 1202/1753] Turn off InternalsVisibleTo for the analyzer assemblies and fix up most of the issues --- .../AssemblyInfo.cs | 3 - .../CSharpUtils.cs | 38 ++-- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 2 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 2 +- .../CSharpVSTHRD011UseAsyncLazyAnalyzer.cs | 2 +- .../CSharpVSTHRD012SpecifyJtfWhereAllowed.cs | 2 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 2 +- ...8AssertThreadRequirementUnconditionally.cs | 2 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 2 +- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 2 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 2 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 2 +- .../VSTHRD002UseJtfRunAnalyzer.cs | 2 +- .../VSTHRD010MainThreadUsageAnalyzer.cs | 4 +- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 8 +- .../VSTHRD100AsyncVoidMethodCodeFix.cs | 2 +- .../AssemblyInfo.cs | 3 - .../VisualBasicUtils.cs | 10 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 2 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 2 +- ...isualBasicVSTHRD011UseAsyncLazyAnalyzer.cs | 2 +- ...ualBasicVSTHRD012SpecifyJtfWhereAllowed.cs | 2 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 2 +- ...8AssertThreadRequirementUnconditionally.cs | 2 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 2 +- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 2 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 2 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 2 +- ...RD001UseSwitchToMainThreadAsyncAnalyzer.cs | 2 +- ...004AwaitSwitchToMainThreadAsyncAnalyzer.cs | 2 +- .../AbstractVSTHRD011UseAsyncLazyAnalyzer.cs | 6 +- ...AbstractVSTHRD012SpecifyJtfWhereAllowed.cs | 2 +- ...oidImplicitTaskSchedulerCurrentAnalyzer.cs | 2 +- ...8AssertThreadRequirementUnconditionally.cs | 2 +- ...HRD109AvoidAssertInAsyncMethodsAnalyzer.cs | 2 +- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 2 +- ...ImplementSystemIAsyncDisposableAnalyzer.cs | 2 +- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 2 +- .../AssemblyInfo.cs | 5 - .../CommonInterest.cs | 76 ++++---- .../LanguageUtils.cs | 12 +- .../Namespaces.cs | 24 +-- .../Types.cs | 172 +++++++++--------- .../Utils.cs | 84 ++++----- ...ableTaskContextCtorWithNullArgsAnalyzer.cs | 8 +- ...THRD200UseAsyncNamingConventionAnalyzer.cs | 8 +- 46 files changed, 256 insertions(+), 267 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/AssemblyInfo.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/AssemblyInfo.cs index 44c9c5b2d..61f8ea2f6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/AssemblyInfo.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/AssemblyInfo.cs @@ -10,6 +10,3 @@ [assembly: ComVisible(false)] [assembly: NeutralResourcesLanguage("en-US")] - -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.CodeFixes, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs index 9db145608..47292ea5b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpUtils.cs @@ -13,7 +13,7 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; -internal sealed class CSharpUtils : LanguageUtils +public sealed class CSharpUtils : LanguageUtils { public static readonly CSharpUtils Instance = new CSharpUtils(); @@ -21,7 +21,7 @@ private CSharpUtils() { } - internal static ExpressionSyntax IsolateMethodName(InvocationExpressionSyntax invocation) + public static ExpressionSyntax IsolateMethodName(InvocationExpressionSyntax invocation) { if (invocation is null) { @@ -40,7 +40,7 @@ internal static ExpressionSyntax IsolateMethodName(InvocationExpressionSyntax in /// /// The syntax node to begin the search from. /// The containing function, and metadata for it. - internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode? syntaxNode) + public static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode? syntaxNode) { while (syntaxNode is object) { @@ -114,7 +114,7 @@ internal static ContainingFunctionData GetContainingFunction(CSharpSyntaxNode? s return default(ContainingFunctionData); } - internal static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode) + public static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode) { SyntaxNode? parent = null; while ((parent = syntaxNode.Parent) is object) @@ -130,7 +130,7 @@ internal static bool IsOnLeftHandOfAssignment(SyntaxNode syntaxNode) return false; } - internal static IEnumerable FindAssignedValuesWithin(SyntaxNode container, SemanticModel semanticModel, ISymbol variable, CancellationToken cancellationToken) + public static IEnumerable FindAssignedValuesWithin(SyntaxNode container, SemanticModel semanticModel, ISymbol variable, CancellationToken cancellationToken) { if (semanticModel is null) { @@ -176,7 +176,7 @@ internal static IEnumerable FindAssignedValuesWithin(SyntaxNod } } - internal static MemberAccessExpressionSyntax MemberAccess(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) + public static MemberAccessExpressionSyntax MemberAccess(IReadOnlyList qualifiers, SimpleNameSyntax simpleName) { if (qualifiers is null) { @@ -206,7 +206,7 @@ internal static MemberAccessExpressionSyntax MemberAccess(IReadOnlyList /// /// Determines whether an expression appears inside a C# "nameof" pseudo-method. /// - internal static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) + public static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) { InvocationExpressionSyntax? invocation = syntaxNode?.FirstAncestorOrSelf(); return invocation is object @@ -214,7 +214,7 @@ internal static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) && invocation.ArgumentList.Arguments.Count == 1; } - internal override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) + public override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) { foreach (SyntaxReference? syntaxReference in symbol.DeclaringSyntaxReferences) { @@ -238,7 +238,7 @@ internal static bool IsWithinNameOf([NotNullWhen(true)] SyntaxNode? syntaxNode) return symbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax(cancellationToken)?.GetLocation(); } - internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) + public override SyntaxNode IsolateMethodName(IInvocationOperation invocation) { if (invocation.Syntax is InvocationExpressionSyntax invocationExpression) { @@ -248,7 +248,7 @@ internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) return invocation.Syntax; } - internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) + public override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) { if (objectCreation.Syntax is ObjectCreationExpressionSyntax { Type: { } type }) { @@ -258,7 +258,7 @@ internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCr return objectCreation.Syntax; } - internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) + public override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) { SyntaxReference? syntaxReference = methodSymbol.DeclaringSyntaxReferences.FirstOrDefault(); if (syntaxReference is null) @@ -281,7 +281,7 @@ internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSy return returnType is not null && returnType.IsKind(SyntaxKind.NullableType); } - internal override bool IsAsyncMethod(SyntaxNode syntaxNode) + public override bool IsAsyncMethod(SyntaxNode syntaxNode) { SyntaxTokenList? modifiers = syntaxNode switch { @@ -294,9 +294,9 @@ internal override bool IsAsyncMethod(SyntaxNode syntaxNode) return modifiers?.Any(SyntaxKind.AsyncKeyword) is true; } - internal readonly struct ContainingFunctionData + public readonly struct ContainingFunctionData { - internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax? parameterList, CSharpSyntaxNode? blockOrExpression, Func bodyReplacement) + public ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, ParameterListSyntax? parameterList, CSharpSyntaxNode? blockOrExpression, Func bodyReplacement) { this.Function = function; this.IsAsync = isAsync; @@ -305,14 +305,14 @@ internal ContainingFunctionData(CSharpSyntaxNode function, bool isAsync, Paramet this.BodyReplacement = bodyReplacement; } - internal CSharpSyntaxNode Function { get; } + public CSharpSyntaxNode Function { get; } - internal bool IsAsync { get; } + public bool IsAsync { get; } - internal ParameterListSyntax? ParameterList { get; } + public ParameterListSyntax? ParameterList { get; } - internal CSharpSyntaxNode? BlockOrExpression { get; } + public CSharpSyntaxNode? BlockOrExpression { get; } - internal Func BodyReplacement { get; } + public Func BodyReplacement { get; } } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 347387f22..7ad45e4ab 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 475722005..3dbd93ed1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs index fbbf1136d..38a4361ce 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD011UseAsyncLazyAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs index 0686763b9..9dd4d6666 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD012SpecifyJtfWhereAllowed.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 4d4c320b5..cde8a1b12 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs index f9cd6b899..26c43d0ef 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 261f7d404..d52c02608 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index 4f64498fd..7c71225a7 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD110ObserveResultOfAsyncCallsAnalyzer : AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index 470eaec53..021d111c3 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -9,6 +9,6 @@ namespace Microsoft.VisualStudio.Threading.Analyzers [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs index d03c6e926..4e74ad8ac 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/CSharpVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.CSharp)] public sealed class CSharpVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer { - private protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; + protected override LanguageUtils LanguageUtils => CSharpUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs index 6a7cc8661..5a0727902 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD002UseJtfRunAnalyzer.cs @@ -34,7 +34,7 @@ public class VSTHRD002UseJtfRunAnalyzer : DiagnosticAnalyzer { public const string Id = "VSTHRD002"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD002_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD002_MessageFormat), Strings.ResourceManager, typeof(Strings)), diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs index 9c25bfa46..26b9a5af0 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD010MainThreadUsageAnalyzer.cs @@ -57,7 +57,7 @@ public class VSTHRD010MainThreadUsageAnalyzer : DiagnosticAnalyzer /// /// The descriptor to use for diagnostics reported in synchronous methods. /// - internal static readonly DiagnosticDescriptor DescriptorSync = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor DescriptorSync = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD010_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD010_MessageFormat_Sync), Strings.ResourceManager, typeof(Strings)), @@ -70,7 +70,7 @@ public class VSTHRD010MainThreadUsageAnalyzer : DiagnosticAnalyzer /// /// The descriptor to use for diagnostics reported in async methods. /// - internal static readonly DiagnosticDescriptor DescriptorAsync = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor DescriptorAsync = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD010_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD010_MessageFormat_Async), Strings.ResourceManager, typeof(Strings)), diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index 05cef3c9f..46cde9c5a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -35,11 +35,11 @@ public class VSTHRD103UseAsyncOptionAnalyzer : DiagnosticAnalyzer { public const string Id = "VSTHRD103"; - internal const string AsyncMethodKeyName = "AsyncMethodName"; + public const string AsyncMethodKeyName = "AsyncMethodName"; - internal const string ExtensionMethodNamespaceKeyName = "ExtensionMethodNamespace"; + public const string ExtensionMethodNamespaceKeyName = "ExtensionMethodNamespace"; - internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD103_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD103_MessageFormat), Strings.ResourceManager, typeof(Strings)), @@ -48,7 +48,7 @@ public class VSTHRD103UseAsyncOptionAnalyzer : DiagnosticAnalyzer defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: true); - internal static readonly DiagnosticDescriptor DescriptorNoAlternativeMethod = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor DescriptorNoAlternativeMethod = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD103_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD103_MessageFormat_UseAwaitInstead), Strings.ResourceManager, typeof(Strings)), diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs index 06ccef274..5bcc32779 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD100AsyncVoidMethodCodeFix.cs @@ -41,7 +41,7 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; public class VSTHRD100AsyncVoidMethodCodeFix : CodeFixProvider { private static readonly ImmutableArray ReusableFixableDiagnosticIds = ImmutableArray.Create( - VSTHRD100AsyncVoidMethodAnalyzer.Descriptor.Id); + VSTHRD100AsyncVoidMethodAnalyzer.Id); /// public override ImmutableArray FixableDiagnosticIds => ReusableFixableDiagnosticIds; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/AssemblyInfo.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/AssemblyInfo.cs index 44c9c5b2d..61f8ea2f6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/AssemblyInfo.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/AssemblyInfo.cs @@ -10,6 +10,3 @@ [assembly: ComVisible(false)] [assembly: NeutralResourcesLanguage("en-US")] - -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.CodeFixes, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs index dc2c2a787..a8e74de1c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicUtils.cs @@ -18,7 +18,7 @@ private VisualBasicUtils() { } - internal override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) + public override Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken) { foreach (SyntaxReference? syntaxReference in symbol.DeclaringSyntaxReferences) { @@ -79,21 +79,21 @@ private VisualBasicUtils() return symbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax(cancellationToken)?.GetLocation(); } - internal override SyntaxNode IsolateMethodName(IInvocationOperation invocation) + public override SyntaxNode IsolateMethodName(IInvocationOperation invocation) { return invocation.Syntax; } - internal override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) + public override SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation) { return objectCreation.Syntax; } - internal override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) + public override bool MethodReturnsNullableReferenceType(IMethodSymbol methodSymbol) { // VB.NET doesn't support nullable reference types return false; } - internal override bool IsAsyncMethod(SyntaxNode syntaxNode) => syntaxNode is MethodBlockSyntax methodDeclaration && methodDeclaration.BlockStatement.Modifiers.Any(SyntaxKind.AsyncKeyword); + public override bool IsAsyncMethod(SyntaxNode syntaxNode) => syntaxNode is MethodBlockSyntax methodDeclaration && methodDeclaration.BlockStatement.Modifiers.Any(SyntaxKind.AsyncKeyword); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 9a2515b91..ce469c865 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index fa1606292..d55510ee6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs index 4116a98ad..e6fe9f018 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD011UseAsyncLazyAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD011UseAsyncLazyAnalyzer : AbstractVSTHRD011UseAsyncLazyAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs index 234eadb7b..39c3eb376 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD012SpecifyJtfWhereAllowed.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD012SpecifyJtfWhereAllowed : AbstractVSTHRD012SpecifyJtfWhereAllowed { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 957efce3b..a1414a949 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer : AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs index 1e3d5b11b..e25894b9c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD108AssertThreadRequirementUnconditionally : AbstractVSTHRD108AssertThreadRequirementUnconditionally { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 8f5b0fcda..f414b4107 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index 3b6110b0f..2f1657c99 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD110ObserveResultOfAsyncCallsAnalyzer : AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index 5eb55ec7c..9ce654001 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs index 2f5f3a395..5433c7d79 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -9,5 +9,5 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; [DiagnosticAnalyzer(LanguageNames.VisualBasic)] public sealed class VisualBasicVSTHRD114AvoidReturningNullTaskAnalyzer : AbstractVSTHRD114AvoidReturningNullTaskAnalyzer { - private protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; + protected override LanguageUtils LanguageUtils => VisualBasicUtils.Instance; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs index 5545967f6..cd428fe85 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs @@ -23,7 +23,7 @@ public abstract class AbstractVSTHRD001UseSwitchToMainThreadAsyncAnalyzer : Diag public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } public override void Initialize(AnalysisContext context) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs index 177770600..b9a34c939 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer.cs @@ -27,7 +27,7 @@ public abstract class AbstractVSTHRD004AwaitSwitchToMainThreadAsyncAnalyzer : Di /// public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } public override void Initialize(AnalysisContext context) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs index 7147399f3..705578acd 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD011UseAsyncLazyAnalyzer.cs @@ -14,7 +14,7 @@ public abstract class AbstractVSTHRD011UseAsyncLazyAnalyzer : DiagnosticAnalyzer { public const string Id = "VSTHRD011"; - internal static readonly DiagnosticDescriptor LazyOfTaskDescriptor = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor LazyOfTaskDescriptor = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD011_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD011_MessageFormat), Strings.ResourceManager, typeof(Strings)), @@ -23,7 +23,7 @@ public abstract class AbstractVSTHRD011UseAsyncLazyAnalyzer : DiagnosticAnalyzer defaultSeverity: DiagnosticSeverity.Error, isEnabledByDefault: true); - internal static readonly DiagnosticDescriptor SyncBlockInValueFactoryDescriptor = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor SyncBlockInValueFactoryDescriptor = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD011_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD011b_MessageFormat), Strings.ResourceManager, typeof(Strings)), @@ -38,7 +38,7 @@ public override ImmutableArray SupportedDiagnostics get { return ImmutableArray.Create(LazyOfTaskDescriptor, SyncBlockInValueFactoryDescriptor); } } - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } /// public override void Initialize(AnalysisContext context) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs index 969e32176..06c8071d4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD012SpecifyJtfWhereAllowed.cs @@ -25,7 +25,7 @@ public abstract class AbstractVSTHRD012SpecifyJtfWhereAllowed : DiagnosticAnalyz public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } public override void Initialize(AnalysisContext context) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs index 5e3b2a94f..df3e9845f 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer.cs @@ -39,7 +39,7 @@ public abstract class AbstractVSTHRD105AvoidImplicitTaskSchedulerCurrentAnalyzer public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } public override void Initialize(AnalysisContext context) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs index 45b473d76..676bd4207 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD108AssertThreadRequirementUnconditionally.cs @@ -47,7 +47,7 @@ public abstract class AbstractVSTHRD108AssertThreadRequirementUnconditionally : /// public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } /// public override void Initialize(AnalysisContext context) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs index 05c6263fb..f40739d99 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer.cs @@ -37,7 +37,7 @@ public abstract class AbstractVSTHRD109AvoidAssertInAsyncMethodsAnalyzer : Diagn /// public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } /// public override void Initialize(AnalysisContext context) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index f4c22dd59..864c3f5e4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -28,7 +28,7 @@ public abstract class AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer : Diagn /// public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } /// public override void Initialize(AnalysisContext context) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs index 65d5904a1..56a9e1fc8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer.cs @@ -27,7 +27,7 @@ public abstract class AbstractVSTHRD112ImplementSystemIAsyncDisposableAnalyzer : /// public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } public override void Initialize(AnalysisContext context) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs index 0affd5c59..dcd2e9425 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -29,7 +29,7 @@ public abstract class AbstractVSTHRD114AvoidReturningNullTaskAnalyzer : Diagnost /// public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Descriptor); - private protected abstract LanguageUtils LanguageUtils { get; } + protected abstract LanguageUtils LanguageUtils { get; } /// public override void Initialize(AnalysisContext context) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AssemblyInfo.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AssemblyInfo.cs index 82101278f..61f8ea2f6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AssemblyInfo.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AssemblyInfo.cs @@ -10,8 +10,3 @@ [assembly: ComVisible(false)] [assembly: NeutralResourcesLanguage("en-US")] - -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.CodeFixes, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.CSharp, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.VisualBasic, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index 436bed69e..42300094c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -19,20 +19,20 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; -internal static class CommonInterest +public static class CommonInterest { - internal static readonly Regex FileNamePatternForLegacyThreadSwitchingMembers = new Regex(@"^vs-threading\.LegacyThreadSwitchingMembers(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly Regex FileNamePatternForMembersRequiringMainThread = new Regex(@"^vs-threading\.MembersRequiringMainThread(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly Regex FileNamePatternForMethodsThatAssertMainThread = new Regex(@"^vs-threading\.MainThreadAssertingMethods(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly Regex FileNamePatternForMethodsThatSwitchToMainThread = new Regex(@"^vs-threading\.MainThreadSwitchingMethods(\..*)?.txt$", FileNamePatternRegexOptions); + public static readonly Regex FileNamePatternForLegacyThreadSwitchingMembers = new Regex(@"^vs-threading\.LegacyThreadSwitchingMembers(\..*)?.txt$", FileNamePatternRegexOptions); + public static readonly Regex FileNamePatternForMembersRequiringMainThread = new Regex(@"^vs-threading\.MembersRequiringMainThread(\..*)?.txt$", FileNamePatternRegexOptions); + public static readonly Regex FileNamePatternForMethodsThatAssertMainThread = new Regex(@"^vs-threading\.MainThreadAssertingMethods(\..*)?.txt$", FileNamePatternRegexOptions); + public static readonly Regex FileNamePatternForMethodsThatSwitchToMainThread = new Regex(@"^vs-threading\.MainThreadSwitchingMethods(\..*)?.txt$", FileNamePatternRegexOptions); - internal static readonly IEnumerable JTFSyncBlockers = new[] + public static readonly IEnumerable JTFSyncBlockers = new[] { new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTaskFactory.TypeName), Types.JoinableTaskFactory.Run), Types.JoinableTaskFactory.RunAsync), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTask.TypeName), Types.JoinableTask.Join), Types.JoinableTask.JoinAsync), }; - internal static readonly IEnumerable ProblematicSyncBlockingMethods = new[] + public static readonly IEnumerable ProblematicSyncBlockingMethods = new[] { new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Wait)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAll)), null), @@ -43,24 +43,24 @@ internal static class CommonInterest new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(ConfiguredValueTaskAwaitable.ConfiguredValueTaskAwaiter)), nameof(ConfiguredValueTaskAwaitable.ConfiguredValueTaskAwaiter.GetResult)), null), }; - internal static readonly IEnumerable SyncBlockingMethods = JTFSyncBlockers.Concat(ProblematicSyncBlockingMethods).Concat(new[] + public static readonly IEnumerable SyncBlockingMethods = JTFSyncBlockers.Concat(ProblematicSyncBlockingMethods).Concat(new[] { new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "Wait"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "GetResult"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), }); - internal static readonly IReadOnlyList SyncBlockingProperties = new[] + public static readonly IReadOnlyList SyncBlockingProperties = new[] { new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Result)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(ValueTask)), nameof(ValueTask.Result)), null), }; - internal static readonly IEnumerable ThreadAffinityTestingMethods = new[] + public static readonly IEnumerable ThreadAffinityTestingMethods = new[] { new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShell, Types.ThreadHelper.TypeName), Types.ThreadHelper.CheckAccess), }; - internal static readonly ImmutableArray TaskConfigureAwait = ImmutableArray.Create( + public static readonly ImmutableArray TaskConfigureAwait = ImmutableArray.Create( new QualifiedMember(new QualifiedType(Types.Task.Namespace, Types.Task.TypeName), nameof(Task.ConfigureAwait)), new QualifiedMember(new QualifiedType(Types.AwaitExtensions.Namespace, Types.AwaitExtensions.TypeName), Types.AwaitExtensions.ConfigureAwaitRunInline)); @@ -79,7 +79,7 @@ internal static class CommonInterest /// private static readonly char[] QualifiedIdentifierSeparators = new[] { '.' }; - internal static IEnumerable ReadMethods(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + public static IEnumerable ReadMethods(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) { foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) { @@ -87,7 +87,7 @@ internal static IEnumerable ReadMethods(AnalyzerOptions analyze } } - internal static IEnumerable ReadTypesAndMembers(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + public static IEnumerable ReadTypesAndMembers(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) { foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) { @@ -116,7 +116,7 @@ internal static IEnumerable ReadTypesAndMembers(AnalyzerOptions a } } - internal static IEnumerable ReadAdditionalFiles(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) + public static IEnumerable ReadAdditionalFiles(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) { if (analyzerOptions is null) { @@ -136,7 +136,7 @@ where fileNamePattern.IsMatch(fileName) return docs.SelectMany(ReadLinesFromAdditionalFile); } - internal static bool Contains(this ImmutableArray methods, ISymbol symbol) + public static bool Contains(this ImmutableArray methods, ISymbol symbol) { foreach (QualifiedMember method in methods) { @@ -149,7 +149,7 @@ internal static bool Contains(this ImmutableArray methods, ISym return false; } - internal static bool Contains(this ImmutableArray types, [NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) + public static bool Contains(this ImmutableArray types, [NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) { TypeMatchSpec matching = default(TypeMatchSpec); foreach (TypeMatchSpec type in types) @@ -171,7 +171,7 @@ internal static bool Contains(this ImmutableArray types, [NotNull return !matching.IsEmpty && !matching.InvertedLogic; } - internal static CommonInterest.AwaitableTypeTester CollectAwaitableTypes(Compilation compilation, CancellationToken cancellationToken) + public static CommonInterest.AwaitableTypeTester CollectAwaitableTypes(Compilation compilation, CancellationToken cancellationToken) { HashSet awaitableTypes = new(SymbolEqualityComparer.Default); void AddAwaitableType(ITypeSymbol type) @@ -238,7 +238,7 @@ bool TryGetAwaitableType(ISymbol getAwaiterMember, [NotNullWhen(true)] out IType return new AwaitableTypeTester(awaitableTypes); } - internal static bool IsAwaitable(this ITypeSymbol? typeSymbol) + public static bool IsAwaitable(this ITypeSymbol? typeSymbol) { if (typeSymbol is null) { @@ -256,7 +256,7 @@ internal static bool IsAwaitable(this ITypeSymbol? typeSymbol) return false; } - internal static bool IsAwaitable(this ITypeSymbol? typeSymbol, SemanticModel semanticModel, int position) + public static bool IsAwaitable(this ITypeSymbol? typeSymbol, SemanticModel semanticModel, int position) { if (typeSymbol is null) { @@ -275,7 +275,7 @@ internal static bool IsAwaitable(this ITypeSymbol? typeSymbol, SemanticModel sem return false; } - internal static IOperation? GetContainingFunction(this IOperation? operation) + public static IOperation? GetContainingFunction(this IOperation? operation) { while (operation?.Parent is not null) { @@ -298,7 +298,7 @@ internal static bool IsAwaitable(this ITypeSymbol? typeSymbol, SemanticModel sem return null; } - internal static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) + public static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) { if (typeSymbol is null) { @@ -324,7 +324,7 @@ internal static bool ConformsToAwaiterPattern(ITypeSymbol typeSymbol) return false; } - internal static IEnumerable ReadLinesFromAdditionalFile(SourceText text) + public static IEnumerable ReadLinesFromAdditionalFile(SourceText text) { if (text is null) { @@ -342,7 +342,7 @@ internal static IEnumerable ReadLinesFromAdditionalFile(SourceText text) } } - internal static QualifiedMember ParseAdditionalFileMethodLine(string line) + public static QualifiedMember ParseAdditionalFileMethodLine(string line) { Match? match = null; try @@ -391,9 +391,9 @@ private static bool TestGetAwaiterMethod(IMethodSymbol getAwaiterMethod) return true; } - internal readonly struct TypeMatchSpec + public readonly struct TypeMatchSpec { - internal TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) + public TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) { this.InvertedLogic = inverted; this.Type = type; @@ -408,37 +408,37 @@ internal TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted /// /// Gets a value indicating whether this entry appeared in a file with a leading "!" character. /// - internal bool InvertedLogic { get; } + public bool InvertedLogic { get; } /// /// Gets the type described by this entry. /// - internal QualifiedType Type { get; } + public QualifiedType Type { get; } /// /// Gets the member described by this entry. /// - internal QualifiedMember Member { get; } + public QualifiedMember Member { get; } /// /// Gets a value indicating whether a member match is reuqired. /// - internal bool IsMember => this.Member.Name is object; + public bool IsMember => this.Member.Name is object; /// /// Gets a value indicating whether the typename is a wildcard. /// - internal bool IsWildcard => this.Type.Name == "*"; + public bool IsWildcard => this.Type.Name == "*"; /// /// Gets a value indicating whether this is an uninitialized (default) instance. /// - internal bool IsEmpty => this.Type.Namespace is null; + public bool IsEmpty => this.Type.Namespace is null; /// /// Tests whether a given symbol matches the description of a type (independent of its property). /// - internal bool IsMatch([NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) + public bool IsMatch([NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memberSymbol) { if (typeSymbol is null) { @@ -464,7 +464,7 @@ internal bool IsMatch([NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? memb } } - internal readonly struct QualifiedType + public readonly struct QualifiedType { public QualifiedType(IReadOnlyList containingTypeNamespace, string typeName) { @@ -485,7 +485,7 @@ public bool IsMatch(ISymbol symbol) public override string ToString() => string.Join(".", this.Namespace.Concat(new[] { this.Name })); } - internal readonly struct QualifiedMember + public readonly struct QualifiedMember { public QualifiedMember(QualifiedType containingType, string methodName) { @@ -507,7 +507,7 @@ public bool IsMatch(ISymbol? symbol) } [DebuggerDisplay("{" + nameof(Method) + "} -> {" + nameof(AsyncAlternativeMethodName) + "}")] - internal readonly struct SyncBlockingMethod + public readonly struct SyncBlockingMethod { public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethodName = null, IReadOnlyList? extensionMethodNamespace = null) { @@ -523,16 +523,16 @@ public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethod public IReadOnlyList? ExtensionMethodNamespace { get; } } - internal class AwaitableTypeTester + public class AwaitableTypeTester { private readonly HashSet awaitableTypes; - internal AwaitableTypeTester(HashSet awaitableTypes) + public AwaitableTypeTester(HashSet awaitableTypes) { this.awaitableTypes = awaitableTypes; } - internal bool IsAwaitableType(ITypeSymbol typeSymbol) + public bool IsAwaitableType(ITypeSymbol typeSymbol) { if (this.awaitableTypes.Contains(typeSymbol)) { diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs index c97085c26..18cb25ee1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/LanguageUtils.cs @@ -7,15 +7,15 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; -internal abstract class LanguageUtils +public abstract class LanguageUtils { - internal abstract Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken); + public abstract Location? GetLocationOfBaseTypeName(INamedTypeSymbol symbol, INamedTypeSymbol baseType, Compilation compilation, CancellationToken cancellationToken); - internal abstract SyntaxNode IsolateMethodName(IInvocationOperation invocation); + public abstract SyntaxNode IsolateMethodName(IInvocationOperation invocation); - internal abstract SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation); + public abstract SyntaxNode IsolateMethodName(IObjectCreationOperation objectCreation); - internal abstract bool MethodReturnsNullableReferenceType(IMethodSymbol method); + public abstract bool MethodReturnsNullableReferenceType(IMethodSymbol method); - internal abstract bool IsAsyncMethod(SyntaxNode syntaxNode); + public abstract bool IsAsyncMethod(SyntaxNode syntaxNode); } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs index be5b1a654..048814831 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs @@ -5,75 +5,75 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; -internal static class Namespaces +public static class Namespaces { - internal static readonly IReadOnlyList System = new[] + public static readonly IReadOnlyList System = new[] { nameof(System), }; - internal static readonly IReadOnlyList SystemCollectionsGeneric = new[] + public static readonly IReadOnlyList SystemCollectionsGeneric = new[] { nameof(System), nameof(global::System.Collections), nameof(global::System.Collections.Generic), }; - internal static readonly IReadOnlyList SystemThreading = new[] + public static readonly IReadOnlyList SystemThreading = new[] { nameof(System), nameof(global::System.Threading), }; - internal static readonly IReadOnlyList SystemDiagnostics = new[] + public static readonly IReadOnlyList SystemDiagnostics = new[] { nameof(System), nameof(global::System.Diagnostics), }; - internal static readonly IReadOnlyList SystemThreadingTasks = new[] + public static readonly IReadOnlyList SystemThreadingTasks = new[] { nameof(System), nameof(global::System.Threading), nameof(global::System.Threading.Tasks), }; - internal static readonly IReadOnlyList SystemRuntimeCompilerServices = new[] + public static readonly IReadOnlyList SystemRuntimeCompilerServices = new[] { nameof(System), nameof(global::System.Runtime), nameof(global::System.Runtime.CompilerServices), }; - internal static readonly IReadOnlyList SystemRuntimeInteropServices = new[] + public static readonly IReadOnlyList SystemRuntimeInteropServices = new[] { nameof(System), nameof(global::System.Runtime), nameof(global::System.Runtime.InteropServices), }; - internal static readonly IReadOnlyList SystemWindowsThreading = new[] + public static readonly IReadOnlyList SystemWindowsThreading = new[] { nameof(System), nameof(global::System.Windows), "Threading", }; - internal static readonly IReadOnlyList MicrosoftVisualStudioThreading = new[] + public static readonly IReadOnlyList MicrosoftVisualStudioThreading = new[] { "Microsoft", "VisualStudio", "Threading", }; - internal static readonly IReadOnlyList MicrosoftVisualStudioShell = new[] + public static readonly IReadOnlyList MicrosoftVisualStudioShell = new[] { "Microsoft", "VisualStudio", "Shell", }; - internal static readonly IReadOnlyList MicrosoftVisualStudioShellInterop = new[] + public static readonly IReadOnlyList MicrosoftVisualStudioShellInterop = new[] { "Microsoft", "VisualStudio", diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs index 8762d3a01..987a09904 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs @@ -9,243 +9,243 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; /// Identifiers used to identify various types so that we can avoid adding dependency only if absolutely needed. /// For each predefine value here, please update the unit test to detect if values go out of sync with the real types they represent. /// -internal static class Types +public static class Types { private const string VSThreadingNamespace = "Microsoft.VisualStudio.Threading"; - internal static class BclAsyncDisposable + public static class BclAsyncDisposable { - internal const string FullName = "System.IAsyncDisposable"; + public const string FullName = "System.IAsyncDisposable"; - internal const string PackageId = "Microsoft.Bcl.AsyncInterfaces"; + public const string PackageId = "Microsoft.Bcl.AsyncInterfaces"; } - internal static class IAsyncDisposable + public static class IAsyncDisposable { - internal const string FullName = "Microsoft.VisualStudio.Threading.IAsyncDisposable"; + public const string FullName = "Microsoft.VisualStudio.Threading.IAsyncDisposable"; } - internal static class AwaitExtensions + public static class AwaitExtensions { /// /// The full name of the AwaitExtensions type. /// - internal const string TypeName = "AwaitExtensions"; + public const string TypeName = "AwaitExtensions"; /// /// The name of the ConfigureAwaitRunInline method. /// - internal const string ConfigureAwaitRunInline = "ConfigureAwaitRunInline"; + public const string ConfigureAwaitRunInline = "ConfigureAwaitRunInline"; - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; } /// /// Contains the names of types and members within TplExtensions. /// - internal static class TplExtensions + public static class TplExtensions { /// /// The full name of the TplExtensions type. /// - internal const string TypeName = "TplExtensions"; + public const string TypeName = "TplExtensions"; /// /// The name of the InvokeAsync method. /// - internal const string InvokeAsync = "InvokeAsync"; + public const string InvokeAsync = "InvokeAsync"; /// /// The name of the CompletedTask field. /// - internal const string CompletedTask = "CompletedTask"; + public const string CompletedTask = "CompletedTask"; /// /// The name of the CanceledTask field. /// - internal const string CanceledTask = "CanceledTask"; + public const string CanceledTask = "CanceledTask"; /// /// The name of the TrueTask field. /// - internal const string TrueTask = "TrueTask"; + public const string TrueTask = "TrueTask"; /// /// The name of the FalseTask field. /// - internal const string FalseTask = "FalseTask"; + public const string FalseTask = "FalseTask"; - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; } /// /// Contains descriptors for the AsyncEventHandler type. /// - internal static class AsyncEventHandler + public static class AsyncEventHandler { /// /// The full name of the AsyncEventHandler type. /// - internal const string TypeName = "AsyncEventHandler"; + public const string TypeName = "AsyncEventHandler"; - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; } - internal static class AsyncMethodBuilderAttribute + public static class AsyncMethodBuilderAttribute { - internal const string TypeName = nameof(System.Runtime.CompilerServices.AsyncMethodBuilderAttribute); + public const string TypeName = nameof(System.Runtime.CompilerServices.AsyncMethodBuilderAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; } /// /// Contains descriptors for the JoinableTaskFactory type. /// - internal static class JoinableTaskFactory + public static class JoinableTaskFactory { - internal const string TypeName = "JoinableTaskFactory"; + public const string TypeName = "JoinableTaskFactory"; - internal const string FullName = "Microsoft.VisualStudio.Threading." + TypeName; + public const string FullName = "Microsoft.VisualStudio.Threading." + TypeName; /// /// The name of the SwitchToMainThreadAsync method. /// - internal const string SwitchToMainThreadAsync = "SwitchToMainThreadAsync"; + public const string SwitchToMainThreadAsync = "SwitchToMainThreadAsync"; - internal const string Run = "Run"; + public const string Run = "Run"; - internal const string RunAsync = "RunAsync"; + public const string RunAsync = "RunAsync"; - internal static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; } /// /// Contains descriptors for the JoinableTaskCollection type. /// - internal static class JoinableTaskCollection + public static class JoinableTaskCollection { - internal const string TypeName = "JoinableTaskCollection"; + public const string TypeName = "JoinableTaskCollection"; } /// /// Contains descriptors for the JoinableTaskContext type. /// - internal static class JoinableTaskContext + public static class JoinableTaskContext { - internal const string TypeName = "JoinableTaskContext"; + public const string TypeName = "JoinableTaskContext"; - internal const string FullName = $"{VSThreadingNamespace}.{TypeName}"; + public const string FullName = $"{VSThreadingNamespace}.{TypeName}"; - internal const string CreateNoOpContext = "CreateNoOpContext"; + public const string CreateNoOpContext = "CreateNoOpContext"; } - internal static class JoinableTask + public static class JoinableTask { - internal const string TypeName = "JoinableTask"; + public const string TypeName = "JoinableTask"; - internal const string Join = "Join"; + public const string Join = "Join"; - internal const string JoinAsync = "JoinAsync"; + public const string JoinAsync = "JoinAsync"; } - internal static class SynchronizationContext + public static class SynchronizationContext { - internal const string TypeName = nameof(System.Threading.SynchronizationContext); + public const string TypeName = nameof(System.Threading.SynchronizationContext); - internal const string Post = nameof(System.Threading.SynchronizationContext.Post); + public const string Post = nameof(System.Threading.SynchronizationContext.Post); - internal const string Send = nameof(System.Threading.SynchronizationContext.Send); + public const string Send = nameof(System.Threading.SynchronizationContext.Send); } - internal static class ThreadHelper + public static class ThreadHelper { - internal const string TypeName = "ThreadHelper"; + public const string TypeName = "ThreadHelper"; - internal const string Invoke = "Invoke"; + public const string Invoke = "Invoke"; - internal const string InvokeAsync = "InvokeAsync"; + public const string InvokeAsync = "InvokeAsync"; - internal const string BeginInvoke = "BeginInvoke"; + public const string BeginInvoke = "BeginInvoke"; - internal const string CheckAccess = "CheckAccess"; + public const string CheckAccess = "CheckAccess"; } - internal static class Dispatcher + public static class Dispatcher { - internal const string TypeName = "Dispatcher"; + public const string TypeName = "Dispatcher"; - internal const string Invoke = "Invoke"; + public const string Invoke = "Invoke"; - internal const string BeginInvoke = "BeginInvoke"; + public const string BeginInvoke = "BeginInvoke"; - internal const string InvokeAsync = "InvokeAsync"; + public const string InvokeAsync = "InvokeAsync"; } - internal static class Task + public static class Task { - internal const string TypeName = nameof(System.Threading.Tasks.Task); + public const string TypeName = nameof(System.Threading.Tasks.Task); - internal const string FullName = "System.Threading.Tasks." + TypeName; + public const string FullName = "System.Threading.Tasks." + TypeName; - internal const string CompletedTask = nameof(System.Threading.Tasks.Task.CompletedTask); + public const string CompletedTask = nameof(System.Threading.Tasks.Task.CompletedTask); - internal const string WhenAll = "WhenAll"; + public const string WhenAll = "WhenAll"; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; + public static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; } - internal static class ConfiguredTaskAwaitable + public static class ConfiguredTaskAwaitable { - internal const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredTaskAwaitable); + public const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredTaskAwaitable); - internal const string FullName = "System.Runtime.CompilerServices." + TypeName; + public const string FullName = "System.Runtime.CompilerServices." + TypeName; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; } - internal static class ValueTask + public static class ValueTask { - internal const string TypeName = nameof(ValueTask); + public const string TypeName = nameof(ValueTask); - internal const string FullName = "System.Threading.Tasks." + TypeName; + public const string FullName = "System.Threading.Tasks." + TypeName; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; + public static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; } - internal static class ConfiguredValueTaskAwaitable + public static class ConfiguredValueTaskAwaitable { - internal const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable); + public const string TypeName = nameof(System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable); - internal const string FullName = "System.Runtime.CompilerServices." + TypeName; + public const string FullName = "System.Runtime.CompilerServices." + TypeName; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; } - internal static class CoClassAttribute + public static class CoClassAttribute { - internal const string TypeName = nameof(System.Runtime.InteropServices.CoClassAttribute); + public const string TypeName = nameof(System.Runtime.InteropServices.CoClassAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; } - internal static class ComImportAttribute + public static class ComImportAttribute { - internal const string TypeName = nameof(System.Runtime.InteropServices.ComImportAttribute); + public const string TypeName = nameof(System.Runtime.InteropServices.ComImportAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; } - internal static class InterfaceTypeAttribute + public static class InterfaceTypeAttribute { - internal const string TypeName = nameof(System.Runtime.InteropServices.InterfaceTypeAttribute); + public const string TypeName = nameof(System.Runtime.InteropServices.InterfaceTypeAttribute); - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; } - internal static class TypeLibTypeAttribute + public static class TypeLibTypeAttribute { - internal const string TypeName = "TypeLibTypeAttribute"; + public const string TypeName = "TypeLibTypeAttribute"; - internal static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index 77d0cc712..d3cfd4a2c 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -15,9 +15,9 @@ namespace Microsoft.VisualStudio.Threading.Analyzers; -internal static class Utils +public static class Utils { - internal static Action DebuggableWrapper(Action handler) + public static Action DebuggableWrapper(Action handler) { return ctxt => { @@ -36,7 +36,7 @@ internal static Action DebuggableWrapper(Action DebuggableWrapper(Action handler) + public static Action DebuggableWrapper(Action handler) { return ctxt => { @@ -55,7 +55,7 @@ internal static Action DebuggableWrapper(Action DebuggableWrapper(Action handler) + public static Action DebuggableWrapper(Action handler) { return ctxt => { @@ -74,7 +74,7 @@ internal static Action DebuggableWrapper(Action DebuggableWrapper(Action handler) + public static Action DebuggableWrapper(Action handler) { return ctxt => { @@ -93,7 +93,7 @@ internal static Action DebuggableWrapper(Action DebuggableWrapper(Action handler) + public static Action DebuggableWrapper(Action handler) { return ctxt => { @@ -133,7 +133,7 @@ internal static Action DebuggableWrapper(Act /// /// Gets a semantic model for the given . /// - internal static bool TryGetNewOrExistingSemanticModel(this SyntaxNodeAnalysisContext context, SyntaxTree syntaxTree, [NotNullWhen(true)] out SemanticModel? semanticModel) + public static bool TryGetNewOrExistingSemanticModel(this SyntaxNodeAnalysisContext context, SyntaxTree syntaxTree, [NotNullWhen(true)] out SemanticModel? semanticModel) { // Avoid calling GetSemanticModel unless we need it since it's much more expensive to create a new one than to reuse one. semanticModel = @@ -143,12 +143,12 @@ internal static bool TryGetNewOrExistingSemanticModel(this SyntaxNodeAnalysisCon return semanticModel is object; } - internal static bool IsEqualToOrDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) + public static bool IsEqualToOrDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) { return EqualityComparer.Default.Equals(type?.OriginalDefinition, expectedType) || IsDerivedFrom(type, expectedType); } - internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) + public static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) { type = type?.BaseType; while (type is object) @@ -170,7 +170,7 @@ internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) /// /// The input symbol. /// The type represented by the input symbol; or if could not figure out the type. - internal static ITypeSymbol? ResolveTypeFromSymbol(ISymbol symbol) + public static ITypeSymbol? ResolveTypeFromSymbol(ISymbol symbol) { ITypeSymbol? type = null; switch (symbol?.Kind) @@ -210,7 +210,7 @@ internal static bool IsDerivedFrom(ITypeSymbol? type, ITypeSymbol expectedType) /// The symbol whose namespace membership is being tested. /// A sequence of namespaces from global to most precise. For example: [System, Threading, Tasks]. /// if the symbol belongs to the given namespace; otherwise . - internal static bool BelongsToNamespace(this ISymbol symbol, IReadOnlyList namespaces) + public static bool BelongsToNamespace(this ISymbol symbol, IReadOnlyList namespaces) { if (namespaces is null) { @@ -236,7 +236,7 @@ internal static bool BelongsToNamespace(this ISymbol symbol, IReadOnlyList IsAsyncCompatibleReturnType(methodSymbol?.ReturnType); + public static bool HasAsyncCompatibleReturnType([NotNullWhen(true)] this IMethodSymbol? methodSymbol) => IsAsyncCompatibleReturnType(methodSymbol?.ReturnType); /// /// Determines whether a type could be used with the async modifier as a method return type. @@ -284,7 +284,7 @@ internal static ISymbol GetContainingFunction(IOperation operation, ISymbol oper /// that follows the proper pattern. But being an async-compatible type in this sense is a type that can be returned from a method carrying the async keyword modifier, /// in that the type is either the special Task type, or offers an async method builder of its own. /// - internal static bool IsAsyncCompatibleReturnType([NotNullWhen(true)] this ITypeSymbol? typeSymbol) + public static bool IsAsyncCompatibleReturnType([NotNullWhen(true)] this ITypeSymbol? typeSymbol) { if (typeSymbol is null) { @@ -301,7 +301,7 @@ static bool IsIAsyncEnumerable(ITypeSymbol symbol) && symbol.BelongsToNamespace(Namespaces.SystemCollectionsGeneric); } - internal static bool IsLazyOfT([NotNullWhen(true)] INamedTypeSymbol? constructedType) + public static bool IsLazyOfT([NotNullWhen(true)] INamedTypeSymbol? constructedType) { return constructedType is object && constructedType.ContainingNamespace?.Name == nameof(System) @@ -310,7 +310,7 @@ internal static bool IsLazyOfT([NotNullWhen(true)] INamedTypeSymbol? constructed && constructedType.Arity > 0; // could be Lazy or Lazy } - internal static bool IsTask([NotNullWhen(true)] ITypeSymbol? typeSymbol) => typeSymbol?.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks); + public static bool IsTask([NotNullWhen(true)] ITypeSymbol? typeSymbol) => typeSymbol?.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks); /// /// Gets a value indicating whether a method is async or is ready to be async by having an async-compatible return type. @@ -319,16 +319,16 @@ internal static bool IsLazyOfT([NotNullWhen(true)] INamedTypeSymbol? constructed /// A method might be async but not have an async compatible return type if it returns void and is an "async void" method. /// However, a non-async void method is *not* considered async ready and gets a false value returned from this method. /// - internal static bool IsAsyncReady(this IMethodSymbol methodSymbol) => methodSymbol.IsAsync || methodSymbol.HasAsyncCompatibleReturnType(); + public static bool IsAsyncReady(this IMethodSymbol methodSymbol) => methodSymbol.IsAsync || methodSymbol.HasAsyncCompatibleReturnType(); - internal static bool HasAsyncAlternative(this IMethodSymbol methodSymbol, CancellationToken cancellationToken) + public static bool HasAsyncAlternative(this IMethodSymbol methodSymbol, CancellationToken cancellationToken) { cancellationToken.ThrowIfCancellationRequested(); return methodSymbol.ContainingType.GetMembers(methodSymbol.Name + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix) .Any(alt => IsXAtLeastAsPublicAsY(alt, methodSymbol)); } - internal static bool IsXAtLeastAsPublicAsY(ISymbol x, ISymbol y) + public static bool IsXAtLeastAsPublicAsY(ISymbol x, ISymbol y) { if (y.DeclaredAccessibility == x.DeclaredAccessibility || x.DeclaredAccessibility == Accessibility.Public) @@ -363,7 +363,7 @@ internal static bool IsXAtLeastAsPublicAsY(ISymbol x, ISymbol y) /// or an explicit interface implementation of a public interface; /// otherwise . /// - internal static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) + public static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) { if (symbol is null) { @@ -399,22 +399,22 @@ internal static bool IsPublic([NotNullWhen(true)] ISymbol? symbol) } } - internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, SemanticModel? semanticModel, CancellationToken cancellationToken) + public static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, SemanticModel? semanticModel, CancellationToken cancellationToken) { return semanticModel?.Compilation is object && IsEntrypointMethod(symbol, semanticModel.Compilation, cancellationToken); } - internal static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, Compilation compilation, CancellationToken cancellationToken) + public static bool IsEntrypointMethod([NotNullWhen(true)] ISymbol? symbol, Compilation compilation, CancellationToken cancellationToken) { return compilation.GetEntryPoint(cancellationToken)?.Equals(symbol, SymbolEqualityComparer.Default) ?? false; } - internal static bool IsObsolete(this ISymbol symbol) + public static bool IsObsolete(this ISymbol symbol) { return symbol.GetAttributes().Any(a => a.AttributeClass?.Name == nameof(ObsoleteAttribute) && a.AttributeClass.BelongsToNamespace(Namespaces.System)); } - internal static IEnumerable FindInterfacesImplemented(this ISymbol? symbol) + public static IEnumerable FindInterfacesImplemented(this ISymbol? symbol) { if (symbol is null) { @@ -430,7 +430,7 @@ from member in iface.GetMembers() return interfaceImplementations; } - internal static string GetFullName(ISymbol symbol) + public static string GetFullName(ISymbol symbol) { if (symbol is null) { @@ -458,20 +458,20 @@ internal static string GetFullName(ISymbol symbol) return sb.ToString(); } - internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2) + public static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2) { item1 = tuple.Item1; item2 = tuple.Item2; } - internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3) + public static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3) { item1 = tuple.Item1; item2 = tuple.Item2; item3 = tuple.Item3; } - internal static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3, out T4 item4) + public static void Deconstruct(this Tuple tuple, out T1 item1, out T2 item2, out T3 item3, out T4 item4) { item1 = tuple.Item1; item2 = tuple.Item2; @@ -479,7 +479,7 @@ internal static void Deconstruct(this Tuple tupl item4 = tuple.Item4; } - internal static string GetHelpLink(string analyzerId) + public static string GetHelpLink(string analyzerId) { return $"https://github.com/Microsoft/vs-threading/blob/main/doc/analyzers/{analyzerId}.md"; } @@ -492,7 +492,7 @@ internal static string GetHelpLink(string analyzerId) /// The position in the document that must have access to any candidate . /// A token that represents lost interest in this inquiry. /// Candidate symbols. - internal static IEnumerable FindCancellationToken(SemanticModel? semanticModel, int positionForLookup, CancellationToken cancellationToken) + public static IEnumerable FindCancellationToken(SemanticModel? semanticModel, int positionForLookup, CancellationToken cancellationToken) { if (semanticModel is null) { @@ -517,7 +517,7 @@ internal static IEnumerable FindCancellationToken(SemanticModel? semant /// The semantic model of the document that must be able to access the methods. /// The fully-qualified name of the method. /// An enumeration of method symbols with a matching name. - internal static IEnumerable FindMethodGroup(SemanticModel? semanticModel, string methodAsString) + public static IEnumerable FindMethodGroup(SemanticModel? semanticModel, string methodAsString) { if (semanticModel is null) { @@ -548,7 +548,7 @@ internal static IEnumerable FindMethodGroup(SemanticModel? semant /// The semantic model of the document that must be able to access the methods. /// The fully-qualified name of the method. /// An enumeration of method symbols with a matching name. - internal static IEnumerable FindMethodGroup(SemanticModel semanticModel, CommonInterest.QualifiedMember method) + public static IEnumerable FindMethodGroup(SemanticModel semanticModel, CommonInterest.QualifiedMember method) { if (semanticModel is null) { @@ -568,7 +568,7 @@ internal static IEnumerable FindMethodGroup(SemanticModel semanti /// The position in the document where the value must be accessible. /// A cancellation token. /// An enumeration of symbols that can provide a value of the required type, together with a flag indicating whether they are accessible using "local" syntax (i.e. the symbol is a local variable or a field on the enclosing type). - internal static IEnumerable> FindInstanceOf(INamedTypeSymbol typeSymbol, SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) + public static IEnumerable> FindInstanceOf(INamedTypeSymbol typeSymbol, SemanticModel semanticModel, int positionForLookup, CancellationToken cancellationToken) { if (typeSymbol is null) { @@ -611,7 +611,7 @@ from symbol in offering.GetMembers() } } - internal static T? FirstAncestor(this SyntaxNode startingNode, IReadOnlyCollection doNotPassNodeTypes) + public static T? FirstAncestor(this SyntaxNode startingNode, IReadOnlyCollection doNotPassNodeTypes) where T : SyntaxNode { if (doNotPassNodeTypes is null) @@ -638,7 +638,7 @@ from symbol in offering.GetMembers() return default(T); } - internal static Tuple SplitOffLastElement(string? qualifiedName) + public static Tuple SplitOffLastElement(string? qualifiedName) { if (qualifiedName is null) { @@ -659,9 +659,9 @@ from symbol in offering.GetMembers() /// /// The parameter. /// if the parameter takes a ; otherwise. - internal static bool IsCancellationTokenParameter(IParameterSymbol parameterSymbol) => parameterSymbol?.Type.Name == nameof(CancellationToken) && parameterSymbol.Type.BelongsToNamespace(Namespaces.SystemThreading); + public static bool IsCancellationTokenParameter(IParameterSymbol parameterSymbol) => parameterSymbol?.Type.Name == nameof(CancellationToken) && parameterSymbol.Type.BelongsToNamespace(Namespaces.SystemThreading); - internal static ISymbol? GetUnderlyingSymbol(IOperation? operation) + public static ISymbol? GetUnderlyingSymbol(IOperation? operation) { return operation switch { @@ -672,9 +672,9 @@ from symbol in offering.GetMembers() }; } - internal static bool IsSameSymbol(IOperation? op1, IOperation? op2) => GetUnderlyingSymbol(op1)?.Equals(GetUnderlyingSymbol(op2), SymbolEqualityComparer.Default) ?? false; + public static bool IsSameSymbol(IOperation? op1, IOperation? op2) => GetUnderlyingSymbol(op1)?.Equals(GetUnderlyingSymbol(op2), SymbolEqualityComparer.Default) ?? false; - internal static IOperation FindFinalAncestor(IOperation operation) + public static IOperation FindFinalAncestor(IOperation operation) { while (operation.Parent is object) { @@ -684,7 +684,7 @@ internal static IOperation FindFinalAncestor(IOperation operation) return operation; } - internal static T? FindAncestor(IOperation? operation) + public static T? FindAncestor(IOperation? operation) where T : class, IOperation { while (operation is object) @@ -700,7 +700,7 @@ internal static IOperation FindFinalAncestor(IOperation operation) return default; } - internal static ISymbol? FindContainingNamedOrAssemblySymbol(this ISymbol? symbol) + public static ISymbol? FindContainingNamedOrAssemblySymbol(this ISymbol? symbol) { ISymbol? candidate = symbol; while (candidate is not null) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD115AvoidJoinableTaskContextCtorWithNullArgsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD115AvoidJoinableTaskContextCtorWithNullArgsAnalyzer.cs index 92360240b..a358185c0 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD115AvoidJoinableTaskContextCtorWithNullArgsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD115AvoidJoinableTaskContextCtorWithNullArgsAnalyzer.cs @@ -19,13 +19,13 @@ public class VSTHRD115AvoidJoinableTaskContextCtorWithNullArgsAnalyzer : Diagnos { public const string Id = "VSTHRD115"; - internal const string UsesDefaultThreadPropertyName = "UsesDefaultThread"; + public const string UsesDefaultThreadPropertyName = "UsesDefaultThread"; - internal const string NodeTypePropertyName = "NodeType"; + public const string NodeTypePropertyName = "NodeType"; - internal const string NodeTypeArgument = "Argument"; + public const string NodeTypeArgument = "Argument"; - internal const string NodeTypeCreation = "Creation"; + public const string NodeTypeCreation = "Creation"; internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor( id: Id, diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs index 899d7a5c9..4a335fd75 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD200UseAsyncNamingConventionAnalyzer.cs @@ -16,11 +16,11 @@ public class VSTHRD200UseAsyncNamingConventionAnalyzer : DiagnosticAnalyzer { public const string Id = "VSTHRD200"; - internal const string NewNameKey = "NewName"; + public const string NewNameKey = "NewName"; - internal const string MandatoryAsyncSuffix = "Async"; + public const string MandatoryAsyncSuffix = "Async"; - internal static readonly DiagnosticDescriptor AddAsyncDescriptor = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor AddAsyncDescriptor = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD200_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD200_AddAsync_MessageFormat), Strings.ResourceManager, typeof(Strings)), @@ -29,7 +29,7 @@ public class VSTHRD200UseAsyncNamingConventionAnalyzer : DiagnosticAnalyzer defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: true); - internal static readonly DiagnosticDescriptor RemoveAsyncDescriptor = new DiagnosticDescriptor( + public static readonly DiagnosticDescriptor RemoveAsyncDescriptor = new DiagnosticDescriptor( id: Id, title: new LocalizableResourceString(nameof(Strings.VSTHRD200_Title), Strings.ResourceManager, typeof(Strings)), messageFormat: new LocalizableResourceString(nameof(Strings.VSTHRD200_RemoveAsync_MessageFormat), Strings.ResourceManager, typeof(Strings)), From 16525898b82bb94116b349a4c6c3694a292e5ce9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jan 2025 14:05:58 -0700 Subject: [PATCH 1203/1753] Bump analyzer testing framework so it works with .NET 8 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b760ecdde..6a9c285d5 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ 2.0.165 3.11.0 4.4.0 - 1.1.1 + 1.1.2 3.1.456501 From eb84f5b9da4284a1865da3166fb4bba05f699bb8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jan 2025 14:29:26 -0700 Subject: [PATCH 1204/1753] Switch to resx source generator --- Directory.Packages.props | 5 +- ...alStudio.Threading.Analyzers.CSharp.csproj | 1 + .../AssemblyInfo.cs | 2 - ...tudio.Threading.Analyzers.CodeFixes.csproj | 1 + .../VSTHRD103UseAsyncOptionCodeFix.cs | 2 +- ...STHRD200UseAsyncNamingConventionCodeFix.cs | 5 +- ...dio.Threading.Analyzers.VisualBasic.csproj | 1 + ...ft.VisualStudio.Threading.Analyzers.csproj | 18 +- .../Strings.Designer.cs | 685 ------------------ .../Microsoft.VisualStudio.Threading.csproj | 34 +- .../Strings.Designer.cs | 287 -------- 11 files changed, 16 insertions(+), 1025 deletions(-) delete mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs delete mode 100644 src/Microsoft.VisualStudio.Threading/Strings.Designer.cs diff --git a/Directory.Packages.props b/Directory.Packages.props index 6a9c285d5..af8184e2e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,12 +9,13 @@ 4.4.0 1.1.2 3.1.456501 + 3.11.0-beta1.24527.2 - + @@ -49,7 +50,7 @@ - + diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj index 689fd8109..f1209f918 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj @@ -2,6 +2,7 @@ netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers + true false false diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/AssemblyInfo.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/AssemblyInfo.cs index e872bfdcc..61f8ea2f6 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/AssemblyInfo.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/AssemblyInfo.cs @@ -10,5 +10,3 @@ [assembly: ComVisible(false)] [assembly: NeutralResourcesLanguage("en-US")] - -[assembly: InternalsVisibleTo("Microsoft.VisualStudio.Threading.Analyzers.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")] diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj index a58ca1295..38ec50815 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj @@ -2,6 +2,7 @@ netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers + true false Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs index 7400af2b6..682cc9374 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD103UseAsyncOptionCodeFix.cs @@ -103,7 +103,7 @@ public override string Title get { return !string.IsNullOrEmpty(this.AlternativeAsyncMethod) - ? string.Format(CultureInfo.CurrentCulture, Strings.AwaitXInstead, this.AlternativeAsyncMethod) + ? new LocalizableResourceString(nameof(Strings.AwaitXInstead), Strings.ResourceManager, typeof(string), this.AlternativeAsyncMethod!).ToString() : Strings.UseAwaitInstead; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index 99c8f7b06..fe17ac2fb 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -53,10 +53,7 @@ public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic, string this.newName = newName; } - public override string Title => string.Format( - CultureInfo.CurrentCulture, - Strings.VSTHRD200_CodeFix_Title, - this.newName); + public override string Title => new LocalizableResourceString(nameof(Strings.VSTHRD200_CodeFix_Title), Strings.ResourceManager, typeof(Strings), this.newName).ToString(); /// public override string? EquivalenceKey => null; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj index b8c437ca0..0ed35b358 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj @@ -2,6 +2,7 @@ netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers + true false false diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj index 35281001e..89e942d24 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj @@ -1,25 +1,13 @@  netstandard2.0 + true Microsoft.VisualStudio.Threading.Analyzers.Only false + $(NoWarn);CS1591 - - True - True - Strings.resx - - - - - ResXFileCodeGenerator - Strings.Designer.cs - - - Strings.resx - - + diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs deleted file mode 100644 index b16b44432..000000000 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Strings.Designer.cs +++ /dev/null @@ -1,685 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Microsoft.VisualStudio.Threading.Analyzers { - using System; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class Strings { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal Strings() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Analyzers.Strings", typeof(Strings).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to Await {0} instead. - /// - internal static string AwaitXInstead { - get { - return ResourceManager.GetString("AwaitXInstead", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to The System.IAsyncDisposable interface is defined in the Microsoft.Bcl.AsyncInterfaces NuGet package.. - /// - internal static string SystemIAsyncDisposablePackageNote { - get { - return ResourceManager.GetString("SystemIAsyncDisposablePackageNote", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use await instead. - /// - internal static string UseAwaitInstead { - get { - return ResourceManager.GetString("UseAwaitInstead", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Await JoinableTaskFactory.SwitchToMainThreadAsync() to switch to the UI thread instead of APIs that can deadlock or require specifying a priority. - /// - internal static string VSTHRD001_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD001_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid legacy thread switching APIs. - /// - internal static string VSTHRD001_Title { - get { - return ResourceManager.GetString("VSTHRD001_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use await instead. - /// - internal static string VSTHRD002_CodeFix_Await_Title { - get { - return ResourceManager.GetString("VSTHRD002_CodeFix_Await_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.. - /// - internal static string VSTHRD002_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD002_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid problematic synchronous waits. - /// - internal static string VSTHRD002_Title { - get { - return ResourceManager.GetString("VSTHRD002_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid awaiting or returning a Task representing work that was not started within your context as that can lead to deadlocks. - ///Start the work within this context, or use JoinableTaskFactory.RunAsync to start the task and await the returned JoinableTask instead.. - /// - internal static string VSTHRD003_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD003_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid awaiting foreign Tasks. - /// - internal static string VSTHRD003_Title { - get { - return ResourceManager.GetString("VSTHRD003_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Calls to JoinableTaskFactory.SwitchToMainThreadAsync() must be awaited. - /// - internal static string VSTHRD004_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD004_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Await SwitchToMainThreadAsync. - /// - internal static string VSTHRD004_Title { - get { - return ResourceManager.GetString("VSTHRD004_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Await JoinableTaskFactory.SwitchToMainThreadAsync() first.. - /// - internal static string VSTHRD010_MessageFormat_Async { - get { - return ResourceManager.GetString("VSTHRD010_MessageFormat_Async", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Accessing "{0}" should only be done on the main thread. Call {1}() first.. - /// - internal static string VSTHRD010_MessageFormat_Sync { - get { - return ResourceManager.GetString("VSTHRD010_MessageFormat_Sync", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Invoke single-threaded types on Main thread. - /// - internal static string VSTHRD010_Title { - get { - return ResourceManager.GetString("VSTHRD010_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Lazy<Task<T>>.Value can deadlock. Use AsyncLazy<T> instead.. - /// - internal static string VSTHRD011_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD011_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use AsyncLazy<T>. - /// - internal static string VSTHRD011_Title { - get { - return ResourceManager.GetString("VSTHRD011_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Invoking or blocking on async code in a Lazy<T> value factory can deadlock. Use AsyncLazy<T> instead.. - /// - internal static string VSTHRD011b_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD011b_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Provide an instance of JoinableTaskFactory in this call (or another overload) to avoid deadlocks with the main thread. - /// - internal static string VSTHRD012_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD012_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Provide JoinableTaskFactory where allowed. - /// - internal static string VSTHRD012_Title { - get { - return ResourceManager.GetString("VSTHRD012_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Change return type to Task. - /// - internal static string VSTHRD100_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD100_CodeFix_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid "async void" methods, because any exceptions not handled by the method will crash the process. - /// - internal static string VSTHRD100_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD100_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid async void methods. - /// - internal static string VSTHRD100_Title { - get { - return ResourceManager.GetString("VSTHRD100_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process. - /// - internal static string VSTHRD101_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD101_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid unsupported async delegates. - /// - internal static string VSTHRD101_Title { - get { - return ResourceManager.GetString("VSTHRD101_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Limit use of synchronously blocking method calls such as JoinableTaskFactory.Run or Task.Result to public entrypoint members where you must be synchronous. Using it for internal members can needlessly add synchronous frames between asynchronous frames, leading to threadpool exhaustion.. - /// - internal static string VSTHRD102_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD102_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Implement internal logic asynchronously. - /// - internal static string VSTHRD102_Title { - get { - return ResourceManager.GetString("VSTHRD102_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to {0} synchronously blocks. Await {1} instead.. - /// - internal static string VSTHRD103_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD103_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to {0} synchronously blocks. Use await instead.. - /// - internal static string VSTHRD103_MessageFormat_UseAwaitInstead { - get { - return ResourceManager.GetString("VSTHRD103_MessageFormat_UseAwaitInstead", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Call async methods when in an async method. - /// - internal static string VSTHRD103_Title { - get { - return ResourceManager.GetString("VSTHRD103_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.. - /// - internal static string VSTHRD104_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD104_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Offer async methods. - /// - internal static string VSTHRD104_Title { - get { - return ResourceManager.GetString("VSTHRD104_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. Use an overload that accepts a TaskScheduler and specify TaskScheduler.Default (or any other) explicitly.. - /// - internal static string VSTHRD105_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD105_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid method overloads that assume TaskScheduler.Current. - /// - internal static string VSTHRD105_Title { - get { - return ResourceManager.GetString("VSTHRD105_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to AsyncEventHandler delegates should be invoked via the extension method "TplExtensions.InvokeAsync()" defined in Microsoft.VisualStudio.Threading assembly. - /// - internal static string VSTHRD106_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD106_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use InvokeAsync to raise async events. - /// - internal static string VSTHRD106_Title { - get { - return ResourceManager.GetString("VSTHRD106_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Await using expression. - /// - internal static string VSTHRD107_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD107_CodeFix_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Missing await operator for "using" expression. - /// - internal static string VSTHRD107_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD107_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Await Task within using expression. - /// - internal static string VSTHRD107_Title { - get { - return ResourceManager.GetString("VSTHRD107_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Thread affinity checks should be unconditional. - /// - internal static string VSTHRD108_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD108_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Assert thread affinity unconditionally. - /// - internal static string VSTHRD108_Title { - get { - return ResourceManager.GetString("VSTHRD108_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid throwing when not on the main thread while in an async or Task-returning method. Switch to the thread required instead.. - /// - internal static string VSTHRD109_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD109_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Switch instead of assert in async methods. - /// - internal static string VSTHRD109_Title { - get { - return ResourceManager.GetString("VSTHRD109_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Observe the awaitable result of this method call by awaiting it, assigning to a variable, or passing it to another method. - /// - internal static string VSTHRD110_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD110_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Observe result of async calls. - /// - internal static string VSTHRD110_Title { - get { - return ResourceManager.GetString("VSTHRD110_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(false). - /// - internal static string VSTHRD111_CodeFix_False_Title { - get { - return ResourceManager.GetString("VSTHRD111_CodeFix_False_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(true). - /// - internal static string VSTHRD111_CodeFix_True_Title { - get { - return ResourceManager.GetString("VSTHRD111_CodeFix_True_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Add .ConfigureAwait(bool) to your await expression. - /// - internal static string VSTHRD111_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD111_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use ConfigureAwait(bool). - /// - internal static string VSTHRD111_Title { - get { - return ResourceManager.GetString("VSTHRD111_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Add implementation of System.IAsyncDisposable.. - /// - internal static string VSTHRD112_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD112_CodeFix_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Implement the System.IAsyncDisposable interface when implementing the obsolete Microsoft.VisualStudio.Threading.IAsyncDisposable interface. - /// - internal static string VSTHRD112_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD112_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Implement System.IAsyncDisposable. - /// - internal static string VSTHRD112_Title { - get { - return ResourceManager.GetString("VSTHRD112_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Add a check for System.IAsyncDisposable in the same code block that checks for Microsoft.VisualStudio.Threading.IAsyncDisposable that behaves similarly. - /// - internal static string VSTHRD113_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD113_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Check for System.IAsyncDisposable. - /// - internal static string VSTHRD113_Title { - get { - return ResourceManager.GetString("VSTHRD113_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use 'Task.CompletedTask' instead. - /// - internal static string VSTHRD114_CodeFix_CompletedTask { - get { - return ResourceManager.GetString("VSTHRD114_CodeFix_CompletedTask", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use 'Task.FromResult' instead. - /// - internal static string VSTHRD114_CodeFix_FromResult { - get { - return ResourceManager.GetString("VSTHRD114_CodeFix_FromResult", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid returning null from a Task-returning method. - /// - internal static string VSTHRD114_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD114_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid returning a null Task. - /// - internal static string VSTHRD114_Title { - get { - return ResourceManager.GetString("VSTHRD114_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Specify 'SynchronizationContext.Current' explicitly. - /// - internal static string VSTHRD115_CodeFix_Suppress_Title { - get { - return ResourceManager.GetString("VSTHRD115_CodeFix_Suppress_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use 'JoinableTaskContext.CreateNoOpContext' instead.. - /// - internal static string VSTHRD115_CodeFix_UseFactory_Title { - get { - return ResourceManager.GetString("VSTHRD115_CodeFix_UseFactory_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid creating JoinableTaskContext with 'null' as the value for the SynchronizationContext because behavior varies by the value of SynchronizationContext.Current. - /// - internal static string VSTHRD115_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD115_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid creating JoinableTaskContext with null SynchronizationContext. - /// - internal static string VSTHRD115_Title { - get { - return ResourceManager.GetString("VSTHRD115_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use "Async" suffix in names of methods that return an awaitable type. - /// - internal static string VSTHRD200_AddAsync_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD200_AddAsync_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Rename to {0}. - /// - internal static string VSTHRD200_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD200_CodeFix_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Avoid "Async" suffix in names of methods that do not return an awaitable type. - /// - internal static string VSTHRD200_RemoveAsync_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD200_RemoveAsync_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Use "Async" suffix for async methods. - /// - internal static string VSTHRD200_Title { - get { - return ResourceManager.GetString("VSTHRD200_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Call ThrowIfCancellationRequested(). - /// - internal static string VSTHRD201_CodeFix_Title { - get { - return ResourceManager.GetString("VSTHRD201_CodeFix_Title", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Check for cancellation after calling SwitchToMainThreadAsync(CancellationToken).. - /// - internal static string VSTHRD201_MessageFormat { - get { - return ResourceManager.GetString("VSTHRD201_MessageFormat", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Check cancellation after SwitchToMainThreadAsync. - /// - internal static string VSTHRD201_Title { - get { - return ResourceManager.GetString("VSTHRD201_Title", resourceCulture); - } - } - } -} diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index e79d5de78..a83aa0770 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -14,23 +14,6 @@ $(TargetFrameworks);net8.0-windows true - - - ResXFileCodeGenerator - Strings.Designer.cs - - - Strings.resx - - - - - - True - True - Strings.resx - - @@ -44,25 +27,18 @@ - - - + + + - + - + diff --git a/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs b/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs deleted file mode 100644 index 68184f498..000000000 --- a/src/Microsoft.VisualStudio.Threading/Strings.Designer.cs +++ /dev/null @@ -1,287 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Microsoft.VisualStudio.Threading; -using System; - - -/// -/// A strongly-typed resource class, for looking up localized strings, etc. -/// -// This class was auto-generated by the StronglyTypedResourceBuilder -// class via a tool like ResGen or Visual Studio. -// To add or remove a member, edit your .ResX file then rerun ResGen -// with the /str option, or rebuild your VS project. -[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] -[global::System.Diagnostics.DebuggerNonUserCodeAttribute()] -[global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] -internal class Strings { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal Strings() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Microsoft.VisualStudio.Threading.Strings", typeof(Strings).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to Acquiring locks on threads with a SynchronizationContext applied is not allowed.. - /// - internal static string AppliedSynchronizationContextNotAllowed { - get { - return ResourceManager.GetString("AppliedSynchronizationContextNotAllowed", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to A non-upgradeable read lock is held by the caller and cannot be upgraded.. - /// - internal static string CannotUpgradeNonUpgradeableLock { - get { - return ResourceManager.GetString("CannotUpgradeNonUpgradeableLock", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Dangerous request for read lock from fork of write lock.. - /// - internal static string DangerousReadLockRequestFromWriteLockFork { - get { - return ResourceManager.GetString("DangerousReadLockRequestFromWriteLockFork", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This instance must be pushed first.. - /// - internal static string FrameMustBePushedFirst { - get { - return ResourceManager.GetString("FrameMustBePushedFirst", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Already transitioned to the Completed state.. - /// - internal static string InvalidAfterCompleted { - get { - return ResourceManager.GetString("InvalidAfterCompleted", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This operation can only be executed against a valid lock.. - /// - internal static string InvalidLock { - get { - return ResourceManager.GetString("InvalidLock", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to A lock is required.. - /// - internal static string InvalidWithoutLock { - get { - return ResourceManager.GetString("InvalidWithoutLock", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to JoinableTask does not belong to the context this collection was instantiated with.. - /// - internal static string JoinableTaskContextAndCollectionMismatch { - get { - return ResourceManager.GetString("JoinableTaskContextAndCollectionMismatch", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This node already registered.. - /// - internal static string JoinableTaskContextNodeAlreadyRegistered { - get { - return ResourceManager.GetString("JoinableTaskContextNodeAlreadyRegistered", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Lazily created value faulted during construction.. - /// - internal static string LazyValueFaulted { - get { - return ResourceManager.GetString("LazyValueFaulted", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Lazily created value not yet constructed.. - /// - internal static string LazyValueNotCreated { - get { - return ResourceManager.GetString("LazyValueNotCreated", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This lock has already been marked for completion. No new top-level locks can be serviced.. - /// - internal static string LockCompletionAlreadyRequested { - get { - return ResourceManager.GetString("LockCompletionAlreadyRequested", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Multiple continuations are not supported.. - /// - internal static string MultipleContinuationsNotSupported { - get { - return ResourceManager.GetString("MultipleContinuationsNotSupported", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This operation is not allowed while holding an active upgradeable read or write lock from an AsyncReaderWriterLock.. - /// - internal static string NotAllowedUnderURorWLock { - get { - return ResourceManager.GetString("NotAllowedUnderURorWLock", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Message pump can only be run from the original thread.. - /// - internal static string PushFromWrongThread { - get { - return ResourceManager.GetString("PushFromWrongThread", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to The queue is empty.. - /// - internal static string QueueEmpty { - get { - return ResourceManager.GetString("QueueEmpty", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Semaphore is already held and reentrancy setting is '{0}'.. - /// - internal static string SemaphoreAlreadyHeld { - get { - return ResourceManager.GetString("SemaphoreAlreadyHeld", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This semaphore has been misused and can no longer be used.. - /// - internal static string SemaphoreMisused { - get { - return ResourceManager.GetString("SemaphoreMisused", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Nested semaphore requests must be released in LIFO order when the reentrancy setting is: '{0}'. - /// - internal static string SemaphoreStackNestingViolated { - get { - return ResourceManager.GetString("SemaphoreStackNestingViolated", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This operation cannot be completed on an STA thread.. - /// - internal static string STAThreadCallerNotAllowed { - get { - return ResourceManager.GetString("STAThreadCallerNotAllowed", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to An attempt to switch to the main thread failed to reach the expected thread. Was the JoinableTaskContext initialized on the wrong thread or with a SynchronizationContext whose Post method does not execute its delegate on the main thread?. - /// - internal static string SwitchToMainThreadFailedToReachExpectedThread { - get { - return ResourceManager.GetString("SwitchToMainThreadFailedToReachExpectedThread", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to This frame has already been used with a different instance.. - /// - internal static string SyncContextFrameMismatchedAffinity { - get { - return ResourceManager.GetString("SyncContextFrameMismatchedAffinity", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to No SynchronizationContext to reach the main thread has been set.. - /// - internal static string SyncContextNotSet { - get { - return ResourceManager.GetString("SyncContextNotSet", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to The value factory has called for the value on the same instance.. - /// - internal static string ValueFactoryReentrancy { - get { - return ResourceManager.GetString("ValueFactoryReentrancy", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Write lock out-lived by a nested read lock, which is not allowed.. - /// - internal static string WriteLockOutlived { - get { - return ResourceManager.GetString("WriteLockOutlived", resourceCulture); - } - } -} From 4d615814c29a3c0ee3afe920d0b2fd23da5e3082 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jan 2025 14:59:44 -0700 Subject: [PATCH 1205/1753] Touch-up PublicAPI.Shipped for net8.0 --- .../net8.0-windows/PublicAPI.Shipped.txt | 2 +- .../net8.0/PublicAPI.Shipped.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt index f137c98ce..0b970c427 100644 --- a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt @@ -354,7 +354,7 @@ override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransi override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int +override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(nint[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void diff --git a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt index 4c48319b5..697cc803c 100644 --- a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt @@ -353,7 +353,7 @@ override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransi override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int +override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(nint[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void From 3d25ab8da4bf2ad4f91ca5eca0ba321aef77ef54 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jan 2025 21:15:58 -0700 Subject: [PATCH 1206/1753] Disable tests that fail and filed #1364 to track --- .../VSTHRD010MainThreadUsageAnalyzerTests.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs index 01c3a3a5c..090aaf35e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs @@ -215,7 +215,7 @@ class Test { }.RunAsync(); } - [Fact] + [Fact(Skip = "Started failing after CodeAnalysis upgrade that caught a bug in the code fix. #1364")] public async Task TransitiveNoCheck_InCtor() { var test = @" @@ -522,7 +522,7 @@ void VerifyOnUIThread() { await CSVerify.VerifyAnalyzerAsync(test, expected); } - [Fact] + [Fact(Skip = "Started failing after CodeAnalysis upgrade that caught a bug in the code fix. #1364")] public async Task RequiresUIThreadTransitive_MultipleInMember() { var test = @" From 40d7bfaea086be791e961a80d34881d0f38f4659 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 12 Jan 2025 08:57:59 -0700 Subject: [PATCH 1207/1753] Fix bad merge --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index af8184e2e..ea2668148 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -44,7 +44,7 @@ - + From 552a5bf29722e67f8b8cc48ffa4f9cef756cb1e4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Jan 2025 10:11:21 -0700 Subject: [PATCH 1208/1753] Rollback xunit runner to avoid delay-signed assembly load failures See https://github.com/xunit/xunit/issues/3130 --- .github/renovate.json | 4 ++++ Directory.Packages.props | 4 ++-- test/IsolatedTestHost/App.config | 10 ++++++++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/.github/renovate.json b/.github/renovate.json index c140014f9..bc386d899 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -12,6 +12,10 @@ "matchPackageNames": ["xunit*"], "groupName": "xunit" }, + { + "matchPackageNames": ["xunit.runner.visualstudio"], + "allowedVersions": "<3.0" + }, { "matchDatasources": ["dotnet-version", "docker"], "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], diff --git a/Directory.Packages.props b/Directory.Packages.props index ec1485117..6a4ea894e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -46,8 +46,8 @@ - - + + diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index f899e7a15..0431432a8 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -1,6 +1,12 @@  + + + + + + @@ -10,13 +16,13 @@ - + - + From 48ff6ea445004c5b71c7e89eba5ceb7381871961 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Jan 2025 15:11:33 -0700 Subject: [PATCH 1209/1753] Bump MicroBuildInsertVsPayload to v5 --- azure-pipelines/OptProf.yml | 2 +- azure-pipelines/vs-insertion.yml | 2 +- azure-pipelines/vs-validation.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index b196e3450..a70b93629 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -90,7 +90,7 @@ stages: packagesToPush: $(Agent.TempDirectory)/VSInsertion-Windows/*.nupkg publishVstsFeed: 97a41293-2972-4f48-8c0e-05493ae82010 # VS feed allowPackageConflicts: true - - task: MicroBuildInsertVsPayload@4 + - task: MicroBuildInsertVsPayload@5 displayName: Insert VS Payload inputs: TeamName: $(TeamName) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index add241f0b..f89987367 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -54,7 +54,7 @@ extends: packageParentPath: $(Pipeline.Workspace)/CI/VSInsertion-Windows allowPackageConflicts: true publishVstsFeed: VS - - task: MicroBuildInsertVsPayload@4 + - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: TeamName: $(TeamName) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index eded83194..2a0f0900f 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -87,7 +87,7 @@ extends: packageParentPath: $(Pipeline.Workspace)/VSInsertion-Windows allowPackageConflicts: true publishVstsFeed: VS - - task: MicroBuildInsertVsPayload@4 + - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: TeamName: $(TeamName) From 8819ea6092146216ee27258b321e1be5604b6caa Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Jan 2025 19:40:30 -0700 Subject: [PATCH 1210/1753] Replace github build workflow with just docfx validation --- .github/workflows/build.yml | 72 ----------------------------- .github/workflows/docs_validate.yml | 22 +++++++++ 2 files changed, 22 insertions(+), 72 deletions(-) delete mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/docs_validate.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 7617cd99b..000000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,72 +0,0 @@ -name: 🏭 Build - -on: - push: - branches: - - main - - 'v*.*' - - microbuild - - validate/* - pull_request: - workflow_dispatch: - -env: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - BUILDCONFIGURATION: Release - # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ - NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages/ - -jobs: - build: - name: 🏭 Build - - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false - matrix: - os: - - ubuntu-22.04 - - macos-14 - - windows-2022 - - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: | - ./init.ps1 -UpgradePrerequisites - dotnet --info - - # Print mono version if it is present. - if (Get-Command mono -ErrorAction SilentlyContinue) { - mono --version - } - shell: pwsh - - name: ⚙️ Set pipeline variables based on source - run: tools/variables/_define.ps1 - shell: pwsh - - name: 🛠 build - run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - - name: 🧪 test - run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} - shell: pwsh - - name: 💅🏻 Verify formatted code - run: dotnet format --verify-no-changes --no-restore - shell: pwsh - if: runner.os == 'Linux' - - name: 📚 Verify docfx build - run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures - if: runner.os == 'Linux' - - name: ⚙ Update pipeline variables based on build outputs - run: tools/variables/_define.ps1 - shell: pwsh - - name: 📢 Publish artifacts - uses: ./.github/actions/publish-artifacts - if: cancelled() == false - - name: 📢 Publish code coverage results to codecov.io - run: ./tools/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" - shell: pwsh - timeout-minutes: 3 - continue-on-error: true - if: env.codecov_token != '' diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml new file mode 100644 index 000000000..9be82c566 --- /dev/null +++ b/.github/workflows/docs_validate.yml @@ -0,0 +1,22 @@ +name: 📃 Docfx Validate + +on: + pull_request: + workflow_dispatch: + +jobs: + build: + name: 📚 docfx + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites + dotnet --info + shell: pwsh + - name: 📚 Verify docfx build + run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures + if: runner.os == 'Linux' From 84258fcadc61a58d352d064dbeab7fb62370db4b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2025 07:15:57 -0700 Subject: [PATCH 1211/1753] Adapt to breaking change in MicroBuildInsertVsPayload@5 --- azure-pipelines/vs-insertion.yml | 2 +- azure-pipelines/vs-validation.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index f89987367..6aaba41cf 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -60,7 +60,7 @@ extends: TeamName: $(TeamName) TeamEmail: $(TeamEmail) InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) - InsertionBuildPolicy: Request Perf DDRITs + InsertionBuildPolicies: Request Perf DDRITs InsertionReviewers: $(Build.RequestedFor) # Append `,Your team name` (without quotes) AutoCompletePR: true AutoCompleteMergeStrategy: Squash diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 2a0f0900f..2fa5086d0 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -96,7 +96,7 @@ extends: InsertionDescription: | This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 - InsertionBuildPolicy: Request Perf DDRITs + InsertionBuildPolicies: Request Perf DDRITs InsertionReviewers: $(Build.RequestedFor) DraftPR: false # set to true and update InsertionBuildPolicy when we can specify all the validations we want to run (https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2224288) AutoCompletePR: false From 5a6c72d984bfd5baef7a70f77010905dbc9b9d00 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2025 08:39:06 -0700 Subject: [PATCH 1212/1753] Bring back Dependabot --- .github/dependabot.yml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..a7a1782f5 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,21 @@ +# Please see the documentation for all configuration options: +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: +- package-ecosystem: nuget + directory: / + schedule: + interval: weekly + groups: + nerdbank-gitversioning: + patterns: + - nbgv + - nerdbank.gitversioning + xunit: + patterns: + - 'xunit*' +- package-ecosystem: dotnet-sdk + directory: / + schedule: + interval: monthly From b7e0687b34f93892a9418ae182770f23d8f21826 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2025 08:56:19 -0700 Subject: [PATCH 1213/1753] Bring back dependabot --- .github/dependabot.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a7a1782f5..bc0b45c86 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -19,3 +19,7 @@ updates: directory: / schedule: interval: monthly + ignore: + - dependency-name: Microsoft.CodeAnalysis* # We intentionally target older VS versions. + - dependency-name: Microsoft.Bcl.AsyncInterfaces # We want to match the minimum target .NET runtime + - dependency-name: System.Collections.Immutable # We want to match the minimum target .NET runtime From 862f998b734e016e71fa5045909e64208de05437 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2025 11:52:44 -0700 Subject: [PATCH 1214/1753] Fix Install-NuGetPackage.ps1 script --- azure-pipelines/Install-NuGetPackage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/azure-pipelines/Install-NuGetPackage.ps1 index 9afde0550..f1db577ab 100644 --- a/azure-pipelines/Install-NuGetPackage.ps1 +++ b/azure-pipelines/Install-NuGetPackage.ps1 @@ -33,7 +33,7 @@ Param( [string]$Verbosity='normal' ) -$nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" +$nugetPath = & "$PSScriptRoot\..\tools\Get-NuGetTool.ps1" try { Write-Verbose "Installing $PackageId..." From d1583877d80f8b6447cfc22986391b4e54e7b780 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Tue, 14 Jan 2025 11:06:13 -0800 Subject: [PATCH 1215/1753] Create a separate unofficial.yml pipeline (#334) --- Expand-Template.ps1 | 2 +- azure-pipelines/apiscan.yml | 8 ++ azure-pipelines/build.yml | 1 + azure-pipelines/official.yml | 129 +++++++++++---------------------- azure-pipelines/unofficial.yml | 90 +++++++++++++++++++++++ 5 files changed, 141 insertions(+), 89 deletions(-) create mode 100644 azure-pipelines/unofficial.yml diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 0bc5f440e..9ba1f04ef 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -156,7 +156,7 @@ try { $YmlReplacements = @{ "(?m)^\s+- microbuild`r?`n"="" } - Replace-Placeholders -Path "azure-pipelines\official.yml" -Replacements $YmlReplacements + Replace-Placeholders -Path "azure-pipelines\unofficial.yml" -Replacements $YmlReplacements Replace-Placeholders -Path "azure-pipelines.yml" -Replacements $YmlReplacements $YmlReplacements = @{} diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index af78f15c0..c3c8aed16 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -1,6 +1,8 @@ parameters: - name: windowsPool type: object +- name: RealSign + type: boolean jobs: - job: apiscan @@ -9,6 +11,12 @@ jobs: pool: ${{ parameters.windowsPool }} timeoutInMinutes: 120 templateContext: + ${{ if not(parameters.RealSign) }}: + mb: + signing: # if the build is test-signed, install the signing plugin so that CSVTestSignPolicy.xml is available + enabled: true + zipSources: false + signType: test outputs: - output: pipelineArtifact displayName: 📢 collect apiscan artifact diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 279c10a63..1a8305867 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -313,3 +313,4 @@ jobs: - template: apiscan.yml parameters: windowsPool: ${{ parameters.windowsPool }} + RealSign: ${{ parameters.RealSign }} diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 35beb818c..a9b5b81ef 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -1,17 +1,5 @@ -trigger: - batch: true - branches: - include: - - main - - microbuild - - 'validate/*' - paths: - exclude: - - doc/ - - '*.md' - - .vscode/ - - azure-pipelines/release.yml - - azure-pipelines/vs-insertion.yml +trigger: none # We only want to trigger manually or based on a schedule +pr: none #schedules: #- cron: "0 3 * * *" # Daily @ 8 PM PST # displayName: Daily vs-insertion @@ -23,10 +11,6 @@ parameters: # As an entrypoint pipeline yml file, all parameters here show up in the Queue Run dialog. # If any paramaters should NOT be queue-time options, they should be removed from here # and references to them in this file replaced with hard-coded values. -- name: ForceOfficialBuild - displayName: Official build (sign, compliance, etc.) - type: boolean - default: false # this should remain false so PR builds using this pipeline are unofficial # - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. # displayName: Skip OptProf optimization # type: boolean @@ -55,75 +39,44 @@ variables: - template: GlobalVariables.yml extends: - ${{ if or(parameters.ForceOfficialBuild, eq(variables['Build.Reason'],'Schedule')) }}: - template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate - parameters: - sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES - codeSignValidation: - enabled: true - break: true - additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** - policheck: - enabled: true - exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml - suppression: - suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress - sbom: - enabled: true - stages: - - stage: Build - variables: - - template: /azure-pipelines/BuildStageVariables.yml@self - jobs: - - template: /azure-pipelines/build.yml@self - parameters: - Is1ESPT: true - RealSign: true - # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - EnableAPIScan: ${{ and(parameters.EnableAPIScan, ne(variables['Build.Reason'], 'pullRequest')) }} - windowsPool: VSEngSS-MicroBuild2022-1ES - linuxPool: - name: AzurePipelines-EO - demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 - os: Linux - macOSPool: - name: Azure Pipelines - vmImage: macOS-14 - os: macOS - EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - RunTests: ${{ parameters.RunTests }} - - template: /azure-pipelines/prepare-insertion-stages.yml@self + template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate + parameters: + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + codeSignValidation: + enabled: true + break: true + additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** + policheck: + enabled: true + exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml + suppression: + suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress + sbom: + enabled: true + stages: + - stage: Build + variables: + - template: /azure-pipelines/BuildStageVariables.yml@self + jobs: + - template: /azure-pipelines/build.yml@self parameters: + Is1ESPT: true RealSign: true - ${{ else }}: - template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate - parameters: - sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES - suppression: - suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress - stages: - - stage: Build - variables: - - template: /azure-pipelines/BuildStageVariables.yml@self - jobs: - - template: /azure-pipelines/build.yml@self - parameters: - Is1ESPT: true - RealSign: false - # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - EnableAPIScan: false - windowsPool: VSEngSS-MicroBuild2022-1ES - linuxPool: - name: AzurePipelines-EO - demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 - os: Linux - macOSPool: - name: Azure Pipelines - vmImage: macOS-14 - os: macOS - EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - RunTests: ${{ parameters.RunTests }} + # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + EnableAPIScan: ${{ parameters.EnableAPIScan }} + windowsPool: VSEngSS-MicroBuild2022-1ES + linuxPool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals 1ESPT-Ubuntu22.04 + os: Linux + macOSPool: + name: Azure Pipelines + vmImage: macOS-14 + os: macOS + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} + RunTests: ${{ parameters.RunTests }} + - template: /azure-pipelines/prepare-insertion-stages.yml@self + parameters: + RealSign: true diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml new file mode 100644 index 000000000..afce810bf --- /dev/null +++ b/azure-pipelines/unofficial.yml @@ -0,0 +1,90 @@ +trigger: + batch: true + branches: + include: + - main + - microbuild + - 'validate/*' + paths: + exclude: + - doc/ + - '*.md' + - .vscode/ + - azure-pipelines/release.yml + - azure-pipelines/vs-insertion.yml + +parameters: +# As an entrypoint pipeline yml file, all parameters here show up in the Queue Run dialog. +# If any paramaters should NOT be queue-time options, they should be removed from here +# and references to them in this file replaced with hard-coded values. +# - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. +# displayName: Skip OptProf optimization +# type: boolean +# default: false +- name: EnableMacOSBuild + displayName: Build on macOS + type: boolean + default: false # macOS is often bogged down in Azure Pipelines +- name: RunTests + displayName: Run tests + type: boolean + default: true +- name: EnableAPIScan + displayName: Include APIScan with compliance tools + type: boolean + default: false +- name: EnableProductionSDL + displayName: Enable Production SDL + type: boolean + default: false + +resources: + repositories: + - repository: MicroBuildTemplate + type: git + name: 1ESPipelineTemplates/MicroBuildTemplate + ref: refs/tags/release + +variables: +- template: GlobalVariables.yml + +extends: + template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate + parameters: + sdl: + sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + suppression: + suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress + enableProductionSDL: ${{ parameters.EnableProductionSDL }} + codeSignValidation: + enabled: ${{ parameters.EnableProductionSDL }} + break: true + policyFile: $(MBSIGN_APPFOLDER)\CSVTestSignPolicy.xml + policheck: + enabled: ${{ parameters.EnableProductionSDL }} + exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml + sbom: + enabled: ${{ parameters.EnableProductionSDL }} + stages: + - stage: Build + variables: + - template: /azure-pipelines/BuildStageVariables.yml@self + jobs: + - template: /azure-pipelines/build.yml@self + parameters: + Is1ESPT: true + RealSign: false + # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + EnableAPIScan: ${{ parameters.EnableAPIScan }} + windowsPool: VSEngSS-MicroBuild2022-1ES + linuxPool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals 1ESPT-Ubuntu22.04 + os: Linux + macOSPool: + name: Azure Pipelines + vmImage: macOS-14 + os: macOS + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} + RunTests: ${{ parameters.RunTests }} From 2545e3021b61162d5f23b4b41e7405f1b25dbbfb Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Tue, 14 Jan 2025 13:18:08 -0800 Subject: [PATCH 1216/1753] Add back signcheck exclusion for unofficial builds --- azure-pipelines/unofficial.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index afce810bf..ff3c2b5d7 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -59,6 +59,7 @@ extends: codeSignValidation: enabled: ${{ parameters.EnableProductionSDL }} break: true + additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** policyFile: $(MBSIGN_APPFOLDER)\CSVTestSignPolicy.xml policheck: enabled: ${{ parameters.EnableProductionSDL }} From 8c45970cd587e8923048ebef3db71ad559a870a3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 14 Jan 2025 18:21:19 -0700 Subject: [PATCH 1217/1753] Update Dockerfile and global.json updates to v9.0.102 (#340) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 3674e182a..6952a419f 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.101-noble +FROM mcr.microsoft.com/dotnet/sdk:9.0.102-noble # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index f3e0b3239..119eff7ee 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.101", + "version": "9.0.102", "rollForward": "patch", "allowPrerelease": false } From 25d6df9315be95115c164411a39ee242b29de0ed Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 14 Jan 2025 18:27:14 -0700 Subject: [PATCH 1218/1753] Migrate xunit settings from app.config to xunit.runner.json --- test/Directory.Build.targets | 4 ++++ test/Library.Tests/app.config | 5 ----- test/Library.Tests/xunit.runner.json | 4 ++++ 3 files changed, 8 insertions(+), 5 deletions(-) delete mode 100644 test/Library.Tests/app.config create mode 100644 test/Library.Tests/xunit.runner.json diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index a6e0f4ace..9f32cd061 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,4 +1,8 @@ + + + + diff --git a/test/Library.Tests/app.config b/test/Library.Tests/app.config deleted file mode 100644 index 61890f055..000000000 --- a/test/Library.Tests/app.config +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/test/Library.Tests/xunit.runner.json b/test/Library.Tests/xunit.runner.json new file mode 100644 index 000000000..8465a4543 --- /dev/null +++ b/test/Library.Tests/xunit.runner.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://xunit.net/schema/current/xunit.runner.schema.json", + "shadowCopy": false +} From b9f8bc9561e76aa68cac7e4ec41ece0364c123a0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jan 2025 10:05:41 -0700 Subject: [PATCH 1219/1753] Fix typo --- .github/workflows/libtemplate-update.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index c6b8fb4ab..53df80ffa 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -45,7 +45,7 @@ jobs: # Pushing commits that add or change files under .github/workflows will cause our workflow to fail. # But it usually isn't necessary because the target branch already has (or doesn't have) these changes. - # So if the merged doesn't bring in any changes to these files, try the merge locally and push that + # So if the merge doesn't bring in any changes to these files, try the merge locally and push that # to keep github happy. if ((git rev-list FETCH_HEAD ^HEAD --count -- .github/workflows) -eq 0) { # Indeed there are no changes in that area. So merge locally to try to appease GitHub. From a4d20fe4bd5337a9173c5d9751c421db279c6b36 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 16 Jan 2025 09:27:38 -0700 Subject: [PATCH 1220/1753] Bump MicroBuildVersion from 2.0.165 to 2.0.171 (#1366) Bumps `MicroBuildVersion` from 2.0.165 to 2.0.171. Updates `Microsoft.VisualStudio.Internal.MicroBuild.NonShipping` from 2.0.165 to 2.0.171 Updates `Microsoft.VisualStudio.Internal.MicroBuild.VisualStudio` from 2.0.165 to 2.0.171 --- updated-dependencies: - dependency-name: Microsoft.VisualStudio.Internal.MicroBuild.NonShipping dependency-type: direct:production update-type: version-update:semver-patch - dependency-name: Microsoft.VisualStudio.Internal.MicroBuild.VisualStudio dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6a4ea894e..acab4a27b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.0.165 + 2.0.171 3.11.0 4.4.0 1.1.2 From df5243521eabba1568f50f15e503d1e2dda0ee78 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 18 Jan 2025 10:36:33 -0700 Subject: [PATCH 1221/1753] Add GitS sponsorship badge --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 610e65049..f7a79262f 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ ![GitHub Actions status](https://github.com/aarnott/Library.Template/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/aarnott/library.template/branch/main/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) +[](https://api.gitsponsors.com/api/badge/link?p=MCQ+F+FQ4qDG3aB7nxcFJ9OIaaCARvdUdn6994QBDixzmF6GkU1V7l/Zk+7MwNTbZGdGMw06hyJAs80v04cpo08nYPaOeWn9BMLwruCMqnmr8AoX5dTC4OcDg3r1juk0nocxT2n22yvq8MyXIS32EQ==) + ## Features * Follow the best and simplest patterns of build, pack and test with dotnet CLI. From 02bf9eeae2ac8aa8b3efe3641ec46eee8d9c3529 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 Jan 2025 07:13:46 -0700 Subject: [PATCH 1222/1753] Revert "Add GitS sponsorship badge" This reverts commit df5243521eabba1568f50f15e503d1e2dda0ee78. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f7a79262f..610e65049 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ ![GitHub Actions status](https://github.com/aarnott/Library.Template/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/aarnott/library.template/branch/main/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) -[](https://api.gitsponsors.com/api/badge/link?p=MCQ+F+FQ4qDG3aB7nxcFJ9OIaaCARvdUdn6994QBDixzmF6GkU1V7l/Zk+7MwNTbZGdGMw06hyJAs80v04cpo08nYPaOeWn9BMLwruCMqnmr8AoX5dTC4OcDg3r1juk0nocxT2n22yvq8MyXIS32EQ==) - ## Features * Follow the best and simplest patterns of build, pack and test with dotnet CLI. From edbe3ce397dd88c2c76f65ca7da277a0f8d23649 Mon Sep 17 00:00:00 2001 From: "CSIGS@microsoft.com" Date: Mon, 20 Jan 2025 06:17:17 -0800 Subject: [PATCH 1223/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20250119124922653. (#1374) --- loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- 11 files changed, 66 insertions(+), 22 deletions(-) diff --git a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl index ac93c5c50..ac73bf92b 100644 --- a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl index 46e8b57ed..924e2e177 100644 --- a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl index 3f6bee444..c3c0a1a9b 100644 --- a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl index 16cd9e1ef..f7b2ef7c5 100644 --- a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl index bc0cee074..ca2b9dd3b 100644 --- a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl index 047eb98af..193ed219d 100644 --- a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl index f234ff8ff..fe0959ec7 100644 --- a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl index 879234905..bfebdc509 100644 --- a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl index 91e3d4e8c..2f067b9d1 100644 --- a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl index 9b966d5d3..25efb16b5 100644 --- a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl index 24280f33a..8aaf728c9 100644 --- a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + From 53e65075c6d4788cef17f15386200910022a6f51 Mon Sep 17 00:00:00 2001 From: "CSIGS@microsoft.com" Date: Mon, 20 Jan 2025 06:17:37 -0800 Subject: [PATCH 1224/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20250120125111625. (#1379) --- loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl index c07887dbf..eba9d85dc 100644 --- a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + diff --git a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl index 682523e2f..50982085b 100644 --- a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl @@ -3,6 +3,7 @@ + @@ -244,10 +245,13 @@ - + - + + + + From ae6b0564c0420cb560b393f059fe1fecc9a2feb1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Jan 2025 15:40:27 -0700 Subject: [PATCH 1225/1753] Publish WinDBG extension to azure-public/vs-impl --- azure-pipelines/prepare-insertion-stages.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index ff752cd6e..1acbc5f2f 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -38,7 +38,7 @@ stages: - ${{ if parameters.PackagePush }}: - job: push ${{ if parameters.RealSign }}: - displayName: azure-public/vssdk feed + displayName: azure-public feeds ${{ else }}: displayName: devdiv/vs-impl feed # Leave this as-is, since non-signed builds must not be pushed to public feeds. ${{ if parameters.ArchiveSymbols }}: @@ -61,6 +61,17 @@ stages: ${{ else }}: nuGetFeedType: internal publishVstsFeed: vs-impl # Leave this as-is, since non-signed builds must not be pushed to public feeds. + - output: nuget + displayName: 📦 Push WinDBG extension + packagesToPush: '$(Pipeline.Workspace)/deployables-Windows/WinDBGGallery/*.nupkg' + packageParentPath: $(Pipeline.Workspace)/deployables-Windows/WinDBGGallery + allowPackageConflicts: true + ${{ if parameters.RealSign }}: + nuGetFeedType: external + publishFeedCredentials: azure-public/vs-impl + ${{ else }}: + nuGetFeedType: internal + publishVstsFeed: vs-impl # Leave this as-is, since non-signed builds must not be pushed to public feeds. steps: - checkout: none - download: current @@ -76,3 +87,7 @@ stages: parameters: wifServiceConnectionName: azure-public/vside package push deadPATServiceConnectionId: 42175e93-c771-4a4f-a132-3cca78f44b3b # azure-public/vssdk + - template: WIFtoPATauth.yml + parameters: + wifServiceConnectionName: azure-public/vside package push + deadPATServiceConnectionId: 207efd62-fd0f-43e7-aeae-17c4febcc660 # azure-public/vs-impl From aa8e87054f2ad8fb64a0de043f39b959a7e5ce51 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 23 Jan 2025 16:14:15 -0700 Subject: [PATCH 1226/1753] Update dependency powershell to 7.5.0 (#341) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 3a7b9b698..1b8c58cef 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.4.6", + "version": "7.5.0", "commands": [ "pwsh" ], From 37306430894c3d18854bbdc8dcb0b0c228b588d8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Jan 2025 22:39:45 -0700 Subject: [PATCH 1227/1753] Bump all microbuild packages at once --- .github/renovate.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index c140014f9..556029478 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -16,6 +16,10 @@ "matchDatasources": ["dotnet-version", "docker"], "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], "groupName": "Dockerfile and global.json updates" + }, + { + "matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"], + "groupName": "microbuild" } ] } From 66fe1ca6c9d3c86887bccd2c550d92587f27b2da Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 08:28:00 -0700 Subject: [PATCH 1228/1753] Add markup link checker to GitHub workflow --- .github/workflows/build.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5b4fc7beb..2d9510620 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -69,3 +69,13 @@ jobs: timeout-minutes: 3 continue-on-error: true if: env.codecov_token != '' + + docs: + name: 📃 Docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: 🔗 Markup Link Checker (mlc) + uses: becheran/mlc@v0.19.0 + with: + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From b3b3da2f87f080d451e7514865717c7cd6540ecd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 08:35:34 -0700 Subject: [PATCH 1229/1753] Fix stale link in CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77f5e0a3b..56dd666f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ You should install the version specified in `global.json` or a later version wit the same major.minor.Bxx "hundreds" band. For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.310 while the 2.2.400 version would not be considered compatible by .NET SDK. -See [.NET Core Versioning](https://docs.microsoft.com/dotnet/core/versions/) for more information. +See [.NET Core Versioning](https://learn.microsoft.com/dotnet/core/versions/) for more information. ## Package restore @@ -44,7 +44,7 @@ Building, testing, and packing this repository can be done by using the standard ## Releases Use `nbgv tag` to create a tag for a particular commit that you mean to release. -[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/doc/nbgv-cli.md). +[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://dotnet.github.io/Nerdbank.GitVersioning/docs/nbgv-cli.html). Push the tag. From 1da386324a06ce360c03270dd19c01133270c4c0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 09:25:14 -0700 Subject: [PATCH 1230/1753] Skip aka.ms links that don't validate --- .github/workflows/docs_validate.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 07dd8b9a5..d1c8b8fb8 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -6,7 +6,7 @@ on: jobs: build: - name: 📚 docfx + name: 📚 Doc validation runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 @@ -15,7 +15,7 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@v0.19.0 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc - name: ⚙ Install prerequisites run: | ./init.ps1 -UpgradePrerequisites From bdaf0accaa2bbf78fd618f20d2df2abf4c842a9e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 09:46:34 -0700 Subject: [PATCH 1231/1753] Fix broken link --- .github/workflows/docs_validate.yml | 2 +- doc/analyzers/editorconfigs/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index d1c8b8fb8..4b3d4076b 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -15,7 +15,7 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@v0.19.0 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc,https://microsoft.sharepoint.com/* - name: ⚙ Install prerequisites run: | ./init.ps1 -UpgradePrerequisites diff --git a/doc/analyzers/editorconfigs/README.md b/doc/analyzers/editorconfigs/README.md index d5e54ba4e..cc2e2366a 100644 --- a/doc/analyzers/editorconfigs/README.md +++ b/doc/analyzers/editorconfigs/README.md @@ -25,7 +25,7 @@ While several project types have specific .editorconfig files defined in this fo Libraries that may run in any process, whether they have a main thread or not, should code themselves defensively to avoid any dependency on the main thread so that applications that do not follow `JoinableTaskFactory` rules can avoid deadlocks even when synchronously blocking their main thread using `Task.Wait()` on code running inside your library. In particular, shared libraries of general interest should _always_ use `.ConfigureAwait(false)` when awaiting on tasks. -[Learn more about authoring libraries following best threading practices](../library_with_jtf.md). +[Learn more about authoring libraries following best threading practices](../../library_with_jtf.md). ### Libraries that run inside a JoinableTaskFactory-compliant application From 9409f44674386eb10f9721ecbed1cb1b7aa1e2db Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 14:25:15 -0700 Subject: [PATCH 1232/1753] Bump nuget.exe build tool to 6.12.2 --- tools/Get-NuGetTool.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Get-NuGetTool.ps1 b/tools/Get-NuGetTool.ps1 index 3097c8736..8a3b9eeda 100644 --- a/tools/Get-NuGetTool.ps1 +++ b/tools/Get-NuGetTool.ps1 @@ -6,7 +6,7 @@ #> Param( [Parameter()] - [string]$NuGetVersion='6.4.0' + [string]$NuGetVersion='6.12.2' ) $toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" From 50873c3cd5a272e48722aba7278fdf5acff89ecb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 10:53:58 -0700 Subject: [PATCH 1233/1753] Fix VSTHRD110 false negative in local functions of async methods Fixes #1363 --- .../CommonInterest.cs | 2 +- ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 30 +++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index 42300094c..ef21f9f90 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -279,7 +279,7 @@ public static bool IsAwaitable(this ITypeSymbol? typeSymbol, SemanticModel seman { while (operation?.Parent is not null) { - if (operation.Parent is IAnonymousFunctionOperation or IMethodBodyOperation) + if (operation.Parent is IAnonymousFunctionOperation or IMethodBodyOperation or ILocalFunctionOperation) { return operation.Parent; } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index bae3ec25c..03dfc29b2 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -485,4 +485,34 @@ class Class1 await CSVerify.VerifyAnalyzerAsync(test); } + + [Fact] + public async Task LocalVoidFunctionWithinAsyncTaskMethod() + { + string test = /* lang=c#-test */ """ + using System.Threading.Tasks; + + class Test + { + async Task DoOperationAsync() + { + DoOperationInner(); + + void DoOperationInner() + { + [|HelperAsync()|]; + } + } + + void DoOperation() + { + [|HelperAsync()|]; + } + + Task HelperAsync() => Task.CompletedTask; + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } } From 2636bc1ea12624b374a82ad7dbdf933165ad2760 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 11:06:44 -0700 Subject: [PATCH 1234/1753] Add analyzer test provided by @meziantou in #1363 It isn't clear how to fix this without slowing down the analyzer significantly. As this has not been a highly requested, I'm going to Won't Fix this. Closes #1363 --- ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index bae3ec25c..60f135a5e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -247,6 +247,33 @@ void Bar() { } await CSVerify.VerifyAnalyzerAsync(test, expected); } + [Fact(Skip = "Won't fix")] + public async Task GetAwaiterWithIncompatibleParameters() + { + string test = /* lang=c#-test */ """ + using System; + using System.Collections.Generic; + using System.Runtime.CompilerServices; + using System.Threading.Tasks; + + class Test + { + void Foo() + { + var stack = new Stack<(int, int)>(); + stack.Pop(); + } + } + + internal static class Extensions + { + internal static TaskAwaiter<(T1, T2)> GetAwaiter(this (Task, Task) tasks) => throw new NotImplementedException(); + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task ConfigureAwait_ProducesDiagnostics() { From e25313b90d5f26b11211c61c7adff7f0a94eb4c8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 4 Feb 2025 21:27:02 +0000 Subject: [PATCH 1235/1753] Update becheran/mlc action to v0.19.1 --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2d9510620..42f5a0053 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -76,6 +76,6 @@ jobs: steps: - uses: actions/checkout@v4 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.19.0 + uses: becheran/mlc@v0.19.1 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From 83228fe554696ec1508b2ff3e214832dd4df182e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 14:42:42 -0700 Subject: [PATCH 1236/1753] Suppress an expected doc warning --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 42f5a0053..d3d9d2f87 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -78,4 +78,4 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@v0.19.1 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From 3114358825e4c20cf9d49597c2616c067e25b3f3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 16:06:31 -0700 Subject: [PATCH 1237/1753] Remove dependabot.yml --- .github/dependabot.yml | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index a7a1782f5..000000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,21 +0,0 @@ -# Please see the documentation for all configuration options: -# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file - -version: 2 -updates: -- package-ecosystem: nuget - directory: / - schedule: - interval: weekly - groups: - nerdbank-gitversioning: - patterns: - - nbgv - - nerdbank.gitversioning - xunit: - patterns: - - 'xunit*' -- package-ecosystem: dotnet-sdk - directory: / - schedule: - interval: monthly From 3856c54130c323dd2fa8a48e9fc13eb0c23d8f0c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 4 Feb 2025 16:11:26 -0700 Subject: [PATCH 1238/1753] Update becheran/mlc action to v0.19.2 (#345) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d3d9d2f87..7eb7860e2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -76,6 +76,6 @@ jobs: steps: - uses: actions/checkout@v4 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.19.1 + uses: becheran/mlc@v0.19.2 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From 0d1997f1c15d2bcdabddf283cdf9f3b305aea3d4 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 4 Feb 2025 17:53:50 -0700 Subject: [PATCH 1239/1753] Update MicrosoftDiagnosticsRuntimeVersion to 3.1.525101 (#1388) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index acab4a27b..5dbe0564e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 3.11.0 4.4.0 1.1.2 - 3.1.456501 + 3.1.525101 3.11.0-beta1.24527.2 From dbd8dc24c6acaab31f68fcd65c48ec08bc906cba Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 5 Feb 2025 01:11:58 +0000 Subject: [PATCH 1240/1753] Update dependency DNNE to 2.0.7 (#1391) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 5dbe0564e..7a407cdcc 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ 3.11.0-beta1.24527.2 - + From 399d3d5d8f13ac06a82a58dd50dcd6adf0b96767 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 18:00:20 -0700 Subject: [PATCH 1241/1753] Stick with .NET 8 packages --- .github/renovate.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index 556029478..86c3fe2f9 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -17,6 +17,20 @@ "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], "groupName": "Dockerfile and global.json updates" }, + { + "matchPackageNames": [ + "System.Collections.Immutable", + "System.Composition*", + "System.Diagnostics.DiagnosticSource", + "System.IO.Pipelines", + "System.Reflection.Metadata", + "System.Text.Json", + "System.Threading.Tasks.Dataflow", + "Microsoft.Bcl.AsyncInterfaces" + ], + "allowedVersions": "<9.0", + "groupName": "Included in .NET runtime" + }, { "matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"], "groupName": "microbuild" From 56ac6706a56b22a46358901886e9b679ac6cbee6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 18:01:04 -0700 Subject: [PATCH 1242/1753] Update microbuild to 2.0.181 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 659d9c007..6606c84af 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.171 + 2.0.181 From 37e48d01b7bdd9990b6449cc8d361e94b81fa798 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 18:01:27 -0700 Subject: [PATCH 1243/1753] Update dependency ubuntu to v24 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index d1c8b8fb8..f7125817a 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -7,7 +7,7 @@ on: jobs: build: name: 📚 Doc validation - runs-on: ubuntu-22.04 + runs-on: ubuntu-24.04 steps: - uses: actions/checkout@v4 with: From 28c5968eb57d442d2a9eb82d95c3776069f028fc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 18:12:58 -0700 Subject: [PATCH 1244/1753] Avoid daily updates of VS packages --- .github/renovate.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index 86c3fe2f9..409b27d95 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -34,6 +34,11 @@ { "matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"], "groupName": "microbuild" + }, + { + "matchPackageNames": ["Microsoft.VisualStudio.*"], + "matchUpdateTypes": ["patch"], + "enabled": false } ] } From b4a369cbcf6bf536dbf608d08520b3655d3db046 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 18:15:50 -0700 Subject: [PATCH 1245/1753] Group VS SDK package updates --- .github/renovate.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index 409b27d95..c9d99b7f3 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -35,6 +35,10 @@ "matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"], "groupName": "microbuild" }, + { + "matchPackageNames": ["Microsoft.VisualStudio.*"], + "groupName": "Visual Studio SDK" + }, { "matchPackageNames": ["Microsoft.VisualStudio.*"], "matchUpdateTypes": ["patch"], From 2d06ba40adda405cab7ebab4ace694ee8e40a413 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Feb 2025 21:28:14 -0700 Subject: [PATCH 1246/1753] Update becheran/mlc action to v0.19.2 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 4bf30d423..380cc03c2 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.19.0 + uses: becheran/mlc@v0.19.2 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc - name: ⚙ Install prerequisites From 3305b9fbfd081be683a57dbf197ae3f25d945aa4 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 5 Feb 2025 04:34:24 +0000 Subject: [PATCH 1247/1753] Update dependency Microsoft.Windows.CsWin32 to 0.3.162 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7a407cdcc..91846e5ce 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -31,7 +31,7 @@ - + From 8814c58c417bfbcdf297c3091fed87c4fb55cf8b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 14:28:30 -0700 Subject: [PATCH 1248/1753] Update roslyn for tests, not for our analyzers --- .github/renovate.json | 4 ++++ Directory.Packages.props | 8 +++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/renovate.json b/.github/renovate.json index 28f86245c..b2611c4de 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -47,6 +47,10 @@ "matchPackageNames": ["Microsoft.VisualStudio.*"], "matchUpdateTypes": ["patch"], "enabled": false + }, + { + "matchJsonata": [ "sharedVariableName='CodeAnalysisVersion'" ], + "enabled": false } ] } diff --git a/Directory.Packages.props b/Directory.Packages.props index c8daee982..56ac743c8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ true 2.0.181 3.11.0 - 4.4.0 + 4.4.0 1.1.2 3.1.525101 3.11.0-beta1.24527.2 @@ -43,6 +43,12 @@ + + + + + + From 429e76f7d36b71ad3014c0c9712a238a26bed45b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 14:36:16 -0700 Subject: [PATCH 1249/1753] Fix mlc suppressions for SECURITY.md --- .github/workflows/docs_validate.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 380cc03c2..e100eba60 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -3,6 +3,10 @@ name: 📃 Docfx Validate on: pull_request: workflow_dispatch: + push: + branches: + - main + - microbuild jobs: build: @@ -15,7 +19,7 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@v0.19.2 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc* - name: ⚙ Install prerequisites run: | ./init.ps1 -UpgradePrerequisites From 3b029146569467b7820d34e11c574bd7884d6939 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 15:05:15 -0700 Subject: [PATCH 1250/1753] Fix mlc markdown link errors, warnings --- .github/workflows/docs_validate.yml | 2 +- CONTRIBUTING.md | 2 +- README.md | 4 +- doc/analyzers/VSTHRD010.md | 2 +- doc/threading_rules.md | 144 ++++++++++++++-------------- doc/threadpool_starvation.md | 6 +- 6 files changed, 80 insertions(+), 80 deletions(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index f382684b3..2c298e01b 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -19,7 +19,7 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@v0.19.2 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc*,https://microsoft.sharepoint.com/* + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/*,https://badges.gitter.im/*,https://github.com/*,https://app.gitter.im/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc*,https://microsoft.sharepoint.com/* - name: ⚙ Install prerequisites run: | ./init.ps1 -UpgradePrerequisites diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b72a21042..c3e106809 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ For significant changes we strongly recommend opening an issue to start a design * [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/2.2) with the version matching our [global.json](global.json) file. The version you install must be at least the version specified in the global.json file, and must be within the same hundreds version for the 3rd integer: x.y.Czz (x.y.C must match, and zz must be at least as high). The easiest way to get this is to run the `init` script at the root of the repo. Use the `-InstallLocality Machine` and approve admin elevation if you wish so the SDK is always discoverable from VS. See the `init` script usage doc for more details. -* Optional: [Visual Studio 2019](https://www.visualstudio.com/) +* Optional: [Visual Studio 2022](https://visualstudio.microsoft.com/) The only prerequisite for building, testing, and deploying from this repository is the [.NET SDK](https://get.dot.net/). diff --git a/README.md b/README.md index ba08fea4f..97da5667f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## Microsoft.VisualStudio.Threading -[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Threading) +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.svg)](https://www.nuget.org/packages/Microsoft.VisualStudio.Threading) Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). @@ -15,7 +15,7 @@ Async synchronization primitives, async collections, TPL and dataflow extensions ## Microsoft.VisualStudio.Threading.Analyzers -[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.Analyzers.svg)](https://nuget.org/packages/Microsoft.VisualStudio.Threading.Analyzers) +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.Analyzers.svg)](https://www.nuget.org/packages/Microsoft.VisualStudio.Threading.Analyzers) Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. diff --git a/doc/analyzers/VSTHRD010.md b/doc/analyzers/VSTHRD010.md index 022d76554..bfb01c11d 100644 --- a/doc/analyzers/VSTHRD010.md +++ b/doc/analyzers/VSTHRD010.md @@ -58,4 +58,4 @@ private async Task CallVSAsync() } ``` -Refer to [Asynchronous and multithreaded programming within VS using the JoinableTaskFactory](http://blogs.msdn.com/b/andrewarnottms/archive/2014/05/07/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/) for more info. +Refer to [Asynchronous and multithreaded programming within VS using the JoinableTaskFactory](https://devblogs.microsoft.com/premier-developer/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/) for more info. diff --git a/doc/threading_rules.md b/doc/threading_rules.md index 95a022fcc..f6de5c29a 100644 --- a/doc/threading_rules.md +++ b/doc/threading_rules.md @@ -13,11 +13,11 @@ extensions](cookbook_vs.md)). ## The Rules -The rules are listed below with minimal examples. For a more thorough explanation with more examples, check out [this slideshow](https://www.slideshare.net/aarnott/the-3-vs-threading-rules). +The rules are listed below with minimal examples. For a more thorough explanation with more examples, check out [this slideshow](https://www.slideshare.net/slideshow/the-3-vs-threading-rules/78280010). ### Rule #1. If a method has certain thread apartment requirements (STA or MTA) it must either: 1. Have an asynchronous signature, and asynchronously marshal to the appropriate - thread if it isn't originally invoked on a compatible thread. The recommended + thread if it isn't originally invoked on a compatible thread. The recommended means of switching to the main thread is: ```csharp @@ -25,7 +25,7 @@ The rules are listed below with minimal examples. For a more thorough explanatio ``` OR - + 2. Have a synchronous signature, and throw an exception when called on the wrong thread. This can be done in Visual Studio with `ThreadHelper.ThrowIfNotOnUIThread()` or `ThreadHelper.ThrowIfOnUIThread()`. @@ -33,7 +33,7 @@ The rules are listed below with minimal examples. For a more thorough explanatio In particular, no method is allowed to synchronously marshal work to another thread (blocking while that work is done) except by using the second rule (below). Synchronous blocks in general are to be avoided whenever possible. - + ### Rule #2. When an implementation of an already-shipped public API must call asynchronous code and block for its completion, it must do so by following this simple pattern: ```csharp @@ -42,7 +42,7 @@ joinableTaskFactoryInstance.Run(async delegate await SomeOperationAsync(...); }); ``` - + ### Rule #3. If ever awaiting work that was started earlier, that work must be *joined*. For example, one service kicks off some asynchronous work that may later become synchronously blocking: @@ -57,22 +57,22 @@ JoinableTask longRunningAsyncWork = joinableTaskFactoryInstance.RunAsync( then later that async work becomes blocking: -```csharp +```csharp longRunningAsyncWork.Join(); ``` -or perhaps +or perhaps -```csharp +```csharp await longRunningAsyncWork; ``` Note however that this extra step is not necessary when awaiting is done immediately after kicking off an asynchronous operation. - -In particular, no method should call `Task.Wait()` or `Task.Result` on + +In particular, no method should call `Task.Wait()` or `Task.Result` on an incomplete `Task`. - + ### Additional "honorable mention" rules: (Not JTF related) ### Rule #4. Never define `async void` methods. Make the methods return `Task` instead. @@ -81,11 +81,11 @@ an incomplete `Task`. - Exceptions can't be reported to telemetry by the caller. - It's impossible for your VS package to responsibly block in `Package.Close` till your `async` work is done when it was kicked off this way. - - Be cautious: `async delegate` or `async () =>` become `async void` - methods when passed to a method that accepts `Action` delegates. Only - pass `async` delegates to methods that accept `Func` or + - Be cautious: `async delegate` or `async () =>` become `async void` + methods when passed to a method that accepts `Action` delegates. Only + pass `async` delegates to methods that accept `Func` or `Func>` parameters. - + Frequently Asked Questions --------------- @@ -139,65 +139,65 @@ blocking thread to execute the continuations. There are several reasons for this: -1. The COM transition synchronously blocks the calling thread. If the - main thread isn't immediately pumping messages, the MTA thread will - block until it handles the message. If you're on a threadpool thread, - this ties up a precious resource and if your code may execute on - multiple threadpool threads at once, there is a very real possibility +1. The COM transition synchronously blocks the calling thread. If the + main thread isn't immediately pumping messages, the MTA thread will + block until it handles the message. If you're on a threadpool thread, + this ties up a precious resource and if your code may execute on + multiple threadpool threads at once, there is a very real possibility of [threadpool starvation](threadpool_starvation.md). -2. Deadlock: if the main thread is blocked waiting for the background - thread, and the main thread happens to be on top of some call stack - (like WPF measure-layout) that suppresses the message pump, the code +2. Deadlock: if the main thread is blocked waiting for the background + thread, and the main thread happens to be on top of some call stack + (like WPF measure-layout) that suppresses the message pump, the code that normally works will randomly deadlock. -3. When the main thread is pumping messages, it will execute your code, - regardless as to whether it is relevant to what the main thread may - already be doing. If the main thread is in the main message pump, - that's fine. But if the main thread is in a pumping wait (in - managed code this could be almost anywhere as this includes locks, - I/O, sync blocks, etc.) it could be a very bad time. We call these - bad times "reentrancy" and the problem comes when you have component - X running on the main thread in a pumping wait, the component Y - uses COM marshalling to re-enter the main thread, and then Y calls - (directly or indirectly) into component X. Component X is typically - written with the assumption that by being on the main thread, it's - isolated and single-threaded, and it usually isn't prepared to handle - reentrancy. As a result, data corruption and/or deadlocks can result. - Such has been the source of many deadlocks and crashes in VS for the +3. When the main thread is pumping messages, it will execute your code, + regardless as to whether it is relevant to what the main thread may + already be doing. If the main thread is in the main message pump, + that's fine. But if the main thread is in a pumping wait (in + managed code this could be almost anywhere as this includes locks, + I/O, sync blocks, etc.) it could be a very bad time. We call these + bad times "reentrancy" and the problem comes when you have component + X running on the main thread in a pumping wait, the component Y + uses COM marshalling to re-enter the main thread, and then Y calls + (directly or indirectly) into component X. Component X is typically + written with the assumption that by being on the main thread, it's + isolated and single-threaded, and it usually isn't prepared to handle + reentrancy. As a result, data corruption and/or deadlocks can result. + Such has been the source of many deadlocks and crashes in VS for the last few releases. -4. Any method from a VS service that returns a pointer is probably - inherently broken when called from a background thread. For example, - `ItemID`s returned from `IVsHierarchy` are very often raw pointers cast - to integers. These pointers are guaranteed to be valid for as long - as you're on the main thread (and no event was raised to invalidate - it). But when you call a `IVsHierarchy` method to get an `ItemID` back - from a background thread, you leave the STA thread immediately as - the call returns, meaning the pointer is unsafe to use. If you then - go and pass that pointer back into the project system, the pointer - could have been invalidated in the interim, and you'll end up causing - an access violation crash in VS. The only safe way to deal with - `ItemID`s (or any other pointer type) is while manually marshaled to - the UI thread so that you know they are still valid for as long as +4. Any method from a VS service that returns a pointer is probably + inherently broken when called from a background thread. For example, + `ItemID`s returned from `IVsHierarchy` are very often raw pointers cast + to integers. These pointers are guaranteed to be valid for as long + as you're on the main thread (and no event was raised to invalidate + it). But when you call a `IVsHierarchy` method to get an `ItemID` back + from a background thread, you leave the STA thread immediately as + the call returns, meaning the pointer is unsafe to use. If you then + go and pass that pointer back into the project system, the pointer + could have been invalidated in the interim, and you'll end up causing + an access violation crash in VS. The only safe way to deal with + `ItemID`s (or any other pointer type) is while manually marshaled to + the UI thread so that you know they are still valid for as long as you hold and use them. -5. If your method runs on a background thread and has a loop that - accesses a VS service, that can incur a lot of thread transitions - which can hurt performance. If you were explicit in your code about - the transition, you'd very likely move it to just before you enter +5. If your method runs on a background thread and has a loop that + accesses a VS service, that can incur a lot of thread transitions + which can hurt performance. If you were explicit in your code about + the transition, you'd very likely move it to just before you enter the loop, which would make your code more efficient from the start. -6. Some VS services don't have proxy stubs registered and thus will fail - to the type cast or on method invocation when your code executes on +6. Some VS services don't have proxy stubs registered and thus will fail + to the type cast or on method invocation when your code executes on a background thread. -7. Some VS services get rewritten from native to managed code, which - subtly changes them from single-threaded to free-threaded services. - Unless the managed code is written to be thread-safe (most is not) - this means that your managed code calling into a managed code VS - service on a background thread will not transition to the UI thread - first, and you are cruising for thread-safety bugs (data corruption, - crashes, hangs, etc). By switching to the main thread yourself first, - you won't be the poor soul who has crashes in their feature and has - to debug it for days until you finally figure out that you were causing - data corruption and a crash later on. Yes, you can blame the free - threaded managed code that should have protected itself, but that's - not very satisfying after days of investigation. And the owner of +7. Some VS services get rewritten from native to managed code, which + subtly changes them from single-threaded to free-threaded services. + Unless the managed code is written to be thread-safe (most is not) + this means that your managed code calling into a managed code VS + service on a background thread will not transition to the UI thread + first, and you are cruising for thread-safety bugs (data corruption, + crashes, hangs, etc). By switching to the main thread yourself first, + you won't be the poor soul who has crashes in their feature and has + to debug it for days until you finally figure out that you were causing + data corruption and a crash later on. Yes, you can blame the free + threaded managed code that should have protected itself, but that's + not very satisfying after days of investigation. And the owner of that code may refuse to fix their code and you'll have to fix yours anyway. ##### How do these rules protect me from re-entering random code on the main thread? @@ -243,7 +243,7 @@ the moment. The debugger and Windows teams are working to improve that situation. In the meantime, we have learned several techniques to figure out what is causing the hang, and we're working to enhance the framework to automatically detect, self-analyze and report hangs to you so you have -almost nothing to do but fix the code bug. +almost nothing to do but fix the code bug. In the meantime, the most useful technique for analyzing async hangs is to attach WinDBG to the process and dump out incomplete async methods' states. @@ -283,7 +283,7 @@ priority via the `JoinableTask` it may call your code within. ##### What message priority is used to switch to (or resume on) the main thread, and can this be changed? -`JoinableTaskFactory`’s default behavior is to switch to the main thread using +`JoinableTaskFactory`'s default behavior is to switch to the main thread using `SynchronizationContext.Post`, which typically posts a message to the main thread, which puts it below RPC and above user input in priority. @@ -303,8 +303,8 @@ your own constructor that chains in the base constructor, passing in the required parameters. You are then free to directly instantiate your derived type by passing in either a `JoinableTaskContext` or a `JoinableTaskCollection`. -For more information on this topic, see Andrew Arnott's blog post -[Asynchronous and multithreaded programming within VS using the +For more information on this topic, see Andrew Arnott's blog post +[Asynchronous and multithreaded programming within VS using the `JoinableTaskFactory`][JTFBlog]. [AsyncHangDebugging]: https://github.com/Microsoft/VSProjectSystem/blob/master/doc/scenario/analyze_hangs.md diff --git a/doc/threadpool_starvation.md b/doc/threadpool_starvation.md index 8162c5e84..73222d14a 100644 --- a/doc/threadpool_starvation.md +++ b/doc/threadpool_starvation.md @@ -73,7 +73,7 @@ There are multiple major causes of thread pool starvation. Each is briefly descr ### Blocking a thread pool thread while waiting for the UI thread -When a thread pool thread tries to access an STA COM object such as Visual Studio's IServiceProvider or a service previously obtained from this interface, the call to that COM object will require an RPC (Remote Procedure Call) transition which blocks the thread pool thread until the UI thread has time to respond to the request. Learn more about RPC calls from [this blog post](https://blogs.msdn.microsoft.com/andrewarnottms/2014/05/07/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/). +When a thread pool thread tries to access an STA COM object such as Visual Studio's IServiceProvider or a service previously obtained from this interface, the call to that COM object will require an RPC (Remote Procedure Call) transition which blocks the thread pool thread until the UI thread has time to respond to the request. Learn more about RPC calls from [this blog post](https://devblogs.microsoft.com/premier-developer/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/). The mitigation for this is to have the method that is executing on the thread pool asynchronously switch to the UI thread *before* calling into an STA COM object. This allows the thread pool thread to work on something else on the thread pool's queue while the UI thread is busy or servicing this request. After interacting with the STA COM object, the async method can switch back to the thread pool if desired. @@ -81,8 +81,8 @@ The mitigation for this is to have the method that is executing on the thread po When a component sends many work items to the thread pool in a short timeframe, the queue will grow to store them till one of the thread pool threads can execute them all. Any subsequently queued items will be added to the end of the queue, regardless of their relative priority in the application. When the queue is long, and a work item is appended to the end of the queue that is required for the UI of the application to feel responsive, the application can hang or feel sluggish due to the work that otherwise should be running in the background without impacting UI responsiveness. -The mitigation is for components that have many work items to send to the threadpool to throttle the rate at which new items are introduced to the threadpool to a reasonably small number. This helps keep the queue short, and thus any newly enqueued work will execute much sooner, keeping the application responsive. Throttling work can be done such that the CPU stays busy and the background work moving along quickly, but without sacrificing UI responsiveness. See [this blog post](https://blogs.msdn.microsoft.com/andrewarnottms/2017/05/11/limiting-concurrency-for-faster-and-more-responsive-apps/) for more information on how to easily throttle concurrent work. +The mitigation is for components that have many work items to send to the threadpool to throttle the rate at which new items are introduced to the threadpool to a reasonably small number. This helps keep the queue short, and thus any newly enqueued work will execute much sooner, keeping the application responsive. Throttling work can be done such that the CPU stays busy and the background work moving along quickly, but without sacrificing UI responsiveness. See [this blog post](https://devblogs.microsoft.com/premier-developer/limiting-concurrency-for-faster-and-more-responsive-apps/) for more information on how to easily throttle concurrent work. ## Learn more -Vance Morrison wrote [a blog post](https://blogs.msdn.microsoft.com/vancem/2018/10/16/diagnosing-net-core-threadpool-starvation-with-perfview-why-my-service-is-not-saturating-all-cores-or-seems-to-stall/) describing this situation as well. +Vance Morrison wrote [a blog post](https://learn.microsoft.com/archive/blogs/vancem/diagnosing-net-core-threadpool-starvation-with-perfview-why-my-service-is-not-saturating-all-cores-or-seems-to-stall) describing this situation as well. From 82b197345b9bed3c75786b02e9b589918ee9b72f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 00:23:54 +0000 Subject: [PATCH 1251/1753] Update dependency System.Runtime.CompilerServices.Unsafe to 6.1.0 (#1406) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 56ac743c8..1a1c4cb7e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -35,7 +35,7 @@ - + From a90624e4326dc5265ae908f0d9c3d023ebff2118 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 00:25:02 +0000 Subject: [PATCH 1252/1753] Update dependency System.Threading.Tasks.Extensions to 4.6.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1a1c4cb7e..515316d86 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -36,7 +36,7 @@ - + From 5812ca4dafea1638efe675fbbf281ea3baccee27 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 00:25:03 +0000 Subject: [PATCH 1253/1753] Merge pull request #1408 from microsoft/renovate/major-included-in-.net-runtime Update Included in .NET runtime to v8 (major) --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1a1c4cb7e..1c3f70742 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,7 +13,7 @@ - + @@ -33,7 +33,7 @@ - + From abb9883aaa706c3bb897f5729f280ec5c1c75c98 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 00:45:26 +0000 Subject: [PATCH 1254/1753] Merge pull request #1402 from microsoft/renovate/system.memory-4.x Update dependency System.Memory to 4.6.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1c3f70742..b46053559 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -34,7 +34,7 @@ - + From 444438971904714bb09576a34c296743549e9466 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 19:35:38 -0700 Subject: [PATCH 1255/1753] Update binding redirect --- test/IsolatedTestHost/App.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index 0431432a8..e5ab83a70 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -10,7 +10,7 @@ - + From 0f4c04b9127c3fef2e7664b6664cb9ff8a2cfed6 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 02:39:07 +0000 Subject: [PATCH 1256/1753] Update xunit --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b46053559..4938c232f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -40,8 +40,8 @@ - - + + From 8eb0937bad6dd628f70d29a75e76bff112d8a707 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 21:42:18 -0700 Subject: [PATCH 1257/1753] Renovate should not update to versions from non-release branches --- .github/renovate.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index c140014f9..a41e0267c 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -16,6 +16,11 @@ "matchDatasources": ["dotnet-version", "docker"], "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], "groupName": "Dockerfile and global.json updates" + }, + { + "matchPackageNames": ["*"], + "allowedVersions": "!/-g[a-f0-9]+$/", + "groupName": "Ignore versions built from non-release branches" } ] } From 9db1062760fc20f2124ec32a012aced5666372bf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 22:36:37 -0700 Subject: [PATCH 1258/1753] Drop group name in renovate --- .github/renovate.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/renovate.json b/.github/renovate.json index a41e0267c..092ed0497 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -19,8 +19,7 @@ }, { "matchPackageNames": ["*"], - "allowedVersions": "!/-g[a-f0-9]+$/", - "groupName": "Ignore versions built from non-release branches" + "allowedVersions": "!/-g[a-f0-9]+$/" } ] } From 44ad64748ad91d24d6975d0666bc6779ccdc7b96 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 11:11:43 +0000 Subject: [PATCH 1259/1753] Update Visual Studio SDK to 17.13.40002 --- Directory.Packages.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b46053559..8f0dca0d7 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -26,9 +26,9 @@ - - - + + + From acb16c20486a1334b339d0a3fcfdb3a35e406fcc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 6 Feb 2025 06:52:47 -0700 Subject: [PATCH 1260/1753] Update packages used by analyzer tests Also teach renovate how to find and update these automatically going forward. --- .github/renovate.json | 8 ++++++++ .../Helpers/ReferencesHelper.cs | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/renovate.json b/.github/renovate.json index b2611c4de..3b72ae384 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -52,5 +52,13 @@ "matchJsonata": [ "sharedVariableName='CodeAnalysisVersion'" ], "enabled": false } + ], + "customManagers": [ + { + "customType": "regex", + "datasourceTemplate": "nuget", + "fileMatch": ["test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs"], + "matchStrings": ["PackageIdentity\\(\"(?[^\"]+)\", \"(?[^\"]+)\"\\)"] + } ] } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 79d1482c9..329c8bdc9 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -16,8 +16,8 @@ internal static class ReferencesHelper #error Fix TFM conditions #endif .WithPackages(ImmutableArray.Create( - new PackageIdentity("System.Collections.Immutable", "5.0.0"), - new PackageIdentity("System.Threading.Tasks.Extensions", "4.5.4"), + new PackageIdentity("System.Collections.Immutable", "6.0.0"), + new PackageIdentity("System.Threading.Tasks.Extensions", "4.6.0"), new PackageIdentity("Microsoft.Bcl.AsyncInterfaces", "6.0.0"))); internal static readonly ImmutableArray VSSDKPackageReferences = ImmutableArray.Create(new string[] From 15cfcdb5b9f8fd931b206029f9439aac27ba16b5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 6 Feb 2025 07:27:25 -0700 Subject: [PATCH 1261/1753] Compensate for CsWin32 HANDLE type change --- .../NoMessagePumpSyncContext.cs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs index 5d1f1b58e..feea9a501 100644 --- a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs @@ -47,7 +47,7 @@ public static SynchronizationContext Default /// /// The array index of the object that satisfied the wait. /// - public override int Wait(IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout) + public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout) { Requires.NotNull(waitHandles, nameof(waitHandles)); @@ -61,7 +61,10 @@ public override int Wait(IntPtr[] waitHandles, bool waitAll, int millisecondsTim if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) #endif { - return (int)PInvoke.WaitForMultipleObjects(MemoryMarshal.Cast(waitHandles), waitAll, (uint)millisecondsTimeout); + fixed (IntPtr* pHandles = waitHandles) + { + return (int)PInvoke.WaitForMultipleObjects((uint)waitHandles.Length, (HANDLE*)pHandles, waitAll, (uint)millisecondsTimeout); + } } else { From a4f32b4e7e50e4f713a7b360e697ffa39b150f8f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 6 Feb 2025 08:06:44 -0700 Subject: [PATCH 1262/1753] Adapt to avoid netstandard2.0 build of VS SDK --- ...ualStudio.Threading.Analyzers.Tests.csproj | 27 ++++++++----------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 31c251114..8174b4bc5 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -15,16 +15,11 @@ $(TargetFrameworks);net8.0-windows;net472 - - - - - + + + + + @@ -32,15 +27,14 @@ - - + + - AdditionalFiles.%(FileName)%(Extension) @@ -50,13 +44,14 @@ + + - + AdditionalFiles From ba4ac3fb81e1b6435e0a44bb35bb687a86e6f5ba Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 6 Feb 2025 15:32:59 +0000 Subject: [PATCH 1263/1753] Merge pull request #1409 from microsoft/renovate/dotnet-monorepo Update dotnet monorepo to 4.12.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7121d8a90..772d68e2e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ true 2.0.181 3.11.0 - 4.4.0 + 4.12.0 1.1.2 3.1.525101 3.11.0-beta1.24527.2 From c5d1d292527ef94330a7dd3cfc78e98aebaab9ee Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 6 Feb 2025 09:10:50 -0700 Subject: [PATCH 1264/1753] Adapt to new Xunit.StaFact --- .../Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs index d73549251..c21a6d286 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs @@ -9,6 +9,7 @@ using Microsoft.VisualStudio.Threading; using Xunit; using Xunit.Abstractions; +using TplExtensions = Microsoft.VisualStudio.Threading.TplExtensions; public class TplExtensionsTests : TestBase { From 84db3cfa946be996a78ea249357645970c94a3e9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Feb 2025 19:37:50 -0700 Subject: [PATCH 1265/1753] Fix doc link redirect --- doc/analyzers/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/analyzers/index.md b/doc/analyzers/index.md index bf20d0337..7b07b500b 100644 --- a/doc/analyzers/index.md +++ b/doc/analyzers/index.md @@ -49,4 +49,4 @@ Guideline | 200-299 | Code that deviates from best practices and may limit the b Some analyzers' behavior can be configured. See our [configuration](configuration.md) topic for more information. -[1]: https://nuget.org/packages/microsoft.visualstudio.threading.analyzers +[1]: https://www.nuget.org/packages/microsoft.visualstudio.threading.analyzers From 70d3bec9b8a8a22367024f19627ceceb3f39dbcc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jan 2025 21:26:39 -0700 Subject: [PATCH 1266/1753] Migrate docs to docfx-based GitHub Pages --- Directory.Build.props | 2 +- README.md | 8 +- doc/analyzers/VSTHRD001.md | 83 +----- doc/analyzers/VSTHRD002.md | 46 +-- doc/analyzers/VSTHRD003.md | 268 +----------------- doc/analyzers/VSTHRD004.md | 44 +-- doc/analyzers/VSTHRD010.md | 62 +--- doc/analyzers/VSTHRD011.md | 58 +--- doc/analyzers/VSTHRD012.md | 34 +-- doc/analyzers/VSTHRD100.md | 57 +--- doc/analyzers/VSTHRD101.md | 72 +---- doc/analyzers/VSTHRD102.md | 57 +--- doc/analyzers/VSTHRD103.md | 30 +- doc/analyzers/VSTHRD104.md | 37 +-- doc/analyzers/VSTHRD105.md | 84 +----- doc/analyzers/VSTHRD106.md | 32 +-- doc/analyzers/VSTHRD107.md | 28 +- doc/analyzers/VSTHRD108.md | 47 +-- doc/analyzers/VSTHRD109.md | 30 +- doc/analyzers/VSTHRD110.md | 76 +---- doc/analyzers/VSTHRD111.md | 39 +-- doc/analyzers/VSTHRD112.md | 67 +---- doc/analyzers/VSTHRD113.md | 38 +-- doc/analyzers/VSTHRD114.md | 32 +-- doc/analyzers/VSTHRD115.md | 39 +-- doc/analyzers/VSTHRD200.md | 48 +--- .../AppWithMainThread.editorconfig | 0 .../AppWithoutMainThread.editorconfig | 0 .../JTFFocusedLibrary.editorconfig | 0 doc/{analyzers => }/editorconfigs/README.md | 2 +- .../editorconfigs/SharedLibrary.editorconfig | 0 .../editorconfigs/Tests.editorconfig | 0 doc/index.md | 14 - docfx/analyzers/VSTHRD001.md | 82 ++++++ docfx/analyzers/VSTHRD002.md | 45 +++ docfx/analyzers/VSTHRD003.md | 267 +++++++++++++++++ docfx/analyzers/VSTHRD004.md | 43 +++ docfx/analyzers/VSTHRD010.md | 61 ++++ docfx/analyzers/VSTHRD011.md | 57 ++++ docfx/analyzers/VSTHRD012.md | 33 +++ docfx/analyzers/VSTHRD100.md | 56 ++++ docfx/analyzers/VSTHRD101.md | 71 +++++ docfx/analyzers/VSTHRD102.md | 56 ++++ docfx/analyzers/VSTHRD103.md | 29 ++ docfx/analyzers/VSTHRD104.md | 36 +++ docfx/analyzers/VSTHRD105.md | 83 ++++++ docfx/analyzers/VSTHRD106.md | 31 ++ docfx/analyzers/VSTHRD107.md | 27 ++ docfx/analyzers/VSTHRD108.md | 46 +++ docfx/analyzers/VSTHRD109.md | 29 ++ docfx/analyzers/VSTHRD110.md | 75 +++++ docfx/analyzers/VSTHRD111.md | 38 +++ docfx/analyzers/VSTHRD112.md | 66 +++++ docfx/analyzers/VSTHRD113.md | 37 +++ docfx/analyzers/VSTHRD114.md | 31 ++ docfx/analyzers/VSTHRD115.md | 38 +++ docfx/analyzers/VSTHRD200.md | 47 +++ {doc => docfx}/analyzers/configuration.md | 0 {doc => docfx}/analyzers/fsa.md | 2 +- {doc => docfx}/analyzers/index.md | 20 +- {doc => docfx}/analyzers/installation.md | 2 +- docfx/analyzers/toc.yml | 29 ++ {doc => docfx/docs}/async_hang.md | 0 {doc => docfx/docs}/cookbook_vs.md | 0 {doc => docfx/docs}/dumpasync.md | 0 docfx/docs/features.md | 25 +- docfx/docs/getting-started.md | 6 +- {doc => docfx/docs}/library_with_jtf.md | 2 +- {doc => docfx/docs}/testing_vs.md | 0 {doc => docfx/docs}/threading_rules.md | 68 +++-- {doc => docfx/docs}/threadpool_starvation.md | 6 +- docfx/docs/toc.yml | 13 +- {doc => docfx}/images/blocked_time.png | Bin .../images/blocked_time_callers.png | Bin ...u_stacks_showing_threadpool_starvation.png | Bin {doc/analyzers => docfx}/images/fsa.png | Bin .../images/vs_threadpoolstarvation_event.jpg | Bin docfx/index.md | 5 +- docfx/toc.yml | 4 + .../README.md | 2 +- .../Utils.cs | 2 +- .../README.md | 2 + 82 files changed, 1540 insertions(+), 1466 deletions(-) rename doc/{analyzers => }/editorconfigs/AppWithMainThread.editorconfig (100%) rename doc/{analyzers => }/editorconfigs/AppWithoutMainThread.editorconfig (100%) rename doc/{analyzers => }/editorconfigs/JTFFocusedLibrary.editorconfig (100%) rename doc/{analyzers => }/editorconfigs/README.md (97%) rename doc/{analyzers => }/editorconfigs/SharedLibrary.editorconfig (100%) rename doc/{analyzers => }/editorconfigs/Tests.editorconfig (100%) delete mode 100644 doc/index.md create mode 100644 docfx/analyzers/VSTHRD001.md create mode 100644 docfx/analyzers/VSTHRD002.md create mode 100644 docfx/analyzers/VSTHRD003.md create mode 100644 docfx/analyzers/VSTHRD004.md create mode 100644 docfx/analyzers/VSTHRD010.md create mode 100644 docfx/analyzers/VSTHRD011.md create mode 100644 docfx/analyzers/VSTHRD012.md create mode 100644 docfx/analyzers/VSTHRD100.md create mode 100644 docfx/analyzers/VSTHRD101.md create mode 100644 docfx/analyzers/VSTHRD102.md create mode 100644 docfx/analyzers/VSTHRD103.md create mode 100644 docfx/analyzers/VSTHRD104.md create mode 100644 docfx/analyzers/VSTHRD105.md create mode 100644 docfx/analyzers/VSTHRD106.md create mode 100644 docfx/analyzers/VSTHRD107.md create mode 100644 docfx/analyzers/VSTHRD108.md create mode 100644 docfx/analyzers/VSTHRD109.md create mode 100644 docfx/analyzers/VSTHRD110.md create mode 100644 docfx/analyzers/VSTHRD111.md create mode 100644 docfx/analyzers/VSTHRD112.md create mode 100644 docfx/analyzers/VSTHRD113.md create mode 100644 docfx/analyzers/VSTHRD114.md create mode 100644 docfx/analyzers/VSTHRD115.md create mode 100644 docfx/analyzers/VSTHRD200.md rename {doc => docfx}/analyzers/configuration.md (100%) rename {doc => docfx}/analyzers/fsa.md (91%) rename {doc => docfx}/analyzers/index.md (81%) rename {doc => docfx}/analyzers/installation.md (96%) create mode 100644 docfx/analyzers/toc.yml rename {doc => docfx/docs}/async_hang.md (100%) rename {doc => docfx/docs}/cookbook_vs.md (100%) rename {doc => docfx/docs}/dumpasync.md (100%) rename {doc => docfx/docs}/library_with_jtf.md (98%) rename {doc => docfx/docs}/testing_vs.md (100%) rename {doc => docfx/docs}/threading_rules.md (85%) rename {doc => docfx/docs}/threadpool_starvation.md (96%) rename {doc => docfx}/images/blocked_time.png (100%) rename {doc => docfx}/images/blocked_time_callers.png (100%) rename {doc => docfx}/images/cpu_stacks_showing_threadpool_starvation.png (100%) rename {doc/analyzers => docfx}/images/fsa.png (100%) rename {doc => docfx}/images/vs_threadpoolstarvation_event.jpg (100%) diff --git a/Directory.Build.props b/Directory.Build.props index e41668d8e..dad792fba 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -24,7 +24,7 @@ embedded - https://github.com/Microsoft/vs-threading + https://microsoft.github.io/vs-threading/ Microsoft Microsoft © Microsoft Corporation. All rights reserved. diff --git a/README.md b/README.md index 97da5667f..689fbf5d2 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). -[Overview documentation](doc/index.md). +[Getting started](https://microsoft.github.io/vs-threading/docs/getting-started.md). -[See the full list of features](src/Microsoft.VisualStudio.Threading/README.md). +[See the full list of features](https://microsoft.github.io/vs-threading/docs/features.md). ## Microsoft.VisualStudio.Threading.Analyzers @@ -19,6 +19,4 @@ Async synchronization primitives, async collections, TPL and dataflow extensions Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. -[Diagnostic analyzer rules](doc/analyzers/index.md). - -[See the full list of features](src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md). +[Diagnostic analyzer rules](https://microsoft.github.io/vs-threading/analyzers/index.md). diff --git a/doc/analyzers/VSTHRD001.md b/doc/analyzers/VSTHRD001.md index 1dd47c1ac..0bd13cf04 100644 --- a/doc/analyzers/VSTHRD001.md +++ b/doc/analyzers/VSTHRD001.md @@ -1,82 +1 @@ -# VSTHRD001 Avoid legacy thread switching methods - -Switching to the UI thread should be done using `JoinableTaskFactory.SwitchToMainThreadAsync` -rather than legacy methods such as `Dispatcher.Invoke` or `ThreadHelper.Invoke`. -This avoids deadlocks and can reduce threadpool starvation. - -## Examples of patterns that are flagged by this analyzer - -```csharp -ThreadHelper.Generic.Invoke(delegate { - DoSomething(); -}); -``` - -or - -```cs -Dispatcher.CurrentDispatcher.BeginInvoke(delegate { - DoSomething(); -}); -``` - -## Solution - -Use `await SwitchToMainThreadAsync()` instead, wrapping with the `JoinableTaskFactory`'s `Run` or `RunAsync` method if necessary: - -```csharp -void Foo() { - ThreadHelper.JoinableTaskFactory.Run(async delegate { - await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(); - DoSomething(); - }); -} -``` - -In the above example, we obtain a `JoinableTaskFactory` instance from the `ThreadHelper.JoinableTaskFactory` static property -as it exists within Visual Studio itself. Other applications should create and expose their own `JoinableTaskContext` and/or `JoinableTaskFactory` for use in code that run in these applications. -See our doc on [consuming `JoinableTaskFactory` from a library](https://github.com/microsoft/vs-threading/blob/main/doc/library_with_jtf.md) for more information. - -### Replacing Dispatcher.BeginInvoke - -When updating calls to `Dispatcher.BeginInvoke`, there are a few considerations to consider. - -1. `BeginInvoke` schedules the delegate for execution later. -1. `BeginInvoke` always executes the delegate on the dispatcher's thread. -1. `BeginInvoke` schedules the delegate at some given priority, or default priority determined by the dispatcher. - -To resolve a warning for such code, it is often sufficient to replace it with this, which is *roughly* equivalent: - -```cs -await joinableTaskFactory.RunAsync(async delegate { - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); - DoSomething(); -}) -``` - -The first line in the delegate is necessary to match the behaviors of 1 and 2 on the above list. -When the caller is known to already be on the main thread, you can simplify it slightly to this: - -```cs -await joinableTaskFactory.RunAsync(async delegate { - await Task.Yield(); - DoSomething(); -}) -``` - -Matching behavior 3 on the list above may be important when the dispatcher priority is specified in the BeginInvoke call and was chosen for a particular reason. -In such a case, you can ensure that `JoinableTaskFactory` matches that priority instead of using its default by creating a special `JoinableTaskFactory` instance with the priority setting you require using the [`JoinableTaskFactory.WithPriority`](https://learn.microsoft.com/dotnet/api/microsoft.visualstudio.threading.dispatcherextensions.withpriority?view=visualstudiosdk-2022) method. - -Altogether, this might look like: - -```cs -await joinableTaskFactory.WithPriority(DispatcherPriority.DataBind).RunAsync(async delegate { - await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); - DoSomething(); -}) -``` - -## Configuration - -This analyzer is configurable via the `vs-threading.LegacyThreadSwitchingMembers.txt` file. -See our [configuration](configuration.md) topic for more information. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD001.html). diff --git a/doc/analyzers/VSTHRD002.md b/doc/analyzers/VSTHRD002.md index 6a05a94ca..69a4fc3c9 100644 --- a/doc/analyzers/VSTHRD002.md +++ b/doc/analyzers/VSTHRD002.md @@ -1,45 +1 @@ -# VSTHRD002 Avoid problematic synchronous waits - -Synchronously waiting on `Task`, `ValueTask`, or awaiters is dangerous and may cause dead locks. - -## Examples of patterns that are flagged by this analyzer - -```csharp -void DoSomething() -{ - DoSomethingElseAsync().Wait(); - DoSomethingElseAsync().GetAwaiter().GetResult(); - var result = CalculateSomethingAsync().Result; -} -``` - -## Solution - -Please consider the following options: - -1. Switch to asynchronous wait if the caller is already a "async" method. -1. Change the chain of callers to be "async" methods, and then change this code to be asynchronous await. -1. Use `JoinableTaskFactory.Run()` to wait on the tasks or awaiters. - -```csharp -async Task DoSomethingAsync() -{ - await DoSomethingElseAsync(); - await DoSomethingElseAsync(); - var result = await CalculateSomethingAsync(); -} - -void DoSomething() -{ - joinableTaskFactory.Run(async delegate - { - await DoSomethingElseAsync(); - await DoSomethingElseAsync(); - var result = await CalculateSomethingAsync(); - }); -} -``` - -Refer to [Asynchronous and multithreaded programming within VS using the JoinableTaskFactory][1] for more information. - -[1]: https://devblogs.microsoft.com/premier-developer/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/ +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD002.html). diff --git a/doc/analyzers/VSTHRD003.md b/doc/analyzers/VSTHRD003.md index 49d8ad87b..34aba3d45 100644 --- a/doc/analyzers/VSTHRD003.md +++ b/doc/analyzers/VSTHRD003.md @@ -1,267 +1 @@ -# VSTHRD003 Avoid awaiting foreign Tasks - -Tasks that are created and run from another context (not within the currently running method or delegate) -should not be returned or awaited on. Doing so can result in deadlocks because awaiting a `Task` -does not result in the awaiter "joining" the effort such that access to the main thread is shared. -If the awaited `Task` requires the main thread, and the caller that is awaiting it is blocking the -main thread, a deadlock will result. - -When required to await a task that was started earlier, start it within a delegate passed to -`JoinableTaskFactory.RunAsync`, storing the resulting `JoinableTask` in a field or variable. -You can safely await the `JoinableTask` later. - -## Simple examples of patterns that are flagged by this analyzer - -The following example would likely deadlock if `MyMethod` were called on the main thread, -since `SomeOperationAsync` cannot gain access to the main thread in order to complete. - -```csharp -void MyMethod() -{ - System.Threading.Tasks.Task task = SomeOperationAsync(); - joinableTaskFactory.Run(async delegate - { - await task; /* This analyzer will report warning on this line. */ - }); -} -``` - -In the next example, `WaitForMyMethod` may deadlock when `this.task` has not completed -and needs the main thread to complete. - -```csharp -class SomeClass -{ - System.Threading.Tasks.Task task; - - SomeClass() - { - this.task = SomeOperationAsync(); - } - - async Task MyMethodAsync() - { - await this.task; /* This analyzer will report warning on this line. */ - } - - void WaitForMyMethod() - { - joinableTaskFactory.Run(() => MyMethodAsync()); - } -} -``` - -More [advanced examples](#advanced-cases) are further down in this document, below the solution section for the simpler examples. - -## Solution for simpler cases - -To await the result of an async method from with a JoinableTaskFactory.Run delegate, -invoke the async method within the JoinableTaskFactory.Run delegate: - -```csharp -void MyMethod() -{ - joinableTaskFactory.Run(async delegate - { - System.Threading.Tasks.Task task = SomeOperationAsync(); - await task; - }); -} -``` - -Alternatively wrap the original method invocation with JoinableTaskFactory.RunAsync: - -```csharp -class SomeClass -{ - JoinableTask joinableTask; - - SomeClass() - { - this.joinableTask = joinableTaskFactory.RunAsync(() => SomeOperationAsync()); - } - - async Task MyMethodAsync() - { - await this.joinableTask; - } - - void WaitForMyMethod() - { - joinableTaskFactory.Run(() => MyMethodAsync()); - } -} -``` - -## Advanced cases - -### `TaskCompletionSource` - -In the next example, a `TaskCompletionSource` is used as a black-box for unblocking functionality. -It too represents awaiting a foreign task: - -```cs -class SomeClass -{ - TaskCompletionSource tcs = new(); - - public async Task MyMethodAsync() - { - await this.tcs.Task; /* This analyzer will report warning on this line. */ - /* do more stuff */ - } - - void UnlockProgress() - { - this.tcs.TrySetResult(true); - } -} -``` - -The problem with the above code is that `MyMethodAsync()` waits for unknown work (whatever work will lead to the completion of the `TaskCompletionSource`) before making progress. -If `UnlockProgress()` is never called, the caller of `MyMethodAsync()` will be awaiting forever. -Now suppose that the caller of `MyMethodAsync()` is actually inside a `JoinableTaskFactory.Run` delegate: - -```cs -void SomeCaller() -{ - joinableTaskFactory.Run(async delegate - { - await someClass.MyMethodAsync(); - }); -} -``` - -If `SomeCaller()` runs on the main thread, then it will effectively block the main thread while waiting for `this.tcs.Task` from `SomeClass` to complete. -Now suppose that another thread comes along and wants to do some work before calling `UnlockProgress()`: - -```cs -partial class SomeClass -{ - async Task KeyMasterAsync() - { - await joinableTaskFactory.SwitchToMainThreadAsync(); - // do some work - // Unblock others - someClass.UnlockProgress(); - } -} -``` - -We have a deadlock, because `SomeCaller()` is blocking the main thread while waiting for `UnlockProgress()` to be called, but `UnlockProgress()` will not be called until `KeyMasterAsync` can reach the main thread. - -Fixing this fundamentally means that `SomeCaller` will need to *join* whatever work may be needed to ultimately call `UnlockProgress`. But for `SomeCaller`, that work is unknown, since it's at least partially inside another class. -`TaskCompletionSource` is fundamentally a blackbox and the most difficult thing to use correctly while avoiding deadlocks. - -Preferred solutions involve replacing `TaskCompletionSource` with another type that makes tracking the work involved automatic. -These include: - -1. Use `JoinableTaskFactory.RunAsync` and store the resulting `JoinableTask` in a field to await later. -1. Use `AsyncLazy` for one-time init work that should only start if required. Be sure to pass in a `JoinableTaskFactory` instance to its constructor. - -Assuming you must keep using `TaskCompletionSource` though, here's how it can be done as safely as possible. -Joining a set of unknown work is best done with the `JoinableTaskCollection` class. -It is the responsibility of `SomeClass` in the example above to work with this collection to avoid deadlocks, like this: - -```cs -class SomeClass -{ - TaskCompletionSource tcs = new(); - JoinableTaskCollection jtc; - JoinableTaskFactory jtf; - - internal SomeClass(JoinableTaskContext joinableTaskContext) - { - this.jtc = joinableTaskContext.CreateCollection(); - this.jtf = joinableTaskContext.CreateFactory(this.jtc); - } - - public async Task MyMethodAsync() - { - // Our caller is interested in completion of the TaskCompletionSource, - // so join the collected effort while waiting, to avoid deadlocks. - using (this.jtc.Join()) - { - await this.tcs.Task; /* This analyzer will report warning on this line. */ - } - - /* do more stuff */ - } - - void UnlockProgress() - { - this.tcs.TrySetResult(true); - } - - async Task KeyMasterAsync() - { - // As this method must complete to signal the TaskCompletionSource, - // all of its work must be done within the context of a JoinableTask - // that belongs to the JoinableTaskCollection. - // jtf.RunAsync will add the JoinableTask it creates to the jtc collection - // because jtf was created with jtc as an argument in our constructor. - await this.jtf.RunAsync(async delegate - { - // Because we're in the jtc collection, anyone waiting on MyMethodAsync - // will automatically lend us use of the main thread if they have it - // to avoid deadlocks. - // It does NOT matter whether we use jtf or another JoinableTaskFactory instance - // at this point. - await anyOldJTF.SwitchToMainThreadAsync(); - - // do some work - // Unblock others - this.UnlockProgress(); - }); - } -} -``` - -Notice how the public API of the class does not need to expose any `JoinableTask`-related types. -It's an implementation detail of the class. - -This works fine when the class itself fully controls the work to complete the `TaskCompletionSource`. -When _other_ classes also do work (independently of work started within `SomeClass`), the placement and access to the `JoinableTaskFactory` that is associated with the `JoinableTaskCollection` may need to be elevated so that other classes can access it as well so that *all* the work required to complete the `TaskCompletionSource` will be tracked. - -### Task chaining or other means to ensure sequential execution - -Task chaining is another technique that can lead to deadlocks. -Task chaining is where a single `Task` is kept in a field and used to call `Task.ContinueWith` to append another Task, and the resulting Task is then assigned to the field, like this: - -```cs -class TaskChainingExample -{ - private readonly object lockObject = new(); - private Task lastTask = Task.CompletedTask; - - internal Task AddWorkToEnd(Funk work) - { - lock (this.lockObject) - { - return this.lastTask = this.lastTask.ContinueWith(_ => work()).Unwrap(); - } - } -} -``` - -(Note: The above example has several *other* issues that would require more code to address, but it illustrates the idea of task chaining.) - -The deadlock risk with task chaining is that again, the chain of tasks come together to form a kind of private queue which the `JoinableTaskFactory` has no visibility into. -When a task is not at the front of the queue but its owner blocks the main thread for its completion, and if any other task ahead of it in the queue needs the main thread, a deadlock will result. - -For this reason (and several others), task chaining is *not* recommended. -Instead, you can achieve a thread-safe queue that executes work sequentially by utilizing the `ReentrantSemaphore` class. - -Fixing the above example would translate to this (allowing for a variety of reentrancy modes): - -```cs -class SequentialExecutingQueueExample -{ - private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(initialCount: 1, joinableTaskContext, ReentrancyMode.Stack); - - internal Task AddWorkToEnd(Func work) - { - return semaphore.ExecuteAsync(work); - } -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD003.html). diff --git a/doc/analyzers/VSTHRD004.md b/doc/analyzers/VSTHRD004.md index 39d3bbdf6..8c937964f 100644 --- a/doc/analyzers/VSTHRD004.md +++ b/doc/analyzers/VSTHRD004.md @@ -1,43 +1 @@ -# VSTHRD004 Await SwitchToMainThreadAsync - -Calls to `JoinableTaskFactory.SwitchToMainThreadAsync` must be awaited -or it is a no-op. - -## Examples of patterns that are flagged by this analyzer - -```csharp -void MyMethod() -{ - joinableTaskFactory.SwitchToMainThreadAsync(); - UIThreadBoundWork(); -} -``` - -## Solution - -Add `await` in front of the call to `JoinableTaskFactory.SwitchToMainThreadAsync`. - -This requires an async context. Here, we fix the problem by making the outer method async: - -```csharp -async Task MyMethodAsync() -{ - await joinableTaskFactory.SwitchToMainThreadAsync(); - UIThreadBoundWork(); -} -``` - - -Alternatively if found in a synchronous method that cannot be made async, -this failure can be fixed by lifting the code into a delegate passed to `JoinableTaskFactory.Run`: - -```csharp -void MyMethod() -{ - joinableTaskFactory.Run(async delegate - { - await joinableTaskFactory.SwitchToMainThreadAsync(); - UIThreadBoundWork(); - }); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD004.html). diff --git a/doc/analyzers/VSTHRD010.md b/doc/analyzers/VSTHRD010.md index bfb01c11d..15a5d10b3 100644 --- a/doc/analyzers/VSTHRD010.md +++ b/doc/analyzers/VSTHRD010.md @@ -1,61 +1 @@ -# VSTHRD010 Invoke single-threaded types on Main thread - -Acquiring, casting, or invoking single-threaded objects should be done after ensuring -that your code is running on the main thread. - -This analyzer can be configured to: -1. Recognize the objects that are single-threaded that are unique to your app or library. -2. Recognize synchronous methods that verify the caller is already on the main thread. -3. Recognize methods that switch to the main thread when the caller awaits them. - Calls to `JoinableTaskFactory.SwitchToMainThreadAsync` methods are pre-configured. - -See our [configuration](configuration.md) topic to learn more about customizing this analyzer. - -This analyzer also recognizes requirements to use the main thread transitively within your solution. -For example, if method `A()` invokes a type that we know from configuration requires the main thread, -and `B()` calls `A()`, then the `B` method also needs the UI thread transitively. -This analyzer flags `B()` as needing to call a method that throws if not already on the main thread -only when `A()` is written to call such a method. - -**NOTE:** This analyzer requires [full solution analysis](fsa.md). - -## Examples of patterns that are flagged by this analyzer - -This example is based on the configuration available from the Visual Studio SDK -that defines `IVs*` interfaces as requiring the main thread. - -```csharp -private void CallVS() -{ - IVsSolution sln = GetIVsSolution(); - sln.SetProperty(); // This analyzer will report warning on this invocation. -} -``` - -## Solution - -First ensure you are running on the main thread before interacting with single-threaded objects. -Either throw when you are not on the appropriate thread, or explicitly switch to the -main thread. - -This solution example is based on the configuration available from the Visual Studio SDK -that defines `ThreadHelper.ThrowIfNotOnUIThread()` as one which throws if the caller -is not already on the main thread. - -```csharp -private void CallVS() -{ - ThreadHelper.ThrowIfNotOnUIThread(); - IVsSolution sln = GetIVsSolution(); - sln.SetProperty(); // This analyzer will not report warning on this invocation. -} - -private async Task CallVSAsync() -{ - await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(); - IVsSolution sln = GetIVsSolution(); - sln.SetProperty(); // This analyzer will not report warning on this invocation. -} -``` - -Refer to [Asynchronous and multithreaded programming within VS using the JoinableTaskFactory](https://devblogs.microsoft.com/premier-developer/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/) for more info. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD010.html). diff --git a/doc/analyzers/VSTHRD011.md b/doc/analyzers/VSTHRD011.md index 40b7e94fe..8bd47dc63 100644 --- a/doc/analyzers/VSTHRD011.md +++ b/doc/analyzers/VSTHRD011.md @@ -1,57 +1 @@ -# VSTHRD011 Use `AsyncLazy` - -The `Lazy` type executes the value factory just once and -the value factory inherits the context of the first one to request the -`Lazy.Value` property's value. This can lead to deadlocks when -the value factory attempts to switch to the main thread. - -## Examples of patterns that are flagged by this analyzer - -### Using `Lazy` where `T` is `Task` - -When `T` is `Task` (because the value factory is an async method), -if the first caller had no access to the main thread, and the value factory -requires it, it will block. If later a second caller calls the `Value` property -and that second caller is blocking the UI thread for its result, it will deadlock. - -```csharp -var lazy = new Lazy>(async delegate // analyzer flags this line -{ - await Task.Yield(); - return 3; -}); - -int value = await lazy.Value; -``` - -### Using synchronously blocking methods in `Lazy` value factories - -When the value factory passed to the `Lazy` constructor calls synchronously -blocking methods such as `JoinableTaskFactory.Run`, only the first caller -can help any required transition to the main thread. - -```csharp -var lazy = new Lazy(delegate -{ - return joinableTaskFactory.Run(async delegate { // analyzer flags this line - int result = await SomeAsyncMethod(); - return result + 3; - }); -}); - -int value = lazy.Value; -``` - -## Solution - -Use `AsyncLazy` with an async value factory: - -```csharp -var lazy = new AsyncLazy(async delegate -{ - await Task.Yield(); - return 3; -}); - -int value = await lazy.GetValueAsync(); -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD011.html). diff --git a/doc/analyzers/VSTHRD012.md b/doc/analyzers/VSTHRD012.md index 31710a1cb..7c2578ea7 100644 --- a/doc/analyzers/VSTHRD012.md +++ b/doc/analyzers/VSTHRD012.md @@ -1,33 +1 @@ -# VSTHRD012 Provide `JoinableTaskFactory` where allowed - -When constructing types or calling methods that accept a `JoinableTaskFactory` -or `JoinableTaskContext`, take the opportunity to supply one if your application -has a main thread with a single threaded `SynchronizationContext` such as WPF or WinForms. - -## Examples of patterns that are flagged by this analyzer - -```csharp -void F() { - var o = new AsyncLazy(() => Task.FromResult(1)); // analyzer flags this line -} -``` - -## Solution - -Call the overload that accepts a `JoinableTaskFactory` or `JoinableTaskContext` instance: - -```csharp -void F() { - var o = new AsyncLazy(() => Task.FromResult(1), this.JoinableTaskFactory); -} -``` - -## Suppression - -You can suppress the diagnostic by explicitly specifying `null` for the argument: - -```csharp -void F() { - var o = new AsyncLazy(() => Task.FromResult(1), null); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD012.html). diff --git a/doc/analyzers/VSTHRD100.md b/doc/analyzers/VSTHRD100.md index b1a7278d5..25d170bfe 100644 --- a/doc/analyzers/VSTHRD100.md +++ b/doc/analyzers/VSTHRD100.md @@ -1,56 +1 @@ -# VSTHRD100 Avoid `async void` methods - -Methods with `async void` signatures make it impossible for their caller to track -the entire asynchronous operation and handle exceptions that may be thrown by that method. -If the method throws an exception, it crashes the process. - -## Examples of patterns that are flagged by this analyzer - -```csharp -async void DoSomethingAsync() -{ - await SomethingElseAsync(); -} -``` - -## Solution - -Change the method to return `Task` instead of `void`. - -```csharp -async Task DoSomethingAsync() -{ - await SomethingElseAsync(); -} -``` - -A code fix is offered that automatically changes the return type of the method. - -### Event handlers - -For event handlers, avoid `async void` by using `RunAsync`: -```csharp -obj.Event += (s, e) => joinableTaskFactory.RunAsync(() => OnEventAsync(s, e)); -} - -private async Task OnEventAsync(object sender, EventArgs e) -{ - // async code here. -} -``` - -When using method group syntax as an argument, you can define the method with the required signature, without the `async` modifier, and define an anonymous delegate or lambda within the method, like this: - -```cs -var menuItem = new MenuCommand(HandleEvent, commandId); - -private void HandleEvent(object sender, EventArgs e) -{ - _ = joinableTaskFactory.RunAsync(async () => - { - // async code - }); -} -``` - -Refer to [Async/Await - Best Practices in Asynchronous Programming](https://msdn.microsoft.com/en-us/magazine/jj991977.aspx) for more info. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD100.html). diff --git a/doc/analyzers/VSTHRD101.md b/doc/analyzers/VSTHRD101.md index 10f9e411d..1c842e532 100644 --- a/doc/analyzers/VSTHRD101.md +++ b/doc/analyzers/VSTHRD101.md @@ -1,71 +1 @@ -# VSTHRD101 Avoid unsupported async delegates - -C# allows you to define async delegates or lambdas and use them in contexts that accept -void-returning delegates, thus creating an `async void` method such as is forbidden by -[VSTHRD100](VSTHRD100.md), but is much harder to catch when simply looking at the code -because for the same syntax, the C# compiler will create an `async Func` delegate -or an `async void` delegate based on the type expected by the method being invoked. - -This analyzer helps prevent inadvertent creation of `async void` delegates. - -## Examples of patterns that are flagged by this analyzer - -```csharp -void StartWatching(ObservableCollection oc) -{ - // This delegate becomes an "async void" method to match the EventHandler delegate type. - oc.CollectionChanged += async () => - { - await Task.Yield(); - }; -} - -void StartWatching(ObservableCollection oc) -{ - // This delegate becomes an "async void" method to match the Action delegate type. - Callback(async () => - { - await Task.Yield(); - }); -} - -void Callback(Action action) -{ - // out of scope of sample -} -``` - -## Solution - -1. Wrap the asynchronous behavior in another method that accepts a `Func` delegate. -1. Change the receiving method's expected delegate type to one that returns a `Task` or `Task`. -1. Implement the delegate synchronously. - -```csharp -void StartWatching(ObservableCollection oc) -{ - oc.CollectionChanged += () => - { - // The outer delegate is synchronous, but kicks off async work via a method that accepts an async delegate. - joinableTaskFactory.RunAsync(async delegate { - await Task.Yield(); - }); - }; -} - -void StartWatching(ObservableCollection oc) -{ - // This delegate becomes an "async Task" method to match the Func delegate type. - Callback(async () => - { - await Task.Yield(); - }); -} - -void Callback(Func action) -{ - // out of scope of sample -} -``` - -Refer to [Async/Await - Best Practices in Asynchronous Programming](https://msdn.microsoft.com/en-us/magazine/jj991977.aspx) for more info. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD101.html). diff --git a/doc/analyzers/VSTHRD102.md b/doc/analyzers/VSTHRD102.md index 60ba1cb71..4d83049f2 100644 --- a/doc/analyzers/VSTHRD102.md +++ b/doc/analyzers/VSTHRD102.md @@ -1,56 +1 @@ -# VSTHRD102 Implement internal logic asynchronously - -Internal or private methods may be invoked by public methods that are asynchronous. -If the internal method has an opportunity to do work asynchronously, it should do so -in order that async public members can truly be async. - -## Examples of patterns that are flagged by this analyzer - -```csharp -public void PublicMethod() -{ - DoWork(); -} - -public async Task PublicMethodAsync() -{ - DoWork(); - await Task.Yield(); -} - -internal void DoWork() -{ - joinableTaskFactory.Run(async delegate // Analyzer will flag this line - { - await DoSomethingAsync(); - }); -} -``` - -Note how `DoWork()` synchronously blocks for both `PublicMethod()` and `PublicMethodAsync()`. - -## Solution - -Remove the synchronously blocking behavior and make the method async. - -```csharp -public void PublicMethod() -{ - joinableTaskFactory.Run(() => PublicMethodAsync()); -} - -public async Task PublicMethodAsync() -{ - await DoWorkAsync(); - await Task.Yield(); -} - -internal async Task DoWorkAsync() -{ - await DoSomethingAsync(); -} -``` - -Note how `DoWorkAsync()` now allows `PublicMethodAsync()` to do its work asynchronously -while `PublicMethod()` continues to synchronously block, giving your external caller the option -as to whether to do work asynchronously or synchronously. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD102.html). diff --git a/doc/analyzers/VSTHRD103.md b/doc/analyzers/VSTHRD103.md index 348032057..6a94121a9 100644 --- a/doc/analyzers/VSTHRD103.md +++ b/doc/analyzers/VSTHRD103.md @@ -1,29 +1 @@ -# VSTHRD103 Call async methods when in an async method - -In a method which is already asynchronous, calls to other methods should -be to their async versions, where they exist. - -## Examples of patterns that are flagged by this analyzer - -```csharp -Task DoAsync() -{ - file.Read(buffer, 0, 10); -} -``` - -All methods where an Async-suffixed equivalent exists will produce this warning -when called from a `Task`-returning method. -In addition, calling `Task.Wait()`, `Task.Result` or `Task.GetAwaiter().GetResult()` -will produce this warning. - -## Solution - -Await the async version of the method: - -```csharp -async Task DoAsync() -{ - await file.ReadAsync(buffer, 0, 10); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD103.html). diff --git a/doc/analyzers/VSTHRD104.md b/doc/analyzers/VSTHRD104.md index aabbe5722..41e426712 100644 --- a/doc/analyzers/VSTHRD104.md +++ b/doc/analyzers/VSTHRD104.md @@ -1,36 +1 @@ -# VSTHRD104 Offer async option - -When a publicly accessible method uses `JoinableTaskFactory.Run`, there should be -another way to access the async behavior without synchronously blocking the thread -so that an async caller can be async throughout. - -This rule encourages this pattern by recognizing when some method *Foo* exists and -calls `JoinableTaskFactory.Run` that there is also a method *FooAsync*. -The recommended pattern then is for *Foo* to call *FooAsync* from the delegate -passed to `JoinableTaskFactory.Run` so that the implementation only need be written once. - -## Examples of patterns that are flagged by this analyzer - -```csharp -public void Foo() { - this.joinableTaskFactory.Run(async delegate { - await Task.Yield(); - }); -} -``` - -## Solution - -Add a FooAsync method, and (optionally) call it from the Foo method: - -```csharp -public void Foo() { - this.joinableTaskFactory.Run(async delegate { - await FooAsync(); - }); -} - -public async Task FooAsync() { - await Task.Yield(); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD104.html). diff --git a/doc/analyzers/VSTHRD105.md b/doc/analyzers/VSTHRD105.md index 06c3e34a4..62c8b7a7e 100644 --- a/doc/analyzers/VSTHRD105.md +++ b/doc/analyzers/VSTHRD105.md @@ -1,83 +1 @@ -# VSTHRD105 Avoid method overloads that assume `TaskScheduler.Current` - -Certain methods in the .NET Framework have overloads that allow specifying or omitting -a `TaskScheduler` instance. Always specify one explicitly to avoid the assumed `TaskScheduler.Current` -value, whose behavior is defined by your caller and may vary at runtime. - -The "current" `TaskScheduler` is defined by the one that is executing the currently running code. -But when your code is executing without having been scheduled by a `TaskScheduler` (as is the case with most code), -then the `TaskScheduler.Current` property returns `TaskScheduler.Default` which schedules tasks on the thread pool. -This leads many to incorrectly assume that task scheduling methods such as `StartNew` and `ContinueWith` default -to using the thread pool when in fact their default behavior varies by your caller. - -This variability in behavior leads to bugs when, for example, `TaskScheduler.Current` returns a `TaskScheduler` -that executes tasks on the application's main thread and/or only executes one task at once, such as one obtained -from the `TaskScheduler.FromCurrentSynchronizationContext()` method. -Such a circumstance often leads to deadlocks or responsiveness issues in the application. - -Always explicitly specifying `TaskScheduler.Default` (or other if appropriate) ensures your code will schedule -tasks in a predictable, consistent way. - -No diagnostic is produced by this analyzer when `TaskFactory.StartNew` is invoked on a private instance -of `TaskFactory`, since it may in fact have a safe default for `TaskScheduler`. - -Similar rules: [CA2008 (DoNotCreateTasksWithoutPassingATaskSchedulerAnalyzer)](https://github.com/dotnet/roslyn-analyzers/blob/32d8f1e397439035f0ecb5f61a9e672225f0ecdb/src/Microsoft.NetCore.Analyzers/Core/Tasks/DoNotCreateTasksWithoutPassingATaskScheduler.cs) - -## Examples of patterns that are flagged by this analyzer - -```csharp -private void FirstMethod() -{ - TaskScheduler uiScheduler = TaskScheduler.FromCurrentSynchronizationContext(); - Task.Factory.StartNew( - () => - { - this.AnotherMethod(); - }, - System.Threading.CancellationToken.None, - TaskCreationOptions.None, - uiScheduler); -} - -private void AnotherMethod() -{ - // TaskScheduler.Current is assumed here, which is determined by our caller. - var nestedTask = Task.Factory.StartNew( // analyzer flags this line - () => - { - // Ooops, we're still on the UI thread when called by FirstMethod. - // But we might be on the thread pool if someone else called us. - }); -} -``` - -## Solution - -Specify a `TaskScheduler` explicitly to suppress the warning: - -```csharp -private void FirstMethod() -{ - TaskScheduler uiScheduler = TaskScheduler.FromCurrentSynchronizationContext(); - Task.Factory.StartNew( - () => - { - this.AnotherMethod(); - }, - CancellationToken.None, - TaskCreationOptions.None, - uiScheduler); -} - -private void AnotherMethod() -{ - var nestedTask = Task.Factory.StartNew( - () => - { - // Ah, now we're reliably running on the thread pool. :) - }, - CancellationToken.None, - TaskCreationOptions.None, - TaskScheduler.Default); // Specify TaskScheduler explicitly here. -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD105.html). diff --git a/doc/analyzers/VSTHRD106.md b/doc/analyzers/VSTHRD106.md index f47fc46ce..8a34ed3aa 100644 --- a/doc/analyzers/VSTHRD106.md +++ b/doc/analyzers/VSTHRD106.md @@ -1,31 +1 @@ -# VSTHRD106 Use `InvokeAsync` to raise async events - -Asynchronous events (those typed as `AsyncEventHandler`) must be raised carefully to ensure -all event handlers are invoked and awaited on. - -Although C# lets you invoke event handlers naturally, it has no awareness of async event handlers -and thus will not let you correctly await on their invocation nor invoke them sequentially. - -## Examples of patterns that are flagged by this analyzer - -```csharp -public AsyncEventHandler Clicked; - -async Task OnClicked() { - await Clicked(this, EventArgs.Empty); // only awaits the first event handler. -} -``` - -## Solution - -Use the `InvokeAsync` extension method defined in the `TplExtensions` class and await its result. -This will ensure each event handler completes before invoking the next event handler in the list, -similar to the default behavior for raising synchronous events. - -```csharp -public AsyncEventHandler Clicked; - -async Task OnClicked() { - await Clicked.InvokeAsync(this, EventArgs.Empty); // await for the completion of all handlers. -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD106.html). diff --git a/doc/analyzers/VSTHRD107.md b/doc/analyzers/VSTHRD107.md index 8694cf2ea..76dab4581 100644 --- a/doc/analyzers/VSTHRD107.md +++ b/doc/analyzers/VSTHRD107.md @@ -1,27 +1 @@ -# VSTHRD107 Await Task within using expression - -The C# `using` statement requires that the used expression implement `IDisposable`. -Because `Task` implements `IDisposable`, one may accidentally omit an `await` operator -and `Dispose` of the `Task` instead of the `T` result itself when `T` derives from `IDisposable`. - -## Examples of patterns that are flagged by this analyzer - -```csharp -AsyncSemaphore lck; -using (lck.EnterAsync()) -{ - // ... -} -``` - -## Solution - -Add the `await` operator within the `using` expression. - -```csharp -AsyncSemaphore lck; -using (await lck.EnterAsync()) -{ - // ... -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD107.html). diff --git a/doc/analyzers/VSTHRD108.md b/doc/analyzers/VSTHRD108.md index c2b986e2a..9771719f3 100644 --- a/doc/analyzers/VSTHRD108.md +++ b/doc/analyzers/VSTHRD108.md @@ -1,46 +1 @@ -# VSTHRD108 Assert thread affinity unconditionally - -When a method has thread affinity and throws if called from the wrong thread, it should do so without regard to any other condition. This helps ensure the caller will notice early during development that they are calling from the wrong thread. Extra conditions can hide the problem till end users discover an application failure. - -## Examples of patterns that are flagged by this analyzer - -```csharp -private int? age; - -public int GetAge() -{ - if (!this.age.HasValue) - { - ThreadHelper.ThrowIfNotOnUIThread(); - this.age = DoExpensiveUIThreadWork(); - } - - return this.age.Value; -} -``` - -The problem here is that although the UI thread is only strictly required when the field is actually initialized, callers generally cannot predict whether they will be the first or a subsequent caller. If they call from a background thread and tend to be a subsequent caller, no exception will be thrown. But under some conditions in the app when they happen to be the first caller, they'll fail at runtime because they're calling from the background thread. - -## Solution - -Move the code that throws when not on the UI thread outside the conditional block. - -```csharp -private int? age; - -public int GetAge() -{ - ThreadHelper.ThrowIfNotOnUIThread(); - if (!this.age.HasValue) - { - this.age = DoExpensiveUIThreadWork(); - } - - return this.age.Value; -} -``` - -## Configuration - -This analyzer is configurable via the `vs-threading.MainThreadAssertingMethods.txt` file. -See our [configuration](configuration.md) topic for more information. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD108.html). diff --git a/doc/analyzers/VSTHRD109.md b/doc/analyzers/VSTHRD109.md index 7e28198b7..d0792db4a 100644 --- a/doc/analyzers/VSTHRD109.md +++ b/doc/analyzers/VSTHRD109.md @@ -1,29 +1 @@ -# VSTHRD109 Switch instead of assert in async methods - -Methods that are or can be async should switch to the main thread when necessary -rather than throw an exception if invoked from a different thread. -This allows callers to invoke any async method from any thread -without having to concern themselves with the threading requirements of a method that -can support its own threading requirements by switching. - -## Examples of patterns that are flagged by this analyzer - -```csharp -async Task FooAsync() { - ThreadHelper.ThrowIfNotOnUIThread(); - DoStuff(); - await DoMoreStuff(); -} -``` - -## Solution - -Use `await SwitchToMainThreadAsync()` instead: - -```csharp -async Task FooAsync() { - await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(); - DoStuff(); - await DoMoreStuff(); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD109.html). diff --git a/doc/analyzers/VSTHRD110.md b/doc/analyzers/VSTHRD110.md index 7aa764f52..42bb17ab1 100644 --- a/doc/analyzers/VSTHRD110.md +++ b/doc/analyzers/VSTHRD110.md @@ -1,75 +1 @@ -# VSTHRD110 Observe result of async calls - -Tasks returned from async methods should be awaited, or assigned to a variable for observation later. -Methods that return `Task`s often complete and report their work via the `Task` they return, and simply -invoking the method does not guarantee that its work is complete nor successful. Using the `await` keyword -just before the method call causes execution of the calling method to effectively suspend until the called -method has completed and rethrows any exception thrown by the method. - -When a `Task` or `Task` is returned and is not awaited or redirected in some other way, -within the context of a synchronous method, a warning is reported. - -This rule does *not* apply to calls made within async methods, since [CS4014][CS4014] already reports these. - -## Examples of patterns that are flagged by this analyzer - -```csharp -void Foo() { - DoStuffAsync(); -} - -async Task DoStuffAsync() { /* ... */ } -``` - -## Solution - -Convert the method to be async and await the expression: - -```csharp -async Task FooAsync() { - await DoStuffAsync(); -} - -async Task DoStuffAsync() { /* ... */ } -``` - -When the calling method's signature cannot be changed, wrap the method body in a `JoinableTaskFactory.Run` delegate instead: - -```csharp -void Foo() { - jtf.Run(async delegate { - await DoStuffAsync(); - }); -} - -async Task DoStuffAsync() { /* ... */ } -``` - -One other option is to assign the result of the method call to a field or local variable, presumably to track it later: - -```csharp -void Foo() { - Task watchThis = DoStuffAsync(); -} - -async Task DoStuffAsync() { /* ... */ } -``` - -When tracking the `Task` with a field, remember that to await it later without risk of deadlocking, -wrap it in a `JoinableTask` using `JoinableTaskFactory.RunAsync`, per [the 3rd rule](../threading_rules.md#Rule3). - -```csharp -JoinableTask watchThis; - -void Foo() { - this.watchThis = jtf.RunAsync(() => DoStuffAsync()); -} - -async Task WaitForFooToFinishAsync() { - await this.watchThis; -} - -async Task DoStuffAsync() { /* ... */ } -``` - -[CS4014]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs4014 +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD110.html). diff --git a/doc/analyzers/VSTHRD111.md b/doc/analyzers/VSTHRD111.md index 0495e84f0..7cd14fe7a 100644 --- a/doc/analyzers/VSTHRD111.md +++ b/doc/analyzers/VSTHRD111.md @@ -1,38 +1 @@ -# VSTHRD111 Use `.ConfigureAwait(bool)` - -Some code bases, particularly libraries with no affinity to an app's UI thread, are advised to use `.ConfigureAwait(false)` for each and every _await_ because it can avoid deadlocks after those calls start on an application's UI thread and the app later decides to synchronously block the UI thread waiting for those tasks to finish. Using `.ConfigureAwait(false)` also allows continuations to switch to a background thread even when no synchronous blocking would cause a deadlock, which makes for a more responsive application and possibly higher throughput of async operations. - -Note that this scenario can also be solved using the `JoinableTaskFactory`, but many class libraries may not wish to depend on the application proffers an instance of that type to the library. Where JoinableTaskFactory _does_ apply, use of `.ConfigureAwait(false)` is _not_ recommended. See [this topic](https://github.com/Microsoft/vs-threading/blob/main/doc/cookbook_vs.md#should-i-await-a-task-with-configureawaitfalse) for more on when `.ConfigureAwait(false)` and `.ConfigureAwait(true)` are appropriate. - -**This analyzer's diagnostics are *hidden* by default**. You should enable the rule for libraries that use to require this await suffix. - -## Examples of patterns that are flagged by this analyzer - -Any await on `Task` or `ValueTask` without the `.ConfigureAwait(bool)` method called on it will be flagged. - -```csharp -async Task FooAsync() { - await DoStuffAsync(); // This line is flagged - await DoMoreStuffAsync(); // This line is flagged -} - -async Task DoStuffAsync() { /* ... */ } -async ValueTask DoMoreStuffAsync() { /* ... */ } -``` - -## Solution - -Add `.ConfigureAwait(false)` or `.ConfigureAwait(true)` to the awaited `Task` or `ValueTask`. - -```csharp -async Task FooAsync() { - await DoStuffAsync().ConfigureAwait(true); - await DoMoreStuffAsync().ConfigureAwait(false); -} - -async Task DoStuffAsync() { /* ... */ } -async ValueTask DoMoreStuffAsync() { /* ... */ } -``` - -Code fixes are offered for for this diagnostic to add either `.ConfigureAwait(false)` or `.ConfigureAwait(true)` -to an awaited expression. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD111.html). diff --git a/doc/analyzers/VSTHRD112.md b/doc/analyzers/VSTHRD112.md index b9e3ae45c..edc8f6772 100644 --- a/doc/analyzers/VSTHRD112.md +++ b/doc/analyzers/VSTHRD112.md @@ -1,66 +1 @@ -# VSTHRD112 Implement `System.IAsyncDisposable` - -The `Microsoft.VisualStudio.Threading.IAsyncDisposable` interface is obsolete now that the -`System.IAsyncDisposable` interface has been defined for .NET Standard 2.0 and .NET Framework 4.6.1 -by the [`Microsoft.Bcl.AsyncInterfaces` NuGet package](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces). - -New classes looking to support async disposable should use `System.IAsyncDisposable` instead of `Microsoft.VisualStudio.Threading.IAsyncDisposable`. -Existing classes that already implement `Microsoft.VisualStudio.Threading.IAsyncDisposable` should *also* implement `System.IAsyncDisposable` so the async disposal option will be recognized by code that only checks for presence of the new interface. - -## Examples of patterns that are flagged by this analyzer - -This class only implements `Microsoft.VisualStudio.Threading.IAsyncDisposable` and will produce the VSTHRD112 diagnostic: - -```cs -using Microsoft.VisualStudio.Threading; - -class SomeClass : IAsyncDisposable -{ - public Task DisposeAsync() - { - } -} -``` - -## Solution - -Implement `System.IAsyncDisposable` in addition to (or instead of) `Microsoft.VisualStudio.Threading.IAsyncDisposable`. -Add a package reference to `Microsoft.Bcl.AsyncInterfaces` if the compiler cannot find `System.IAsyncDisposable`. - -In this example, only `System.IAsyncDisposable` is supported, which is acceptable: - -```cs -using System; - -class SomeClass : IAsyncDisposable -{ - public ValueTask DisposeAsync() - { - } -} -``` - -In this next example, both interfaces are supported: - -```cs -class SomeClass : System.IAsyncDisposable, Microsoft.VisualStudio.Threading.IAsyncDisposable -{ - Task Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() - { - // Simply forward the call to the other DisposeAsync overload. - System.IAsyncDisposable self = this; - return self.DisposeAsync().AsTask(); - } - - ValueTask System.IAsyncDisposable.DisposeAsync() - { - // Interesting dispose logic here. - } -} -``` - -In the above example both `DisposeAsync` methods are explicit interface implementations. -Promoting one of the methods to be `public` is typically advised. -If one of these methods was already public and the class itself is public or protected, keep the same method public to avoid an API binary breaking change. - -An automated code fix may be offered for VSTHRD112 diagnostics. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD112.html). diff --git a/doc/analyzers/VSTHRD113.md b/doc/analyzers/VSTHRD113.md index 8d4dee677..547e22219 100644 --- a/doc/analyzers/VSTHRD113.md +++ b/doc/analyzers/VSTHRD113.md @@ -1,37 +1 @@ -# VSTHRD113 Check for `System.IAsyncDisposable` - -The `Microsoft.VisualStudio.Threading.IAsyncDisposable` interface is obsolete now that the -`System.IAsyncDisposable` interface has been defined for .NET Standard 2.0 and .NET Framework 4.6.1 -by the [`Microsoft.Bcl.AsyncInterfaces` NuGet package](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces). - -Existing code that tests for the `Microsoft.VisualStudio.Threading.IAsyncDisposable` interface on some object should also check for `System.IAsyncDisposable` and behave similarly in either case. -New code should consider only supporting the new `System.IAsyncDisposable` interface. - -## Examples of patterns that are flagged by this analyzer - -The following code only checks for the obsolete interface and is flagged by this diagnostic: - -```cs -using Microsoft.VisualStudio.Threading; - -if (obj is IAsyncDisposable asyncDisposable) -{ - await asyncDisposable.DisposeAsync(); -} -``` - -## Solution - -Fix this by adding a code branch for the new interface that behaves similarly -within the same containing code block: - -```cs -if (obj is Microsoft.VisualStudio.Threading.IAsyncDisposable vsThreadingAsyncDisposable) -{ - await vsThreadingAsyncDisposable.DisposeAsync(); -} -else if (obj is System.IAsyncDisposable bclAsyncDisposable) -{ - await bclAsyncDisposable.DisposeAsync(); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD113.html). diff --git a/doc/analyzers/VSTHRD114.md b/doc/analyzers/VSTHRD114.md index c20c3fb53..d7822f8ca 100644 --- a/doc/analyzers/VSTHRD114.md +++ b/doc/analyzers/VSTHRD114.md @@ -1,31 +1 @@ -# VSTHRD114 Avoid returning a null Task - -Returning `null` from a non-async `Task`/`Task` method will cause a `NullReferenceException` at runtime. This problem can be avoided by returning `Task.CompletedTask`, `Task.FromResult(null)` or `Task.FromResult(default(T))` instead. - -## Examples of patterns that are flagged by this analyzer - -Any non-async `Task` returning method with an explicit `return null;` will be flagged. - -```csharp -Task DoAsync() { - return null; -} - -Task GetSomethingAsync() { - return null; -} -``` - -## Solution - -Return a task like `Task.CompletedTask` or `Task.FromResult`. - -```csharp -Task DoAsync() { - return Task.CompletedTask; -} - -Task GetSomethingAsync() { - return Task.FromResult(null); -} -``` +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD114.html). diff --git a/doc/analyzers/VSTHRD115.md b/doc/analyzers/VSTHRD115.md index 5e1560911..419b7bf3c 100644 --- a/doc/analyzers/VSTHRD115.md +++ b/doc/analyzers/VSTHRD115.md @@ -1,38 +1 @@ -# VSTHRD115 Avoid creating a JoinableTaskContext with an explicit `null` `SynchronizationContext` - -Constructing a `JoinableTaskContext` with an explicit `null` `SynchronizationContext` is not recommended as a means to construct an instance for use in unit tests or processes without a main thread. -This is because the constructor will automatically use `SynchronizationContext.Current` in lieu of a non-`null` argument. -If `SynchronizationContext.Current` happens to be non-`null`, the constructor may unexpectedly configure the new instance as if a main thread were present. - -## Examples of patterns that are flagged by this analyzer - -```csharp -void SetupJTC() { - this.jtc = new JoinableTaskContext(null, null); -} -``` - -This code *appears* to configure the `JoinableTaskContext` to not be associated with any `SynchronizationContext`. -But in fact it will be associated with the current `SynchronizationContext` if one is present. - -## Solution - -If you intended to inherit `SynchronizationContext.Current` to initialize with a main thread, -provide that value explicitly as the second argument to suppress the warning: - -```cs -void SetupJTC() { - this.jtc = new JoinableTaskContext(null, SynchronizationContext.Current); -} -``` - -If you intended to create a `JoinableTaskContext` for use in a unit test or in a process without a main thread, -call `JoinableTaskContext.CreateNoOpContext()` instead: - -```cs -void SetupJTC() { - this.jtc = JoinableTaskContext.CreateNoOpContext(); -} -``` - -Code fixes are offered to update code to either of the above patterns. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD115.html). diff --git a/doc/analyzers/VSTHRD200.md b/doc/analyzers/VSTHRD200.md index 3f87cf273..abe7406d3 100644 --- a/doc/analyzers/VSTHRD200.md +++ b/doc/analyzers/VSTHRD200.md @@ -1,47 +1 @@ -# VSTHRD200 Use `Async` suffix for async methods - -The .NET Guidelines for async methods includes that such methods -should have names that include an "Async" suffix. - -Methods that return awaitable types such as `Task` or `ValueTask` -should have an Async suffix. -Methods that do not return awaitable types should not use the Async suffix. - -## Examples of patterns that are flagged by this analyzer - -This `Task`-returning method should have a name that ends with Async: - -```csharp -async Task DoSomething() // analyzer flags this line -{ - await Task.Yield(); -} -``` - -This method should not have a name that ends with Async, since it does not return an awaitable type: - -```csharp -bool DoSomethingElseAsync() // analyzer flags this line -{ - return false; -} -``` - -## Solution - -Simply rename the method to end in "Async" (or remove the suffix, as appropriate): - -```csharp -async Task DoSomethingAsync() -{ - await Task.Yield(); -} - -bool DoSomethingElse() -{ - return false; -} -``` - - -A code fix exists to automatically rename such methods. +This content has been moved to [GitHub Pages](https://microsoft.github.io/vs-threading/analyzers/VSTHRD200.html). diff --git a/doc/analyzers/editorconfigs/AppWithMainThread.editorconfig b/doc/editorconfigs/AppWithMainThread.editorconfig similarity index 100% rename from doc/analyzers/editorconfigs/AppWithMainThread.editorconfig rename to doc/editorconfigs/AppWithMainThread.editorconfig diff --git a/doc/analyzers/editorconfigs/AppWithoutMainThread.editorconfig b/doc/editorconfigs/AppWithoutMainThread.editorconfig similarity index 100% rename from doc/analyzers/editorconfigs/AppWithoutMainThread.editorconfig rename to doc/editorconfigs/AppWithoutMainThread.editorconfig diff --git a/doc/analyzers/editorconfigs/JTFFocusedLibrary.editorconfig b/doc/editorconfigs/JTFFocusedLibrary.editorconfig similarity index 100% rename from doc/analyzers/editorconfigs/JTFFocusedLibrary.editorconfig rename to doc/editorconfigs/JTFFocusedLibrary.editorconfig diff --git a/doc/analyzers/editorconfigs/README.md b/doc/editorconfigs/README.md similarity index 97% rename from doc/analyzers/editorconfigs/README.md rename to doc/editorconfigs/README.md index cc2e2366a..4fbffaa7b 100644 --- a/doc/analyzers/editorconfigs/README.md +++ b/doc/editorconfigs/README.md @@ -25,7 +25,7 @@ While several project types have specific .editorconfig files defined in this fo Libraries that may run in any process, whether they have a main thread or not, should code themselves defensively to avoid any dependency on the main thread so that applications that do not follow `JoinableTaskFactory` rules can avoid deadlocks even when synchronously blocking their main thread using `Task.Wait()` on code running inside your library. In particular, shared libraries of general interest should _always_ use `.ConfigureAwait(false)` when awaiting on tasks. -[Learn more about authoring libraries following best threading practices](../../library_with_jtf.md). +[Learn more about authoring libraries following best threading practices](https://microsoft.github.io/vs-threading/docs/library_with_jtf.md). ### Libraries that run inside a JoinableTaskFactory-compliant application diff --git a/doc/analyzers/editorconfigs/SharedLibrary.editorconfig b/doc/editorconfigs/SharedLibrary.editorconfig similarity index 100% rename from doc/analyzers/editorconfigs/SharedLibrary.editorconfig rename to doc/editorconfigs/SharedLibrary.editorconfig diff --git a/doc/analyzers/editorconfigs/Tests.editorconfig b/doc/editorconfigs/Tests.editorconfig similarity index 100% rename from doc/analyzers/editorconfigs/Tests.editorconfig rename to doc/editorconfigs/Tests.editorconfig diff --git a/doc/index.md b/doc/index.md deleted file mode 100644 index 7c65607ed..000000000 --- a/doc/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# Threading documentation - -## Overview - -* [3 Threading Rules](threading_rules.md) -* [Diagnostic analyzer rules](analyzers/index.md) -* [Cookbook for Visual Studio](cookbook_vs.md) -* [Testing a Visual Studio extension that uses JoinableTaskFactory](testing_vs.md) -* [Authoring a library with a JoinableTaskFactory dependency](library_with_jtf.md) - -## Performance and responsiveness investigation techniques - -* [Async hang investigations](async_hang.md) -* [Investigating Threadpool starvation issues](threadpool_starvation.md) diff --git a/docfx/analyzers/VSTHRD001.md b/docfx/analyzers/VSTHRD001.md new file mode 100644 index 000000000..1dd47c1ac --- /dev/null +++ b/docfx/analyzers/VSTHRD001.md @@ -0,0 +1,82 @@ +# VSTHRD001 Avoid legacy thread switching methods + +Switching to the UI thread should be done using `JoinableTaskFactory.SwitchToMainThreadAsync` +rather than legacy methods such as `Dispatcher.Invoke` or `ThreadHelper.Invoke`. +This avoids deadlocks and can reduce threadpool starvation. + +## Examples of patterns that are flagged by this analyzer + +```csharp +ThreadHelper.Generic.Invoke(delegate { + DoSomething(); +}); +``` + +or + +```cs +Dispatcher.CurrentDispatcher.BeginInvoke(delegate { + DoSomething(); +}); +``` + +## Solution + +Use `await SwitchToMainThreadAsync()` instead, wrapping with the `JoinableTaskFactory`'s `Run` or `RunAsync` method if necessary: + +```csharp +void Foo() { + ThreadHelper.JoinableTaskFactory.Run(async delegate { + await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(); + DoSomething(); + }); +} +``` + +In the above example, we obtain a `JoinableTaskFactory` instance from the `ThreadHelper.JoinableTaskFactory` static property +as it exists within Visual Studio itself. Other applications should create and expose their own `JoinableTaskContext` and/or `JoinableTaskFactory` for use in code that run in these applications. +See our doc on [consuming `JoinableTaskFactory` from a library](https://github.com/microsoft/vs-threading/blob/main/doc/library_with_jtf.md) for more information. + +### Replacing Dispatcher.BeginInvoke + +When updating calls to `Dispatcher.BeginInvoke`, there are a few considerations to consider. + +1. `BeginInvoke` schedules the delegate for execution later. +1. `BeginInvoke` always executes the delegate on the dispatcher's thread. +1. `BeginInvoke` schedules the delegate at some given priority, or default priority determined by the dispatcher. + +To resolve a warning for such code, it is often sufficient to replace it with this, which is *roughly* equivalent: + +```cs +await joinableTaskFactory.RunAsync(async delegate { + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); + DoSomething(); +}) +``` + +The first line in the delegate is necessary to match the behaviors of 1 and 2 on the above list. +When the caller is known to already be on the main thread, you can simplify it slightly to this: + +```cs +await joinableTaskFactory.RunAsync(async delegate { + await Task.Yield(); + DoSomething(); +}) +``` + +Matching behavior 3 on the list above may be important when the dispatcher priority is specified in the BeginInvoke call and was chosen for a particular reason. +In such a case, you can ensure that `JoinableTaskFactory` matches that priority instead of using its default by creating a special `JoinableTaskFactory` instance with the priority setting you require using the [`JoinableTaskFactory.WithPriority`](https://learn.microsoft.com/dotnet/api/microsoft.visualstudio.threading.dispatcherextensions.withpriority?view=visualstudiosdk-2022) method. + +Altogether, this might look like: + +```cs +await joinableTaskFactory.WithPriority(DispatcherPriority.DataBind).RunAsync(async delegate { + await joinableTaskFactory.SwitchToMainThreadAsync(alwaysYield: true); + DoSomething(); +}) +``` + +## Configuration + +This analyzer is configurable via the `vs-threading.LegacyThreadSwitchingMembers.txt` file. +See our [configuration](configuration.md) topic for more information. diff --git a/docfx/analyzers/VSTHRD002.md b/docfx/analyzers/VSTHRD002.md new file mode 100644 index 000000000..6a05a94ca --- /dev/null +++ b/docfx/analyzers/VSTHRD002.md @@ -0,0 +1,45 @@ +# VSTHRD002 Avoid problematic synchronous waits + +Synchronously waiting on `Task`, `ValueTask`, or awaiters is dangerous and may cause dead locks. + +## Examples of patterns that are flagged by this analyzer + +```csharp +void DoSomething() +{ + DoSomethingElseAsync().Wait(); + DoSomethingElseAsync().GetAwaiter().GetResult(); + var result = CalculateSomethingAsync().Result; +} +``` + +## Solution + +Please consider the following options: + +1. Switch to asynchronous wait if the caller is already a "async" method. +1. Change the chain of callers to be "async" methods, and then change this code to be asynchronous await. +1. Use `JoinableTaskFactory.Run()` to wait on the tasks or awaiters. + +```csharp +async Task DoSomethingAsync() +{ + await DoSomethingElseAsync(); + await DoSomethingElseAsync(); + var result = await CalculateSomethingAsync(); +} + +void DoSomething() +{ + joinableTaskFactory.Run(async delegate + { + await DoSomethingElseAsync(); + await DoSomethingElseAsync(); + var result = await CalculateSomethingAsync(); + }); +} +``` + +Refer to [Asynchronous and multithreaded programming within VS using the JoinableTaskFactory][1] for more information. + +[1]: https://devblogs.microsoft.com/premier-developer/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/ diff --git a/docfx/analyzers/VSTHRD003.md b/docfx/analyzers/VSTHRD003.md new file mode 100644 index 000000000..49d8ad87b --- /dev/null +++ b/docfx/analyzers/VSTHRD003.md @@ -0,0 +1,267 @@ +# VSTHRD003 Avoid awaiting foreign Tasks + +Tasks that are created and run from another context (not within the currently running method or delegate) +should not be returned or awaited on. Doing so can result in deadlocks because awaiting a `Task` +does not result in the awaiter "joining" the effort such that access to the main thread is shared. +If the awaited `Task` requires the main thread, and the caller that is awaiting it is blocking the +main thread, a deadlock will result. + +When required to await a task that was started earlier, start it within a delegate passed to +`JoinableTaskFactory.RunAsync`, storing the resulting `JoinableTask` in a field or variable. +You can safely await the `JoinableTask` later. + +## Simple examples of patterns that are flagged by this analyzer + +The following example would likely deadlock if `MyMethod` were called on the main thread, +since `SomeOperationAsync` cannot gain access to the main thread in order to complete. + +```csharp +void MyMethod() +{ + System.Threading.Tasks.Task task = SomeOperationAsync(); + joinableTaskFactory.Run(async delegate + { + await task; /* This analyzer will report warning on this line. */ + }); +} +``` + +In the next example, `WaitForMyMethod` may deadlock when `this.task` has not completed +and needs the main thread to complete. + +```csharp +class SomeClass +{ + System.Threading.Tasks.Task task; + + SomeClass() + { + this.task = SomeOperationAsync(); + } + + async Task MyMethodAsync() + { + await this.task; /* This analyzer will report warning on this line. */ + } + + void WaitForMyMethod() + { + joinableTaskFactory.Run(() => MyMethodAsync()); + } +} +``` + +More [advanced examples](#advanced-cases) are further down in this document, below the solution section for the simpler examples. + +## Solution for simpler cases + +To await the result of an async method from with a JoinableTaskFactory.Run delegate, +invoke the async method within the JoinableTaskFactory.Run delegate: + +```csharp +void MyMethod() +{ + joinableTaskFactory.Run(async delegate + { + System.Threading.Tasks.Task task = SomeOperationAsync(); + await task; + }); +} +``` + +Alternatively wrap the original method invocation with JoinableTaskFactory.RunAsync: + +```csharp +class SomeClass +{ + JoinableTask joinableTask; + + SomeClass() + { + this.joinableTask = joinableTaskFactory.RunAsync(() => SomeOperationAsync()); + } + + async Task MyMethodAsync() + { + await this.joinableTask; + } + + void WaitForMyMethod() + { + joinableTaskFactory.Run(() => MyMethodAsync()); + } +} +``` + +## Advanced cases + +### `TaskCompletionSource` + +In the next example, a `TaskCompletionSource` is used as a black-box for unblocking functionality. +It too represents awaiting a foreign task: + +```cs +class SomeClass +{ + TaskCompletionSource tcs = new(); + + public async Task MyMethodAsync() + { + await this.tcs.Task; /* This analyzer will report warning on this line. */ + /* do more stuff */ + } + + void UnlockProgress() + { + this.tcs.TrySetResult(true); + } +} +``` + +The problem with the above code is that `MyMethodAsync()` waits for unknown work (whatever work will lead to the completion of the `TaskCompletionSource`) before making progress. +If `UnlockProgress()` is never called, the caller of `MyMethodAsync()` will be awaiting forever. +Now suppose that the caller of `MyMethodAsync()` is actually inside a `JoinableTaskFactory.Run` delegate: + +```cs +void SomeCaller() +{ + joinableTaskFactory.Run(async delegate + { + await someClass.MyMethodAsync(); + }); +} +``` + +If `SomeCaller()` runs on the main thread, then it will effectively block the main thread while waiting for `this.tcs.Task` from `SomeClass` to complete. +Now suppose that another thread comes along and wants to do some work before calling `UnlockProgress()`: + +```cs +partial class SomeClass +{ + async Task KeyMasterAsync() + { + await joinableTaskFactory.SwitchToMainThreadAsync(); + // do some work + // Unblock others + someClass.UnlockProgress(); + } +} +``` + +We have a deadlock, because `SomeCaller()` is blocking the main thread while waiting for `UnlockProgress()` to be called, but `UnlockProgress()` will not be called until `KeyMasterAsync` can reach the main thread. + +Fixing this fundamentally means that `SomeCaller` will need to *join* whatever work may be needed to ultimately call `UnlockProgress`. But for `SomeCaller`, that work is unknown, since it's at least partially inside another class. +`TaskCompletionSource` is fundamentally a blackbox and the most difficult thing to use correctly while avoiding deadlocks. + +Preferred solutions involve replacing `TaskCompletionSource` with another type that makes tracking the work involved automatic. +These include: + +1. Use `JoinableTaskFactory.RunAsync` and store the resulting `JoinableTask` in a field to await later. +1. Use `AsyncLazy` for one-time init work that should only start if required. Be sure to pass in a `JoinableTaskFactory` instance to its constructor. + +Assuming you must keep using `TaskCompletionSource` though, here's how it can be done as safely as possible. +Joining a set of unknown work is best done with the `JoinableTaskCollection` class. +It is the responsibility of `SomeClass` in the example above to work with this collection to avoid deadlocks, like this: + +```cs +class SomeClass +{ + TaskCompletionSource tcs = new(); + JoinableTaskCollection jtc; + JoinableTaskFactory jtf; + + internal SomeClass(JoinableTaskContext joinableTaskContext) + { + this.jtc = joinableTaskContext.CreateCollection(); + this.jtf = joinableTaskContext.CreateFactory(this.jtc); + } + + public async Task MyMethodAsync() + { + // Our caller is interested in completion of the TaskCompletionSource, + // so join the collected effort while waiting, to avoid deadlocks. + using (this.jtc.Join()) + { + await this.tcs.Task; /* This analyzer will report warning on this line. */ + } + + /* do more stuff */ + } + + void UnlockProgress() + { + this.tcs.TrySetResult(true); + } + + async Task KeyMasterAsync() + { + // As this method must complete to signal the TaskCompletionSource, + // all of its work must be done within the context of a JoinableTask + // that belongs to the JoinableTaskCollection. + // jtf.RunAsync will add the JoinableTask it creates to the jtc collection + // because jtf was created with jtc as an argument in our constructor. + await this.jtf.RunAsync(async delegate + { + // Because we're in the jtc collection, anyone waiting on MyMethodAsync + // will automatically lend us use of the main thread if they have it + // to avoid deadlocks. + // It does NOT matter whether we use jtf or another JoinableTaskFactory instance + // at this point. + await anyOldJTF.SwitchToMainThreadAsync(); + + // do some work + // Unblock others + this.UnlockProgress(); + }); + } +} +``` + +Notice how the public API of the class does not need to expose any `JoinableTask`-related types. +It's an implementation detail of the class. + +This works fine when the class itself fully controls the work to complete the `TaskCompletionSource`. +When _other_ classes also do work (independently of work started within `SomeClass`), the placement and access to the `JoinableTaskFactory` that is associated with the `JoinableTaskCollection` may need to be elevated so that other classes can access it as well so that *all* the work required to complete the `TaskCompletionSource` will be tracked. + +### Task chaining or other means to ensure sequential execution + +Task chaining is another technique that can lead to deadlocks. +Task chaining is where a single `Task` is kept in a field and used to call `Task.ContinueWith` to append another Task, and the resulting Task is then assigned to the field, like this: + +```cs +class TaskChainingExample +{ + private readonly object lockObject = new(); + private Task lastTask = Task.CompletedTask; + + internal Task AddWorkToEnd(Funk work) + { + lock (this.lockObject) + { + return this.lastTask = this.lastTask.ContinueWith(_ => work()).Unwrap(); + } + } +} +``` + +(Note: The above example has several *other* issues that would require more code to address, but it illustrates the idea of task chaining.) + +The deadlock risk with task chaining is that again, the chain of tasks come together to form a kind of private queue which the `JoinableTaskFactory` has no visibility into. +When a task is not at the front of the queue but its owner blocks the main thread for its completion, and if any other task ahead of it in the queue needs the main thread, a deadlock will result. + +For this reason (and several others), task chaining is *not* recommended. +Instead, you can achieve a thread-safe queue that executes work sequentially by utilizing the `ReentrantSemaphore` class. + +Fixing the above example would translate to this (allowing for a variety of reentrancy modes): + +```cs +class SequentialExecutingQueueExample +{ + private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(initialCount: 1, joinableTaskContext, ReentrancyMode.Stack); + + internal Task AddWorkToEnd(Func work) + { + return semaphore.ExecuteAsync(work); + } +} +``` diff --git a/docfx/analyzers/VSTHRD004.md b/docfx/analyzers/VSTHRD004.md new file mode 100644 index 000000000..39d3bbdf6 --- /dev/null +++ b/docfx/analyzers/VSTHRD004.md @@ -0,0 +1,43 @@ +# VSTHRD004 Await SwitchToMainThreadAsync + +Calls to `JoinableTaskFactory.SwitchToMainThreadAsync` must be awaited +or it is a no-op. + +## Examples of patterns that are flagged by this analyzer + +```csharp +void MyMethod() +{ + joinableTaskFactory.SwitchToMainThreadAsync(); + UIThreadBoundWork(); +} +``` + +## Solution + +Add `await` in front of the call to `JoinableTaskFactory.SwitchToMainThreadAsync`. + +This requires an async context. Here, we fix the problem by making the outer method async: + +```csharp +async Task MyMethodAsync() +{ + await joinableTaskFactory.SwitchToMainThreadAsync(); + UIThreadBoundWork(); +} +``` + + +Alternatively if found in a synchronous method that cannot be made async, +this failure can be fixed by lifting the code into a delegate passed to `JoinableTaskFactory.Run`: + +```csharp +void MyMethod() +{ + joinableTaskFactory.Run(async delegate + { + await joinableTaskFactory.SwitchToMainThreadAsync(); + UIThreadBoundWork(); + }); +} +``` diff --git a/docfx/analyzers/VSTHRD010.md b/docfx/analyzers/VSTHRD010.md new file mode 100644 index 000000000..bfb01c11d --- /dev/null +++ b/docfx/analyzers/VSTHRD010.md @@ -0,0 +1,61 @@ +# VSTHRD010 Invoke single-threaded types on Main thread + +Acquiring, casting, or invoking single-threaded objects should be done after ensuring +that your code is running on the main thread. + +This analyzer can be configured to: +1. Recognize the objects that are single-threaded that are unique to your app or library. +2. Recognize synchronous methods that verify the caller is already on the main thread. +3. Recognize methods that switch to the main thread when the caller awaits them. + Calls to `JoinableTaskFactory.SwitchToMainThreadAsync` methods are pre-configured. + +See our [configuration](configuration.md) topic to learn more about customizing this analyzer. + +This analyzer also recognizes requirements to use the main thread transitively within your solution. +For example, if method `A()` invokes a type that we know from configuration requires the main thread, +and `B()` calls `A()`, then the `B` method also needs the UI thread transitively. +This analyzer flags `B()` as needing to call a method that throws if not already on the main thread +only when `A()` is written to call such a method. + +**NOTE:** This analyzer requires [full solution analysis](fsa.md). + +## Examples of patterns that are flagged by this analyzer + +This example is based on the configuration available from the Visual Studio SDK +that defines `IVs*` interfaces as requiring the main thread. + +```csharp +private void CallVS() +{ + IVsSolution sln = GetIVsSolution(); + sln.SetProperty(); // This analyzer will report warning on this invocation. +} +``` + +## Solution + +First ensure you are running on the main thread before interacting with single-threaded objects. +Either throw when you are not on the appropriate thread, or explicitly switch to the +main thread. + +This solution example is based on the configuration available from the Visual Studio SDK +that defines `ThreadHelper.ThrowIfNotOnUIThread()` as one which throws if the caller +is not already on the main thread. + +```csharp +private void CallVS() +{ + ThreadHelper.ThrowIfNotOnUIThread(); + IVsSolution sln = GetIVsSolution(); + sln.SetProperty(); // This analyzer will not report warning on this invocation. +} + +private async Task CallVSAsync() +{ + await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(); + IVsSolution sln = GetIVsSolution(); + sln.SetProperty(); // This analyzer will not report warning on this invocation. +} +``` + +Refer to [Asynchronous and multithreaded programming within VS using the JoinableTaskFactory](https://devblogs.microsoft.com/premier-developer/asynchronous-and-multithreaded-programming-within-vs-using-the-joinabletaskfactory/) for more info. diff --git a/docfx/analyzers/VSTHRD011.md b/docfx/analyzers/VSTHRD011.md new file mode 100644 index 000000000..40b7e94fe --- /dev/null +++ b/docfx/analyzers/VSTHRD011.md @@ -0,0 +1,57 @@ +# VSTHRD011 Use `AsyncLazy` + +The `Lazy` type executes the value factory just once and +the value factory inherits the context of the first one to request the +`Lazy.Value` property's value. This can lead to deadlocks when +the value factory attempts to switch to the main thread. + +## Examples of patterns that are flagged by this analyzer + +### Using `Lazy` where `T` is `Task` + +When `T` is `Task` (because the value factory is an async method), +if the first caller had no access to the main thread, and the value factory +requires it, it will block. If later a second caller calls the `Value` property +and that second caller is blocking the UI thread for its result, it will deadlock. + +```csharp +var lazy = new Lazy>(async delegate // analyzer flags this line +{ + await Task.Yield(); + return 3; +}); + +int value = await lazy.Value; +``` + +### Using synchronously blocking methods in `Lazy` value factories + +When the value factory passed to the `Lazy` constructor calls synchronously +blocking methods such as `JoinableTaskFactory.Run`, only the first caller +can help any required transition to the main thread. + +```csharp +var lazy = new Lazy(delegate +{ + return joinableTaskFactory.Run(async delegate { // analyzer flags this line + int result = await SomeAsyncMethod(); + return result + 3; + }); +}); + +int value = lazy.Value; +``` + +## Solution + +Use `AsyncLazy` with an async value factory: + +```csharp +var lazy = new AsyncLazy(async delegate +{ + await Task.Yield(); + return 3; +}); + +int value = await lazy.GetValueAsync(); +``` diff --git a/docfx/analyzers/VSTHRD012.md b/docfx/analyzers/VSTHRD012.md new file mode 100644 index 000000000..31710a1cb --- /dev/null +++ b/docfx/analyzers/VSTHRD012.md @@ -0,0 +1,33 @@ +# VSTHRD012 Provide `JoinableTaskFactory` where allowed + +When constructing types or calling methods that accept a `JoinableTaskFactory` +or `JoinableTaskContext`, take the opportunity to supply one if your application +has a main thread with a single threaded `SynchronizationContext` such as WPF or WinForms. + +## Examples of patterns that are flagged by this analyzer + +```csharp +void F() { + var o = new AsyncLazy(() => Task.FromResult(1)); // analyzer flags this line +} +``` + +## Solution + +Call the overload that accepts a `JoinableTaskFactory` or `JoinableTaskContext` instance: + +```csharp +void F() { + var o = new AsyncLazy(() => Task.FromResult(1), this.JoinableTaskFactory); +} +``` + +## Suppression + +You can suppress the diagnostic by explicitly specifying `null` for the argument: + +```csharp +void F() { + var o = new AsyncLazy(() => Task.FromResult(1), null); +} +``` diff --git a/docfx/analyzers/VSTHRD100.md b/docfx/analyzers/VSTHRD100.md new file mode 100644 index 000000000..b1a7278d5 --- /dev/null +++ b/docfx/analyzers/VSTHRD100.md @@ -0,0 +1,56 @@ +# VSTHRD100 Avoid `async void` methods + +Methods with `async void` signatures make it impossible for their caller to track +the entire asynchronous operation and handle exceptions that may be thrown by that method. +If the method throws an exception, it crashes the process. + +## Examples of patterns that are flagged by this analyzer + +```csharp +async void DoSomethingAsync() +{ + await SomethingElseAsync(); +} +``` + +## Solution + +Change the method to return `Task` instead of `void`. + +```csharp +async Task DoSomethingAsync() +{ + await SomethingElseAsync(); +} +``` + +A code fix is offered that automatically changes the return type of the method. + +### Event handlers + +For event handlers, avoid `async void` by using `RunAsync`: +```csharp +obj.Event += (s, e) => joinableTaskFactory.RunAsync(() => OnEventAsync(s, e)); +} + +private async Task OnEventAsync(object sender, EventArgs e) +{ + // async code here. +} +``` + +When using method group syntax as an argument, you can define the method with the required signature, without the `async` modifier, and define an anonymous delegate or lambda within the method, like this: + +```cs +var menuItem = new MenuCommand(HandleEvent, commandId); + +private void HandleEvent(object sender, EventArgs e) +{ + _ = joinableTaskFactory.RunAsync(async () => + { + // async code + }); +} +``` + +Refer to [Async/Await - Best Practices in Asynchronous Programming](https://msdn.microsoft.com/en-us/magazine/jj991977.aspx) for more info. diff --git a/docfx/analyzers/VSTHRD101.md b/docfx/analyzers/VSTHRD101.md new file mode 100644 index 000000000..10f9e411d --- /dev/null +++ b/docfx/analyzers/VSTHRD101.md @@ -0,0 +1,71 @@ +# VSTHRD101 Avoid unsupported async delegates + +C# allows you to define async delegates or lambdas and use them in contexts that accept +void-returning delegates, thus creating an `async void` method such as is forbidden by +[VSTHRD100](VSTHRD100.md), but is much harder to catch when simply looking at the code +because for the same syntax, the C# compiler will create an `async Func` delegate +or an `async void` delegate based on the type expected by the method being invoked. + +This analyzer helps prevent inadvertent creation of `async void` delegates. + +## Examples of patterns that are flagged by this analyzer + +```csharp +void StartWatching(ObservableCollection oc) +{ + // This delegate becomes an "async void" method to match the EventHandler delegate type. + oc.CollectionChanged += async () => + { + await Task.Yield(); + }; +} + +void StartWatching(ObservableCollection oc) +{ + // This delegate becomes an "async void" method to match the Action delegate type. + Callback(async () => + { + await Task.Yield(); + }); +} + +void Callback(Action action) +{ + // out of scope of sample +} +``` + +## Solution + +1. Wrap the asynchronous behavior in another method that accepts a `Func` delegate. +1. Change the receiving method's expected delegate type to one that returns a `Task` or `Task`. +1. Implement the delegate synchronously. + +```csharp +void StartWatching(ObservableCollection oc) +{ + oc.CollectionChanged += () => + { + // The outer delegate is synchronous, but kicks off async work via a method that accepts an async delegate. + joinableTaskFactory.RunAsync(async delegate { + await Task.Yield(); + }); + }; +} + +void StartWatching(ObservableCollection oc) +{ + // This delegate becomes an "async Task" method to match the Func delegate type. + Callback(async () => + { + await Task.Yield(); + }); +} + +void Callback(Func action) +{ + // out of scope of sample +} +``` + +Refer to [Async/Await - Best Practices in Asynchronous Programming](https://msdn.microsoft.com/en-us/magazine/jj991977.aspx) for more info. diff --git a/docfx/analyzers/VSTHRD102.md b/docfx/analyzers/VSTHRD102.md new file mode 100644 index 000000000..60ba1cb71 --- /dev/null +++ b/docfx/analyzers/VSTHRD102.md @@ -0,0 +1,56 @@ +# VSTHRD102 Implement internal logic asynchronously + +Internal or private methods may be invoked by public methods that are asynchronous. +If the internal method has an opportunity to do work asynchronously, it should do so +in order that async public members can truly be async. + +## Examples of patterns that are flagged by this analyzer + +```csharp +public void PublicMethod() +{ + DoWork(); +} + +public async Task PublicMethodAsync() +{ + DoWork(); + await Task.Yield(); +} + +internal void DoWork() +{ + joinableTaskFactory.Run(async delegate // Analyzer will flag this line + { + await DoSomethingAsync(); + }); +} +``` + +Note how `DoWork()` synchronously blocks for both `PublicMethod()` and `PublicMethodAsync()`. + +## Solution + +Remove the synchronously blocking behavior and make the method async. + +```csharp +public void PublicMethod() +{ + joinableTaskFactory.Run(() => PublicMethodAsync()); +} + +public async Task PublicMethodAsync() +{ + await DoWorkAsync(); + await Task.Yield(); +} + +internal async Task DoWorkAsync() +{ + await DoSomethingAsync(); +} +``` + +Note how `DoWorkAsync()` now allows `PublicMethodAsync()` to do its work asynchronously +while `PublicMethod()` continues to synchronously block, giving your external caller the option +as to whether to do work asynchronously or synchronously. diff --git a/docfx/analyzers/VSTHRD103.md b/docfx/analyzers/VSTHRD103.md new file mode 100644 index 000000000..348032057 --- /dev/null +++ b/docfx/analyzers/VSTHRD103.md @@ -0,0 +1,29 @@ +# VSTHRD103 Call async methods when in an async method + +In a method which is already asynchronous, calls to other methods should +be to their async versions, where they exist. + +## Examples of patterns that are flagged by this analyzer + +```csharp +Task DoAsync() +{ + file.Read(buffer, 0, 10); +} +``` + +All methods where an Async-suffixed equivalent exists will produce this warning +when called from a `Task`-returning method. +In addition, calling `Task.Wait()`, `Task.Result` or `Task.GetAwaiter().GetResult()` +will produce this warning. + +## Solution + +Await the async version of the method: + +```csharp +async Task DoAsync() +{ + await file.ReadAsync(buffer, 0, 10); +} +``` diff --git a/docfx/analyzers/VSTHRD104.md b/docfx/analyzers/VSTHRD104.md new file mode 100644 index 000000000..aabbe5722 --- /dev/null +++ b/docfx/analyzers/VSTHRD104.md @@ -0,0 +1,36 @@ +# VSTHRD104 Offer async option + +When a publicly accessible method uses `JoinableTaskFactory.Run`, there should be +another way to access the async behavior without synchronously blocking the thread +so that an async caller can be async throughout. + +This rule encourages this pattern by recognizing when some method *Foo* exists and +calls `JoinableTaskFactory.Run` that there is also a method *FooAsync*. +The recommended pattern then is for *Foo* to call *FooAsync* from the delegate +passed to `JoinableTaskFactory.Run` so that the implementation only need be written once. + +## Examples of patterns that are flagged by this analyzer + +```csharp +public void Foo() { + this.joinableTaskFactory.Run(async delegate { + await Task.Yield(); + }); +} +``` + +## Solution + +Add a FooAsync method, and (optionally) call it from the Foo method: + +```csharp +public void Foo() { + this.joinableTaskFactory.Run(async delegate { + await FooAsync(); + }); +} + +public async Task FooAsync() { + await Task.Yield(); +} +``` diff --git a/docfx/analyzers/VSTHRD105.md b/docfx/analyzers/VSTHRD105.md new file mode 100644 index 000000000..06c3e34a4 --- /dev/null +++ b/docfx/analyzers/VSTHRD105.md @@ -0,0 +1,83 @@ +# VSTHRD105 Avoid method overloads that assume `TaskScheduler.Current` + +Certain methods in the .NET Framework have overloads that allow specifying or omitting +a `TaskScheduler` instance. Always specify one explicitly to avoid the assumed `TaskScheduler.Current` +value, whose behavior is defined by your caller and may vary at runtime. + +The "current" `TaskScheduler` is defined by the one that is executing the currently running code. +But when your code is executing without having been scheduled by a `TaskScheduler` (as is the case with most code), +then the `TaskScheduler.Current` property returns `TaskScheduler.Default` which schedules tasks on the thread pool. +This leads many to incorrectly assume that task scheduling methods such as `StartNew` and `ContinueWith` default +to using the thread pool when in fact their default behavior varies by your caller. + +This variability in behavior leads to bugs when, for example, `TaskScheduler.Current` returns a `TaskScheduler` +that executes tasks on the application's main thread and/or only executes one task at once, such as one obtained +from the `TaskScheduler.FromCurrentSynchronizationContext()` method. +Such a circumstance often leads to deadlocks or responsiveness issues in the application. + +Always explicitly specifying `TaskScheduler.Default` (or other if appropriate) ensures your code will schedule +tasks in a predictable, consistent way. + +No diagnostic is produced by this analyzer when `TaskFactory.StartNew` is invoked on a private instance +of `TaskFactory`, since it may in fact have a safe default for `TaskScheduler`. + +Similar rules: [CA2008 (DoNotCreateTasksWithoutPassingATaskSchedulerAnalyzer)](https://github.com/dotnet/roslyn-analyzers/blob/32d8f1e397439035f0ecb5f61a9e672225f0ecdb/src/Microsoft.NetCore.Analyzers/Core/Tasks/DoNotCreateTasksWithoutPassingATaskScheduler.cs) + +## Examples of patterns that are flagged by this analyzer + +```csharp +private void FirstMethod() +{ + TaskScheduler uiScheduler = TaskScheduler.FromCurrentSynchronizationContext(); + Task.Factory.StartNew( + () => + { + this.AnotherMethod(); + }, + System.Threading.CancellationToken.None, + TaskCreationOptions.None, + uiScheduler); +} + +private void AnotherMethod() +{ + // TaskScheduler.Current is assumed here, which is determined by our caller. + var nestedTask = Task.Factory.StartNew( // analyzer flags this line + () => + { + // Ooops, we're still on the UI thread when called by FirstMethod. + // But we might be on the thread pool if someone else called us. + }); +} +``` + +## Solution + +Specify a `TaskScheduler` explicitly to suppress the warning: + +```csharp +private void FirstMethod() +{ + TaskScheduler uiScheduler = TaskScheduler.FromCurrentSynchronizationContext(); + Task.Factory.StartNew( + () => + { + this.AnotherMethod(); + }, + CancellationToken.None, + TaskCreationOptions.None, + uiScheduler); +} + +private void AnotherMethod() +{ + var nestedTask = Task.Factory.StartNew( + () => + { + // Ah, now we're reliably running on the thread pool. :) + }, + CancellationToken.None, + TaskCreationOptions.None, + TaskScheduler.Default); // Specify TaskScheduler explicitly here. +} +``` diff --git a/docfx/analyzers/VSTHRD106.md b/docfx/analyzers/VSTHRD106.md new file mode 100644 index 000000000..f47fc46ce --- /dev/null +++ b/docfx/analyzers/VSTHRD106.md @@ -0,0 +1,31 @@ +# VSTHRD106 Use `InvokeAsync` to raise async events + +Asynchronous events (those typed as `AsyncEventHandler`) must be raised carefully to ensure +all event handlers are invoked and awaited on. + +Although C# lets you invoke event handlers naturally, it has no awareness of async event handlers +and thus will not let you correctly await on their invocation nor invoke them sequentially. + +## Examples of patterns that are flagged by this analyzer + +```csharp +public AsyncEventHandler Clicked; + +async Task OnClicked() { + await Clicked(this, EventArgs.Empty); // only awaits the first event handler. +} +``` + +## Solution + +Use the `InvokeAsync` extension method defined in the `TplExtensions` class and await its result. +This will ensure each event handler completes before invoking the next event handler in the list, +similar to the default behavior for raising synchronous events. + +```csharp +public AsyncEventHandler Clicked; + +async Task OnClicked() { + await Clicked.InvokeAsync(this, EventArgs.Empty); // await for the completion of all handlers. +} +``` diff --git a/docfx/analyzers/VSTHRD107.md b/docfx/analyzers/VSTHRD107.md new file mode 100644 index 000000000..8694cf2ea --- /dev/null +++ b/docfx/analyzers/VSTHRD107.md @@ -0,0 +1,27 @@ +# VSTHRD107 Await Task within using expression + +The C# `using` statement requires that the used expression implement `IDisposable`. +Because `Task` implements `IDisposable`, one may accidentally omit an `await` operator +and `Dispose` of the `Task` instead of the `T` result itself when `T` derives from `IDisposable`. + +## Examples of patterns that are flagged by this analyzer + +```csharp +AsyncSemaphore lck; +using (lck.EnterAsync()) +{ + // ... +} +``` + +## Solution + +Add the `await` operator within the `using` expression. + +```csharp +AsyncSemaphore lck; +using (await lck.EnterAsync()) +{ + // ... +} +``` diff --git a/docfx/analyzers/VSTHRD108.md b/docfx/analyzers/VSTHRD108.md new file mode 100644 index 000000000..c2b986e2a --- /dev/null +++ b/docfx/analyzers/VSTHRD108.md @@ -0,0 +1,46 @@ +# VSTHRD108 Assert thread affinity unconditionally + +When a method has thread affinity and throws if called from the wrong thread, it should do so without regard to any other condition. This helps ensure the caller will notice early during development that they are calling from the wrong thread. Extra conditions can hide the problem till end users discover an application failure. + +## Examples of patterns that are flagged by this analyzer + +```csharp +private int? age; + +public int GetAge() +{ + if (!this.age.HasValue) + { + ThreadHelper.ThrowIfNotOnUIThread(); + this.age = DoExpensiveUIThreadWork(); + } + + return this.age.Value; +} +``` + +The problem here is that although the UI thread is only strictly required when the field is actually initialized, callers generally cannot predict whether they will be the first or a subsequent caller. If they call from a background thread and tend to be a subsequent caller, no exception will be thrown. But under some conditions in the app when they happen to be the first caller, they'll fail at runtime because they're calling from the background thread. + +## Solution + +Move the code that throws when not on the UI thread outside the conditional block. + +```csharp +private int? age; + +public int GetAge() +{ + ThreadHelper.ThrowIfNotOnUIThread(); + if (!this.age.HasValue) + { + this.age = DoExpensiveUIThreadWork(); + } + + return this.age.Value; +} +``` + +## Configuration + +This analyzer is configurable via the `vs-threading.MainThreadAssertingMethods.txt` file. +See our [configuration](configuration.md) topic for more information. diff --git a/docfx/analyzers/VSTHRD109.md b/docfx/analyzers/VSTHRD109.md new file mode 100644 index 000000000..7e28198b7 --- /dev/null +++ b/docfx/analyzers/VSTHRD109.md @@ -0,0 +1,29 @@ +# VSTHRD109 Switch instead of assert in async methods + +Methods that are or can be async should switch to the main thread when necessary +rather than throw an exception if invoked from a different thread. +This allows callers to invoke any async method from any thread +without having to concern themselves with the threading requirements of a method that +can support its own threading requirements by switching. + +## Examples of patterns that are flagged by this analyzer + +```csharp +async Task FooAsync() { + ThreadHelper.ThrowIfNotOnUIThread(); + DoStuff(); + await DoMoreStuff(); +} +``` + +## Solution + +Use `await SwitchToMainThreadAsync()` instead: + +```csharp +async Task FooAsync() { + await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(); + DoStuff(); + await DoMoreStuff(); +} +``` diff --git a/docfx/analyzers/VSTHRD110.md b/docfx/analyzers/VSTHRD110.md new file mode 100644 index 000000000..6e7bc44af --- /dev/null +++ b/docfx/analyzers/VSTHRD110.md @@ -0,0 +1,75 @@ +# VSTHRD110 Observe result of async calls + +Tasks returned from async methods should be awaited, or assigned to a variable for observation later. +Methods that return `Task`s often complete and report their work via the `Task` they return, and simply +invoking the method does not guarantee that its work is complete nor successful. Using the `await` keyword +just before the method call causes execution of the calling method to effectively suspend until the called +method has completed and rethrows any exception thrown by the method. + +When a `Task` or `Task` is returned and is not awaited or redirected in some other way, +within the context of a synchronous method, a warning is reported. + +This rule does *not* apply to calls made within async methods, since [CS4014][CS4014] already reports these. + +## Examples of patterns that are flagged by this analyzer + +```csharp +void Foo() { + DoStuffAsync(); +} + +async Task DoStuffAsync() { /* ... */ } +``` + +## Solution + +Convert the method to be async and await the expression: + +```csharp +async Task FooAsync() { + await DoStuffAsync(); +} + +async Task DoStuffAsync() { /* ... */ } +``` + +When the calling method's signature cannot be changed, wrap the method body in a `JoinableTaskFactory.Run` delegate instead: + +```csharp +void Foo() { + jtf.Run(async delegate { + await DoStuffAsync(); + }); +} + +async Task DoStuffAsync() { /* ... */ } +``` + +One other option is to assign the result of the method call to a field or local variable, presumably to track it later: + +```csharp +void Foo() { + Task watchThis = DoStuffAsync(); +} + +async Task DoStuffAsync() { /* ... */ } +``` + +When tracking the `Task` with a field, remember that to await it later without risk of deadlocking, +wrap it in a `JoinableTask` using `JoinableTaskFactory.RunAsync`, per [the 3rd rule](../docs/threading_rules.md#Rule3). + +```csharp +JoinableTask watchThis; + +void Foo() { + this.watchThis = jtf.RunAsync(() => DoStuffAsync()); +} + +async Task WaitForFooToFinishAsync() { + await this.watchThis; +} + +async Task DoStuffAsync() { /* ... */ } +``` + +[CS4014]: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs4014 diff --git a/docfx/analyzers/VSTHRD111.md b/docfx/analyzers/VSTHRD111.md new file mode 100644 index 000000000..0495e84f0 --- /dev/null +++ b/docfx/analyzers/VSTHRD111.md @@ -0,0 +1,38 @@ +# VSTHRD111 Use `.ConfigureAwait(bool)` + +Some code bases, particularly libraries with no affinity to an app's UI thread, are advised to use `.ConfigureAwait(false)` for each and every _await_ because it can avoid deadlocks after those calls start on an application's UI thread and the app later decides to synchronously block the UI thread waiting for those tasks to finish. Using `.ConfigureAwait(false)` also allows continuations to switch to a background thread even when no synchronous blocking would cause a deadlock, which makes for a more responsive application and possibly higher throughput of async operations. + +Note that this scenario can also be solved using the `JoinableTaskFactory`, but many class libraries may not wish to depend on the application proffers an instance of that type to the library. Where JoinableTaskFactory _does_ apply, use of `.ConfigureAwait(false)` is _not_ recommended. See [this topic](https://github.com/Microsoft/vs-threading/blob/main/doc/cookbook_vs.md#should-i-await-a-task-with-configureawaitfalse) for more on when `.ConfigureAwait(false)` and `.ConfigureAwait(true)` are appropriate. + +**This analyzer's diagnostics are *hidden* by default**. You should enable the rule for libraries that use to require this await suffix. + +## Examples of patterns that are flagged by this analyzer + +Any await on `Task` or `ValueTask` without the `.ConfigureAwait(bool)` method called on it will be flagged. + +```csharp +async Task FooAsync() { + await DoStuffAsync(); // This line is flagged + await DoMoreStuffAsync(); // This line is flagged +} + +async Task DoStuffAsync() { /* ... */ } +async ValueTask DoMoreStuffAsync() { /* ... */ } +``` + +## Solution + +Add `.ConfigureAwait(false)` or `.ConfigureAwait(true)` to the awaited `Task` or `ValueTask`. + +```csharp +async Task FooAsync() { + await DoStuffAsync().ConfigureAwait(true); + await DoMoreStuffAsync().ConfigureAwait(false); +} + +async Task DoStuffAsync() { /* ... */ } +async ValueTask DoMoreStuffAsync() { /* ... */ } +``` + +Code fixes are offered for for this diagnostic to add either `.ConfigureAwait(false)` or `.ConfigureAwait(true)` +to an awaited expression. diff --git a/docfx/analyzers/VSTHRD112.md b/docfx/analyzers/VSTHRD112.md new file mode 100644 index 000000000..b9e3ae45c --- /dev/null +++ b/docfx/analyzers/VSTHRD112.md @@ -0,0 +1,66 @@ +# VSTHRD112 Implement `System.IAsyncDisposable` + +The `Microsoft.VisualStudio.Threading.IAsyncDisposable` interface is obsolete now that the +`System.IAsyncDisposable` interface has been defined for .NET Standard 2.0 and .NET Framework 4.6.1 +by the [`Microsoft.Bcl.AsyncInterfaces` NuGet package](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces). + +New classes looking to support async disposable should use `System.IAsyncDisposable` instead of `Microsoft.VisualStudio.Threading.IAsyncDisposable`. +Existing classes that already implement `Microsoft.VisualStudio.Threading.IAsyncDisposable` should *also* implement `System.IAsyncDisposable` so the async disposal option will be recognized by code that only checks for presence of the new interface. + +## Examples of patterns that are flagged by this analyzer + +This class only implements `Microsoft.VisualStudio.Threading.IAsyncDisposable` and will produce the VSTHRD112 diagnostic: + +```cs +using Microsoft.VisualStudio.Threading; + +class SomeClass : IAsyncDisposable +{ + public Task DisposeAsync() + { + } +} +``` + +## Solution + +Implement `System.IAsyncDisposable` in addition to (or instead of) `Microsoft.VisualStudio.Threading.IAsyncDisposable`. +Add a package reference to `Microsoft.Bcl.AsyncInterfaces` if the compiler cannot find `System.IAsyncDisposable`. + +In this example, only `System.IAsyncDisposable` is supported, which is acceptable: + +```cs +using System; + +class SomeClass : IAsyncDisposable +{ + public ValueTask DisposeAsync() + { + } +} +``` + +In this next example, both interfaces are supported: + +```cs +class SomeClass : System.IAsyncDisposable, Microsoft.VisualStudio.Threading.IAsyncDisposable +{ + Task Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() + { + // Simply forward the call to the other DisposeAsync overload. + System.IAsyncDisposable self = this; + return self.DisposeAsync().AsTask(); + } + + ValueTask System.IAsyncDisposable.DisposeAsync() + { + // Interesting dispose logic here. + } +} +``` + +In the above example both `DisposeAsync` methods are explicit interface implementations. +Promoting one of the methods to be `public` is typically advised. +If one of these methods was already public and the class itself is public or protected, keep the same method public to avoid an API binary breaking change. + +An automated code fix may be offered for VSTHRD112 diagnostics. diff --git a/docfx/analyzers/VSTHRD113.md b/docfx/analyzers/VSTHRD113.md new file mode 100644 index 000000000..8d4dee677 --- /dev/null +++ b/docfx/analyzers/VSTHRD113.md @@ -0,0 +1,37 @@ +# VSTHRD113 Check for `System.IAsyncDisposable` + +The `Microsoft.VisualStudio.Threading.IAsyncDisposable` interface is obsolete now that the +`System.IAsyncDisposable` interface has been defined for .NET Standard 2.0 and .NET Framework 4.6.1 +by the [`Microsoft.Bcl.AsyncInterfaces` NuGet package](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces). + +Existing code that tests for the `Microsoft.VisualStudio.Threading.IAsyncDisposable` interface on some object should also check for `System.IAsyncDisposable` and behave similarly in either case. +New code should consider only supporting the new `System.IAsyncDisposable` interface. + +## Examples of patterns that are flagged by this analyzer + +The following code only checks for the obsolete interface and is flagged by this diagnostic: + +```cs +using Microsoft.VisualStudio.Threading; + +if (obj is IAsyncDisposable asyncDisposable) +{ + await asyncDisposable.DisposeAsync(); +} +``` + +## Solution + +Fix this by adding a code branch for the new interface that behaves similarly +within the same containing code block: + +```cs +if (obj is Microsoft.VisualStudio.Threading.IAsyncDisposable vsThreadingAsyncDisposable) +{ + await vsThreadingAsyncDisposable.DisposeAsync(); +} +else if (obj is System.IAsyncDisposable bclAsyncDisposable) +{ + await bclAsyncDisposable.DisposeAsync(); +} +``` diff --git a/docfx/analyzers/VSTHRD114.md b/docfx/analyzers/VSTHRD114.md new file mode 100644 index 000000000..c20c3fb53 --- /dev/null +++ b/docfx/analyzers/VSTHRD114.md @@ -0,0 +1,31 @@ +# VSTHRD114 Avoid returning a null Task + +Returning `null` from a non-async `Task`/`Task` method will cause a `NullReferenceException` at runtime. This problem can be avoided by returning `Task.CompletedTask`, `Task.FromResult(null)` or `Task.FromResult(default(T))` instead. + +## Examples of patterns that are flagged by this analyzer + +Any non-async `Task` returning method with an explicit `return null;` will be flagged. + +```csharp +Task DoAsync() { + return null; +} + +Task GetSomethingAsync() { + return null; +} +``` + +## Solution + +Return a task like `Task.CompletedTask` or `Task.FromResult`. + +```csharp +Task DoAsync() { + return Task.CompletedTask; +} + +Task GetSomethingAsync() { + return Task.FromResult(null); +} +``` diff --git a/docfx/analyzers/VSTHRD115.md b/docfx/analyzers/VSTHRD115.md new file mode 100644 index 000000000..5e1560911 --- /dev/null +++ b/docfx/analyzers/VSTHRD115.md @@ -0,0 +1,38 @@ +# VSTHRD115 Avoid creating a JoinableTaskContext with an explicit `null` `SynchronizationContext` + +Constructing a `JoinableTaskContext` with an explicit `null` `SynchronizationContext` is not recommended as a means to construct an instance for use in unit tests or processes without a main thread. +This is because the constructor will automatically use `SynchronizationContext.Current` in lieu of a non-`null` argument. +If `SynchronizationContext.Current` happens to be non-`null`, the constructor may unexpectedly configure the new instance as if a main thread were present. + +## Examples of patterns that are flagged by this analyzer + +```csharp +void SetupJTC() { + this.jtc = new JoinableTaskContext(null, null); +} +``` + +This code *appears* to configure the `JoinableTaskContext` to not be associated with any `SynchronizationContext`. +But in fact it will be associated with the current `SynchronizationContext` if one is present. + +## Solution + +If you intended to inherit `SynchronizationContext.Current` to initialize with a main thread, +provide that value explicitly as the second argument to suppress the warning: + +```cs +void SetupJTC() { + this.jtc = new JoinableTaskContext(null, SynchronizationContext.Current); +} +``` + +If you intended to create a `JoinableTaskContext` for use in a unit test or in a process without a main thread, +call `JoinableTaskContext.CreateNoOpContext()` instead: + +```cs +void SetupJTC() { + this.jtc = JoinableTaskContext.CreateNoOpContext(); +} +``` + +Code fixes are offered to update code to either of the above patterns. diff --git a/docfx/analyzers/VSTHRD200.md b/docfx/analyzers/VSTHRD200.md new file mode 100644 index 000000000..3f87cf273 --- /dev/null +++ b/docfx/analyzers/VSTHRD200.md @@ -0,0 +1,47 @@ +# VSTHRD200 Use `Async` suffix for async methods + +The .NET Guidelines for async methods includes that such methods +should have names that include an "Async" suffix. + +Methods that return awaitable types such as `Task` or `ValueTask` +should have an Async suffix. +Methods that do not return awaitable types should not use the Async suffix. + +## Examples of patterns that are flagged by this analyzer + +This `Task`-returning method should have a name that ends with Async: + +```csharp +async Task DoSomething() // analyzer flags this line +{ + await Task.Yield(); +} +``` + +This method should not have a name that ends with Async, since it does not return an awaitable type: + +```csharp +bool DoSomethingElseAsync() // analyzer flags this line +{ + return false; +} +``` + +## Solution + +Simply rename the method to end in "Async" (or remove the suffix, as appropriate): + +```csharp +async Task DoSomethingAsync() +{ + await Task.Yield(); +} + +bool DoSomethingElse() +{ + return false; +} +``` + + +A code fix exists to automatically rename such methods. diff --git a/doc/analyzers/configuration.md b/docfx/analyzers/configuration.md similarity index 100% rename from doc/analyzers/configuration.md rename to docfx/analyzers/configuration.md diff --git a/doc/analyzers/fsa.md b/docfx/analyzers/fsa.md similarity index 91% rename from doc/analyzers/fsa.md rename to docfx/analyzers/fsa.md index f1b49668d..48afeb68d 100644 --- a/doc/analyzers/fsa.md +++ b/docfx/analyzers/fsa.md @@ -6,4 +6,4 @@ Diagnostics reported by such an analyzer will appear in a full build log. They m To ensure the diagnostics are always visible, even when documents are open, select the "Enable full Solution Analysis" option, as shown below: -![Visual Studio Options -> Text Editor -> C# -> Advanced -> Enable full solution analysis option](images/fsa.png) \ No newline at end of file +![Visual Studio Options -> Text Editor -> C# -> Advanced -> Enable full solution analysis option](../images/fsa.png) diff --git a/doc/analyzers/index.md b/docfx/analyzers/index.md similarity index 81% rename from doc/analyzers/index.md rename to docfx/analyzers/index.md index 7b07b500b..4d2077c25 100644 --- a/doc/analyzers/index.md +++ b/docfx/analyzers/index.md @@ -6,23 +6,23 @@ Learn more about [how to install and configure these analyzers](installation.md) ID | Title | Severity | Supports | Default diagnostic severity ---- | --- | --- | --- | --- | -[VSTHRD001](VSTHRD001.md) | Avoid legacy thread switching methods | Critical | [1st rule](../threading_rules.md#Rule1) | 🔡 Warning -[VSTHRD002](VSTHRD002.md) | Avoid problematic synchronous waits | Critical | [2nd rule](../threading_rules.md#Rule2) | Warning -[VSTHRD003](VSTHRD003.md) | Avoid awaiting foreign Tasks | Critical | [3rd rule](../threading_rules.md#Rule3) | Warning -[VSTHRD004](VSTHRD004.md) | Await SwitchToMainThreadAsync | Critical | [1st rule](../threading_rules.md#Rule1) | Error -[VSTHRD010](VSTHRD010.md) | Invoke single-threaded types on Main thread | Critical | [1st rule](../threading_rules.md#Rule1) | Warning -[VSTHRD011](VSTHRD011.md) | Use `AsyncLazy` | Critical | [3rd rule](../threading_rules.md#Rule3) | Error -[VSTHRD012](VSTHRD012.md) | Provide JoinableTaskFactory where allowed | Critical | [All rules](../threading_rules.md) | Warning +[VSTHRD001](VSTHRD001.md) | Avoid legacy thread switching methods | Critical | [1st rule](../docs/threading_rules.md#Rule1) | 🔡 Warning +[VSTHRD002](VSTHRD002.md) | Avoid problematic synchronous waits | Critical | [2nd rule](../docs/threading_rules.md#Rule2) | Warning +[VSTHRD003](VSTHRD003.md) | Avoid awaiting foreign Tasks | Critical | [3rd rule](../docs/threading_rules.md#Rule3) | Warning +[VSTHRD004](VSTHRD004.md) | Await SwitchToMainThreadAsync | Critical | [1st rule](../docs/threading_rules.md#Rule1) | Error +[VSTHRD010](VSTHRD010.md) | Invoke single-threaded types on Main thread | Critical | [1st rule](../docs/threading_rules.md#Rule1) | Warning +[VSTHRD011](VSTHRD011.md) | Use `AsyncLazy` | Critical | [3rd rule](../docs/threading_rules.md#Rule3) | Error +[VSTHRD012](VSTHRD012.md) | Provide JoinableTaskFactory where allowed | Critical | [All rules](../docs/threading_rules.md) | Warning [VSTHRD100](VSTHRD100.md) | Avoid `async void` methods | Advisory | | Warning [VSTHRD101](VSTHRD101.md) | Avoid unsupported async delegates | Advisory | [VSTHRD100](VSTHRD100.md) | Warning -[VSTHRD102](VSTHRD102.md) | Implement internal logic asynchronously | Advisory | [2nd rule](../threading_rules.md#Rule2) | Info +[VSTHRD102](VSTHRD102.md) | Implement internal logic asynchronously | Advisory | [2nd rule](../docs/threading_rules.md#Rule2) | Info [VSTHRD103](VSTHRD103.md) | Call async methods when in an async method | Advisory | | Warning [VSTHRD104](VSTHRD104.md) | Offer async option | Advisory | | Info [VSTHRD105](VSTHRD105.md) | Avoid method overloads that assume `TaskScheduler.Current` | Advisory | | Warning [VSTHRD106](VSTHRD106.md) | Use `InvokeAsync` to raise async events | Advisory | | Warning [VSTHRD107](VSTHRD107.md) | Await Task within using expression | Advisory | | Error -[VSTHRD108](VSTHRD108.md) | Assert thread affinity unconditionally | Advisory | [1st rule](../threading_rules.md#Rule1), [VSTHRD010](VSTHRD010.md) | Warning -[VSTHRD109](VSTHRD109.md) | Switch instead of assert in async methods | Advisory | [1st rule](../threading_rules.md#Rule1) | Error +[VSTHRD108](VSTHRD108.md) | Assert thread affinity unconditionally | Advisory | [1st rule](../docs/threading_rules.md#Rule1), [VSTHRD010](VSTHRD010.md) | Warning +[VSTHRD109](VSTHRD109.md) | Switch instead of assert in async methods | Advisory | [1st rule](../docs/threading_rules.md#Rule1) | Error [VSTHRD110](VSTHRD110.md) | Observe result of async calls | Advisory | | Warning [VSTHRD111](VSTHRD111.md) | Use `.ConfigureAwait(bool)` | Advisory | | Hidden [VSTHRD112](VSTHRD112.md) | Implement `System.IAsyncDisposable` | Advisory | | Info diff --git a/doc/analyzers/installation.md b/docfx/analyzers/installation.md similarity index 96% rename from doc/analyzers/installation.md rename to docfx/analyzers/installation.md index a00c99297..9724a95b8 100644 --- a/doc/analyzers/installation.md +++ b/docfx/analyzers/installation.md @@ -26,7 +26,7 @@ You should generally use the latest version available, without regard to the ver There are [many rules](index.md) in the analyzer package. The default severity levels for the various rules are not appropriate for every type of project. -To get the best default severity levels for your project type, please review [these editorconfig recommendations](editorconfigs/README.md) and apply them to your project. +To get the best default severity levels for your project type, please review [these editorconfig recommendations](https://github.com/microsoft/vs-threading/blob/main/doc/editorconfigs/README.md) and apply them to your project. Some analyzers allow for [specialized configuration](configuration.md) that allows you to tailor them to your specific application or library to provide even more value to your team. diff --git a/docfx/analyzers/toc.yml b/docfx/analyzers/toc.yml new file mode 100644 index 000000000..cc7bee4ff --- /dev/null +++ b/docfx/analyzers/toc.yml @@ -0,0 +1,29 @@ +items: +- href: index.md +- href: configuration.md +- href: fsa.md +- href: installation.md +- href: VSTHRD001.md +- href: VSTHRD002.md +- href: VSTHRD003.md +- href: VSTHRD004.md +- href: VSTHRD010.md +- href: VSTHRD011.md +- href: VSTHRD012.md +- href: VSTHRD100.md +- href: VSTHRD101.md +- href: VSTHRD102.md +- href: VSTHRD103.md +- href: VSTHRD104.md +- href: VSTHRD105.md +- href: VSTHRD106.md +- href: VSTHRD107.md +- href: VSTHRD108.md +- href: VSTHRD109.md +- href: VSTHRD110.md +- href: VSTHRD111.md +- href: VSTHRD112.md +- href: VSTHRD113.md +- href: VSTHRD114.md +- href: VSTHRD115.md +- href: VSTHRD200.md diff --git a/doc/async_hang.md b/docfx/docs/async_hang.md similarity index 100% rename from doc/async_hang.md rename to docfx/docs/async_hang.md diff --git a/doc/cookbook_vs.md b/docfx/docs/cookbook_vs.md similarity index 100% rename from doc/cookbook_vs.md rename to docfx/docs/cookbook_vs.md diff --git a/doc/dumpasync.md b/docfx/docs/dumpasync.md similarity index 100% rename from doc/dumpasync.md rename to docfx/docs/dumpasync.md diff --git a/docfx/docs/features.md b/docfx/docs/features.md index eb3fbeb0d..0e517bcfb 100644 --- a/docfx/docs/features.md +++ b/docfx/docs/features.md @@ -1,3 +1,26 @@ # Features -TODO +Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). + +* Async versions of many threading synchronization primitives + * `AsyncAutoResetEvent` + * `AsyncBarrier` + * `AsyncCountdownEvent` + * `AsyncManualResetEvent` + * `AsyncReaderWriterLock` + * `AsyncSemaphore` + * `ReentrantSemaphore` +* Async versions of very common types + * `AsyncEventHandler` + * `AsyncLazy` + * `AsyncLazyInitializer` + * `AsyncLocal` + * `AsyncQueue` +* Await extension methods + * Await on a `TaskScheduler` to switch to it. + Switch to a background thread with `await TaskScheduler.Default;` + * Await on a `Task` with a timeout + * Await on a `Task` with cancellation +* `JoinableTaskFactory` that allows you to schedule asynchronous or synchronous work + that does not deadlock with the UI thread even when the UI thread needs to + synchronously block on the result. diff --git a/docfx/docs/getting-started.md b/docfx/docs/getting-started.md index eff2c2fbc..e353bffba 100644 --- a/docfx/docs/getting-started.md +++ b/docfx/docs/getting-started.md @@ -5,8 +5,4 @@ Consume this library via its NuGet Package. Click on the badge to find its latest version and the instructions for consuming it that best apply to your project. -[![NuGet package](https://img.shields.io/nuget/v/Library.svg)](https://nuget.org/packages/Library) - -## Usage - -TODO +[![NuGet package](https://img.shields.io/nuget/v/Microsoft.VisualStudio.Threading.svg)](https://www.nuget.org/packages/Microsoft.VisualStudio.Threading) diff --git a/doc/library_with_jtf.md b/docfx/docs/library_with_jtf.md similarity index 98% rename from doc/library_with_jtf.md rename to docfx/docs/library_with_jtf.md index c93afe46d..29434ab75 100644 --- a/doc/library_with_jtf.md +++ b/docfx/docs/library_with_jtf.md @@ -124,4 +124,4 @@ Note that when you create your own default instance of JoinableTaskContext (i.e. If your library is app-agnostic (such that it cannot use an app-specific mechanism to obtain an instance of `JoinableTaskContext`) and has no good singleton class on which the app can set the `JoinableTaskContext` instance for the entire library's use, the last option is simply to take a `JoinableTaskContext` instance as a parameter when you need it. For example, [the `AsyncLazy` constructor accepts a `JoinableTaskFactory` as an optional parameter](https://github.com/Microsoft/vs-threading/blob/027bff027c829cab6be54dbd15551d763199ebf0/src/Microsoft.VisualStudio.Threading/AsyncLazy.cs#L60). -When you make the `JoinableTaskContext`/`JoinableTaskFactory` argument optional, the [VSTHRD012](analyzers/VSTHRD012.md) rule can guide your library's users to specify it if they have it available. +When you make the `JoinableTaskContext`/`JoinableTaskFactory` argument optional, the [VSTHRD012](../analyzers/VSTHRD012.md) rule can guide your library's users to specify it if they have it available. diff --git a/doc/testing_vs.md b/docfx/docs/testing_vs.md similarity index 100% rename from doc/testing_vs.md rename to docfx/docs/testing_vs.md diff --git a/doc/threading_rules.md b/docfx/docs/threading_rules.md similarity index 85% rename from doc/threading_rules.md rename to docfx/docs/threading_rules.md index f6de5c29a..cf6115457 100644 --- a/doc/threading_rules.md +++ b/docfx/docs/threading_rules.md @@ -1,7 +1,4 @@ -3 Threading Rules -================= - -## Background +# 3 Threading Rules In Visual Studio 2013, we consolidated all our lessons learned from writing a complex, multi-threaded component of Visual Studio into a small and simple set of @@ -15,7 +12,10 @@ extensions](cookbook_vs.md)). The rules are listed below with minimal examples. For a more thorough explanation with more examples, check out [this slideshow](https://www.slideshare.net/slideshow/the-3-vs-threading-rules/78280010). -### Rule #1. If a method has certain thread apartment requirements (STA or MTA) it must either: +### Rule #1. Use `JTF.SwitchToMainThreadAsync` + +If a method has certain thread apartment requirements (STA or MTA) it must either: + 1. Have an asynchronous signature, and asynchronously marshal to the appropriate thread if it isn't originally invoked on a compatible thread. The recommended means of switching to the main thread is: @@ -34,7 +34,9 @@ The rules are listed below with minimal examples. For a more thorough explanatio another thread (blocking while that work is done) except by using the second rule (below). Synchronous blocks in general are to be avoided whenever possible. -### Rule #2. When an implementation of an already-shipped public API must call asynchronous code and block for its completion, it must do so by following this simple pattern: +### Rule #2. Use `JTF.Run` + +When an implementation of an already-shipped public API must call asynchronous code and block for its completion, it must do so by following this simple pattern: ```csharp joinableTaskFactoryInstance.Run(async delegate @@ -43,7 +45,9 @@ joinableTaskFactoryInstance.Run(async delegate }); ``` -### Rule #3. If ever awaiting work that was started earlier, that work must be *joined*. +### Rule #3. Use `JTF.RunAsync` + +If ever awaiting work that was started earlier, that work must be *joined*. For example, one service kicks off some asynchronous work that may later become synchronously blocking: @@ -73,23 +77,25 @@ done immediately after kicking off an asynchronous operation. In particular, no method should call `Task.Wait()` or `Task.Result` on an incomplete `Task`. -### Additional "honorable mention" rules: (Not JTF related) +### Rule #4. Avoid `async void` + +(This one is more of an "honorable mention" rule, as it is not JTF related.) + +Never define `async void` methods. Make the methods return `Task` instead. -### Rule #4. Never define `async void` methods. Make the methods return `Task` instead. - - Exceptions thrown from `async void` methods always crash the process. - - Callers don't even have the option to `await` the result. - - Exceptions can't be reported to telemetry by the caller. - - It's impossible for your VS package to responsibly block in `Package.Close` - till your `async` work is done when it was kicked off this way. - - Be cautious: `async delegate` or `async () =>` become `async void` - methods when passed to a method that accepts `Action` delegates. Only - pass `async` delegates to methods that accept `Func` or - `Func>` parameters. +- Exceptions thrown from `async void` methods always crash the process. +- Callers don't even have the option to `await` the result. +- Exceptions can't be reported to telemetry by the caller. +- It's impossible for your VS package to responsibly block in `Package.Close` + till your `async` work is done when it was kicked off this way. +- Be cautious: `async delegate` or `async () =>` become `async void` + methods when passed to a method that accepts `Action` delegates. Only + pass `async` delegates to methods that accept `Func` or + `Func>` parameters. -Frequently Asked Questions ---------------- +## Frequently Asked Questions -##### Do I need to follow these rules? +### Do I need to follow these rules? All code that runs in Visual Studio itself should follow these rules. These rules have been reviewed by several senior and principal developers @@ -99,7 +105,7 @@ would do well to follow them in managed code where possible. Any other GUI app that invokes asynchronous code that it must occasionally block the UI thread on is also recommended to follow these rules. -##### Why should a method that has a dependency on a specific (kind of) thread be async? +### Why should a method that has a dependency on a specific (kind of) thread be async? Efficiency and responsiveness: Switching threads means that the original thread either can do something else productive (e.g., execute more work from @@ -115,7 +121,7 @@ requires, whether it's thread-safe, etc. The implementation can change over time to add or remove thread affinity, or to switch from locking to scheduling for thread safety, etc. -##### Why do I need to use `JoinableTaskFactory.Run` to synchronously block on asynchronous work rather than just calling `Task.Wait()` or `Task.Result`? +### Why do I need to use `JoinableTaskFactory.Run` to synchronously block on asynchronous work rather than just calling `Task.Wait()` or `Task.Result`? If you're on the main thread, because `Task.Wait` or `Task.Result` will often deadlock because you're now synchronously blocking the main thread for @@ -135,7 +141,7 @@ In contrast, when you use `JoinableTaskFactory.Run`, main thread deadlocks and threadpool exhaustion are automatically mitigated by reusing the blocking thread to execute the continuations. -##### Why not rely on COM marshaling to switch to the main thread when necessary? +### Why not rely on COM marshaling to switch to the main thread when necessary? There are several reasons for this: @@ -200,7 +206,7 @@ There are several reasons for this: not very satisfying after days of investigation. And the owner of that code may refuse to fix their code and you'll have to fix yours anyway. -##### How do these rules protect me from re-entering random code on the main thread? +### How do these rules protect me from re-entering random code on the main thread? By always using asynchronous mechanisms to marshal to the UI thread, you're effectively send a `PostMessage` to the UI thread, which will not re-enter @@ -218,7 +224,7 @@ main thread. That is, using this method to get to the UI thread just works: it avoids both deadlocks and undesirable reentrancy. The only time it deadlocks is when the threading rules listed above are not being followed. -##### Am I protected from other code re-entering my own code while it executes on the main thread? +### Am I protected from other code re-entering my own code while it executes on the main thread? Yes, somewhat. When you call `JoinableTaskFactory.Run` with an async delegate, when your delegate yields (using await) the message pump is temporarily @@ -236,7 +242,7 @@ disabling the message pump yourself, it's usually not a good idea because 3rd party code you may be calling could be relying on a functioning message pump. -##### I'm trying to analyze a hang around code that uses `JoinableTaskFactory`, but since transitions are asynchronous the active threads' call stacks don't tell the whole story. How can I find the cause and fix the hang? +### I'm trying to analyze a hang around code that uses `JoinableTaskFactory`, but since transitions are asynchronous the active threads' call stacks don't tell the whole story. How can I find the cause and fix the hang? Debugging async hangs in general is lacking debugger tooling support at the moment. The debugger and Windows teams are working to improve that @@ -250,11 +256,11 @@ attach WinDBG to the process and dump out incomplete async methods' states. This can be tedious, but we have a script in this file that you can use to make it much easier: [Async hang debugging][AsyncHangDebugging] -##### What is threadpool exhaustion, and why is it bad? +### What is threadpool exhaustion, and why is it bad? See our [threadpool starvation](threadpool_starvation.md) doc. -##### I'm writing an async method that isn't in a `JoinableTask`. Should I use `JTF.SwitchToMainThreadAsync()` to get to the UI thread? +### I'm writing an async method that isn't in a `JoinableTask`. Should I use `JTF.SwitchToMainThreadAsync()` to get to the UI thread? Yes. `JoinableTaskFactory.SwitchToMainThreadAsync()` works great outside a `JoinableTask`. It simply posts the continuation to the main thread for @@ -281,13 +287,13 @@ focus on the fact that at this point, your code needs the main thread and call `JTF.SwitchToMainThreadAsync()`. This allows your caller to set the priority via the `JoinableTask` it may call your code within. -##### What message priority is used to switch to (or resume on) the main thread, and can this be changed? +### What message priority is used to switch to (or resume on) the main thread, and can this be changed? `JoinableTaskFactory`'s default behavior is to switch to the main thread using `SynchronizationContext.Post`, which typically posts a message to the main thread, which puts it below RPC and above user input in priority. -[How to use a different priority for switching to the main thread in VS](cookbook_vs.md#how-to-switch-to-or-use-the-ui-thread-with-background-priority) +[How to use a different priority for switching to the main thread in VS](cookbook_vs.md#how-to-switch-to-or-use-the-ui-thread-with-a-specific-priority) The following describes how to replace the mechanism for getting to the UI thread in a host-independent way: diff --git a/doc/threadpool_starvation.md b/docfx/docs/threadpool_starvation.md similarity index 96% rename from doc/threadpool_starvation.md rename to docfx/docs/threadpool_starvation.md index 73222d14a..f8ac0db06 100644 --- a/doc/threadpool_starvation.md +++ b/docfx/docs/threadpool_starvation.md @@ -31,7 +31,7 @@ We use [PerfView](https://aka.ms/perfview) for these investigations. First, consider how we might come to suspect that thread pool starvation is to blame for a performance or responsiveness problem in the application. In PerfView if we were looking at a sluggish scenario with the CPU Stacks window, we might observe this: -![PerfView CPU Stacks view showing large columns of no CPU activity](images/cpu_stacks_showing_threadpool_starvation.png) +![PerfView CPU Stacks view showing large columns of no CPU activity](../images/cpu_stacks_showing_threadpool_starvation.png) Notice how the `When` column shows several vertical columns of time where there is little or no CPU activity. This is a good indication that we have either excessive lock contention or thread pool exhaustion. @@ -39,7 +39,7 @@ Notice how the `When` column shows several vertical columns of time where there Recent versions of Visual Studio raise an ETW event called `Microsoft-VisualStudio-Common/vs_core_perf_threadpoolstarvation` when thread pool starvation is detected. This is a sure clue of the problem and can give you a time range within the trace to focus your investigation. -![PerfView showing the VS ETW event that indicates thread pool starvation](images/vs_threadpoolstarvation_event.jpg) +![PerfView showing the VS ETW event that indicates thread pool starvation](../images/vs_threadpoolstarvation_event.jpg) ### Investigation steps @@ -49,7 +49,7 @@ While the CLR has thread pool ETW events to indicate thread starvation, these ev 1. In the Thread Time Stacks window, set the Start and End fields to the time range where you had a responsiveness problem. 1. Make sure symbols for the `clr` module are loaded. 1. In the "By Name" tab, find the `clr!ThreadpoolMgr::ExecuteWorkRequest` frame and invoke the "Include Items" command. This will add the frame to the `IncPats` field and filter all frames and stacks to those found on threadpool threads. -1. Also in the "By Name" tab, find the `BLOCKED_TIME` row and invoke the "Show Callers" command. ![PerfView By Name tab showing BLOCKED_TIME](images/blocked_time.png) This will show all stacks that led to any thread pool thread waiting instead of executing on the CPU. ![PerfView Callers of BLOCKED_TIME](images/blocked_time_callers.png) +1. Also in the "By Name" tab, find the `BLOCKED_TIME` row and invoke the "Show Callers" command. ![PerfView By Name tab showing BLOCKED_TIME](../images/blocked_time.png) This will show all stacks that led to any thread pool thread waiting instead of executing on the CPU. ![PerfView Callers of BLOCKED_TIME](../images/blocked_time_callers.png) Take a look at the stacks where the most threads or the most time is spent blocked. This is the code where you should focus your effort to remove the synchronous block. Common mitigations include: diff --git a/docfx/docs/toc.yml b/docfx/docs/toc.yml index 518ffadd9..0e6eb0e07 100644 --- a/docfx/docs/toc.yml +++ b/docfx/docs/toc.yml @@ -1,5 +1,10 @@ items: -- name: Features - href: features.md -- name: Getting Started - href: getting-started.md +- href: getting-started.md +- href: features.md +- href: threading_rules.md +- href: cookbook_vs.md +- href: testing_vs.md +- href: library_with_jtf.md +- href: threadpool_starvation.md +- href: async_hang.md +- href: dumpasync.md diff --git a/doc/images/blocked_time.png b/docfx/images/blocked_time.png similarity index 100% rename from doc/images/blocked_time.png rename to docfx/images/blocked_time.png diff --git a/doc/images/blocked_time_callers.png b/docfx/images/blocked_time_callers.png similarity index 100% rename from doc/images/blocked_time_callers.png rename to docfx/images/blocked_time_callers.png diff --git a/doc/images/cpu_stacks_showing_threadpool_starvation.png b/docfx/images/cpu_stacks_showing_threadpool_starvation.png similarity index 100% rename from doc/images/cpu_stacks_showing_threadpool_starvation.png rename to docfx/images/cpu_stacks_showing_threadpool_starvation.png diff --git a/doc/analyzers/images/fsa.png b/docfx/images/fsa.png similarity index 100% rename from doc/analyzers/images/fsa.png rename to docfx/images/fsa.png diff --git a/doc/images/vs_threadpoolstarvation_event.jpg b/docfx/images/vs_threadpoolstarvation_event.jpg similarity index 100% rename from doc/images/vs_threadpoolstarvation_event.jpg rename to docfx/images/vs_threadpoolstarvation_event.jpg diff --git a/docfx/index.md b/docfx/index.md index 391ee6ec5..637535dda 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -4,6 +4,7 @@ _layout: landing # Overview -This is your docfx landing page. +This is the documentation site for the Microsoft.VisualStudio.Threading library and analyzers. -Click "Docs" across the top to get started. +Click the Docs or Analyzers heading on the top to read the docs. +Or click the API heading to see API-level documentation. diff --git a/docfx/toc.yml b/docfx/toc.yml index 8e9a67007..cf4bdcb5a 100644 --- a/docfx/toc.yml +++ b/docfx/toc.yml @@ -1,5 +1,9 @@ items: - name: Docs href: docs/ +- name: Analyzers + href: analyzers/ - name: API href: api/ +- name: GitHub + href: https://github.com/microsoft/vs-threading diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md index b6955d52e..0662334ab 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/README.md @@ -2,4 +2,4 @@ Static code analyzers to detect common mistakes or potential issues regarding threading and async coding. -[Diagnostic analyzer rules](https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/index.md). +[Diagnostic analyzer rules](https://microsoft.github.io/vs-threading/analyzers/index.html). diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index d3cfd4a2c..047c50c0a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -481,7 +481,7 @@ public static void Deconstruct(this Tuple tuple, public static string GetHelpLink(string analyzerId) { - return $"https://github.com/Microsoft/vs-threading/blob/main/doc/analyzers/{analyzerId}.md"; + return $"https://microsoft.github.io/vs-threading/analyzers/{analyzerId}.html"; } /// diff --git a/src/Microsoft.VisualStudio.Threading/README.md b/src/Microsoft.VisualStudio.Threading/README.md index 465ce9f1d..96928a56c 100644 --- a/src/Microsoft.VisualStudio.Threading/README.md +++ b/src/Microsoft.VisualStudio.Threading/README.md @@ -2,6 +2,8 @@ Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). +[Full documentation](https://microsoft.github.io/vs-threading/docs/getting-started.html). + ## Features * Async versions of many threading synchronization primitives From a8359f99b3bf0fc7d08c9e4bf9a47c8ce30ded50 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 6 Feb 2025 10:37:33 -0700 Subject: [PATCH 1267/1753] Don't update xunit.combinatorial to v2 --- .github/renovate.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index 3b72ae384..09fd2fa77 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -16,6 +16,10 @@ "matchPackageNames": ["xunit.runner.visualstudio"], "allowedVersions": "<3.0" }, + { + "matchPackageNames": ["xunit.combinatorial"], + "allowedVersions": "<2.0" + }, { "matchDatasources": ["dotnet-version", "docker"], "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], From 574886f56785776ec9246585256d3056228cd021 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 7 Feb 2025 07:20:17 -0700 Subject: [PATCH 1268/1753] Update xunit (#346) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 8811c1ea8..8703de3ff 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,8 +10,8 @@ - - + + From f0bbb37d283d2a9df435515f0c7857ce08c9d0f3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 7 Feb 2025 13:56:27 -0700 Subject: [PATCH 1269/1753] Fix markdown links --- README.md | 6 +++--- doc/editorconfigs/README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 689fbf5d2..cabe45111 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ Async synchronization primitives, async collections, TPL and dataflow extensions. The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This package is applicable to any .NET application (not just Visual Studio). -[Getting started](https://microsoft.github.io/vs-threading/docs/getting-started.md). +[Getting started](https://microsoft.github.io/vs-threading/docs/getting-started.html). -[See the full list of features](https://microsoft.github.io/vs-threading/docs/features.md). +[See the full list of features](https://microsoft.github.io/vs-threading/docs/features.html). ## Microsoft.VisualStudio.Threading.Analyzers @@ -19,4 +19,4 @@ Async synchronization primitives, async collections, TPL and dataflow extensions Static code analyzer to detect common mistakes or potential issues regarding threading and async coding. -[Diagnostic analyzer rules](https://microsoft.github.io/vs-threading/analyzers/index.md). +[Diagnostic analyzer rules](https://microsoft.github.io/vs-threading/analyzers/index.html). diff --git a/doc/editorconfigs/README.md b/doc/editorconfigs/README.md index 4fbffaa7b..d07b6ff8c 100644 --- a/doc/editorconfigs/README.md +++ b/doc/editorconfigs/README.md @@ -25,7 +25,7 @@ While several project types have specific .editorconfig files defined in this fo Libraries that may run in any process, whether they have a main thread or not, should code themselves defensively to avoid any dependency on the main thread so that applications that do not follow `JoinableTaskFactory` rules can avoid deadlocks even when synchronously blocking their main thread using `Task.Wait()` on code running inside your library. In particular, shared libraries of general interest should _always_ use `.ConfigureAwait(false)` when awaiting on tasks. -[Learn more about authoring libraries following best threading practices](https://microsoft.github.io/vs-threading/docs/library_with_jtf.md). +[Learn more about authoring libraries following best threading practices](https://microsoft.github.io/vs-threading/docs/library_with_jtf.html). ### Libraries that run inside a JoinableTaskFactory-compliant application From a84479fe40048d4e6239c977ad8cff1e9eeb0297 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 7 Feb 2025 20:57:31 -0700 Subject: [PATCH 1270/1753] Switch nuget feed The new feed will not be filled with CI builds. It will only have nuget.org and other public feeds, and CI for private build packages (e.g. microbuild). --- azure-pipelines/install-dependencies.yml | 4 ++-- nuget.config | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/install-dependencies.yml b/azure-pipelines/install-dependencies.yml index 9835c3f81..01e250c39 100644 --- a/azure-pipelines/install-dependencies.yml +++ b/azure-pipelines/install-dependencies.yml @@ -11,13 +11,13 @@ steps: - template: WIFtoPATauth.yml parameters: wifServiceConnectionName: azure-public/vside package pull - deadPATServiceConnectionId: 0ae39abc-4d06-4436-a7b5-865833df49db # azure-public/msft_consumption + deadPATServiceConnectionId: 46f0d4d4-9fff-4c58-a1ab-3b8f97e3b78a # azure-public/msft_consumption_public - task: NuGetAuthenticate@1 displayName: 🔏 Authenticate NuGet feeds inputs: ${{ if and(parameters.needsAzurePublicFeeds, eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9')) }}: - nuGetServiceConnections: azure-public/msft_consumption + nuGetServiceConnections: azure-public/msft_consumption_public - powershell: | $AccessToken = '$(System.AccessToken)' # Avoid specifying the access token directly on the init.ps1 command line to avoid it showing up in errors diff --git a/nuget.config b/nuget.config index 52071eaac..a46b63888 100644 --- a/nuget.config +++ b/nuget.config @@ -6,8 +6,7 @@ - - + From a71c97c2377c9d17faafb1a570350c213169efd0 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 10 Feb 2025 09:58:39 -0700 Subject: [PATCH 1271/1753] Update becheran/mlc action to v0.21.0 (#347) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 7eb7860e2..da3e9e1f1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -76,6 +76,6 @@ jobs: steps: - uses: actions/checkout@v4 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.19.2 + uses: becheran/mlc@v0.21.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From a8d08d4856b60c9a2911b3a2fd0f1f297bd4a7ea Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 10 Feb 2025 09:59:19 -0700 Subject: [PATCH 1272/1753] Update dependency Microsoft.NET.Test.Sdk to 17.13.0 (#348) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 8703de3ff..350c7eb53 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,7 +9,7 @@ - + From 62c89782b8d88a4cfef61338775a14522874e001 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Feb 2025 10:01:53 -0700 Subject: [PATCH 1273/1753] Bump MicroBuildVersion to 2.0.187 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c2c319598..f9d52e8e2 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.181 + 2.0.187 From c54b2b362185cc148d4c5690bac3f9f1d8adc9d6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Feb 2025 10:17:08 -0700 Subject: [PATCH 1274/1753] Rollback dependencies to publicly available versions --- Directory.Packages.props | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index f564b7b35..56791685b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 3.11.0 4.12.0 1.1.2 - 3.1.525101 + 3.0.442202 3.11.0-beta1.24527.2 @@ -26,9 +26,9 @@ - - - + + + From dcac5622a9fdd730181042ec75f4ce3b4d14ba8f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Feb 2025 11:27:55 -0700 Subject: [PATCH 1275/1753] Revert "Fix up build breaks after dependency upgrade" This reverts commit efdee0b1349ce980deedd8d7ca130e8258d1486d. --- src/SosThreadingTools/DumpAsyncCommand.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index 9aedaf999..dcc005c56 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -370,7 +370,7 @@ private void MarkThreadingBlockTasks(List allStateMachines) { if (visitedObjects.Add(stackObject.Address)) { - ClrObject joinableTaskObject = stackObject.Type is null ? runtime.Heap.GetObject(stackObject.Address) : runtime.Heap.GetObject(stackObject.Address, stackObject.Type); + var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); int state = joinableTaskObject.ReadField("state"); if ((state & 0x10) == 0x10) { From 5724fef06be91bdb391252c650d250353b42fdc2 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 12 Feb 2025 07:43:48 -0700 Subject: [PATCH 1276/1753] Update Dockerfile and global.json updates to v9.0.200 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 6952a419f..78a791bc7 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.102-noble +FROM mcr.microsoft.com/dotnet/sdk:9.0.200-noble # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 119eff7ee..024087d2a 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.102", + "version": "9.0.200", "rollForward": "patch", "allowPrerelease": false } From c24a8f0bfb381569bbc93d518aea650dc0b75a48 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 18 Feb 2025 21:06:17 -0700 Subject: [PATCH 1277/1753] Update dependency dotnet-coverage to 17.14.1 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 1b8c58cef..11790a980 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "17.13.1", + "version": "17.14.1", "commands": [ "dotnet-coverage" ], From 05277201a25761e23e894abbc408fb3bb73f87a9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 20 Feb 2025 05:51:42 -0700 Subject: [PATCH 1278/1753] Update dependency docfx to 2.78.3 (#351) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 11790a980..62b56f9fe 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -24,7 +24,7 @@ "rollForward": false }, "docfx": { - "version": "2.78.2", + "version": "2.78.3", "commands": [ "docfx" ], From 57860c2f297b16674142f724eb2ed1d952f1ee91 Mon Sep 17 00:00:00 2001 From: Tobias Laving Date: Sat, 22 Feb 2025 21:41:37 +0100 Subject: [PATCH 1279/1753] Fix super set for VSTHRD103 --- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 7 +++++- .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 24 +++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index 46cde9c5a..e269989d1 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -163,7 +163,12 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) /// private static bool HasSupersetOfParameterTypes(IMethodSymbol candidateMethod, IMethodSymbol baselineMethod) { - return candidateMethod.Parameters.All(candidateParameter => baselineMethod.Parameters.Any(baselineParameter => baselineParameter.Type?.Equals(candidateParameter.Type, SymbolEqualityComparer.Default) ?? false)); + if (baselineMethod.Parameters.Length > candidateMethod.Parameters.Length) + { + return false; + } + + return baselineMethod.Parameters.All(baselineParameter => candidateMethod.Parameters.Any(candidateParameter => baselineParameter.Type?.Equals(candidateParameter.Type, SymbolEqualityComparer.Default) ?? false)); } private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext context) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index b4ff2da62..6eca41811 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -1339,6 +1339,30 @@ void Bar() {} await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task DoNotRaiseForDistinctSyncMethod() + { + string test = @" +using System.Threading.Tasks; + +class SomeClass { + Task Method(){ + Bar(10, 11); + return Task.CompletedTask; + } + + Task Foo() => Task.FromResult(11); + async Task BarAsync(int id) { + var number = await Foo(); + return Bar(id, number); + } + int Bar(int id, int number) => id * number; +} +"; + + await CSVerify.VerifyAnalyzerAsync(test); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName) => CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(line, column, line, column + length).WithArguments(methodName); From 956db2584a7b4fa663b54afa17d059a2455b7e97 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 25 Feb 2025 03:55:38 +0000 Subject: [PATCH 1280/1753] Update dotnet monorepo to 4.13.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 56791685b..41dbbc141 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ true 2.0.187 3.11.0 - 4.12.0 + 4.13.0 1.1.2 3.0.442202 3.11.0-beta1.24527.2 From 077bfc33a6dc3e8cf600f983bea70c322973457e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 26 Feb 2025 10:28:07 -0700 Subject: [PATCH 1281/1753] Do not verify signed binaries in LocBin artifact This artifact does not ship and only serves as input for translators. --- azure-pipelines/official.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index a9b5b81ef..b8a4655de 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -46,7 +46,7 @@ extends: codeSignValidation: enabled: true break: true - additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** + additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|LocBin-*\**;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** policheck: enabled: true exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml From 81ff3412fff91ecc268aaaf7220b865ca3166d54 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 26 Feb 2025 13:06:42 -0700 Subject: [PATCH 1282/1753] Add placeholder option for vs-validation to skip optimization --- azure-pipelines/vs-validation.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 2fa5086d0..1b415b221 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -5,6 +5,12 @@ trigger: none # We only want to trigger manually or based on resources pr: none +# parameters: +# - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. +# displayName: Skip OptProf optimization +# type: boolean +# default: false + resources: repositories: - repository: MicroBuildTemplate @@ -36,6 +42,7 @@ extends: parameters: Is1ESPT: true RealSign: false + # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: name: AzurePipelines-EO From 0fb1ddedffea5ffe98ec8a0a1b451495c9091a99 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 27 Feb 2025 05:53:53 -0700 Subject: [PATCH 1283/1753] Update dependency dotnet-coverage to 17.14.2 (#352) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 62b56f9fe..c21d04bd0 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "17.14.1", + "version": "17.14.2", "commands": [ "dotnet-coverage" ], From 161bac90970e29dc4558e61f66c15c8c4d899e6a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 3 Mar 2025 11:15:37 -0700 Subject: [PATCH 1284/1753] Fix GitHub release workflow in dispatched runs Dispatched runs were failing because they still looked for a GitHub release via properties that are not defined. Also, upload artifacts to the GitHub release recursively, avoiding directories. --- .github/workflows/release.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 766ebaf56..c6a5edd8a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -74,11 +74,11 @@ jobs: - name: 💽 Upload artifacts to release shell: pwsh - if: ${{ github.event.release.assets_url }} != '' + if: ${{ github.event_name == 'release' && github.event.release.assets_url != '' }} env: GH_TOKEN: ${{ github.token }} run: | - Get-ChildItem '${{ runner.temp }}/deployables' |% { + Get-ChildItem '${{ runner.temp }}/deployables' -File -Recurse |% { Write-Host "Uploading $($_.Name) to release..." gh release -R ${{ github.repository }} upload "${{ github.ref_name }}" $_.FullName } From 1e00ddcc7078405b5bf266b54b844fb0b64da280 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Mar 2025 15:41:10 -0700 Subject: [PATCH 1285/1753] Drop semanticCommits setting from renovate.json It's default is to automatically detect the repo's convention, which is great. --- .github/renovate.json | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/renovate.json b/.github/renovate.json index 092ed0497..9582ad998 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1,7 +1,6 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": ["config:recommended"], - "semanticCommits": "disabled", "labels": ["dependencies"], "packageRules": [ { From 1cc3b975881ad6a07cc96d45f2f90dc997de6ff1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 4 Mar 2025 15:42:02 -0700 Subject: [PATCH 1286/1753] Switch to renovate rules from Microsoft presets --- .github/renovate.json | 53 ++++--------------------------------------- 1 file changed, 5 insertions(+), 48 deletions(-) diff --git a/.github/renovate.json b/.github/renovate.json index 90b80965f..4cd2b0cb6 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1,51 +1,8 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": ["config:recommended"], - "labels": ["dependencies"], - "packageRules": [ - { - "matchPackageNames": ["nbgv", "nerdbank.gitversioning"], - "groupName": "nbgv and nerdbank.gitversioning updates" - }, - { - "matchPackageNames": ["xunit*"], - "groupName": "xunit" - }, - { - "matchDatasources": ["dotnet-version", "docker"], - "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], - "groupName": "Dockerfile and global.json updates" - }, - { - "matchPackageNames": ["*"], - "allowedVersions": "!/-g[a-f0-9]+$/" - }, - { - "matchPackageNames": [ - "System.Collections.Immutable", - "System.Composition*", - "System.Diagnostics.DiagnosticSource", - "System.IO.Pipelines", - "System.Reflection.Metadata", - "System.Text.Json", - "System.Threading.Tasks.Dataflow", - "Microsoft.Bcl.AsyncInterfaces" - ], - "allowedVersions": "<9.0", - "groupName": "Included in .NET runtime" - }, - { - "matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"], - "groupName": "microbuild" - }, - { - "matchPackageNames": ["Microsoft.VisualStudio.*"], - "groupName": "Visual Studio SDK" - }, - { - "matchPackageNames": ["Microsoft.VisualStudio.*"], - "matchUpdateTypes": ["patch"], - "enabled": false - } - ] + "extends": [ + "github>microsoft/vs-renovate-presets:microbuild", + "github>microsoft/vs-renovate-presets:vs_main_dependencies" + ], + "packageRules": [] } From 46b079d8456bf219929c43fb6c4f9bad8c1a6297 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Thu, 6 Mar 2025 10:00:58 -0800 Subject: [PATCH 1287/1753] Fix a race condition which leads product to hang the order to read this.joinableTask is not ensured in the current lock-free part of the logic. Under a race condition, this leads AsyncLazy to wait the inner task instead of the joinable task when two threads hitting this code about the same time. --- src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 013f96fa2..1f9c3ae6f 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -224,6 +224,10 @@ public Task GetValueAsync(CancellationToken cancellationToken) // to synchronously block the Main thread waiting for the result // without leading to deadlocks. this.joinableTask = this.jobFactory.RunAsync(valueFactory); + + // this ensures that this.joinableTask must be committed before this.value + Thread.MemoryBarrier(); + this.value = this.joinableTask.Task; } else @@ -245,6 +249,9 @@ public Task GetValueAsync(CancellationToken cancellationToken) resumableAwaiter?.Resume(); } + // this ensures that this.joinableTask cannot be retrieved before the conditional check using this.value + Thread.MemoryBarrier(); + return this.joinableTask?.JoinAsync(continueOnCapturedContext: false, cancellationToken) ?? this.value.WithCancellation(cancellationToken); } From 164ff31aab9c8173067e93ddd290a81e6c6eb2d4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 7 Mar 2025 17:34:25 -0700 Subject: [PATCH 1288/1753] Do not fail on missing LCL files in official builds Missing LCL files are a normal consequence of creating a new library, and unless we get successful builds out after creating that library, translations will never be provided (thus resolving the warning). --- azure-pipelines/dotnet.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 180e36c29..2abca9eb2 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -8,7 +8,7 @@ parameters: steps: -- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" +- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904,LOCTASK002 /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: 🛠 dotnet build - ${{ if not(parameters.IsOptProf) }}: From 46e768b364bbff90441fb5c0c9bfb160f4bfc67d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 9 Mar 2025 19:12:44 -0600 Subject: [PATCH 1289/1753] Revert "Avoid `dotnet format` hang" This reverts commit 20e285c4d956424d2686261faa32f8721d5a7acf. This workaround is no longer needed with the 9.0.200 .NET SDK. --- Directory.Packages.props | 5 ++--- azure-pipelines/build.yml | 4 +--- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 350c7eb53..03d41a123 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -19,9 +19,8 @@ - - + - \ No newline at end of file + diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5c106ade4..108258282 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -37,10 +37,8 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} - - script: dotnet format --verify-no-changes + - script: dotnet format --verify-no-changes --no-restore displayName: 💅 Verify formatted code - env: - dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - template: expand-template.yml - job: macOS From 6ed2f360da0cf53546b2ea4d11330958bd7883be Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Mar 2025 12:12:00 -0600 Subject: [PATCH 1290/1753] Consolidate SDL tasks for insertion job --- azure-pipelines/vs-insertion.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 6aaba41cf..c19331d42 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -32,6 +32,8 @@ extends: - job: insertion displayName: VS insertion pool: VSEngSS-MicroBuild2022-1ES + templateContext: + outputParentDirectory: $(Pipeline.Workspace)/CI steps: - checkout: none - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" From 65f844095c1638f14f4bc8c37f29534f6ca326a3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Mar 2025 12:13:41 -0600 Subject: [PATCH 1291/1753] Disable redundant 1ES SBOM task --- azure-pipelines/official.yml | 2 +- azure-pipelines/unofficial.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index b8a4655de..abf0ff257 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -53,7 +53,7 @@ extends: suppression: suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress sbom: - enabled: true + enabled: false # Skip 1ES SBOM because microbuild has our own sbom system stages: - stage: Build variables: diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index ff3c2b5d7..d33b74213 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -65,7 +65,7 @@ extends: enabled: ${{ parameters.EnableProductionSDL }} exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml sbom: - enabled: ${{ parameters.EnableProductionSDL }} + enabled: false # Skip 1ES SBOM because microbuild has our own sbom system stages: - stage: Build variables: From 039ac0b644f5cc3cab1982542457e2d7e0a2e607 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 10 Mar 2025 12:17:16 -0600 Subject: [PATCH 1292/1753] Put publishing code coverage under a switch --- azure-pipelines/build.yml | 6 +++++- azure-pipelines/official.yml | 5 +++++ azure-pipelines/unofficial.yml | 5 +++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 1a8305867..1448c0558 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -71,6 +71,10 @@ parameters: type: boolean default: true +- name: PublishCodeCoverage + type: boolean + default: true + # Whether this is a special one-off build for inserting into VS for a validation insertion PR (that will never be merged). - name: SkipCodesignVerify type: boolean @@ -303,7 +307,7 @@ jobs: parameters: EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - - ${{ if parameters.RunTests }}: + - ${{ if and(parameters.RunTests, parameters.PublishCodeCoverage) }}: - template: publish-codecoverage.yml parameters: EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index abf0ff257..6d7c02130 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -27,6 +27,10 @@ parameters: displayName: Include APIScan with compliance tools type: boolean default: false # enable in individual repos only AFTER updating TSAOptions.json with your own values +- name: PublishCodeCoverage + displayName: Publish code coverage + type: boolean + default: true resources: repositories: @@ -77,6 +81,7 @@ extends: os: macOS EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} RunTests: ${{ parameters.RunTests }} + PublishCodeCoverage: ${{ parameters.PublishCodeCoverage }} - template: /azure-pipelines/prepare-insertion-stages.yml@self parameters: RealSign: true diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index d33b74213..9ca100eae 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -37,6 +37,10 @@ parameters: displayName: Enable Production SDL type: boolean default: false +- name: PublishCodeCoverage + displayName: Publish code coverage + type: boolean + default: true resources: repositories: @@ -89,3 +93,4 @@ extends: os: macOS EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} RunTests: ${{ parameters.RunTests }} + PublishCodeCoverage: ${{ parameters.PublishCodeCoverage }} From c2f2fccbeda7b2839f34804326032c689b247205 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Mar 2025 10:06:51 -0600 Subject: [PATCH 1293/1753] Insert into rel/d17.13 --- tools/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/variables/InsertTargetBranch.ps1 b/tools/variables/InsertTargetBranch.ps1 index cdcc91943..c4f3cdf90 100644 --- a/tools/variables/InsertTargetBranch.ps1 +++ b/tools/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.13' From f5ed6f4510724af5e8d1932eb09d3c840e2211d8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Mar 2025 10:06:26 -0600 Subject: [PATCH 1294/1753] Set version to '17.14-alpha' --- tools/variables/InsertTargetBranch.ps1 | 2 +- version.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/variables/InsertTargetBranch.ps1 b/tools/variables/InsertTargetBranch.ps1 index c4f3cdf90..cdcc91943 100644 --- a/tools/variables/InsertTargetBranch.ps1 +++ b/tools/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'rel/d17.13' +'main' diff --git a/version.json b/version.json index 0b00bfe8a..67a5f1419 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.13", + "version": "17.14-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} +} \ No newline at end of file From 63a87bfd893209fba856f4c2300760f1174698a4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Mar 2025 09:52:30 -0600 Subject: [PATCH 1295/1753] Create a `Microsoft.VisualStudio.Threading.Only` package This new package has the library, but no analyzers dependency. The analyzers dependency is retained by the original `Microsoft.VisualStudio.Threading` package, along with a new dependency on the `Microsoft.VisualStudio.Threading.Only` package. This allows consumers like StreamJsonRpc to express a dependency on `Microsoft.VisualStudio.Threading.Only` instead of `Microsoft.VisualStudio.Threading` in order to prevent its downstream users from having threading analyzers applied automatically, which they may not want. --- Microsoft.VisualStudio.Threading.sln | 11 ++++++++++ src/LibraryNuspecProperties.props | 12 +++++++++++ ...VisualStudio.Threading.JointPackage.csproj | 19 +++++++++++++++++ .../Microsoft.VisualStudio.Threading.csproj | 21 ++++++------------- 4 files changed, 48 insertions(+), 15 deletions(-) create mode 100644 src/LibraryNuspecProperties.props create mode 100644 src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj diff --git a/Microsoft.VisualStudio.Threading.sln b/Microsoft.VisualStudio.Threading.sln index aab07fca4..57ec45323 100644 --- a/Microsoft.VisualStudio.Threading.sln +++ b/Microsoft.VisualStudio.Threading.sln @@ -51,6 +51,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{C1DAF484-7 test\Directory.Build.targets = test\Directory.Build.targets EndProjectSection EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.VisualStudio.Threading.JointPackage", "src\Microsoft.VisualStudio.Threading.JointPackage\Microsoft.VisualStudio.Threading.JointPackage.csproj", "{D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -137,6 +139,14 @@ Global {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|Any CPU.Build.0 = Release|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|NonWindows.ActiveCfg = Release|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|NonWindows.Build.0 = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|NonWindows.ActiveCfg = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|NonWindows.Build.0 = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|Any CPU.Build.0 = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|NonWindows.ActiveCfg = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|NonWindows.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -152,6 +162,7 @@ Global {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} {D5A0D627-7853-43F5-9AF4-E23D062C6ABA} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} {8CDF7526-D625-4E16-A266-BAF654ABE181} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {E2124DFF-970E-4BA1-9E50-3ADB0AABF347} diff --git a/src/LibraryNuspecProperties.props b/src/LibraryNuspecProperties.props new file mode 100644 index 000000000..51565ee53 --- /dev/null +++ b/src/LibraryNuspecProperties.props @@ -0,0 +1,12 @@ + + + netstandard2.0;net8.0;net472 + $(TargetFrameworks);net8.0-windows + + Async synchronization primitives, async collections, TPL and dataflow extensions. + The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This + package is applicable to any .NET application (not just Visual Studio). + + Threading Async Lock Synchronization Threadsafe + + diff --git a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj new file mode 100644 index 000000000..79f6b8825 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj @@ -0,0 +1,19 @@ + + + + Microsoft.VisualStudio.Threading + false + false + $(NoWarn);NU5128 + + + + + + + + + + + + diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index a83aa0770..3e5321d89 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -1,17 +1,14 @@  + - netstandard2.0;net8.0;net472 - - Async synchronization primitives, async collections, TPL and dataflow extensions. - Async synchronization primitives, async collections, TPL and dataflow extensions. - The JoinableTaskFactory allows synchronously blocking the UI thread for async work. This - package is applicable to any .NET application (not just Visual Studio). - Threading Async Lock Synchronization Threadsafe - + Microsoft.VisualStudio.Threading.Only + $(Description) + This package contains only the library, without a dependency on the analyzers. + Use the Microsoft.VisualStudio.Threading package to get the library and analyzers together. + true - $(TargetFrameworks);net8.0-windows true @@ -34,11 +31,5 @@ - - - - From f4cea18c07bc3d53498cbfe85515c862c69febc9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Mar 2025 18:22:04 -0600 Subject: [PATCH 1296/1753] Opt the JointPackage project out of localization --- .../Microsoft.VisualStudio.Threading.JointPackage.csproj | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj index 79f6b8825..904eb18f4 100644 --- a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj +++ b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj @@ -5,6 +5,7 @@ false false $(NoWarn);NU5128 + false From dcc296378aafe7b7ed65965cabbb7fad59d77f3f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 12 Mar 2025 09:45:59 -0600 Subject: [PATCH 1297/1753] Drop github release workflow --- .github/workflows/release.yml | 88 ----------------------------------- 1 file changed, 88 deletions(-) delete mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index c6a5edd8a..000000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -name: 🎁 Release - -on: - release: - types: [published] - workflow_dispatch: - inputs: - ship_run_id: - description: ID of the GitHub workflow run to ship - required: true - -run-name: ${{ github.ref_name }} - -permissions: - actions: read - contents: write - -jobs: - release: - runs-on: ubuntu-24.04 - steps: - - name: ⚙️ Initialization - shell: pwsh - run: | - if ('${{ secrets.NUGET_API_KEY }}') { - Write-Host "NUGET_API_KEY secret detected. NuGet packages will be pushed." - echo "NUGET_API_KEY_DEFINED=true" >> $env:GITHUB_ENV - } - - - name: 🔎 Search for build of ${{ github.ref }} - shell: pwsh - id: findrunid - env: - GH_TOKEN: ${{ github.token }} - run: | - if ('${{ inputs.ship_run_id }}') { - $runid = '${{ inputs.ship_run_id }}' - } else { - $restApiRoot = '/repos/${{ github.repository }}' - - # Resolve the tag reference to a commit sha - $resolvedRef = gh api ` - -H "Accept: application/vnd.github+json" ` - -H "X-GitHub-Api-Version: 2022-11-28" ` - $restApiRoot/git/ref/tags/${{ github.ref_name }} ` - | ConvertFrom-Json - $commitSha = $resolvedRef.object.sha - - Write-Host "Resolved ${{ github.ref_name }} to $commitSha" - - $releases = gh run list -R ${{ github.repository }} -c $commitSha -w .github/workflows/build.yml -s success --json databaseId,startedAt ` - | ConvertFrom-Json | Sort-Object startedAt -Descending - - if ($releases.length -eq 0) { - Write-Error "No successful builds found for ${{ github.ref }}." - } elseif ($releases.length -gt 1) { - Write-Warning "More than one successful run found for ${{ github.ref }}. Artifacts from the most recent successful run will ship." - } - - $runid = $releases[0].databaseId - } - - Write-Host "Using artifacts from run-id: $runid" - - Echo "runid=$runid" >> $env:GITHUB_OUTPUT - - - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@v4 - with: - name: deployables-Linux - path: ${{ runner.temp }}/deployables - run-id: ${{ steps.findrunid.outputs.runid }} - github-token: ${{ github.token }} - - - name: 💽 Upload artifacts to release - shell: pwsh - if: ${{ github.event_name == 'release' && github.event.release.assets_url != '' }} - env: - GH_TOKEN: ${{ github.token }} - run: | - Get-ChildItem '${{ runner.temp }}/deployables' -File -Recurse |% { - Write-Host "Uploading $($_.Name) to release..." - gh release -R ${{ github.repository }} upload "${{ github.ref_name }}" $_.FullName - } - - - name: 🚀 Push NuGet packages - run: dotnet nuget push ${{ runner.temp }}/deployables/*.nupkg --source https://api.nuget.org/v3/index.json -k '${{ secrets.NUGET_API_KEY }}' - if: ${{ env.NUGET_API_KEY_DEFINED == 'true' }} From e5d6527429d1be1824854435c32112356c387aff Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 11:10:57 -0600 Subject: [PATCH 1298/1753] Merge pull request #355 from AArnott/renovate/dockerfile-and-global.json-updates Update Dockerfile and global.json updates to v9.0.201 --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 78a791bc7..8f9e2d8b6 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.200-noble +FROM mcr.microsoft.com/dotnet/sdk:9.0.201-noble # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 024087d2a..95c3e3074 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.200", + "version": "9.0.201", "rollForward": "patch", "allowPrerelease": false } From 52d98610beae3dc3d6452ee4ada50a1f7f378c00 Mon Sep 17 00:00:00 2001 From: "CSIGS@microsoft.com" Date: Fri, 14 Mar 2025 08:05:17 -0700 Subject: [PATCH 1299/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20250314114720535. (#1432) --- loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl | 6 +++--- 13 files changed, 39 insertions(+), 39 deletions(-) diff --git a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl index ac73bf92b..5168395d6 100644 --- a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl index 924e2e177..5d44c68c0 100644 --- a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl index c3c0a1a9b..d640658d3 100644 --- a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl index f7b2ef7c5..087c0d92f 100644 --- a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl index ca2b9dd3b..9ef19b70f 100644 --- a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl index 193ed219d..7994090ff 100644 --- a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl index eba9d85dc..acc786527 100644 --- a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl index fe0959ec7..04b91b6be 100644 --- a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl index 50982085b..0c7c09a2e 100644 --- a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl index bfebdc509..693c50fde 100644 --- a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl index 2f067b9d1..284219293 100644 --- a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl index 25efb16b5..b34aad47c 100644 --- a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + diff --git a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl index 8aaf728c9..781c173fc 100644 --- a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl @@ -245,12 +245,12 @@ - + - + - + From f4d653adbaf94387300bf8b4a2dc767d995faf25 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 14 Mar 2025 10:58:28 -0600 Subject: [PATCH 1300/1753] Fix regression in inclusion of analyzer's built-in AdditionalFiles --- .../Microsoft.VisualStudio.Threading.JointPackage.csproj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj index 904eb18f4..4d7805ae0 100644 --- a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj +++ b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj @@ -13,8 +13,8 @@ - - + + From 3967abe452c8cd433c3e4596126373d41a06bd87 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Mar 2025 10:17:04 -0600 Subject: [PATCH 1301/1753] Fix build breaks --- .../InternalUtilities.cs | 10 +++---- .../ListOfOftenOne`1.cs | 4 +-- .../AsyncLazyTests.cs | 20 +++++++------- .../AsyncReaderWriterLockTests.cs | 4 +-- .../AsyncSemaphoreTests.cs | 4 +-- .../JoinableTaskContextTests.cs | 2 +- .../JoinableTaskTests.cs | 26 +++++++++---------- .../ProgressWithCompletionTests.cs | 2 +- ...ngleThreadedSynchronizationContextTests.cs | 6 ++--- .../TplExtensionsTests.cs | 10 +++---- 10 files changed, 44 insertions(+), 44 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs index ab6150081..ad95047e6 100644 --- a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs +++ b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs @@ -78,7 +78,7 @@ internal static IEnumerable GetAsyncReturnStackFrames(this Delegate cont do { - var state = GetStateMachineFieldValueOnSuffix(stateMachine, "__state"); + object? state = GetStateMachineFieldValueOnSuffix(stateMachine, "__state"); yield return string.Format( CultureInfo.CurrentCulture, "{2}{0} (state: {1}, address: 0x{3:X8})", @@ -194,13 +194,13 @@ private static IEnumerable FindContinuationDelegates(IAsyncStateMachin { Requires.NotNull(stateMachine, nameof(stateMachine)); - var builder = GetStateMachineFieldValueOnSuffix(stateMachine, "__builder"); + object? builder = GetStateMachineFieldValueOnSuffix(stateMachine, "__builder"); if (builder is null) { yield break; } - var task = GetFieldValue(builder, "m_task"); + object? task = GetFieldValue(builder, "m_task"); if (task is null) { // Probably this builder is an instance of "AsyncTaskMethodBuilder", so we need to get its inner "AsyncTaskMethodBuilder" @@ -224,7 +224,7 @@ private static IEnumerable FindContinuationDelegates(IAsyncStateMachin yield break; } - var continuationObject = continuationField.GetValue(task); + object? continuationObject = continuationField.GetValue(task); if (continuationObject is null) { yield break; @@ -232,7 +232,7 @@ private static IEnumerable FindContinuationDelegates(IAsyncStateMachin if (continuationObject is IEnumerable items) { - foreach (var item in items) + foreach (object? item in items) { Delegate? action = item as Delegate ?? GetFieldValue(item!, "m_action") as Delegate; if (action is object) diff --git a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs index 6520289fc..6ff984ca1 100644 --- a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs +++ b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs @@ -61,7 +61,7 @@ public void Add(T value) do { priorValue = Volatile.Read(ref this.value); - var newValue = Combine(priorValue, value); + object newValue = Combine(priorValue, value); fieldBeforeExchange = Interlocked.CompareExchange(ref this.value, newValue, priorValue); } while (priorValue != fieldBeforeExchange); @@ -77,7 +77,7 @@ public void Remove(T value) do { priorValue = Volatile.Read(ref this.value); - var newValue = Remove(priorValue, value); + object? newValue = Remove(priorValue, value); fieldBeforeExchange = Interlocked.CompareExchange(ref this.value, newValue, priorValue); } while (priorValue != fieldBeforeExchange); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 4fc8a2736..0c3e76a21 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -390,7 +390,7 @@ public void ToStringForUncreatedValue() public async Task ToStringForCreatedValue() { var lazy = new AsyncLazy(() => Task.FromResult(3)); - var value = await lazy.GetValueAsync(); + int value = await lazy.GetValueAsync(); string result = lazy.ToString(); Assert.Equal(value.ToString(CultureInfo.InvariantCulture), result); } @@ -485,7 +485,7 @@ async delegate // the Main thread waiting for it to complete. // This will deadlock unless the AsyncLazy joins // the value factory's async pump with the currently blocking one. - var value = await lazy.GetValueAsync(); + object value = await lazy.GetValueAsync(); Assert.NotNull(value); }); @@ -523,7 +523,7 @@ async delegate }, passJtfToLazyCtor ? asyncPump : null); // mix it up to exercise all the code paths in the ctor. - var backgroundRequest = Task.Run(async delegate + Task backgroundRequest = Task.Run(async delegate { return await lazy.GetValueAsync(); }); @@ -532,7 +532,7 @@ async delegate Task? foregroundRequest = lazy.GetValueAsync(); SingleThreadedTestSynchronizationContext.IFrame? frame = SingleThreadedTestSynchronizationContext.NewFrame(); - var combinedTask = Task.WhenAll(foregroundRequest, backgroundRequest); + Task combinedTask = Task.WhenAll(foregroundRequest, backgroundRequest); combinedTask.WithTimeout(UnexpectedTimeout).ContinueWith(_ => frame.Continue = false, TaskScheduler.Default); SingleThreadedTestSynchronizationContext.PushFrame(ctxt, frame); @@ -571,7 +571,7 @@ async delegate }, asyncPump); - var backgroundRequest = Task.Run(async delegate + Task backgroundRequest = Task.Run(async delegate { return await lazy.GetValueAsync(); }); @@ -579,8 +579,8 @@ async delegate Thread.Sleep(AsyncDelay); // Give the background thread time to call GetValueAsync(), but it doesn't yield (when the test was written). asyncPump.Run(async delegate { - var foregroundValue = await lazy.GetValueAsync(this.TimeoutToken); - var backgroundValue = await backgroundRequest; + object foregroundValue = await lazy.GetValueAsync(this.TimeoutToken); + object backgroundValue = await backgroundRequest; Assert.Same(foregroundValue, backgroundValue); }); } @@ -614,14 +614,14 @@ async delegate }, asyncPump); - var backgroundRequest = Task.Run(async delegate + Task backgroundRequest = Task.Run(async delegate { return await lazy.GetValueAsync(); }); Thread.Sleep(AsyncDelay); // Give the background thread time to call GetValueAsync(), but it doesn't yield (when the test was written). - var foregroundValue = lazy.GetValue(this.TimeoutToken); - var backgroundValue = asyncPump.Run(() => backgroundRequest); + object foregroundValue = lazy.GetValue(this.TimeoutToken); + object backgroundValue = asyncPump.Run(() => backgroundRequest); Assert.Same(foregroundValue, backgroundValue); } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index 8b7690814..9944108c7 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -4228,7 +4228,7 @@ public async Task SetLockDataNoLock() lck.SetLockData(null); Assert.Null(lck.GetLockData()); - var value1 = new object(); + object value1 = new object(); lck.SetLockData(value1); Assert.Equal(value1, lck.GetLockData()); @@ -4236,7 +4236,7 @@ public async Task SetLockDataNoLock() { Assert.Null(lck.GetLockData()); - var value2 = new object(); + object value2 = new object(); lck.SetLockData(value2); Assert.Equal(value2, lck.GetLockData()); } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs index b5cd20d64..5265569a9 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs @@ -78,7 +78,7 @@ public async Task Contested_OneWaitsAtATime(int initialCount) // The second wave cannot enter the semaphore until space is available. for (int i = 0; i < initialCount; i++) { - var nextContestedIndex = initialCount + i; + int nextContestedIndex = initialCount + i; releasers[nextContestedIndex] = this.lck.EnterAsync(); Assert.False(releasers[nextContestedIndex].IsCompleted); releasers[i].Result.Dispose(); // exit the semaphore with a previously assigned one. @@ -108,7 +108,7 @@ public async Task Contested_ManyWaitAtATime(int initialCount) // The second wave cannot enter the semaphore until space is available. for (int i = 0; i < initialCount; i++) { - var nextContestedIndex = initialCount + i; + int nextContestedIndex = initialCount + i; releasers[nextContestedIndex] = this.lck.EnterAsync(); Assert.False(releasers[nextContestedIndex].IsCompleted); } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index 93dfffa59..dc36759f6 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -69,7 +69,7 @@ public void ReportHangOnRun() { Tuple? tuple = await hangQueue.DequeueAsync(ct); TimeSpan duration = tuple.Item1; - var iterations = tuple.Item2; + int iterations = tuple.Item2; Guid id = tuple.Item3; Assert.True(lastDuration == TimeSpan.Zero || lastDuration < duration); Assert.Equal(lastIteration + 1, iterations); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index 0ec61cb6a..15af17a7a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -48,7 +48,7 @@ public void RunFuncOfTaskOfTMTA() [Fact] public void LeaveAndReturnToMainThread() { - var fullyCompleted = false; + bool fullyCompleted = false; this.asyncPump.Run(async delegate { Assert.Equal(this.originalThreadManagedId, Environment.CurrentManagedThreadId); @@ -238,7 +238,7 @@ public void SwitchToMainThreadAsyncTransitionsCanSeeAsyncLocals() Exception? delegateFailure = null; var asyncLocal = new System.Threading.AsyncLocal(); - var asyncLocalValue = new object(); + object asyncLocalValue = new object(); // The point of this test is to verify that the transitioning/transitioned // methods on the JoinableTaskFactory can see into the AsyncLocal.Value @@ -2235,7 +2235,7 @@ public void BeginAsyncWithResultOnMTAKicksOffOtherAsyncPumpWorkCanCompleteSynchr }).Result; Assert.False(joinable.Task.IsCompleted); - var result = joinable.Join(); + int result = joinable.Join(); Assert.Equal(5, result); Assert.True(taskFinished); Assert.True(joinable.Task.IsCompleted); @@ -2631,7 +2631,7 @@ public void JoinWorkStealingRetainsThreadAffinityUI() public void JoinWorkStealingRetainsThreadAffinityBackground() { bool synchronousCompletionStarting = false; - var asyncTask = Task.Run(delegate + Task asyncTask = Task.Run(delegate { return this.asyncPump.RunAsync(async delegate { @@ -4006,7 +4006,7 @@ public void JoinableTaskOfT_TaskPropertyBeforeReturning() public void IsCompletedTrueDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.CompletedTask); @@ -4038,7 +4038,7 @@ public void IsCompletedTrueDoesNotLock() public void JoinCompletedDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.CompletedTask); @@ -4070,7 +4070,7 @@ public void JoinCompletedDoesNotLock() public void JoinAsyncCompletedDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.CompletedTask); @@ -4106,7 +4106,7 @@ public void JoinAsyncCompletedDoesNotLock() public void GetAwaiterCompletedDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.CompletedTask); @@ -4140,7 +4140,7 @@ public void GetAwaiterCompletedDoesNotLock() public void JoinCompletedTDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.FromResult(0)); @@ -4172,7 +4172,7 @@ public void JoinCompletedTDoesNotLock() public void JoinAsyncCompletedTDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.FromResult(0)); @@ -4210,7 +4210,7 @@ public void JoinAsyncCompletedTDoesNotLock() public void GetAwaiterCompletedTDoesNotLock() { using var context = new JoinableTaskContext(); - var syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; + object syncContextLock = typeof(JoinableTaskContext).GetProperty("SyncContextLock", BindingFlags.NonPublic | BindingFlags.Instance)!.GetValue(context)!; Assert.NotNull(syncContextLock); JoinableTask joinableTask = context.Factory.RunAsync(() => Task.FromResult(0)); @@ -4520,7 +4520,7 @@ private WeakReference JoinableTaskReleasedBySyncContextAfterCompletion_Helper(ou private void RunFuncOfTaskHelper() { - var initialThread = Environment.CurrentManagedThreadId; + int initialThread = Environment.CurrentManagedThreadId; this.asyncPump.Run(async delegate { Assert.Equal(initialThread, Environment.CurrentManagedThreadId); @@ -4531,7 +4531,7 @@ private void RunFuncOfTaskHelper() private void RunFuncOfTaskOfTHelper() { - var initialThread = Environment.CurrentManagedThreadId; + int initialThread = Environment.CurrentManagedThreadId; var expectedResult = new GenericParameterHelper(); GenericParameterHelper actualResult = this.asyncPump.Run(async delegate { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs index a5cb3e283..f2dd306fc 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs @@ -162,7 +162,7 @@ public void DoesNotDeadlockWhenCallbackCapturesSyncContext(bool captureMainThrea } else { - var progressTask = Task.Run(progressFactory); + Task> progressTask = Task.Run(progressFactory); progressTask.WaitWithoutInlining(); progress = progressTask.Result; } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs index 29e702b70..7cd17668d 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs @@ -127,7 +127,7 @@ public void Post_DoesNotExecuteSynchronously() [Fact] public void Post_PushFrame() { - var originalThreadId = Environment.CurrentManagedThreadId; + int originalThreadId = Environment.CurrentManagedThreadId; var syncContext = new SingleThreadedSynchronizationContext(); var frame = new SingleThreadedSynchronizationContext.Frame(); @@ -164,7 +164,7 @@ public void Post_PushFrame() [Fact] public void Post_PushFrame_Throws() { - var originalThreadId = Environment.CurrentManagedThreadId; + int originalThreadId = Environment.CurrentManagedThreadId; var syncContext = new SingleThreadedSynchronizationContext(); var frame = new SingleThreadedSynchronizationContext.Frame(); @@ -184,7 +184,7 @@ public void Post_CapturesExecutionContext() { try { - var expectedValue = new object(); + object expectedValue = new object(); var actualValue = new TaskCompletionSource(); var asyncLocal = new AsyncLocal(); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs index c21a6d286..aa241bd84 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs @@ -534,7 +534,7 @@ public async Task NoThrowAwaitable_ValueTask_UnsafeOnCompleted_DoesNotCaptureExe public async Task NoThrowAwaitable_ValueTaskT_Succeeds() { var barrier = new TaskCompletionSource(); - var result = new object(); + object result = new object(); var tcs = new TaskCompletionSource(); var test = Task.Run(async () => { @@ -885,7 +885,7 @@ public void FollowCancelableTaskToCompletionEndsInFault() [Fact] public async Task ToApmOfTWithNoTaskState() { - var state = new object(); + object state = new object(); var tcs = new TaskCompletionSource(); IAsyncResult? beginResult = null; @@ -912,7 +912,7 @@ public async Task ToApmOfTWithNoTaskState() [Fact] public async Task ToApmOfTWithMatchingTaskState() { - var state = new object(); + object state = new object(); var tcs = new TaskCompletionSource(state); IAsyncResult? beginResult = null; @@ -939,7 +939,7 @@ public async Task ToApmOfTWithMatchingTaskState() [Fact] public async Task ToApmWithNoTaskState() { - var state = new object(); + object state = new object(); var tcs = new TaskCompletionSource(); IAsyncResult? beginResult = null; @@ -966,7 +966,7 @@ public async Task ToApmWithNoTaskState() [Fact] public async Task ToApmWithMatchingTaskState() { - var state = new object(); + object state = new object(); var tcs = new TaskCompletionSource(state); IAsyncResult? beginResult = null; From 90c108ddcf175c0999f15a225b894692c3826834 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 14 Mar 2025 11:00:30 -0600 Subject: [PATCH 1302/1753] Switch from `build` to `buildTransitive` for analyzer package This should increase the odds of the AdditionalFiles getting everywhere they need to be. --- .../Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj | 2 +- .../vs-threading.LegacyThreadSwitchingMembers.txt | 0 .../AdditionalFiles/vs-threading.MainThreadAssertingMethods.txt | 0 .../AdditionalFiles/vs-threading.MainThreadSwitchingMethods.txt | 0 .../AdditionalFiles/vs-threading.MembersRequiringMainThread.txt | 0 .../Microsoft.VisualStudio.Threading.Analyzers.targets | 0 .../Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj | 2 +- 7 files changed, 2 insertions(+), 2 deletions(-) rename src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/{build => buildTransitive}/AdditionalFiles/vs-threading.LegacyThreadSwitchingMembers.txt (100%) rename src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/{build => buildTransitive}/AdditionalFiles/vs-threading.MainThreadAssertingMethods.txt (100%) rename src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/{build => buildTransitive}/AdditionalFiles/vs-threading.MainThreadSwitchingMethods.txt (100%) rename src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/{build => buildTransitive}/AdditionalFiles/vs-threading.MembersRequiringMainThread.txt (100%) rename src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/{build => buildTransitive}/Microsoft.VisualStudio.Threading.Analyzers.targets (100%) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj index 38ec50815..fd269bbb4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj @@ -20,7 +20,7 @@ - + diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.LegacyThreadSwitchingMembers.txt b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.LegacyThreadSwitchingMembers.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.LegacyThreadSwitchingMembers.txt rename to src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.LegacyThreadSwitchingMembers.txt diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.MainThreadAssertingMethods.txt b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.MainThreadAssertingMethods.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.MainThreadAssertingMethods.txt rename to src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.MainThreadAssertingMethods.txt diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.MainThreadSwitchingMethods.txt b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.MainThreadSwitchingMethods.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.MainThreadSwitchingMethods.txt rename to src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.MainThreadSwitchingMethods.txt diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.MembersRequiringMainThread.txt b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.MembersRequiringMainThread.txt similarity index 100% rename from src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/AdditionalFiles/vs-threading.MembersRequiringMainThread.txt rename to src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/AdditionalFiles/vs-threading.MembersRequiringMainThread.txt diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/Microsoft.VisualStudio.Threading.Analyzers.targets b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/Microsoft.VisualStudio.Threading.Analyzers.targets similarity index 100% rename from src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/build/Microsoft.VisualStudio.Threading.Analyzers.targets rename to src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/buildTransitive/Microsoft.VisualStudio.Threading.Analyzers.targets diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 8174b4bc5..c77215d0f 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -34,7 +34,7 @@ - AdditionalFiles.%(FileName)%(Extension) From 0be4393752936f7c97760ee5d6a4fa3b27c06ea6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Mar 2025 10:23:47 -0600 Subject: [PATCH 1303/1753] Build stable 17.14 version --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index 67a5f1419..ccba5e2d3 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.14-alpha", + "version": "17.14", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From f43702bd2bee2e7faad5585ee4a53d42f243bd1d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 17 Mar 2025 16:35:54 +0000 Subject: [PATCH 1304/1753] Update dependency Microsoft.Diagnostics.Runtime to 3.1.512801 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 56cda4578..be93c1429 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 3.11.0 4.12.0 1.1.2 - 3.0.442202 + 3.1.512801 3.11.0-beta1.24527.2 From a329741f70abefef36937c14e52168a436f28f16 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Mar 2025 10:48:58 -0600 Subject: [PATCH 1305/1753] Prevent updating .NET packages beyond LTS versions --- .github/renovate.json | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/renovate.json b/.github/renovate.json index c3af59616..76fb3a524 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -3,6 +3,7 @@ "extends": [ "github>microsoft/vs-renovate-presets:microbuild", "github>microsoft/vs-renovate-presets:vs_main_dependencies", + "github>microsoft/vs-renovate-presets:dotnet_packages_LTS", "github>microsoft/vs-renovate-presets:xunitv2" ], "packageRules": [ From 32d3f700ad0af1371b6b7253d80b6b925d1fb859 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Mar 2025 10:56:51 -0600 Subject: [PATCH 1306/1753] Fix package downgrade warning --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 41dbbc141..6aea5e35a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -15,7 +15,7 @@ - + From 9cfe5b83d9d184532bb46650dd1ea4adb477fa89 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Mar 2025 11:03:03 -0600 Subject: [PATCH 1307/1753] Fix package restore failure and remove use of obsolete API --- Directory.Packages.props | 5 ++--- src/SosThreadingTools/DumpAsyncCommand.cs | 11 ++++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index be93c1429..9034866a8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,6 @@ 3.11.0 4.12.0 1.1.2 - 3.1.512801 3.11.0-beta1.24527.2 @@ -24,8 +23,8 @@ - - + + diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index dcc005c56..de3686f8d 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -35,7 +35,7 @@ public void Execute(string args) ChainStateMachinesBasedOnTaskContinuations(knownStateMachines); ChainStateMachinesBasedOnJointableTasks(allStateMachines); - this.MarkThreadingBlockTasks(allStateMachines); + this.MarkThreadingBlockTasks(heap, allStateMachines); MarkUIThreadDependingTasks(allStateMachines); FixBrokenDependencies(allStateMachines); @@ -348,7 +348,7 @@ private static void FixBrokenDependencies(List allStateMachin } } - private void MarkThreadingBlockTasks(List allStateMachines) + private void MarkThreadingBlockTasks(ClrHeap heap, List allStateMachines) { foreach (ClrRuntime runtime in this.Runtimes) { @@ -365,12 +365,13 @@ private void MarkThreadingBlockTasks(List allStateMachines) foreach (ClrStackRoot stackRoot in thread.EnumerateStackRoots()) { ClrObject stackObject = stackRoot.Object; - if (string.Equals(stackObject.Type?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || - string.Equals(stackObject.Type?.BaseType?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal)) + if (stackObject.Type is not null && + (string.Equals(stackObject.Type.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal) || + string.Equals(stackObject.Type.BaseType?.Name, "Microsoft.VisualStudio.Threading.JoinableTask", StringComparison.Ordinal))) { if (visitedObjects.Add(stackObject.Address)) { - var joinableTaskObject = new ClrObject(stackObject.Address, stackObject.Type); + ClrObject joinableTaskObject = heap.GetObject(stackObject.Address, stackObject.Type); int state = joinableTaskObject.ReadField("state"); if ((state & 0x10) == 0x10) { From 52c0ee55e9b13040e9466c782ac8423b08bb8180 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 17 Mar 2025 18:05:15 +0000 Subject: [PATCH 1308/1753] Update dependency Microsoft.Bcl.AsyncInterfaces to v9 (#1438) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 27492e99a..214771a83 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + From 24a6e2bd2268958e129e3e98f77d39dbe2ad73d7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 19 Mar 2025 15:33:09 -0600 Subject: [PATCH 1309/1753] Build renovate settings on the best-practices preset (#357) --- .github/renovate.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/renovate.json b/.github/renovate.json index 9582ad998..c8b723c8c 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1,6 +1,6 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": ["config:recommended"], + "extends": ["config:best-practices"], "labels": ["dependencies"], "packageRules": [ { From 408618f71d35359f62986a0cfc5fd603f18ecb62 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 15:33:48 -0600 Subject: [PATCH 1310/1753] Update Dockerfile and global.json updates to v9.0.202 (#356) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 8f9e2d8b6..e605cd687 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.201-noble +FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 95c3e3074..d0e434438 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.201", + "version": "9.0.202", "rollForward": "patch", "allowPrerelease": false } From b8573cfd44403da853ddb2a1bec3c917368f787d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 21:42:32 +0000 Subject: [PATCH 1311/1753] Pin dependencies (#358) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/actions/publish-artifacts/action.yaml | 14 +++++++------- .github/workflows/build.yml | 6 +++--- .github/workflows/docs.yml | 6 +++--- .github/workflows/libtemplate-update.yml | 2 +- .github/workflows/release.yml | 2 +- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 2a75c4d22..1f345fe6f 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -14,46 +14,46 @@ runs: - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index da3e9e1f1..d4ee90e5e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,7 +29,7 @@ jobs: - windows-2022 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -74,8 +74,8 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.21.0 + uses: becheran/mlc@c925f90a9a25e16e4c4bfa29058f6f9ffa9f0d8c # v0.21.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 70b779b57..0a8f8215d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,7 +25,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -35,10 +35,10 @@ jobs: name: 📚 Generate documentation - name: Upload artifact - uses: actions/upload-pages-artifact@v3 + uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3 with: path: docfx/_site - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v4 + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4 diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 53df80ffa..7d0a67a0b 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c6a5edd8a..dccc87af7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -65,7 +65,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@v4 + uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From 45692247456d307128609f7a55d2b53e101a33a8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 21:43:08 +0000 Subject: [PATCH 1312/1753] Pin mcr.microsoft.com/dotnet/sdk Docker tag to 332e036 (#359) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index e605cd687..eaaf8fe16 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble +FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble@sha256:332e0362dd210a10348d436a5fb7f87aeec28c2c53ac2c3c2659e57c22294d0e # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 3e117539aaed4c30f3a52e7662bf70fd20d31492 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 02:31:04 +0000 Subject: [PATCH 1313/1753] Merge pull request #1419 from microsoft/renovate/visual-studio-sdk Update Visual Studio SDK to 17.13.40008 --- Directory.Packages.props | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 214771a83..2f9ce1eb6 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -25,9 +25,9 @@ - - - + + + From 95d58be864ede20a03ef7906aa0d48bbd012c509 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 02:53:16 +0000 Subject: [PATCH 1314/1753] Update CodeAnalysisAnalyzerVersion (#1392) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2f9ce1eb6..c477deb5a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 3.11.0 4.13.0 1.1.2 - 3.11.0-beta1.24527.2 + 3.11.0-beta1.25076.3 From 32fa18726e2bb2d52fb7890234a6981cfc3318d2 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 24 Mar 2025 15:56:19 -0700 Subject: [PATCH 1315/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.202-noble Docker digest to dcc11e3 (#360) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index eaaf8fe16..54acf522f 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble@sha256:332e0362dd210a10348d436a5fb7f87aeec28c2c53ac2c3c2659e57c22294d0e +FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble@sha256:dcc11e3a07f72d463077b401275d09fbad72b68cdc7a2029c2b51f21812bd8f6 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 9e7e0ed9847ac1b779c26601942342b8a54e4c2a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 25 Mar 2025 15:54:24 -0700 Subject: [PATCH 1316/1753] Fix `CancellationToken.Combine` with 3+ cancelable tokens --- .../CancellationTokenExtensions.cs | 5 ++++ .../CancellationTokenExtensionsTests.cs | 25 +++++++++++-------- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs index e63d09437..af6649e29 100644 --- a/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/CancellationTokenExtensions.cs @@ -115,6 +115,11 @@ public static CombinedCancellationToken CombineWith(this CancellationToken origi // Before this point we've checked every condition that would allow us to avoid it. var cancelableTokens = new CancellationToken[cancelableTokensCount]; int i = 0; + if (original.CanBeCanceled) + { + cancelableTokens[i++] = original; + } + foreach (CancellationToken other in others) { if (other.CanBeCanceled) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs index 9fb91ba53..5a957f05b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs @@ -2,6 +2,7 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; +using System.Linq; using System.Threading; using Microsoft.VisualStudio.Threading; using Xunit; @@ -226,19 +227,23 @@ public void CombineWith_Array_TwoCancelable_AmidMany(bool cancelFirst) } } - [Fact] - public void CombineWith_Array_ThreeCancelable_AmidMany() + [Theory, CombinatorialData] + public void CombineWith_Array_ThreeCancelable_AmidMany([CombinatorialRange(0, 3)] int canceledIndex) { - var cts1 = new CancellationTokenSource(); - var cts2 = new CancellationTokenSource(); - var cts3 = new CancellationTokenSource(); - using (CancellationTokenExtensions.CombinedCancellationToken combined = CancellationToken.None.CombineWith(cts1.Token, CancellationToken.None, cts2.Token, CancellationToken.None, cts3.Token)) + CancellationTokenSource[] cts = new CancellationTokenSource[3]; + for (int i = 0; i < 3; i++) { - Assert.NotEqual(cts1.Token, combined.Token); - Assert.NotEqual(cts2.Token, combined.Token); - Assert.NotEqual(cts3.Token, combined.Token); + cts[i] = new(); + } - cts2.Cancel(); + using (CancellationTokenExtensions.CombinedCancellationToken combined = cts[0].Token.CombineWith(cts.Skip(1).Select(s => s.Token).ToArray())) + { + for (int i = 0; i < cts.Length; i++) + { + Assert.NotEqual(cts[i].Token, combined.Token); + } + + cts[canceledIndex].Cancel(); Assert.True(combined.Token.IsCancellationRequested); } } From c6c1f8b4bc5c5ad5e311809d971fbeef1ee3d530 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Thu, 27 Mar 2025 13:49:25 -0700 Subject: [PATCH 1317/1753] Opt in to the new MicroBuild SBOM behavior --- Directory.Build.props | 2 ++ Directory.Build.targets | 2 -- azure-pipelines/NuGetSbom.props | 6 ++++++ azure-pipelines/NuGetSbom.targets | 12 ------------ 4 files changed, 8 insertions(+), 14 deletions(-) create mode 100644 azure-pipelines/NuGetSbom.props delete mode 100644 azure-pipelines/NuGetSbom.targets diff --git a/Directory.Build.props b/Directory.Build.props index da14541b0..f3045068f 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -56,4 +56,6 @@ $(RepositoryUrl)/releases/tag/v$(Version) + + diff --git a/Directory.Build.targets b/Directory.Build.targets index 27b0fad1c..ffbdb5021 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -8,6 +8,4 @@ - - diff --git a/azure-pipelines/NuGetSbom.props b/azure-pipelines/NuGetSbom.props new file mode 100644 index 000000000..dbfee864b --- /dev/null +++ b/azure-pipelines/NuGetSbom.props @@ -0,0 +1,6 @@ + + + true + 2 + + diff --git a/azure-pipelines/NuGetSbom.targets b/azure-pipelines/NuGetSbom.targets deleted file mode 100644 index a2599e882..000000000 --- a/azure-pipelines/NuGetSbom.targets +++ /dev/null @@ -1,12 +0,0 @@ - - - true - $(TargetsForTfmSpecificBuildOutput);IncludeSbomInNupkg - - - - - - - - From bc06523042578fb13deade2afe84f4de62cc2f1b Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:07:08 -0700 Subject: [PATCH 1318/1753] Fix unofficial build with SDL tools enabled --- azure-pipelines/build.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 72d3a27d5..591d70abd 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -289,6 +289,12 @@ jobs: condition: succeededOrFailed() ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: + ${{ if not(parameters.RealSign) }}: + mb: + signing: # if the build is test-signed, install the signing plugin so that CSVTestSignPolicy.xml is available + enabled: true + zipSources: false + signType: test outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - output: pipelineArtifact From a6094b6fea9846b21867b5c18f1c2c798caa0e24 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 28 Mar 2025 13:16:27 -0700 Subject: [PATCH 1319/1753] Drop CPS-specific threading guidance (#1445) This guidance is long outdated. --- docfx/docs/cookbook_vs.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docfx/docs/cookbook_vs.md b/docfx/docs/cookbook_vs.md index 778c795bb..c81183d50 100644 --- a/docfx/docs/cookbook_vs.md +++ b/docfx/docs/cookbook_vs.md @@ -1,11 +1,6 @@ Cookbook for Visual Studio ========================== -Important for CPS extension authors and clients: please -replace all references to `ThreadHelper.JoinableTaskFactory` with -`this.ThreadHandling.AsyncPump`, where `this.ThreadHandling` is an `[Import] -IThreadHandling`. - ## Initial setup - Add a reference to [Microsoft.VisualStudio.Threading][NuPkg]. From 268a3af1869dd5d2e3b72735bc4b8e8e823ea66f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 5 Apr 2025 21:39:00 -0600 Subject: [PATCH 1320/1753] Update dependency xunit.v3 to v2 (#353) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 03d41a123..74b396154 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ - + From d4ce11e2ad77485e2206568ea7d7c20dc978f693 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 9 Apr 2025 14:27:01 -0600 Subject: [PATCH 1321/1753] Update Dockerfile and global.json updates to v9.0.203 (#364) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 54acf522f..85d91565d 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble@sha256:dcc11e3a07f72d463077b401275d09fbad72b68cdc7a2029c2b51f21812bd8f6 +FROM mcr.microsoft.com/dotnet/sdk:9.0.203-noble@sha256:2c9a4956a61fc45d9111fb36ec9fb86932e4842af9eb9bc9306bf8757f53674d # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index d0e434438..4fe2bf77a 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.202", + "version": "9.0.203", "rollForward": "patch", "allowPrerelease": false } From 2fb29d7465d37ecc7092fae84b7e615f80ab5b83 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 15 Apr 2025 19:54:33 -0600 Subject: [PATCH 1322/1753] Update docs to use MergeFrom-Template.ps1 --- CONTRIBUTING.md | 14 ++++++++++++++ README.md | 11 ++++++----- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56dd666f8..4281f299e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,3 +82,17 @@ Configuration is in the `.github/renovate.json` file. When changing the renovate.json file, follow [these validation steps](https://docs.renovatebot.com/config-validation/). If Renovate is not creating pull requests when you expect it to, check that the [Renovate GitHub App](https://github.com/apps/renovate) is configured for your account or repo. + +## Merging latest from Library.Template + +### Maintaining your repo based on this template + +The best way to keep your repo in sync with Library.Template's evolving features and best practices is to periodically merge the template into your repo: +` +```ps1 +git fetch +git checkout origin/main +.\tools\MergeFrom-Template.ps1 +# resolve any conflicts, then commit the merge commit. +git push origin -u HEAD +``` diff --git a/README.md b/README.md index 610e65049..f78bfdb38 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,13 @@ Further customize your repo by: ### Maintaining your repo based on this template The best way to keep your repo in sync with this template's evolving features and best practices is to periodically merge the template into your repo: - +` ```ps1 -git checkout main # your default branch -git pull # make sure you're at tip -git fetch libtemplate # fetch latest Library.Template -git merge libtemplate/main +git fetch +git checkout origin/main +.\tools\MergeFrom-Template.ps1 +# resolve any conflicts, then commit the merge commit. +git push origin -u HEAD ``` There will frequently be merge conflicts to work out, but they will be easier to resolve than running the `Apply-Template.ps1` script every time, which simply blows away all your local changes with the latest from the template. From 7d17e8b8d40f5922af6f04a043f677c434b09e62 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Sat, 19 Apr 2025 12:29:47 -0700 Subject: [PATCH 1323/1753] For customized SynchronizationContext implementation, knowing whether a pending request has been completed could allow it to remove completed requests. Because JTF requests are potentially sent to multiple queues, including the JTF internal queue, many of those requests can be processed especially inside low priority or delayed queues. For low priority queue, completed tasks showing up for high memory usages. This new contract provides a way to make improvements. This is only for advanced scenarios, common JTF consumers would not access the request or have chance to use it incorrectly. --- .../IPendingExecutionRequestState.cs | 16 ++++++++++++++++ .../JoinableTaskFactory.cs | 7 ++++++- .../net472/PublicAPI.Unshipped.txt | 2 ++ .../net8.0-windows/PublicAPI.Unshipped.txt | 2 ++ .../net8.0/PublicAPI.Unshipped.txt | 2 ++ .../netstandard2.0/PublicAPI.Unshipped.txt | 2 ++ 6 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs diff --git a/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs b/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs new file mode 100644 index 000000000..7a745cb53 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs @@ -0,0 +1,16 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading +{ + /// + /// An optional interface implemented by pending request state posted to the underline synchronization context. It allows synchronization context to remove completed requests. + /// + public interface IPendingExecutionRequestState + { + /// + /// Gets a value indicating whether the current request has been completed, and can be skipped. + /// + bool IsCompleted { get; } + } +} diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 018f4c4bc..e32d3dd72 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -1058,7 +1058,7 @@ public void Dispose() /// A delegate wrapper that ensures the delegate is only invoked at most once. /// [DebuggerDisplay("{DelegateLabel}")] - internal class SingleExecuteProtector + internal class SingleExecuteProtector : IPendingExecutionRequestState { /// /// Executes the delegate if it has not already executed. @@ -1112,6 +1112,11 @@ private SingleExecuteProtector(JoinableTask job) this.job = job; } + /// + /// Gets a value indicating whether the current request has been completed, and can be skipped. + /// + bool IPendingExecutionRequestState.IsCompleted => this.HasBeenExecuted; + /// /// Gets a value indicating whether this instance has already executed. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 0e00ec898..82ffde8aa 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,2 +1,4 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt index 0e00ec898..82ffde8aa 100644 --- a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt @@ -1,2 +1,4 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt index 0e00ec898..82ffde8aa 100644 --- a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt @@ -1,2 +1,4 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 0e00ec898..82ffde8aa 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,2 +1,4 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState +Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file From 23cd85a9b1f744767a2b0b7aa674165e7fc272b4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 22 Apr 2025 14:06:33 -0600 Subject: [PATCH 1324/1753] Fix lang service reporting C# 7.3 errors in Error List By setting LangVersion so late in msbuild evaluation, the `CommandLineArgsForDesignTimeEvaluation` property is set based on the default value (of 7.3, for .NET Framework projects). This causes the VS language service to initialize with the wrong language version. I originally moved this property definition to the .targets because `$(Language)` isn't set in time for the .props files to use them. But we can move it back to .props by using the project file extension instead. --- Directory.Build.props | 5 +++++ Directory.Build.targets | 4 ---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index 98b987f68..e862541e5 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -40,6 +40,11 @@ snupkg + + 13 + 16.9 + + diff --git a/Directory.Build.targets b/Directory.Build.targets index ffbdb5021..b4afce0a7 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -1,9 +1,5 @@ - - 13 - 16.9 - From 37f9be019fd92a22b2c563c7ed5a242e656ca6aa Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 22 Apr 2025 14:35:26 -0700 Subject: [PATCH 1325/1753] Mark new contract an experimental feature. --- .../IPendingExecutionRequestState.cs | 5 +++++ src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs | 2 ++ 2 files changed, 7 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs b/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs index 7a745cb53..9d73c4e8c 100644 --- a/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs +++ b/src/Microsoft.VisualStudio.Threading/IPendingExecutionRequestState.cs @@ -1,11 +1,16 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System.ComponentModel; +using System.Diagnostics.CodeAnalysis; + namespace Microsoft.VisualStudio.Threading { /// /// An optional interface implemented by pending request state posted to the underline synchronization context. It allows synchronization context to remove completed requests. /// + [EditorBrowsable(EditorBrowsableState.Never)] + [Experimental("VSOnly")] public interface IPendingExecutionRequestState { /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index e32d3dd72..8395363b9 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -1058,7 +1058,9 @@ public void Dispose() /// A delegate wrapper that ensures the delegate is only invoked at most once. /// [DebuggerDisplay("{DelegateLabel}")] +#pragma warning disable VSOnly // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed. internal class SingleExecuteProtector : IPendingExecutionRequestState +#pragma warning restore VSOnly // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed. { /// /// Executes the delegate if it has not already executed. From 095ddc22bfb4786830a7ef6432ad83ae761f0eb7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 22 Apr 2025 16:22:36 -0600 Subject: [PATCH 1326/1753] Remove remnants of a workaround --- azure-pipelines/build.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 591d70abd..3fedaf8f1 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -200,8 +200,6 @@ jobs: - ${{ if and(parameters.EnableDotNetFormatCheck, not(parameters.EnableLinuxBuild)) }}: - script: dotnet format --verify-no-changes --no-restore displayName: 💅 Verify formatted code - env: - dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml @@ -244,8 +242,6 @@ jobs: - ${{ if parameters.EnableDotNetFormatCheck }}: - script: dotnet format --verify-no-changes --no-restore displayName: 💅 Verify formatted code - env: - dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - template: expand-template.yml - ${{ if parameters.EnableMacOSBuild }}: From 24fb90c797c70cea31fea3f1abce87bc9fc897fb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 22 Apr 2025 16:44:26 -0600 Subject: [PATCH 1327/1753] Share more variable definitions --- azure-pipelines/vs-validation.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 1b415b221..3a40395e7 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -32,10 +32,9 @@ extends: stages: - stage: Build variables: - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true - NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ - BuildConfiguration: Release - SkipCodesignVerify: true + - template: /azure-pipelines/BuildStageVariables.yml@self + - name: SkipCodesignVerify + value: true jobs: - template: /azure-pipelines/build.yml@self From a84dfb3a7b4e6037b007a0be881f71abb310b7c9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 22 Apr 2025 16:52:45 -0600 Subject: [PATCH 1328/1753] Avoid CodeQL steps during release --- azure-pipelines/prepare-insertion-stages.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 46033d674..cfe287433 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -18,6 +18,8 @@ stages: - job: symbol_archive displayName: Archive symbols pool: VSEngSS-MicroBuild2022-1ES + variables: + ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build stages, we don't need it here steps: - checkout: none - download: current @@ -61,6 +63,8 @@ stages: ${{ else }}: nuGetFeedType: internal publishVstsFeed: vs-impl # Leave this as-is, since non-signed builds must not be pushed to public feeds. + variables: + ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build stages, we don't need it here steps: - checkout: none - download: current From 5e856e20df0f198a6f3c7d109532d51ee27204ab Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 14:56:55 -0600 Subject: [PATCH 1329/1753] Drop stale comment --- azure-pipelines/microbuild.after.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index e21074331..025de4f5f 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -9,7 +9,7 @@ parameters: type: boolean steps: -- ${{ if not(parameters.SkipCodesignVerify) }}: # skip CodesignVerify on validation builds because we don't even test-sign nupkg's. +- ${{ if not(parameters.SkipCodesignVerify) }}: - task: MicroBuildCodesignVerify@3 displayName: 🔍 Verify Signed Files inputs: From 9d5143a3abf0204ed81ee55a457d0d830cb2de08 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 17:10:46 -0600 Subject: [PATCH 1330/1753] Insert into the `rel/d17.14` branch --- tools/variables/InsertTargetBranch.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/variables/InsertTargetBranch.ps1 b/tools/variables/InsertTargetBranch.ps1 index cdcc91943..d0a8e85d7 100644 --- a/tools/variables/InsertTargetBranch.ps1 +++ b/tools/variables/InsertTargetBranch.ps1 @@ -1,2 +1,2 @@ # This is the default branch of the VS repo that we will use to insert into VS. -'main' +'rel/d17.14' From 48b5ed0a5501a25791c9134c5acc5bf0dda0c42a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 17:11:12 -0600 Subject: [PATCH 1331/1753] Build 17.15-alpha --- version.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.json b/version.json index ccba5e2d3..f96d8ed07 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.14", + "version": "17.15-alpha", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +8,4 @@ "cloudBuild": { "setVersionVariables": false } -} \ No newline at end of file +} From 7c7b49baba880743a8f18b6b3ab985b338d90b0b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 17:13:55 -0600 Subject: [PATCH 1332/1753] Bump version height of 17.14 This is necessary because we built some 17.14 versions and then rewinded the branch. --- version.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/version.json b/version.json index ccba5e2d3..1f674a6ed 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,7 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", "version": "17.14", + "buildNumberOffset": 3, "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" @@ -8,4 +9,4 @@ "cloudBuild": { "setVersionVariables": false } -} \ No newline at end of file +} From fc999605d227dddab2ac19fe71e3deaa98eab821 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 23 Apr 2025 23:26:17 +0000 Subject: [PATCH 1333/1753] Pin dependencies (#1440) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/actions/publish-artifacts/action.yaml | 14 +++++++------- .github/workflows/docs.yml | 6 +++--- .github/workflows/docs_validate.yml | 4 ++-- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 2a75c4d22..1f345fe6f 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -14,46 +14,46 @@ runs: - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 70b779b57..0a8f8215d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,7 +25,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -35,10 +35,10 @@ jobs: name: 📚 Generate documentation - name: Upload artifact - uses: actions/upload-pages-artifact@v3 + uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3 with: path: docfx/_site - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v4 + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4 diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 96204b6df..456319c31 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,11 +13,11 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.21.0 + uses: becheran/mlc@c925f90a9a25e16e4c4bfa29058f6f9ffa9f0d8c # v0.21.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/*,https://badges.gitter.im/*,https://github.com/*,https://app.gitter.im/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc*,https://microsoft.sharepoint.com/* - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 53df80ffa..7d0a67a0b 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 2714b09c93e5487b3adbde44abe2f0deb855b68e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 18:03:27 -0600 Subject: [PATCH 1334/1753] Reapply "Avoid `dotnet format` hang" This reverts commit 46e768b364bbff90441fb5c0c9bfb160f4bfc67d. Because https://github.com/dotnet/sdk/issues/44951 is repro'ing again even on the latest .NET SDK. --- Directory.Packages.props | 5 +++-- azure-pipelines/build.yml | 4 +++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 74b396154..d7bce7ef3 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -19,8 +19,9 @@ - + + - + \ No newline at end of file diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 108258282..5c106ade4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -37,8 +37,10 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} - - script: dotnet format --verify-no-changes --no-restore + - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code + env: + dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - template: expand-template.yml - job: macOS From a4fb4a4b01fc0877e7f3449efb4ba57862fc662e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 18:49:53 -0600 Subject: [PATCH 1335/1753] Another CodeQL skip --- azure-pipelines/build.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index f1c619282..ff3bef406 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -287,6 +287,8 @@ jobs: - macOS pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). condition: succeededOrFailed() + variables: + ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build jobs, we don't need it here ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: ${{ if not(parameters.RealSign) }}: From 23452136e5bd2066f6c9dfa0dcbc3e2e93e809af Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 24 Apr 2025 10:39:32 -0600 Subject: [PATCH 1336/1753] Revert "Opt in to the new MicroBuild SBOM behavior" (#365) --- Directory.Build.props | 2 -- Directory.Build.targets | 2 ++ azure-pipelines/NuGetSbom.props | 6 ------ azure-pipelines/NuGetSbom.targets | 12 ++++++++++++ 4 files changed, 14 insertions(+), 8 deletions(-) delete mode 100644 azure-pipelines/NuGetSbom.props create mode 100644 azure-pipelines/NuGetSbom.targets diff --git a/Directory.Build.props b/Directory.Build.props index 252702d7a..40da01cac 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -61,6 +61,4 @@ $(RepositoryUrl)/releases/tag/v$(Version) - - diff --git a/Directory.Build.targets b/Directory.Build.targets index b4afce0a7..5f8e2a6dd 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -4,4 +4,6 @@ + + diff --git a/azure-pipelines/NuGetSbom.props b/azure-pipelines/NuGetSbom.props deleted file mode 100644 index dbfee864b..000000000 --- a/azure-pipelines/NuGetSbom.props +++ /dev/null @@ -1,6 +0,0 @@ - - - true - 2 - - diff --git a/azure-pipelines/NuGetSbom.targets b/azure-pipelines/NuGetSbom.targets new file mode 100644 index 000000000..a2599e882 --- /dev/null +++ b/azure-pipelines/NuGetSbom.targets @@ -0,0 +1,12 @@ + + + true + $(TargetsForTfmSpecificBuildOutput);IncludeSbomInNupkg + + + + + + + + From 1a8cb7653b0732fd6aa351be882019f37f6a1dae Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 27 Apr 2025 18:50:55 -0600 Subject: [PATCH 1337/1753] Update actions/download-artifact digest to d3f86a1 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index dccc87af7..e37811d69 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -65,7 +65,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4 + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From 8dc98043fd2d7298b8f8120272571edb9b3e19e3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:19:42 -0600 Subject: [PATCH 1338/1753] Update dependency powershell to 7.5.1 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index c21d04bd0..0eae32501 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.5.0", + "version": "7.5.1", "commands": [ "pwsh" ], From 1ddad471fe3bb866f673dac78771c95be19d4951 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:24:01 -0600 Subject: [PATCH 1339/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.203-noble Docker digest to c849687 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 85d91565d..78b0398cb 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.203-noble@sha256:2c9a4956a61fc45d9111fb36ec9fb86932e4842af9eb9bc9306bf8757f53674d +FROM mcr.microsoft.com/dotnet/sdk:9.0.203-noble@sha256:c84968764a7d265a29cc840096750816d82655369d6ad03bcdf65f790684fd21 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 638e0fb64b759da41e3be29d64f26f87ac6627c5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 29 Apr 2025 14:14:37 -0600 Subject: [PATCH 1340/1753] Reapply "Opt in to the new MicroBuild SBOM behavior" This reapplies https://github.com/AArnott/Library.Template/commit/23452136e5bd2066f6c9dfa0dcbc3e2e93e809af. Reverts AArnott/Library.Template#365 --- Directory.Build.props | 2 ++ Directory.Build.targets | 2 -- azure-pipelines/NuGetSbom.props | 6 ++++++ azure-pipelines/NuGetSbom.targets | 12 ------------ 4 files changed, 8 insertions(+), 14 deletions(-) create mode 100644 azure-pipelines/NuGetSbom.props delete mode 100644 azure-pipelines/NuGetSbom.targets diff --git a/Directory.Build.props b/Directory.Build.props index 40da01cac..252702d7a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -61,4 +61,6 @@ $(RepositoryUrl)/releases/tag/v$(Version) + + diff --git a/Directory.Build.targets b/Directory.Build.targets index 5f8e2a6dd..b4afce0a7 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -4,6 +4,4 @@ - - diff --git a/azure-pipelines/NuGetSbom.props b/azure-pipelines/NuGetSbom.props new file mode 100644 index 000000000..dbfee864b --- /dev/null +++ b/azure-pipelines/NuGetSbom.props @@ -0,0 +1,6 @@ + + + true + 2 + + diff --git a/azure-pipelines/NuGetSbom.targets b/azure-pipelines/NuGetSbom.targets deleted file mode 100644 index a2599e882..000000000 --- a/azure-pipelines/NuGetSbom.targets +++ /dev/null @@ -1,12 +0,0 @@ - - - true - $(TargetsForTfmSpecificBuildOutput);IncludeSbomInNupkg - - - - - - - - From 567a5748c1d954d5365b13851c09c61a0ac958bb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 30 Apr 2025 11:18:19 -0600 Subject: [PATCH 1341/1753] Deploy SBOMs next to the VSIX they describe This should fix 404s on sbom's referenced from .vsman files. --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index 252702d7a..d63b9f109 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -7,6 +7,7 @@ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\NuGet\ $(RepoRootPath)bin\Packages\$(Configuration)\Vsix\$(Platform)\ + $(VSIXOutputPath) enable enable latest From 508b83948dc41dbab0baedd30d697464d4b84ee2 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 3 May 2025 19:40:58 -0700 Subject: [PATCH 1342/1753] Update xunit (#370) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 74b396154..87c53575d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,8 +10,8 @@ - - + + From 990d9b538f81ae72b5cb07a7ae1425dfe6787671 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 6 May 2025 08:31:35 -0600 Subject: [PATCH 1343/1753] Update SUPPORT.md with links to product support --- SUPPORT.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/SUPPORT.md b/SUPPORT.md index ecbe64c04..2f187f716 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -2,7 +2,7 @@ **REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project? -- **No CSS support:** Fill out this template with information about how to file issues and get help. +- **No CSS support:** Review the template below and edit as necessary. - **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). - **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide. @@ -12,14 +12,15 @@ ## How to file issues and get help -This project uses GitHub Issues to track bugs and feature requests. Please search the existing -issues before filing new issues to avoid duplicates. For new issues, file your bug or -feature request as a new Issue. +This project uses GitHub Issues to track bugs and feature requests. +Please search the existing issues before filing new issues to avoid duplicates. +For new issues, file your bug or feature request as a new Issue. -For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE -FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER -CHANNEL. WHERE WILL YOU HELP PEOPLE?**. +Note that this repo is primarily used for Visual Studio and related products and support will be focused on those scenarios. ## Microsoft Support Policy -Support for this **PROJECT or PRODUCT** is limited to the resources listed above. +Official Microsoft support for this software is offered through our shipping products such as Visual Studio. +Support and servicing is limited to the latest released version. +For more information, see [Visual Studio Product Lifecycle and Servicing](https://learn.microsoft.com/visualstudio/productinfo/vs-servicing). +Assisted support is available from a professional support engineer by opening a ticket with the [Microsoft assisted support team](https://support.serviceshub.microsoft.com/supportforbusiness/onboarding). From fd52657a6739e420b505afc23297159fe05a4faf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 6 May 2025 14:09:44 -0600 Subject: [PATCH 1344/1753] Refine SUPPORT.md wording --- SUPPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SUPPORT.md b/SUPPORT.md index 2f187f716..a324f3003 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -20,7 +20,7 @@ Note that this repo is primarily used for Visual Studio and related products and ## Microsoft Support Policy -Official Microsoft support for this software is offered through our shipping products such as Visual Studio. +Microsoft support for this software is available only for its use in officially supported products such as Visual Studio. Support and servicing is limited to the latest released version. For more information, see [Visual Studio Product Lifecycle and Servicing](https://learn.microsoft.com/visualstudio/productinfo/vs-servicing). Assisted support is available from a professional support engineer by opening a ticket with the [Microsoft assisted support team](https://support.serviceshub.microsoft.com/supportforbusiness/onboarding). From 8fe4f147ec39d3e1aedd985ba8213bc8de37e8f2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 6 May 2025 13:25:08 -0600 Subject: [PATCH 1345/1753] Add support for a repo to hard-code extra SDKs that must be installed --- tools/Install-DotNetSdk.ps1 | 57 ++++++++++++++++++++++--------------- 1 file changed, 34 insertions(+), 23 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index e08571bc7..402b4307c 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -36,7 +36,11 @@ if (!(Test-Path $DotNetInstallScriptRoot)) { New-Item -ItemType Directory -Path $DotNetInstallScriptRoot = Resolve-Path $DotNetInstallScriptRoot # Look up actual required .NET SDK version from global.json -$sdkVersion = & "$PSScriptRoot/variables/DotNetSdkVersion.ps1" +$sdks = @(New-Object PSObject -Property @{ Version = & "$PSScriptRoot/variables/DotNetSdkVersion.ps1" }) + +# Sometimes a repo requires extra SDKs to be installed (e.g. msbuild.locator scenarios running in tests). +# In such a circumstance, a precise SDK version or a channel can be added as in the example below: +# $sdks += New-Object PSObject -Property @{ Channel = '8.0' } If ($IncludeX86 -and ($IsMacOS -or $IsLinux)) { Write-Verbose "Ignoring -IncludeX86 switch because 32-bit runtimes are only supported on Windows." @@ -191,13 +195,16 @@ if ($InstallLocality -eq 'machine') { $DotNetInstallDir = '/usr/share/dotnet' } else { $restartRequired = $false - if ($PSCmdlet.ShouldProcess(".NET SDK $sdkVersion", "Install")) { - Install-DotNet -Version $sdkVersion -Architecture $arch - $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) - - if ($IncludeX86) { - Install-DotNet -Version $sdkVersion -Architecture x86 + $sdks |% { + if ($_.Version) { $version = $_.Version } else { $version = $_.Channel } + if ($PSCmdlet.ShouldProcess(".NET SDK $_", "Install")) { + Install-DotNet -Version $version -Architecture $arch $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + + if ($IncludeX86) { + Install-DotNet -Version $version -Architecture x86 + $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) + } } } @@ -296,29 +303,33 @@ $DotNetInstallScriptPathExpression = "& '$DotNetInstallScriptPathExpression'" $anythingInstalled = $false $global:LASTEXITCODE = 0 -if ($PSCmdlet.ShouldProcess(".NET SDK $sdkVersion", "Install")) { - $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture $arch -InstallDir $DotNetInstallDir $switches" +$sdks |% { + if ($_.Version) { $parameters = '-Version', $_.Version } else { $parameters = '-Channel', $_.Channel } - if ($LASTEXITCODE -ne 0) { - Write-Error ".NET SDK installation failure: $LASTEXITCODE" - exit $LASTEXITCODE - } -} else { - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture $arch -InstallDir $DotNetInstallDir $switches -DryRun" -} - -if ($IncludeX86) { - if ($PSCmdlet.ShouldProcess(".NET x86 SDK $sdkVersion", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET SDK $_", "Install")) { $anythingInstalled = $true - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture x86 -InstallDir $DotNetX86InstallDir $switches" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression $parameters -Architecture $arch -InstallDir $DotNetInstallDir $switches" if ($LASTEXITCODE -ne 0) { - Write-Error ".NET x86 SDK installation failure: $LASTEXITCODE" + Write-Error ".NET SDK installation failure: $LASTEXITCODE" exit $LASTEXITCODE } } else { - Invoke-Expression -Command "$DotNetInstallScriptPathExpression -Version $sdkVersion -Architecture x86 -InstallDir $DotNetX86InstallDir $switches -DryRun" + Invoke-Expression -Command "$DotNetInstallScriptPathExpression $parameters -Architecture $arch -InstallDir $DotNetInstallDir $switches -DryRun" + } + + if ($IncludeX86) { + if ($PSCmdlet.ShouldProcess(".NET x86 SDK $_", "Install")) { + $anythingInstalled = $true + Invoke-Expression -Command "$DotNetInstallScriptPathExpression $parameters -Architecture x86 -InstallDir $DotNetX86InstallDir $switches" + + if ($LASTEXITCODE -ne 0) { + Write-Error ".NET x86 SDK installation failure: $LASTEXITCODE" + exit $LASTEXITCODE + } + } else { + Invoke-Expression -Command "$DotNetInstallScriptPathExpression $parameters -Architecture x86 -InstallDir $DotNetX86InstallDir $switches -DryRun" + } } } From 3b421ec77eab3e6851fa9304c1cb07a8ab8e414e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 7 May 2025 14:51:22 -0600 Subject: [PATCH 1346/1753] Add script for collecting 3rd party symbol files --- tools/Get-3rdPartySymbolFiles.ps1 | 91 +++++++++++++++++++++++++++++++ tools/Get-SymbolFiles.ps1 | 6 +- 2 files changed, 96 insertions(+), 1 deletion(-) create mode 100644 tools/Get-3rdPartySymbolFiles.ps1 diff --git a/tools/Get-3rdPartySymbolFiles.ps1 b/tools/Get-3rdPartySymbolFiles.ps1 new file mode 100644 index 000000000..ef6bbef28 --- /dev/null +++ b/tools/Get-3rdPartySymbolFiles.ps1 @@ -0,0 +1,91 @@ +Function Get-FileFromWeb([Uri]$Uri, $OutFile) { + $OutDir = Split-Path $OutFile + if (!(Test-Path $OutFile)) { + Write-Verbose "Downloading $Uri..." + if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir | Out-Null } + try { + (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) + } + finally { + # This try/finally causes the script to abort + } + } +} + +Function Unzip($Path, $OutDir) { + $OutDir = (New-Item -ItemType Directory -Path $OutDir -Force).FullName + Add-Type -AssemblyName System.IO.Compression.FileSystem + + # Start by extracting to a temporary directory so that there are no file conflicts. + [System.IO.Compression.ZipFile]::ExtractToDirectory($Path, "$OutDir.out") + + # Now move all files from the temp directory to $OutDir, overwriting any files. + Get-ChildItem -Path "$OutDir.out" -Recurse -File | ForEach-Object { + $destinationPath = Join-Path -Path $OutDir -ChildPath $_.FullName.Substring("$OutDir.out".Length).TrimStart([io.path]::DirectorySeparatorChar, [io.path]::AltDirectorySeparatorChar) + if (!(Test-Path -Path (Split-Path -Path $destinationPath -Parent))) { + New-Item -ItemType Directory -Path (Split-Path -Path $destinationPath -Parent) | Out-Null + } + Move-Item -Path $_.FullName -Destination $destinationPath -Force + } + Remove-Item -Path "$OutDir.out" -Recurse -Force +} + +Function Get-SymbolsFromPackage($id, $version) { + $symbolPackagesPath = "$PSScriptRoot/../obj/SymbolsPackages" + New-Item -ItemType Directory -Path $symbolPackagesPath -Force | Out-Null + $nupkgPath = Join-Path $symbolPackagesPath "$id.$version.nupkg" + $snupkgPath = Join-Path $symbolPackagesPath "$id.$version.snupkg" + $unzippedPkgPath = Join-Path $symbolPackagesPath "$id.$version" + Get-FileFromWeb -Uri "https://www.nuget.org/api/v2/package/$id/$version" -OutFile $nupkgPath + Get-FileFromWeb -Uri "https://www.nuget.org/api/v2/symbolpackage/$id/$version" -OutFile $snupkgPath + + Unzip -Path $nupkgPath -OutDir $unzippedPkgPath + Unzip -Path $snupkgPath -OutDir $unzippedPkgPath + + Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Filter *.pdb | % { + # Collect the DLLs/EXEs as well. + $rootName = Join-Path $_.Directory $_.BaseName + if ($rootName.EndsWith('.ni')) { + $rootName = $rootName.Substring(0, $rootName.Length - 3) + } + + $dllPath = "$rootName.dll" + $exePath = "$rootName.exe" + if (Test-Path $dllPath) { + $BinaryImagePath = $dllPath + } + elseif (Test-Path $exePath) { + $BinaryImagePath = $exePath + } + else { + Write-Warning "`"$_`" found with no matching binary file." + $BinaryImagePath = $null + } + + if ($BinaryImagePath) { + Write-Output $BinaryImagePath + Write-Output $_.FullName + } + } +} + +Function Get-PackageVersion($id) { + $versionProps = [xml](Get-Content -LiteralPath $PSScriptRoot\..\Directory.Packages.props) + $version = $versionProps.Project.ItemGroup.PackageVersion | ? { $_.Include -eq $id } | % { $_.Version } + if (!$version) { + Write-Error "No package version found in Directory.Packages.props for the package '$id'" + } + + $version +} + +# All 3rd party packages for which symbols packages are expected should be listed here. +# These must all be sourced from nuget.org, as it is the only feed that supports symbol packages. +$3rdPartyPackageIds = @() + +$3rdPartyPackageIds | % { + $version = Get-PackageVersion $_ + if ($version) { + Get-SymbolsFromPackage -id $_ -version $version + } +} diff --git a/tools/Get-SymbolFiles.ps1 b/tools/Get-SymbolFiles.ps1 index b5063cec6..9464226a9 100644 --- a/tools/Get-SymbolFiles.ps1 +++ b/tools/Get-SymbolFiles.ps1 @@ -43,7 +43,7 @@ $PDBs |% { } } |% { # Collect the DLLs/EXEs as well. - $rootName = "$($_.Directory)/$($_.BaseName)" + $rootName = Join-Path $_.Directory $_.BaseName if ($rootName.EndsWith('.ni')) { $rootName = $rootName.Substring(0, $rootName.Length - 3) } @@ -64,3 +64,7 @@ $PDBs |% { Write-Output $_.FullName } } + +if (!$Tests) { + & $PSScriptRoot\Get-3rdPartySymbolFiles.ps1 +} From 5cc3d595f18db9dd5de705852640586b0fc24357 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 23 Apr 2025 18:07:04 -0600 Subject: [PATCH 1347/1753] Reapply "Avoid `dotnet format` hang" This reverts commit 46e768b364bbff90441fb5c0c9bfb160f4bfc67d. Because https://github.com/dotnet/sdk/issues/44951 is repro'ing again even on the latest .NET SDK. --- Directory.Packages.props | 3 ++- azure-pipelines/build.yml | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 87c53575d..c8918f798 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -19,7 +19,8 @@ - + + diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 108258282..5c106ade4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -37,8 +37,10 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} - - script: dotnet format --verify-no-changes --no-restore + - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code + env: + dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - template: expand-template.yml - job: macOS From e84bdc64f0536b9af683c8d726255a1a82fba208 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 9 May 2025 11:13:18 -0600 Subject: [PATCH 1348/1753] Fix 3rd party symbol archival --- tools/Get-SymbolFiles.ps1 | 4 ---- tools/artifacts/symbols.ps1 | 3 +++ 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/tools/Get-SymbolFiles.ps1 b/tools/Get-SymbolFiles.ps1 index 9464226a9..70656c0fa 100644 --- a/tools/Get-SymbolFiles.ps1 +++ b/tools/Get-SymbolFiles.ps1 @@ -64,7 +64,3 @@ $PDBs |% { Write-Output $_.FullName } } - -if (!$Tests) { - & $PSScriptRoot\Get-3rdPartySymbolFiles.ps1 -} diff --git a/tools/artifacts/symbols.ps1 b/tools/artifacts/symbols.ps1 index 9e2c7bd5b..b5882678a 100644 --- a/tools/artifacts/symbols.ps1 +++ b/tools/artifacts/symbols.ps1 @@ -1,7 +1,10 @@ $BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../bin") +$3rdPartyPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../obj/SymbolsPackages") if (!(Test-Path $BinPath)) { return } $symbolfiles = & "$PSScriptRoot/../Get-SymbolFiles.ps1" -Path $BinPath | Get-Unique +$3rdPartyFiles = & "$PSScriptRoot/../Get-3rdPartySymbolFiles.ps1" @{ "$BinPath" = $SymbolFiles; + "$3rdPartyPath" = $3rdPartyFiles; } From 56aaaf07c7318b015f04c9fefb66eb7dcb67a492 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 14 May 2025 10:03:40 -0600 Subject: [PATCH 1349/1753] Update Dockerfile and global.json updates to v9.0.300 (#372) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 78b0398cb..7d54aac97 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.203-noble@sha256:c84968764a7d265a29cc840096750816d82655369d6ad03bcdf65f790684fd21 +FROM mcr.microsoft.com/dotnet/sdk:9.0.300-noble@sha256:58fa5442c6da3bd654cab866fd6668de2713769511e412a3aa23c14368b84b16 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 4fe2bf77a..33fc5ca69 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.203", + "version": "9.0.300", "rollForward": "patch", "allowPrerelease": false } From 94431e72197b996f65ea77f497cfee7069f0c9cc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 20 May 2025 04:09:07 -0600 Subject: [PATCH 1350/1753] Update dependency Microsoft.NET.Test.Sdk to 17.14.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c8918f798..de9a568bd 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,7 +9,7 @@ - + From 08b8fabe4d5e476c07e4f5bf239ff7057abc589a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 29 May 2025 12:30:17 -0700 Subject: [PATCH 1351/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.300-noble Docker digest to 9f7bd4d (#373) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 7d54aac97..938b19f86 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.300-noble@sha256:58fa5442c6da3bd654cab866fd6668de2713769511e412a3aa23c14368b84b16 +FROM mcr.microsoft.com/dotnet/sdk:9.0.300-noble@sha256:9f7bd4d010026e15a57d9cf876f2f7d08c3eeed6a0ea987b8c5ba8c75e68e948 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 25a0aa49698a8f16b6c9043f41479eb78570c4d9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 29 May 2025 23:18:07 +0000 Subject: [PATCH 1352/1753] Update becheran/mlc action to v0.22.0 (#374) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d4ee90e5e..f0f293ee1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -76,6 +76,6 @@ jobs: steps: - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@c925f90a9a25e16e4c4bfa29058f6f9ffa9f0d8c # v0.21.0 + uses: becheran/mlc@88c9db09b8dabab813a2edd13f955b36aa73657a # v0.22.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From 7974fd38305278850bfb7013761995058b829fdb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 3 Jun 2025 08:14:52 -0600 Subject: [PATCH 1353/1753] Update dependency Microsoft.NET.Test.Sdk to 17.14.1 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index de9a568bd..c75c510aa 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,7 +9,7 @@ - + From 1c36682f82c28b3f0b160a9a69f8a7acb0ed36da Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 Jun 2025 10:15:43 -0600 Subject: [PATCH 1354/1753] Use `ImmutableArray` instead of `IReadOnlyList` in analyzers --- .../CommonInterest.cs | 46 ++++++------- .../Namespaces.cs | 68 +++++++++---------- .../Types.cs | 28 ++++---- .../Usings.cs | 4 ++ 4 files changed, 73 insertions(+), 73 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers/Usings.cs diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index ef21f9f90..e6923cc3b 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -26,14 +26,14 @@ public static class CommonInterest public static readonly Regex FileNamePatternForMethodsThatAssertMainThread = new Regex(@"^vs-threading\.MainThreadAssertingMethods(\..*)?.txt$", FileNamePatternRegexOptions); public static readonly Regex FileNamePatternForMethodsThatSwitchToMainThread = new Regex(@"^vs-threading\.MainThreadSwitchingMethods(\..*)?.txt$", FileNamePatternRegexOptions); - public static readonly IEnumerable JTFSyncBlockers = new[] - { + public static readonly IEnumerable JTFSyncBlockers = + [ new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTaskFactory.TypeName), Types.JoinableTaskFactory.Run), Types.JoinableTaskFactory.RunAsync), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioThreading, Types.JoinableTask.TypeName), Types.JoinableTask.Join), Types.JoinableTask.JoinAsync), - }; + ]; - public static readonly IEnumerable ProblematicSyncBlockingMethods = new[] - { + public static readonly IEnumerable ProblematicSyncBlockingMethods = + [ new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Wait)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAll)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.WaitAny)), null), @@ -41,24 +41,24 @@ public static class CommonInterest new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(TaskAwaiter)), nameof(TaskAwaiter.GetResult)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(ValueTaskAwaiter)), nameof(ValueTaskAwaiter.GetResult)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemRuntimeCompilerServices, nameof(ConfiguredValueTaskAwaitable.ConfiguredValueTaskAwaiter)), nameof(ConfiguredValueTaskAwaitable.ConfiguredValueTaskAwaiter.GetResult)), null), - }; + ]; - public static readonly IEnumerable SyncBlockingMethods = JTFSyncBlockers.Concat(ProblematicSyncBlockingMethods).Concat(new[] - { + public static readonly IEnumerable SyncBlockingMethods = JTFSyncBlockers.Concat(ProblematicSyncBlockingMethods).Concat( + [ new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "Wait"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShellInterop, "IVsTask"), "GetResult"), extensionMethodNamespace: Namespaces.MicrosoftVisualStudioShell), - }); + ]); - public static readonly IReadOnlyList SyncBlockingProperties = new[] - { + public static readonly ImmutableArray SyncBlockingProperties = + [ new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(Task)), nameof(Task.Result)), null), new SyncBlockingMethod(new QualifiedMember(new QualifiedType(Namespaces.SystemThreadingTasks, nameof(ValueTask)), nameof(ValueTask.Result)), null), - }; + ]; - public static readonly IEnumerable ThreadAffinityTestingMethods = new[] - { + public static readonly IEnumerable ThreadAffinityTestingMethods = + [ new QualifiedMember(new QualifiedType(Namespaces.MicrosoftVisualStudioShell, Types.ThreadHelper.TypeName), Types.ThreadHelper.CheckAccess), - }; + ]; public static readonly ImmutableArray TaskConfigureAwait = ImmutableArray.Create( new QualifiedMember(new QualifiedType(Types.Task.Namespace, Types.Task.TypeName), nameof(Task.ConfigureAwait)), @@ -77,7 +77,7 @@ public static class CommonInterest /// /// An array with '.' as its only element. /// - private static readonly char[] QualifiedIdentifierSeparators = new[] { '.' }; + private static readonly char[] QualifiedIdentifierSeparators = ['.']; public static IEnumerable ReadMethods(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) { @@ -421,7 +421,7 @@ public TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) public QualifiedMember Member { get; } /// - /// Gets a value indicating whether a member match is reuqired. + /// Gets a value indicating whether a member match is required. /// public bool IsMember => this.Member.Name is object; @@ -433,7 +433,7 @@ public TypeMatchSpec(QualifiedType type, QualifiedMember member, bool inverted) /// /// Gets a value indicating whether this is an uninitialized (default) instance. /// - public bool IsEmpty => this.Type.Namespace is null; + public bool IsEmpty => this.Type.Name is null; /// /// Tests whether a given symbol matches the description of a type (independent of its property). @@ -466,13 +466,13 @@ public bool IsMatch([NotNullWhen(true)] ITypeSymbol? typeSymbol, ISymbol? member public readonly struct QualifiedType { - public QualifiedType(IReadOnlyList containingTypeNamespace, string typeName) + public QualifiedType(ImmutableArray containingTypeNamespace, string typeName) { this.Namespace = containingTypeNamespace; this.Name = typeName; } - public IReadOnlyList Namespace { get; } + public ImmutableArray Namespace { get; } public string Name { get; } @@ -482,7 +482,7 @@ public bool IsMatch(ISymbol symbol) && symbol.BelongsToNamespace(this.Namespace); } - public override string ToString() => string.Join(".", this.Namespace.Concat(new[] { this.Name })); + public override string ToString() => string.Join(".", this.Namespace.Concat([this.Name])); } public readonly struct QualifiedMember @@ -509,7 +509,7 @@ public bool IsMatch(ISymbol? symbol) [DebuggerDisplay("{" + nameof(Method) + "} -> {" + nameof(AsyncAlternativeMethodName) + "}")] public readonly struct SyncBlockingMethod { - public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethodName = null, IReadOnlyList? extensionMethodNamespace = null) + public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethodName = null, ImmutableArray? extensionMethodNamespace = null) { this.Method = method; this.AsyncAlternativeMethodName = asyncAlternativeMethodName; @@ -520,7 +520,7 @@ public SyncBlockingMethod(QualifiedMember method, string? asyncAlternativeMethod public string? AsyncAlternativeMethodName { get; } - public IReadOnlyList? ExtensionMethodNamespace { get; } + public ImmutableArray? ExtensionMethodNamespace { get; } } public class AwaitableTypeTester diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs index 048814831..d1d8492b2 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Namespaces.cs @@ -1,83 +1,81 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Collections.Generic; - namespace Microsoft.VisualStudio.Threading.Analyzers; public static class Namespaces { - public static readonly IReadOnlyList System = new[] - { + public static readonly ImmutableArray System = + [ nameof(System), - }; + ]; - public static readonly IReadOnlyList SystemCollectionsGeneric = new[] - { + public static readonly ImmutableArray SystemCollectionsGeneric = + [ nameof(System), nameof(global::System.Collections), nameof(global::System.Collections.Generic), - }; + ]; - public static readonly IReadOnlyList SystemThreading = new[] - { + public static readonly ImmutableArray SystemThreading = + [ nameof(System), nameof(global::System.Threading), - }; + ]; - public static readonly IReadOnlyList SystemDiagnostics = new[] - { + public static readonly ImmutableArray SystemDiagnostics = + [ nameof(System), nameof(global::System.Diagnostics), - }; + ]; - public static readonly IReadOnlyList SystemThreadingTasks = new[] - { + public static readonly ImmutableArray SystemThreadingTasks = + [ nameof(System), nameof(global::System.Threading), nameof(global::System.Threading.Tasks), - }; + ]; - public static readonly IReadOnlyList SystemRuntimeCompilerServices = new[] - { + public static readonly ImmutableArray SystemRuntimeCompilerServices = + [ nameof(System), nameof(global::System.Runtime), nameof(global::System.Runtime.CompilerServices), - }; + ]; - public static readonly IReadOnlyList SystemRuntimeInteropServices = new[] - { + public static readonly ImmutableArray SystemRuntimeInteropServices = + [ nameof(System), nameof(global::System.Runtime), nameof(global::System.Runtime.InteropServices), - }; + ]; - public static readonly IReadOnlyList SystemWindowsThreading = new[] - { + public static readonly ImmutableArray SystemWindowsThreading = + [ nameof(System), nameof(global::System.Windows), "Threading", - }; + ]; - public static readonly IReadOnlyList MicrosoftVisualStudioThreading = new[] - { + public static readonly ImmutableArray MicrosoftVisualStudioThreading = + [ "Microsoft", "VisualStudio", "Threading", - }; + ]; - public static readonly IReadOnlyList MicrosoftVisualStudioShell = new[] - { + public static readonly ImmutableArray MicrosoftVisualStudioShell = + [ "Microsoft", "VisualStudio", "Shell", - }; + ]; - public static readonly IReadOnlyList MicrosoftVisualStudioShellInterop = new[] - { + public static readonly ImmutableArray MicrosoftVisualStudioShellInterop = + [ "Microsoft", "VisualStudio", "Shell", "Interop", - }; + ]; } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs index 987a09904..f6d24b8db 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Types.cs @@ -1,8 +1,6 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Collections.Generic; - namespace Microsoft.VisualStudio.Threading.Analyzers; /// @@ -37,7 +35,7 @@ public static class AwaitExtensions /// public const string ConfigureAwaitRunInline = "ConfigureAwaitRunInline"; - public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly ImmutableArray Namespace = Namespaces.MicrosoftVisualStudioThreading; } /// @@ -75,7 +73,7 @@ public static class TplExtensions /// public const string FalseTask = "FalseTask"; - public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly ImmutableArray Namespace = Namespaces.MicrosoftVisualStudioThreading; } /// @@ -88,14 +86,14 @@ public static class AsyncEventHandler /// public const string TypeName = "AsyncEventHandler"; - public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly ImmutableArray Namespace = Namespaces.MicrosoftVisualStudioThreading; } public static class AsyncMethodBuilderAttribute { public const string TypeName = nameof(System.Runtime.CompilerServices.AsyncMethodBuilderAttribute); - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeCompilerServices; } /// @@ -116,7 +114,7 @@ public static class JoinableTaskFactory public const string RunAsync = "RunAsync"; - public static readonly IReadOnlyList Namespace = Namespaces.MicrosoftVisualStudioThreading; + public static readonly ImmutableArray Namespace = Namespaces.MicrosoftVisualStudioThreading; } /// @@ -191,7 +189,7 @@ public static class Task public const string WhenAll = "WhenAll"; - public static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; + public static readonly ImmutableArray Namespace = Namespaces.SystemThreadingTasks; } public static class ConfiguredTaskAwaitable @@ -200,7 +198,7 @@ public static class ConfiguredTaskAwaitable public const string FullName = "System.Runtime.CompilerServices." + TypeName; - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeCompilerServices; } public static class ValueTask @@ -209,7 +207,7 @@ public static class ValueTask public const string FullName = "System.Threading.Tasks." + TypeName; - public static readonly IReadOnlyList Namespace = Namespaces.SystemThreadingTasks; + public static readonly ImmutableArray Namespace = Namespaces.SystemThreadingTasks; } public static class ConfiguredValueTaskAwaitable @@ -218,34 +216,34 @@ public static class ConfiguredValueTaskAwaitable public const string FullName = "System.Runtime.CompilerServices." + TypeName; - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeCompilerServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeCompilerServices; } public static class CoClassAttribute { public const string TypeName = nameof(System.Runtime.InteropServices.CoClassAttribute); - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeInteropServices; } public static class ComImportAttribute { public const string TypeName = nameof(System.Runtime.InteropServices.ComImportAttribute); - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeInteropServices; } public static class InterfaceTypeAttribute { public const string TypeName = nameof(System.Runtime.InteropServices.InterfaceTypeAttribute); - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeInteropServices; } public static class TypeLibTypeAttribute { public const string TypeName = "TypeLibTypeAttribute"; - public static readonly IReadOnlyList Namespace = Namespaces.SystemRuntimeInteropServices; + public static readonly ImmutableArray Namespace = Namespaces.SystemRuntimeInteropServices; } } diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Usings.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Usings.cs new file mode 100644 index 000000000..d30c9f88f --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Usings.cs @@ -0,0 +1,4 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +global using System.Collections.Immutable; From 0d8cac25bb840686637e3498bac8f8a8c5d1db91 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 Jun 2025 14:50:48 -0600 Subject: [PATCH 1355/1753] Update becheran/mlc action to v0.22.0 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 2425d742b..80476a0d4 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -17,7 +17,7 @@ jobs: with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@v0.21.0 + uses: becheran/mlc@88c9db09b8dabab813a2edd13f955b36aa73657a # v0.22.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc* - name: ⚙ Install prerequisites From e427b3f3a3550a53929baf1361e11fbfeef00332 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 5 Jun 2025 14:55:27 -0600 Subject: [PATCH 1356/1753] Pin actions/checkout --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 80476a0d4..391289a45 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) From df32f51fa7771b8c8863c2323a7cce7468cc2e53 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 7 Jun 2025 05:23:07 -0600 Subject: [PATCH 1357/1753] Update xunit Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c75c510aa..c510499aa 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,8 +10,8 @@ - - + + From 5894dfc84fc2da444a90fca32328c50e27650889 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 10 Jun 2025 07:33:23 -0600 Subject: [PATCH 1358/1753] Improve docs around `ReentrantSemaphore`'s reentrancy detection --- Microsoft.VisualStudio.Threading.sln | 111 ++++++++++++++++++ samples/.editorconfig | 60 ++++++++++ samples/ApiSamples.cs | 42 +++++++ samples/samples.csproj | 20 ++++ .../ReentrantSemaphore.cs | 14 +++ 5 files changed, 247 insertions(+) create mode 100644 samples/.editorconfig create mode 100644 samples/ApiSamples.cs create mode 100644 samples/samples.csproj diff --git a/Microsoft.VisualStudio.Threading.sln b/Microsoft.VisualStudio.Threading.sln index 57ec45323..286f79845 100644 --- a/Microsoft.VisualStudio.Threading.sln +++ b/Microsoft.VisualStudio.Threading.sln @@ -53,100 +53,210 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{C1DAF484-7 EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.VisualStudio.Threading.JointPackage", "src\Microsoft.VisualStudio.Threading.JointPackage\Microsoft.VisualStudio.Threading.JointPackage.csproj", "{D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "samples", "samples\samples.csproj", "{52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Debug|NonWindows = Debug|NonWindows + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU Release|NonWindows = Release|NonWindows + Release|x64 = Release|x64 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|Any CPU.Build.0 = Debug|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|NonWindows.Build.0 = Debug|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x64.ActiveCfg = Debug|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x64.Build.0 = Debug|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x86.ActiveCfg = Debug|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x86.Build.0 = Debug|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|Any CPU.ActiveCfg = Release|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|Any CPU.Build.0 = Release|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|NonWindows.ActiveCfg = Release|Any CPU {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|NonWindows.Build.0 = Release|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x64.ActiveCfg = Release|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x64.Build.0 = Release|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x86.ActiveCfg = Release|Any CPU + {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x86.Build.0 = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|Any CPU.Build.0 = Debug|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|NonWindows.Build.0 = Debug|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x64.ActiveCfg = Debug|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x64.Build.0 = Debug|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x86.ActiveCfg = Debug|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x86.Build.0 = Debug|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|Any CPU.ActiveCfg = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|Any CPU.Build.0 = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.ActiveCfg = Release|Any CPU {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.Build.0 = Release|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x64.ActiveCfg = Release|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x64.Build.0 = Release|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x86.ActiveCfg = Release|Any CPU + {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x86.Build.0 = Release|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.Build.0 = Debug|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.Build.0 = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x64.ActiveCfg = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x64.Build.0 = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x86.ActiveCfg = Debug|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x86.Build.0 = Debug|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.ActiveCfg = Release|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.Build.0 = Release|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.ActiveCfg = Release|Any CPU {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.Build.0 = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x64.ActiveCfg = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x64.Build.0 = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x86.ActiveCfg = Release|Any CPU + {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x86.Build.0 = Release|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.Build.0 = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|NonWindows.Build.0 = Debug|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x64.ActiveCfg = Debug|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x64.Build.0 = Debug|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x86.ActiveCfg = Debug|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x86.Build.0 = Debug|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|Any CPU.ActiveCfg = Release|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|Any CPU.Build.0 = Release|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|NonWindows.ActiveCfg = Release|Any CPU {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|NonWindows.Build.0 = Release|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x64.ActiveCfg = Release|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x64.Build.0 = Release|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x86.ActiveCfg = Release|Any CPU + {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x86.Build.0 = Release|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|Any CPU.Build.0 = Debug|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|NonWindows.Build.0 = Debug|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x64.ActiveCfg = Debug|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x64.Build.0 = Debug|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x86.ActiveCfg = Debug|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x86.Build.0 = Debug|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|Any CPU.ActiveCfg = Release|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|Any CPU.Build.0 = Release|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|NonWindows.ActiveCfg = Release|Any CPU {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|NonWindows.Build.0 = Release|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x64.ActiveCfg = Release|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x64.Build.0 = Release|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x86.ActiveCfg = Release|Any CPU + {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x86.Build.0 = Release|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|Any CPU.Build.0 = Debug|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|NonWindows.Build.0 = Debug|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x64.ActiveCfg = Debug|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x64.Build.0 = Debug|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x86.ActiveCfg = Debug|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x86.Build.0 = Debug|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|Any CPU.ActiveCfg = Release|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|Any CPU.Build.0 = Release|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|NonWindows.ActiveCfg = Release|Any CPU {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|NonWindows.Build.0 = Release|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x64.ActiveCfg = Release|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x64.Build.0 = Release|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x86.ActiveCfg = Release|Any CPU + {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x86.Build.0 = Release|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|Any CPU.Build.0 = Debug|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|NonWindows.Build.0 = Debug|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x64.ActiveCfg = Debug|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x64.Build.0 = Debug|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x86.ActiveCfg = Debug|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x86.Build.0 = Debug|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|Any CPU.ActiveCfg = Release|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|Any CPU.Build.0 = Release|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|NonWindows.ActiveCfg = Release|Any CPU {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|NonWindows.Build.0 = Release|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x64.ActiveCfg = Release|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x64.Build.0 = Release|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x86.ActiveCfg = Release|Any CPU + {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x86.Build.0 = Release|Any CPU {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|Any CPU.Build.0 = Debug|Any CPU {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|NonWindows.ActiveCfg = Debug|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x64.ActiveCfg = Debug|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x64.Build.0 = Debug|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x86.ActiveCfg = Debug|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x86.Build.0 = Debug|Any CPU {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|Any CPU.ActiveCfg = Release|Any CPU {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|Any CPU.Build.0 = Release|Any CPU {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|NonWindows.ActiveCfg = Release|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x64.ActiveCfg = Release|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x64.Build.0 = Release|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x86.ActiveCfg = Release|Any CPU + {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x86.Build.0 = Release|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|Any CPU.Build.0 = Debug|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|NonWindows.Build.0 = Debug|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x64.ActiveCfg = Debug|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x64.Build.0 = Debug|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x86.ActiveCfg = Debug|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x86.Build.0 = Debug|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|Any CPU.ActiveCfg = Release|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|Any CPU.Build.0 = Release|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|NonWindows.ActiveCfg = Release|Any CPU {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|NonWindows.Build.0 = Release|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x64.ActiveCfg = Release|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x64.Build.0 = Release|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x86.ActiveCfg = Release|Any CPU + {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x86.Build.0 = Release|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|Any CPU.Build.0 = Debug|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|NonWindows.Build.0 = Debug|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x64.ActiveCfg = Debug|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x64.Build.0 = Debug|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x86.ActiveCfg = Debug|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x86.Build.0 = Debug|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|Any CPU.ActiveCfg = Release|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|Any CPU.Build.0 = Release|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|NonWindows.ActiveCfg = Release|Any CPU {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|NonWindows.Build.0 = Release|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x64.ActiveCfg = Release|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x64.Build.0 = Release|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x86.ActiveCfg = Release|Any CPU + {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x86.Build.0 = Release|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|Any CPU.Build.0 = Debug|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|NonWindows.ActiveCfg = Debug|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|NonWindows.Build.0 = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x64.ActiveCfg = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x64.Build.0 = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x86.ActiveCfg = Debug|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x86.Build.0 = Debug|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|Any CPU.ActiveCfg = Release|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|Any CPU.Build.0 = Release|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|NonWindows.ActiveCfg = Release|Any CPU {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|NonWindows.Build.0 = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x64.ActiveCfg = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x64.Build.0 = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x86.ActiveCfg = Release|Any CPU + {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x86.Build.0 = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|NonWindows.ActiveCfg = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|NonWindows.Build.0 = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x64.ActiveCfg = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x64.Build.0 = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x86.ActiveCfg = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x86.Build.0 = Debug|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|Any CPU.Build.0 = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|NonWindows.ActiveCfg = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|NonWindows.Build.0 = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x64.ActiveCfg = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x64.Build.0 = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x86.ActiveCfg = Release|Any CPU + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -163,6 +273,7 @@ Global {D5A0D627-7853-43F5-9AF4-E23D062C6ABA} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} {8CDF7526-D625-4E16-A266-BAF654ABE181} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} + {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {E2124DFF-970E-4BA1-9E50-3ADB0AABF347} diff --git a/samples/.editorconfig b/samples/.editorconfig new file mode 100644 index 000000000..726d351c3 --- /dev/null +++ b/samples/.editorconfig @@ -0,0 +1,60 @@ +[*.cs] + +indent_style = space + +# SA1108: Block statements should not contain embedded comments +dotnet_diagnostic.SA1108.severity = none + +# SA1123: Do not place regions within elements +dotnet_diagnostic.SA1123.severity = none + +# SA1124: Do not use regions +dotnet_diagnostic.SA1124.severity = none + +# SA1200: Using directives should be placed correctly +dotnet_diagnostic.SA1200.severity = none + +# SA1201: Elements should appear in the correct order +dotnet_diagnostic.SA1201.severity = silent + +# SA1205: Partial elements should declare access +dotnet_diagnostic.SA1205.severity = none + +# SA1400: Access modifier should be declared +dotnet_diagnostic.SA1400.severity = none + +# SA1402: File may only contains a single type +dotnet_diagnostic.SA1402.severity = none + +# SA1403: File may only contain a single namespace +dotnet_diagnostic.SA1403.severity = none + +# SA1502: Element should not be on a single line +dotnet_diagnostic.SA1502.severity = none + +# SA1515: Single-line comment should be preceded by blank line +dotnet_diagnostic.SA1515.severity = none + +# SA1516: Elements should be separated by blank line +dotnet_diagnostic.SA1516.severity = none + +# SA1600: Elements should be documented +dotnet_diagnostic.SA1600.severity = silent + +# SA1601: Partial elements should be documented +dotnet_diagnostic.SA1601.severity = silent + +# SA1649: File name should match first type name +dotnet_diagnostic.SA1649.severity = none + +# IDE0051: Remove unused private members +dotnet_diagnostic.IDE0051.severity = none + +# CS1591: Missing XML comment for publicly visible type or member +dotnet_diagnostic.CS1591.severity = silent + +# CA1822: Mark members as static +dotnet_diagnostic.CA1822.severity = silent + +# CA1062: Validate arguments of public methods +dotnet_diagnostic.CA1062.severity = silent diff --git a/samples/ApiSamples.cs b/samples/ApiSamples.cs new file mode 100644 index 000000000..74ffc15f2 --- /dev/null +++ b/samples/ApiSamples.cs @@ -0,0 +1,42 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System.Threading; +using System.Threading.Tasks; +using Microsoft.VisualStudio.Threading; + +public class SuppressRelevanceSample +{ + private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(mode: ReentrantSemaphore.ReentrancyMode.NotAllowed); + + #region SuppressRelevance + public async Task DoSomethingAsync() + { + await this.semaphore.ExecuteAsync(async delegate + { + // field access under the semaphore + // ... + await Task.Yield(); // represents some async work + + // Fire and forget code that uses the semaphore, but should *not* + // inherit our own posession of the semaphore. + using (this.semaphore.SuppressRelevance()) + { + this.DoSomethingLaterAsync().Forget(); // Don't await this, or a deadlock will occur. + } + }); + } + + private async Task DoSomethingLaterAsync() + { + // This semaphore use will not be seen as nested because of our caller's wrapping + // the call in SuppressRelevance. + // So instead of throwing, it will block till its caller releases the semaphore. + await this.semaphore.ExecuteAsync(async delegate + { + // Whatever + await Task.Yield(); // represents some async work + }); + } + #endregion +} diff --git a/samples/samples.csproj b/samples/samples.csproj new file mode 100644 index 000000000..078b09b46 --- /dev/null +++ b/samples/samples.csproj @@ -0,0 +1,20 @@ + + + + net8.0;net472 + false + + + + + + + + diff --git a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs index 3e7c581a5..5ee34752a 100644 --- a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs @@ -153,6 +153,7 @@ public static ReentrantSemaphore Create(int initialCount = 1, JoinableTaskContex /// /// A cancellation token. /// A task that completes with the result of , after the semaphore has been exited. + /// public abstract Task ExecuteAsync(Func operation, CancellationToken cancellationToken = default); /// @@ -167,6 +168,13 @@ public static ReentrantSemaphore Create(int initialCount = 1, JoinableTaskContex /// /// A cancellation token. /// A task that completes with the result of , after the semaphore has been exited. + /// + /// Thrown when reentrancy is detected and not allowed based due to being provided to the constructor. + /// This happens when code that already holds the semaphore calls code that attempts to again enter the semaphore. + /// When the called code is not awaited on by the caller, it may be appropriate to suppress this reentrancy detection for the method + /// that is called in a fire-and-forget fashion. + /// To suppress this exception for that specific case while preserving overall protection, use . + /// public abstract ValueTask ExecuteAsync(Func> operation, CancellationToken cancellationToken = default); /// @@ -179,6 +187,12 @@ public static ReentrantSemaphore Create(int initialCount = 1, JoinableTaskContex /// caller's right to the semaphore. /// This is a safe call to make whether or not the semaphore is currently held, or whether reentrancy is allowed on this instance. /// + /// + /// + /// The following snippet demonstrates a way to use this method. + /// + /// + /// public virtual RevertRelevance SuppressRelevance() => default; /// From 8ef5a25df24307f8ae00862f13a854ecb44d508e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 10 Jun 2025 07:41:21 -0600 Subject: [PATCH 1359/1753] Switch solution file from sln to slnx --- .vscode/settings.json | 2 +- Microsoft.VisualStudio.Threading.sln | 281 -------------------------- Microsoft.VisualStudio.Threading.slnx | 44 ++++ 3 files changed, 45 insertions(+), 282 deletions(-) delete mode 100644 Microsoft.VisualStudio.Threading.sln create mode 100644 Microsoft.VisualStudio.Threading.slnx diff --git a/.vscode/settings.json b/.vscode/settings.json index 618d36150..a7bab44d1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,7 +6,7 @@ "omnisharp.enableEditorConfigSupport": true, "omnisharp.enableRoslynAnalyzers": true, "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true, - "dotnet.defaultSolution": "Microsoft.VisualStudio.Threading.sln", + "dotnet.defaultSolution": "Microsoft.VisualStudio.Threading.slnx", "editor.formatOnSave": true, "[xml]": { "editor.wordWrap": "off" diff --git a/Microsoft.VisualStudio.Threading.sln b/Microsoft.VisualStudio.Threading.sln deleted file mode 100644 index 286f79845..000000000 --- a/Microsoft.VisualStudio.Threading.sln +++ /dev/null @@ -1,281 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 17 -VisualStudioVersion = 17.5.33116.440 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers", "src\Microsoft.VisualStudio.Threading.Analyzers\Microsoft.VisualStudio.Threading.Analyzers.csproj", "{536F3F9A-B457-43B8-BC93-CE1C16959037}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers.Tests", "test\Microsoft.VisualStudio.Threading.Analyzers.Tests\Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj", "{620ED702-B6DA-4454-BF3E-5494D3652724}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{AA091F9F-B40A-466F-B09F-22EAD115996F}" - ProjectSection(SolutionItems) = preProject - .editorconfig = .editorconfig - azure-pipelines\build.yml = azure-pipelines\build.yml - Directory.Build.props = Directory.Build.props - Directory.Build.targets = Directory.Build.targets - Directory.Packages.props = Directory.Packages.props - global.json = global.json - nuget.config = nuget.config - stylecop.json = stylecop.json - version.json = version.json - EndProjectSection -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher", "test\Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher\Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj", "{4961AA84-088C-46C0-BAC0-F9E87A9F03A7}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading", "src\Microsoft.VisualStudio.Threading\Microsoft.VisualStudio.Threading.csproj", "{D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Tests", "test\Microsoft.VisualStudio.Threading.Tests\Microsoft.VisualStudio.Threading.Tests.csproj", "{CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IsolatedTestHost", "test\IsolatedTestHost\IsolatedTestHost.csproj", "{BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers.CodeFixes", "src\Microsoft.VisualStudio.Threading.Analyzers.CodeFixes\Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj", "{3BDB8F46-A39C-422B-8B0E-89E98B83073F}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SosThreadingTools", "src\SosThreadingTools\SosThreadingTools.csproj", "{7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers.CSharp", "src\Microsoft.VisualStudio.Threading.Analyzers.CSharp\Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj", "{D5A0D627-7853-43F5-9AF4-E23D062C6ABA}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.VisualStudio.Threading.Analyzers.VisualBasic", "src\Microsoft.VisualStudio.Threading.Analyzers.VisualBasic\Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj", "{8CDF7526-D625-4E16-A266-BAF654ABE181}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{96134B19-FB32-4FA0-A565-BD4247D1E5B2}" - ProjectSection(SolutionItems) = preProject - src\.editorconfig = src\.editorconfig - src\AssemblyInfo.cs = src\AssemblyInfo.cs - src\Directory.Build.props = src\Directory.Build.props - src\Directory.Build.targets = src\Directory.Build.targets - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{C1DAF484-769B-4C5E-9DD1-A4CFAA66E938}" - ProjectSection(SolutionItems) = preProject - test\.editorconfig = test\.editorconfig - test\Directory.Build.props = test\Directory.Build.props - test\Directory.Build.targets = test\Directory.Build.targets - EndProjectSection -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.VisualStudio.Threading.JointPackage", "src\Microsoft.VisualStudio.Threading.JointPackage\Microsoft.VisualStudio.Threading.JointPackage.csproj", "{D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "samples", "samples\samples.csproj", "{52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Debug|NonWindows = Debug|NonWindows - Debug|x64 = Debug|x64 - Debug|x86 = Debug|x86 - Release|Any CPU = Release|Any CPU - Release|NonWindows = Release|NonWindows - Release|x64 = Release|x64 - Release|x86 = Release|x86 - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|Any CPU.Build.0 = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|NonWindows.Build.0 = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x64.ActiveCfg = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x64.Build.0 = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x86.ActiveCfg = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Debug|x86.Build.0 = Debug|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|Any CPU.ActiveCfg = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|Any CPU.Build.0 = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|NonWindows.ActiveCfg = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|NonWindows.Build.0 = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x64.ActiveCfg = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x64.Build.0 = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x86.ActiveCfg = Release|Any CPU - {536F3F9A-B457-43B8-BC93-CE1C16959037}.Release|x86.Build.0 = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|Any CPU.Build.0 = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|NonWindows.Build.0 = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x64.ActiveCfg = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x64.Build.0 = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x86.ActiveCfg = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Debug|x86.Build.0 = Debug|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|Any CPU.ActiveCfg = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|Any CPU.Build.0 = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.ActiveCfg = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|NonWindows.Build.0 = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x64.ActiveCfg = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x64.Build.0 = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x86.ActiveCfg = Release|Any CPU - {620ED702-B6DA-4454-BF3E-5494D3652724}.Release|x86.Build.0 = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|Any CPU.Build.0 = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|NonWindows.Build.0 = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x64.ActiveCfg = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x64.Build.0 = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x86.ActiveCfg = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Debug|x86.Build.0 = Debug|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.ActiveCfg = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|Any CPU.Build.0 = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.ActiveCfg = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|NonWindows.Build.0 = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x64.ActiveCfg = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x64.Build.0 = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x86.ActiveCfg = Release|Any CPU - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7}.Release|x86.Build.0 = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|NonWindows.Build.0 = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x64.ActiveCfg = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x64.Build.0 = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x86.ActiveCfg = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Debug|x86.Build.0 = Debug|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|Any CPU.Build.0 = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|NonWindows.ActiveCfg = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|NonWindows.Build.0 = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x64.ActiveCfg = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x64.Build.0 = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x86.ActiveCfg = Release|Any CPU - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D}.Release|x86.Build.0 = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|NonWindows.Build.0 = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x64.ActiveCfg = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x64.Build.0 = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x86.ActiveCfg = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Debug|x86.Build.0 = Debug|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|Any CPU.Build.0 = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|NonWindows.ActiveCfg = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|NonWindows.Build.0 = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x64.ActiveCfg = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x64.Build.0 = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x86.ActiveCfg = Release|Any CPU - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D}.Release|x86.Build.0 = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|Any CPU.Build.0 = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|NonWindows.Build.0 = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x64.ActiveCfg = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x64.Build.0 = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x86.ActiveCfg = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Debug|x86.Build.0 = Debug|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|Any CPU.ActiveCfg = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|Any CPU.Build.0 = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|NonWindows.ActiveCfg = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|NonWindows.Build.0 = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x64.ActiveCfg = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x64.Build.0 = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x86.ActiveCfg = Release|Any CPU - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0}.Release|x86.Build.0 = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|Any CPU.Build.0 = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|NonWindows.Build.0 = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x64.ActiveCfg = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x64.Build.0 = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x86.ActiveCfg = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Debug|x86.Build.0 = Debug|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|Any CPU.ActiveCfg = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|Any CPU.Build.0 = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|NonWindows.ActiveCfg = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|NonWindows.Build.0 = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x64.ActiveCfg = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x64.Build.0 = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x86.ActiveCfg = Release|Any CPU - {3BDB8F46-A39C-422B-8B0E-89E98B83073F}.Release|x86.Build.0 = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|Any CPU.Build.0 = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x64.ActiveCfg = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x64.Build.0 = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x86.ActiveCfg = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Debug|x86.Build.0 = Debug|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|Any CPU.ActiveCfg = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|Any CPU.Build.0 = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|NonWindows.ActiveCfg = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x64.ActiveCfg = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x64.Build.0 = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x86.ActiveCfg = Release|Any CPU - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624}.Release|x86.Build.0 = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|NonWindows.Build.0 = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x64.ActiveCfg = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x64.Build.0 = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x86.ActiveCfg = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Debug|x86.Build.0 = Debug|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|Any CPU.Build.0 = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|NonWindows.ActiveCfg = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|NonWindows.Build.0 = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x64.ActiveCfg = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x64.Build.0 = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x86.ActiveCfg = Release|Any CPU - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA}.Release|x86.Build.0 = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|Any CPU.Build.0 = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|NonWindows.Build.0 = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x64.ActiveCfg = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x64.Build.0 = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x86.ActiveCfg = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Debug|x86.Build.0 = Debug|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|Any CPU.ActiveCfg = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|Any CPU.Build.0 = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|NonWindows.ActiveCfg = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|NonWindows.Build.0 = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x64.ActiveCfg = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x64.Build.0 = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x86.ActiveCfg = Release|Any CPU - {8CDF7526-D625-4E16-A266-BAF654ABE181}.Release|x86.Build.0 = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|NonWindows.Build.0 = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x64.ActiveCfg = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x64.Build.0 = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x86.ActiveCfg = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Debug|x86.Build.0 = Debug|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|Any CPU.Build.0 = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|NonWindows.ActiveCfg = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|NonWindows.Build.0 = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x64.ActiveCfg = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x64.Build.0 = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x86.ActiveCfg = Release|Any CPU - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB}.Release|x86.Build.0 = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|Any CPU.Build.0 = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|NonWindows.ActiveCfg = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|NonWindows.Build.0 = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x64.ActiveCfg = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x64.Build.0 = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x86.ActiveCfg = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Debug|x86.Build.0 = Debug|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|Any CPU.ActiveCfg = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|Any CPU.Build.0 = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|NonWindows.ActiveCfg = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|NonWindows.Build.0 = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x64.ActiveCfg = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x64.Build.0 = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x86.ActiveCfg = Release|Any CPU - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9}.Release|x86.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {536F3F9A-B457-43B8-BC93-CE1C16959037} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {620ED702-B6DA-4454-BF3E-5494D3652724} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} - {4961AA84-088C-46C0-BAC0-F9E87A9F03A7} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} - {D9BB9FB6-3833-44E8-B7A7-DE729FCE214D} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {CBEDB102-ABAE-40B1-AF3F-A6226DB6713D} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} - {BA4643D8-E6B2-4DED-882F-4827F3AB6AB0} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} - {3BDB8F46-A39C-422B-8B0E-89E98B83073F} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {7177DEEE-D14D-4A4A-BF6E-8B0CDC26B624} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {D5A0D627-7853-43F5-9AF4-E23D062C6ABA} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {8CDF7526-D625-4E16-A266-BAF654ABE181} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {D149A8B3-A98F-4EDD-8C12-5CCDCBFB68DB} = {96134B19-FB32-4FA0-A565-BD4247D1E5B2} - {52D4D516-3AA0-4A2B-ACF7-70FE9315B0D9} = {C1DAF484-769B-4C5E-9DD1-A4CFAA66E938} - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {E2124DFF-970E-4BA1-9E50-3ADB0AABF347} - EndGlobalSection -EndGlobal diff --git a/Microsoft.VisualStudio.Threading.slnx b/Microsoft.VisualStudio.Threading.slnx new file mode 100644 index 000000000..62b62e80b --- /dev/null +++ b/Microsoft.VisualStudio.Threading.slnx @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From f2bbe668e3d886b5756e5f47bb61690aed73dd8f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 10 Jun 2025 07:38:58 -0600 Subject: [PATCH 1360/1753] Apply our analyzers to the samples project --- samples/ApiSamples.cs | 2 +- samples/samples.csproj | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/samples/ApiSamples.cs b/samples/ApiSamples.cs index 74ffc15f2..6fa40c624 100644 --- a/samples/ApiSamples.cs +++ b/samples/ApiSamples.cs @@ -7,7 +7,7 @@ public class SuppressRelevanceSample { - private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(mode: ReentrantSemaphore.ReentrancyMode.NotAllowed); + private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(1, null, ReentrantSemaphore.ReentrancyMode.NotAllowed); #region SuppressRelevance public async Task DoSomethingAsync() diff --git a/samples/samples.csproj b/samples/samples.csproj index 078b09b46..788cac68e 100644 --- a/samples/samples.csproj +++ b/samples/samples.csproj @@ -7,14 +7,18 @@ - + From 0c41b219292b26fddfa418b3c4b1796f943c4704 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 11 Jun 2025 05:56:25 -0600 Subject: [PATCH 1361/1753] Update Dockerfile and global.json updates to v9.0.301 (#376) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 938b19f86..cd1285d48 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.300-noble@sha256:9f7bd4d010026e15a57d9cf876f2f7d08c3eeed6a0ea987b8c5ba8c75e68e948 +FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:4f50505b5344e9d8a76805d71bb4ba76da6b01656e17a66a8ce1e4c4dfaaec12 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 33fc5ca69..0e241b6f5 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.300", + "version": "9.0.301", "rollForward": "patch", "allowPrerelease": false } From b3c2d219e12190ade30ecc9e5028fb935592a9b0 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Jun 2025 08:14:48 -0700 Subject: [PATCH 1362/1753] Merge pull request #1467 from microsoft/copilot/fix-1167 Fix VSTHRD110 firing in Expression-valued scenarios --- ...HRD110ObserveResultOfAsyncCallsAnalyzer.cs | 99 +++++++++++ ...0ObserveResultOfAsyncCallsAnalyzerTests.cs | 154 ++++++++++++++++++ 2 files changed, 253 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs index 864c3f5e4..1bc7a2004 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs @@ -43,6 +43,98 @@ public override void Initialize(AnalysisContext context) }); } + /// + /// Determines whether an invocation is within a lambda expression that is being converted to an Expression tree. + /// + /// The invocation operation to check. + /// True if the invocation is within a lambda converted to an Expression; false otherwise. + private static bool IsWithinExpressionLambda(IInvocationOperation operation) + { + // Walk up the operation tree to find the containing lambda + IOperation? current = operation.Parent; + while (current is not null) + { + if (current is IAnonymousFunctionOperation lambda) + { + // Found a lambda, now check if it's being converted to an Expression<> + return IsLambdaConvertedToExpression(lambda); + } + + current = current.Parent; + } + + return false; + } + + /// + /// Determines whether a lambda is being converted to an Expression tree type. + /// + /// The lambda operation to check. + /// True if the lambda is being converted to an Expression; false otherwise. + private static bool IsLambdaConvertedToExpression(IAnonymousFunctionOperation lambda) + { + // Walk up from the lambda to find conversion or argument operations + IOperation? current = lambda.Parent; + while (current is not null) + { + // Check if the lambda's parent is a conversion operation + if (current is IConversionOperation conversion) + { + // Check if the target type is Expression<> or a related expression tree type + return IsExpressionTreeType(conversion.Type); + } + + // Check if the lambda is being passed as an argument to a method expecting Expression<> + if (current is IArgumentOperation argument && + argument.Parameter?.Type is INamedTypeSymbol parameterType) + { + return IsExpressionTreeType(parameterType); + } + + // Allow certain operations to be skipped (like parentheses) + if (current is IParenthesizedOperation) + { + current = current.Parent; + continue; + } + + // Stop walking up at other operation types to avoid false positives + break; + } + + return false; + } + + /// + /// Determines whether a type is an Expression tree type (Expression<T> or related types). + /// + /// The type to check. + /// True if the type is an Expression tree type; false otherwise. + private static bool IsExpressionTreeType(ITypeSymbol? type) + { + if (type is not INamedTypeSymbol namedType) + { + return false; + } + + // Check for System.Linq.Expressions.Expression + if (namedType.Name == "Expression" && + namedType.ContainingNamespace?.ToDisplayString() == "System.Linq.Expressions" && + namedType.IsGenericType) + { + return true; + } + + // Check for LambdaExpression and other expression types + if (namedType.ContainingNamespace?.ToDisplayString() == "System.Linq.Expressions" && + (namedType.Name == "LambdaExpression" || namedType.Name.EndsWith("Expression"))) + { + return true; + } + + return false; + } + private void AnalyzeInvocation(OperationAnalysisContext context, CommonInterest.AwaitableTypeTester awaitableTypes) { var operation = (IInvocationOperation)context.Operation; @@ -57,6 +149,13 @@ private void AnalyzeInvocation(OperationAnalysisContext context, CommonInterest. return; } + // Check if this invocation is within a lambda that's being converted to an Expression<> + if (IsWithinExpressionLambda(operation)) + { + // This invocation is within a lambda converted to an expression tree, so it's not actually being invoked. + return; + } + // Only consider invocations that are direct statements (or are statements through limited steps). // Otherwise, we assume their result is awaited, assigned, or otherwise consumed. IOperation? parentOperation = operation.Parent; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs index 95cdeffad..c9fca9dd6 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD110ObserveResultOfAsyncCallsAnalyzerTests.cs @@ -542,4 +542,158 @@ void DoOperation() await CSVerify.VerifyAnalyzerAsync(test); } + + [Fact] + public async Task ExpressionLambda_ProducesNoDiagnostic() + { + string test = """ + using System; + using System.Linq.Expressions; + using System.Threading.Tasks; + + interface ILogger + { + Task InfoAsync(string message); + } + + class MockVerifier + { + public static void Verify(Expression> expression) + { + } + } + + class Test + { + void TestMethod() + { + var logger = new MockLogger(); + MockVerifier.Verify(x => x.InfoAsync("test")); + } + } + + class MockLogger : ILogger + { + public Task InfoAsync(string message) => Task.CompletedTask; + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task ExpressionFuncLambda_ProducesNoDiagnostic() + { + string test = """ + using System; + using System.Linq.Expressions; + using System.Threading.Tasks; + + class Test + { + void TestMethod() + { + SomeMethod(x => x.InfoAsync("test")); + } + + void SomeMethod(Expression> expression) + { + } + + Task InfoAsync(string message) => Task.CompletedTask; + } + + interface ILogger + { + Task InfoAsync(string message); + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task MoqLikeScenario_ProducesNoDiagnostic() + { + string test = """ + using System; + using System.Linq.Expressions; + using System.Threading.Tasks; + + interface ILogger + { + Task InfoAsync(string message); + } + + class Mock + { + public void Verify(Expression> expression, Times times, string message) + { + } + } + + enum Times + { + Never + } + + class Test + { + void TestMethod() + { + var mock = new Mock(); + mock.Verify(x => x.InfoAsync("test"), Times.Never, "No Log should have been written"); + } + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task DirectTaskCall_StillProducesDiagnostic() + { + string test = """ + using System.Threading.Tasks; + + class Test + { + void TestMethod() + { + // This should still trigger VSTHRD110 - direct call not in expression + [|TaskReturningMethod()|]; + } + + Task TaskReturningMethod() => Task.CompletedTask; + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task ExpressionAssignment_ProducesNoDiagnostic() + { + string test = """ + using System; + using System.Linq.Expressions; + using System.Threading.Tasks; + + interface ILogger + { + Task InfoAsync(string message); + } + + class Test + { + void TestMethod() + { + // Assignment to Expression<> variable should not trigger VSTHRD110 + Expression> expr = x => x.InfoAsync("test"); + } + } + """; + + await CSVerify.VerifyAnalyzerAsync(test); + } } From b793c491dc98207d5815478b4c021afa5a655e8d Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Jun 2025 08:15:27 -0700 Subject: [PATCH 1363/1753] Merge pull request #1466 from microsoft/copilot/fix-1128 Document InvalidOperationException for AsyncReaderWriterLock acquisition methods --- .../AsyncReaderWriterLock.cs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index 5ada7bbec..8abf33a65 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -414,6 +414,7 @@ protected virtual bool IsUnsupportedSynchronizationContext /// a canceled token will cause the code that is waiting for the lock to resume with an . /// /// An awaitable object whose result is the lock releaser. + /// Thrown when has been called and this is a new top-level lock request. public Awaitable ReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) { return new Awaitable(this, LockKind.Read, LockFlags.None, cancellationToken); @@ -428,13 +429,14 @@ protected virtual bool IsUnsupportedSynchronizationContext /// a canceled token will cause the code that is waiting for the lock to resume with an . /// /// An awaitable object whose result is the lock releaser. + /// Thrown when has been called and this is a new top-level lock request. public Awaitable UpgradeableReadLockAsync(CancellationToken cancellationToken = default(CancellationToken)) { return new Awaitable(this, LockKind.UpgradeableRead, LockFlags.None, cancellationToken); } /// - /// Obtains a read lock, asynchronously awaiting for the lock if it is not immediately available. + /// Obtains an upgradeable read lock, asynchronously awaiting for the lock if it is not immediately available. /// /// Modifications to normal lock behavior. /// @@ -443,6 +445,7 @@ protected virtual bool IsUnsupportedSynchronizationContext /// a canceled token will cause the code that is waiting for the lock to resume with an . /// /// An awaitable object whose result is the lock releaser. + /// Thrown when has been called and this is a new top-level lock request. public Awaitable UpgradeableReadLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) { return new Awaitable(this, LockKind.UpgradeableRead, options, cancellationToken); @@ -457,6 +460,7 @@ protected virtual bool IsUnsupportedSynchronizationContext /// a canceled token will cause the code that is waiting for the lock to resume with an . /// /// An awaitable object whose result is the lock releaser. + /// Thrown when has been called and this is a new top-level lock request. public Awaitable WriteLockAsync(CancellationToken cancellationToken = default(CancellationToken)) { return new Awaitable(this, LockKind.Write, LockFlags.None, cancellationToken); @@ -472,6 +476,7 @@ protected virtual bool IsUnsupportedSynchronizationContext /// a canceled token will cause the code that is waiting for the lock to resume with an . /// /// An awaitable object whose result is the lock releaser. + /// Thrown when has been called and this is a new top-level lock request. public Awaitable WriteLockAsync(LockFlags options, CancellationToken cancellationToken = default(CancellationToken)) { return new Awaitable(this, LockKind.Write, options, cancellationToken); From d99d64b512e542cbead4cae60419a1d04a95093a Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Jun 2025 08:17:08 -0700 Subject: [PATCH 1364/1753] Merge pull request #1465 from microsoft/copilot/fix-1464 Add AdditionalFiles support to VSTHRD103 analyzer for excluding specific APIs --- docfx/analyzers/VSTHRD103.md | 9 ++++ docfx/analyzers/configuration.md | 13 +++++ .../VSTHRD103UseAsyncOptionAnalyzer.cs | 47 ++++++++++++++----- .../CommonInterest.cs | 1 + ...yncMethodsToExcludeFromVSTHRD103.mocks.txt | 2 + .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 47 +++++++++++++++++++ 6 files changed, 108 insertions(+), 11 deletions(-) create mode 100644 test/Microsoft.VisualStudio.Threading.Analyzers.Tests/AdditionalFiles/vs-threading.SyncMethodsToExcludeFromVSTHRD103.mocks.txt diff --git a/docfx/analyzers/VSTHRD103.md b/docfx/analyzers/VSTHRD103.md index 348032057..120310cf3 100644 --- a/docfx/analyzers/VSTHRD103.md +++ b/docfx/analyzers/VSTHRD103.md @@ -27,3 +27,12 @@ async Task DoAsync() await file.ReadAsync(buffer, 0, 10); } ``` + +## Configuration + +This analyzer can be configured to exclude specific APIs from generating diagnostics. +Some APIs may have async versions that are less efficient or inappropriate for certain use cases. + +See our [configuration](configuration.md) topic to learn how to exclude specific methods +using the `vs-threading.SyncMethodsToExcludeFromVSTHRD103.txt` file. +``` diff --git a/docfx/analyzers/configuration.md b/docfx/analyzers/configuration.md index 75d63c693..77acf4d82 100644 --- a/docfx/analyzers/configuration.md +++ b/docfx/analyzers/configuration.md @@ -79,3 +79,16 @@ thread. **Line format:** `[Namespace.TypeName]::MethodName` **Sample:** `[System.Windows.Threading.Dispatcher]::Invoke` + +## Methods to exclude from VSTHRD103 checks + +The VSTHRD103 analyzer flags calls to synchronous methods where asynchronous equivalents exist, +when in an async context. Sometimes certain APIs have async versions but those async versions +are significantly slower, less efficient, or simply not preferred. These methods can be +excluded from VSTHRD103 analysis by specifying them in a configuration file. + +**Filename:** `vs-threading.SyncMethodsToExcludeFromVSTHRD103.txt` + +**Line format:** `[Namespace.TypeName]::MethodName` + +**Sample:** `[System.Data.SqlClient.SqlDataReader]::Read` diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index 46cde9c5a..547ac2d81 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -68,26 +68,39 @@ public override void Initialize(AnalysisContext context) context.EnableConcurrentExecution(); context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze); - context.RegisterCodeBlockStartAction(ctxt => + context.RegisterCompilationStartAction(compilationStartContext => { - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); - ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(MethodAnalyzer.AnalyzeConditionalAccessExpression), SyntaxKind.ConditionalAccessExpression); + var excludedMethods = CommonInterest.ReadMethods(compilationStartContext.Options, CommonInterest.FileNamePatternForSyncMethodsToExcludeFromVSTHRD103, compilationStartContext.CancellationToken).ToImmutableArray(); + + compilationStartContext.RegisterCodeBlockStartAction(ctxt => + { + var methodAnalyzer = new MethodAnalyzer(excludedMethods); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeInvocation), SyntaxKind.InvocationExpression); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzePropertyGetter), SyntaxKind.SimpleMemberAccessExpression); + ctxt.RegisterSyntaxNodeAction(Utils.DebuggableWrapper(methodAnalyzer.AnalyzeConditionalAccessExpression), SyntaxKind.ConditionalAccessExpression); + }); }); } private class MethodAnalyzer { - internal static void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) + private readonly ImmutableArray excludedMethods; + + public MethodAnalyzer(ImmutableArray excludedMethods) + { + this.excludedMethods = excludedMethods; + } + + internal void AnalyzePropertyGetter(SyntaxNodeAnalysisContext context) { var memberAccessSyntax = (MemberAccessExpressionSyntax)context.Node; if (IsInTaskReturningMethodOrDelegate(context)) { - InspectMemberAccess(context, memberAccessSyntax.Name, CommonInterest.SyncBlockingProperties); + this.InspectMemberAccess(context, memberAccessSyntax.Name, CommonInterest.SyncBlockingProperties); } } - internal static void AnalyzeConditionalAccessExpression(SyntaxNodeAnalysisContext context) + internal void AnalyzeConditionalAccessExpression(SyntaxNodeAnalysisContext context) { var conditionalAccessSyntax = (ConditionalAccessExpressionSyntax)context.Node; if (IsInTaskReturningMethodOrDelegate(context)) @@ -97,17 +110,17 @@ internal static void AnalyzeConditionalAccessExpression(SyntaxNodeAnalysisContex MemberBindingExpressionSyntax bindingExpr => bindingExpr.Name, _ => conditionalAccessSyntax.WhenNotNull, }; - InspectMemberAccess(context, rightSide, CommonInterest.SyncBlockingProperties); + this.InspectMemberAccess(context, rightSide, CommonInterest.SyncBlockingProperties); } } - internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) + internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) { if (IsInTaskReturningMethodOrDelegate(context)) { var invocationExpressionSyntax = (InvocationExpressionSyntax)context.Node; var memberAccessSyntax = invocationExpressionSyntax.Expression as MemberAccessExpressionSyntax; - if (memberAccessSyntax is not null && InspectMemberAccess(context, memberAccessSyntax.Name, CommonInterest.SyncBlockingMethods)) + if (memberAccessSyntax is not null && this.InspectMemberAccess(context, memberAccessSyntax.Name, CommonInterest.SyncBlockingMethods)) { // Don't return double-diagnostics. return; @@ -134,6 +147,12 @@ internal static void AnalyzeInvocation(SyntaxNodeAnalysisContext context) && m.Name != invocationDeclaringMethod?.Identifier.Text && m.HasAsyncCompatibleReturnType()) { + // Check if this method is excluded from VSTHRD103 diagnostics + if (this.excludedMethods.Contains(methodSymbol)) + { + return; + } + // An async alternative exists. ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(AsyncMethodKeyName, asyncMethodName); @@ -197,7 +216,7 @@ private static bool IsInTaskReturningMethodOrDelegate(SyntaxNodeAnalysisContext return methodSymbol?.HasAsyncCompatibleReturnType() is true; } - private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, ExpressionSyntax memberName, IEnumerable problematicMethods) + private bool InspectMemberAccess(SyntaxNodeAnalysisContext context, ExpressionSyntax memberName, IEnumerable problematicMethods) { ISymbol? memberSymbol = context.SemanticModel.GetSymbolInfo(memberName, context.CancellationToken).Symbol; if (memberSymbol is object) @@ -206,6 +225,12 @@ private static bool InspectMemberAccess(SyntaxNodeAnalysisContext context, Expre { if (item.Method.IsMatch(memberSymbol)) { + // Check if this method is excluded from VSTHRD103 diagnostics + if (this.excludedMethods.Contains(memberSymbol)) + { + return false; + } + Location? location = memberName.GetLocation(); ImmutableDictionary? properties = ImmutableDictionary.Empty .Add(ExtensionMethodNamespaceKeyName, item.ExtensionMethodNamespace is object ? string.Join(".", item.ExtensionMethodNamespace) : string.Empty); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index ef21f9f90..82e17d2e5 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -25,6 +25,7 @@ public static class CommonInterest public static readonly Regex FileNamePatternForMembersRequiringMainThread = new Regex(@"^vs-threading\.MembersRequiringMainThread(\..*)?.txt$", FileNamePatternRegexOptions); public static readonly Regex FileNamePatternForMethodsThatAssertMainThread = new Regex(@"^vs-threading\.MainThreadAssertingMethods(\..*)?.txt$", FileNamePatternRegexOptions); public static readonly Regex FileNamePatternForMethodsThatSwitchToMainThread = new Regex(@"^vs-threading\.MainThreadSwitchingMethods(\..*)?.txt$", FileNamePatternRegexOptions); + public static readonly Regex FileNamePatternForSyncMethodsToExcludeFromVSTHRD103 = new Regex(@"^vs-threading\.SyncMethodsToExcludeFromVSTHRD103(\..*)?.txt$", FileNamePatternRegexOptions); public static readonly IEnumerable JTFSyncBlockers = new[] { diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/AdditionalFiles/vs-threading.SyncMethodsToExcludeFromVSTHRD103.mocks.txt b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/AdditionalFiles/vs-threading.SyncMethodsToExcludeFromVSTHRD103.mocks.txt new file mode 100644 index 000000000..491c94c55 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/AdditionalFiles/vs-threading.SyncMethodsToExcludeFromVSTHRD103.mocks.txt @@ -0,0 +1,2 @@ +# Test exclusions for VSTHRD103 analyzer +[TestNamespace.TestClass]::SlowSyncMethod \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index b4ff2da62..3e6413088 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -1339,6 +1339,53 @@ void Bar() {} await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task SyncMethodCallInAsyncMethod_ExcludedViaAdditionalFiles_GeneratesNoWarning() + { + var test = @" +using System.Threading.Tasks; + +class Test { + async Task T() { + TestNamespace.TestClass.SlowSyncMethod(); + } +} + +namespace TestNamespace { + class TestClass { + public static void SlowSyncMethod() { } + public static Task SlowSyncMethodAsync() => Task.CompletedTask; + } +} +"; + + // No diagnostic expected because SlowSyncMethod is excluded via AdditionalFiles + await CSVerify.VerifyAnalyzerAsync(test); + } + + [Fact] + public async Task SyncMethodCallInAsyncMethod_NotExcludedViaAdditionalFiles_GeneratesWarning() + { + var test = @" +using System.Threading.Tasks; + +class Test { + async Task T() { + TestNamespace.TestClass.{|#0:NotExcludedMethod|}(); + } +} + +namespace TestNamespace { + class TestClass { + public static void NotExcludedMethod() { } + public static Task NotExcludedMethodAsync() => Task.CompletedTask; + } +} +"; + + await CSVerify.VerifyAnalyzerAsync(test, CSVerify.Diagnostic(Descriptor).WithLocation(0).WithArguments("NotExcludedMethod", "NotExcludedMethodAsync")); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName) => CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(line, column, line, column + length).WithArguments(methodName); From 4e511afa763d5fd001f92d2dc92a7ea8dd5ce8e9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Jun 2025 14:12:11 -0600 Subject: [PATCH 1365/1753] Add copilot swe agent setup instructions (#377) --- .github/workflows/copilot-setup-steps.yml | 41 +++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/copilot-setup-steps.yml diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml new file mode 100644 index 000000000..bb149d651 --- /dev/null +++ b/.github/workflows/copilot-setup-steps.yml @@ -0,0 +1,41 @@ +name: "Copilot Setup Steps" + +# Automatically run the setup steps when they are changed to allow for easy validation, and +# allow manual testing through the repository's "Actions" tab +on: + workflow_dispatch: + push: + branches: + - main + paths: + - .github/workflows/copilot-setup-steps.yml + pull_request: + paths: + - .github/workflows/copilot-setup-steps.yml + +jobs: + # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot. + copilot-setup-steps: + runs-on: ubuntu-latest + # Set the permissions to the lowest permissions possible needed for your steps. + # Copilot will be given its own token for its operations. + permissions: + # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete. + contents: read + + # You can define any steps you want, and they will run before the agent starts. + # If you do not check out your code, Copilot will do this for you. + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider + dotnet --info + + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } + shell: pwsh From 231dae9d7654ea546d0dc0eb6c9a9bb3774c12e6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Jun 2025 14:20:33 -0600 Subject: [PATCH 1366/1753] Touch-up name of github workflow --- .github/workflows/copilot-setup-steps.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index bb149d651..053f56e95 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -1,4 +1,4 @@ -name: "Copilot Setup Steps" +name: 💪🏼 Copilot Setup Steps # Automatically run the setup steps when they are changed to allow for easy validation, and # allow manual testing through the repository's "Actions" tab From f6217c2a72bb2edd662883795ff847a76b31beb3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Jun 2025 07:36:02 -0600 Subject: [PATCH 1367/1753] Bump MicroBuild to 2.0.198 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index f5cbaec6b..69917d402 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.187 + 2.0.198 From 0e6d59ccb2c15a14b09cef2fcab5b5e4322eda3d Mon Sep 17 00:00:00 2001 From: Skylar Nam Date: Wed, 18 Jun 2025 13:29:39 -0700 Subject: [PATCH 1368/1753] Enable PME signing for Library.Template --- azure-pipelines/build.yml | 3 +++ azure-pipelines/microbuild.before.yml | 1 + 2 files changed, 4 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index ff3bef406..1482140f1 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -118,6 +118,7 @@ jobs: zipSources: false ${{ if parameters.RealSign }}: signType: real + signWithProd: true ${{ else }}: signType: test sbom: @@ -223,6 +224,7 @@ jobs: signing: enabled: false # enable when building unique artifacts on this agent that must be signed signType: real + signWithProd: true outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: @@ -258,6 +260,7 @@ jobs: signing: enabled: false # enable when building unique artifacts on this agent that must be signed signType: real + signWithProd: true outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - ${{ each artifact_name in parameters.artifact_names }}: diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 05acd3194..07429bc79 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -44,6 +44,7 @@ steps: inputs: signType: Real zipSources: false + ConnectedPMEServiceName: 6cc74545-d7b9-4050-9dfa-ebefcc8961ea # devdiv's SC ID displayName: 🔧 Install MicroBuild Signing Plugin - ${{ if parameters.EnableLocalization }}: From ce93bede641735dc358b34a0d1c9776ff6181e9d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 18 Jun 2025 14:57:12 -0600 Subject: [PATCH 1369/1753] Fix expand-template.yml indentation --- azure-pipelines/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index ff3bef406..ca2cedb54 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -246,7 +246,7 @@ jobs: displayName: 💅 Verify formatted code env: dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - - template: expand-template.yml + - template: expand-template.yml - ${{ if parameters.EnableMacOSBuild }}: - job: macOS From c2fbe77eddffb787c965abf12ff71dea05f0b3cb Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 19 Jun 2025 11:43:13 -0700 Subject: [PATCH 1370/1753] Migrate renovate config (#1453) * Migrate config .github/renovate.json * Update renovate.json --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .github/renovate.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/renovate.json b/.github/renovate.json index 76fb3a524..b5dfac106 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -16,7 +16,7 @@ { "customType": "regex", "datasourceTemplate": "nuget", - "fileMatch": [ + "managerFilePatterns": [ "test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs" ], "matchStrings": [ From dd63cb05dac2a0e3647434404218fa6ed87da31a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 Jun 2025 17:36:18 -0600 Subject: [PATCH 1371/1753] Focus binskim on just the binaries we build --- azure-pipelines/build.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 215a17c35..b69a9f5c4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -141,6 +141,9 @@ jobs: - ${{ if parameters.EnableOptProf }}: - powershell: Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSDROPNAME]$(tools/variables/ProfilingInputsDropName.ps1)" displayName: ⚙ Set ProfilingInputsDropName for optprof + sdl: + binskim: + analyzeTargetGlob: $(Build.ArtifactStagingDirectory)\symbols-Windows\** outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: From 81ce4f6c1acd08e0d014734ebf806475fb46c2da Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 Jun 2025 15:48:42 -0600 Subject: [PATCH 1372/1753] Add trim and NativeAOT safety attributes This gets vs-threading to self-identify as a NativeAOT-ready assembly, and adds the attributes on the specific methods that are *not* safe. Incidentally, all the trim-unsafe methods are strictly for runtime diagnostics rather than critical functionality. --- Microsoft.VisualStudio.Threading.slnx | 1 + azure-pipelines/build.yml | 3 + azure-pipelines/dotnet.yml | 11 + ...cReaderWriterLock+HangReportContributor.cs | 11 +- .../IHangReportContributor.cs | 7 +- .../InternalUtilities.cs | 241 ----------------- ...inableTaskContext+HangReportContributor.cs | 6 +- .../JoinableTaskFactory.cs | 7 +- .../MemoryInspection.cs | 252 ++++++++++++++++++ .../Microsoft.VisualStudio.Threading.csproj | 3 + .../Reasons.cs | 9 + .../ThreadingEventSource.cs | 4 +- ...rosoft.VisualStudio.Threading.Tests.csproj | 9 +- .../NativeAOTCompatibility.csproj | 21 ++ test/NativeAOTCompatibility/Program.cs | 4 + 15 files changed, 328 insertions(+), 261 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading/MemoryInspection.cs create mode 100644 src/Microsoft.VisualStudio.Threading/Reasons.cs create mode 100644 test/NativeAOTCompatibility/NativeAOTCompatibility.csproj create mode 100644 test/NativeAOTCompatibility/Program.cs diff --git a/Microsoft.VisualStudio.Threading.slnx b/Microsoft.VisualStudio.Threading.slnx index 62b62e80b..c5f2e42b1 100644 --- a/Microsoft.VisualStudio.Threading.slnx +++ b/Microsoft.VisualStudio.Threading.slnx @@ -40,5 +40,6 @@ + diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 0f62763b6..d16bcb0cc 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -197,6 +197,7 @@ jobs: Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} IsOptProf: ${{ parameters.IsOptProf }} + osRID: win - ${{ if and(parameters.EnableDotNetFormatCheck, not(parameters.EnableLinuxBuild)) }}: - script: dotnet format --verify-no-changes @@ -241,6 +242,7 @@ jobs: parameters: Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} + osRID: linux - ${{ if parameters.EnableDotNetFormatCheck }}: - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code @@ -276,6 +278,7 @@ jobs: parameters: Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} + osRID: osx - job: WrapUp dependsOn: diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 2abca9eb2..8fc6e7d55 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -5,6 +5,8 @@ parameters: default: false - name: Is1ESPT type: boolean +- name: osRID + type: string steps: @@ -16,6 +18,15 @@ steps: displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) +- powershell: | + dotnet publish -f net9.0 -c Release -r ${{ parameters.osRID }}-x64 -warnaserror + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } + if (!($IsMacOS -or $IsLinux)) { + dotnet publish -f net9.0-windows -c Release -r ${{ parameters.osRID }}-x64 -warnaserror + } + displayName: 🧪 NativeAOT test + workingDirectory: test/NativeAOTCompatibility + - ${{ if parameters.IsOptProf }}: - script: dotnet pack src\VSInsertionMetadata -c $(BuildConfiguration) -warnaserror /bl:"$(Build.ArtifactStagingDirectory)/build_logs/VSInsertion-Pack.binlog" displayName: 🔧 dotnet pack VSInsertionMetadata diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs index cbed5dad5..08f4ffcbf 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock+HangReportContributor.cs @@ -3,11 +3,11 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Linq; using System.Text; using System.Threading; -using System.Threading.Tasks; using System.Xml.Linq; namespace Microsoft.VisualStudio.Threading @@ -46,6 +46,7 @@ protected internal virtual SynchronizationContext NoMessagePumpSynchronizationCo /// Contributes data for a hang report. /// /// The hang report contribution. Null values should be ignored. + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] HangReportContribution IHangReportContributor.GetHangReport() { return this.GetHangReport(); @@ -55,7 +56,8 @@ HangReportContribution IHangReportContributor.GetHangReport() /// Contributes data for a hang report. /// /// The hang report contribution. Null values should be ignored. - [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] + [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity"), SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] protected virtual HangReportContribution GetHangReport() { using (this.NoMessagePumpSynchronizationContext.Apply()) @@ -125,6 +127,7 @@ private static XDocument CreateDgml(out XElement nodes, out XElement links) /// /// Appends details of a given collection of awaiters to the hang report. /// + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] private static XElement CreateAwaiterNode(Awaiter awaiter) { Requires.NotNull(awaiter, nameof(awaiter)); @@ -211,9 +214,13 @@ public IEnumerable Categories { get { +#if NET + foreach (AwaiterCollection value in Enum.GetValues()) +#else #pragma warning disable CS8605 // Unboxing a possibly null value. foreach (AwaiterCollection value in Enum.GetValues(typeof(AwaiterCollection))) #pragma warning restore CS8605 // Unboxing a possibly null value. +#endif { if (this.Membership.HasFlag(value)) { diff --git a/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs index 7c320ff33..7b5cac146 100644 --- a/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/IHangReportContributor.cs @@ -1,11 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Diagnostics.CodeAnalysis; namespace Microsoft.VisualStudio.Threading; @@ -18,5 +14,6 @@ public interface IHangReportContributor /// Contributes data for a hang report. /// /// The hang report contribution. Null values should be ignored. + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] HangReportContribution GetHangReport(); } diff --git a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs index ad95047e6..f9eaba00a 100644 --- a/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs +++ b/src/Microsoft.VisualStudio.Threading/InternalUtilities.cs @@ -1,14 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System; -using System.Collections; using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Threading.Tasks; namespace Microsoft.VisualStudio.Threading; @@ -17,15 +10,6 @@ namespace Microsoft.VisualStudio.Threading; /// internal static class InternalUtilities { - /// - /// The substring that should be inserted before each async return stack frame. - /// - /// - /// When printing synchronous callstacks, .NET begins each frame with " at ". - /// When printing async return stack, we use this to indicate continuations. - /// - private const string AsyncReturnStackPrefix = " -> "; - /// /// Removes an element from the middle of a queue without disrupting the other elements. /// @@ -60,229 +44,4 @@ internal static bool RemoveMidQueue(this Queue queue, T valueToRemove) return found; } - - /// - /// Walk the continuation objects inside "async state machines" to generate the return call stack. - /// FOR DIAGNOSTIC PURPOSES ONLY. - /// - /// The delegate that represents the head of an async continuation chain. - internal static IEnumerable GetAsyncReturnStackFrames(this Delegate continuationDelegate) - { - IAsyncStateMachine? stateMachine = FindAsyncStateMachine(continuationDelegate); - if (stateMachine is null) - { - // Did not find the async state machine, so returns the method name as top frame and stop walking. - yield return GetDelegateLabel(continuationDelegate); - yield break; - } - - do - { - object? state = GetStateMachineFieldValueOnSuffix(stateMachine, "__state"); - yield return string.Format( - CultureInfo.CurrentCulture, - "{2}{0} (state: {1}, address: 0x{3:X8})", - stateMachine.GetType().FullName, - state, - AsyncReturnStackPrefix, - (long)GetAddress(stateMachine)); // the long cast allows hex formatting - - Delegate[]? continuationDelegates = FindContinuationDelegates(stateMachine).ToArray(); - if (continuationDelegates.Length == 0) - { - break; - } - - // Consider: It's possible but uncommon scenario to have multiple "async methods" being awaiting for one "async method". - // Here we just choose the first awaiting "async method" as that should be good enough for postmortem. - // In future we might want to revisit this to cover the other awaiting "async methods". - stateMachine = continuationDelegates.Select((d) => FindAsyncStateMachine(d)) - .FirstOrDefault((s) => s is object); - if (stateMachine is null) - { - yield return GetDelegateLabel(continuationDelegates.First()); - } - } - while (stateMachine is object); - } - - /// - /// A helper method to get the label of the given delegate. - /// - private static string GetDelegateLabel(Delegate invokeDelegate) - { - Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); - - MethodInfo? method = invokeDelegate.GetMethodInfo(); - if (invokeDelegate.Target is object) - { - string instanceType = string.Empty; - if (!(method?.DeclaringType?.Equals(invokeDelegate.Target.GetType()) ?? false)) - { - instanceType = " (" + invokeDelegate.Target.GetType().FullName + ")"; - } - - return string.Format( - CultureInfo.CurrentCulture, - "{3}{0}.{1}{2} (target address: 0x{4:X" + (IntPtr.Size * 2) + "})", - method?.DeclaringType?.FullName, - method?.Name, - instanceType, - AsyncReturnStackPrefix, - GetAddress(invokeDelegate.Target).ToInt64()); // the cast allows hex formatting - } - - return string.Format( - CultureInfo.CurrentCulture, - "{2}{0}.{1}", - method?.DeclaringType?.FullName, - method?.Name, - AsyncReturnStackPrefix); - } - - /// - /// Gets the memory address of a given object. - /// - /// The object to get the address for. - /// The memory address. - /// - /// This method works when GCHandle will refuse because the type of object is a non-blittable type. - /// However, this method provides no guarantees that the address will remain valid for the caller, - /// so it is only useful for diagnostics and when we don't expect addresses to be changing much any more. - /// - private static unsafe IntPtr GetAddress(object value) => new IntPtr(Unsafe.AsPointer(ref value)); - - /// - /// A helper method to find the async state machine from the given delegate. - /// - private static IAsyncStateMachine? FindAsyncStateMachine(Delegate invokeDelegate) - { - Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); - - if (invokeDelegate.Target is object) - { - // Some delegates are wrapped with a ContinuationWrapper object. We have to unwrap that in those cases. - // In testing, this m_continuation field jump is only required when the debugger is attached -- weird. - // I suspect however that it's a natural behavior of the async state machine (when there are >1 continuations perhaps). - // So we check for the case in all cases. - if (GetFieldValue(invokeDelegate.Target, "m_continuation") is Action continuation) - { - invokeDelegate = continuation; - if (invokeDelegate.Target is null) - { - return null; - } - } - - var stateMachine = GetFieldValue(invokeDelegate.Target, "m_stateMachine") as IAsyncStateMachine; - return stateMachine; - } - - return null; - } - - /// - /// This is the core to find the continuation delegate(s) inside the given async state machine. - /// The chain of objects is like this: async state machine -> async method builder -> task -> continuation object -> action. - /// - /// - /// There are 3 types of "async method builder": AsyncVoidMethodBuilder, AsyncTaskMethodBuilder, AsyncTaskMethodBuilder<T>. - /// We don't cover AsyncVoidMethodBuilder as it is used rarely and it can't be awaited either; - /// AsyncTaskMethodBuilder is a wrapper on top of AsyncTaskMethodBuilder<VoidTaskResult>. - /// - private static IEnumerable FindContinuationDelegates(IAsyncStateMachine stateMachine) - { - Requires.NotNull(stateMachine, nameof(stateMachine)); - - object? builder = GetStateMachineFieldValueOnSuffix(stateMachine, "__builder"); - if (builder is null) - { - yield break; - } - - object? task = GetFieldValue(builder, "m_task"); - if (task is null) - { - // Probably this builder is an instance of "AsyncTaskMethodBuilder", so we need to get its inner "AsyncTaskMethodBuilder" - builder = GetFieldValue(builder, "m_builder"); - if (builder is object) - { - task = GetFieldValue(builder, "m_task"); - } - } - - if (task is null) - { - yield break; - } - - // "task" might be an instance of the type deriving from "Task", but "m_continuationObject" is a private field in "Task", - // so we need to use "typeof(Task)" to access "m_continuationObject". - FieldInfo? continuationField = typeof(Task).GetTypeInfo().GetDeclaredField("m_continuationObject"); - if (continuationField is null) - { - yield break; - } - - object? continuationObject = continuationField.GetValue(task); - if (continuationObject is null) - { - yield break; - } - - if (continuationObject is IEnumerable items) - { - foreach (object? item in items) - { - Delegate? action = item as Delegate ?? GetFieldValue(item!, "m_action") as Delegate; - if (action is object) - { - yield return action; - } - } - } - else - { - Delegate? action = continuationObject as Delegate ?? GetFieldValue(continuationObject, "m_action") as Delegate; - if (action is object) - { - yield return action; - } - } - } - - /// - /// A helper method to get field's value given the object and the field name. - /// - private static object? GetFieldValue(object obj, string fieldName) - { - Requires.NotNull(obj, nameof(obj)); - Requires.NotNullOrEmpty(fieldName, nameof(fieldName)); - - FieldInfo? field = obj.GetType().GetTypeInfo().GetDeclaredField(fieldName); - if (field is object) - { - return field.GetValue(obj); - } - - return null; - } - - /// - /// The field names of "async state machine" are not fixed; the workaround is to find the field based on the suffix. - /// - private static object? GetStateMachineFieldValueOnSuffix(IAsyncStateMachine stateMachine, string suffix) - { - Requires.NotNull(stateMachine, nameof(stateMachine)); - Requires.NotNullOrEmpty(suffix, nameof(suffix)); - - IEnumerable? fields = stateMachine.GetType().GetTypeInfo().DeclaredFields; - FieldInfo? field = fields.FirstOrDefault((f) => f.Name.EndsWith(suffix, StringComparison.Ordinal)); - if (field is object) - { - return field.GetValue(stateMachine); - } - - return null; - } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs index 7f96afed4..caad35d6c 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext+HangReportContributor.cs @@ -3,10 +3,10 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Globalization; using System.Linq; using System.Text; -using System.Threading.Tasks; using System.Xml.Linq; namespace Microsoft.VisualStudio.Threading; @@ -17,6 +17,7 @@ public partial class JoinableTaskContext : IHangReportContributor /// Contributes data for a hang report. /// /// The hang report contribution. + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] HangReportContribution IHangReportContributor.GetHangReport() { return this.GetHangReport(); @@ -26,6 +27,7 @@ HangReportContribution IHangReportContributor.GetHangReport() /// Contributes data for a hang report. /// /// The hang report contribution. Null values should be ignored. + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] protected virtual HangReportContribution GetHangReport() { using (this.NoMessagePumpSynchronizationContext.Apply()) @@ -116,6 +118,7 @@ private static Dictionary CreateNodesForJoinab return result; } + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] private static List> CreateNodeLabels(Dictionary tasksAndElements) { Requires.NotNull(tasksAndElements, nameof(tasksAndElements)); @@ -146,6 +149,7 @@ private static List> CreateNodeLabels(Dictionary internal string DelegateLabel { + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] get { return this.WalkAsyncReturnStackFrames().First(); // Top frame of the return callstack. @@ -1214,6 +1210,7 @@ internal void RemoveExecutingCallback(JoinableTask.ExecutionQueue callbackReceiv /// Walk the continuation objects inside "async state machines" to generate the return callstack. /// FOR DIAGNOSTIC PURPOSES ONLY. /// + [RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] internal IEnumerable WalkAsyncReturnStackFrames() { // This instance might be a wrapper of another instance of "SingleExecuteProtector". diff --git a/src/Microsoft.VisualStudio.Threading/MemoryInspection.cs b/src/Microsoft.VisualStudio.Threading/MemoryInspection.cs new file mode 100644 index 000000000..b9f9ca85b --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/MemoryInspection.cs @@ -0,0 +1,252 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Globalization; +using System.Linq; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Threading.Tasks; + +namespace Microsoft.VisualStudio.Threading; + +[RequiresUnreferencedCode(Reasons.DiagnosticAnalysisOnly)] +internal static class MemoryInspection +{ + /// + /// The substring that should be inserted before each async return stack frame. + /// + /// + /// When printing synchronous callstacks, .NET begins each frame with " at ". + /// When printing async return stack, we use this to indicate continuations. + /// + private const string AsyncReturnStackPrefix = " -> "; + + /// + /// Walk the continuation objects inside "async state machines" to generate the return call stack. + /// FOR DIAGNOSTIC PURPOSES ONLY. + /// + /// The delegate that represents the head of an async continuation chain. + internal static IEnumerable GetAsyncReturnStackFrames(this Delegate continuationDelegate) + { + IAsyncStateMachine? stateMachine = FindAsyncStateMachine(continuationDelegate); + if (stateMachine is null) + { + // Did not find the async state machine, so returns the method name as top frame and stop walking. + yield return GetDelegateLabel(continuationDelegate); + yield break; + } + + do + { + object? state = GetStateMachineFieldValueOnSuffix(stateMachine, "__state"); + yield return string.Format( + CultureInfo.CurrentCulture, + "{2}{0} (state: {1}, address: 0x{3:X8})", + stateMachine.GetType().FullName, + state, + AsyncReturnStackPrefix, + (long)GetAddress(stateMachine)); // the long cast allows hex formatting + + Delegate[]? continuationDelegates = FindContinuationDelegates(stateMachine).ToArray(); + if (continuationDelegates.Length == 0) + { + break; + } + + // Consider: It's possible but uncommon scenario to have multiple "async methods" being awaiting for one "async method". + // Here we just choose the first awaiting "async method" as that should be good enough for postmortem. + // In future we might want to revisit this to cover the other awaiting "async methods". + stateMachine = continuationDelegates.Select((d) => FindAsyncStateMachine(d)) + .FirstOrDefault((s) => s is object); + if (stateMachine is null) + { + yield return GetDelegateLabel(continuationDelegates.First()); + } + } + while (stateMachine is object); + } + + /// + /// A helper method to get the label of the given delegate. + /// + private static string GetDelegateLabel(Delegate invokeDelegate) + { + Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); + + MethodInfo? method = invokeDelegate.GetMethodInfo(); + if (invokeDelegate.Target is object) + { + string instanceType = string.Empty; + if (!(method?.DeclaringType?.Equals(invokeDelegate.Target.GetType()) ?? false)) + { + instanceType = " (" + invokeDelegate.Target.GetType().FullName + ")"; + } + + return string.Format( + CultureInfo.CurrentCulture, + "{3}{0}.{1}{2} (target address: 0x{4:X" + (IntPtr.Size * 2) + "})", + method?.DeclaringType?.FullName, + method?.Name, + instanceType, + AsyncReturnStackPrefix, + GetAddress(invokeDelegate.Target).ToInt64()); // the cast allows hex formatting + } + + return string.Format( + CultureInfo.CurrentCulture, + "{2}{0}.{1}", + method?.DeclaringType?.FullName, + method?.Name, + AsyncReturnStackPrefix); + } + + /// + /// A helper method to find the async state machine from the given delegate. + /// + private static IAsyncStateMachine? FindAsyncStateMachine(Delegate invokeDelegate) + { + Requires.NotNull(invokeDelegate, nameof(invokeDelegate)); + + if (invokeDelegate.Target is object) + { + // Some delegates are wrapped with a ContinuationWrapper object. We have to unwrap that in those cases. + // In testing, this m_continuation field jump is only required when the debugger is attached -- weird. + // I suspect however that it's a natural behavior of the async state machine (when there are >1 continuations perhaps). + // So we check for the case in all cases. + if (GetFieldValue(invokeDelegate.Target, "m_continuation") is Action continuation) + { + invokeDelegate = continuation; + if (invokeDelegate.Target is null) + { + return null; + } + } + + var stateMachine = GetFieldValue(invokeDelegate.Target, "m_stateMachine") as IAsyncStateMachine; + return stateMachine; + } + + return null; + } + + /// + /// This is the core to find the continuation delegate(s) inside the given async state machine. + /// The chain of objects is like this: async state machine -> async method builder -> task -> continuation object -> action. + /// + /// + /// There are 3 types of "async method builder": AsyncVoidMethodBuilder, AsyncTaskMethodBuilder, AsyncTaskMethodBuilder<T>. + /// We don't cover AsyncVoidMethodBuilder as it is used rarely and it can't be awaited either; + /// AsyncTaskMethodBuilder is a wrapper on top of AsyncTaskMethodBuilder<VoidTaskResult>. + /// + private static IEnumerable FindContinuationDelegates(IAsyncStateMachine stateMachine) + { + Requires.NotNull(stateMachine, nameof(stateMachine)); + + object? builder = GetStateMachineFieldValueOnSuffix(stateMachine, "__builder"); + if (builder is null) + { + yield break; + } + + object? task = GetFieldValue(builder, "m_task"); + if (task is null) + { + // Probably this builder is an instance of "AsyncTaskMethodBuilder", so we need to get its inner "AsyncTaskMethodBuilder" + builder = GetFieldValue(builder, "m_builder"); + if (builder is object) + { + task = GetFieldValue(builder, "m_task"); + } + } + + if (task is null) + { + yield break; + } + + // "task" might be an instance of the type deriving from "Task", but "m_continuationObject" is a private field in "Task", + // so we need to use "typeof(Task)" to access "m_continuationObject". + FieldInfo? continuationField = typeof(Task).GetTypeInfo().GetDeclaredField("m_continuationObject"); + if (continuationField is null) + { + yield break; + } + + object? continuationObject = continuationField.GetValue(task); + if (continuationObject is null) + { + yield break; + } + + if (continuationObject is IEnumerable items) + { + foreach (object? item in items) + { + Delegate? action = item as Delegate ?? GetFieldValue(item!, "m_action") as Delegate; + if (action is object) + { + yield return action; + } + } + } + else + { + Delegate? action = continuationObject as Delegate ?? GetFieldValue(continuationObject, "m_action") as Delegate; + if (action is object) + { + yield return action; + } + } + } + + /// + /// A helper method to get field's value given the object and the field name. + /// + private static object? GetFieldValue(object obj, string fieldName) + { + Requires.NotNull(obj, nameof(obj)); + Requires.NotNullOrEmpty(fieldName, nameof(fieldName)); + + FieldInfo? field = obj.GetType().GetTypeInfo().GetDeclaredField(fieldName); + if (field is object) + { + return field.GetValue(obj); + } + + return null; + } + + /// + /// The field names of "async state machine" are not fixed; the workaround is to find the field based on the suffix. + /// + private static object? GetStateMachineFieldValueOnSuffix(IAsyncStateMachine stateMachine, string suffix) + { + Requires.NotNull(stateMachine, nameof(stateMachine)); + Requires.NotNullOrEmpty(suffix, nameof(suffix)); + + IEnumerable? fields = stateMachine.GetType().GetTypeInfo().DeclaredFields; + FieldInfo? field = fields.FirstOrDefault((f) => f.Name.EndsWith(suffix, StringComparison.Ordinal)); + if (field is object) + { + return field.GetValue(stateMachine); + } + + return null; + } + + /// + /// Gets the memory address of a given object. + /// + /// The object to get the address for. + /// The memory address. + /// + /// This method works when GCHandle will refuse because the type of object is a non-blittable type. + /// However, this method provides no guarantees that the address will remain valid for the caller, + /// so it is only useful for diagnostics and when we don't expect addresses to be changing much any more. + /// + private static unsafe IntPtr GetAddress(object value) => new IntPtr(Unsafe.AsPointer(ref value)); +} diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 3e5321d89..14acd335d 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -7,6 +7,9 @@ Use the Microsoft.VisualStudio.Threading package to get the library and analyzers together. true + + true + true true diff --git a/src/Microsoft.VisualStudio.Threading/Reasons.cs b/src/Microsoft.VisualStudio.Threading/Reasons.cs new file mode 100644 index 000000000..8d8189e95 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading/Reasons.cs @@ -0,0 +1,9 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +namespace Microsoft.VisualStudio.Threading; + +internal static class Reasons +{ + internal const string DiagnosticAnalysisOnly = "This API performs analysis of runtime objects for diagnostic purposes only, and isn't required for correct functionality."; +} diff --git a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs index 890718f74..59ae498a6 100644 --- a/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs +++ b/src/Microsoft.VisualStudio.Threading/ThreadingEventSource.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System; +using System.Diagnostics.CodeAnalysis; using System.Diagnostics.Tracing; namespace Microsoft.VisualStudio.Threading; @@ -104,6 +104,7 @@ public void WaitReaderWriterLockStop(int lockId, AsyncReaderWriterLock.LockKind /// Hash code of the task. /// Whether the task is on the main thread. [Event(CompleteOnCurrentThreadStartEvent)] + [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "We're only serializing primitive types.")] public void CompleteOnCurrentThreadStart(int taskId, bool isOnMainThread) { this.WriteEvent(CompleteOnCurrentThreadStartEvent, taskId, Boxed.Box(isOnMainThread)); @@ -143,6 +144,7 @@ public void WaitSynchronouslyStop() /// The request id. /// The execution need happen on the main thread. [Event(PostExecutionStartEvent, Level = EventLevel.Verbose)] + [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "We're only serializing primitive types.")] public void PostExecutionStart(int requestId, bool mainThreadAffinitized) { this.WriteEvent(PostExecutionStartEvent, requestId, Boxed.Box(mainThreadAffinitized)); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index b4bc53556..b17c4787e 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -22,8 +22,7 @@ RarelyRemoveItemSet`1.cs - + WeakKeyDictionary`2.cs @@ -39,8 +38,7 @@ - + @@ -48,8 +46,7 @@ true - + false true diff --git a/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj b/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj new file mode 100644 index 000000000..47a89a6d7 --- /dev/null +++ b/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj @@ -0,0 +1,21 @@ + + + + Exe + net9.0 + true + false + + + $(TargetFrameworks);net9.0-windows + + + + + + + + + + + diff --git a/test/NativeAOTCompatibility/Program.cs b/test/NativeAOTCompatibility/Program.cs new file mode 100644 index 000000000..0c1d2e38a --- /dev/null +++ b/test/NativeAOTCompatibility/Program.cs @@ -0,0 +1,4 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +System.Console.WriteLine("This test is run by \"dotnet publish -c release -r [RID]-x64\" rather than by executing the program."); From c8124cf9002d6df309941c9f7dcbfe42d68f14a9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 Jun 2025 17:31:00 -0600 Subject: [PATCH 1373/1753] Consolidate build and NativeAOT publish --- Directory.Build.props | 13 +++++++++++++ Directory.Build.targets | 2 ++ Directory.Traversal.targets | 15 +++++++++++++++ Microsoft.VisualStudio.Threading.slnx | 7 +++++++ azure-pipelines/dotnet.yml | 11 +---------- global.json | 3 ++- src/dirs.proj | 5 +++++ test/AOT.props | 16 ++++++++++++++++ .../NativeAOTCompatibility.csproj | 4 +--- test/dirs.proj | 8 ++++++++ tools/dirs.proj | 6 ++++++ 11 files changed, 76 insertions(+), 14 deletions(-) create mode 100644 Directory.Traversal.targets create mode 100644 src/dirs.proj create mode 100644 test/AOT.props create mode 100644 test/dirs.proj create mode 100644 tools/dirs.proj diff --git a/Directory.Build.props b/Directory.Build.props index 30f2da1db..ca9be7049 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -41,6 +41,19 @@ 16.9 + + win + linux + osx + + x64 + arm64 + + $(RidOsPrefix)-$(RidOsArchitecture) + + $(DefaultRuntimeIdentifier) + + diff --git a/Directory.Build.targets b/Directory.Build.targets index b4afce0a7..dbcb085dc 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -4,4 +4,6 @@ + + diff --git a/Directory.Traversal.targets b/Directory.Traversal.targets new file mode 100644 index 000000000..805bd6e92 --- /dev/null +++ b/Directory.Traversal.targets @@ -0,0 +1,15 @@ + + + true + + false + false + true + true + + + + + + diff --git a/Microsoft.VisualStudio.Threading.slnx b/Microsoft.VisualStudio.Threading.slnx index c5f2e42b1..c7243f9f5 100644 --- a/Microsoft.VisualStudio.Threading.slnx +++ b/Microsoft.VisualStudio.Threading.slnx @@ -11,16 +11,21 @@ + + + + + @@ -33,8 +38,10 @@ + + diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 8fc6e7d55..f9ca66e10 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -10,7 +10,7 @@ parameters: steps: -- script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904,LOCTASK002 /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" +- script: dotnet build tools/dirs.proj -t:build,pack,publish --no-restore -c $(BuildConfiguration) -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904,LOCTASK002 /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: 🛠 dotnet build - ${{ if not(parameters.IsOptProf) }}: @@ -18,15 +18,6 @@ steps: displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) -- powershell: | - dotnet publish -f net9.0 -c Release -r ${{ parameters.osRID }}-x64 -warnaserror - if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - if (!($IsMacOS -or $IsLinux)) { - dotnet publish -f net9.0-windows -c Release -r ${{ parameters.osRID }}-x64 -warnaserror - } - displayName: 🧪 NativeAOT test - workingDirectory: test/NativeAOTCompatibility - - ${{ if parameters.IsOptProf }}: - script: dotnet pack src\VSInsertionMetadata -c $(BuildConfiguration) -warnaserror /bl:"$(Build.ArtifactStagingDirectory)/build_logs/VSInsertion-Pack.binlog" displayName: 🔧 dotnet pack VSInsertionMetadata diff --git a/global.json b/global.json index 6e89f4181..5fce40099 100644 --- a/global.json +++ b/global.json @@ -6,6 +6,7 @@ }, "msbuild-sdks": { "MSBuild.Sdk.Extras": "3.0.44", - "Microsoft.Build.NoTargets": "3.7.56" + "Microsoft.Build.NoTargets": "3.7.56", + "Microsoft.Build.Traversal": "4.1.82" } } diff --git a/src/dirs.proj b/src/dirs.proj new file mode 100644 index 000000000..b6fa81f93 --- /dev/null +++ b/src/dirs.proj @@ -0,0 +1,5 @@ + + + + + diff --git a/test/AOT.props b/test/AOT.props new file mode 100644 index 000000000..27d5cbf21 --- /dev/null +++ b/test/AOT.props @@ -0,0 +1,16 @@ + + + Exe + true + true + true + $(AvailableRuntimeIdentifiers) + $(DefaultRuntimeIdentifier) + + + + + RuntimeIdentifier + + + diff --git a/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj b/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj index 47a89a6d7..f663beb88 100644 --- a/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj +++ b/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj @@ -1,9 +1,7 @@ - + - Exe net9.0 - true false diff --git a/test/dirs.proj b/test/dirs.proj new file mode 100644 index 000000000..eec473e2a --- /dev/null +++ b/test/dirs.proj @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/tools/dirs.proj b/tools/dirs.proj new file mode 100644 index 000000000..8f1d6787a --- /dev/null +++ b/tools/dirs.proj @@ -0,0 +1,6 @@ + + + + + + From 5cb439e79c6bd3b9feeb69516f1210cca94731a2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 Jun 2025 17:41:44 -0600 Subject: [PATCH 1374/1753] Fix symbol classification for test project --- Microsoft.VisualStudio.Threading.slnx | 2 +- .../NativeAOTCompatibility.Test.csproj} | 0 .../Program.cs | 0 test/dirs.proj | 6 +++--- 4 files changed, 4 insertions(+), 4 deletions(-) rename test/{NativeAOTCompatibility/NativeAOTCompatibility.csproj => NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj} (100%) rename test/{NativeAOTCompatibility => NativeAOTCompatibility.Test}/Program.cs (100%) diff --git a/Microsoft.VisualStudio.Threading.slnx b/Microsoft.VisualStudio.Threading.slnx index c7243f9f5..037ae9ddc 100644 --- a/Microsoft.VisualStudio.Threading.slnx +++ b/Microsoft.VisualStudio.Threading.slnx @@ -47,6 +47,6 @@ - + diff --git a/test/NativeAOTCompatibility/NativeAOTCompatibility.csproj b/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj similarity index 100% rename from test/NativeAOTCompatibility/NativeAOTCompatibility.csproj rename to test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj diff --git a/test/NativeAOTCompatibility/Program.cs b/test/NativeAOTCompatibility.Test/Program.cs similarity index 100% rename from test/NativeAOTCompatibility/Program.cs rename to test/NativeAOTCompatibility.Test/Program.cs diff --git a/test/dirs.proj b/test/dirs.proj index eec473e2a..16cfe03d2 100644 --- a/test/dirs.proj +++ b/test/dirs.proj @@ -1,8 +1,8 @@ - + - - + + From b432d5eeff8ecf9a484615a7098e07008463ab51 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 Jun 2025 21:47:12 -0600 Subject: [PATCH 1375/1753] Build for OptProf with test signed bits Real signing can only be used for official builds. --- azure-pipelines/microbuild.before.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 07429bc79..250715369 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -42,9 +42,8 @@ steps: - task: MicroBuildSigningPlugin@4 inputs: - signType: Real + signType: Test zipSources: false - ConnectedPMEServiceName: 6cc74545-d7b9-4050-9dfa-ebefcc8961ea # devdiv's SC ID displayName: 🔧 Install MicroBuild Signing Plugin - ${{ if parameters.EnableLocalization }}: From 13e9b014769beca66241563f126277187488d4a4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 19 Jun 2025 21:40:59 -0600 Subject: [PATCH 1376/1753] Fix build with loc plugin When building with the Microbuild loc plugin, the plugin tries to localize samples.dll. But that isn't prepared for localization, nor is it required. --- samples/samples.csproj | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/samples/samples.csproj b/samples/samples.csproj index 788cac68e..6f1681d0a 100644 --- a/samples/samples.csproj +++ b/samples/samples.csproj @@ -21,4 +21,8 @@ + + + + From 1a7db8d2477fba5c3c11f2862b7a28c65673b473 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Jun 2025 06:52:49 -0600 Subject: [PATCH 1377/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to 21cd104 (#379) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index cd1285d48..bc640c8a9 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:4f50505b5344e9d8a76805d71bb4ba76da6b01656e17a66a8ce1e4c4dfaaec12 +FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:21cd104bae759d9787f99a7d9a9d0e431f9360ee373909bbbfd4b8da07a7e3d9 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From f84cb0f8a87686cd3388a448cf924c043930ed7a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:52:18 -0600 Subject: [PATCH 1378/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to f353951 (#380) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index bc640c8a9..eaf9a82eb 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:21cd104bae759d9787f99a7d9a9d0e431f9360ee373909bbbfd4b8da07a7e3d9 +FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:f353951d75cd99696c912ba7a29a1c6905fe0c1c7613e12e5318efed40d9b287 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From d1219b5166a7d25145317795102696495f671cc1 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 24 Jun 2025 22:53:36 -0600 Subject: [PATCH 1379/1753] Update dependency powershell to 7.5.2 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 0eae32501..79ad7dda2 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.5.1", + "version": "7.5.2", "commands": [ "pwsh" ], From c14a73b6392be60a68cd1383db777d5ad8241273 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 29 Jun 2025 14:51:35 -0600 Subject: [PATCH 1380/1753] Re-enable static graph nuget restore --- Directory.Build.props | 3 +-- README.md | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index e862541e5..f702243ab 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -17,8 +17,7 @@ true - - false + true $(MSBuildThisFileDirectory) diff --git a/README.md b/README.md index f78bfdb38..f0b0f7d86 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,10 @@ * Static analyzers: default [Code Analysis](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/overview) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) * Read-only source tree (builds to top-level bin/obj folders) * Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/dotnet/nerdbank.gitversioning)) -* Builds with a "pinned" .NET Core SDK to ensure reproducible builds across machines and across time. +* Builds with a "pinned" .NET SDK to ensure reproducible builds across machines and across time. * Automatically pack the library and publish it as an artifact, and even push it to some NuGet feed for consumption. * Testing - * Testing on .NET Framework, multiple .NET Core versions + * Testing on .NET Framework, multiple .NET versions * Testing on Windows, Linux and OSX * Tests that crash or hang in Azure Pipelines automatically collect dumps and publish as a pipeline artifact for later investigation. * Cloud build support From 53960183851451f5482da6bdcc421057a277d989 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 7 Jul 2025 20:33:23 -0600 Subject: [PATCH 1381/1753] Update becheran/mlc action to v1 (#383) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f0f293ee1..b6beb8d8f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -76,6 +76,6 @@ jobs: steps: - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@88c9db09b8dabab813a2edd13f955b36aa73657a # v0.22.0 + uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From d9522ff94699b409df91d539dc46b7e01e4b00af Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 7 Jul 2025 20:33:50 -0600 Subject: [PATCH 1382/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to 2346351 (#382) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index eaf9a82eb..0a5f632a8 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:f353951d75cd99696c912ba7a29a1c6905fe0c1c7613e12e5318efed40d9b287 +FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:2346351dfe95ffdfe8352042647b2c9746c62cfc812eead9b9bf6154937c86ba # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 200f811d546e7beed6fa7c7b5c4786fe7b725003 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 8 Jul 2025 07:25:59 -0600 Subject: [PATCH 1383/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.301-noble Docker digest to 4fd7d3e (#384) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 0a5f632a8..f06bc4ca2 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:2346351dfe95ffdfe8352042647b2c9746c62cfc812eead9b9bf6154937c86ba +FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:4fd7d3e5aeb6cfb75e923a54cdb0b6e858b27ad3b517837917c57c2e632b5694 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 11467d8198d1d001f749f4b360358c32fa6d3f1c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 9 Jul 2025 12:37:34 +0000 Subject: [PATCH 1384/1753] Update .NET SDK to v9.0.302 * Update mcr.microsoft.com/dotnet/sdk Docker tag to v9.0.302 * Bump .NET SDK to 9.0.302 in global.json --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index f06bc4ca2..50eb81596 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.301-noble@sha256:4fd7d3e5aeb6cfb75e923a54cdb0b6e858b27ad3b517837917c57c2e632b5694 +FROM mcr.microsoft.com/dotnet/sdk:9.0.302-noble@sha256:b9f738e7bfa1581ae38a91365f26e21354fe09c6b9a4f2327f6cec588486d9e2 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 0e241b6f5..f4ade2caf 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.301", + "version": "9.0.302", "rollForward": "patch", "allowPrerelease": false } From dd842406373a11a83f1952e92762b7c8401b09c6 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Fri, 11 Jul 2025 17:12:02 -0700 Subject: [PATCH 1385/1753] Allow library code to detect the JoinableContext is not associated with main thread It allows library code to skip certain work under such conditions. For example to build an extensive dependency graph for dataflow dependencies, or dependencies in work queues. --- .../JoinableTaskContext.cs | 6 +++++ .../net472/PublicAPI.Unshipped.txt | 1 + .../net8.0-windows/PublicAPI.Unshipped.txt | 1 + .../net8.0/PublicAPI.Unshipped.txt | 1 + .../netstandard2.0/PublicAPI.Unshipped.txt | 1 + .../JoinableTaskContextTests.cs | 25 +++++++++++++++++++ 6 files changed, 35 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index e409a2db7..63246ff74 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -245,6 +245,12 @@ public bool IsWithinJoinableTask get { return this.AmbientTask is object; } } + /// + /// Gets a value indicating whether gets a value indicating the JoinableTask is not associated with any main thread. + /// This allows library code to skip some additional work in the environments that do not have a main thread. + /// + public bool IsNoOpContext => this.UnderlyingSynchronizationContext is null; + /// /// Gets a value indicating whether the main thread is blocked by any joinable task. /// diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt index 82ffde8aa..dbb58c1bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask Microsoft.VisualStudio.Threading.IPendingExecutionRequestState Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt index 82ffde8aa..dbb58c1bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask Microsoft.VisualStudio.Threading.IPendingExecutionRequestState Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt index 82ffde8aa..dbb58c1bb 100644 --- a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask Microsoft.VisualStudio.Threading.IPendingExecutionRequestState Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt index 82ffde8aa..dbb58c1bb 100644 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt @@ -1,4 +1,5 @@ Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask Microsoft.VisualStudio.Threading.IPendingExecutionRequestState Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool +Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index dc36759f6..2951b647c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -727,6 +727,7 @@ public void Ctor_ExplicitNullSyncContext() Thread mainThread = Thread.CurrentThread; Assumes.NotNull(SynchronizationContext.Current); JoinableTaskContext jtc = JoinableTaskContext.CreateNoOpContext(); + Assert.True(jtc.IsNoOpContext); await TaskScheduler.Default.SwitchTo(alwaysYield: true); // Get off the main thread. Assert.NotSame(mainThread, Thread.CurrentThread); @@ -745,6 +746,7 @@ public void Ctor_NullSyncContextArg_AmbientSyncContext() Thread mainThread = Thread.CurrentThread; Assumes.NotNull(SynchronizationContext.Current); JoinableTaskContext jtc = new(null, null); + Assert.False(jtc.IsNoOpContext); await TaskScheduler.Default.SwitchTo(alwaysYield: true); // Get off the main thread. Assert.NotSame(mainThread, Thread.CurrentThread); @@ -762,6 +764,7 @@ public void Ctor_Default() Thread mainThread = Thread.CurrentThread; Assumes.NotNull(SynchronizationContext.Current); JoinableTaskContext jtc = new(); + Assert.False(jtc.IsNoOpContext); await TaskScheduler.Default.SwitchTo(alwaysYield: true); // Get off the main thread. Assert.NotSame(mainThread, Thread.CurrentThread); @@ -771,6 +774,28 @@ public void Ctor_Default() }); } + [Fact] + public void Ctor_DefaultWithNoSyncContext() + { + this.SimulateUIThread(async delegate + { + await TaskScheduler.Default.SwitchTo(alwaysYield: true); // Get off the main thread. + + Thread currentThread = Thread.CurrentThread; + + Assumes.Null(SynchronizationContext.Current); + JoinableTaskContext jtc = new(); + Assert.True(jtc.IsNoOpContext); + + await TaskScheduler.Default.SwitchTo(); + Assert.Same(currentThread, Thread.CurrentThread); + + // Verify that switching to the main thread works. + await jtc.Factory.SwitchToMainThreadAsync(this.TimeoutToken); + Assert.Same(currentThread, Thread.CurrentThread); + }); + } + protected override JoinableTaskContext CreateJoinableTaskContext() { return new JoinableTaskContextDerived(); From eef5eeeb0a60eb64036707e742f7fd1542e990bf Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 13 Jul 2025 22:28:13 -0600 Subject: [PATCH 1386/1753] Update dependency xunit.v3 to v3 (#387) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c510499aa..fa15ee523 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ - + From 6b1c4db08f77a7eb6c6278bc016219ad28137a93 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 14 Jul 2025 14:17:14 +0000 Subject: [PATCH 1387/1753] Update dependency xunit.runner.visualstudio to 3.1.2 (#386) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index fa15ee523..c5bad1b66 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 43aadc16f8163d5fd4cc46694adb6ecfe03613d3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 14 Jul 2025 18:17:48 -0600 Subject: [PATCH 1388/1753] Skip CodeQL scanning of test code --- CodeQL.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 CodeQL.yml diff --git a/CodeQL.yml b/CodeQL.yml new file mode 100644 index 000000000..903500b55 --- /dev/null +++ b/CodeQL.yml @@ -0,0 +1,3 @@ +path_classifiers: + library: + - 'test/**' From 2102e056d0bfc0b16d4dfe9b50e4eb2cef848123 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 15 Jul 2025 06:42:41 -0600 Subject: [PATCH 1389/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.302-noble Docker digest to d442f82 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 50eb81596..1dfcdb9e6 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.302-noble@sha256:b9f738e7bfa1581ae38a91365f26e21354fe09c6b9a4f2327f6cec588486d9e2 +FROM mcr.microsoft.com/dotnet/sdk:9.0.302-noble@sha256:d442f8270d12233f878df7fa280969fc2a7c892ae80d145eb1a1b8fb811eee83 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From f17cd2ac94a01fe3cee43ee0cb7baa930e507ee1 Mon Sep 17 00:00:00 2001 From: "Pierson Lee (PIE)" Date: Tue, 15 Jul 2025 17:06:37 -0700 Subject: [PATCH 1390/1753] Run Component Detection explicitly before Notice Component Detection that was being injected was happening too late (way after NOTICE task was running) which was causing the generate NOTICE task to fail. --- azure-pipelines/microbuild.before.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index 05acd3194..ec59c2ece 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -17,9 +17,9 @@ parameters: steps: - ${{ if and(not(parameters.IsOptProf), ne(variables['Build.Reason'], 'PullRequest')) }}: # notice@0 requires CG detection to run first, and non-default branches don't inject it automatically. - - ${{ if ne(variables['Build.SourceBranch'], 'refs/heads/main') }}: - - task: ComponentGovernanceComponentDetection@0 - displayName: 🔍 Component Detection + # default branch injection (main) is happening too late for notice@0 to run successfully. Adding this as a workaround. + - task: ComponentGovernanceComponentDetection@0 + displayName: 🔍 Component Detection - task: notice@0 displayName: 🛠️ Generate NOTICE file From 9bb119c00b4bfd3c148d5f1d8187775cf2e7c0dd Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 16 Jul 2025 15:59:47 -0700 Subject: [PATCH 1391/1753] Update src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs Co-authored-by: Andrew Arnott --- .../JoinableTaskContext.cs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index 63246ff74..fa3cb7339 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -246,9 +246,12 @@ public bool IsWithinJoinableTask } /// - /// Gets a value indicating whether gets a value indicating the JoinableTask is not associated with any main thread. - /// This allows library code to skip some additional work in the environments that do not have a main thread. + /// Gets a value indicating whether this instance is not associated with any main thread + /// (e.g. created with ). /// + /// + /// This allows library code to skip some additional work in the environments that do not have a main thread. + /// public bool IsNoOpContext => this.UnderlyingSynchronizationContext is null; /// From fe71729b2b10b69c5dac50db9a8828b2a699ab17 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 16 Jul 2025 23:49:51 +0000 Subject: [PATCH 1392/1753] Update dependency xunit.runner.visualstudio to 3.1.3 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c5bad1b66..0747b92bc 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 77f38d4173d60258fcfca40ba59a53733030f2eb Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 18 Jul 2025 05:34:24 -0600 Subject: [PATCH 1393/1753] Update Dockerfile and global.json updates to v9.0.303 (#394) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 1dfcdb9e6..05ddebad2 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.302-noble@sha256:d442f8270d12233f878df7fa280969fc2a7c892ae80d145eb1a1b8fb811eee83 +FROM mcr.microsoft.com/dotnet/sdk:9.0.303-noble@sha256:af75742bd2f6fd148504951b57a983bc410191729bf543eae467528d1bc175e5 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index f4ade2caf..a982cdefc 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.302", + "version": "9.0.303", "rollForward": "patch", "allowPrerelease": false } From b6f67cc20e43b9f989fd115d2f5831f787cb1311 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 24 Jul 2025 14:54:45 -0600 Subject: [PATCH 1394/1753] Bump MicroBuildVersion to 2.0.199 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 3d6ea14d2..f7bf9d566 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.198 + 2.0.199 From 648355746406d1bf4fe95cb14d6ee102974fbc01 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Jul 2025 10:09:51 -0600 Subject: [PATCH 1395/1753] Update becheran/mlc action to v1 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 391289a45..35921d06c 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -17,7 +17,7 @@ jobs: with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@88c9db09b8dabab813a2edd13f955b36aa73657a # v0.22.0 + uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc* - name: ⚙ Install prerequisites From 8eb458b8381ac2fe279d765f1084eb16af4fb99a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 25 Jul 2025 19:46:32 -0600 Subject: [PATCH 1396/1753] Disable credscan task on unofficial builds --- azure-pipelines/libtemplate-update.yml | 2 ++ azure-pipelines/unofficial.yml | 2 ++ azure-pipelines/vs-validation.yml | 2 ++ 3 files changed, 6 insertions(+) diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index 3d7fb7e3b..384be7cfc 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -35,6 +35,8 @@ extends: name: AzurePipelines-EO demands: - ImageOverride -equals 1ESPT-Windows2022 + credscan: + enabled: false stages: - stage: Merge diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 9ca100eae..d72327353 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -57,6 +57,8 @@ extends: parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + credscan: + enabled: false suppression: suppressionFile: $(System.DefaultWorkingDirectory)\azure-pipelines\falsepositives.gdnsuppress enableProductionSDL: ${{ parameters.EnableProductionSDL }} diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 3a40395e7..b9d46b7c7 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -28,6 +28,8 @@ extends: parameters: sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + credscan: + enabled: false stages: - stage: Build From 28382fd802f19e1d3262dbf95c50ebdcee97c3fa Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 30 Jul 2025 07:20:08 -0600 Subject: [PATCH 1397/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.303-noble Docker digest to a990afa Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 05ddebad2..881dafec2 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.303-noble@sha256:af75742bd2f6fd148504951b57a983bc410191729bf543eae467528d1bc175e5 +FROM mcr.microsoft.com/dotnet/sdk:9.0.303-noble@sha256:a990afa820aa77df1cc3a7eaf471eb7cddf5f8233d739297400e0ce7ff0762bd # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From f9374d9cc10ae59fd134a9ee7262fa189eca2945 Mon Sep 17 00:00:00 2001 From: Tyler Dunkel <40210514+tydunkel@users.noreply.github.com> Date: Wed, 30 Jul 2025 11:09:51 -0700 Subject: [PATCH 1398/1753] Pass through System.AccessToken when real signing on non-Windows builds (#396) --- azure-pipelines/build.yml | 2 ++ azure-pipelines/dotnet.yml | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index b69a9f5c4..e91da6146 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -246,6 +246,7 @@ jobs: parameters: Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} + BuildRequiresAccessToken: ${{ parameters.RealSign }} # Real signing on non-Windows machines requires passing through access token to build steps that sign - ${{ if parameters.EnableDotNetFormatCheck }}: - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code @@ -282,6 +283,7 @@ jobs: parameters: Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} + BuildRequiresAccessToken: ${{ parameters.RealSign }} # Real signing on non-Windows machines requires passing through access token to build steps that sign - template: expand-template.yml - job: WrapUp diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 2abca9eb2..947cfc1a4 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -5,11 +5,17 @@ parameters: default: false - name: Is1ESPT type: boolean +- name: BuildRequiresAccessToken + type: boolean + default: false steps: - script: dotnet build -t:build,pack --no-restore -c $(BuildConfiguration) -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904,LOCTASK002 /bl:"$(Build.ArtifactStagingDirectory)/build_logs/build.binlog" displayName: 🛠 dotnet build + ${{ if parameters.BuildRequiresAccessToken }}: + env: + SYSTEM_ACCESSTOKEN: $(System.AccessToken) - ${{ if not(parameters.IsOptProf) }}: - powershell: tools/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults From 6f665e45309c0232f50b36dc7250f7f23af1eabe Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 30 Jul 2025 22:16:37 -0600 Subject: [PATCH 1399/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.303-noble Docker digest to 14fad15 (#397) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 881dafec2..738001ecc 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.303-noble@sha256:a990afa820aa77df1cc3a7eaf471eb7cddf5f8233d739297400e0ce7ff0762bd +FROM mcr.microsoft.com/dotnet/sdk:9.0.303-noble@sha256:14fad15702d25fec7ff1532b762abd323fc7549c9b8a713b5871b88dc989053d # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From c2b6afa61b52ce4b643682574ddc7e958ecc48ea Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 5 Aug 2025 16:38:46 -0600 Subject: [PATCH 1400/1753] Update Dockerfile and global.json updates to v9.0.304 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 738001ecc..077025891 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.303-noble@sha256:14fad15702d25fec7ff1532b762abd323fc7549c9b8a713b5871b88dc989053d +FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:39ca82d31517e698dcd47f668d53041ec95cca8b783d8134c3053a9769492603 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index a982cdefc..aee1f8eb9 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.303", + "version": "9.0.304", "rollForward": "patch", "allowPrerelease": false } From eb42f5f05592b74e9701cbac7b1976d8f05677c3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 5 Aug 2025 19:20:59 -0600 Subject: [PATCH 1401/1753] Update actions/download-artifact action to v5 (#399) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e37811d69..05a8c8fff 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -65,7 +65,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4 + uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From 801d690548323e7731c92cc760620ea0fe6e4bff Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 5 Aug 2025 19:48:40 -0600 Subject: [PATCH 1402/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.304-noble Docker digest to 1f7ccf8 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 077025891..792d7e861 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:39ca82d31517e698dcd47f668d53041ec95cca8b783d8134c3053a9769492603 +FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:1f7ccf88e076bc1cb1ddbd81959fb55b886b01851b092867bb7a638435fa1f1f # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 78241e391b86b2840d6ebd780d4a7be3028e83c1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 9 Aug 2025 11:45:05 -0600 Subject: [PATCH 1403/1753] Add copilot-instructions.md file --- .github/copilot-instructions.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 000000000..942d81d9b --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,22 @@ +# Copilot instructions for this repository + +## High level guidance + +* Review the `CONTRIBUTING.md` file for instructions to build and test the software. +* Set the `NBGV_GitEngine` environment variable to `Disabled` before running any `dotnet` or `msbuild` commands. + +## Software Design + +* Design APIs to be highly testable, and all functionality should be tested. +* Avoid introducing binary breaking changes in public APIs of projects under `src` unless their project files have `IsPackable` set to `false`. + +## Testing + +* There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Test` suffix. +* Tests should use the Xunit testing framework. + +## Coding style + +* Honor StyleCop rules and fix any reported build warnings *after* getting tests to pass. +* In C# files, use namespace *statements* instead of namespace *blocks* for all new files. +* Add API doc comments to all new public and internal members. From 28cfd93db8ccb2a5e25de629eb4504054a4c3704 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 10 Aug 2025 08:25:04 -0600 Subject: [PATCH 1404/1753] Fix up contributing to work better on linux --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4281f299e..990402db1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,9 +53,9 @@ Push the tag. When your repo is hosted by GitHub and you are using GitHub Actions, you should create a GitHub Release using the standard GitHub UI. Having previously used `nbgv tag` and pushing the tag will help you identify the precise commit and name to use for this release. -After publishing the release, the `.github\workflows\release.yml` workflow will be automatically triggered, which will: +After publishing the release, the `.github/workflows/release.yml` workflow will be automatically triggered, which will: -1. Find the most recent `.github\workflows\build.yml` GitHub workflow run of the tagged release. +1. Find the most recent `.github/workflows/build.yml` GitHub workflow run of the tagged release. 1. Upload the `deployables` artifact from that workflow run to your GitHub Release. 1. If you have `NUGET_API_KEY` defined as a secret variable for your repo or org, any nuget packages in the `deployables` artifact will be pushed to nuget.org. @@ -92,7 +92,7 @@ The best way to keep your repo in sync with Library.Template's evolving features ```ps1 git fetch git checkout origin/main -.\tools\MergeFrom-Template.ps1 +./tools/MergeFrom-Template.ps1 # resolve any conflicts, then commit the merge commit. git push origin -u HEAD ``` From c4de4d094e4f078890878e9d89090fd0b1a6a084 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 10 Aug 2025 09:19:23 -0600 Subject: [PATCH 1405/1753] Add copilot instructions about avoiding unstable tests --- .github/copilot-instructions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 942d81d9b..085935029 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -14,6 +14,7 @@ * There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Test` suffix. * Tests should use the Xunit testing framework. +* Some tests are known to be unstable. When running tests, you should skip the unstable ones by running `dotnet test --filter "TestCategory!=FailsInCloudTest"`. ## Coding style From 7f486ccfc64f146f376738ee435442fbb3f81214 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 11 Aug 2025 09:53:49 -0600 Subject: [PATCH 1406/1753] Update actions/checkout action to v5 (#402) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b6beb8d8f..03067ad22 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,7 +29,7 @@ jobs: - windows-2022 steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -74,7 +74,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 053f56e95..eb69d92e8 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0a8f8215d..6454d3c54 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,7 +25,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 7d0a67a0b..f5cf8666f 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From dc3950f6376f1ee5c747f062afd43a654305884c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 16 Aug 2025 06:35:33 -0600 Subject: [PATCH 1407/1753] Update xunit Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 0747b92bc..8d1ed7872 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,8 +10,8 @@ - - + + From 04843ad0057ceac68bf1f13f7aa20a76c671382e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 17 Aug 2025 12:34:52 -0600 Subject: [PATCH 1408/1753] Update actions/checkout action to v5 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 35921d06c..7c50b3b7d 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) From 90069e4bf80cd5a8d42ad6f46cb2827f8105f472 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 19 Aug 2025 18:31:41 -0600 Subject: [PATCH 1409/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.304-noble Docker digest to 0b7186a (#404) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 792d7e861..d40ad5e94 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:1f7ccf88e076bc1cb1ddbd81959fb55b886b01851b092867bb7a638435fa1f1f +FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:0b7186a7247bf8c07085fd700613bb0425a6f8f6467a0342c12a535e767da803 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 640b1d12eb5de5bc1b02a42528206ef6a3155b27 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 22 Aug 2025 13:13:42 -0600 Subject: [PATCH 1410/1753] Update actions/upload-pages-artifact action to v4 (#405) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6454d3c54..13751a644 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -35,7 +35,7 @@ jobs: name: 📚 Generate documentation - name: Upload artifact - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3 + uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4 with: path: docfx/_site From 849676611f654d73c84a9468b0ecc205294250e0 Mon Sep 17 00:00:00 2001 From: Juraj Grosic Date: Mon, 25 Aug 2025 02:00:25 +0200 Subject: [PATCH 1411/1753] Merge pull request #1485 from jgrosic/patch-1 Fix typo in docs library_with_jtf.md --- docfx/docs/library_with_jtf.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docfx/docs/library_with_jtf.md b/docfx/docs/library_with_jtf.md index 29434ab75..351db71a5 100644 --- a/docfx/docs/library_with_jtf.md +++ b/docfx/docs/library_with_jtf.md @@ -115,7 +115,7 @@ public static class LibrarySettings } ``` -This pattern and self-initializer allows all the rest of your library code to assume JTF is always present (so you can use JTF.Run and JTF.RunAsync everywhere w/o feature that JTF will be null), and it mitigates all the deadlocks possible given the host constraints. +This pattern and self-initializer allows all the rest of your library code to assume JTF is always present (so you can use JTF.Run and JTF.RunAsync everywhere w/o fear that JTF will be null), and it mitigates all the deadlocks possible given the host constraints. Note that when you create your own default instance of JoinableTaskContext (i.e. when the host doesn't), it will consider the thread you're on to be the main thread. If SynchronizationContext.Current is object it will capture it and use it to switch to the main thread when you ask it to (very similar to how VS works today), otherwise any request to SwitchToMainThreadAsync will never switch the thread (since no `SynchronizationContext` was supplied to do so) but otherwise JTF continues to work. From 6e77b794a0a615053d494cee596232f80d35c8bb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 25 Aug 2025 16:44:44 -0600 Subject: [PATCH 1412/1753] Move GitHub workflow token permissions to per-job --- .github/workflows/docs.yml | 13 ++++++------- .github/workflows/release.yml | 7 +++---- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 13751a644..a7155c4cf 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,13 +5,6 @@ on: branches: - main -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - actions: read - pages: write - id-token: write - contents: read - # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. concurrency: @@ -20,6 +13,12 @@ concurrency: jobs: publish-docs: + # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages + permissions: + actions: read + pages: write + id-token: write + contents: read environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 05a8c8fff..1b4e25ca5 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,13 +11,12 @@ on: run-name: ${{ github.ref_name }} -permissions: - actions: read - contents: write - jobs: release: runs-on: ubuntu-24.04 + permissions: + actions: read + contents: write steps: - name: ⚙️ Initialization shell: pwsh From 3c9a9faab9fc9417bef919c798979b7e5e9736d1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 28 Aug 2025 15:05:29 -0600 Subject: [PATCH 1413/1753] Move Install-NuGetPackage.ps1 to the tools folder --- init.ps1 | 2 +- {azure-pipelines => tools}/Install-NuGetPackage.ps1 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename {azure-pipelines => tools}/Install-NuGetPackage.ps1 (96%) diff --git a/init.ps1 b/init.ps1 index e8c2602ea..8bb78ad8f 100755 --- a/init.ps1 +++ b/init.ps1 @@ -126,7 +126,7 @@ try { } } - $InstallNuGetPkgScriptPath = "$PSScriptRoot\azure-pipelines\Install-NuGetPackage.ps1" + $InstallNuGetPkgScriptPath = "$PSScriptRoot\tools\Install-NuGetPackage.ps1" $nugetVerbosity = 'quiet' if ($Verbose) { $nugetVerbosity = 'normal' } $MicroBuildPackageSource = 'https://pkgs.dev.azure.com/devdiv/_packaging/MicroBuildToolset%40Local/nuget/v3/index.json' diff --git a/azure-pipelines/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 similarity index 96% rename from azure-pipelines/Install-NuGetPackage.ps1 rename to tools/Install-NuGetPackage.ps1 index f1db577ab..9afde0550 100644 --- a/azure-pipelines/Install-NuGetPackage.ps1 +++ b/tools/Install-NuGetPackage.ps1 @@ -33,7 +33,7 @@ Param( [string]$Verbosity='normal' ) -$nugetPath = & "$PSScriptRoot\..\tools\Get-NuGetTool.ps1" +$nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" try { Write-Verbose "Installing $PackageId..." From 53aebc939ed71b5805ac5ddc66261d4ff76a5814 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Sep 2025 07:48:40 -0600 Subject: [PATCH 1414/1753] Update hyperlinks to learn.microsoft.com --- CONTRIBUTING.md | 2 +- README.md | 2 +- azurepipelines-coverage.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 990402db1..7875bfc8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ This repository can be built on Windows, Linux, and OSX. Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). -[pwsh]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell?view=powershell-6 +[pwsh]: https://learn.microsoft.com/powershell/scripting/install/installing-powershell ## Releases diff --git a/README.md b/README.md index f0b0f7d86..b0c1a00cc 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ * Follow the best and simplest patterns of build, pack and test with dotnet CLI. * Init script that installs prerequisites and auth helpers, supporting both non-elevation and elevation modes. -* Static analyzers: default [Code Analysis](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/overview) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) +* Static analyzers: default [Code Analysis](https://learn.microsoft.com/dotnet/fundamentals/code-analysis/overview) and [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) * Read-only source tree (builds to top-level bin/obj folders) * Auto-versioning (via [Nerdbank.GitVersioning](https://github.com/dotnet/nerdbank.gitversioning)) * Builds with a "pinned" .NET SDK to ensure reproducible builds across machines and across time. diff --git a/azurepipelines-coverage.yml b/azurepipelines-coverage.yml index 0cd5dad36..e2dd1f503 100644 --- a/azurepipelines-coverage.yml +++ b/azurepipelines-coverage.yml @@ -1,4 +1,4 @@ -# https://learn.microsoft.com/azure/devops/pipelines/test/codecoverage-for-pullrequests?view=azure-devops +# https://learn.microsoft.com/azure/devops/pipelines/test/codecoverage-for-pullrequests coverage: status: comments: on # add comment to PRs reporting diff in coverage of modified files From 8cf1387a466f05a0c6e2f2fd94a9b4d12e6997fc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Sep 2025 07:48:40 -0600 Subject: [PATCH 1415/1753] Update hyperlinks to learn.microsoft.com --- SECURITY.md | 2 +- azure-pipelines/PostPRMessage.ps1 | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index 0dc4b6a77..29306956d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). -If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://learn.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. ## Reporting Security Issues diff --git a/azure-pipelines/PostPRMessage.ps1 b/azure-pipelines/PostPRMessage.ps1 index 4a2b7886e..4075f3921 100644 --- a/azure-pipelines/PostPRMessage.ps1 +++ b/azure-pipelines/PostPRMessage.ps1 @@ -8,7 +8,7 @@ param( $CommentState='Active' ) -# See https://docs.microsoft.com/en-us/dotnet/api/microsoft.teamfoundation.sourcecontrol.webapi.commentthreadstatus?view=azure-devops-dotnet +# See https://learn.microsoft.com/dotnet/api/microsoft.teamfoundation.sourcecontrol.webapi.commentthreadstatus if ($CommentState -eq 'Active') { $StatusCode = 1 } elseif ($CommentState -eq 'ByDesign') { @@ -38,7 +38,7 @@ $body = ConvertTo-Json @{ Write-Verbose "Posting JSON payload: `n$Body" # Post the message to the Pull Request -# https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20request%20threads?view=azure-devops-rest-5.1 +# https://learn.microsoft.com/rest/api/azure/devops/git/pull-request-threads $url = "$($env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI)$env:SYSTEM_TEAMPROJECTID/_apis/git/repositories/$($env:BUILD_REPOSITORY_NAME)/pullRequests/$($env:SYSTEM_PULLREQUEST_PULLREQUESTID)/threads?api-version=5.1" if ($PSCmdlet.ShouldProcess($url, 'Post comment via REST call')) { try { From 25e8285b3bcd77428682e1f6799ef85c65f30a2c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Sep 2025 19:09:57 -0600 Subject: [PATCH 1416/1753] Remove stray backtick from CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7875bfc8f..d48a02076 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,7 +88,7 @@ If Renovate is not creating pull requests when you expect it to, check that the ### Maintaining your repo based on this template The best way to keep your repo in sync with Library.Template's evolving features and best practices is to periodically merge the template into your repo: -` + ```ps1 git fetch git checkout origin/main From 4d2be894dbdb286fcab1cabbf43c3fedca1c270b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Sep 2025 19:34:41 -0600 Subject: [PATCH 1417/1753] Add `Install-NuGetPackage.ps1` script This was previously only included in the `microbuild` branch. --- tools/Install-NuGetPackage.ps1 | 55 ++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 tools/Install-NuGetPackage.ps1 diff --git a/tools/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 new file mode 100644 index 000000000..9afde0550 --- /dev/null +++ b/tools/Install-NuGetPackage.ps1 @@ -0,0 +1,55 @@ +<# +.SYNOPSIS + Installs a NuGet package. +.PARAMETER PackageID + The Package ID to install. +.PARAMETER Version + The version of the package to install. If unspecified, the latest stable release is installed. +.PARAMETER Source + The package source feed to find the package to install from. +.PARAMETER PackagesDir + The directory to install the package to. By default, it uses the Packages folder at the root of the repo. +.PARAMETER ConfigFile + The nuget.config file to use. By default, it uses :/nuget.config. +.OUTPUTS + System.String. The path to the installed package. +#> +[CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Low')] +Param( + [Parameter(Position=1,Mandatory=$true)] + [string]$PackageId, + [Parameter()] + [string]$Version, + [Parameter()] + [string]$Source, + [Parameter()] + [switch]$Prerelease, + [Parameter()] + [string]$PackagesDir="$PSScriptRoot\..\packages", + [Parameter()] + [string]$ConfigFile="$PSScriptRoot\..\nuget.config", + [Parameter()] + [ValidateSet('Quiet','Normal','Detailed')] + [string]$Verbosity='normal' +) + +$nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" + +try { + Write-Verbose "Installing $PackageId..." + $nugetArgs = "Install",$PackageId,"-OutputDirectory",$PackagesDir,'-ConfigFile',$ConfigFile + if ($Version) { $nugetArgs += "-Version",$Version } + if ($Source) { $nugetArgs += "-FallbackSource",$Source } + if ($Prerelease) { $nugetArgs += "-Prerelease" } + $nugetArgs += '-Verbosity',$Verbosity + + if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { + $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru + if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw } + } + + # Provide the path to the installed package directory to our caller. + Write-Output (Get-ChildItem "$PackagesDir\$PackageId.*")[0].FullName +} finally { + Pop-Location +} From c29f9af53a720c0ceae90e70bf6dfb5c88a89e84 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Sep 2025 19:53:41 -0600 Subject: [PATCH 1418/1753] Add switches to Install-NuGetPackage.ps1 --- tools/Install-NuGetPackage.ps1 | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/tools/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 index 9afde0550..c7a42a91a 100644 --- a/tools/Install-NuGetPackage.ps1 +++ b/tools/Install-NuGetPackage.ps1 @@ -7,6 +7,12 @@ The version of the package to install. If unspecified, the latest stable release is installed. .PARAMETER Source The package source feed to find the package to install from. +.PARAMETER Prerelease + Include prerelease packages when searching for the latest version. +.PARAMETER ExcludeVersion + Installs the package without adding the version to the folder name. +.PARAMETER DirectDownload + Bypass the local cache when downloading packages. .PARAMETER PackagesDir The directory to install the package to. By default, it uses the Packages folder at the root of the repo. .PARAMETER ConfigFile @@ -25,6 +31,10 @@ Param( [Parameter()] [switch]$Prerelease, [Parameter()] + [switch]$ExcludeVersion, + [Parameter()] + [switch]$DirectDownload, + [Parameter()] [string]$PackagesDir="$PSScriptRoot\..\packages", [Parameter()] [string]$ConfigFile="$PSScriptRoot\..\nuget.config", @@ -41,6 +51,8 @@ try { if ($Version) { $nugetArgs += "-Version",$Version } if ($Source) { $nugetArgs += "-FallbackSource",$Source } if ($Prerelease) { $nugetArgs += "-Prerelease" } + if ($ExcludeVersion) { $nugetArgs += '-ExcludeVersion' } + if ($DirectDownload) { $nugetArgs += '-DirectDownload' } $nugetArgs += '-Verbosity',$Verbosity if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { From fec70cfcda335d648706e2875f38893ded3c1db6 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 9 Sep 2025 16:53:41 -0600 Subject: [PATCH 1419/1753] Update Dockerfile and global.json updates to v9.0.305 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index d40ad5e94..c1223a435 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:0b7186a7247bf8c07085fd700613bb0425a6f8f6467a0342c12a535e767da803 +FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:66a9fb34b06fe16c8a656327d6dd765b38bcb60577ce9af4bf08c6c63ea98702 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index aee1f8eb9..6fea1e98e 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.304", + "version": "9.0.305", "rollForward": "patch", "allowPrerelease": false } From d71cf6675486eb27a563d4f118b471d99ef9207c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 10 Sep 2025 07:38:47 -0600 Subject: [PATCH 1420/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.305-noble Docker digest to 802e64a (#407) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index c1223a435..5526144c2 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:66a9fb34b06fe16c8a656327d6dd765b38bcb60577ce9af4bf08c6c63ea98702 +FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:802e64ab9e113bdfa5d476ae00c7b40ab5c42da1792731c41a47f43bc4e74bdb # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 1367101102f299c993d337aef3c5a4628c277b3a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Sep 2025 08:00:08 -0600 Subject: [PATCH 1421/1753] Drop extra `Pop-Location` from `Install-NuGetPackage.ps1` --- tools/Install-NuGetPackage.ps1 | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/tools/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 index c7a42a91a..3c11b0f6b 100644 --- a/tools/Install-NuGetPackage.ps1 +++ b/tools/Install-NuGetPackage.ps1 @@ -45,23 +45,19 @@ Param( $nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" -try { - Write-Verbose "Installing $PackageId..." - $nugetArgs = "Install",$PackageId,"-OutputDirectory",$PackagesDir,'-ConfigFile',$ConfigFile - if ($Version) { $nugetArgs += "-Version",$Version } - if ($Source) { $nugetArgs += "-FallbackSource",$Source } - if ($Prerelease) { $nugetArgs += "-Prerelease" } - if ($ExcludeVersion) { $nugetArgs += '-ExcludeVersion' } - if ($DirectDownload) { $nugetArgs += '-DirectDownload' } - $nugetArgs += '-Verbosity',$Verbosity +Write-Verbose "Installing $PackageId..." +$nugetArgs = "Install",$PackageId,"-OutputDirectory",$PackagesDir,'-ConfigFile',$ConfigFile +if ($Version) { $nugetArgs += "-Version",$Version } +if ($Source) { $nugetArgs += "-FallbackSource",$Source } +if ($Prerelease) { $nugetArgs += "-Prerelease" } +if ($ExcludeVersion) { $nugetArgs += '-ExcludeVersion' } +if ($DirectDownload) { $nugetArgs += '-DirectDownload' } +$nugetArgs += '-Verbosity',$Verbosity - if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { - $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru - if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw } - } - - # Provide the path to the installed package directory to our caller. - Write-Output (Get-ChildItem "$PackagesDir\$PackageId.*")[0].FullName -} finally { - Pop-Location +if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { + $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru + if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw } } + +# Provide the path to the installed package directory to our caller. +Write-Output (Get-ChildItem "$PackagesDir\$PackageId.*")[0].FullName From e40d505268ea70ccd683ea7b5554307cb5cedcf6 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 10 Sep 2025 12:09:28 -0600 Subject: [PATCH 1422/1753] Update dependency powershell to v7.5.3 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 79ad7dda2..e2f24dc2f 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.5.2", + "version": "7.5.3", "commands": [ "pwsh" ], From 761109a9d7112f25e0c880ff91958394cb3aecbf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Sep 2025 21:34:45 -0600 Subject: [PATCH 1423/1753] Add API compat testing --- .config/dotnet-tools.json | 7 ++++ .github/workflows/build.yml | 4 ++ azure-pipelines/build.yml | 4 ++ azure-pipelines/dotnet.yml | 11 +++++- tools/Check-ApiCompat.ps1 | 74 +++++++++++++++++++++++++++++++++++++ 5 files changed, 99 insertions(+), 1 deletion(-) create mode 100644 tools/Check-ApiCompat.ps1 diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 79ad7dda2..79ccf8bd5 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -29,6 +29,13 @@ "docfx" ], "rollForward": false + }, + "microsoft.dotnet.apicompat.tool": { + "version": "9.0.305", + "commands": [ + "apicompat" + ], + "rollForward": false } } } diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 03067ad22..4e5f1b53e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -50,6 +50,10 @@ jobs: - name: 🧪 test run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} shell: pwsh + - name: 📋 API compat test + run: tools/Check-ApiCompat.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} + shell: pwsh + if: runner.os == 'Linux' - name: 💅🏻 Verify formatted code run: dotnet format --verify-no-changes --no-restore shell: pwsh diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5c106ade4..e3c59be8e 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -8,6 +8,9 @@ parameters: - name: RunTests type: boolean default: true +- name: EnableApiCompatCheck + type: boolean + default: true jobs: - job: Windows @@ -37,6 +40,7 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} + EnableApiCompatCheck: ${{ parameters.EnableApiCompatCheck }} - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code env: diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 30bb4107d..8630e50c9 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,5 +1,9 @@ parameters: - RunTests: +- name: RunTests + type: boolean +- name: EnableApiCompatCheck + type: boolean + default: false steps: @@ -10,6 +14,11 @@ steps: displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) +- ${{ if parameters.EnableApiCompatCheck }}: + - powershell: tools/Check-ApiCompat.ps1 -Configuration $(BuildConfiguration) + displayName: 📋 API compat test + condition: and(succeeded(), ${{ parameters.RunTests }}) + - powershell: tools/variables/_define.ps1 failOnStderr: true displayName: ⚙ Update pipeline variables based on build outputs diff --git a/tools/Check-ApiCompat.ps1 b/tools/Check-ApiCompat.ps1 new file mode 100644 index 000000000..26dd6d4c2 --- /dev/null +++ b/tools/Check-ApiCompat.ps1 @@ -0,0 +1,74 @@ +#!/usr/bin/env pwsh + +<# +.SYNOPSIS + Runs the apicompat tool on the built packages. +.PARAMETER Configuration + Debug or Release +.PARAMETER GenerateSuppressionFile + If specified, generates or updates a suppression file for API compatibility checks. +#> +[CmdletBinding()] +Param ( + [string]$Configuration = 'Release', + [switch]$GenerateSuppressionFile +) + +Function Get-PackageId($nupkgPath) { + # The package ID cannot be reliably parsed out of the nupkg file name, + # because if the ID ends with an integer, it may be ambiguous with the version part. + # Extract the nuspec file from the nupkg to get the package ID. + $tempDir = [System.IO.Path]::GetTempPath() + [System.Guid]::NewGuid().ToString() + New-Item -ItemType Directory -Path $tempDir | Out-Null + try { + Expand-Archive -Path $nupkgPath -DestinationPath $tempDir + $nuspecPath = Get-ChildItem -Path $tempDir -Filter "*.nuspec" | Select-Object -First 1 + if ($nuspecPath) { + [xml]$nuspec = Get-Content $nuspecPath.FullName + return $nuspec.package.metadata.id + } + else { + Write-Warning "No nuspec found in $nupkgPath" + return $null + } + } + finally { + Remove-Item -Recurse -Force $tempDir + } +} + +$failures = 0 +Get-ChildItem $PSScriptRoot/../bin/Packages/$Configuration/*.nupkg | % { + $packageId = Get-PackageId $_.FullName + + if ($packageId -eq $null) { + continue + } + + $compatArgs = 'apicompat', 'package', $_.FullName, '--enable-strict-mode-for-baseline-validation' + + # Attempt to download the last published stable version of this package + # to serve as a baseline on which this new build should be API compatible. + try { + New-Item -ItemType Directory -Path "$PSScriptRoot/../obj" -Force | Out-Null + $baselineFile = [System.IO.Path]::GetFullPath("$PSScriptRoot/../obj/$packageId.baseline.nupkg") + Invoke-WebRequest -Uri https://www.nuget.org/api/v2/package/$packageId -OutFile $baselineFile + $compatArgs += '--baseline-package', $baselineFile + } + catch { + Write-Warning "Failed to download baseline package for $packageId, which may be expected if a stable package has not been published. $_" + } + + $ApiCompatSuppressionPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../src/$packageId/ApiCompatSuppressions.xml") + if ((Test-Path $ApiCompatSuppressionPath) -or $GenerateSuppressionFile) { + $compatArgs += '--suppression-file', $ApiCompatSuppressionPath + } + if ($GenerateSuppressionFile) { + $compatArgs += '--generate-suppression-file' + } + Write-Host "Testing $($packageId): dotnet $compatArgs" + dotnet @compatArgs + if ($LASTEXITCODE -ne 0) { $failures += 1 } +} + +exit $failures From b1997987d1afcb5b8b544aff70e8efcbd131569e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Sep 2025 21:54:22 -0600 Subject: [PATCH 1424/1753] Switch API compat testing from dotnet tool to MSBuild --- .config/dotnet-tools.json | 7 ---- .github/workflows/build.yml | 4 -- Directory.Build.props | 3 ++ azure-pipelines/build.yml | 4 -- azure-pipelines/dotnet.yml | 11 +----- src/Library/Library.csproj | 1 + tools/Check-ApiCompat.ps1 | 74 ------------------------------------- 7 files changed, 5 insertions(+), 99 deletions(-) delete mode 100644 tools/Check-ApiCompat.ps1 diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 79ccf8bd5..79ad7dda2 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -29,13 +29,6 @@ "docfx" ], "rollForward": false - }, - "microsoft.dotnet.apicompat.tool": { - "version": "9.0.305", - "commands": [ - "apicompat" - ], - "rollForward": false } } } diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4e5f1b53e..03067ad22 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -50,10 +50,6 @@ jobs: - name: 🧪 test run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} shell: pwsh - - name: 📋 API compat test - run: tools/Check-ApiCompat.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} - shell: pwsh - if: runner.os == 'Linux' - name: 💅🏻 Verify formatted code run: dotnet format --verify-no-changes --no-restore shell: pwsh diff --git a/Directory.Build.props b/Directory.Build.props index f702243ab..02d418045 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -13,6 +13,9 @@ true true + + true + true diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index e3c59be8e..5c106ade4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -8,9 +8,6 @@ parameters: - name: RunTests type: boolean default: true -- name: EnableApiCompatCheck - type: boolean - default: true jobs: - job: Windows @@ -40,7 +37,6 @@ jobs: - template: dotnet.yml parameters: RunTests: ${{ parameters.RunTests }} - EnableApiCompatCheck: ${{ parameters.EnableApiCompatCheck }} - script: dotnet format --verify-no-changes displayName: 💅 Verify formatted code env: diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 8630e50c9..30bb4107d 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,9 +1,5 @@ parameters: -- name: RunTests - type: boolean -- name: EnableApiCompatCheck - type: boolean - default: false + RunTests: steps: @@ -14,11 +10,6 @@ steps: displayName: 🧪 dotnet test condition: and(succeeded(), ${{ parameters.RunTests }}) -- ${{ if parameters.EnableApiCompatCheck }}: - - powershell: tools/Check-ApiCompat.ps1 -Configuration $(BuildConfiguration) - displayName: 📋 API compat test - condition: and(succeeded(), ${{ parameters.RunTests }}) - - powershell: tools/variables/_define.ps1 failOnStderr: true displayName: ⚙ Update pipeline variables based on build outputs diff --git a/src/Library/Library.csproj b/src/Library/Library.csproj index 89f062347..fa79c05e0 100644 --- a/src/Library/Library.csproj +++ b/src/Library/Library.csproj @@ -1,5 +1,6 @@ net8.0;netstandard2.0 + diff --git a/tools/Check-ApiCompat.ps1 b/tools/Check-ApiCompat.ps1 deleted file mode 100644 index 26dd6d4c2..000000000 --- a/tools/Check-ApiCompat.ps1 +++ /dev/null @@ -1,74 +0,0 @@ -#!/usr/bin/env pwsh - -<# -.SYNOPSIS - Runs the apicompat tool on the built packages. -.PARAMETER Configuration - Debug or Release -.PARAMETER GenerateSuppressionFile - If specified, generates or updates a suppression file for API compatibility checks. -#> -[CmdletBinding()] -Param ( - [string]$Configuration = 'Release', - [switch]$GenerateSuppressionFile -) - -Function Get-PackageId($nupkgPath) { - # The package ID cannot be reliably parsed out of the nupkg file name, - # because if the ID ends with an integer, it may be ambiguous with the version part. - # Extract the nuspec file from the nupkg to get the package ID. - $tempDir = [System.IO.Path]::GetTempPath() + [System.Guid]::NewGuid().ToString() - New-Item -ItemType Directory -Path $tempDir | Out-Null - try { - Expand-Archive -Path $nupkgPath -DestinationPath $tempDir - $nuspecPath = Get-ChildItem -Path $tempDir -Filter "*.nuspec" | Select-Object -First 1 - if ($nuspecPath) { - [xml]$nuspec = Get-Content $nuspecPath.FullName - return $nuspec.package.metadata.id - } - else { - Write-Warning "No nuspec found in $nupkgPath" - return $null - } - } - finally { - Remove-Item -Recurse -Force $tempDir - } -} - -$failures = 0 -Get-ChildItem $PSScriptRoot/../bin/Packages/$Configuration/*.nupkg | % { - $packageId = Get-PackageId $_.FullName - - if ($packageId -eq $null) { - continue - } - - $compatArgs = 'apicompat', 'package', $_.FullName, '--enable-strict-mode-for-baseline-validation' - - # Attempt to download the last published stable version of this package - # to serve as a baseline on which this new build should be API compatible. - try { - New-Item -ItemType Directory -Path "$PSScriptRoot/../obj" -Force | Out-Null - $baselineFile = [System.IO.Path]::GetFullPath("$PSScriptRoot/../obj/$packageId.baseline.nupkg") - Invoke-WebRequest -Uri https://www.nuget.org/api/v2/package/$packageId -OutFile $baselineFile - $compatArgs += '--baseline-package', $baselineFile - } - catch { - Write-Warning "Failed to download baseline package for $packageId, which may be expected if a stable package has not been published. $_" - } - - $ApiCompatSuppressionPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../src/$packageId/ApiCompatSuppressions.xml") - if ((Test-Path $ApiCompatSuppressionPath) -or $GenerateSuppressionFile) { - $compatArgs += '--suppression-file', $ApiCompatSuppressionPath - } - if ($GenerateSuppressionFile) { - $compatArgs += '--generate-suppression-file' - } - Write-Host "Testing $($packageId): dotnet $compatArgs" - dotnet @compatArgs - if ($LASTEXITCODE -ne 0) { $failures += 1 } -} - -exit $failures From dfa8f358b1f8bdf4546fe2023e3145e884ad92c2 Mon Sep 17 00:00:00 2001 From: trevors20 <49179298+trevors20@users.noreply.github.com> Date: Thu, 11 Sep 2025 08:20:54 -0700 Subject: [PATCH 1425/1753] Migrate from managed identity to service connection for APIScan (#409) * Migrate from managed identity to service connection for APIScan. * Add the system access token. * Use a variable for the apiscan auth string. * Apply suggestion from @AArnott --------- Co-authored-by: Andrew Arnott --- azure-pipelines/apiscan.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/apiscan.yml b/azure-pipelines/apiscan.yml index c3c8aed16..a1d07e104 100644 --- a/azure-pipelines/apiscan.yml +++ b/azure-pipelines/apiscan.yml @@ -49,8 +49,10 @@ jobs: isLargeApp: false toolVersion: Latest preserveLogsFolder: true + azureSubscription: VSEng-APIScanSC env: - AzureServicesAuthConnectionString: runAs=App;AppId=$(ApiScanClientId) + AzureServicesAuthConnectionString: $(APIScanAuthConnectionString) + SYSTEM_ACCESSTOKEN: $(System.AccessToken) # File bugs when APIScan finds issues - task: TSAUpload@2 From 28cf28e93868cf212cafc84b8c2d032624b453f6 Mon Sep 17 00:00:00 2001 From: Matteo Prosperi <41970398+matteo-prosperi@users.noreply.github.com> Date: Tue, 16 Sep 2025 11:29:45 -0700 Subject: [PATCH 1426/1753] Migrate from managed identity to service connection for symbol archiving (#411) * Migrate from managed identity to service connection for symbol archiving Updated MicroBuildArchiveSymbols task version and added Azure subscription and environment variables. * Apply suggestion from @AArnott --------- Co-authored-by: Andrew Arnott --- azure-pipelines/prepare-insertion-stages.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index cfe287433..fdce906aa 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -30,12 +30,15 @@ stages: - download: current artifact: symbols-legacy displayName: 🔻 Download symbols-legacy artifact - - task: MicroBuildArchiveSymbols@5 + - task: MicroBuildArchiveSymbols@6 displayName: 🔣 Archive symbols to Symweb inputs: SymbolsFeatureName: $(SymbolsFeatureName) SymbolsProject: VS SymbolsAgentPath: $(Pipeline.Workspace)/symbols-legacy + azureSubscription: Vseng-SymbolsUpload + env: + SYSTEM_ACCESSTOKEN: $(System.AccessToken) - ${{ if parameters.PackagePush }}: - job: push From b06cfe598fdff626d3e7a8581660a72c67d07954 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 16 Sep 2025 20:08:27 -0700 Subject: [PATCH 1427/1753] remove NotifyOfCrossThreadDependency call when a debugger is attached, NotifyOfCrossThreadDependency will freeze the thread to send notification to the debugger. Because this NoMessagePumpSynchronizationContext is heavily used, including nested inside code holding the JTF lock, this leads the process being debugged becomes extremely slow when JTF is heavily used. --- src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs index fa3cb7339..3baa6cbae 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskContext.cs @@ -302,11 +302,6 @@ protected internal virtual SynchronizationContext NoMessagePumpSynchronizationCo { get { - // Callers of this method are about to take a private lock, which tends - // to cause a deadlock while debugging because of lock contention with the - // debugger's expression evaluator. So prevent that. - Debugger.NotifyOfCrossThreadDependency(); - return NoMessagePumpSyncContext.Default; } } From 028c074776bd658a8594370571b80484d435e05b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 Sep 2025 12:49:52 -0600 Subject: [PATCH 1428/1753] Bump MicroBuild version to 2.0.201 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 80e687a5c..73c69a871 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.199 + 2.0.201 From ce5bb3c2a4163c2010d7eab775a59257eaaf30b5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 Sep 2025 12:50:00 -0600 Subject: [PATCH 1429/1753] Update .gitignore source URL --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index cc2b12470..1b7799301 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ## -## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore +## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore # User-specific files *.rsuser From 60bc0ad038dfd438997fc034bf89c3be53254337 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 Sep 2025 12:50:15 -0600 Subject: [PATCH 1430/1753] Drop explicit nuget.org source for procdump It'll now come from wherever nuget.config says. --- tools/Get-ProcDump.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Get-ProcDump.ps1 b/tools/Get-ProcDump.ps1 index 1493fe4b2..6fba954d8 100644 --- a/tools/Get-ProcDump.ps1 +++ b/tools/Get-ProcDump.ps1 @@ -8,7 +8,7 @@ $procDumpToolPath = "$baseDir\procdump.$version\bin" if (-not (Test-Path $procDumpToolPath)) { if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } $baseDir = (Resolve-Path $baseDir).Path # Normalize it - & (& $PSScriptRoot\Get-NuGetTool.ps1) install procdump -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://api.nuget.org/v3/index.json | Out-Null + & (& $PSScriptRoot\Get-NuGetTool.ps1) install procdump -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir | Out-Null } (Resolve-Path $procDumpToolPath).Path From 0f75208c0de471105bfbea7355590f69f05e96a9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 Sep 2025 16:51:08 -0600 Subject: [PATCH 1431/1753] Allow VSInsertion artifact collection with just a VSIX --- tools/artifacts/VSInsertion.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/artifacts/VSInsertion.ps1 b/tools/artifacts/VSInsertion.ps1 index ffc7e29ad..a5b940b5d 100644 --- a/tools/artifacts/VSInsertion.ps1 +++ b/tools/artifacts/VSInsertion.ps1 @@ -20,8 +20,8 @@ $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration" $NuGetPackages = "$PackagesRoot/NuGet" $VsixPackages = "$PackagesRoot/Vsix" -if (!(Test-Path $NuGetPackages)) { - Write-Warning "Skipping because NuGet packages haven't been built yet." +if (!(Test-Path $NuGetPackages) -and !(Test-Path $VsixPackages)) { + Write-Warning "Skipping because NuGet and VSIX packages haven't been built yet." return @{} } From 0e1fe345c4406ad40c16b6304543cd5f12a9c244 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 Sep 2025 17:49:26 -0600 Subject: [PATCH 1432/1753] Fix Microsoft.DiaSymReader.Pdb2Pdb package installation --- tools/Convert-PDB.ps1 | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/tools/Convert-PDB.ps1 b/tools/Convert-PDB.ps1 index f119a164e..7e1303a2a 100644 --- a/tools/Convert-PDB.ps1 +++ b/tools/Convert-PDB.ps1 @@ -30,7 +30,13 @@ if (-not (Test-Path $pdb2pdbpath)) { if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } $baseDir = (Resolve-Path $baseDir).Path # Normalize it Write-Verbose "& (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null" - & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null + # This package originally comes from the https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json feed. + # Add this feed as an upstream to whatever feed is in nuget.config if this step fails. + & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir | Out-Null + if ($LASTEXITCODE -ne 0) { + Write-Error "Failed to install Microsoft.DiaSymReader.Pdb2Pdb. Consider adding https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json as an upstream to your nuget.config feed." + return + } } $args = $DllPath,'/out',$OutputPath,'/nowarn','0021' From fe66868c9e853165c57920a79d2ef8ae160d884b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 17 Sep 2025 21:00:27 -0600 Subject: [PATCH 1433/1753] Fix VSIX placement to match .vsman expectations --- Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Build.props b/Directory.Build.props index b3a76d98a..53754def2 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -7,6 +7,7 @@ $(RepoRootPath)bin\$(MSBuildProjectName)\ $(RepoRootPath)bin\Packages\$(Configuration)\NuGet\ $(RepoRootPath)bin\Packages\$(Configuration)\Vsix\$(Platform)\ + $(RepoRootPath)bin\Packages\$(Configuration)\Vsix\ $(VSIXOutputPath) enable enable From af11e1164b6ce85ca3599741d7830c6b8cab1d17 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Sep 2025 07:31:58 -0600 Subject: [PATCH 1434/1753] Fix stray period in doc --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d48a02076..d4322a7ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,7 +66,7 @@ Trigger the pipeline by adding the `auto-release` tag on a run of your main `azu ## Tutorial and API documentation -API and hand-written docs are found under the `docfx/` directory. and are built by [docfx](https://dotnet.github.io/docfx/). +API and hand-written docs are found under the `docfx/` directory and are built by [docfx](https://dotnet.github.io/docfx/). You can make changes and host the site locally to preview them by switching to that directory and running the `dotnet docfx --serve` command. After making a change, you can rebuild the docs site while the localhost server is running by running `dotnet docfx` again from a separate terminal. From b9362532b8ef8db8a88a0eec99fbcca3329fea57 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Sep 2025 16:44:33 -0600 Subject: [PATCH 1435/1753] Use newer SBOM tool The old one has concurrency bugs that leads to frequent build breaks. --- azure-pipelines/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index e91da6146..3db1adde0 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -123,6 +123,7 @@ jobs: signType: test sbom: enabled: true + sbomToolVersion: 5.0.3 localization: enabled: ${{ parameters.EnableLocalization }} ${{ if eq(variables['Build.Reason'], 'pullRequest') }}: From 85815caf5391c3f73790b62bea08a652ccb6edff Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 19 Sep 2025 11:38:24 -0600 Subject: [PATCH 1436/1753] Bump nuget.exe to 6.14.0 --- tools/Get-NuGetTool.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Get-NuGetTool.ps1 b/tools/Get-NuGetTool.ps1 index 8a3b9eeda..bed0cba1d 100644 --- a/tools/Get-NuGetTool.ps1 +++ b/tools/Get-NuGetTool.ps1 @@ -6,7 +6,7 @@ #> Param( [Parameter()] - [string]$NuGetVersion='6.12.2' + [string]$NuGetVersion='6.14.0' ) $toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" From e670cd471d3abeb33570ee4fbd074525c59450fe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Sep 2025 06:33:58 -0600 Subject: [PATCH 1437/1753] Build stable package version --- version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.json b/version.json index f96d8ed07..2f478c761 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "17.15-alpha", + "version": "18.0", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From ec4d0275d7eea4cf5e5a5fe658bcbd04fad2eff5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Sep 2025 07:13:16 -0600 Subject: [PATCH 1438/1753] Switch from PublicAPI files to .NET SDK package validation This new mechanism will validate a _bunch_ of things about package structure that PublicAPI never touched, including: 1. If an API exists on .NET Standard, it should also exist on all the specific runtime targets that implement that standard. 1. APIs experience no breaking changes across versions. The only thing that PublicAPI.txt files do that package validation doesn't is a specific file that changes only when public API changes. That can be useful in repos where we have specific PR policies set up to add a required reviewer group to the PR when public APIs are changed, or to make a public API change more obvious. But it's also a real pain to maintain these files, so especially in repos where we _don't_ have such reviewer policies set up, it makes more sense to migrate to the new system. --- Directory.Packages.props | 1 - .../Microsoft.VisualStudio.Threading.csproj | 6 +- .../net472/PublicAPI.Shipped.txt | 515 ----------------- .../net472/PublicAPI.Unshipped.txt | 5 - .../net8.0-windows/PublicAPI.Shipped.txt | 516 ------------------ .../net8.0-windows/PublicAPI.Unshipped.txt | 5 - .../net8.0/PublicAPI.Shipped.txt | 513 ----------------- .../net8.0/PublicAPI.Unshipped.txt | 5 - .../netstandard2.0/PublicAPI.Shipped.txt | 513 ----------------- .../netstandard2.0/PublicAPI.Unshipped.txt | 5 - 10 files changed, 1 insertion(+), 2083 deletions(-) delete mode 100644 src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt delete mode 100644 src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt diff --git a/Directory.Packages.props b/Directory.Packages.props index bca56cae8..1a96ddc69 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -19,7 +19,6 @@ - diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 14acd335d..894de4e05 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -10,6 +10,7 @@ true true + 17.14.15 true @@ -20,13 +21,8 @@ - - - - - diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt deleted file mode 100644 index 6f08bf254..000000000 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Shipped.txt +++ /dev/null @@ -1,515 +0,0 @@ -#nullable enable -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncBarrier -Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncLazy -Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool -Microsoft.VisualStudio.Threading.AsyncLocal -Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void -Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? -Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue -Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int -Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void -Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T -Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncSemaphore -Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void -Microsoft.VisualStudio.Threading.DispatcherExtensions -Microsoft.VisualStudio.Threading.HangReportContribution -Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! -Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? -Microsoft.VisualStudio.Threading.IAsyncDisposable -Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.IHangReportContributor -Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext -Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContextException -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskFactory -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ReentrantSemaphore -Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void -Microsoft.VisualStudio.Threading.SpecializedSyncContext -Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void -Microsoft.VisualStudio.Threading.ThreadingTools -Microsoft.VisualStudio.Threading.TplExtensions -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask -override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.DispatcherExtensions.WithPriority(this Microsoft.VisualStudio.Threading.JoinableTaskFactory! joinableTaskFactory, System.Windows.Threading.Dispatcher! dispatcher, System.Windows.Threading.DispatcherPriority priority) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! -static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! -static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void -virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void -virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance diff --git a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt deleted file mode 100644 index dbb58c1bb..000000000 --- a/src/Microsoft.VisualStudio.Threading/net472/PublicAPI.Unshipped.txt +++ /dev/null @@ -1,5 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool -static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt deleted file mode 100644 index 0b970c427..000000000 --- a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Shipped.txt +++ /dev/null @@ -1,516 +0,0 @@ -#nullable enable -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncBarrier -Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncLazy -Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool -Microsoft.VisualStudio.Threading.AsyncLocal -Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void -Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? -Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue -Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int -Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void -Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T -Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncSemaphore -Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void -Microsoft.VisualStudio.Threading.DispatcherExtensions -Microsoft.VisualStudio.Threading.HangReportContribution -Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! -Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? -Microsoft.VisualStudio.Threading.IAsyncDisposable -Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.IHangReportContributor -Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext -Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContextException -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskFactory -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ReentrantSemaphore -Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void -Microsoft.VisualStudio.Threading.SpecializedSyncContext -Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void -Microsoft.VisualStudio.Threading.ThreadingTools -Microsoft.VisualStudio.Threading.TplExtensions -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask -override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(nint[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.DispatcherExtensions.WithPriority(this Microsoft.VisualStudio.Threading.JoinableTaskFactory! joinableTaskFactory, System.Windows.Threading.Dispatcher! dispatcher, System.Windows.Threading.DispatcherPriority priority) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! -static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! -static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void -virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void -virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance - diff --git a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt deleted file mode 100644 index dbb58c1bb..000000000 --- a/src/Microsoft.VisualStudio.Threading/net8.0-windows/PublicAPI.Unshipped.txt +++ /dev/null @@ -1,5 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool -static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt deleted file mode 100644 index 697cc803c..000000000 --- a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Shipped.txt +++ /dev/null @@ -1,513 +0,0 @@ -#nullable enable -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncBarrier -Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncLazy -Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool -Microsoft.VisualStudio.Threading.AsyncLocal -Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void -Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? -Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue -Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int -Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void -Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T -Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncSemaphore -Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void -Microsoft.VisualStudio.Threading.HangReportContribution -Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! -Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? -Microsoft.VisualStudio.Threading.IAsyncDisposable -Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.IHangReportContributor -Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext -Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContextException -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskFactory -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ReentrantSemaphore -Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void -Microsoft.VisualStudio.Threading.SpecializedSyncContext -Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void -Microsoft.VisualStudio.Threading.ThreadingTools -Microsoft.VisualStudio.Threading.TplExtensions -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask -override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(nint[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! -static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! -static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void -virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void -virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance diff --git a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt deleted file mode 100644 index dbb58c1bb..000000000 --- a/src/Microsoft.VisualStudio.Threading/net8.0/PublicAPI.Unshipped.txt +++ /dev/null @@ -1,5 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool -static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt deleted file mode 100644 index 4c48319b5..000000000 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Shipped.txt +++ /dev/null @@ -1,513 +0,0 @@ -#nullable enable -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.AsyncAutoResetEvent(bool allowInliningAwaiters) -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncAutoResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncBarrier -Microsoft.VisualStudio.Threading.AsyncBarrier.AsyncBarrier(int participants) -> void -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.AsyncCountdownEvent(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.Signal() -> void -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAndWaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.SignalAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCountdownEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncEventHandler -Microsoft.VisualStudio.Threading.AsyncLazy -Microsoft.VisualStudio.Threading.AsyncLazy.AsyncLazy(System.Func!>! valueFactory, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue() -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValue(System.Threading.CancellationToken cancellationToken) -> T -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.GetValueAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueCreated.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueFactoryCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.AsyncLazyInitializer(System.Func! action, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory = null) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.Initialize(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.InitializeAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazyInitializer.IsCompletedSuccessfully.get -> bool -Microsoft.VisualStudio.Threading.AsyncLocal -Microsoft.VisualStudio.Threading.AsyncLocal.AsyncLocal() -> void -Microsoft.VisualStudio.Threading.AsyncLocal.Value.get -> T? -Microsoft.VisualStudio.Threading.AsyncLocal.Value.set -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.IsSet.get -> bool -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAll() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.PulseAllAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Reset() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.Set() -> void -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.SetAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncManualResetEvent.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue -Microsoft.VisualStudio.Threading.AsyncQueue.AsyncQueue() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncQueue.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Count.get -> int -Microsoft.VisualStudio.Threading.AsyncQueue.DequeueAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncQueue.Enqueue(T value) -> void -Microsoft.VisualStudio.Threading.AsyncQueue.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.IsEmpty.get -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.Peek() -> T -Microsoft.VisualStudio.Threading.AsyncQueue.SyncRoot.get -> object! -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(System.Predicate! valueCheck, out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryDequeue(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryEnqueue(T value) -> bool -Microsoft.VisualStudio.Threading.AsyncQueue.TryPeek(out T value) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AmbientLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CaptureDiagnostics.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Complete() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Completion.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.HideLocks() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsAnyPassiveLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsPassiveWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUpgradeableReadLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsWriteLockHeld.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.get -> object? -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Data.set -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.Flags.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.HasWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsActive.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsUpgradeableReadLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsValid.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.IsWriteLock.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle.NestingLock.get -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockStackContains(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags flags, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle handle) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeWriteLockReleased(System.Func! action) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(string! message) -> System.Exception! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Suppression.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.SyncObject.get -> object! -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Awaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetAggregateLockFlags() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.None = 0 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.SkipInitialPreparation = 4096 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags.StickyWrite = 1 -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.GetResult() -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.ReleaseAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetAllResourcesToUnknownState() -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(System.Func! resourceCheck, object? state) -> bool -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.SetResourceAsAccessed(TResource! resource) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.UpgradeableReadLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.WriteLockAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceAwaitable -Microsoft.VisualStudio.Threading.AsyncSemaphore -Microsoft.VisualStudio.Threading.AsyncSemaphore.AsyncSemaphore(int initialCount) -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(System.TimeSpan timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.EnterAsync(int timeout, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser -Microsoft.VisualStudio.Threading.AsyncSemaphore.Releaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.ConfiguredTaskYieldAwaitable(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.ConfiguredTaskYieldAwaiter(bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.ExecuteContinuationSynchronouslyAwaitable(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.ExecuteContinuationSynchronouslyAwaiter(System.Threading.Tasks.Task! antecedent) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.GetResult() -> T -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable.TaskSchedulerAwaitable(System.Threading.Tasks.TaskScheduler! taskScheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.TaskSchedulerAwaiter(System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationToken cancellationToken) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.CombinedCancellationToken(System.Threading.CancellationTokenSource! cancellationTokenSource) -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Dispose() -> void -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken other) -> bool -Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Token.get -> System.Threading.CancellationToken -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory -Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.DelegatingJoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskFactory! innerFactory) -> void -Microsoft.VisualStudio.Threading.HangReportContribution -Microsoft.VisualStudio.Threading.HangReportContribution.Content.get -> string! -Microsoft.VisualStudio.Threading.HangReportContribution.ContentName.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.ContentType.get -> string? -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.HangReportContribution(string! content, string? contentType, string? contentName, params Microsoft.VisualStudio.Threading.HangReportContribution![]? nestedReports) -> void -Microsoft.VisualStudio.Threading.HangReportContribution.NestedReports.get -> System.Collections.Generic.IReadOnlyCollection? -Microsoft.VisualStudio.Threading.IAsyncDisposable -Microsoft.VisualStudio.Threading.IAsyncDisposable.DisposeAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.IHangReportContributor -Microsoft.VisualStudio.Threading.IHangReportContributor.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> void -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask -Microsoft.VisualStudio.Threading.JoinableTask.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter -Microsoft.VisualStudio.Threading.JoinableTask.Join(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> T -Microsoft.VisualStudio.Threading.JoinableTask.JoinAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTask.Task.get -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Contains(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> bool -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.get -> string? -Microsoft.VisualStudio.Threading.JoinableTaskCollection.DisplayName.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.GetEnumerator() -> System.Collections.Generic.IEnumerator! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Join() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinTillEmptyAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinableTaskCollection(Microsoft.VisualStudio.Threading.JoinableTaskContext! context, bool refCountAddedJobs = false) -> void -Microsoft.VisualStudio.Threading.JoinableTaskCollection.Remove(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext -Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.EntryMethod.get -> System.Reflection.MethodInfo? -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDetails(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId, System.Reflection.MethodInfo? entryMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangDuration.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.HangId.get -> System.Guid -Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails.NotificationCount.get -> int -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsWithinJoinableTask.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.JoinableTaskContext(System.Threading.Thread? mainThread = null, System.Threading.SynchronizationContext? synchronizationContext = null) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskContextException -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException() -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextException.JoinableTaskContextException(string? message, System.Exception? inner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateCollection() -> Microsoft.VisualStudio.Threading.JoinableTaskCollection! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.Factory.get -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsMainThreadBlocked() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.IsOnMainThread.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.JoinableTaskContextNode(Microsoft.VisualStudio.Threading.JoinableTaskContext! context) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.MainThread.get -> System.Threading.Thread! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.RegisterOnHangDetected() -> System.IDisposable! -Microsoft.VisualStudio.Threading.JoinableTaskContextNode.SuppressRelevance() -> Microsoft.VisualStudio.Threading.JoinableTaskContext.RevertRelevance -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.LongRunning = 1 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions.None = 0 -> Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions -Microsoft.VisualStudio.Threading.JoinableTaskFactory -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Add(Microsoft.VisualStudio.Threading.JoinableTask! joinable) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Context.get -> Microsoft.VisualStudio.Threading.JoinableTaskContext! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.JoinableTaskFactory.HangDetectionTimeout.set -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.IsWaitingOnLongRunningTask() -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.JoinableTaskFactory(Microsoft.VisualStudio.Threading.JoinableTaskContext! owner) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> void -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.Run(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> T -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.SwitchToMainThreadAsync(bool alwaysYield, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.JoinableTaskFactory.UnderlyingSynchronizationContext.get -> System.Threading.SynchronizationContext? -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext -Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.NoMessagePumpSyncContext() -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Action! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.ProgressWithCompletion(System.Func! handler, Microsoft.VisualStudio.Threading.JoinableTaskFactory? joinableTaskFactory) -> void -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ProgressWithCompletion.WaitAsync(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.ReentrantSemaphore -Microsoft.VisualStudio.Threading.ReentrantSemaphore.CurrentCount.get -> int -Microsoft.VisualStudio.Threading.ReentrantSemaphore.Dispose() -> void -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Freeform = 3 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed = 0 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotRecognized = 1 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.Stack = 2 -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Attributes = 2 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Security = 8 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey = 1 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value = 4 -> Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.get -> bool -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Continue.set -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame.Frame() -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.PushFrame(Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Frame! frame) -> void -Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.SingleThreadedSynchronizationContext() -> void -Microsoft.VisualStudio.Threading.SpecializedSyncContext -Microsoft.VisualStudio.Threading.SpecializedSyncContext.Dispose() -> void -Microsoft.VisualStudio.Threading.ThreadingTools -Microsoft.VisualStudio.Threading.TplExtensions -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable.NoThrowTaskAwaitable(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.NoThrowTaskAwaiter(System.Threading.Tasks.Task! task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetResourceAsync(TMoniker resourceMoniker, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForConcurrentAccessAsync(TResource! resource, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.PrepareResourceForExclusiveAccessAsync(TResource! resource, Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.LockFlags lockFlags, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -abstract Microsoft.VisualStudio.Threading.ReentrantSemaphore.ExecuteAsync(System.Func>! operation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask -override Microsoft.VisualStudio.Threading.AsyncLazy.ToString() -> string! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -override Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.OnUpgradeableReadLockReleased() -> void -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.Equals(object? obj) -> bool -override Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.GetHashCode() -> int -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -override Microsoft.VisualStudio.Threading.DelegatingJoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -override Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Wait(System.IntPtr[]! waitHandles, bool waitAll, int millisecondsTimeout) -> int -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.SingleThreadedSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwait(this System.Runtime.CompilerServices.YieldAwaitable yieldAwaitable, bool continueOnCapturedContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ConfiguredTaskYieldAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitRunInline(this System.Threading.Tasks.Task! antecedent) -> Microsoft.VisualStudio.Threading.AwaitExtensions.ExecuteContinuationSynchronouslyAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.Tasks.TaskScheduler! scheduler) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.WaitHandle! handle) -> System.Runtime.CompilerServices.TaskAwaiter -static Microsoft.VisualStudio.Threading.AwaitExtensions.SwitchTo(this System.Threading.Tasks.TaskScheduler! scheduler, bool alwaysYield = false) -> Microsoft.VisualStudio.Threading.AwaitExtensions.TaskSchedulerAwaitable -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForChangeAsync(this Microsoft.Win32.RegistryKey! registryKey, bool watchSubtree = true, Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters change = Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Subkey | Microsoft.VisualStudio.Threading.RegistryChangeNotificationFilters.Value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.AwaitExtensions.WaitForExitAsync(this System.Diagnostics.Process! process, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, System.Threading.CancellationToken other) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombineWith(this System.Threading.CancellationToken original, params System.Threading.CancellationToken[]! others) -> Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator !=(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken.operator ==(Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken left, Microsoft.VisualStudio.Threading.CancellationTokenExtensions.CombinedCancellationToken right) -> bool -static Microsoft.VisualStudio.Threading.NoMessagePumpSyncContext.Default.get -> System.Threading.SynchronizationContext! -static Microsoft.VisualStudio.Threading.ReentrantSemaphore.Create(int initialCount = 1, Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext = null, Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode mode = Microsoft.VisualStudio.Threading.ReentrantSemaphore.ReentrancyMode.NotAllowed) -> Microsoft.VisualStudio.Threading.ReentrantSemaphore! -static Microsoft.VisualStudio.Threading.SpecializedSyncContext.Apply(System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.Apply(this System.Threading.SynchronizationContext? syncContext, bool checkForChangesOnRevert = true) -> Microsoft.VisualStudio.Threading.SpecializedSyncContext -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, TArg applyChangeArgument, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.ApplyChangeOptimistically(ref T hotLocation, System.Func! applyChange) -> bool -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.ThreadingTools.WithCancellation(this System.Threading.Tasks.Task! task, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AppendAction(this System.Threading.Tasks.Task! task, System.Action! action, System.Threading.Tasks.TaskContinuationOptions options = System.Threading.Tasks.TaskContinuationOptions.None, System.Threading.CancellationToken cancellation = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.ApplyResultTo(this System.Threading.Tasks.Task! task, System.Threading.Tasks.TaskCompletionSource! tcs) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.AttachToParent(this System.Threading.Tasks.Task! task) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.FollowCancelableTaskToCompletion(System.Func!>! taskToFollow, System.Threading.CancellationToken ultimateCancellation, System.Threading.Tasks.TaskCompletionSource? taskThatFollows = null) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.Task? task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, System.EventArgs! args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.InvokeAsync(this Microsoft.VisualStudio.Threading.AsyncEventHandler? handlers, object? sender, TEventArgs args) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.Task! task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToApm(this System.Threading.Tasks.Task! task, System.AsyncCallback? callback, object? state) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.ToTask(this System.Threading.WaitHandle! handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WaitWithoutInlining(this System.Threading.Tasks.Task! task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static Microsoft.VisualStudio.Threading.TplExtensions.WithTimeout(this System.Threading.Tasks.Task! task, System.TimeSpan timeout) -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CanceledTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.CompletedTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.FalseTask -> System.Threading.Tasks.Task! -static readonly Microsoft.VisualStudio.Threading.TplExtensions.TrueTask -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncQueue.InitialCapacity.get -> int -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnCompleted() -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnDequeued(T value) -> void -virtual Microsoft.VisualStudio.Threading.AsyncQueue.OnEnqueued(T value, bool alreadyDispatched) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.CanCurrentThreadHoldActiveLock.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.GetTaskSchedulerForReadLockRequest() -> System.Threading.Tasks.TaskScheduler! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.IsUnsupportedSynchronizationContext.get -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnBeforeLockReleasedAsync(bool exclusiveLockRelease, Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.LockHandle releasingLock) -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnCriticalFailure(System.Exception! ex) -> System.Exception! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnExclusiveLockReleasedAsync() -> System.Threading.Tasks.Task! -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.OnUpgradeableReadLockReleased() -> void -virtual Microsoft.VisualStudio.Threading.AsyncSemaphore.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.Dispose(bool disposing) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.GetHangReport() -> Microsoft.VisualStudio.Threading.HangReportContribution! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.NoMessagePumpSynchronizationContext.get -> System.Threading.SynchronizationContext! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContext.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateDefaultFactory() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.CreateFactory(Microsoft.VisualStudio.Threading.JoinableTaskCollection! collection) -> Microsoft.VisualStudio.Threading.JoinableTaskFactory! -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnFalseHangDetected(System.TimeSpan hangDuration, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(Microsoft.VisualStudio.Threading.JoinableTaskContext.HangDetails! details) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskContextNode.OnHangDetected(System.TimeSpan hangDuration, int notificationCount, System.Guid hangId) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitionedToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask, bool canceled) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.OnTransitioningToMainThread(Microsoft.VisualStudio.Threading.JoinableTask! joinableTask) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback! callback, object! state) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronously(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.JoinableTaskFactory.WaitSynchronouslyCore(System.Threading.Tasks.Task! task) -> void -virtual Microsoft.VisualStudio.Threading.ProgressWithCompletion.Report(T value) -> void -virtual Microsoft.VisualStudio.Threading.ReentrantSemaphore.SuppressRelevance() -> Microsoft.VisualStudio.Threading.ReentrantSemaphore.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.Releaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.ResourceReleaser.DisposeAsync() -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.NonConcurrentSynchronizationContext(bool sticky) -> void -Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.UnhandledException -> System.EventHandler? -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.CreateCopy() -> System.Threading.SynchronizationContext! -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Post(System.Threading.SendOrPostCallback! d, object? state) -> void -override Microsoft.VisualStudio.Threading.NonConcurrentSynchronizationContext.Send(System.Threading.SendOrPostCallback! d, object? state) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.Forget(this System.Threading.Tasks.ValueTask task) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.AggregateExceptionAwaitable(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.AggregateExceptionAwaiter(System.Threading.Tasks.Task! task, bool continueOnCapturedContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.ConfigureAwaitForAggregateException(this System.Threading.Tasks.Task! task, bool continueOnCapturedContext = true) -> Microsoft.VisualStudio.Threading.AwaitExtensions.AggregateExceptionAwaitable -Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void -Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.DeadlockCheckTimeout.get -> System.TimeSpan -Microsoft.VisualStudio.Threading.AsyncQueue.ToArray() -> T[]! -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.SynchronizationContextAwaiter(System.Threading.SynchronizationContext! syncContext) -> void -Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.SemaphoreFaultedException -Microsoft.VisualStudio.Threading.SemaphoreFaultedException.SemaphoreFaultedException() -> void -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException -Microsoft.VisualStudio.Threading.IllegalSemaphoreUsageException.IllegalSemaphoreUsageException(string! message) -> void -static Microsoft.VisualStudio.Threading.AwaitExtensions.GetAwaiter(this System.Threading.SynchronizationContext! synchronizationContext) -> Microsoft.VisualStudio.Threading.AwaitExtensions.SynchronizationContextAwaiter -Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable.NoThrowAwaitable() -> Microsoft.VisualStudio.Threading.JoinableTaskFactory.MainThreadAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.GetAwaiter() -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable.NoThrowValueTaskAwaitable(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.GetResult() -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.NoThrowValueTaskAwaiter(System.Threading.Tasks.ValueTask task, bool captureContext) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.OnCompleted(System.Action! continuation) -> void -Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaiter.UnsafeOnCompleted(System.Action! continuation) -> void -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -static Microsoft.VisualStudio.Threading.TplExtensions.NoThrowAwaitable(this System.Threading.Tasks.ValueTask task, bool captureContext = true) -> Microsoft.VisualStudio.Threading.TplExtensions.NoThrowValueTaskAwaitable -virtual Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock.GetTaskSchedulerToPrepareResourcesForConcurrentAccess(TResource! resource) -> System.Threading.Tasks.TaskScheduler! -Microsoft.VisualStudio.Threading.JoinableTaskContext.Capture() -> string? -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.JoinableTaskFactory.RunAsync(System.Func!>! asyncMethod, string? parentToken, Microsoft.VisualStudio.Threading.JoinableTaskCreationOptions creationOptions) -> Microsoft.VisualStudio.Threading.JoinableTask! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.AsyncCrossProcessMutex(string! name) -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.EnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.LockReleaser.IsAbandoned.get -> bool -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.Name.get -> string! -Microsoft.VisualStudio.Threading.AsyncCrossProcessMutex.TryEnterAsync(System.TimeSpan timeout) -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValue() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.DisposeValueAsync() -> System.Threading.Tasks.Task! -Microsoft.VisualStudio.Threading.AsyncLazy.IsValueDisposed.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance -Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance.Dispose() -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.get -> bool -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRecursiveFactoryDetection.init -> void -Microsoft.VisualStudio.Threading.AsyncLazy.SuppressRelevance() -> Microsoft.VisualStudio.Threading.AsyncLazy.RevertRelevance diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt deleted file mode 100644 index dbb58c1bb..000000000 --- a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt +++ /dev/null @@ -1,5 +0,0 @@ -Microsoft.VisualStudio.Threading.AsyncBarrier.SignalAndWait(System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState -Microsoft.VisualStudio.Threading.IPendingExecutionRequestState.IsCompleted.get -> bool -Microsoft.VisualStudio.Threading.JoinableTaskContext.IsNoOpContext.get -> bool -static Microsoft.VisualStudio.Threading.JoinableTaskContext.CreateNoOpContext() -> Microsoft.VisualStudio.Threading.JoinableTaskContext! \ No newline at end of file From 4155b0ae36b45416ade55c7892f4bdc035304b81 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 22 Sep 2025 19:23:18 +0000 Subject: [PATCH 1439/1753] Merge pull request #1489 from microsoft/renovate/msbuild Update dependency Microsoft.Build.NoTargets to 3.7.134 --- global.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/global.json b/global.json index b9966e9ed..2248f0d85 100644 --- a/global.json +++ b/global.json @@ -6,7 +6,7 @@ }, "msbuild-sdks": { "MSBuild.Sdk.Extras": "3.0.44", - "Microsoft.Build.NoTargets": "3.7.56", + "Microsoft.Build.NoTargets": "3.7.134", "Microsoft.Build.Traversal": "4.1.82" } } From 662051ccd3ce6fed4cceb620b23c544ff74ea1ef Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 22 Sep 2025 19:29:16 +0000 Subject: [PATCH 1440/1753] Merge pull request #1490 from microsoft/renovate/net-packages Update dependency System.ValueTuple to 4.6.1 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 1a96ddc69..b8380429e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -35,7 +35,7 @@ - + From 7bfb1d6e3808df638ff45910153e6607f3146b64 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 24 Sep 2025 08:47:15 -0600 Subject: [PATCH 1441/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.305-noble Docker digest to 604ef06 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 5526144c2..4a440efcb 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:802e64ab9e113bdfa5d476ae00c7b40ab5c42da1792731c41a47f43bc4e74bdb +FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:604ef064c6d91068eeb9d946036d8ffadbe25589c4cd77a230fc96e0f6d01d72 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 0ec755fcdfd442bfa287aa8ecf070a01154e2b6d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 26 Sep 2025 10:51:48 -0600 Subject: [PATCH 1442/1753] Don't check npmjs.com doc links npmjs.com has taken to blocking such checks with 403 Forbidden. --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 03067ad22..ee6caf65b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -78,4 +78,4 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/* From 04923ff12b0d3eb17a680b41e4fa1485b21b8471 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 26 Sep 2025 11:16:50 -0600 Subject: [PATCH 1443/1753] Add dotnet-tools.json to Solution Items --- Library.sln | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Library.sln b/Library.sln index 638efb568..5c81b3068 100644 --- a/Library.sln +++ b/Library.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.29322.22 +# Visual Studio Version 18 +VisualStudioVersion = 18.0.11023.372 main MinimumVisualStudioVersion = 15.0.26124.0 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library", "src\Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" EndProject @@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Directory.Build.props = Directory.Build.props Directory.Build.targets = Directory.Build.targets Directory.Packages.props = Directory.Packages.props + .config\dotnet-tools.json = .config\dotnet-tools.json global.json = global.json nuget.config = nuget.config README.md = README.md From 0b8462ee3ccc5c91c1a44fba2453d9ac8833d603 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 26 Sep 2025 11:42:17 -0600 Subject: [PATCH 1444/1753] Skip testing get.dot.net links This link is good, but github agents get a 403 Forbidden back --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ee6caf65b..717342eb6 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -78,4 +78,4 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/* + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ From a0fe97a199d47a23beedea8e15eaaa3360d9ea09 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 26 Sep 2025 17:48:55 +0000 Subject: [PATCH 1445/1753] Update nbgv and nerdbank.gitversioning updates to 3.8.118 (#416) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index e2f24dc2f..bdb0ed42f 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -17,7 +17,7 @@ "rollForward": false }, "nbgv": { - "version": "3.7.115", + "version": "3.8.118", "commands": [ "nbgv" ], diff --git a/Directory.Packages.props b/Directory.Packages.props index 8d1ed7872..8cbe694ce 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -20,7 +20,7 @@ - + From 234e34d4def6efd24740488c3cab887dc5a1793b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 27 Sep 2025 14:56:47 -0600 Subject: [PATCH 1446/1753] Switch to NuGet Trusted Publishing --- .github/workflows/release.yml | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1b4e25ca5..b84d90771 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,17 +15,10 @@ jobs: release: runs-on: ubuntu-24.04 permissions: - actions: read - contents: write + actions: read # Required to download artifacts + contents: write # Upload artifacts to Release + id-token: write # Required for NuGet CLI Login steps: - - name: ⚙️ Initialization - shell: pwsh - run: | - if ('${{ secrets.NUGET_API_KEY }}') { - Write-Host "NUGET_API_KEY secret detected. NuGet packages will be pushed." - echo "NUGET_API_KEY_DEFINED=true" >> $env:GITHUB_ENV - } - - name: 🔎 Search for build of ${{ github.ref }} shell: pwsh id: findrunid @@ -82,6 +75,11 @@ jobs: gh release -R ${{ github.repository }} upload "${{ github.ref_name }}" $_.FullName } + - name: 🪪 Authorize NuGet package push + uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1 + id: nuget-login + with: + user: ${{ secrets.NUGET_USER }} + - name: 🚀 Push NuGet packages - run: dotnet nuget push ${{ runner.temp }}/deployables/*.nupkg --source https://api.nuget.org/v3/index.json -k '${{ secrets.NUGET_API_KEY }}' - if: ${{ env.NUGET_API_KEY_DEFINED == 'true' }} + run: dotnet nuget push ${{ runner.temp }}/deployables/*.nupkg --source https://api.nuget.org/v3/index.json -k '${{ steps.nuget-login.outputs.NUGET_API_KEY }}' From e574cb5e19a217eeebf29b71a572c153fefbb855 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 27 Sep 2025 21:04:27 -0600 Subject: [PATCH 1447/1753] Update xunit (#417) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 8cbe694ce..aa5788c47 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,8 +10,8 @@ - - + + From 8712b0e13085e2603f6bb3d61f644395b5b2e268 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 06:41:55 -0700 Subject: [PATCH 1448/1753] Update dependency dotnet-coverage to v18 (#419) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index bdb0ed42f..f8c4a2644 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "17.14.2", + "version": "18.0.4", "commands": [ "dotnet-coverage" ], From 11ec88f1d866e5c246e3a91690d1adfaf9227ad8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 1 Oct 2025 02:21:26 +0000 Subject: [PATCH 1449/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.305-noble Docker digest to 8a26226 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 4a440efcb..2c0bd561c 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:604ef064c6d91068eeb9d946036d8ffadbe25589c4cd77a230fc96e0f6d01d72 +FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:8a26226e58ec52c5defb37b876584df99f94bec70f1081c4014fdf25c994d51e # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 86903f81179e9d6649b834eb619075b9dbbec4ba Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 1 Oct 2025 09:13:20 -0700 Subject: [PATCH 1450/1753] Drop devcontainer folder from microbuild repos The pinned Docker image changes too frequently, causing high severity security alerts, and we don't even hardly use this file. --- .devcontainer/Dockerfile | 14 -------------- .devcontainer/devcontainer.json | 25 ------------------------- 2 files changed, 39 deletions(-) delete mode 100644 .devcontainer/Dockerfile delete mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile deleted file mode 100644 index 2c0bd561c..000000000 --- a/.devcontainer/Dockerfile +++ /dev/null @@ -1,14 +0,0 @@ -# Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:8a26226e58ec52c5defb37b876584df99f94bec70f1081c4014fdf25c994d51e - -# Installing mono makes `dotnet test` work without errors even for net472. -# But installing it takes a long time, so it's excluded by default. -#RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF -#RUN echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic main" | tee /etc/apt/sources.list.d/mono-official-stable.list -#RUN apt-get update -#RUN DEBIAN_FRONTEND=noninteractive apt-get install -y mono-devel - -# Clear the NUGET_XMLDOC_MODE env var so xml api doc files get unpacked, allowing a rich experience in Intellisense. -# See https://github.com/dotnet/dotnet-docker/issues/2790 for a discussion on this, where the prioritized use case -# was *not* devcontainers, sadly. -ENV NUGET_XMLDOC_MODE= diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json deleted file mode 100644 index 1a3a00866..000000000 --- a/.devcontainer/devcontainer.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "name": "Dev space", - "dockerFile": "Dockerfile", - "customizations": { - "vscode": { - "settings": { - "terminal.integrated.shell.linux": "/usr/bin/pwsh" - }, - "extensions": [ - "ms-azure-devops.azure-pipelines", - "ms-dotnettools.csharp", - "k--kato.docomment", - "editorconfig.editorconfig", - "esbenp.prettier-vscode", - "pflannery.vscode-versionlens", - "davidanson.vscode-markdownlint", - "dotjoshjohnson.xml", - "ms-vscode-remote.remote-containers", - "ms-azuretools.vscode-docker", - "tintoy.msbuild-project-tools" - ] - } - }, - "postCreateCommand": "./init.ps1 -InstallLocality machine" -} From 97119efc181001bec8a68705f817a354f91f983b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 2 Oct 2025 10:52:49 -0700 Subject: [PATCH 1451/1753] Update dependency Microsoft.NET.Test.Sdk to v18 (#422) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index aa5788c47..91c1e03d6 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,7 +9,7 @@ - + From 870263bde71884ab9cc7492ad73cac298b789063 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 2 Oct 2025 10:53:05 -0700 Subject: [PATCH 1452/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.305-noble Docker digest to 9ae2f68 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 2c0bd561c..5edfe781f 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:8a26226e58ec52c5defb37b876584df99f94bec70f1081c4014fdf25c994d51e +FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:9ae2f68485dc3385e76e38524806fd159988b6e525ea5f27a4870bdf8bc0fe72 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 184e741e11a04a5801fe63434de0e83e590fbbf4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Oct 2025 10:58:46 -0600 Subject: [PATCH 1453/1753] Add `repo` command as a CLI tool --- .config/dotnet-tools.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index f8c4a2644..39724560f 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -29,6 +29,13 @@ "docfx" ], "rollForward": false + }, + "nerdbank.dotnetrepotools": { + "version": "1.0.92", + "commands": [ + "repo" + ], + "rollForward": false } } -} +} \ No newline at end of file From 705966a7b1e897d7dcef98528b8ec1132eec90d5 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 8 Oct 2025 06:19:47 -0600 Subject: [PATCH 1454/1753] Update dependency dotnet-coverage to v18.1.0 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 39724560f..859d3f470 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.0.4", + "version": "18.1.0", "commands": [ "dotnet-coverage" ], From 217b879a0d5f4fa1148c69daf46efa35d306dc40 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 13 Oct 2025 12:26:43 -0600 Subject: [PATCH 1455/1753] Activate CFSClean network isolation policy This will prevent all Library.Template pipelines from accessing nuget.org or other public package feeds directly. Instead, Azure Artifacts feeds should be used. --- azure-pipelines/archive-sourcecode.yml | 2 ++ azure-pipelines/libtemplate-update.yml | 2 ++ azure-pipelines/official.yml | 2 ++ azure-pipelines/release.yml | 2 ++ azure-pipelines/unofficial.yml | 2 ++ azure-pipelines/vs-insertion.yml | 2 ++ azure-pipelines/vs-validation.yml | 2 ++ 7 files changed, 14 insertions(+) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 77f243bc4..7f35de40c 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -35,6 +35,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index 384be7cfc..a0421bd6a 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -30,6 +30,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: name: AzurePipelines-EO diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 6d7c02130..ab66443c8 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -45,6 +45,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES codeSignValidation: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 3100e4b74..73418a977 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -20,6 +20,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index d72327353..bc2e88e0f 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -55,6 +55,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES credscan: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index c19331d42..71c904149 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -23,6 +23,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index b9d46b7c7..b6c79abaf 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -26,6 +26,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES credscan: From 6a4e43cebdecb716b377a17152569e1ccc79b832 Mon Sep 17 00:00:00 2001 From: "Pierson Lee (PIE)" Date: Mon, 13 Oct 2025 15:32:53 -0700 Subject: [PATCH 1456/1753] Split the VS PR stage separately from the upload steps There is sometimes an issue with the clone/create PR step. When that happens, the stage isn't requeuable because the VSTS upload step fails when its run again because the payload is already there. This update allows the step to clone the VS repo and create the PR to be rerun due to issues independent of the Upload step. --- azure-pipelines/vs-insertion.yml | 24 +++++++++++++++++++++--- azure-pipelines/vs-validation.yml | 29 +++++++++++++++++++++++++---- 2 files changed, 46 insertions(+), 7 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index c19331d42..23e8a058a 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -27,10 +27,10 @@ extends: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES stages: - - stage: insertion + - stage: upload_payload jobs: - - job: insertion - displayName: VS insertion + - job: upload_payload + displayName: Upload VS payload pool: VSEngSS-MicroBuild2022-1ES templateContext: outputParentDirectory: $(Pipeline.Workspace)/CI @@ -56,6 +56,24 @@ extends: packageParentPath: $(Pipeline.Workspace)/CI/VSInsertion-Windows allowPackageConflicts: true publishVstsFeed: VS + + - stage: insertion + dependsOn: upload_payload + condition: succeeded('upload_payload') + jobs: + - job: insertion + displayName: VS insertion + pool: VSEngSS-MicroBuild2022-1ES + templateContext: + outputParentDirectory: $(Pipeline.Workspace)/CI + steps: + - checkout: none + - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" + displayName: ⚙️ Set pipeline name + - template: azure-pipelines/release-deployment-prep.yml@self + - download: CI + artifact: VSInsertion-Windows + displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index b9d46b7c7..42d1dab7c 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -63,11 +63,11 @@ extends: ArchiveSymbols: false RealSign: false - - stage: insertion - displayName: VS insertion + - stage: upload_payload + displayName: Upload VS payload jobs: - - job: insertion - displayName: VS insertion + - job: upload_payload + displayName: Upload VS payload pool: VSEngSS-MicroBuild2022-1ES steps: - checkout: self @@ -95,6 +95,27 @@ extends: packageParentPath: $(Pipeline.Workspace)/VSInsertion-Windows allowPackageConflicts: true publishVstsFeed: VS + + - stage: insertion + displayName: VS insertion + dependsOn: upload_payload + condition: succeeded('upload_payload') + jobs: + - job: insertion + displayName: VS insertion + pool: VSEngSS-MicroBuild2022-1ES + steps: + - checkout: self + clean: true + fetchDepth: 1 + - download: current + artifact: Variables-Windows + displayName: 🔻 Download Variables-Windows artifact + - powershell: $(Pipeline.Workspace)/Variables-Windows/_define.ps1 + displayName: ⚙️ Set pipeline variables based on artifacts + - download: current + artifact: VSInsertion-Windows + displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: From 461d00fbb95eabbf2f268a70ca29c5239adddb21 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 14 Oct 2025 18:17:34 -0600 Subject: [PATCH 1457/1753] Update Dockerfile and global.json updates to v9.0.306 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 5edfe781f..5d1972270 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.305-noble@sha256:9ae2f68485dc3385e76e38524806fd159988b6e525ea5f27a4870bdf8bc0fe72 +FROM mcr.microsoft.com/dotnet/sdk:9.0.306-noble@sha256:953b8dd2d8e25c934579905b00d7077c5622632ff617f471a211ce9b72013205 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 6fea1e98e..cfaecd0dd 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.305", + "version": "9.0.306", "rollForward": "patch", "allowPrerelease": false } From 9ca01b2dcd7574b32b5e7b1572916e544450e247 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 16 Oct 2025 17:07:41 -0600 Subject: [PATCH 1458/1753] Split into jobs instead of stages Also remove a task that was duplicated (I think) unnecessarily. --- azure-pipelines/vs-insertion.yml | 16 ++++------------ azure-pipelines/vs-validation.yml | 15 ++++----------- 2 files changed, 8 insertions(+), 23 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 23e8a058a..ba9b521f5 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -27,9 +27,9 @@ extends: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES stages: - - stage: upload_payload + - stage: insertion jobs: - - job: upload_payload + - job: upload displayName: Upload VS payload pool: VSEngSS-MicroBuild2022-1ES templateContext: @@ -57,23 +57,15 @@ extends: allowPackageConflicts: true publishVstsFeed: VS - - stage: insertion - dependsOn: upload_payload - condition: succeeded('upload_payload') - jobs: - - job: insertion + - job: insert + dependsOn: upload displayName: VS insertion pool: VSEngSS-MicroBuild2022-1ES templateContext: outputParentDirectory: $(Pipeline.Workspace)/CI steps: - checkout: none - - powershell: Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" - displayName: ⚙️ Set pipeline name - template: azure-pipelines/release-deployment-prep.yml@self - - download: CI - artifact: VSInsertion-Windows - displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 42d1dab7c..4319884e1 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -63,10 +63,10 @@ extends: ArchiveSymbols: false RealSign: false - - stage: upload_payload - displayName: Upload VS payload + - stage: insertion + displayName: VS insertion jobs: - - job: upload_payload + - job: upload displayName: Upload VS payload pool: VSEngSS-MicroBuild2022-1ES steps: @@ -96,13 +96,9 @@ extends: allowPackageConflicts: true publishVstsFeed: VS - - stage: insertion - displayName: VS insertion - dependsOn: upload_payload - condition: succeeded('upload_payload') - jobs: - job: insertion displayName: VS insertion + dependsOn: upload pool: VSEngSS-MicroBuild2022-1ES steps: - checkout: self @@ -113,9 +109,6 @@ extends: displayName: 🔻 Download Variables-Windows artifact - powershell: $(Pipeline.Workspace)/Variables-Windows/_define.ps1 displayName: ⚙️ Set pipeline variables based on artifacts - - download: current - artifact: VSInsertion-Windows - displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: From 3f2ca0571b4cbaa166f81be9dfcf3ba149571bd8 Mon Sep 17 00:00:00 2001 From: Pierson Lee Date: Thu, 16 Oct 2025 16:49:50 -0700 Subject: [PATCH 1459/1753] Update InsertJsonValues to handle folders (#391) * Update InsertJsonValues to handle folders If the VSMan is in a nested folder, then the folder becomes part of the upload. Updated the InsertJsonValues to handle that. * Move BasePath Resolve-Path inside the test-path * Update comments and logic to make it cleaner --- tools/variables/InsertJsonValues.ps1 | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/tools/variables/InsertJsonValues.ps1 b/tools/variables/InsertJsonValues.ps1 index 7aa8d30c1..fb9390c53 100644 --- a/tools/variables/InsertJsonValues.ps1 +++ b/tools/variables/InsertJsonValues.ps1 @@ -8,11 +8,25 @@ $BasePath = "$PSScriptRoot\..\..\bin\Packages\$BuildConfiguration\Vsix" if (Test-Path $BasePath) { $vsmanFiles = @() - Get-ChildItem $BasePath *.vsman -Recurse -File |% { + Get-ChildItem $BasePath *.vsman -Recurse -File | % { $version = (Get-Content $_.FullName | ConvertFrom-Json).info.buildVersion + $fullPath = (Resolve-Path $_.FullName).Path + $basePath = (Resolve-Path $BasePath).Path + # Cannot use RelativePath or GetRelativePath due to Powershell Core v2.0 limitation + if ($fullPath.StartsWith($basePath, [StringComparison]::OrdinalIgnoreCase)) { + # Get the relative paths then make sure the directory separators match URL format. + $rfn = $fullPath.Substring($basePath.Length).TrimStart('\', '/').Replace('\', '/') + } + else { + $rfn = $fullPath # fallback to full path if it doesn't start with base path + } + $fn = $_.Name - $vsmanFiles += "$fn{$version}=https://vsdrop.corp.microsoft.com/file/v1/$vstsDropNames;$fn" + + # The left side is filename followed by the version and the right side is the drop url and the relative filename + $thisVsManFile = "$fn{$version}=https://vsdrop.corp.microsoft.com/file/v1/$vstsDropNames;$rfn" + $vsmanFiles += $thisVsManFile } - [string]::join(',',$vsmanFiles) + [string]::join(',', $vsmanFiles) } From 206b88c3d7a08d32f10a7c964257fec455f5544a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 16 Oct 2025 23:55:50 +0000 Subject: [PATCH 1460/1753] Update dependency powershell to v7.5.4 (#427) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 859d3f470..c52d1103c 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.5.3", + "version": "7.5.4", "commands": [ "pwsh" ], From f0720455725ef509d7c5fcafb0b467d4db2b6410 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 17 Oct 2025 07:17:41 -0600 Subject: [PATCH 1461/1753] Update mcr.microsoft.com/dotnet/sdk:9.0.306-noble Docker digest to d88e637 (#428) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 5d1972270..f98875898 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.306-noble@sha256:953b8dd2d8e25c934579905b00d7077c5622632ff617f471a211ce9b72013205 +FROM mcr.microsoft.com/dotnet/sdk:9.0.306-noble@sha256:d88e637d15248531967111fba05c6725ad45ea1dace3d35d8cfe2c4d4094e25d # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 7e4ea51340538870532f55b1010a0e165ed57293 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 17 Oct 2025 08:50:18 -0700 Subject: [PATCH 1462/1753] Merge pull request #1415 from microsoft/renovate/microsoft.windows.cswin32-0.x Update dependency Microsoft.Windows.CsWin32 to 0.3.217 --- Directory.Packages.props | 2 +- .../Microsoft.VisualStudio.Threading.csproj | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ac7953d3d..c64197f9d 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + diff --git a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj index 894de4e05..7f9c90429 100644 --- a/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj +++ b/src/Microsoft.VisualStudio.Threading/Microsoft.VisualStudio.Threading.csproj @@ -10,6 +10,7 @@ true true + System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute 17.14.15 From 03563e49fb6f4bc99cb768e8659869a82d7fb683 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 20 Oct 2025 17:03:00 -0600 Subject: [PATCH 1463/1753] Move `GitHubRelease` task to a release job --- azure-pipelines/release.yml | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 73418a977..aea1a2d9b 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -28,7 +28,8 @@ extends: stages: - stage: release jobs: - - job: release + - job: nuget + displayName: 📦 Push nuget.org packages pool: name: AzurePipelines-EO demands: @@ -45,6 +46,28 @@ extends: publishFeedCredentials: VisualStudioExtensibility (nuget.org) steps: - checkout: none + - download: CI + artifact: deployables-Windows + displayName: 🔻 Download deployables-Windows artifact + patterns: 'NuGet/*' + - job: github + displayName: 📢 GitHub release + dependsOn: nuget + pool: + name: AzurePipelines-EO + demands: + - ImageOverride -equals 1ESPT-Ubuntu22.04 + os: Linux + templateContext: + type: releaseJob + isProduction: true + inputs: + - input: pipelineArtifact + pipeline: CI + artifactName: deployables-Windows + targetPath: $(Pipeline.Workspace)/CI/deployables-Windows + steps: + - checkout: none - powershell: | Write-Host "##vso[build.updatebuildnumber]$(resources.pipeline.CI.runName)" if ('$(resources.pipeline.CI.runName)'.Contains('-')) { @@ -53,10 +76,6 @@ extends: Write-Host "##vso[task.setvariable variable=IsPrerelease]false" } displayName: ⚙ Set up pipeline - - download: CI - artifact: deployables-Windows - displayName: 🔻 Download deployables-Windows artifact - patterns: 'NuGet/*' - task: GitHubRelease@1 displayName: 📢 GitHub release (create) inputs: From 9c70c31dac48ab456f518229fdcb8c6d34f600f0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 21 Oct 2025 20:47:17 -0600 Subject: [PATCH 1464/1753] Fix analyzer tests to pull packages from our nuget.config feed This fixes a Azure Pipeline break in the devdiv projedct where network isolation is enabled. --- .../Helpers/ReferencesHelper.cs | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 329c8bdc9..50edf5917 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -1,13 +1,19 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +#pragma warning disable SA1202 // Elements should be ordered by access - because field initializer depend on each other + +using System; using System.Collections.Immutable; +using System.IO; using System.Net; namespace Microsoft.VisualStudio.Threading.Analyzers.Tests; internal static class ReferencesHelper { + private static readonly string NuGetConfigPath = FindNuGetConfigPath(); + #if NETFRAMEWORK public static ReferenceAssemblies DefaultReferences = ReferenceAssemblies.NetFramework.Net471.Default #elif NET8_0 @@ -15,6 +21,7 @@ internal static class ReferencesHelper #else #error Fix TFM conditions #endif + .WithNuGetConfigFilePath(NuGetConfigPath) .WithPackages(ImmutableArray.Create( new PackageIdentity("System.Collections.Immutable", "6.0.0"), new PackageIdentity("System.Threading.Tasks.Extensions", "4.6.0"), @@ -32,4 +39,21 @@ static ReferencesHelper() ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; #pragma warning restore RS0030 // Do not used banned APIs } + + private static string FindNuGetConfigPath() + { + string? path = AppContext.BaseDirectory; + while (path is not null) + { + string candidate = Path.Combine(path, "nuget.config"); + if (File.Exists(candidate)) + { + return candidate; + } + + path = Path.GetDirectoryName(path); + } + + throw new InvalidOperationException("Could not find NuGet.config by searching up from " + AppContext.BaseDirectory); + } } From a880a38116eedf9893cbb9afcaaa8f633e98b357 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Oct 2025 07:53:58 -0600 Subject: [PATCH 1465/1753] Drop EnableOptProf parameter where it is unused --- azure-pipelines/build.yml | 2 -- azure-pipelines/microbuild.after.yml | 3 --- azure-pipelines/microbuild.before.yml | 3 --- 3 files changed, 8 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 3db1adde0..b68abbc7f 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -191,7 +191,6 @@ jobs: - template: microbuild.before.yml parameters: EnableLocalization: ${{ parameters.EnableLocalization }} - EnableOptProf: ${{ parameters.EnableOptProf }} IsOptProf: ${{ parameters.IsOptProf }} ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} RealSign: ${{ parameters.RealSign }} @@ -211,7 +210,6 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml parameters: - EnableOptProf: ${{ parameters.EnableOptProf }} IsOptProf: ${{ parameters.IsOptProf }} SkipCodesignVerify: ${{ parameters.SkipCodesignVerify }} diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 025de4f5f..67ba90080 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,7 +1,4 @@ parameters: -- name: EnableOptProf - type: boolean - default: false - name: IsOptProf type: boolean default: false diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index d09310b1e..b169460c4 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -2,9 +2,6 @@ parameters: - name: EnableLocalization type: boolean default: false -- name: EnableOptProf - type: boolean - default: false - name: IsOptProf type: boolean default: false From a16d3f4213237f1b70c1f592edb466a4acac8bab Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Oct 2025 10:17:23 -0600 Subject: [PATCH 1466/1753] Add SBOM to `deployables` pipeline artifact This is required for consumption from production release jobs. --- azure-pipelines/build.yml | 60 ++++++++++++++++++++++-------------- azure-pipelines/official.yml | 1 + 2 files changed, 38 insertions(+), 23 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index b68abbc7f..c23a028e4 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -29,14 +29,17 @@ parameters: - name: artifact_names type: object default: - - build_logs - - coverageResults - - deployables - - projectAssetsJson - - symbols - - testResults - - test_symbols - - Variables + - name: build_logs + - name: coverageResults + - name: deployables + sbomEnabled: true + - name: projectAssetsJson + - name: symbols + - name: testResults + testOnly: true + - name: test_symbols + testOnly: true + - name: Variables # The Enable*Build parameters turn non-Windows agents on or off. # Their default value should be based on whether the build and tests are expected/required to pass on that platform. # Callers (e.g. Official.yml) *may* expose these parameters at queue-time in order to turn OFF optional agents. @@ -57,6 +60,11 @@ parameters: - name: Is1ESPT type: boolean +# Indicates whether the 'official' 1ES PT templates are being used (as opposed to the unofficial ones). +- name: Is1ESPTOfficial + type: boolean + default: false + - name: RealSign type: boolean default: false @@ -148,12 +156,14 @@ jobs: outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - ${{ each artifact in parameters.artifact_names }}: + - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-Windows - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Windows - artifactName: ${{ artifact_name }}-Windows + displayName: 📢 Publish ${{ artifact.name }}-Windows + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Windows + artifactName: ${{ artifact.name }}-Windows + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true condition: succeededOrFailed() - output: pipelineArtifact displayName: 📢 Publish VSInsertion-Windows @@ -229,12 +239,14 @@ jobs: signWithProd: true outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - ${{ each artifact in parameters.artifact_names }}: + - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-Linux - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-Linux - artifactName: ${{ artifact_name }}-Linux + displayName: 📢 Publish ${{ artifact.name }}-Linux + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Linux + artifactName: ${{ artifact.name }}-Linux + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true condition: succeededOrFailed() steps: - checkout: self @@ -266,12 +278,14 @@ jobs: signWithProd: true outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - - ${{ each artifact_name in parameters.artifact_names }}: - - ${{ if or(ne(artifact_name, 'testResults'), parameters.RunTests) }}: + - ${{ each artifact in parameters.artifact_names }}: + - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact_name }}-macOS - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact_name }}-macOS - artifactName: ${{ artifact_name }}-macOS + displayName: 📢 Publish ${{ artifact.name }}-macOS + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-macOS + artifactName: ${{ artifact.name }}-macOS + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true condition: succeededOrFailed() steps: - checkout: self diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index ab66443c8..54049629a 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -68,6 +68,7 @@ extends: - template: /azure-pipelines/build.yml@self parameters: Is1ESPT: true + Is1ESPTOfficial: true RealSign: true # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableAPIScan: ${{ parameters.EnableAPIScan }} From df796774958dd93caad197da1c906fca360b83f7 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 20:57:02 +0000 Subject: [PATCH 1467/1753] Update dependency Microsoft.Windows.CsWin32 to 0.3.228 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c64197f9d..e6915d28b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From f3393ad1756b2fb45ba906632e1f7d5c328fa9e6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Oct 2025 18:08:09 -0600 Subject: [PATCH 1468/1753] Bump MicroBuildVersion to 2.0.208 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 36dfba20a..a8f5bc954 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -5,7 +5,7 @@ true true - 2.0.201 + 2.0.208 From dd97dcaf812067a5568d7642a2ac5882cb159873 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Oct 2025 07:07:24 -0600 Subject: [PATCH 1469/1753] Fix artifact publishing failures due to prior failed attempts --- azure-pipelines/build.yml | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index c23a028e4..078cb8396 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -164,7 +164,13 @@ jobs: artifactName: ${{ artifact.name }}-Windows ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: sbomEnabled: true - condition: succeededOrFailed() + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-Windows (for failed attempts) + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Windows + artifactName: ${{ artifact.name }}-Windows-$(System.PhaseAttempt) + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + condition: failed() - output: pipelineArtifact displayName: 📢 Publish VSInsertion-Windows targetPath: $(Build.ArtifactStagingDirectory)/VSInsertion-Windows @@ -247,7 +253,13 @@ jobs: artifactName: ${{ artifact.name }}-Linux ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: sbomEnabled: true - condition: succeededOrFailed() + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-Linux (for failed attempts) + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Linux + artifactName: ${{ artifact.name }}-Linux-$(System.PhaseAttempt) + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + condition: failed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. @@ -286,7 +298,13 @@ jobs: artifactName: ${{ artifact.name }}-macOS ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: sbomEnabled: true - condition: succeededOrFailed() + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-macOS (for failed attempts) + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-macOS + artifactName: ${{ artifact.name }}-macOS-$(System.PhaseAttempt) + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + condition: failed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. From 9389c4868a594ea30efa805cb40781ac4c80a29f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Oct 2025 09:50:09 -0600 Subject: [PATCH 1470/1753] Switch from sln to slnx --- Library.sln | 63 ---------------------------------------------------- Library.slnx | 26 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 63 deletions(-) delete mode 100644 Library.sln create mode 100644 Library.slnx diff --git a/Library.sln b/Library.sln deleted file mode 100644 index 5c81b3068..000000000 --- a/Library.sln +++ /dev/null @@ -1,63 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 18 -VisualStudioVersion = 18.0.11023.372 main -MinimumVisualStudioVersion = 15.0.26124.0 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library", "src\Library\Library.csproj", "{C06D702E-6FC7-453B-BDDF-608F825EC003}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Library.Tests", "test\Library.Tests\Library.Tests.csproj", "{DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1CE9670B-D5FF-46A7-9D00-24E70E6ED48B}" - ProjectSection(SolutionItems) = preProject - .editorconfig = .editorconfig - Directory.Build.props = Directory.Build.props - Directory.Build.targets = Directory.Build.targets - Directory.Packages.props = Directory.Packages.props - .config\dotnet-tools.json = .config\dotnet-tools.json - global.json = global.json - nuget.config = nuget.config - README.md = README.md - stylecop.json = stylecop.json - version.json = version.json - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{9E154A29-1796-4B85-BD81-B6A385D8FF71}" - ProjectSection(SolutionItems) = preProject - src\.editorconfig = src\.editorconfig - src\Directory.Build.props = src\Directory.Build.props - src\Directory.Build.targets = src\Directory.Build.targets - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{36CCE840-6FE5-4DB9-A8D5-8CF3CB6D342A}" - ProjectSection(SolutionItems) = preProject - test\.editorconfig = test\.editorconfig - test\Directory.Build.props = test\Directory.Build.props - test\Directory.Build.targets = test\Directory.Build.targets - EndProjectSection -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {C06D702E-6FC7-453B-BDDF-608F825EC003}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {C06D702E-6FC7-453B-BDDF-608F825EC003}.Debug|Any CPU.Build.0 = Debug|Any CPU - {C06D702E-6FC7-453B-BDDF-608F825EC003}.Release|Any CPU.ActiveCfg = Release|Any CPU - {C06D702E-6FC7-453B-BDDF-608F825EC003}.Release|Any CPU.Build.0 = Release|Any CPU - {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Debug|Any CPU.Build.0 = Debug|Any CPU - {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Release|Any CPU.ActiveCfg = Release|Any CPU - {DC5F3D1C-A9A3-44B7-A3C0-82C1FF4C3336}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {9E154A29-1796-4B85-BD81-B6A385D8FF71} = {1CE9670B-D5FF-46A7-9D00-24E70E6ED48B} - {36CCE840-6FE5-4DB9-A8D5-8CF3CB6D342A} = {1CE9670B-D5FF-46A7-9D00-24E70E6ED48B} - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {E3944F6A-384B-4B0F-B93F-3BD513DC57BD} - EndGlobalSection -EndGlobal diff --git a/Library.slnx b/Library.slnx new file mode 100644 index 000000000..dc016d9e2 --- /dev/null +++ b/Library.slnx @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + From 68801e8c8d8c4d1a32e797447da3bbb0f45dbf72 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Oct 2025 10:39:16 -0600 Subject: [PATCH 1471/1753] Clarify that symbols should be only 1st party --- ...rdPartySymbolFiles.ps1 => Get-ExternalSymbolFiles.ps1} | 8 +++++--- tools/artifacts/symbols.ps1 | 6 +++--- 2 files changed, 8 insertions(+), 6 deletions(-) rename tools/{Get-3rdPartySymbolFiles.ps1 => Get-ExternalSymbolFiles.ps1} (93%) diff --git a/tools/Get-3rdPartySymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 similarity index 93% rename from tools/Get-3rdPartySymbolFiles.ps1 rename to tools/Get-ExternalSymbolFiles.ps1 index ef6bbef28..5ad2a1960 100644 --- a/tools/Get-3rdPartySymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -79,11 +79,13 @@ Function Get-PackageVersion($id) { $version } -# All 3rd party packages for which symbols packages are expected should be listed here. +# All 1st party packages for which symbols packages are expected should be listed here. # These must all be sourced from nuget.org, as it is the only feed that supports symbol packages. -$3rdPartyPackageIds = @() +# We should NOT add 3rd party packages to this list because PDBs may be unsafe for our debuggers to load, +# so we should only archive 1st party symbols. +$1stPartyPackageIds = @() -$3rdPartyPackageIds | % { +$1stPartyPackageIds | % { $version = Get-PackageVersion $_ if ($version) { Get-SymbolsFromPackage -id $_ -version $version diff --git a/tools/artifacts/symbols.ps1 b/tools/artifacts/symbols.ps1 index b5882678a..91f83f0d4 100644 --- a/tools/artifacts/symbols.ps1 +++ b/tools/artifacts/symbols.ps1 @@ -1,10 +1,10 @@ $BinPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../bin") -$3rdPartyPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../obj/SymbolsPackages") +$ExternalPath = [System.IO.Path]::GetFullPath("$PSScriptRoot/../../obj/SymbolsPackages") if (!(Test-Path $BinPath)) { return } $symbolfiles = & "$PSScriptRoot/../Get-SymbolFiles.ps1" -Path $BinPath | Get-Unique -$3rdPartyFiles = & "$PSScriptRoot/../Get-3rdPartySymbolFiles.ps1" +$ExternalFiles = & "$PSScriptRoot/../Get-ExternalSymbolFiles.ps1" @{ "$BinPath" = $SymbolFiles; - "$3rdPartyPath" = $3rdPartyFiles; + "$ExternalPath" = $ExternalFiles; } From d1ffba297bb3b6d7b9a0ce0c6e996d28f0189085 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 24 Oct 2025 06:54:09 -0600 Subject: [PATCH 1472/1753] Fix template expansion after slnx rename --- Expand-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index ae1623131..c71e4625b 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -99,7 +99,7 @@ try { git config core.safecrlf false # Avoid warnings when adding files with mangled line endings # Rename project directories and solution - git mv Library.sln "$LibraryName.sln" + git mv Library.slnx "$LibraryName.slnx" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv src/Library/Library.csproj "src/Library/$LibraryName.csproj" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } From b725deef78ecaa3a392d7b1042e6851af326d13a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 24 Oct 2025 09:52:21 -0600 Subject: [PATCH 1473/1753] Another template expansion fix --- Expand-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index c71e4625b..04cf503d5 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -119,7 +119,7 @@ try { if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } dotnet sln add "test/$LibraryName.Tests" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - git add "$LibraryName.sln" + git add "$LibraryName.slnx" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Update project reference in test project. Add before removal to keep the same ItemGroup in place. From cbf20ad05664311e9c7bc8e45bcccf78958b56c3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 24 Oct 2025 16:01:39 +0000 Subject: [PATCH 1474/1753] Update dependency docfx to v2.78.4 (#429) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index c52d1103c..536052ffc 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -24,7 +24,7 @@ "rollForward": false }, "docfx": { - "version": "2.78.3", + "version": "2.78.4", "commands": [ "docfx" ], From 4ee59042346577d75dc6e81f567115d9182c8acb Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 24 Oct 2025 21:12:23 -0600 Subject: [PATCH 1475/1753] Update GitHub Artifact Actions Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/actions/publish-artifacts/action.yaml | 14 +++++++------- .github/workflows/release.yml | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 1f345fe6f..3b267f3e7 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -14,46 +14,46 @@ runs: - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b84d90771..ee4159b84 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,7 +57,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5 + uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From 20dc055e095214d84947a77cb77bfae11ffe7d1e Mon Sep 17 00:00:00 2001 From: Sandy Armstrong Date: Wed, 29 Oct 2025 09:09:49 -0700 Subject: [PATCH 1476/1753] Increase retry count on NOTICE task failure to 10 We have seen this task fail as many as 9 times in a row. It has various issues and has recently been handed to a new team. Hopefully reliability will improve, but for now, it may be helpful to increase retries more broadly. --- azure-pipelines/microbuild.before.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index b169460c4..fd47d1bb9 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -23,7 +23,7 @@ steps: inputs: outputfile: $(System.DefaultWorkingDirectory)/obj/NOTICE outputformat: text - retryCountOnTaskFailure: 3 # fails when the cloud service is overloaded + retryCountOnTaskFailure: 10 # fails when the cloud service is overloaded continueOnError: ${{ not(parameters.RealSign) }} # Tolerate failures when we're not building something that may ship. - ${{ if parameters.IsOptProf }}: From fe333c17a9ee6c538907695905703cbd7fcea3d1 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 2 Nov 2025 20:50:53 -0700 Subject: [PATCH 1477/1753] Update dependency xunit.v3 to 3.2.0 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 91c1e03d6..6760e38c6 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ - + From ccb8e49efe28bf8939880cb01220e191bf712f99 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 15:45:22 +0000 Subject: [PATCH 1478/1753] Update nbgv and nerdbank.gitversioning updates to 3.9.50 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 536052ffc..9f9de05c4 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -17,7 +17,7 @@ "rollForward": false }, "nbgv": { - "version": "3.8.118", + "version": "3.9.50", "commands": [ "nbgv" ], diff --git a/Directory.Packages.props b/Directory.Packages.props index 6760e38c6..78310fd9f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -20,7 +20,7 @@ - + From 26a3acc0e34835e40614962ca3594b3d6e82d4c5 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 5 Nov 2025 13:40:10 -0700 Subject: [PATCH 1479/1753] Fix variable persistence when value includes a single quote --- tools/artifacts/Variables.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/artifacts/Variables.ps1 b/tools/artifacts/Variables.ps1 index 7a320c7ea..c4d976650 100644 --- a/tools/artifacts/Variables.ps1 +++ b/tools/artifacts/Variables.ps1 @@ -26,7 +26,7 @@ Get-ChildItem "$PSScriptRoot/../variables" |% { if ($value) { # We got something, so wrap it with quotes so it's treated like a literal value. - $value = "'$value'" + $value = "'" + $value.Replace("'", "''") + "'" } } From 17d786e15cfe285e84290df77c2d695721daa8c3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 8 Nov 2025 08:10:21 -0700 Subject: [PATCH 1480/1753] Drop redundant condition from YAML --- .github/workflows/docs_validate.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 7ac73e71a..c3e76e550 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -27,4 +27,3 @@ jobs: shell: pwsh - name: 📚 Verify docfx build run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures - if: runner.os == 'Linux' From d6be5cffe1ea7fbcc71f8f07b6ff1a3b62f65a40 Mon Sep 17 00:00:00 2001 From: trevors20 <49179298+trevors20@users.noreply.github.com> Date: Mon, 10 Nov 2025 12:08:36 -0800 Subject: [PATCH 1481/1753] Merge pull request 435 from trevors20/dev/trevors/microbuild/updateinsert251110 Add the VSDrop service connection to the insert vs payload --- azure-pipelines/OptProf.yml | 4 ++++ azure-pipelines/vs-insertion.yml | 5 +++++ azure-pipelines/vs-validation.yml | 4 ++++ 3 files changed, 13 insertions(+) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index a70b93629..515e72a3e 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -97,6 +97,10 @@ stages: TeamEmail: $(TeamEmail) SkipCreatePR: true CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + ConnectedVSDropServiceName: 'VSEng-VSDrop-MI' + env: + SYSTEM_ACCESSTOKEN: $(System.AccessToken) - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 displayName: Trigger a new build of DD-CB-TestSignVS-devCI inputs: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 71c904149..2899a6a08 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -69,6 +69,11 @@ extends: AutoCompletePR: true AutoCompleteMergeStrategy: Squash ShallowClone: true + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + ConnectedVSDropServiceName: 'VSEng-VSDrop-MI' + env: + SYSTEM_ACCESSTOKEN: $(System.AccessToken) + - powershell: | $contentType = 'application/json'; $headers = @{ Authorization = 'Bearer $(System.AccessToken)' }; diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index b6c79abaf..bd6a0aaf5 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -111,6 +111,10 @@ extends: DraftPR: false # set to true and update InsertionBuildPolicy when we can specify all the validations we want to run (https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2224288) AutoCompletePR: false ShallowClone: true + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + ConnectedVSDropServiceName: 'VSEng-VSDrop-MI' + env: + SYSTEM_ACCESSTOKEN: $(System.AccessToken) - powershell: | $insertionPRId = azure-pipelines/Get-InsertionPRId.ps1 $Markdown = @" From 74d3a45218a42251990819333ce3470b4a2b6fdd Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 06:04:00 -0800 Subject: [PATCH 1482/1753] Update dependency Microsoft.NET.Test.Sdk to 18.0.1 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 78310fd9f..c0924a538 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -9,7 +9,7 @@ - + From 45dad1e64b14647a7230db65fd058044036d719e Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Tue, 11 Nov 2025 12:06:08 -0800 Subject: [PATCH 1483/1753] reduce overhead when running in no main thread mode (#1502) * Do not track nested factory when there is no main thread Generally, post to context would not be used as SwitchToMainThread is no-op in this context. Even it is being called under certain corner cases, it would just queue the same work item to the thread pool multiple times, so better to prevent the allocation in the first place. * Do not turn on SynchronouslyBlockingMainThread flag on when the JTF is used in no main thread mode. Because IsOnMainThread is just to check the thread id, this can be turned on randomly when the code is running in the initial thread pool thread. It would turn on expensive dependency tracking graph, which is not what we expect to do. * stop creating main thread synchronization context when running in no main thread mode. --------- Co-authored-by: Lifeng Lu --- .../JoinableTask.cs | 7 +++-- .../JoinableTaskFactory.cs | 27 ++++++++++--------- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index e82404d4c..7490f3672 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -8,7 +8,6 @@ using System.Linq; using System.Reflection; using System.Runtime.CompilerServices; -using System.Text; using System.Threading; using System.Threading.Tasks; using JoinRelease = Microsoft.VisualStudio.Threading.JoinableTaskCollection.JoinRelease; @@ -147,7 +146,7 @@ internal JoinableTask(JoinableTaskFactory owner, bool synchronouslyBlocking, str this.state |= JoinableTaskFlags.StartedSynchronously | JoinableTaskFlags.CompletingSynchronously; } - if (owner.Context.IsOnMainThread) + if (owner.Context.IsOnMainThread && !this.JoinableTaskContext.IsNoOpContext) { this.state |= JoinableTaskFlags.StartedOnMainThread; if (synchronouslyBlocking) @@ -321,7 +320,7 @@ internal SynchronizationContext? ApplicableJobSyncContext { get { - if (this.JoinableTaskContext.IsOnMainThread) + if (this.JoinableTaskContext.IsOnMainThread && !this.JoinableTaskContext.IsNoOpContext) { if (this.mainThreadJobSyncContext is null) { @@ -977,7 +976,7 @@ internal void CompleteOnCurrentThread() { bool onMainThread = false; JoinableTaskFlags additionalFlags = JoinableTaskFlags.CompletingSynchronously; - if (this.JoinableTaskContext.IsOnMainThread) + if (this.JoinableTaskContext.IsOnMainThread && !this.JoinableTaskContext.IsNoOpContext) { additionalFlags |= JoinableTaskFlags.SynchronouslyBlockingMainThread; onMainThread = true; diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 0a0520f89..3417adb3a 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -28,7 +28,7 @@ public partial class JoinableTaskFactory /// private readonly JoinableTaskContext owner; - private readonly SynchronizationContext mainThreadJobSyncContext; + private readonly SynchronizationContext? mainThreadJobSyncContext; /// /// The collection to add all created tasks to. May be . @@ -71,7 +71,7 @@ internal JoinableTaskFactory(JoinableTaskContext owner, JoinableTaskCollection? this.owner = owner; this.jobCollection = collection; - this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this); + this.mainThreadJobSyncContext = owner.IsNoOpContext ? null : new JoinableTaskSynchronizationContext(this); } /// @@ -1017,20 +1017,23 @@ internal RunFramework(JoinableTaskFactory factory, JoinableTask joinable) { JoinableTaskDependencyGraph.AddDependency(this.previousJoinable, joinable); - // By definition we inherit the nesting factories of our immediate nesting task. - ListOfOftenOne nestingFactories = this.previousJoinable.NestingFactories; - - // And we may add our immediate nesting parent's factory to the list of - // ancestors if it isn't already in the list. - if (this.previousJoinable.Factory != this.factory) + if (!factory.Context.IsNoOpContext) { - if (!nestingFactories.Contains(this.previousJoinable.Factory)) + // By definition we inherit the nesting factories of our immediate nesting task. + ListOfOftenOne nestingFactories = this.previousJoinable.NestingFactories; + + // And we may add our immediate nesting parent's factory to the list of + // ancestors if it isn't already in the list. + if (this.previousJoinable.Factory != this.factory) { - nestingFactories.Add(this.previousJoinable.Factory); + if (!nestingFactories.Contains(this.previousJoinable.Factory)) + { + nestingFactories.Add(this.previousJoinable.Factory); + } } - } - this.joinable.NestingFactories = nestingFactories; + this.joinable.NestingFactories = nestingFactories; + } } if (joinable.GetTokenizedParent() is JoinableTask tokenizedParent) From aaccf733763ee03b1b0458fafaaf2d1739537a77 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Nov 2025 15:02:09 -0700 Subject: [PATCH 1484/1753] Build with the .NET 10 SDK --- .devcontainer/Dockerfile | 2 +- Directory.Build.props | 1 + global.json | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index f98875898..de697825e 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:9.0.306-noble@sha256:d88e637d15248531967111fba05c6725ad45ea1dace3d35d8cfe2c4d4094e25d +FROM mcr.microsoft.com/dotnet/sdk:10.0.100 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/Directory.Build.props b/Directory.Build.props index 02d418045..e1e9ee701 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -12,6 +12,7 @@ true true true + true true diff --git a/global.json b/global.json index cfaecd0dd..895d51bad 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "9.0.306", + "version": "10.0.100", "rollForward": "patch", "allowPrerelease": false } From adb7870d664a6215b965398d549c3c9a84df8fd9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Nov 2025 15:23:14 -0700 Subject: [PATCH 1485/1753] Adapt to breaking .NET 10 SDK change Workaround for https://github.com/dotnet/sdk/issues/51666 --- Expand-Template.ps1 | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 04cf503d5..5b08d843f 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -110,6 +110,14 @@ try { git mv test/Library.Tests "test/$LibraryName.Tests" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } + # Update project reference in test project. Add before removal to keep the same ItemGroup in place. + dotnet add "test/$LibraryName.Tests" reference "src/$LibraryName" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } + dotnet remove "test/$LibraryName.Tests" reference src/Library/Library.csproj + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } + git add "test/$LibraryName.Tests/$LibraryName.Tests.csproj" + if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } + # Refresh solution file both to update paths and give the projects unique GUIDs dotnet sln remove src/Library/Library.csproj if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } @@ -122,14 +130,6 @@ try { git add "$LibraryName.slnx" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - # Update project reference in test project. Add before removal to keep the same ItemGroup in place. - dotnet add "test/$LibraryName.Tests" reference "src/$LibraryName" - if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - dotnet remove "test/$LibraryName.Tests" reference src/Library/Library.csproj - if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - git add "test/$LibraryName.Tests/$LibraryName.Tests.csproj" - if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - # Establish a new strong-name key & $sn.Path -k 2048 strongname.snk if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } From 4a6f64196cdffe0b3d5a1dd8da1a836d9e9fd824 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 11 Nov 2025 20:15:45 -0700 Subject: [PATCH 1486/1753] Fix ARM64 detection on macOS --- tools/Install-DotNetSdk.ps1 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 402b4307c..3d13e817d 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -197,7 +197,7 @@ if ($InstallLocality -eq 'machine') { $restartRequired = $false $sdks |% { if ($_.Version) { $version = $_.Version } else { $version = $_.Channel } - if ($PSCmdlet.ShouldProcess(".NET SDK $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET SDK $version ($arch)", "Install")) { Install-DotNet -Version $version -Architecture $arch $restartRequired = $restartRequired -or ($LASTEXITCODE -eq 3010) @@ -281,10 +281,10 @@ if ($IncludeX86) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/0b09de9bc136cacb5f849a6957ebd4062173c148/src/dotnet-install.sh" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/a3fbd0fd625032bac207f1f590e5353fe26faa59/src/dotnet-install.sh" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/0b09de9bc136cacb5f849a6957ebd4062173c148/src/dotnet-install.ps1" + $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/a3fbd0fd625032bac207f1f590e5353fe26faa59/src/dotnet-install.ps1" $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" } @@ -306,7 +306,7 @@ $global:LASTEXITCODE = 0 $sdks |% { if ($_.Version) { $parameters = '-Version', $_.Version } else { $parameters = '-Channel', $_.Channel } - if ($PSCmdlet.ShouldProcess(".NET SDK $_", "Install")) { + if ($PSCmdlet.ShouldProcess(".NET SDK $_ ($arch)", "Install")) { $anythingInstalled = $true Invoke-Expression -Command "$DotNetInstallScriptPathExpression $parameters -Architecture $arch -InstallDir $DotNetInstallDir $switches" From e1aa37c4508bd87df71cf503dedd78fe839a7eb9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 12 Nov 2025 03:58:26 +0000 Subject: [PATCH 1487/1753] Pin mcr.microsoft.com/dotnet/sdk Docker tag to c7445f1 Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index de697825e..6637ad8ac 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.100 +FROM mcr.microsoft.com/dotnet/sdk:10.0.100@sha256:c7445f141c04f1a6b454181bd098dcfa606c61ba0bd213d0a702489e5bd4cd71 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From ed20107e2ccdd1842353ecc0bf108f9ae4fc5824 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 12 Nov 2025 07:04:29 -0700 Subject: [PATCH 1488/1753] Bump C# language version to 14 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index e1e9ee701..a3d5fb8e1 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -44,7 +44,7 @@ - 13 + 14 16.9 From c8fa88850cc7bf314a2f07bdf217cb60dafc3ec1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Nov 2025 11:07:53 -0700 Subject: [PATCH 1489/1753] Drop `auto-insertion` tag handling Now that official and unofficial pipelines are distinct, there's no real reason to avoid triggering an insertion with every official build. --- azure-pipelines/build.yml | 3 --- azure-pipelines/schedule-only-steps.yml | 3 --- azure-pipelines/vs-insertion.yml | 1 - 3 files changed, 7 deletions(-) delete mode 100644 azure-pipelines/schedule-only-steps.yml diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 078cb8396..86d11fe16 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -194,9 +194,6 @@ jobs: - powershell: Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSDROPNAME]$(tools/variables/ProfilingInputsDropName.ps1)" displayName: ⚙ Set ProfilingInputsDropName for optprof - - ${{ if eq(variables['Build.Reason'], 'Schedule') }}: - - template: schedule-only-steps.yml - - template: install-dependencies.yml - script: dotnet nbgv cloud -ca diff --git a/azure-pipelines/schedule-only-steps.yml b/azure-pipelines/schedule-only-steps.yml deleted file mode 100644 index ad07a341b..000000000 --- a/azure-pipelines/schedule-only-steps.yml +++ /dev/null @@ -1,3 +0,0 @@ -steps: -- powershell: echo "##vso[build.addbuildtag]auto-insertion" - displayName: Tag for auto-insertion diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 2899a6a08..bb5332ec9 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -15,7 +15,6 @@ resources: trigger: tags: - Real signed - - auto-insertion variables: - template: GlobalVariables.yml From e95eb88acf602a6c46a2720650f0e2509cf542f3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 12:28:49 -0700 Subject: [PATCH 1490/1753] Update actions/checkout digest to 93cb6ef Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 717342eb6..f290509be 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,7 +29,7 @@ jobs: - windows-2022 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -74,7 +74,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index eb69d92e8..52dfafa0a 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a7155c4cf..d78426362 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index f5cf8666f..1f64e09d2 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 91ee72eba1eed6090d83d93f0dcba4bd53ac655f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 17 Nov 2025 14:40:18 -0700 Subject: [PATCH 1491/1753] Replace hard-coded codecov_token with secrets/variables --- .github/workflows/build.yml | 7 ++++--- Expand-Template.ps1 | 10 ---------- azure-pipelines.yml | 1 - azure-pipelines/dotnet.yml | 7 +++++-- 4 files changed, 9 insertions(+), 16 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f290509be..5c06d5de0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -12,7 +12,6 @@ on: env: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BUILDCONFIGURATION: Release - # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages/ jobs: @@ -64,11 +63,13 @@ jobs: uses: ./.github/actions/publish-artifacts if: cancelled() == false - name: 📢 Publish code coverage results to codecov.io - run: ./tools/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" + run: | + if ('${{ secrets.CODECOV_TOKEN }}') { + ./tools/publish-CodeCov.ps1 -CodeCovToken '${{ secrets.CODECOV_TOKEN }}' -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" + } shell: pwsh timeout-minutes: 3 continue-on-error: true - if: env.codecov_token != '' docs: name: 📃 Docs diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 5b08d843f..39bbd2cf0 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -7,9 +7,6 @@ Expands this template into an actual project, taking values for placeholders The name of the library. Should consist only of alphanumeric characters and periods. .PARAMETER Author The name to use in copyright and owner notices. -.PARAMETER CodeCovToken -A token obtained from codecov.io for your repo. If not specified, code coverage results will not be published to codecov.io, -but can be added later by editing the Azure Pipelines YAML file. .PARAMETER CIFeed The `/{guid}` path to the Azure Pipelines artifact feed to push your nuget package to as part of your CI. .PARAMETER Squash @@ -22,8 +19,6 @@ Param( [Parameter(Mandatory=$true)] [string]$Author, [Parameter()] - [string]$CodeCovToken, - [Parameter()] [string]$CIFeed, [Parameter()] [switch]$Squash @@ -179,11 +174,6 @@ try { } $YmlReplacements = @{} - if ($CodeCovToken) { - $YmlReplacements['(codecov_token: ).*(#.*)'] = "`$1$CodeCovToken" - } else { - $YmlReplacements['(codecov_token: ).*(#.*)'] = "#`$1`$2" - } if ($CIFeed) { $YmlReplacements['(ci_feed: ).*(#.*)'] = "`$1$CIFeed" } else { diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 4d372fe0c..8c2ddec93 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -26,7 +26,6 @@ parameters: variables: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true BuildConfiguration: Release - codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/ ci_feed: https://pkgs.dev.azure.com/andrewarnott/_packaging/CI/nuget/v3/index.json # Azure Artifacts feed URL NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/ diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index 30bb4107d..9a572afe1 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -20,11 +20,14 @@ steps: displayName: 📢 Publish artifacts condition: succeededOrFailed() -- ${{ if and(ne(variables['codecov_token'], ''), parameters.RunTests) }}: +- ${{ if parameters.RunTests }}: - powershell: | $ArtifactStagingFolder = & "tools/Get-ArtifactsStagingDirectory.ps1" $CoverageResultsFolder = Join-Path $ArtifactStagingFolder "coverageResults-$(Agent.JobName)" - tools/publish-CodeCov.ps1 -CodeCovToken "$(codecov_token)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)" + tools/publish-CodeCov.ps1 -CodeCovToken "$(CODECOV_TOKEN)" -PathToCodeCoverage "$CoverageResultsFolder" -Name "$(Agent.JobName) Coverage Results" -Flags "$(Agent.JobName)" displayName: 📢 Publish code coverage results to codecov.io timeoutInMinutes: 3 continueOnError: true + # Set the CODECOV_TOKEN variable in your Azure Pipeline to enable code coverage reporting + # Get a token from https://codecov.io/ + condition: and(succeeded(), ne(variables['CODECOV_TOKEN'], '')) From 32a3cdd0dbc5773b67517f9b97b86c42198f4cbb Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 20 Nov 2025 21:13:36 +0000 Subject: [PATCH 1492/1753] Update actions/checkout action to v6 (443) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5c06d5de0..376a52ff9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,7 +28,7 @@ jobs: - windows-2022 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -75,7 +75,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 52dfafa0a..8bbf7b077 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d78426362..28313d12a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 1f64e09d2..f7d0b54e4 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 585a2dfec55c77a7fa62afe086ac131ad93187fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20K=C3=B6plinger?= Date: Fri, 21 Nov 2025 15:44:28 +0100 Subject: [PATCH 1493/1753] Use official URLs in Install-DotNetSdk.ps1 The blob storage URLs will stop working, see https://github.com/dotnet/announcements/issues/336 --- tools/Install-DotNetSdk.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 3d13e817d..590581e26 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -125,14 +125,14 @@ Function Get-InstallerExe( } if ($TypedVersion.Build -eq -1) { - $versionInfo = -Split (Invoke-WebRequest -Uri "https://dotnetcli.blob.core.windows.net/dotnet/$sku/$Version/latest.version" -UseBasicParsing) + $versionInfo = -Split (Invoke-WebRequest -Uri "https://builds.dotnet.microsoft.com/dotnet/$sku/$Version/latest.version" -UseBasicParsing) $Version = $versionInfo[-1] } $majorMinor = "$($TypedVersion.Major).$($TypedVersion.Minor)" $ReleasesFile = Join-Path $DotNetInstallScriptRoot "$majorMinor\releases.json" if (!(Test-Path $ReleasesFile)) { - Get-FileFromWeb -Uri "https://dotnetcli.blob.core.windows.net/dotnet/release-metadata/$majorMinor/releases.json" -OutDir (Split-Path $ReleasesFile) | Out-Null + Get-FileFromWeb -Uri "https://builds.dotnet.microsoft.com/dotnet/release-metadata/$majorMinor/releases.json" -OutDir (Split-Path $ReleasesFile) | Out-Null } $releases = Get-Content $ReleasesFile | ConvertFrom-Json From 725513886298c9a2b109bc7406d6305ac152fb3f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 24 Nov 2025 01:52:01 +0000 Subject: [PATCH 1494/1753] Merge pull request #1501 from microsoft/renovate/microsoft.windows.cswin32-0.x Update dependency Microsoft.Windows.CsWin32 to 0.3.253 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index e6915d28b..791b8a1e0 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From 1439223d98460542839efa8c8c9c19a011c72e98 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 28 Nov 2025 18:34:34 -0700 Subject: [PATCH 1495/1753] Update dependency xunit.v3 to 3.2.1 (445) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c0924a538..d4cbbbb1c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ - + From 5c7913114d8228342884bb3d0752e2ebebc152b4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 Dec 2025 18:27:46 -0700 Subject: [PATCH 1496/1753] Enable ShouldSkipOptimize parameter for more pipelines --- azure-pipelines/unofficial.yml | 10 +++++----- azure-pipelines/vs-validation.yml | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 35d574ad8..3673a95cc 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -18,10 +18,10 @@ parameters: # As an entrypoint pipeline yml file, all parameters here show up in the Queue Run dialog. # If any paramaters should NOT be queue-time options, they should be removed from here # and references to them in this file replaced with hard-coded values. -# - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. -# displayName: Skip OptProf optimization -# type: boolean -# default: false +- name: ShouldSkipOptimize + displayName: Skip OptProf optimization + type: boolean + default: false - name: EnableMacOSBuild displayName: Build on macOS type: boolean @@ -84,7 +84,7 @@ extends: parameters: Is1ESPT: true RealSign: false - # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableAPIScan: ${{ parameters.EnableAPIScan }} windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index b6c79abaf..ab7fe4809 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -5,11 +5,11 @@ trigger: none # We only want to trigger manually or based on resources pr: none -# parameters: -# - name: ShouldSkipOptimize # Uncomment this and references to it below when setting EnableOptProf to true in build.yml. -# displayName: Skip OptProf optimization -# type: boolean -# default: false +parameters: +- name: ShouldSkipOptimize + displayName: Skip OptProf optimization + type: boolean + default: false resources: repositories: @@ -45,7 +45,7 @@ extends: parameters: Is1ESPT: true RealSign: false - # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} + ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} windowsPool: VSEngSS-MicroBuild2022-1ES linuxPool: name: AzurePipelines-EO From 5a412a0c542cd02716f3c9e1460e6b98c63cdb69 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 1 Dec 2025 18:25:17 -0700 Subject: [PATCH 1497/1753] Switch out our own OptProf profiling pipeline for the VS one --- azure-pipelines/OptProf.yml | 125 -------- azure-pipelines/OptProf_part2.yml | 91 ------ azure-pipelines/build.yml | 269 +++++++++--------- azure-pipelines/dotnet.yml | 14 +- azure-pipelines/microbuild.after.yml | 21 -- azure-pipelines/microbuild.before.yml | 28 +- azure-pipelines/vs-insertion-script.ps1 | 17 ++ azure-pipelines/vs-insertion.yml | 1 + azure-pipelines/vs-validation.yml | 2 +- src/OptProf.targets | 8 +- .../Library.VSInsertionMetadata.proj | 11 - src/VSInsertionMetadata/ProfilingInputs.props | 5 - .../VSInsertionMetadata.targets | 71 ----- tools/artifacts/VSInsertion.ps1 | 12 +- tools/variables/ProfilingInputsPropsName.ps1 | 6 + 15 files changed, 176 insertions(+), 505 deletions(-) delete mode 100644 azure-pipelines/OptProf.yml delete mode 100644 azure-pipelines/OptProf_part2.yml create mode 100644 azure-pipelines/vs-insertion-script.ps1 delete mode 100644 src/VSInsertionMetadata/Library.VSInsertionMetadata.proj delete mode 100644 src/VSInsertionMetadata/ProfilingInputs.props delete mode 100644 src/VSInsertionMetadata/VSInsertionMetadata.targets create mode 100644 tools/variables/ProfilingInputsPropsName.ps1 diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml deleted file mode 100644 index 515e72a3e..000000000 --- a/azure-pipelines/OptProf.yml +++ /dev/null @@ -1,125 +0,0 @@ -trigger: none -pr: none -schedules: -- cron: "0 3 * * Fri" # Thu @ 8 or 9 PM Mountain Time (depending on DST) - displayName: Weekly OptProf run - branches: - include: - - 'v*.*' - - main - always: true # we must keep data fresh since optimizationdata drops are purged after 30 days - -# Avoid errant CI builds: https://developercommunity.visualstudio.com/content/problem/1154409/azure-pipeline-is-triggering-due-to-events-that-ne.html -#resources: -# repositories: -# - repository: scripts -# type: git -# name: DeploymentScripts -# ref: refs/heads/test - -parameters: - - name: ShouldSkipOptimize - displayName: Skip OptProf optimization - type: boolean - default: false # Should usually be false so that optprof LKG can apply when tests fail, but may need to be set to true in a manually queued pipeline run if all drops have expired. - -variables: -- template: GlobalVariables.yml -- name: PublicRelease - value: false # avoid using nice version since we're building a preliminary/unoptimized package -- name: IsOptProf - value: true -- name: MicroBuild_NuPkgSigningEnabled - value: false # test-signed nuget packages fail to restore in the VS insertion PR validations. Just don't sign them *at all*. - -stages: -- stage: Library - variables: - - name: OptProf - value: true - - template: BuildStageVariables.yml - jobs: - - template: build.yml - parameters: - Is1ESPT: false - RealSign: false - windowsPool: VSEngSS-MicroBuild2022-1ES - EnableMacOSBuild: false - ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - IsOptProf: true - RunTests: false - SkipCodesignVerify: true -- stage: QueueVSBuild - jobs: - - job: QueueOptProf - pool: VSEngSS-MicroBuild2022-1ES - variables: - InsertPayloadName: LibraryName - InsertTopicBranch: team/VS-IDE/LibraryName-OptProf-run-$(Build.BuildId) - steps: - - checkout: none # We don't need source from our own repo - clean: true - - # Pipeline YAML does not yet support checking out other repos. So we'll do it by hand. -# - checkout: scripts # We DO need source from the DeploymentScripts repo -# clean: true -# path: $(Agent.TempDirectory)/DeploymentScripts -# fetchDepth: 1 - - script: 'git -c http.extraheader="AUTHORIZATION: bearer $(System.AccessToken)" clone https://devdiv.visualstudio.com/DevDiv/_git/DeploymentScripts --depth 1 --branch test "$(Agent.TempDirectory)/DeploymentScripts"' - displayName: Download DeploymentScripts repo - - - task: DownloadBuildArtifacts@0 - displayName: Download insertion artifacts - inputs: - artifactName: VSInsertion-Windows - downloadPath: $(Agent.TempDirectory) - - task: DownloadBuildArtifacts@0 - displayName: Download variables artifacts - inputs: - artifactName: Variables-Windows - downloadPath: $(Agent.TempDirectory) - - task: PowerShell@2 - displayName: Set pipeline variables based on artifacts - inputs: - targetType: filePath - filePath: $(Agent.TempDirectory)/Variables-Windows/_define.ps1 - - task: NuGetCommand@2 - displayName: Push VS-repo packages to VS feed - inputs: - command: push - packagesToPush: $(Agent.TempDirectory)/VSInsertion-Windows/*.nupkg - publishVstsFeed: 97a41293-2972-4f48-8c0e-05493ae82010 # VS feed - allowPackageConflicts: true - - task: MicroBuildInsertVsPayload@5 - displayName: Insert VS Payload - inputs: - TeamName: $(TeamName) - TeamEmail: $(TeamEmail) - SkipCreatePR: true - CustomScriptExecutionCommand: src\VSSDK\NuGet\AllowUnstablePackages.ps1 - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - ConnectedVSDropServiceName: 'VSEng-VSDrop-MI' - env: - SYSTEM_ACCESSTOKEN: $(System.AccessToken) - - task: benjhuser.tfs-extensions-build-tasks.trigger-build-task.TriggerBuild@3 - displayName: Trigger a new build of DD-CB-TestSignVS-devCI - inputs: - buildDefinition: DD-CB-TestSignVS-devCI - useSameBranch: false - branchToUse: $(InsertTopicBranch) - storeInEnvironmentVariable: true - queueBuildForUserThatTriggeredBuild: false - authenticationMethod: OAuth Token - password: $(System.AccessToken) - - task: PowerShell@2 - displayName: Associate InsertionOutputs artifacts with CloudBuild - inputs: - targetType: filePath - filePath: $(Agent.TempDirectory)/DeploymentScripts/Scripts/Insertion/WriteArtifact.ps1 - arguments: '-oldBuildID $(Build.BuildId) -newBuildID $(TriggeredBuildIds) -artifactName "InsertionOutputs" -accessToken $(System.AccessToken)' - - task: PowerShell@2 - displayName: Tag the build with LibraryName-insertion - inputs: - targetType: filePath - filePath: $(Agent.TempDirectory)/DeploymentScripts/Scripts/Insertion/TagBuild.ps1 - arguments: '-buildID $(TriggeredBuildIds) -tagName "LibraryName-insertion" -accessToken $(System.AccessToken)' diff --git a/azure-pipelines/OptProf_part2.yml b/azure-pipelines/OptProf_part2.yml deleted file mode 100644 index c59d69996..000000000 --- a/azure-pipelines/OptProf_part2.yml +++ /dev/null @@ -1,91 +0,0 @@ -trigger: none -pr: none - -resources: - pipelines: - - pipeline: VisualStudioBuildUnderTest - source: DD-CB-TestSignVS-devCI - trigger: - tags: - - LibraryName-insertion - - pipeline: DartLab - source: DartLab - branch: main - - pipeline: DartLab.OptProf - source: DartLab.OptProf - branch: main - tags: - - production - repositories: - - repository: DartLabTemplates - type: git - name: DartLab.Templates - ref: refs/heads/main - - repository: DartLabOptProfTemplates - type: git - name: DartLab.OptProf - ref: refs/tags/Production - -parameters: - -# The prefix naming of the OptimizationInputs drop -- name: optimizationDropPrefix - type: string - default: OptimizationInputs/$(System.TeamProject)/$(Build.Repository.Name) - -stages: -- template: \templates\stages\visual-studio\single-runsettings.yml@DartLabOptProfTemplates - parameters: - ##### Required ##### - runSettingsURI: $(Pipeline.Workspace)\VisualStudioBuildUnderTest\BuildArtifacts\runsettings\LibraryName.OptProf.runsettings - visualStudioBootstrapperURI: https://vsdrop.corp.microsoft.com/file/v1/$(VisualStudio.BuildUnderTest.ProductsDropName);bootstrappers/Enterprise/vs_enterprise.exe - ##### Optional ##### - name: OptProfProfilingWorkflow - displayName: OptProf Profiling Workflow - optOptimizationInputsDropName: $(OptimizationInputsDropName) - previousOptimizationInputsDropName: $(PreviousOptimizationInputsDropName) - testLabPoolName: VS-Platform - ##### Step Hooks ##### - preTestMachineConfigurationStepList: - - download: VisualStudioBuildUnderTest - - task: PowerShell@2 - name: SetProductsDropName - displayName: Set 'VisualStudio.BuildUnderTest.ProductsDropName' - inputs: - filePath: $(DartLab.Path)\Scripts\VisualStudio\Build\Get-VisualStudioDropName.ps1 - arguments: -DropNamePrefix 'Products' -VstsDropUrlsJson '$(Pipeline.Workspace)\VisualStudioBuildUnderTest\BuildArtifacts\VstsDropUrls.json' -OutVariableName 'VisualStudio.BuildUnderTest.ProductsDropName' - preDeployAndRunTestsStepList: - - download: VisualStudioBuildUnderTest - prePublishOptimizationInputsDropStepList: - # Set parameter for PreviousOptimizationInputsDropName, MicroBuildCommitID, and OptimizationInputsDropName - - powershell: | - try { - $artifactName = 'InsertionOutputs' - $BuildID = $(resources.pipeline.VisualStudioBuildUnderTest.runID) - $artifact = Get-BuildArtifact -InstanceURL 'https://dev.azure.com/devdiv' -ProjectName 'DevDiv' -BuildID $BuildID -ArtifactName $artifactName -OAuthAccessToken (ConvertTo-SecureString '$(System.AccessToken)' -AsPlainText -Force) - $containerName = $artifact.Resource.Data -Split '/' | Select-Object -Last 1 - $fileName = Join-Path $containerName 'Metadata.json' - $jsonString = Read-BuildArtifactFile -InstanceURL 'https://dev.azure.com/devdiv' -ProjectName 'DevDiv' -BuildID $BuildID -ArtifactName $artifactName -FileName $fileName -OAuthAccessToken (ConvertTo-SecureString '$(System.AccessToken)' -AsPlainText -Force) - $json = $jsonString | ConvertFrom-Json - - Write-Host "The content of the metadata.json file was $json" - - $dropname = $json.OptimizationData - $commitID = $json.CommitID - $OptimizationInputsDropName = "${{parameters.optimizationDropPrefix}}/$($commitID)/$(Build.BuildId)/$(System.StageId)/$(System.StageAttempt)" - - Write-Host "PreviousOptimizationInputsDropName: $dropname" - Set-AzurePipelinesVariable 'PreviousOptimizationInputsDropName' $dropname - - Write-Host "MicroBuildCommitID: $commitID" - Set-AzurePipelinesVariable 'MicroBuildCommitID' $commitID - - Write-Host "OptimizationInputsDropName: $OptimizationInputsDropName" - Set-AzurePipelinesVariable 'OptimizationInputsDropName' $OptimizationInputsDropName - } - catch { - Write-Host $_ - Write-Error "Failed to set OptimizationInputsDropName pipeline variable" - throw - } - displayName: Set MicroBuildCommitID, PreviousOptimizationInputsDropName, and OptimizationInputsDropName diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 86d11fe16..a1f64b869 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -69,12 +69,6 @@ parameters: type: boolean default: false -# Whether this particular run is an OptProf profiling run. -# This is used to skip unit tests and other non-essential work to improve reliability of the OptProf pipeline. -- name: IsOptProf - type: boolean - default: false - - name: RunTests type: boolean default: true @@ -139,8 +133,11 @@ jobs: optprof: enabled: ${{ parameters.EnableOptProf }} ProfilingInputsDropName: $(ProfilingInputsDropName) - OptimizationInputsLookupMethod: DropPrefix - DropNamePrefix: OptimizationInputs/$(System.TeamProject)/$(Build.Repository.Name) + GeneratePropsFile: true + PropsPath: $(Build.ArtifactStagingDirectory)/InsertionOutputs/$(ProfilingInputsPropsName) + OptimizationInputsLookupMethod: GitTagRepo + GitTagProject: DevDiv + GitTagRepo: VS ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} AccessToken: $(System.AccessToken) mbpresteps: @@ -148,8 +145,10 @@ jobs: fetchDepth: 0 # avoid shallow clone so nbgv can do its work. clean: true - ${{ if parameters.EnableOptProf }}: - - powershell: Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSDROPNAME]$(tools/variables/ProfilingInputsDropName.ps1)" - displayName: ⚙ Set ProfilingInputsDropName for optprof + - powershell: | + Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSDROPNAME]$(tools/variables/ProfilingInputsDropName.ps1)" + Write-Host "##vso[task.setvariable variable=PROFILINGINPUTSPROPSNAME]$(tools/variables/ProfilingInputsPropsName.ps1)" + displayName: ⚙ Setting variables for optprof sdl: binskim: analyzeTargetGlob: $(Build.ArtifactStagingDirectory)\symbols-Windows\** @@ -185,6 +184,15 @@ jobs: displayName: 📢 Publish APIScanInputs targetPath: $(Build.ArtifactStagingDirectory)/APIScanInputs-Windows artifactName: APIScanInputs + - ${{ if parameters.EnableOptProf }}: + - output: artifactsDrop + displayName: 📢 Publish to Artifact Services - ProfilingInputs + dropServiceURI: https://devdiv.artifacts.visualstudio.com + buildNumber: $(ProfilingInputsDropName) + sourcePath: $(Build.ArtifactStagingDirectory)\OptProf\ProfilingInputs + toLowerCase: false + retentionDays: 500 + condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) steps: - ${{ if not(parameters.Is1ESPT) }}: - checkout: self @@ -204,7 +212,6 @@ jobs: - template: microbuild.before.yml parameters: EnableLocalization: ${{ parameters.EnableLocalization }} - IsOptProf: ${{ parameters.IsOptProf }} ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} RealSign: ${{ parameters.RealSign }} @@ -212,7 +219,6 @@ jobs: parameters: Is1ESPT: ${{ parameters.Is1ESPT }} RunTests: ${{ parameters.RunTests }} - IsOptProf: ${{ parameters.IsOptProf }} - ${{ if and(parameters.EnableDotNetFormatCheck, not(parameters.EnableLinuxBuild)) }}: - script: dotnet format --verify-no-changes @@ -223,142 +229,139 @@ jobs: - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - template: microbuild.after.yml parameters: - IsOptProf: ${{ parameters.IsOptProf }} SkipCodesignVerify: ${{ parameters.SkipCodesignVerify }} - template: expand-template.yml +- ${{ if parameters.EnableLinuxBuild }}: + - job: Linux + pool: ${{ parameters.linuxPool }} + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + mb: + ${{ if parameters.RealSign }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real + signWithProd: true + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - ${{ each artifact in parameters.artifact_names }}: + - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-Linux + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Linux + artifactName: ${{ artifact.name }}-Linux + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-Linux (for failed attempts) + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Linux + artifactName: ${{ artifact.name }}-Linux-$(System.PhaseAttempt) + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + condition: failed() + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + - template: dotnet.yml + parameters: + Is1ESPT: ${{ parameters.Is1ESPT }} + RunTests: ${{ parameters.RunTests }} + BuildRequiresAccessToken: ${{ parameters.RealSign }} # Real signing on non-Windows machines requires passing through access token to build steps that sign + - ${{ if parameters.EnableDotNetFormatCheck }}: + - script: dotnet format --verify-no-changes + displayName: 💅 Verify formatted code + env: + dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 + - template: expand-template.yml -- ${{ if not(parameters.IsOptProf) }}: - - ${{ if parameters.EnableLinuxBuild }}: - - job: Linux - pool: ${{ parameters.linuxPool }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - templateContext: - mb: - ${{ if parameters.RealSign }}: - signing: - enabled: false # enable when building unique artifacts on this agent that must be signed - signType: real - signWithProd: true - outputParentDirectory: $(Build.ArtifactStagingDirectory) - outputs: - - ${{ each artifact in parameters.artifact_names }}: - - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact.name }}-Linux - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Linux - artifactName: ${{ artifact.name }}-Linux - ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: - sbomEnabled: true - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact.name }}-Linux (for failed attempts) - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-Linux - artifactName: ${{ artifact.name }}-Linux-$(System.PhaseAttempt) - ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: - sbomEnabled: true - condition: failed() - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - - template: dotnet.yml - parameters: - Is1ESPT: ${{ parameters.Is1ESPT }} - RunTests: ${{ parameters.RunTests }} - BuildRequiresAccessToken: ${{ parameters.RealSign }} # Real signing on non-Windows machines requires passing through access token to build steps that sign - - ${{ if parameters.EnableDotNetFormatCheck }}: - - script: dotnet format --verify-no-changes - displayName: 💅 Verify formatted code - env: - dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951 - - template: expand-template.yml - - - ${{ if parameters.EnableMacOSBuild }}: - - job: macOS - pool: ${{ parameters.macOSPool }} - ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: - templateContext: - mb: - ${{ if parameters.RealSign }}: - signing: - enabled: false # enable when building unique artifacts on this agent that must be signed - signType: real - signWithProd: true - outputParentDirectory: $(Build.ArtifactStagingDirectory) - outputs: - - ${{ each artifact in parameters.artifact_names }}: - - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact.name }}-macOS - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-macOS - artifactName: ${{ artifact.name }}-macOS - ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: - sbomEnabled: true - - output: pipelineArtifact - displayName: 📢 Publish ${{ artifact.name }}-macOS (for failed attempts) - targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-macOS - artifactName: ${{ artifact.name }}-macOS-$(System.PhaseAttempt) - ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: - sbomEnabled: true - condition: failed() - steps: - - checkout: self - fetchDepth: 0 # avoid shallow clone so nbgv can do its work. - clean: true - - template: install-dependencies.yml - - template: dotnet.yml - parameters: - Is1ESPT: ${{ parameters.Is1ESPT }} - RunTests: ${{ parameters.RunTests }} - BuildRequiresAccessToken: ${{ parameters.RealSign }} # Real signing on non-Windows machines requires passing through access token to build steps that sign - - template: expand-template.yml - - - job: WrapUp - dependsOn: - - Windows - - ${{ if parameters.EnableLinuxBuild }}: - - Linux - - ${{ if parameters.EnableMacOSBuild }}: - - macOS - pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). - condition: succeededOrFailed() - variables: - ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build jobs, we don't need it here +- ${{ if parameters.EnableMacOSBuild }}: + - job: macOS + pool: ${{ parameters.macOSPool }} ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: templateContext: - ${{ if not(parameters.RealSign) }}: - mb: - signing: # if the build is test-signed, install the signing plugin so that CSVTestSignPolicy.xml is available - enabled: true - zipSources: false - signType: test + mb: + ${{ if parameters.RealSign }}: + signing: + enabled: false # enable when building unique artifacts on this agent that must be signed + signType: real + signWithProd: true outputParentDirectory: $(Build.ArtifactStagingDirectory) outputs: - - output: pipelineArtifact - displayName: 📢 Publish symbols-legacy - targetPath: $(Build.ArtifactStagingDirectory)/symbols-legacy - artifactName: symbols-legacy - condition: succeededOrFailed() + - ${{ each artifact in parameters.artifact_names }}: + - ${{ if or(ne(artifact.testOnly, 'true'), parameters.RunTests) }}: + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-macOS + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-macOS + artifactName: ${{ artifact.name }}-macOS + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + - output: pipelineArtifact + displayName: 📢 Publish ${{ artifact.name }}-macOS (for failed attempts) + targetPath: $(Build.ArtifactStagingDirectory)/${{ artifact.name }}-macOS + artifactName: ${{ artifact.name }}-macOS-$(System.PhaseAttempt) + ${{ if and(parameters.Is1ESPTOfficial, eq(artifact.sbomEnabled, 'true')) }}: + sbomEnabled: true + condition: failed() steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. clean: true - template: install-dependencies.yml + - template: dotnet.yml parameters: - initArgs: -NoRestore - - template: publish-symbols.yml + Is1ESPT: ${{ parameters.Is1ESPT }} + RunTests: ${{ parameters.RunTests }} + BuildRequiresAccessToken: ${{ parameters.RealSign }} # Real signing on non-Windows machines requires passing through access token to build steps that sign + - template: expand-template.yml + +- job: WrapUp + dependsOn: + - Windows + - ${{ if parameters.EnableLinuxBuild }}: + - Linux + - ${{ if parameters.EnableMacOSBuild }}: + - macOS + pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821). + condition: succeededOrFailed() + variables: + ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build jobs, we don't need it here + ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}: + templateContext: + ${{ if not(parameters.RealSign) }}: + mb: + signing: # if the build is test-signed, install the signing plugin so that CSVTestSignPolicy.xml is available + enabled: true + zipSources: false + signType: test + outputParentDirectory: $(Build.ArtifactStagingDirectory) + outputs: + - output: pipelineArtifact + displayName: 📢 Publish symbols-legacy + targetPath: $(Build.ArtifactStagingDirectory)/symbols-legacy + artifactName: symbols-legacy + condition: succeededOrFailed() + steps: + - checkout: self + fetchDepth: 0 # avoid shallow clone so nbgv can do its work. + clean: true + - template: install-dependencies.yml + parameters: + initArgs: -NoRestore + - template: publish-symbols.yml + parameters: + EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} + EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} + - ${{ if and(parameters.RunTests, parameters.PublishCodeCoverage) }}: + - template: publish-codecoverage.yml parameters: EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - - ${{ if and(parameters.RunTests, parameters.PublishCodeCoverage) }}: - - template: publish-codecoverage.yml - parameters: - EnableLinuxBuild: ${{ parameters.EnableLinuxBuild }} - EnableMacOSBuild: ${{ parameters.EnableMacOSBuild }} - - ${{ if parameters.EnableAPIScan }}: - - template: apiscan.yml - parameters: - windowsPool: ${{ parameters.windowsPool }} - RealSign: ${{ parameters.RealSign }} +- ${{ if parameters.EnableAPIScan }}: + - template: apiscan.yml + parameters: + windowsPool: ${{ parameters.windowsPool }} + RealSign: ${{ parameters.RealSign }} diff --git a/azure-pipelines/dotnet.yml b/azure-pipelines/dotnet.yml index b1f7625d6..b67b4a62a 100644 --- a/azure-pipelines/dotnet.yml +++ b/azure-pipelines/dotnet.yml @@ -1,8 +1,5 @@ parameters: - name: RunTests -- name: IsOptProf - type: boolean - default: false - name: Is1ESPT type: boolean - name: BuildRequiresAccessToken @@ -17,14 +14,9 @@ steps: env: SYSTEM_ACCESSTOKEN: $(System.AccessToken) -- ${{ if not(parameters.IsOptProf) }}: - - powershell: tools/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults - displayName: 🧪 dotnet test - condition: and(succeeded(), ${{ parameters.RunTests }}) - -- ${{ if parameters.IsOptProf }}: - - script: dotnet pack src\VSInsertionMetadata -c $(BuildConfiguration) -warnaserror /bl:"$(Build.ArtifactStagingDirectory)/build_logs/VSInsertion-Pack.binlog" - displayName: 🔧 dotnet pack VSInsertionMetadata +- powershell: tools/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults + displayName: 🧪 dotnet test + condition: and(succeeded(), ${{ parameters.RunTests }}) - powershell: tools/variables/_define.ps1 failOnStderr: true diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml index 67ba90080..c0e1e7bd0 100644 --- a/azure-pipelines/microbuild.after.yml +++ b/azure-pipelines/microbuild.after.yml @@ -1,7 +1,4 @@ parameters: -- name: IsOptProf - type: boolean - default: false - name: SkipCodesignVerify type: boolean @@ -15,21 +12,3 @@ steps: TargetFolders: | $(Build.SourcesDirectory)/bin/Packages/$(BuildConfiguration) condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT')) - -- ${{ if parameters.IsOptProf }}: - - task: ms-vscs-artifact.build-tasks.artifactDropTask-1.artifactDropTask@0 - inputs: - dropServiceURI: https://devdiv.artifacts.visualstudio.com - buildNumber: $(ProfilingInputsDropName) - sourcePath: $(Build.ArtifactStagingDirectory)\OptProf\ProfilingInputs - toLowerCase: false - usePat: true - displayName: 📢 Publish to Artifact Services - ProfilingInputs - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - - - task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: $(Build.ArtifactStagingDirectory)/InsertionOutputs - ArtifactName: InsertionOutputs - ArtifactType: Container - displayName: 📢 Publish InsertionOutputs as Azure DevOps artifacts diff --git a/azure-pipelines/microbuild.before.yml b/azure-pipelines/microbuild.before.yml index fd47d1bb9..298235321 100644 --- a/azure-pipelines/microbuild.before.yml +++ b/azure-pipelines/microbuild.before.yml @@ -2,9 +2,6 @@ parameters: - name: EnableLocalization type: boolean default: false -- name: IsOptProf - type: boolean - default: false - name: ShouldSkipOptimize type: boolean default: false @@ -12,7 +9,7 @@ parameters: type: boolean steps: -- ${{ if and(not(parameters.IsOptProf), ne(variables['Build.Reason'], 'PullRequest')) }}: +- ${{ if ne(variables['Build.Reason'], 'PullRequest') }}: # notice@0 requires CG detection to run first, and non-default branches don't inject it automatically. # default branch injection (main) is happening too late for notice@0 to run successfully. Adding this as a workaround. - task: ComponentGovernanceComponentDetection@0 @@ -25,26 +22,3 @@ steps: outputformat: text retryCountOnTaskFailure: 10 # fails when the cloud service is overloaded continueOnError: ${{ not(parameters.RealSign) }} # Tolerate failures when we're not building something that may ship. - -- ${{ if parameters.IsOptProf }}: - # We have to install these plugins ourselves for Optprof runs because those pipelines haven't migrated to 1ES PT yet. - - task: MicroBuildOptProfPlugin@6 - inputs: - ProfilingInputsDropName: $(ProfilingInputsDropName) - OptimizationInputsLookupMethod: DropPrefix - DropNamePrefix: OptimizationInputs/$(System.TeamProject)/$(Build.Repository.Name) - ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - AccessToken: $(System.AccessToken) - displayName: 🔧 Install OptProf Plugin - - - task: MicroBuildSigningPlugin@4 - inputs: - signType: Test - zipSources: false - displayName: 🔧 Install MicroBuild Signing Plugin - - - ${{ if parameters.EnableLocalization }}: - - task: MicroBuildLocalizationPlugin@4 - inputs: - languages: $(LocLanguages) - displayName: 🔧 Install MicroBuild Localization Plugin diff --git a/azure-pipelines/vs-insertion-script.ps1 b/azure-pipelines/vs-insertion-script.ps1 new file mode 100644 index 000000000..53076254f --- /dev/null +++ b/azure-pipelines/vs-insertion-script.ps1 @@ -0,0 +1,17 @@ +# List of build artifact files [Source => Destination] to be committed into the VS repo. +$FilesToCommit = @{ + "$env:PROFILINGINPUTSPROPSNAME" = "src/Tests/config/runsettings/Official/OptProf/External/$env:PROFILINGINPUTSPROPSNAME"; +} + +foreach ($File in $FilesToCommit.GetEnumerator()) { + $SourcePath = Join-Path $PSScriptRoot $File.Key + if (Test-Path $SourcePath) { + $DestinationPath = Join-Path (Get-Location) $File.Value + Write-Host "Copying $SourcePath to $DestinationPath" + Copy-Item -Path $SourcePath -Destination $DestinationPath + git add $DestinationPath + } + else { + Write-Host "$SourcePath is not present, skipping" + } +} diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index bb5332ec9..e9cb17814 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -65,6 +65,7 @@ extends: InsertionPayloadName: $(Build.Repository.Name) $(Build.BuildNumber) InsertionBuildPolicies: Request Perf DDRITs InsertionReviewers: $(Build.RequestedFor) # Append `,Your team name` (without quotes) + CustomScriptExecutionCommand: $(Pipeline.Workspace)\CI\VSInsertion-Windows\vs-insertion-script.ps1 AutoCompletePR: true AutoCompleteMergeStrategy: Squash ShallowClone: true diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index bd6a0aaf5..c03fdaa00 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -105,7 +105,7 @@ extends: InsertionPayloadName: $(Build.Repository.Name) VALIDATION BUILD $(Build.BuildNumber) ($(Build.SourceBranch)) [Skip-SymbolCheck] [Skip-HashCheck] [Skip-SignCheck] InsertionDescription: | This PR is for **validation purposes only** for !$(System.PullRequest.PullRequestId). **Do not complete**. - CustomScriptExecutionCommand: src/VSSDK/NuGet/AllowUnstablePackages.ps1 + CustomScriptExecutionCommand: $(Pipeline.Workspace)\VSInsertion-Windows\vs-insertion-script.ps1; src\VSSDK\NuGet\AllowUnstablePackages.ps1 InsertionBuildPolicies: Request Perf DDRITs InsertionReviewers: $(Build.RequestedFor) DraftPR: false # set to true and update InsertionBuildPolicy when we can specify all the validations we want to run (https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2224288) diff --git a/src/OptProf.targets b/src/OptProf.targets index d0167d7c1..0757df215 100644 --- a/src/OptProf.targets +++ b/src/OptProf.targets @@ -2,14 +2,12 @@ IBC - Common7\IDE\PrivateAssemblies\$(TargetFileName) + Common7\IDE\PublicAssemblies\Microsoft.VisualStudio.Threading.17.x\$(TargetFileName) /ExeConfig:"%VisualStudio.InstallationUnderTest.Path%\Common7\IDE\vsn.exe" - - - + + - diff --git a/src/VSInsertionMetadata/Library.VSInsertionMetadata.proj b/src/VSInsertionMetadata/Library.VSInsertionMetadata.proj deleted file mode 100644 index 0caaedb94..000000000 --- a/src/VSInsertionMetadata/Library.VSInsertionMetadata.proj +++ /dev/null @@ -1,11 +0,0 @@ - - - netstandard2.0 - true - $(RepoRootPath)bin\Packages\$(Configuration)\VSRepo\ - false - false - Contains metadata for insertion into VS. - - - diff --git a/src/VSInsertionMetadata/ProfilingInputs.props b/src/VSInsertionMetadata/ProfilingInputs.props deleted file mode 100644 index fb19d6048..000000000 --- a/src/VSInsertionMetadata/ProfilingInputs.props +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/src/VSInsertionMetadata/VSInsertionMetadata.targets b/src/VSInsertionMetadata/VSInsertionMetadata.targets deleted file mode 100644 index 84ebb5a88..000000000 --- a/src/VSInsertionMetadata/VSInsertionMetadata.targets +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - $(TargetsForTfmSpecificContentInPackage); - SubstituteProfilingInputsMacro; - - - - - - - - - - - - - - - - - - - - - - $(PackageVersion).$(Build_BuildId) - - - - - - diff --git a/tools/artifacts/VSInsertion.ps1 b/tools/artifacts/VSInsertion.ps1 index a5b940b5d..700b24f69 100644 --- a/tools/artifacts/VSInsertion.ps1 +++ b/tools/artifacts/VSInsertion.ps1 @@ -19,6 +19,10 @@ if (!$BuildConfiguration) { $PackagesRoot = "$RepoRoot/bin/Packages/$BuildConfiguration" $NuGetPackages = "$PackagesRoot/NuGet" $VsixPackages = "$PackagesRoot/Vsix" +$AzurePipelinesPath = "$RepoRoot/azure-pipelines" +if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { + $InsertionOutputs = "$env:BUILD_ARTIFACTSTAGINGDIRECTORY/InsertionOutputs" +} if (!(Test-Path $NuGetPackages) -and !(Test-Path $VsixPackages)) { Write-Warning "Skipping because NuGet and VSIX packages haven't been built yet." @@ -26,16 +30,16 @@ if (!(Test-Path $NuGetPackages) -and !(Test-Path $VsixPackages)) { } $result = @{ - "$NuGetPackages" = (Get-ChildItem $NuGetPackages -Recurse) + "$AzurePipelinesPath" = (Get-ChildItem "$AzurePipelinesPath/vs-insertion-script.ps1"); + "$NuGetPackages" = (Get-ChildItem $NuGetPackages -Recurse); } if (Test-Path $VsixPackages) { $result["$PackagesRoot"] += Get-ChildItem $VsixPackages -Recurse } -if ($env:IsOptProf) { - $VSRepoPackages = "$PackagesRoot/VSRepo" - $result["$VSRepoPackages"] = (Get-ChildItem "$VSRepoPackages\*.VSInsertionMetadata.*.nupkg"); +if ($InsertionOutputs -and $env:PROFILINGINPUTSPROPSNAME -and (Test-Path "$InsertionOutputs/$env:PROFILINGINPUTSPROPSNAME")) { + $result[$InsertionOutputs] = (Get-ChildItem "$InsertionOutputs/$env:PROFILINGINPUTSPROPSNAME"); # OptProf ProfilingInputs } $result diff --git a/tools/variables/ProfilingInputsPropsName.ps1 b/tools/variables/ProfilingInputsPropsName.ps1 new file mode 100644 index 000000000..e66cce0ca --- /dev/null +++ b/tools/variables/ProfilingInputsPropsName.ps1 @@ -0,0 +1,6 @@ +if ($env:SYSTEM_TEAMPROJECT) { + $repoName = $env:BUILD_REPOSITORY_NAME.Replace('/', '.') + "$env:SYSTEM_TEAMPROJECT.$repoName.props" +} else { + Write-Warning "No Azure Pipelines build detected. No Azure Pipelines drop name will be computed." +} From 61009c88d8fc77ca39c5047344bac8959d878907 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 09:56:31 -0700 Subject: [PATCH 1498/1753] Bump DNNE to 2.0.8 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d100accc5..19a667b76 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ 3.11.0-beta1.25076.3 - + From a23eb8db15455b3dd935f85bca1eb71a86aef416 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 10:38:04 -0700 Subject: [PATCH 1499/1753] Merge pull request 447 to Build on newer agents --- .github/workflows/build.yml | 6 +++--- Expand-Template.ps1 | 2 +- azure-pipelines/build.yml | 6 +++--- azure-pipelines/expand-template.yml | 12 ++++++++++++ 4 files changed, 19 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 376a52ff9..b37961005 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -23,9 +23,9 @@ jobs: fail-fast: false matrix: os: - - ubuntu-22.04 - - macos-14 - - windows-2022 + - ubuntu-24.04 + - macOS-15 + - windows-2025 steps: - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 39bbd2cf0..568ee7999 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -52,7 +52,7 @@ function Replace-Placeholders { $sn = Get-Command sn -ErrorAction SilentlyContinue if (-not $sn) { if ($IsMacOS -or $IsLinux) { - Write-Error "sn command not found on PATH. Install mono and/or vote up this issue: https://github.com/dotnet/sdk/issues/13560" + Write-Error 'sn command not found on PATH. Install mono, use "sudo apt-get install strong-name-tool" and/or vote up this issue: https://github.com/dotnet/sdk/issues/13560' exit(1) } $snExes = Get-ChildItem -Recurse "${env:ProgramFiles(x86)}\Microsoft SDKs\Windows\sn.exe" diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml index 5c106ade4..7d808edeb 100644 --- a/azure-pipelines/build.yml +++ b/azure-pipelines/build.yml @@ -2,7 +2,7 @@ parameters: - name: windowsPool type: object default: - vmImage: windows-2022 + vmImage: windows-2025 - name: includeMacOS type: boolean - name: RunTests @@ -28,7 +28,7 @@ jobs: - job: Linux pool: - vmImage: Ubuntu-22.04 + vmImage: ubuntu-24.04 steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. @@ -46,7 +46,7 @@ jobs: - job: macOS condition: ${{ parameters.includeMacOS }} pool: - vmImage: macOS-14 + vmImage: macOS-15 steps: - checkout: self fetchDepth: 0 # avoid shallow clone so nbgv can do its work. diff --git a/azure-pipelines/expand-template.yml b/azure-pipelines/expand-template.yml index d843f1eac..3f4897b8d 100644 --- a/azure-pipelines/expand-template.yml +++ b/azure-pipelines/expand-template.yml @@ -6,6 +6,18 @@ steps: - powershell: | git config user.name "test user" git config user.email "andrewarnott@gmail.com" + if ($IsLinux) { + Write-Host "##[group]strong-name-tool installation" + Write-Host "##[command]sudo apt-get install strong-name-tool" + sudo apt-get install strong-name-tool 2>&1 + Write-Host "##[endgroup]" + } + if ($IsMacOS) { + Write-Host "##[group]mono installation" + Write-Host "##[command]brew install mono" + brew install mono 2>&1 + Write-Host "##[endgroup]" + } ./Expand-Template.ps1 -LibraryName Calc -Author "Andrew Arnott" displayName: 🧪 Expanding template failOnStderr: true From 064bff7e1380cbfab683d3d424b3360b4d6c2395 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 17:45:23 +0000 Subject: [PATCH 1500/1753] Update actions/checkout digest to 8e8c483 (448) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b37961005..11a8eb3b5 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,7 +28,7 @@ jobs: - windows-2025 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -75,7 +75,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 8bbf7b077..6a88e0c5d 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 28313d12a..adeffee4a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index f7d0b54e4..800279bb5 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 35aa4d135f4050acec3a35cab0cf57a1512faad5 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 17:50:00 +0000 Subject: [PATCH 1501/1753] Update actions/checkout digest --- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/docs_validate.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 8bbf7b077..6a88e0c5d 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 28313d12a..adeffee4a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index c3e76e550..ad00d50a3 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index f7d0b54e4..800279bb5 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 498462f89919dfd07cfad1ab6f1edbdc39d2ccc2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 12:48:51 -0700 Subject: [PATCH 1502/1753] Build on VS2026 agents --- azure-pipelines/OptProf.yml | 4 ++-- azure-pipelines/archive-sourcecode.yml | 2 +- azure-pipelines/official.yml | 4 ++-- azure-pipelines/prepare-insertion-stages.yml | 2 +- azure-pipelines/release.yml | 2 +- azure-pipelines/unofficial.yml | 4 ++-- azure-pipelines/vs-insertion.yml | 4 ++-- azure-pipelines/vs-validation.yml | 6 +++--- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/azure-pipelines/OptProf.yml b/azure-pipelines/OptProf.yml index 515e72a3e..cc3df69e9 100644 --- a/azure-pipelines/OptProf.yml +++ b/azure-pipelines/OptProf.yml @@ -43,7 +43,7 @@ stages: parameters: Is1ESPT: false RealSign: false - windowsPool: VSEngSS-MicroBuild2022-1ES + windowsPool: VSEng-MicroBuildVSStable EnableMacOSBuild: false ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} IsOptProf: true @@ -52,7 +52,7 @@ stages: - stage: QueueVSBuild jobs: - job: QueueOptProf - pool: VSEngSS-MicroBuild2022-1ES + pool: VSEng-MicroBuildVSStable variables: InsertPayloadName: LibraryName InsertTopicBranch: team/VS-IDE/LibraryName-OptProf-run-$(Build.BuildId) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 7f35de40c..ee349e5b0 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -38,7 +38,7 @@ extends: settings: networkIsolationPolicy: Permissive,CFSClean sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sourceAnalysisPool: VSEng-MicroBuildVSStable stages: - stage: archive diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index d5571b0df..11718380f 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -48,7 +48,7 @@ extends: settings: networkIsolationPolicy: Permissive,CFSClean sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sourceAnalysisPool: VSEng-MicroBuildVSStable codeSignValidation: enabled: true break: true @@ -72,7 +72,7 @@ extends: RealSign: true # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableAPIScan: ${{ parameters.EnableAPIScan }} - windowsPool: VSEngSS-MicroBuild2022-1ES + windowsPool: VSEng-MicroBuildVSStable linuxPool: name: AzurePipelines-EO demands: diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index fdce906aa..9f934f92c 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -17,7 +17,7 @@ stages: - ${{ if parameters.ArchiveSymbols }}: - job: symbol_archive displayName: Archive symbols - pool: VSEngSS-MicroBuild2022-1ES + pool: VSEng-MicroBuildVSStable variables: ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build stages, we don't need it here steps: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index aea1a2d9b..38e9a3bad 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -23,7 +23,7 @@ extends: settings: networkIsolationPolicy: Permissive,CFSClean sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sourceAnalysisPool: VSEng-MicroBuildVSStable stages: - stage: release diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 5796f7821..64905a855 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -58,7 +58,7 @@ extends: settings: networkIsolationPolicy: Permissive,CFSClean sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: enabled: false suppression: @@ -85,7 +85,7 @@ extends: RealSign: false # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} EnableAPIScan: ${{ parameters.EnableAPIScan }} - windowsPool: VSEngSS-MicroBuild2022-1ES + windowsPool: VSEng-MicroBuildVSStable linuxPool: name: AzurePipelines-EO demands: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index bb5332ec9..e4a4424b8 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -25,14 +25,14 @@ extends: settings: networkIsolationPolicy: Permissive,CFSClean sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sourceAnalysisPool: VSEng-MicroBuildVSStable stages: - stage: insertion jobs: - job: insertion displayName: VS insertion - pool: VSEngSS-MicroBuild2022-1ES + pool: VSEng-MicroBuildVSStable templateContext: outputParentDirectory: $(Pipeline.Workspace)/CI steps: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 92f84cc08..a553455c0 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -29,7 +29,7 @@ extends: settings: networkIsolationPolicy: Permissive,CFSClean sdl: - sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: enabled: false @@ -46,7 +46,7 @@ extends: Is1ESPT: true RealSign: false # ShouldSkipOptimize: ${{ parameters.ShouldSkipOptimize }} - windowsPool: VSEngSS-MicroBuild2022-1ES + windowsPool: VSEng-MicroBuildVSStable linuxPool: name: AzurePipelines-EO demands: @@ -70,7 +70,7 @@ extends: jobs: - job: insertion displayName: VS insertion - pool: VSEngSS-MicroBuild2022-1ES + pool: VSEng-MicroBuildVSStable steps: - checkout: self clean: true From 26355f20e7a52cbe38e81f7d98e3cf040df04275 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 15:21:37 -0700 Subject: [PATCH 1503/1753] Better pinning of GitHub Actions --- .github/renovate.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/renovate.json b/.github/renovate.json index c8b723c8c..c97d97791 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1,6 +1,6 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": ["config:best-practices"], + "extends": ["config:best-practices","helpers:pinGitHubActionDigestsToSemver"], "labels": ["dependencies"], "packageRules": [ { From 5ded58b1970014c5e40a1495936d9f0f4c69f24c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 22:28:28 +0000 Subject: [PATCH 1504/1753] Update actions/checkout action to v6.0.1 (449) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 11a8eb3b5..b3aa05bc4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,7 +28,7 @@ jobs: - windows-2025 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -75,7 +75,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 6a88e0c5d..ebd538812 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index adeffee4a..f7ed808de 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 800279bb5..0b111a609 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 4548135503611f9115cc961e4ec643cfafc8ba0c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 13:28:02 -0700 Subject: [PATCH 1505/1753] Exclude `vs-insertion-script.ps1` from signing requirement --- azure-pipelines/official.yml | 2 +- azure-pipelines/unofficial.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 54049629a..5c14d1423 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -52,7 +52,7 @@ extends: codeSignValidation: enabled: true break: true - additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|LocBin-*\**;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** + additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|LocBin-*\**;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\**;-|$(Build.ArtifactStagingDirectory)\VSInsertion-Windows\vs-insertion-script.ps1 policheck: enabled: true exclusionsFile: $(System.DefaultWorkingDirectory)\azure-pipelines\PoliCheckExclusions.xml diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index bc2e88e0f..6097512c7 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -67,7 +67,7 @@ extends: codeSignValidation: enabled: ${{ parameters.EnableProductionSDL }} break: true - additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\** + additionalTargetsGlobPattern: -|Variables-*\*.ps1;-|APIScanInputs-*\**;-|test_symbols-*\**;-|MicroBuild\**;-|$(Build.ArtifactStagingDirectory)\VSInsertion-Windows\vs-insertion-script.ps1 policyFile: $(MBSIGN_APPFOLDER)\CSVTestSignPolicy.xml policheck: enabled: ${{ parameters.EnableProductionSDL }} From 9a6d7453fe7dcf3370fff0bdb86ba5ee0bc50082 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 22:33:00 +0000 Subject: [PATCH 1506/1753] Update actions/deploy-pages action to v4.0.5 (450) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f7ed808de..b1ba5680c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -40,4 +40,4 @@ jobs: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4 + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 From 5beff9213afc4fda78fb7189fdb2d1d46d7b9f5c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 18:21:32 -0700 Subject: [PATCH 1507/1753] Skip SBOM generation for the vs-insertion pipeline --- azure-pipelines/vs-insertion.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index bb5332ec9..068580c24 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -26,6 +26,8 @@ extends: networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEngSS-MicroBuild2022-1ES + sbom: + enabled: false stages: - stage: insertion From 89853ca1fd7e0c5839eac2071952e1770d23073f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Dec 2025 18:21:56 -0700 Subject: [PATCH 1508/1753] Remove stray backtick from README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b0c1a00cc..aa2dfb599 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Further customize your repo by: ### Maintaining your repo based on this template The best way to keep your repo in sync with this template's evolving features and best practices is to periodically merge the template into your repo: -` + ```ps1 git fetch git checkout origin/main From 40019588499960f7d5bc54e44bfd784f65f601bf Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 19:57:52 -0700 Subject: [PATCH 1509/1753] Update NuGet/login action to v1.1.0 (451) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ee4159b84..d2495c172 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -76,7 +76,7 @@ jobs: } - name: 🪪 Authorize NuGet package push - uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1 + uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1.1.0 id: nuget-login with: user: ${{ secrets.NUGET_USER }} From 6ffb32fd1d812708771f6aab66ae9303befd015e Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 3 Dec 2025 15:12:02 +0000 Subject: [PATCH 1510/1753] Merge pull request #1520 from microsoft/renovate/net-packages Update dependency Microsoft.Bcl.AsyncInterfaces to 9.0.11 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 0ec64cf78..c5b6b98e8 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + From b09c6e5524c0767461d10daa5b077d22db4033c9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Dec 2025 17:02:42 -0700 Subject: [PATCH 1511/1753] Remove vs-threading specific change --- src/OptProf.targets | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/OptProf.targets b/src/OptProf.targets index 0757df215..b99753b4b 100644 --- a/src/OptProf.targets +++ b/src/OptProf.targets @@ -2,7 +2,7 @@ IBC - Common7\IDE\PublicAssemblies\Microsoft.VisualStudio.Threading.17.x\$(TargetFileName) + Common7\IDE\PrivateAssemblies\$(TargetFileName) /ExeConfig:"%VisualStudio.InstallationUnderTest.Path%\Common7\IDE\vsn.exe" From fe54aae7537439698e7f9ce02e5b596ad3019880 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Dec 2025 17:16:47 -0700 Subject: [PATCH 1512/1753] Remove stale comment --- src/OptProf.targets | 1 - 1 file changed, 1 deletion(-) diff --git a/src/OptProf.targets b/src/OptProf.targets index b99753b4b..0b6cc92cd 100644 --- a/src/OptProf.targets +++ b/src/OptProf.targets @@ -6,7 +6,6 @@ /ExeConfig:"%VisualStudio.InstallationUnderTest.Path%\Common7\IDE\vsn.exe" - From 937c83ae3eb2b46f050e894d9e1d865a60eb0111 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 3 Dec 2025 19:46:34 -0700 Subject: [PATCH 1513/1753] Avoid building Windows-only binaries on linux/mac --- Microsoft.VisualStudio.Threading.slnx | 8 ++++++-- tools/dotnet-test-cloud.ps1 | 6 ++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/Microsoft.VisualStudio.Threading.slnx b/Microsoft.VisualStudio.Threading.slnx index 8542d76c5..647f3cb99 100644 --- a/Microsoft.VisualStudio.Threading.slnx +++ b/Microsoft.VisualStudio.Threading.slnx @@ -44,9 +44,13 @@ - + + + - + + + diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 02891d975..51919726f 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -47,6 +47,11 @@ if ($x86) { $testBinLog = Join-Path $ArtifactStagingFolder (Join-Path build_logs test.binlog) $testDiagLog = Join-Path $ArtifactStagingFolder (Join-Path test_logs diag.log) +$extraArgs = @() +if ($IsLinux -or $IsMacOS) { + $extraArgs += '-p:Platform=NonWindows' +} + & $dotnet test $RepoRoot ` --no-build ` -c $Configuration ` @@ -58,6 +63,7 @@ $testDiagLog = Join-Path $ArtifactStagingFolder (Join-Path test_logs diag.log) -bl:"$testBinLog" ` --diag "$testDiagLog;TraceLevel=info" ` --logger trx ` + @extraArgs ` $unknownCounter = 0 Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { From 397e3e9f01c7b986b84a5aced50fc32c000f1869 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 4 Dec 2025 03:36:38 +0000 Subject: [PATCH 1514/1753] Update actions/checkout action to v6.0.1 --- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/docs_validate.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 6a88e0c5d..ebd538812 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index adeffee4a..f7ed808de 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index ad00d50a3..1b6565df3 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 800279bb5..0b111a609 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From c2ee756b471535be01944279e73e379f0900ca80 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Dec 2025 06:39:26 -0700 Subject: [PATCH 1515/1753] Fix alignment of `sbom` parameter --- azure-pipelines/vs-insertion.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 3436ce019..faeadd88a 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -26,8 +26,8 @@ extends: networkIsolationPolicy: Permissive,CFSClean sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable - sbom: - enabled: false + sbom: + enabled: false stages: - stage: insertion From 8f355fd98abb169e345cd9eb9bb9ad8c36adbef0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 4 Dec 2025 07:45:38 -0700 Subject: [PATCH 1516/1753] Retarget NativeAOT testing to .NET 10 This provides a higher level of validation, and removes the need for VS 2022 to be on the build agent. --- .../NativeAOTCompatibility.Test.csproj | 4 ++-- test/dirs.proj | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj b/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj index f663beb88..87b9e251d 100644 --- a/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj +++ b/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj @@ -1,11 +1,11 @@ - net9.0 + net10.0 false - $(TargetFrameworks);net9.0-windows + $(TargetFrameworks);net10.0-windows diff --git a/test/dirs.proj b/test/dirs.proj index 16cfe03d2..dde4d2640 100644 --- a/test/dirs.proj +++ b/test/dirs.proj @@ -2,7 +2,7 @@ - - + + From abb8f7471146590332cde44bec5d2ce2fae7d3e0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 5 Dec 2025 09:54:59 -0700 Subject: [PATCH 1517/1753] Fix template expansion --- Expand-Template.ps1 | 9 --------- 1 file changed, 9 deletions(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index cebbcc9d9..aee8303f0 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -100,8 +100,6 @@ try { if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } git mv test/Library.Tests "test/$LibraryName.Tests" if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } - git mv src/VSInsertionMetadata/Library.VSInsertionMetadata.proj "src/VSInsertionMetadata/$LibraryName.VSInsertionMetadata.proj" - if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } # Update project reference in test project. Add before removal to keep the same ItemGroup in place. dotnet add "test/$LibraryName.Tests" reference "src/$LibraryName" @@ -172,13 +170,6 @@ try { 'LibraryName' = $LibraryName; } - Replace-Placeholders -Path "azure-pipelines/OptProf.yml" -Replacements @{ - 'LibraryName' = $LibraryName; - } - Replace-Placeholders -Path "azure-pipelines/OptProf_part2.yml" -Replacements @{ - 'LibraryName' = $LibraryName; - } - # Self destruct git rm Expand-Template.* Apply-Template.ps1 if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE } From fddc013fc29090578d198f457537568994647d46 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Dec 2025 14:14:43 -0700 Subject: [PATCH 1518/1753] Opt into Microsoft Testing Platform (MTP) (#452) --- Directory.Packages.props | 5 +++ azure-pipelines/Merge-CodeCoverage.ps1 | 1 + global.json | 3 ++ test/Directory.Build.props | 1 + test/Directory.Build.targets | 6 +++ tools/artifacts/coverageResults.ps1 | 27 ++++++------- tools/artifacts/testResults.ps1 | 3 +- tools/dotnet-test-cloud.ps1 | 53 +++++++++++++++++++------- 8 files changed, 72 insertions(+), 27 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d4cbbbb1c..56cc7c29c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,12 +4,17 @@ true true + 1.9.1 + + + + diff --git a/azure-pipelines/Merge-CodeCoverage.ps1 b/azure-pipelines/Merge-CodeCoverage.ps1 index 308f57546..169bb175e 100644 --- a/azure-pipelines/Merge-CodeCoverage.ps1 +++ b/azure-pipelines/Merge-CodeCoverage.ps1 @@ -28,6 +28,7 @@ try { if ($reports) { $reports |% { $_.FullName } |% { # In addition to replacing {reporoot}, we also normalize on one kind of slash so that the report aggregates data for a file whether data was collected on Windows or not. + Write-Verbose "Processing $_" $xml = [xml](Get-Content -LiteralPath $_) $xml.coverage.packages.package.classes.class |? { $_.filename} |% { $_.filename = $_.filename.Replace('{reporoot}', $RepoRoot).Replace([IO.Path]::AltDirectorySeparatorChar, [IO.Path]::DirectorySeparatorChar) diff --git a/global.json b/global.json index 895d51bad..37a3146a2 100644 --- a/global.json +++ b/global.json @@ -3,5 +3,8 @@ "version": "10.0.100", "rollForward": "patch", "allowPrerelease": false + }, + "test": { + "runner": "Microsoft.Testing.Platform" } } diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 6c7aa71dc..2b5b542d6 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -5,6 +5,7 @@ false true + true diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index 9f32cd061..8ec617e95 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,5 +1,11 @@ + + + + + + diff --git a/tools/artifacts/coverageResults.ps1 b/tools/artifacts/coverageResults.ps1 index 8c68216ed..1aadbb747 100644 --- a/tools/artifacts/coverageResults.ps1 +++ b/tools/artifacts/coverageResults.ps1 @@ -1,25 +1,26 @@ -$RepoRoot = [System.IO.Path]::GetFullPath("$PSScriptRoot\..\..") +$RepoRoot = Resolve-Path "$PSScriptRoot\..\.." -$coverageFiles = @(Get-ChildItem "$RepoRoot/test/*.cobertura.xml" -Recurse | Where {$_.FullName -notlike "*/In/*" -and $_.FullName -notlike "*\In\*" }) +$coverageFilesUnderRoot = @(Get-ChildItem "$RepoRoot/*.cobertura.xml" -Recurse | Where-Object {$_.FullName -notlike "*/In/*" -and $_.FullName -notlike "*\In\*" }) + +# Under MTP, coverage files are written directly to the artifacts output directory, +# so we need to look there too. +$ArtifactStagingFolder = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" +$directTestLogs = Join-Path $ArtifactStagingFolder test_logs +$coverageFilesUnderArtifacts = if (Test-Path $directTestLogs) { @(Get-ChildItem "$directTestLogs/*.cobertura.xml" -Recurse) } else { @() } # Prepare code coverage reports for merging on another machine -$repoRoot = $env:SYSTEM_DEFAULTWORKINGDIRECTORY -if (!$repoRoot) { $repoRoot = $env:GITHUB_WORKSPACE } -if ($repoRoot) { - Write-Host "Substituting $repoRoot with `"{reporoot}`"" - $coverageFiles |% { - $content = Get-Content -LiteralPath $_ |% { $_ -Replace [regex]::Escape($repoRoot), "{reporoot}" } - Set-Content -LiteralPath $_ -Value $content -Encoding UTF8 - } -} else { - Write-Warning "coverageResults: Cloud build not detected. Machine-neutral token replacement skipped." +Write-Host "Substituting $repoRoot with `"{reporoot}`"" +@($coverageFilesUnderRoot + $coverageFilesUnderArtifacts) |? { $_ }|% { + $content = Get-Content -LiteralPath $_ |% { $_ -Replace [regex]::Escape($repoRoot), "{reporoot}" } + Set-Content -LiteralPath $_ -Value $content -Encoding UTF8 } if (!((Test-Path $RepoRoot\bin) -and (Test-Path $RepoRoot\obj))) { return } @{ + $directTestLogs = $coverageFilesUnderArtifacts; $RepoRoot = ( - $coverageFiles + + $coverageFilesUnderRoot + (Get-ChildItem "$RepoRoot\obj\*.cs" -Recurse) ); } diff --git a/tools/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 index 5310fb52a..a841967e8 100644 --- a/tools/artifacts/testResults.ps1 +++ b/tools/artifacts/testResults.ps1 @@ -4,7 +4,8 @@ Param( $result = @{} -$testRoot = Resolve-Path "$PSScriptRoot\..\..\test" +$RepoRoot = Resolve-Path "$PSScriptRoot\..\.." +$testRoot = Join-Path $RepoRoot test $result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) $artifactStaging = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 02891d975..17fbe6c11 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -25,6 +25,7 @@ Param( $RepoRoot = (Resolve-Path "$PSScriptRoot/..").Path $ArtifactStagingFolder = & "$PSScriptRoot/Get-ArtifactsStagingDirectory.ps1" +$OnCI = ($env:CI -or $env:TF_BUILD) $dotnet = 'dotnet' if ($x86) { @@ -45,23 +46,49 @@ if ($x86) { } $testBinLog = Join-Path $ArtifactStagingFolder (Join-Path build_logs test.binlog) -$testDiagLog = Join-Path $ArtifactStagingFolder (Join-Path test_logs diag.log) +$testLogs = Join-Path $ArtifactStagingFolder test_logs -& $dotnet test $RepoRoot ` - --no-build ` - -c $Configuration ` - --filter "TestCategory!=FailsInCloudTest" ` - --collect "Code Coverage;Format=cobertura" ` - --settings "$PSScriptRoot/test.runsettings" ` - --blame-hang-timeout 60s ` - --blame-crash ` - -bl:"$testBinLog" ` - --diag "$testDiagLog;TraceLevel=info" ` - --logger trx ` +$globalJson = Get-Content $PSScriptRoot/../global.json | ConvertFrom-Json +$isMTP = $globalJson.test.runner -eq 'Microsoft.Testing.Platform' +if ($isMTP) { + $extraArgs = @() + if ($OnCI) { $extraArgs += '--no-progress' } + & $dotnet test --solution $RepoRoot ` + --no-build ` + -c $Configuration ` + -bl:"$testBinLog" ` + --filter-not-trait 'TestCategory=FailsInCloudTest' ` + --coverage ` + --coverage-output-format cobertura ` + --coverage-settings "$PSScriptRoot/test.runsettings" ` + --hangdump ` + --hangdump-timeout 60s ` + --crashdump ` + --diagnostic ` + --diagnostic-output-directory $testLogs ` + --diagnostic-verbosity Information ` + --results-directory $testLogs ` + --report-trx ` + @extraArgs +} else { + $testDiagLog = Join-Path $ArtifactStagingFolder (Join-Path test_logs diag.log) + & $dotnet test $RepoRoot ` + --no-build ` + -c $Configuration ` + --filter "TestCategory!=FailsInCloudTest" ` + --collect "Code Coverage;Format=cobertura" ` + --settings "$PSScriptRoot/test.runsettings" ` + --blame-hang-timeout 60s ` + --blame-crash ` + -bl:"$testBinLog" ` + --diag "$testDiagLog;TraceLevel=info" ` + --logger trx ` +} $unknownCounter = 0 Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { - Copy-Item $_ -Destination $ArtifactStagingFolder/test_logs/ + New-Item $testLogs -ItemType Directory -Force | Out-Null + Copy-Item $_ -Destination $testLogs if ($PublishResults) { $x = [xml](Get-Content -LiteralPath $_) From f761f0f7e50514cdb2b0b4b3b07fa3d298ff2eaf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Dec 2025 15:09:40 -0700 Subject: [PATCH 1519/1753] Push to nuget.org before pushing to github release This makes recovering a release from a nuget.org push failure easier. --- .github/workflows/release.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d2495c172..a4e4745a1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -64,6 +64,15 @@ jobs: run-id: ${{ steps.findrunid.outputs.runid }} github-token: ${{ github.token }} + - name: 🪪 Authorize NuGet package push + uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1.1.0 + id: nuget-login + with: + user: ${{ secrets.NUGET_USER }} + + - name: 🚀 Push NuGet packages + run: dotnet nuget push ${{ runner.temp }}/deployables/*.nupkg --source https://api.nuget.org/v3/index.json -k '${{ steps.nuget-login.outputs.NUGET_API_KEY }}' + - name: 💽 Upload artifacts to release shell: pwsh if: ${{ github.event_name == 'release' && github.event.release.assets_url != '' }} @@ -74,12 +83,3 @@ jobs: Write-Host "Uploading $($_.Name) to release..." gh release -R ${{ github.repository }} upload "${{ github.ref_name }}" $_.FullName } - - - name: 🪪 Authorize NuGet package push - uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1.1.0 - id: nuget-login - with: - user: ${{ secrets.NUGET_USER }} - - - name: 🚀 Push NuGet packages - run: dotnet nuget push ${{ runner.temp }}/deployables/*.nupkg --source https://api.nuget.org/v3/index.json -k '${{ steps.nuget-login.outputs.NUGET_API_KEY }}' From e4035601946447f2cb317003ebb600cf7df2742d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Dec 2025 15:59:57 -0700 Subject: [PATCH 1520/1753] Update to MTP v2 (#455) --- Directory.Packages.props | 6 +++--- test/Library.Tests/Library.Tests.csproj | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 56cc7c29c..80d105cfd 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,19 +4,19 @@ true true - 1.9.1 + 2.0.2 - + - + diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 5cbc1e1f2..146335725 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -14,7 +14,7 @@ - + From a28d54057fd4e9d86d4130b3977354bdf1754fbb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Dec 2025 16:11:51 -0700 Subject: [PATCH 1521/1753] Update all MTP related packages at once (457) --- .github/renovate.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/renovate.json b/.github/renovate.json index c97d97791..79dba1e54 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -11,6 +11,10 @@ "matchPackageNames": ["xunit*"], "groupName": "xunit" }, + { + "matchPackageNames": ["Microsoft.Testing.Extensions.*"], + "groupName": "Microsoft Testing Platform" + }, { "matchDatasources": ["dotnet-version", "docker"], "matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"], From f355f008b2b164d1e1fa8ca120442b0bffcf06af Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 7 Dec 2025 16:15:02 -0700 Subject: [PATCH 1522/1753] Fix test result publishing to AzDO (458) --- tools/dotnet-test-cloud.ps1 | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 17fbe6c11..9b48178c6 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -70,6 +70,8 @@ if ($isMTP) { --results-directory $testLogs ` --report-trx ` @extraArgs + + $trxFiles = Get-ChildItem -Recurse -Path $testLogs\*.trx } else { $testDiagLog = Join-Path $ArtifactStagingFolder (Join-Path test_logs diag.log) & $dotnet test $RepoRoot ` @@ -82,13 +84,17 @@ if ($isMTP) { --blame-crash ` -bl:"$testBinLog" ` --diag "$testDiagLog;TraceLevel=info" ` - --logger trx ` + --logger trx + + $trxFiles = Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx } $unknownCounter = 0 -Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx |% { +$trxFiles |% { New-Item $testLogs -ItemType Directory -Force | Out-Null - Copy-Item $_ -Destination $testLogs + if (!($_.FullName.StartsWith($testLogs))) { + Copy-Item $_ -Destination $testLogs + } if ($PublishResults) { $x = [xml](Get-Content -LiteralPath $_) From 3304d7930d87ac76dc060f80d5a89a233696e40c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 10 Dec 2025 13:50:17 +0000 Subject: [PATCH 1523/1753] Update .NET SDK to v10.0.101 (#459) * Update mcr.microsoft.com/dotnet/sdk Docker tag to v10.0.101 * Bump .NET SDK --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 6637ad8ac..64f23a9eb 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.100@sha256:c7445f141c04f1a6b454181bd098dcfa606c61ba0bd213d0a702489e5bd4cd71 +FROM mcr.microsoft.com/dotnet/sdk:10.0.101@sha256:d1823fecac3689a2eb959e02ee3bfe1c2142392808240039097ad70644566190 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 37a3146a2..a0ec2d8d9 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.100", + "version": "10.0.101", "rollForward": "patch", "allowPrerelease": false }, From 63de08696a81f2a8350910cd9c162e021f95a604 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Dec 2025 08:48:27 -0700 Subject: [PATCH 1524/1753] Drop package dependencies that MTP does not require --- Directory.Packages.props | 2 -- test/Library.Tests/Library.Tests.csproj | 2 -- 2 files changed, 4 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 80d105cfd..098c7f090 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,12 +10,10 @@ - - diff --git a/test/Library.Tests/Library.Tests.csproj b/test/Library.Tests/Library.Tests.csproj index 146335725..e9e12e43a 100644 --- a/test/Library.Tests/Library.Tests.csproj +++ b/test/Library.Tests/Library.Tests.csproj @@ -12,8 +12,6 @@ - - From 70980c340965220736976b61c0880a1f914a3171 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Dec 2025 14:22:58 -0700 Subject: [PATCH 1525/1753] Fix MTP test failure for MTP-incompatible projects under the test folder --- test/Directory.Build.targets | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index 8ec617e95..839afb5d5 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,6 +1,6 @@ - + From 307d5e37fbf1fff5b2ce96d7154145d4aa80e676 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 07:16:35 -0700 Subject: [PATCH 1526/1753] Fix testing regression from last commit --- test/Directory.Build.props | 1 + 1 file changed, 1 insertion(+) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 2b5b542d6..d7f919fb3 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -3,6 +3,7 @@ + true false true true From 5c9d6251b1074d83db4d18416828b2ccdba07eb9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 07:32:43 -0700 Subject: [PATCH 1527/1753] Adjust how we use IsTestProject This matches how MTP uses it internally. --- test/Directory.Build.props | 1 - test/Directory.Build.targets | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/test/Directory.Build.props b/test/Directory.Build.props index d7f919fb3..2b5b542d6 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -3,7 +3,6 @@ - true false true true diff --git a/test/Directory.Build.targets b/test/Directory.Build.targets index 839afb5d5..3758bb8c9 100644 --- a/test/Directory.Build.targets +++ b/test/Directory.Build.targets @@ -1,6 +1,6 @@ - + From c3770c5ce3215cbc649a28c19ab1905a1e092ef1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 09:02:49 -0700 Subject: [PATCH 1528/1753] All tests build 19 fail at runtime though. --- Directory.Packages.props | 8 --- .../ListOfOftenOne`1.cs | 4 -- .../WeakKeyDictionary`2.cs | 2 +- test/.editorconfig | 3 + test/Directory.Build.props | 1 - test/Directory.Packages.props | 14 +++++ test/IsolatedTestHost/App.config | 19 +------ test/IsolatedTestHost/Program.cs | 1 - .../Helpers/CSharpCodeFixVerifier`2+Test.cs | 2 +- .../VisualBasicCodeFixVerifier`2+Test.cs | 2 +- ...ualStudio.Threading.Analyzers.Tests.csproj | 3 +- ...UseSwitchToMainThreadAsyncAnalyzerTests.cs | 6 +- .../AssemblyInfo.cs | 2 - .../AsyncAutoResetEventTests.cs | 8 +-- .../AsyncBarrierTests.cs | 3 - .../AsyncCountdownEventTests.cs | 3 - .../AsyncCrossProcessMutexTests.cs | 3 - .../AsyncLazyInitializerTests.cs | 3 - .../AsyncLazyTests.cs | 9 +-- .../AsyncLocalTests.cs | 3 - .../AsyncManualResetEventTests.cs | 5 +- .../AsyncQueueTests.cs | 6 +- .../AsyncReaderWriterLockTests.cs | 21 +++---- .../AsyncReaderWriterResourceLockTests.cs | 3 - .../AsyncSemaphoreTests.cs | 3 - .../AwaitExtensionsTests.cs | 55 +++++++++---------- .../CancellationTokenExtensionsTests.cs | 3 - .../DelegatingJoinableTaskFactoryTests.cs | 7 +-- .../DispatcherExtensionsTests.cs | 2 - .../InternalUtilitiesTests.cs | 2 - ...inableTaskAndAsyncReaderWriterLockTests.cs | 3 - .../JoinableTaskCollectionTests.cs | 3 - .../JoinableTaskContextNodeTests.cs | 3 - .../JoinableTaskContextTests.cs | 3 - .../JoinableTaskFactoryTests.cs | 3 - .../JoinableTaskInternalsTests.cs | 3 - .../JoinableTaskTestBase.cs | 2 - .../JoinableTaskTests.cs | 15 ++--- .../JoinableTaskTokenTests.cs | 7 +-- .../ListOfOftenOneTests.cs | 15 ++--- ...rosoft.VisualStudio.Threading.Tests.csproj | 3 +- ...onConcurrentSynchronizationContextTests.cs | 5 -- .../ProgressWithCompletionTests.cs | 3 - .../RarelyRemoveItemSetTests.cs | 15 ++--- .../ReentrantSemaphoreJTFTests.cs | 3 - .../ReentrantSemaphoreNonJTFTests.cs | 3 - .../ReentrantSemaphoreTestBase.cs | 3 - ...ngleThreadedSynchronizationContextTests.cs | 3 - ...ingleThreadedTestSynchronizationContext.cs | 1 - .../TestBase.cs | 8 +-- .../TestBaseTests.cs | 15 ++--- .../TestUtilities.cs | 14 ++--- .../TestUtilitiesTests.cs | 2 - .../ThreadingToolsTests.cs | 5 +- .../TplExtensionsTests.cs | 5 +- .../Usings.cs | 5 ++ .../ValidityTests.cs | 2 - .../WeakKeyDictionaryTests.cs | 3 - 58 files changed, 113 insertions(+), 248 deletions(-) create mode 100644 test/Directory.Packages.props create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/Usings.cs diff --git a/Directory.Packages.props b/Directory.Packages.props index 55379f1bf..e1220977f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,6 @@ 2.0.2 2.0.208 3.11.0 - 4.13.0 1.1.2 3.11.0-beta1.25076.3 @@ -39,15 +38,8 @@ - - - - - - - diff --git a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs index 6ff984ca1..2549aeb50 100644 --- a/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs +++ b/src/Microsoft.VisualStudio.Threading/ListOfOftenOne`1.cs @@ -3,11 +3,7 @@ using System; using System.Collections.Generic; -using System.Diagnostics; -using System.Linq; -using System.Text; using System.Threading; -using System.Threading.Tasks; namespace Microsoft.VisualStudio.Threading; diff --git a/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs b/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs index 562d198aa..5f92e4cc7 100644 --- a/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs +++ b/src/Microsoft.VisualStudio.Threading/WeakKeyDictionary`2.cs @@ -214,7 +214,7 @@ System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() /// internal bool Any() { - foreach (KeyValuePair.WeakReference, TValue> item in this.dictionary) + foreach (KeyValuePair, TValue> item in this.dictionary) { if (item.Key.IsAlive) { diff --git a/test/.editorconfig b/test/.editorconfig index 988129278..04701aea8 100644 --- a/test/.editorconfig +++ b/test/.editorconfig @@ -80,3 +80,6 @@ dotnet_diagnostic.SA1401.severity = silent # SA1133: Do not combine attributes dotnet_diagnostic.SA1133.severity = silent + +# xUnit1051: Use TestContext.Current.CancellationToken +dotnet_diagnostic.xUnit1051.severity = suggestion diff --git a/test/Directory.Build.props b/test/Directory.Build.props index 155b347a6..466be54e4 100644 --- a/test/Directory.Build.props +++ b/test/Directory.Build.props @@ -3,7 +3,6 @@ - true false true true diff --git a/test/Directory.Packages.props b/test/Directory.Packages.props new file mode 100644 index 000000000..6875d8235 --- /dev/null +++ b/test/Directory.Packages.props @@ -0,0 +1,14 @@ + + + + + + 4.13.0 + + + + + + + + diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config index e5ab83a70..aed254391 100644 --- a/test/IsolatedTestHost/App.config +++ b/test/IsolatedTestHost/App.config @@ -1,29 +1,12 @@  - - - - - - + - - - - - - - - - - - - diff --git a/test/IsolatedTestHost/Program.cs b/test/IsolatedTestHost/Program.cs index 6712fa6e0..9cc72b4e0 100644 --- a/test/IsolatedTestHost/Program.cs +++ b/test/IsolatedTestHost/Program.cs @@ -7,7 +7,6 @@ using System.Reflection; using System.Threading; using System.Threading.Tasks; -using Xunit; namespace IsolatedTestHost; diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs index 18ae7d018..b767fa30e 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/CSharpCodeFixVerifier`2+Test.cs @@ -37,7 +37,7 @@ public Test() #if WINDOWS project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(Dispatcher).Assembly.Location)); #else - Skip.If(true); + Assert.SkipWhen(true, "Windows only"); #endif } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs index 8793d3d8c..c3a1ef718 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/VisualBasicCodeFixVerifier`2+Test.cs @@ -37,7 +37,7 @@ public Test() #if WINDOWS project = project.AddMetadataReference(MetadataReference.CreateFromFile(typeof(Dispatcher).Assembly.Location)); #else - Skip.If(true); + Assert.SkipWhen(true, "Windows only"); #endif } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 2bc4f8a7c..50bbac324 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -1,7 +1,7 @@  net8.0 - true + Exe true true $(NoWarn);NU1701 @@ -29,7 +29,6 @@ - /// Verifies that long-lived, uncanceled CancellationTokens do not result in leaking memory. /// - [SkippableFact(Skip = "It always fails after xunit 2.8 update.")] + [Fact(Skip = "It always fails after xunit 2.8 update.")] [Trait("GC", "true")] [Trait("TestCategory", "FailsInCloudTest")] public async Task WaitAsync_WithCancellationToken_DoesNotLeakWhenNotCanceled() @@ -222,7 +220,7 @@ public async Task WaitAsync_WithCancellationToken_DoesNotLeakWhenNotCanceled() /// /// Verifies that canceled CancellationTokens do not result in leaking memory. /// - [SkippableFact(Skip = "It always fails after xunit 2.8 update.")] + [Fact(Skip = "It always fails after xunit 2.8 update.")] [Trait("GC", "true")] [Trait("TestCategory", "FailsInCloudTest")] public async Task WaitAsync_WithCancellationToken_DoesNotLeakWhenCanceled() diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs index 5b9c48559..394cf5bee 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncBarrierTests.cs @@ -6,9 +6,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncBarrierTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCountdownEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCountdownEventTests.cs index 7c9606aca..2ab242193 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCountdownEventTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCountdownEventTests.cs @@ -4,9 +4,6 @@ using System; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncCountdownEventTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs index 9c72d1d8a..8872ad9aa 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs @@ -4,9 +4,6 @@ using System; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncCrossProcessMutexTests : TestBase, IDisposable { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyInitializerTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyInitializerTests.cs index 5c16ba2a6..69eb2dccd 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyInitializerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyInitializerTests.cs @@ -4,9 +4,6 @@ using System; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncLazyInitializerTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 0c3e76a21..79fb5b395 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -8,11 +8,6 @@ using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; - -using Xunit; -using Xunit.Abstractions; - using NamedSyncContext = AwaitExtensionsTests.NamedSyncContext; public class AsyncLazyTests : TestBase @@ -214,7 +209,7 @@ public async Task ValueFactoryReentersValueFactorySynchronously(bool specifyJtf) Assert.False(executed); executed = true; lazy!.GetValueAsync(); - return Task.FromResult(new object()); + return Task.FromResult(new object()); }, jtf); @@ -389,7 +384,7 @@ public void ToStringForUncreatedValue() [Fact] public async Task ToStringForCreatedValue() { - var lazy = new AsyncLazy(() => Task.FromResult(3)); + var lazy = new AsyncLazy(() => Task.FromResult(3)); int value = await lazy.GetValueAsync(); string result = lazy.ToString(); Assert.Equal(value.ToString(CultureInfo.InvariantCulture), result); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLocalTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLocalTests.cs index eeb40ead3..0d0b63e88 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLocalTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLocalTests.cs @@ -7,9 +7,6 @@ using System.Reflection; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncLocalTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs index 3e774cf93..556bc7c20 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs @@ -4,9 +4,6 @@ using System; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncManualResetEventTests : TestBase { @@ -21,7 +18,7 @@ public AsyncManualResetEventTests(ITestOutputHelper logger) [Fact] public void CtorDefaultParameter() { - Assert.False(new System.Threading.ManualResetEventSlim().IsSet); + Assert.False(new ManualResetEventSlim().IsSet); } [Fact] diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs index 65c5700df..c53a34c2c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs @@ -6,14 +6,12 @@ using System.Linq; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; public class AsyncQueueTests : TestBase { private AsyncQueue queue; - public AsyncQueueTests(Xunit.Abstractions.ITestOutputHelper logger) + public AsyncQueueTests(ITestOutputHelper logger) : base(logger) { this.queue = new AsyncQueue(); @@ -543,7 +541,7 @@ public void OnCompletedInvoked() Assert.Equal(1, invoked); } - [SkippableFact, Trait("GC", "true")] + [Fact, Trait("GC", "true")] [Trait("TestCategory", "FailsInCloudTest")] public void UnusedQueueGCPressure() { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index 9944108c7..7cd96d1e2 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -9,9 +9,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; using Xunit.Sdk; #pragma warning disable CA1416 // Validate platform compatibility @@ -230,7 +227,7 @@ public async Task CompleteMethodExecutesContinuationsAsynchronously() await continuation; } - [SkippableFact] + [Fact] [Trait("TestCategory", "FailsInCloudTest")] public async Task NoMemoryLeakForManyLocks() { @@ -3854,10 +3851,10 @@ public async Task MtaLockSharedWithMta() } /// Verifies that when an MTA holding a lock traverses (via CallContext) to an STA that the STA does not appear to hold a lock. - [SkippableFact] + [Fact] public async Task MtaLockNotSharedWithSta() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (await this.asyncLock.ReadLockAsync()) { var testComplete = new TaskCompletionSource(); @@ -3880,10 +3877,10 @@ public async Task MtaLockNotSharedWithSta() } /// Verifies that when an MTA holding a lock traverses (via CallContext) to an STA that the STA will be able to access the same lock by marshaling back to an MTA. - [SkippableFact] + [Fact] public async Task ReadLockTraversesAcrossSta() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (await this.asyncLock.ReadLockAsync()) { var testComplete = new TaskCompletionSource(); @@ -3920,10 +3917,10 @@ public async Task ReadLockTraversesAcrossSta() } /// Verifies that when an MTA holding a lock traverses (via CallContext) to an STA that the STA will be able to access the same lock by requesting it and moving back to an MTA. - [SkippableFact] + [Fact] public async Task UpgradeableReadLockTraversesAcrossSta() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (await this.asyncLock.UpgradeableReadLockAsync()) { @@ -3963,10 +3960,10 @@ public async Task UpgradeableReadLockTraversesAcrossSta() } /// Verifies that when an MTA holding a lock traverses (via CallContext) to an STA that the STA will be able to access the same lock by requesting it and moving back to an MTA. - [SkippableFact] + [Fact] public async Task WriteLockTraversesAcrossSta() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (await this.asyncLock.WriteLockAsync()) { var testComplete = new TaskCompletionSource(); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs index 2b6fb8d15..da1e01462 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterResourceLockTests.cs @@ -7,9 +7,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncReaderWriterResourceLockTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs index 5265569a9..7a5ffd2b1 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncSemaphoreTests.cs @@ -7,9 +7,6 @@ using System.Linq; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class AsyncSemaphoreTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index b2d5af6fb..1a8bad136 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -9,10 +9,7 @@ using System.Runtime.InteropServices; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; using Microsoft.Win32; -using Xunit; -using Xunit.Abstractions; #pragma warning disable CA1416 // Validate platform compatibility @@ -383,10 +380,10 @@ public async Task WaitForExit_NullArgument() await Assert.ThrowsAsync(() => AwaitExtensions.WaitForExitAsync(null!)); } - [SkippableFact] + [Fact] public async Task WaitForExitAsync_ExitCode() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); Process p = Process.Start( new ProcessStartInfo("cmd.exe", "/c exit /b 55") { @@ -397,10 +394,10 @@ public async Task WaitForExitAsync_ExitCode() Assert.Equal(55, exitCode); } - [SkippableFact] + [Fact] public void WaitForExitAsync_AlreadyExited() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); Process p = Process.Start( new ProcessStartInfo("cmd.exe", "/c exit /b 55") { @@ -613,10 +610,10 @@ public async Task SyncContext_Awaiter() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { Task changeWatcherTask = test.Key.WaitForChangeAsync(); @@ -626,10 +623,10 @@ public async Task AwaitRegKeyChange() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_TwoAtOnce_SameKeyHandle() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { Task changeWatcherTask1 = test.Key.WaitForChangeAsync(); @@ -641,10 +638,10 @@ public async Task AwaitRegKeyChange_TwoAtOnce_SameKeyHandle() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_NoChange() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { Task changeWatcherTask = test.Key.WaitForChangeAsync(cancellationToken: test.FinishedToken); @@ -656,10 +653,10 @@ public async Task AwaitRegKeyChange_NoChange() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_WatchSubtree() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { using (RegistryKey? subKey = test.CreateSubKey()) @@ -671,10 +668,10 @@ public async Task AwaitRegKeyChange_WatchSubtree() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_KeyDeleted() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { using (RegistryKey? subKey = test.CreateSubKey()) @@ -686,10 +683,10 @@ public async Task AwaitRegKeyChange_KeyDeleted() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_NoWatchSubtree() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { using (RegistryKey? subKey = test.CreateSubKey()) @@ -705,10 +702,10 @@ public async Task AwaitRegKeyChange_NoWatchSubtree() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_Canceled() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { var cts = new CancellationTokenSource(); @@ -727,10 +724,10 @@ public async Task AwaitRegKeyChange_Canceled() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_KeyDisposedWhileWatching() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); Task watchingTask; using (var test = new RegKeyTest()) { @@ -741,10 +738,10 @@ public async Task AwaitRegKeyChange_KeyDisposedWhileWatching() await watchingTask; } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_CanceledAndImmediatelyDisposed() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); Task watchingTask; CancellationToken expectedCancellationToken; using (var test = new RegKeyTest()) @@ -764,10 +761,10 @@ public async Task AwaitRegKeyChange_CanceledAndImmediatelyDisposed() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_CallingThreadDestroyed() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); using (var test = new RegKeyTest()) { // Start watching and be certain the thread that started watching is destroyed. @@ -789,10 +786,10 @@ public async Task AwaitRegKeyChange_CallingThreadDestroyed() } } - [SkippableFact] + [Fact] public async Task AwaitRegKeyChange_DoesNotPreventAppTerminationOnWin7() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); string testExePath = Path.Combine( AppDomain.CurrentDomain.BaseDirectory!, "..", diff --git a/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs index 5a957f05b..2d483b9ec 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/CancellationTokenExtensionsTests.cs @@ -4,9 +4,6 @@ using System; using System.Linq; using System.Threading; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class CancellationTokenExtensionsTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/DelegatingJoinableTaskFactoryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/DelegatingJoinableTaskFactoryTests.cs index 9ca54fa96..2904d364d 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/DelegatingJoinableTaskFactoryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/DelegatingJoinableTaskFactoryTests.cs @@ -7,9 +7,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class DelegatingJoinableTaskFactoryTests : JoinableTaskTestBase { @@ -156,7 +153,7 @@ protected override void WaitSynchronously(Task task) base.WaitSynchronously(task); } - protected override void PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback callback, object state) + protected override void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) { this.addToLog(FactoryLogEntry.InnerPostToUnderlyingSynchronizationContext); base.PostToUnderlyingSynchronizationContext(callback, state); @@ -196,7 +193,7 @@ protected override void WaitSynchronously(Task task) base.WaitSynchronously(task); } - protected override void PostToUnderlyingSynchronizationContext(System.Threading.SendOrPostCallback callback, object state) + protected override void PostToUnderlyingSynchronizationContext(SendOrPostCallback callback, object state) { this.addToLog(FactoryLogEntry.OuterPostToUnderlyingSynchronizationContext); base.PostToUnderlyingSynchronizationContext(callback, state); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs index 49c05e0be..65d324840 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs @@ -9,8 +9,6 @@ using System.Windows.Threading; using Microsoft; using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class DispatcherExtensionsTests : JoinableTaskTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/InternalUtilitiesTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/InternalUtilitiesTests.cs index 5c8f3d75f..bec84f2c4 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/InternalUtilitiesTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/InternalUtilitiesTests.cs @@ -3,8 +3,6 @@ using System.Collections.Generic; using System.Linq; -using Microsoft.VisualStudio.Threading; -using Xunit; public class InternalUtilitiesTests { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs index 2c05ec10f..33a233bfc 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskAndAsyncReaderWriterLockTests.cs @@ -3,9 +3,6 @@ using System; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskAndAsyncReaderWriterLockTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskCollectionTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskCollectionTests.cs index 02e3d8a7c..1cba90a05 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskCollectionTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskCollectionTests.cs @@ -4,9 +4,6 @@ using System; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskCollectionTests : JoinableTaskTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextNodeTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextNodeTests.cs index 156fc0aea..62393635a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextNodeTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextNodeTests.cs @@ -5,9 +5,6 @@ using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskContextNodeTests : JoinableTaskTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs index 2951b647c..b644fc158 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskContextTests.cs @@ -8,9 +8,6 @@ using System.Threading.Tasks; using System.Xml.Linq; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskContextTests : JoinableTaskTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs index 47ba640e3..7f05a3d5b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs @@ -3,9 +3,6 @@ using System; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskFactoryTests : JoinableTaskTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs index 969fb62b9..d13235468 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskInternalsTests.cs @@ -3,9 +3,6 @@ using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskInternalsTests : JoinableTaskTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs index 8868d0ec6..f415f93ba 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs @@ -9,8 +9,6 @@ using System.Threading.Tasks; using System.Xml.Linq; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit.Abstractions; public abstract class JoinableTaskTestBase : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index 15af17a7a..09013f9f0 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -10,9 +10,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskTests : JoinableTaskTestBase { @@ -1934,7 +1931,7 @@ public void SynchronousTaskStackMaintainedCorrectly() { this.asyncPump.Run(async delegate { - this.asyncPump.Run(() => Task.FromResult(true)); + this.asyncPump.Run(() => Task.FromResult(true)); await Task.Yield(); }); } @@ -2236,7 +2233,7 @@ public void BeginAsyncWithResultOnMTAKicksOffOtherAsyncPumpWorkCanCompleteSynchr Assert.False(joinable.Task.IsCompleted); int result = joinable.Join(); - Assert.Equal(5, result); + Assert.Equal(5, result); Assert.True(taskFinished); Assert.True(joinable.Task.IsCompleted); } @@ -2268,7 +2265,7 @@ public void Join_AlreadyCompletedWithPrecanceledArgument() [Fact] public void Join_AlreadyCompletedWithPrecanceledArgument_Generic() { - JoinableTask jt = this.asyncPump.RunAsync(() => Task.FromResult(0)); + JoinableTask jt = this.asyncPump.RunAsync(() => Task.FromResult(0)); Assert.Throws(() => jt.Join(new CancellationToken(canceled: true))); } @@ -2282,7 +2279,7 @@ public async Task JoinAsync_AlreadyCompletedWithPrecanceledArgument() [Fact] public async Task JoinAsync_AlreadyCompletedWithPrecanceledArgument_Generic() { - JoinableTask jt = this.asyncPump.RunAsync(() => Task.FromResult(0)); + JoinableTask jt = this.asyncPump.RunAsync(() => Task.FromResult(0)); await Assert.ThrowsAsync(() => jt.JoinAsync(new CancellationToken(canceled: true))); } @@ -2977,7 +2974,7 @@ await loPriFactory.RunAsync(async delegate hiPriFactory.DoModalLoopTillEmptyAndTaskCompleted(outer.Task, this.TimeoutToken); } - [SkippableFact] + [Fact] public void NestedFactoriesCanBeCollected() { WeakReference weakOuterFactory = this.NestedFactoriesCanBeCollected_Helper(); @@ -4491,7 +4488,7 @@ private WeakReference NestedFactoriesCanBeCollected_Helper() }); outerFactory.DoModalLoopTillEmptyAndTaskCompleted(outer.Task, this.TimeoutToken); - Skip.IfNot(outer.IsCompleted, "this is a product defect, but this test assumes this works to test something else."); + Assert.SkipUnless(outer.IsCompleted, "this is a product defect, but this test assumes this works to test something else."); // Allow the dispatcher to drain all messages that may be holding references. SynchronizationContext.Current!.Post(s => this.testFrame.Continue = false, null); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs index 25c078496..7d2e07360 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs @@ -4,9 +4,6 @@ using System; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class JoinableTaskTokenTests : JoinableTaskTestBase { @@ -171,7 +168,7 @@ public async Task RunAsyncOfT_AvoidsDeadlockWithParent(bool includeOtherContexts TaskCompletionSource tokenSource = new(); AsyncManualResetEvent releaseOuterTask = new(); - JoinableTask outerTask = this.asyncPump.RunAsync( + JoinableTask outerTask = this.asyncPump.RunAsync( async delegate { try @@ -199,7 +196,7 @@ async delegate this.Logger.WriteLine($"Token (modified): {token}"); } - JoinableTask innerTask = this.asyncPump.RunAsync( + JoinableTask innerTask = this.asyncPump.RunAsync( async delegate { await Task.Yield(); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ListOfOftenOneTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ListOfOftenOneTests.cs index e9bf81f4b..539f88190 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ListOfOftenOneTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ListOfOftenOneTests.cs @@ -2,9 +2,6 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System.Linq; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class ListOfOftenOneTests : TestBase { @@ -34,11 +31,11 @@ public void EnumerationOfOne() using (ListOfOftenOne.Enumerator enumerator = this.list.GetEnumerator()) { Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); enumerator.Reset(); Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); } } @@ -51,15 +48,15 @@ public void EnumerationOfTwo() using (ListOfOftenOne.Enumerator enumerator = this.list.GetEnumerator()) { Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.True(enumerator.MoveNext()); - Assert.Equal(2, enumerator.Current.Data); + Assert.Equal(2, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); enumerator.Reset(); Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.True(enumerator.MoveNext()); - Assert.Equal(2, enumerator.Current.Data); + Assert.Equal(2, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj index 31e88d642..d92df35cd 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests/Microsoft.VisualStudio.Threading.Tests.csproj @@ -1,8 +1,8 @@  net8.0 + Exe true - true true true @@ -31,7 +31,6 @@ - diff --git a/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs index 26afaae86..650a23f3b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs @@ -2,14 +2,9 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Generic; using System.Linq; -using System.Text; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class NonConcurrentSynchronizationContextTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs index f2dd306fc..41f1c29f3 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ProgressWithCompletionTests.cs @@ -5,9 +5,6 @@ using System.Linq; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class ProgressWithCompletionTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs index fb4f79b14..d87d0c071 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/RarelyRemoveItemSetTests.cs @@ -4,9 +4,6 @@ using System; using System.Linq; using System.Runtime.CompilerServices; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class RarelyRemoveItemSetTests : TestBase { @@ -36,11 +33,11 @@ public void EnumerationOfOne() using (RarelyRemoveItemSet.Enumerator enumerator = this.list.EnumerateAndClear().GetEnumerator()) { Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); enumerator.Reset(); Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); } } @@ -53,15 +50,15 @@ public void EnumerationOfTwo() using (RarelyRemoveItemSet.Enumerator enumerator = this.list.EnumerateAndClear().GetEnumerator()) { Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.True(enumerator.MoveNext()); - Assert.Equal(2, enumerator.Current.Data); + Assert.Equal(2, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); enumerator.Reset(); Assert.True(enumerator.MoveNext()); - Assert.Equal(1, enumerator.Current.Data); + Assert.Equal(1, enumerator.Current.Data); Assert.True(enumerator.MoveNext()); - Assert.Equal(2, enumerator.Current.Data); + Assert.Equal(2, enumerator.Current.Data); Assert.False(enumerator.MoveNext()); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreJTFTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreJTFTests.cs index 7ec4ac0d8..6c001e1c2 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreJTFTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreJTFTests.cs @@ -6,9 +6,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class ReentrantSemaphoreJTFTests : ReentrantSemaphoreTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreNonJTFTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreNonJTFTests.cs index 5a1ab9ebd..4935e0b64 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreNonJTFTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreNonJTFTests.cs @@ -2,9 +2,6 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class ReentrantSemaphoreNonJTFTests : ReentrantSemaphoreTestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs index 8e58d4317..494de17d1 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ReentrantSemaphoreTestBase.cs @@ -6,9 +6,6 @@ using System.Linq; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public abstract class ReentrantSemaphoreTestBase : TestBase, IDisposable { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs index 7cd17668d..7e9e5ec44 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedSynchronizationContextTests.cs @@ -4,9 +4,6 @@ using System; using System.Reflection; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class SingleThreadedSynchronizationContextTests : TestBase { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs index 6fd9f5646..0bd798d8a 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/SingleThreadedTestSynchronizationContext.cs @@ -8,7 +8,6 @@ using System.Diagnostics.CodeAnalysis; using System.Threading; using Microsoft; -using Microsoft.VisualStudio.Threading; #if UseWpfContext using System.Windows.Threading; #endif diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs index 5b7b6ff4d..dd0422e78 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs @@ -8,9 +8,7 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; +using Xunit.Sdk; public abstract class TestBase { @@ -339,7 +337,7 @@ protected void ExecuteOnDispatcher(Func action) /// A task whose result is if test execution is already isolated and should therefore proceed with the body of the test, /// or after the isolated instance of the test has completed execution. /// - /// Thrown if the isolated test result is a Failure. + /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. protected Task ExecuteInIsolationAsync([CallerMemberName] string testMethodName = null!) { @@ -355,7 +353,7 @@ protected Task ExecuteInIsolationAsync([CallerMemberName] string testMetho /// if test execution is already isolated and should therefore proceed with the body of the test, /// or after the isolated instance of the test has completed execution. /// - /// Thrown if the isolated test result is a Failure. + /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. protected bool ExecuteInIsolation([CallerMemberName] string testMethodName = null!) { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs index 52853bcb0..26ef0eb7f 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestBaseTests.cs @@ -6,9 +6,6 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; using Xunit.Sdk; public class TestBaseTests : TestBase @@ -18,10 +15,10 @@ public TestBaseTests(ITestOutputHelper logger) { } - [SkippableFact] + [Fact] public void ExecuteOnSTA_ExecutesDelegateOnSTA() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); bool executed = false; this.ExecuteOnSTA(delegate { @@ -32,10 +29,10 @@ public void ExecuteOnSTA_ExecutesDelegateOnSTA() Assert.True(executed); } - [SkippableFact] + [Fact] public void ExecuteOnSTA_PropagatesExceptions() { - Skip.IfNot(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)); + Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); Assert.Throws(() => this.ExecuteOnSTA(() => { throw new ApplicationException(); @@ -90,7 +87,7 @@ public void ExecuteOnDispatcher_PropagatesExceptions() })); } - [SkippableFact] + [Fact] [Trait("TestCategory", "FailsInCloudTest")] public async Task ExecuteInIsolation_PassingTest() { @@ -100,7 +97,7 @@ public async Task ExecuteInIsolation_PassingTest() } } - [SkippableFact] + [Fact] public async Task ExecuteInIsolation_FailingTest() { bool executeHere; diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs index 28844c1a1..53e7ed4ff 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs @@ -10,9 +10,7 @@ using System.Threading; using System.Threading.Tasks; using Microsoft; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; +using Xunit.Sdk; internal static class TestUtilities { @@ -69,7 +67,7 @@ internal static T[] ConcurrencyTest(Func action, int concurrency = -1) concurrency = Environment.ProcessorCount; } - Skip.If(Environment.ProcessorCount < concurrency, $"The test machine does not have enough CPU cores to exercise a concurrency level of {concurrency}"); + Assert.SkipWhen(Environment.ProcessorCount < concurrency, $"The test machine does not have enough CPU cores to exercise a concurrency level of {concurrency}"); // We use a barrier to guarantee that all threads are fully ready to // execute the provided function at precisely the same time. @@ -170,7 +168,7 @@ internal static IDisposable StarveThreadpool() /// A task whose result is if test execution is already isolated and should therefore proceed with the body of the test, /// or after the isolated instance of the test has completed execution. /// - /// Thrown if the isolated test result is a Failure. + /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. internal static Task ExecuteInIsolationAsync(object testClass, string testMethodName, ITestOutputHelper logger) { @@ -189,7 +187,7 @@ internal static Task ExecuteInIsolationAsync(object testClass, string test /// A task whose result is if test execution is already isolated and should therefore proceed with the body of the test, /// or after the isolated instance of the test has completed execution. /// - /// Thrown if the isolated test result is a Failure. + /// Thrown if the isolated test result is a Failure. /// Thrown if on a platform that we do not yet support test isolation on. #pragma warning disable CA1801 // Review unused parameters internal static Task ExecuteInIsolationAsync(string testClassName, string testMethodName, ITestOutputHelper logger) @@ -248,7 +246,7 @@ internal static Task ExecuteInIsolationAsync(string testClassName, string switch (t.Result) { case IsolatedTestHost.ExitCode.TestSkipped: - throw new SkipException("Test skipped. See output of isolated task for details."); + throw SkipException.ForSkip("Test skipped. See output of isolated task for details."); case IsolatedTestHost.ExitCode.TestPassed: default: Assert.Equal(IsolatedTestHost.ExitCode.TestPassed, t.Result); @@ -259,7 +257,7 @@ internal static Task ExecuteInIsolationAsync(string testClassName, string }, TaskScheduler.Default); #else - return Task.FromException(new SkipException("Test isolation is not yet supported on this platform.")); + return Task.FromException(SkipException.ForSkip("Test isolation is not yet supported on this platform.")); #endif } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilitiesTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilitiesTests.cs index 109fb3b6c..82a530f1d 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilitiesTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilitiesTests.cs @@ -2,8 +2,6 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; public class TestUtilitiesTests { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs index aec072c82..a670da2c9 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ThreadingToolsTests.cs @@ -5,9 +5,6 @@ using System.Linq; using System.Threading; using System.Threading.Tasks; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; public class ThreadingToolsTests : TestBase { @@ -118,7 +115,7 @@ public void WithCancellationOfPrecanceledTaskOfT() Assert.Same(tcs.Task, tcs.Task.WithCancellation(cts.Token)); } - [SkippableFact] + [Fact] public void WithCancellationAndPrecancelledToken() { var tcs = new TaskCompletionSource(); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs index aa241bd84..4d0429637 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TplExtensionsTests.cs @@ -6,9 +6,6 @@ using System.Threading; using System.Threading.Tasks; using System.Threading.Tasks.Sources; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; using TplExtensions = Microsoft.VisualStudio.Threading.TplExtensions; public class TplExtensionsTests : TestBase @@ -1077,7 +1074,7 @@ public void WithTimeout_MinusOneMeansInfiniteTimeout(bool generic) { var tcs = new TaskCompletionSource(); Task? timeoutTask = generic - ? TplExtensions.WithTimeout(tcs.Task, TimeSpan.FromMilliseconds(-1)) + ? TplExtensions.WithTimeout(tcs.Task, TimeSpan.FromMilliseconds(-1)) : TplExtensions.WithTimeout((Task)tcs.Task, TimeSpan.FromMilliseconds(-1)); Assert.False(timeoutTask.IsCompleted); await Task.Delay(AsyncDelay / 2); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/Usings.cs b/test/Microsoft.VisualStudio.Threading.Tests/Usings.cs new file mode 100644 index 000000000..f10604229 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/Usings.cs @@ -0,0 +1,5 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +global using Microsoft.VisualStudio.Threading; +global using Xunit; diff --git a/test/Microsoft.VisualStudio.Threading.Tests/ValidityTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/ValidityTests.cs index 8af8ab8dc..176e1de45 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/ValidityTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/ValidityTests.cs @@ -2,8 +2,6 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System.Reflection; -using Microsoft.VisualStudio.Threading; -using Xunit; public class ValidityTests { diff --git a/test/Microsoft.VisualStudio.Threading.Tests/WeakKeyDictionaryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/WeakKeyDictionaryTests.cs index 9c8e17dcf..c533a47cd 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/WeakKeyDictionaryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/WeakKeyDictionaryTests.cs @@ -5,9 +5,6 @@ using System.Collections.Generic; using System.Linq; using System.Runtime.CompilerServices; -using Microsoft.VisualStudio.Threading; -using Xunit; -using Xunit.Abstractions; /// /// Tests for the weak dictionary class. From adf181af9f7b74803b0eee39c9af47d427b803ac Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 09:13:19 -0700 Subject: [PATCH 1529/1753] Fix tests that fail due to Xunit's trace assertion failure listener --- .../TestUtilities.cs | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs index 53e7ed4ff..1c7872500 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestUtilities.cs @@ -92,11 +92,10 @@ internal static T[] ConcurrencyTest(Func action, int concurrency = -1) internal static DebugAssertionRevert DisableAssertionDialog() { #if NETFRAMEWORK - DefaultTraceListener? listener = Debug.Listeners.OfType().FirstOrDefault(); - if (listener is object) - { - listener.AssertUiEnabled = false; - } + Debug.Listeners.OfType().FirstOrDefault()?.AssertUiEnabled = false; + + // Xunit v3 adds a listener that throws on assertions; remove it so we can test actual runtime functionality of the library. + Debug.Listeners.Remove("xUnit.net"); #else Trace.Listeners.Clear(); #endif From fb63f88c9f6b54cf6b042ab7a31c5b7eb0e5c536 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 09:18:32 -0700 Subject: [PATCH 1530/1753] Adapt to Xunit removing its `AsyncTestContext` SynchronizationContext --- .../AsyncReaderWriterLockTests.cs | 44 ++++++++++--------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index 7cd96d1e2..c62e537ab 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -4379,30 +4379,34 @@ public async Task ReadLockAsync_OnCompleted_CapturesExecutionContext() [Fact] public async Task ReadLockAsync_UnsafeOnCompleted_DoesNotCaptureExecutionContext() { - var asyncLocal = new Microsoft.VisualStudio.Threading.AsyncLocal(); - asyncLocal.Value = "expected"; - AsyncReaderWriterLock.Awaiter? awaiter = this.asyncLock.ReadLockAsync().GetAwaiter(); - Assumes.False(awaiter.IsCompleted); - var testResultSource = new TaskCompletionSource(); - awaiter.UnsafeOnCompleted(delegate + // Apply some SynchronizationContext to ensure the issued lock will require us to yield. + using (new SynchronizationContext().Apply(checkForChangesOnRevert: false)) { - try + var asyncLocal = new Microsoft.VisualStudio.Threading.AsyncLocal(); + asyncLocal.Value = "expected"; + AsyncReaderWriterLock.Awaiter? awaiter = this.asyncLock.ReadLockAsync().GetAwaiter(); + Assumes.False(awaiter.IsCompleted); + TaskCompletionSource testResultSource = new(TaskCreationOptions.RunContinuationsAsynchronously); + awaiter.UnsafeOnCompleted(delegate { - using (awaiter.GetResult()) + try { - Assert.Null(asyncLocal.Value); - testResultSource.SetResult(null); + using (awaiter.GetResult()) + { + Assert.Null(asyncLocal.Value); + testResultSource.SetResult(null); + } } - } - catch (Exception ex) - { - testResultSource.SetException(ex); - } - finally - { - } - }); - await testResultSource.Task; + catch (Exception ex) + { + testResultSource.SetException(ex); + } + finally + { + } + }); + await testResultSource.Task; + } } [Fact(Skip = "Disabled after dependency updates introduced failures. See https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1974921")] From 762bd46d949ef038c90c5258be769e82b08c2e2d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 10:25:57 -0700 Subject: [PATCH 1531/1753] Expand applicability of extra args in `dotnet-test-cloud.ps1` --- tools/dotnet-test-cloud.ps1 | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 9b48178c6..b5504801e 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -50,8 +50,9 @@ $testLogs = Join-Path $ArtifactStagingFolder test_logs $globalJson = Get-Content $PSScriptRoot/../global.json | ConvertFrom-Json $isMTP = $globalJson.test.runner -eq 'Microsoft.Testing.Platform' +$extraArgs = @() + if ($isMTP) { - $extraArgs = @() if ($OnCI) { $extraArgs += '--no-progress' } & $dotnet test --solution $RepoRoot ` --no-build ` @@ -84,7 +85,8 @@ if ($isMTP) { --blame-crash ` -bl:"$testBinLog" ` --diag "$testDiagLog;TraceLevel=info" ` - --logger trx + --logger trx ` + @extraArgs $trxFiles = Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx } From 887c2dfea7241082f8d324900ba48ea522b592bc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 09:50:59 -0700 Subject: [PATCH 1532/1753] Adapt IsolatedTestHost to xunit.v3 --- Directory.Packages.props | 2 +- test/IsolatedTestHost/IsolatedTestHost.csproj | 3 ++- test/IsolatedTestHost/Program.cs | 3 +-- test/IsolatedTestHost/TestOutputHelper.cs | 25 +++++++++++-------- 4 files changed, 18 insertions(+), 15 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index e1220977f..2cf97ec8a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -36,7 +36,7 @@ - + diff --git a/test/IsolatedTestHost/IsolatedTestHost.csproj b/test/IsolatedTestHost/IsolatedTestHost.csproj index b5b95cf1e..353005b37 100644 --- a/test/IsolatedTestHost/IsolatedTestHost.csproj +++ b/test/IsolatedTestHost/IsolatedTestHost.csproj @@ -3,10 +3,11 @@ Exe net472 + false - + diff --git a/test/IsolatedTestHost/Program.cs b/test/IsolatedTestHost/Program.cs index 9cc72b4e0..a20655442 100644 --- a/test/IsolatedTestHost/Program.cs +++ b/test/IsolatedTestHost/Program.cs @@ -52,8 +52,7 @@ private static ExitCode MyMain(string assemblyFile, string testClassName, string } bool fact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "FactAttribute"); - bool skippableFact = testMethod.GetCustomAttributesData().Any(a => a.AttributeType.Name == "SkippableFactAttribute"); - if (fact || skippableFact) + if (fact) { return ExecuteTest(testClass, testMethod); } diff --git a/test/IsolatedTestHost/TestOutputHelper.cs b/test/IsolatedTestHost/TestOutputHelper.cs index b27c20f25..f91502ede 100644 --- a/test/IsolatedTestHost/TestOutputHelper.cs +++ b/test/IsolatedTestHost/TestOutputHelper.cs @@ -1,20 +1,23 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System; -using Xunit.Abstractions; +using System.Globalization; +using System.Text; +using Xunit; namespace IsolatedTestHost; internal class TestOutputHelper : ITestOutputHelper { - public void WriteLine(string message) - { - Console.WriteLine(message); - } - - public void WriteLine(string format, params object[] args) - { - Console.WriteLine(format, args); - } + private readonly StringBuilder builder = new(); + + public string Output => this.builder.ToString(); + + public void Write(string message) => this.builder.Append(message); + + public void Write(string format, params object[] args) => this.builder.AppendFormat(format, args); + + public void WriteLine(string message) => this.builder.AppendLine(message); + + public void WriteLine(string format, params object[] args) => this.builder.AppendLine(string.Format(CultureInfo.CurrentCulture, format, args)); } From c9c1f37cca969adac2e17550212faa356e03f86d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 10:49:16 -0700 Subject: [PATCH 1533/1753] Improve test stability (JoinAsyncShouldCompleteWithoutUIThreadAfterCancellation) --- .../Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs index 09013f9f0..7264640fc 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTests.cs @@ -3762,7 +3762,7 @@ public void JoinAsyncShouldCompleteWithoutUIThreadAfterCancellation() // We expect to be able to block on the UI thread and the Task complete. // In completing, it will throw a TaskCanceledException, wrapped by an // AggregateException. If it 'hangs', it will timeout, returning false. - Assert.Throws(() => joinTask.Wait(AsyncDelay)); + Assert.Throws(() => joinTask.Wait(UnexpectedTimeout)); } [Fact] From d29bfbe309d0cc772dec94c2ea80f3f146f63671 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 11:11:03 -0700 Subject: [PATCH 1534/1753] Extend test timeout We have a test failing in 8 seconds when the timeout was set to 10. Trying 15 in an effort to give the tests enough time. --- test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs index dd0422e78..d3a837504 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs @@ -20,7 +20,7 @@ public abstract class TestBase /// The maximum length of time to wait for something that we expect will happen /// within the timeout. /// - protected static readonly TimeSpan UnexpectedTimeout = Debugger.IsAttached ? Timeout.InfiniteTimeSpan : TimeSpan.FromSeconds(10); + protected static readonly TimeSpan UnexpectedTimeout = Debugger.IsAttached ? Timeout.InfiniteTimeSpan : TimeSpan.FromSeconds(15); /// /// The maximum length of time to wait for something that we do not expect will happen From f7daee0eb20ad14dfe2c5a424b883969c7992ae9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Dec 2025 11:59:22 -0700 Subject: [PATCH 1535/1753] Fix MTP test run error --- ...osoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj | 1 + 1 file changed, 1 insertion(+) diff --git a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj index 849497670..6029916ee 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj +++ b/test/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher/Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.csproj @@ -2,6 +2,7 @@ net472 Exe + false From 25c8c0d68756fd07ce81881576b8ca39f4ee5eb1 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 04:37:41 +0000 Subject: [PATCH 1536/1753] Update becheran/mlc action to v1.1.0 (461) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b3aa05bc4..f0ee2d3b2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -77,6 +77,6 @@ jobs: steps: - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 + uses: becheran/mlc@6fa3bddc1a921454b7840df30b343f6415bc8d35 # v1.1.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ From 6dc696587963b28140ecaa5d01dcd19317ce8715 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 12 Dec 2025 17:44:17 -0700 Subject: [PATCH 1537/1753] Update GitHub Artifact Actions (462) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/actions/publish-artifacts/action.yaml | 14 +++++++------- .github/workflows/release.yml | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 3b267f3e7..e0246825d 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -14,46 +14,46 @@ runs: - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a4e4745a1..51b11386d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,7 +57,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6 + uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From 36de3c86ac63043a3d9c6fd78c8be6c34e91cfbd Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 13 Dec 2025 19:35:04 -0700 Subject: [PATCH 1538/1753] Update becheran/mlc action to v1.2.0 (463) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f0ee2d3b2..271ba21c8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -77,6 +77,6 @@ jobs: steps: - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@6fa3bddc1a921454b7840df30b343f6415bc8d35 # v1.1.0 + uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ From f84612f111b59f6aa106b43264dc8d850b8056b7 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 06:30:56 +0000 Subject: [PATCH 1539/1753] Merge pull request #1514 from microsoft/renovate/microsoft.windows.cswin32-0.x Update dependency Microsoft.Windows.CsWin32 to 0.3.259 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2cf97ec8a..248de2a8b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From 6b1ad3c0d9f095ade0751cd7c66406f079dfd4bc Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 20 Dec 2025 16:13:45 -0700 Subject: [PATCH 1540/1753] Preserve exit codes better and organize switches --- tools/dotnet-test-cloud.ps1 | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index b5504801e..61e848ad4 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -51,26 +51,36 @@ $testLogs = Join-Path $ArtifactStagingFolder test_logs $globalJson = Get-Content $PSScriptRoot/../global.json | ConvertFrom-Json $isMTP = $globalJson.test.runner -eq 'Microsoft.Testing.Platform' $extraArgs = @() +$failedTests = 0 if ($isMTP) { if ($OnCI) { $extraArgs += '--no-progress' } + + $dumpSwitches = @( + ,'--hangdump' + ,'--hangdump-timeout','120s' + ,'--crashdump' + ) + $mtpArgs = @( + ,'--coverage' + ,'--coverage-output-format','cobertura' + ,'--diagnostic' + ,'--diagnostic-output-directory',$testLogs + ,'--diagnostic-verbosity','Information' + ,'--results-directory',$testLogs + ,'--report-trx' + ) + & $dotnet test --solution $RepoRoot ` --no-build ` -c $Configuration ` -bl:"$testBinLog" ` --filter-not-trait 'TestCategory=FailsInCloudTest' ` - --coverage ` - --coverage-output-format cobertura ` --coverage-settings "$PSScriptRoot/test.runsettings" ` - --hangdump ` - --hangdump-timeout 60s ` - --crashdump ` - --diagnostic ` - --diagnostic-output-directory $testLogs ` - --diagnostic-verbosity Information ` - --results-directory $testLogs ` - --report-trx ` + @mtpArgs ` + @dumpSwitches ` @extraArgs + if ($LASTEXITCODE -ne 0) { $failedTests += 1 } $trxFiles = Get-ChildItem -Recurse -Path $testLogs\*.trx } else { @@ -87,6 +97,7 @@ if ($isMTP) { --diag "$testDiagLog;TraceLevel=info" ` --logger trx ` @extraArgs + if ($LASTEXITCODE -ne 0) { $failedTests += 1 } $trxFiles = Get-ChildItem -Recurse -Path $RepoRoot\test\*.trx } @@ -119,3 +130,7 @@ $trxFiles |% { Write-Host "##vso[results.publish type=VSTest;runTitle=$runTitle;publishRunAttachments=true;resultFiles=$_;failTaskOnFailedTests=true;testRunSystem=VSTS - PTR;]" } } + +if ($failedTests -ne 0) { + exit $failedTests +} From 86545b60b33ededd96206464cf83764a2049746e Mon Sep 17 00:00:00 2001 From: Charles Gagnon Date: Sat, 27 Dec 2025 16:06:07 -0800 Subject: [PATCH 1541/1753] Skip native binary PDB conversion Add check to skip conversion for native binary PDBs. --- tools/Prepare-Legacy-Symbols.ps1 | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/tools/Prepare-Legacy-Symbols.ps1 b/tools/Prepare-Legacy-Symbols.ps1 index ae0bc40cb..e566d6241 100644 --- a/tools/Prepare-Legacy-Symbols.ps1 +++ b/tools/Prepare-Legacy-Symbols.ps1 @@ -20,6 +20,20 @@ Get-ChildItem "$ArtifactStagingFolder\*.pdb" -Recurse |% { } if ($BinaryImagePath) { + # Native binaries can't have their PDBs converted to legacy (Windows) format so just skip them + try { + $assembly = [System.Reflection.AssemblyName]::GetAssemblyName($BinaryImagePath) + $isManaged = $true + } + catch { + $isManaged = $false + } + + if (-not $isManaged) { + Write-Host "Skipping native binary PDB: $_" -ForegroundColor DarkYellow + return + } + # Convert the PDB to legacy Windows PDBs Write-Host "Converting PDB for $_" -ForegroundColor DarkGray $WindowsPdbDir = "$($_.Directory.FullName)\$WindowsPdbSubDirName" From 57248c719e5b18109e646ffd2145111b6163a824 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 4 Jan 2026 18:55:23 -0700 Subject: [PATCH 1542/1753] Fix case sensitivity in dotnet-test-cloud --- tools/dotnet-test-cloud.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 61e848ad4..5d204819d 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -105,7 +105,7 @@ if ($isMTP) { $unknownCounter = 0 $trxFiles |% { New-Item $testLogs -ItemType Directory -Force | Out-Null - if (!($_.FullName.StartsWith($testLogs))) { + if (!($_.FullName.StartsWith($testLogs, [StringComparison]::OrdinalIgnoreCase))) { Copy-Item $_ -Destination $testLogs } From a385e050ade017e3cbbdebc6cc5f390c9efbe7b8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Jan 2026 07:10:03 -0700 Subject: [PATCH 1543/1753] Bump code coverage package/tool --- .config/dotnet-tools.json | 4 ++-- Directory.Packages.props | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9f9de05c4..697924211 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.1.0", + "version": "18.3.1", "commands": [ "dotnet-coverage" ], @@ -38,4 +38,4 @@ "rollForward": false } } -} \ No newline at end of file +} diff --git a/Directory.Packages.props b/Directory.Packages.props index 098c7f090..d05043221 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 961b025b79a2e0cf39e6976ec74d73aa6ef35388 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 5 Jan 2026 07:46:58 -0700 Subject: [PATCH 1544/1753] Update becheran/mlc action to v1.2.0 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 1b6565df3..139a27f45 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -17,7 +17,7 @@ jobs: with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0 + uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 with: args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://msrc.microsoft.com/*,https://www.microsoft.com/msrc*,https://microsoft.com/msrc*,https://www.npmjs.com/package/*,https://get.dot.net/ - name: ⚙ Install prerequisites From c7b72fb02f540fa930e66e57f642b3c511610ca7 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 9 Jan 2026 13:45:29 +0000 Subject: [PATCH 1545/1753] Update dependency Microsoft.Testing.Extensions.CodeCoverage to 18.3.2 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d05043221..152a20753 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 9870d10a151a2c6747d7c43178a36d81509fda3b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 11 Jan 2026 17:20:11 -0700 Subject: [PATCH 1546/1753] Update dependency dotnet-coverage to v18.3.2 (465) --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 697924211..31856cb40 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.3.1", + "version": "18.3.2", "commands": [ "dotnet-coverage" ], From c35e57fd2576d8e51b6745f4bd713161e5599751 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Jan 2026 05:59:21 -0700 Subject: [PATCH 1547/1753] Merge pull request 469 from AArnott/copilot/port-change-to-library-template Add MTP v2/xunit v3 test commands to copilot instructions --- .github/copilot-instructions.md | 63 +++++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 085935029..bb31332b3 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -12,9 +12,68 @@ ## Testing +**IMPORTANT**: This repository uses Microsoft.Testing.Platform (MTP v2) with xunit v3. Traditional `--filter` syntax does NOT work. Use the options below instead. + * There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Test` suffix. -* Tests should use the Xunit testing framework. -* Some tests are known to be unstable. When running tests, you should skip the unstable ones by running `dotnet test --filter "TestCategory!=FailsInCloudTest"`. +* Tests use xunit v3 with Microsoft.Testing.Platform (MTP v2). Traditional VSTest `--filter` syntax does NOT work. +* Some tests are known to be unstable. When running tests, you should skip the unstable ones by using `-- --filter-not-trait "FailsInCloudTest=true"`. + +### Running Tests + +**Run all tests**: +```bash +dotnet test --no-build -c Release +``` + +**Run tests for a specific test project**: +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release +``` + +**Run a single test method**: +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-method ClassName.MethodName +``` + +**Run all tests in a test class**: +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-class ClassName +``` + +**Run tests with wildcard matching** (supports wildcards at beginning and/or end): +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-method "*Pattern*" +``` + +**Run tests with a specific trait** (equivalent to category filtering): +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-trait "TraitName=value" +``` + +**Exclude tests with a specific trait** (skip unstable tests): +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-not-trait "FailsInCloudTest=true" +``` + +**Run tests for a specific framework only**: +```bash +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release --framework net9.0 +``` + +**List all available tests without running them**: +```bash +cd test/Library.Tests +dotnet run --no-build -c Release --framework net9.0 -- --list-tests +``` + +**Key points about test filtering with MTP v2 / xunit v3**: +- Options after `--` are passed to the test runner, not to `dotnet test` +- Use `--filter-method`, `--filter-class`, `--filter-namespace` for simple filtering +- Use `--filter-trait` and `--filter-not-trait` for trait-based filtering (replaces `--filter "TestCategory=..."`) +- Traditional VSTest `--filter` expressions do NOT work +- Wildcards `*` are supported at the beginning and/or end of filter values +- Multiple simple filters of the same type use OR logic, different types combine with AND +- See `--help` for query filter language for advanced scenarios ## Coding style From 169c608ea1b989523b8907b1abef29746e3c1423 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 12 Jan 2026 06:19:24 -0700 Subject: [PATCH 1548/1753] Fix copilot instructions regarding test project suffix --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index bb31332b3..2aeca2ad8 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -14,7 +14,7 @@ **IMPORTANT**: This repository uses Microsoft.Testing.Platform (MTP v2) with xunit v3. Traditional `--filter` syntax does NOT work. Use the options below instead. -* There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Test` suffix. +* There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Tests` suffix. * Tests use xunit v3 with Microsoft.Testing.Platform (MTP v2). Traditional VSTest `--filter` syntax does NOT work. * Some tests are known to be unstable. When running tests, you should skip the unstable ones by using `-- --filter-not-trait "FailsInCloudTest=true"`. From e989a4c3670c71a2b1213bdd92583b6a062ad531 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 14 Jan 2026 15:44:13 +0000 Subject: [PATCH 1549/1753] Update .NET SDK to v10.0.102 (471) * Update mcr.microsoft.com/dotnet/sdk Docker tag to v10.0.102 * Bump .NET SDK to 10.0.102 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 64f23a9eb..10fb39598 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.101@sha256:d1823fecac3689a2eb959e02ee3bfe1c2142392808240039097ad70644566190 +FROM mcr.microsoft.com/dotnet/sdk:10.0.102@sha256:25d14b400b75fa4e89d5bd4487a92a604a4e409ab65becb91821e7dc4ac7f81f # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index a0ec2d8d9..d8d718ada 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.101", + "version": "10.0.102", "rollForward": "patch", "allowPrerelease": false }, From 901b22d472d6b424fd00409cba2675d42056beaf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 16 Jan 2026 15:59:45 -0700 Subject: [PATCH 1550/1753] Fix FailsInCloudTest filter after MTPv2 migration --- tools/dotnet-test-cloud.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 5d204819d..608214cb5 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -75,7 +75,7 @@ if ($isMTP) { --no-build ` -c $Configuration ` -bl:"$testBinLog" ` - --filter-not-trait 'TestCategory=FailsInCloudTest' ` + --filter-not-trait 'FailsInCloudTest=true' ` --coverage-settings "$PSScriptRoot/test.runsettings" ` @mtpArgs ` @dumpSwitches ` From 918803f7be2cc07bc5e22b0882772e6ca98162b3 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 24 Jan 2026 11:30:03 -0700 Subject: [PATCH 1551/1753] Update dependency xunit.v3.mtp-v2 to 3.2.2 (472) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 152a20753..d245de181 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -14,7 +14,7 @@ - + From 689415e156abff6d39d5b9b93c8eed9cf2113b26 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 24 Jan 2026 18:32:42 +0000 Subject: [PATCH 1552/1753] Update actions/checkout action to v6.0.2 (#473) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 271ba21c8..26bc9eb48 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,7 +28,7 @@ jobs: - windows-2025 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -75,7 +75,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index ebd538812..3c032fae7 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b1ba5680c..53af0a052 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 0b111a609..62a6417df 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 8b62459f6fd69fd56f8fac849d111fd30e539d04 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 3 Feb 2026 13:13:47 -0700 Subject: [PATCH 1553/1753] Update Microsoft Testing Platform (475) --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d245de181..73d0d36e6 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,13 +4,13 @@ true true - 2.0.2 + 2.1.0 - + From 11e9554fe3fc76785f8b1ca8f6e5c54cb64b631f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 3 Feb 2026 13:14:45 -0700 Subject: [PATCH 1554/1753] Update dependency dotnet-coverage to v18.4.1 (474) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 31856cb40..1418b915a 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.3.2", + "version": "18.4.1", "commands": [ "dotnet-coverage" ], From d10df4bfb0c47a50100348849044b7899d3c70f8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 4 Feb 2026 22:05:06 -0700 Subject: [PATCH 1555/1753] Update mcr.microsoft.com/dotnet/sdk:10.0.102 Docker digest to 6ba533c (476) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 10fb39598..50883c32b 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.102@sha256:25d14b400b75fa4e89d5bd4487a92a604a4e409ab65becb91821e7dc4ac7f81f +FROM mcr.microsoft.com/dotnet/sdk:10.0.102@sha256:6ba533cc61a5d8c5e7d4b3a3e33e2ddc2efef200b112e4d658303516bfd24255 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From c8b42f289002cf02b2bd1e3bb3ce312410afceef Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 8 Feb 2026 21:48:29 -0700 Subject: [PATCH 1556/1753] Add Copilot prompt to automate Library.Template updates This prompt file is intended for use in repos that use this template -- not for this template to use within its own repo directly. --- .github/prompts/template-release-notes.md | 4 ++ .../prompts/update-library-template.prompt.md | 58 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 .github/prompts/template-release-notes.md create mode 100644 .github/prompts/update-library-template.prompt.md diff --git a/.github/prompts/template-release-notes.md b/.github/prompts/template-release-notes.md new file mode 100644 index 000000000..eb268812a --- /dev/null +++ b/.github/prompts/template-release-notes.md @@ -0,0 +1,4 @@ +# Template release notes + +This file will describe significant changes in Library.Template as they are introduced, especially if they require special consideration when merging updates into existing repos. +This file is referenced by update-library-template.prompt.md and should remain in place to facilitate future merges, whether done manually or by AI. diff --git a/.github/prompts/update-library-template.prompt.md b/.github/prompts/update-library-template.prompt.md new file mode 100644 index 000000000..a044007c1 --- /dev/null +++ b/.github/prompts/update-library-template.prompt.md @@ -0,0 +1,58 @@ +--- +description: Merges the latest Library.Template into this repo (at position of HEAD) and resolves conflicts. +--- + +# Instructions + +1. Run `tools\MergeFrom-Template.ps1` +2. Resolve merge conflicts, taking into account conflict resolution policy below. +3. Validate the changes, as described in the validation section below. +4. Commiting your changes (if applicable). + +## Conflict resolution policy + +There may be special notes in `.github/prompts/template-release-notes.md` that describe special considerations for certain files or scenarios to help you resolve conflicts appropriately. +Always refer to that file before proceeding. +In particular, focus on the *incoming* part of the file, since it represents the changes from the Library.Template that you are merging into your repo. + +Also consider that some repos choose to reject certain Library.Template patterns. +For example the template uses MTPv2 for test projects, but a repo might have chosen not to adopt that. +When resolving merge conflicts, consider whether it looks like the relevant code file is older than it should be given the changes the template is bringing in. +Ask the user when in doubt as to whether the conflict should be resolved in favor of 'catching up' with the template or keeping the current changes. + +### Keep Current files + +Conflicts in the following files should always be resolved by keeping the current version (i.e. discard incoming changes): + +* README.md + +### Deleted files + +Very typically, when the incoming change is to a file that was deleted locally, the correct resolution is to re-delete the file. + +In some cases however, the deleted file may have incoming changes that should be applied to other files. +The `test\Library.Tests\Library.Tests.csproj` file is very typical of this. +Changes to this file should very typically be applied to any and all test projects in the repo. +You are responsible for doing this in addition to re-deleting this template file. + +## Validation + +Validate the merge result (after resolving any conflicts, if applicable). +Use #runSubagent for each step. + +1. Verify that `dotnet restore` succeeds. Fix any issues that come up. +2. Verify that `dotnet build` succeeds. +3. Verify that tests succeed by running `tools\dotnet-test-cloud.ps1`. + +While these validations are described using `dotnet` CLI commands, some repos require using full msbuild.exe. +You can detect this by checking the `azure-pipelines/dotnet.yml` or `.github/workflows/build.yml` files for use of one or the other tool. + +## Committing your changes + +If you have to make any changes for validations to pass, consider whether they qualify as a bad merge conflict resolution or more of a novel change that you're making to work with the Library.Template update. +Merge conflict resolution fixes ideally get amended into the merge commit, while novel changes would go into a novel commit after the merge commit. + +Always author your commits using `git commit --author "🤖 Copilot "` (and possibly other parameters). +Describe the nature of the merge conflicts you encountered and how you resolved them in your commit message. + +Later, if asked to review pull request validation breaks, always author a fresh commit with each fix that you push, unless the user directs you to do otherwise. From 98ba7d5b41df191ad03f0afd52e0a75a9cac11c8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 9 Feb 2026 13:36:11 -0700 Subject: [PATCH 1557/1753] Fix test filter --- .github/copilot-instructions.md | 2 +- tools/dotnet-test-cloud.ps1 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 2aeca2ad8..deb29535e 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -52,7 +52,7 @@ dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Rele **Exclude tests with a specific trait** (skip unstable tests): ```bash -dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-not-trait "FailsInCloudTest=true" +dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-not-trait "TestCategory=FailsInCloudTest" ``` **Run tests for a specific framework only**: diff --git a/tools/dotnet-test-cloud.ps1 b/tools/dotnet-test-cloud.ps1 index 608214cb5..5d204819d 100644 --- a/tools/dotnet-test-cloud.ps1 +++ b/tools/dotnet-test-cloud.ps1 @@ -75,7 +75,7 @@ if ($isMTP) { --no-build ` -c $Configuration ` -bl:"$testBinLog" ` - --filter-not-trait 'FailsInCloudTest=true' ` + --filter-not-trait 'TestCategory=FailsInCloudTest' ` --coverage-settings "$PSScriptRoot/test.runsettings" ` @mtpArgs ` @dumpSwitches ` From 1632266376df028c8e44fdbc7e65fb49c184edfe Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 9 Feb 2026 14:12:38 -0700 Subject: [PATCH 1558/1753] Update actions/checkout action to v6.0.2 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 139a27f45..fa08fdb0c 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) From 0ba6e41f485ae7ba92ddfaf82a81e2dd1ecea740 Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Mon, 9 Feb 2026 16:27:06 -0800 Subject: [PATCH 1559/1753] Join tasks waited by JoinableTaskCollection.JoinUntilEmpty in dumpasync result (#1538) * Handle JoinUntilEmpty in dumpasync Join to the task it waits on. * Fix missing thread blocking state * Remove unused value. * Adjust logic based on Copilot feedbacks. --------- Co-authored-by: Lifeng Lu --- src/SosThreadingTools/DumpAsyncCommand.cs | 102 +++++++++++++++++----- 1 file changed, 79 insertions(+), 23 deletions(-) diff --git a/src/SosThreadingTools/DumpAsyncCommand.cs b/src/SosThreadingTools/DumpAsyncCommand.cs index de3686f8d..88c73a216 100644 --- a/src/SosThreadingTools/DumpAsyncCommand.cs +++ b/src/SosThreadingTools/DumpAsyncCommand.cs @@ -164,6 +164,12 @@ private static void GetAllStateMachines(ClrHeap heap, List al } } } + + ClrObject currentObject = stateMachine.TryGetObjectField("<>4__this"); + if (!currentObject.IsNull && currentObject.Type is not null && string.Equals(currentObject.Type.Name, "Microsoft.VisualStudio.Threading.JoinableTaskCollection", StringComparison.Ordinal)) + { + asyncState.WaitingJoinableTasks = GetJoinableTasksFromCollection(currentObject); + } } } #pragma warning disable CA1031 // Do not catch general exception types @@ -183,6 +189,44 @@ private static void GetAllStateMachines(ClrHeap heap, List al } } + private static List GetJoinableTasksFromCollection(ClrObject joinableTaskCollection) + { + var joinableTasks = new List(); + ClrValueType? dependentData = joinableTaskCollection.TryGetValueClassField("dependentData"); + if (dependentData is not null) + { + ClrObject childDependentNodes = dependentData.TryGetObjectField("childDependentNodes"); + if (!childDependentNodes.IsNull && + childDependentNodes.TryReadField("count", out int count) && + childDependentNodes.TryReadField("freeCount", out int freeCount)) + { + count -= freeCount; + if (count > 0) + { + ClrObject entries = childDependentNodes.TryGetObjectField("entries"); + if (!entries.IsNull && entries.IsArray && entries.AsArray() is ClrArray entriesArray) + { + for (int i = 0; i < entriesArray.Length; i++) + { + ClrValueType? value = entriesArray.GetStructValue(i); + ClrObject key = value.TryGetObjectField("key"); + if (!key.IsNull) + { + joinableTasks.Add(key); + if (--count == 0) + { + break; + } + } + } + } + } + } + } + + return joinableTasks; + } + private static void ChainStateMachinesBasedOnTaskContinuations(Dictionary knownStateMachines) { foreach (AsyncStateMachine? stateMachine in knownStateMachines.Values) @@ -285,16 +329,13 @@ private static void ChainStateMachinesBasedOnJointableTasks(List4__this"); - ClrObject wrappedTask = joinableTask.TryGetObjectField("wrappedTask"); - if (!wrappedTask.IsNull) + FindWaitingTaskFromJoinableTask(joinableTask, stateMachine); + + if (stateMachine.WaitingJoinableTasks is List joinableTasks) { - AsyncStateMachine? previousStateMachine = allStateMachines - .FirstOrDefault(s => s.Task.Address == wrappedTask.Address); - if (previousStateMachine is object && stateMachine != previousStateMachine) + foreach (ClrObject waitingJoinableTask in joinableTasks) { - stateMachine.Previous = previousStateMachine; - previousStateMachine.Next = stateMachine; - previousStateMachine.DependentCount++; + FindWaitingTaskFromJoinableTask(waitingJoinableTask, stateMachine); } } } @@ -306,6 +347,30 @@ private static void ChainStateMachinesBasedOnJointableTasks(List s.Task.Address == wrappedTask.Address); + if (previousStateMachine is object && currentStateMachine != previousStateMachine) + { + if (currentStateMachine.Previous is null) + { + currentStateMachine.Previous = previousStateMachine; + previousStateMachine.Next = currentStateMachine; + } + else + { + previousStateMachine.Next ??= currentStateMachine; + } + + previousStateMachine.DependentCount++; + } + } + } } private static void MarkUIThreadDependingTasks(List allStateMachines) @@ -388,7 +453,7 @@ private void MarkThreadingBlockTasks(ClrHeap heap, List allSt } } - break; + continue; } } } @@ -436,12 +501,9 @@ private void PrintOutStateMachines(List allStateMachines) .OrderByDescending(m => m.Depth) .ThenByDescending(m => m.SwitchToMainThreadTask.Address)) { - bool multipleLineBlock = this.PrintAsyncStateMachineChain(node, printedMachines); + this.PrintAsyncStateMachineChain(node, printedMachines); - if (multipleLineBlock) - { - Console.WriteLine(string.Empty); - } + Console.WriteLine(string.Empty); } // Print nodes which we didn't print because of loops. @@ -459,10 +521,9 @@ private void PrintOutStateMachines(List allStateMachines) } } - private bool PrintAsyncStateMachineChain(AsyncStateMachine node, HashSet printedMachines) + private void PrintAsyncStateMachineChain(AsyncStateMachine node, HashSet printedMachines) { int nLevel = 0; - bool multipleLineBlock = false; var loopDetection = new HashSet(); for (AsyncStateMachine? p = node; p is object; p = p.Next) @@ -472,7 +533,6 @@ private bool PrintAsyncStateMachineChain(AsyncStateMachine node, HashSet 0) { this.WriteString(".."); - multipleLineBlock = true; } else if (p.AlterPrevious is object) { @@ -481,14 +541,12 @@ private bool PrintAsyncStateMachineChain(AsyncStateMachine node, HashSet allStateMachines) @@ -573,6 +627,8 @@ public AsyncStateMachine(int state, ClrObject stateMachine, ClrObject task) public AsyncStateMachine? AlterPrevious { get; set; } + public List? WaitingJoinableTasks { get; set; } + public ulong CodeAddress { get; set; } public override string ToString() From 8f317e65a1f3180d4efa4ebbd5aed7f53206394c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 10 Feb 2026 16:01:19 -0700 Subject: [PATCH 1560/1753] Improve library.template merge AI prompt --- .github/prompts/template-release-notes.md | 8 ++++++++ .github/prompts/update-library-template.prompt.md | 7 +++++++ 2 files changed, 15 insertions(+) diff --git a/.github/prompts/template-release-notes.md b/.github/prompts/template-release-notes.md index eb268812a..0e5e2d8a4 100644 --- a/.github/prompts/template-release-notes.md +++ b/.github/prompts/template-release-notes.md @@ -2,3 +2,11 @@ This file will describe significant changes in Library.Template as they are introduced, especially if they require special consideration when merging updates into existing repos. This file is referenced by update-library-template.prompt.md and should remain in place to facilitate future merges, whether done manually or by AI. + +## Solution rename + +Never leave a Library.slnx file in the repository. +You might even see one there even though this particular merge didn't bring it in. +This can be an artifact of having renamed Library.sln to Library.slnx in the template repo, but ultimately the receiving repo should have only one .sln or .slnx file, with a better name than `Library`. +If you can confidently do so, go ahead and migrate their `.sln` to an `.slnx` with their original name. +If you can't, just delete `Library.slnx` anyway. diff --git a/.github/prompts/update-library-template.prompt.md b/.github/prompts/update-library-template.prompt.md index a044007c1..cfabcb380 100644 --- a/.github/prompts/update-library-template.prompt.md +++ b/.github/prompts/update-library-template.prompt.md @@ -20,6 +20,8 @@ For example the template uses MTPv2 for test projects, but a repo might have cho When resolving merge conflicts, consider whether it looks like the relevant code file is older than it should be given the changes the template is bringing in. Ask the user when in doubt as to whether the conflict should be resolved in favor of 'catching up' with the template or keeping the current changes. +Use #runSubagent to analyze and resolve merge conflicts across files in parallel. + ### Keep Current files Conflicts in the following files should always be resolved by keeping the current version (i.e. discard incoming changes): @@ -47,6 +49,11 @@ Use #runSubagent for each step. While these validations are described using `dotnet` CLI commands, some repos require using full msbuild.exe. You can detect this by checking the `azure-pipelines/dotnet.yml` or `.github/workflows/build.yml` files for use of one or the other tool. +You are *not* responsible for fixing issues that the merge did not cause. +If validation fails for reasons that seem unrelated to the changes brought in by the merge, advise the user and ask how they'd like you to proceed. +That said, sometimes merges will bring in SDK or dependency updates that can cause breaks in seemingly unrelated areas. +In such cases, you should investigate and solve the issues as needed. + ## Committing your changes If you have to make any changes for validations to pass, consider whether they qualify as a bad merge conflict resolution or more of a novel change that you're making to work with the Library.Template update. From ca9f8e977e1a9cafc986fb14974953e6f9a0ee57 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 11 Feb 2026 00:16:24 +0000 Subject: [PATCH 1561/1753] Update Dockerfile and global.json updates to v10.0.103 (477) * Update mcr.microsoft.com/dotnet/sdk Docker tag to v10.0.103 * Bump global.json as well --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 50883c32b..95ac1b594 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.102@sha256:6ba533cc61a5d8c5e7d4b3a3e33e2ddc2efef200b112e4d658303516bfd24255 +FROM mcr.microsoft.com/dotnet/sdk:10.0.103@sha256:89e985253248c1211e8440b82db775fd3d3c73c915ceb96766495bce050d385f # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index d8d718ada..bdc382f30 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.102", + "version": "10.0.103", "rollForward": "patch", "allowPrerelease": false }, From 467ef6db1e8babe19b4f5e044574479bd2404af2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 11 Feb 2026 08:20:40 -0700 Subject: [PATCH 1562/1753] Explain how to migrate sln to slnx --- .github/prompts/template-release-notes.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/prompts/template-release-notes.md b/.github/prompts/template-release-notes.md index 0e5e2d8a4..975da315e 100644 --- a/.github/prompts/template-release-notes.md +++ b/.github/prompts/template-release-notes.md @@ -8,5 +8,13 @@ This file is referenced by update-library-template.prompt.md and should remain i Never leave a Library.slnx file in the repository. You might even see one there even though this particular merge didn't bring it in. This can be an artifact of having renamed Library.sln to Library.slnx in the template repo, but ultimately the receiving repo should have only one .sln or .slnx file, with a better name than `Library`. -If you can confidently do so, go ahead and migrate their `.sln` to an `.slnx` with their original name. -If you can't, just delete `Library.slnx` anyway. +Delete any `Library.slnx` that you see. +Migrate an `.sln` in the repo root to `.slnx` using this command: + +```ps1 +dotnet solution EXISTING.sln migrate +``` + +This will create an EXISTING.slnx file. `git add` that file, then `git rm` the old `.sln` file. +Sometimes a repo will reference the sln filename in a script or doc somewhere. +Search the repo for such references and update them to the slnx file. From 04993f61ce55d17ee7c7f1b1ef9c9391fb4b9f7d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 11 Feb 2026 10:30:11 -0700 Subject: [PATCH 1563/1753] Update mcr.microsoft.com/dotnet/sdk:10.0.103 Docker digest to 0a506ab (478) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 95ac1b594..3df45f85a 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.103@sha256:89e985253248c1211e8440b82db775fd3d3c73c915ceb96766495bce050d385f +FROM mcr.microsoft.com/dotnet/sdk:10.0.103@sha256:0a506ab0c8aa077361af42f82569d364ab1b8741e967955d883e3f23683d473a # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 54a80db48a9062c4f81676ffbc7c807f6bae8417 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 12 Feb 2026 12:49:50 -0700 Subject: [PATCH 1564/1753] Update dependency nerdbank.dotnetrepotools to v1.1.1 (479) --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 1418b915a..c22a2eb07 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.0.92", + "version": "1.1.1", "commands": [ "repo" ], From 41493c6aba7c6b1e9018cbf0f22f0a8cb32d47d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Feb 2026 11:08:54 -0700 Subject: [PATCH 1565/1753] Use forward slash in md files --- .github/prompts/update-library-template.prompt.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/prompts/update-library-template.prompt.md b/.github/prompts/update-library-template.prompt.md index cfabcb380..fae1a1e68 100644 --- a/.github/prompts/update-library-template.prompt.md +++ b/.github/prompts/update-library-template.prompt.md @@ -44,7 +44,7 @@ Use #runSubagent for each step. 1. Verify that `dotnet restore` succeeds. Fix any issues that come up. 2. Verify that `dotnet build` succeeds. -3. Verify that tests succeed by running `tools\dotnet-test-cloud.ps1`. +3. Verify that tests succeed by running `tools/dotnet-test-cloud.ps1`. While these validations are described using `dotnet` CLI commands, some repos require using full msbuild.exe. You can detect this by checking the `azure-pipelines/dotnet.yml` or `.github/workflows/build.yml` files for use of one or the other tool. From 6dfee58e27e2c3aa037d9893dba85377b58d8ac2 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 17 Feb 2026 13:02:39 -0700 Subject: [PATCH 1566/1753] Touch-up custom prompt --- .github/prompts/update-library-template.prompt.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/prompts/update-library-template.prompt.md b/.github/prompts/update-library-template.prompt.md index fae1a1e68..f9fe67209 100644 --- a/.github/prompts/update-library-template.prompt.md +++ b/.github/prompts/update-library-template.prompt.md @@ -4,10 +4,10 @@ description: Merges the latest Library.Template into this repo (at position of H # Instructions -1. Run `tools\MergeFrom-Template.ps1` +1. Run `tools/MergeFrom-Template.ps1` 2. Resolve merge conflicts, taking into account conflict resolution policy below. 3. Validate the changes, as described in the validation section below. -4. Commiting your changes (if applicable). +4. Committing your changes (if applicable). ## Conflict resolution policy @@ -33,7 +33,7 @@ Conflicts in the following files should always be resolved by keeping the curren Very typically, when the incoming change is to a file that was deleted locally, the correct resolution is to re-delete the file. In some cases however, the deleted file may have incoming changes that should be applied to other files. -The `test\Library.Tests\Library.Tests.csproj` file is very typical of this. +The `test/Library.Tests/Library.Tests.csproj` file is very typical of this. Changes to this file should very typically be applied to any and all test projects in the repo. You are responsible for doing this in addition to re-deleting this template file. From 4d1026d5b7304a392707163f257c5f9af981ef0e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 18 Feb 2026 16:02:56 -0700 Subject: [PATCH 1567/1753] Update network isolation policy --- azure-pipelines/archive-sourcecode.yml | 2 +- azure-pipelines/libtemplate-update.yml | 2 +- azure-pipelines/official.yml | 2 +- azure-pipelines/release.yml | 2 +- azure-pipelines/unofficial.yml | 2 +- azure-pipelines/vs-insertion.yml | 2 +- azure-pipelines/vs-validation.yml | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index ee349e5b0..84b70ec37 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -36,7 +36,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index a0421bd6a..6d0051a05 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -31,7 +31,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: name: AzurePipelines-EO diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 0956e8832..9f0a89d8e 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -46,7 +46,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable codeSignValidation: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 38e9a3bad..5824b0a74 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -21,7 +21,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 7daa9e6d2..47a2a2e29 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -56,7 +56,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index faeadd88a..22481c971 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -23,7 +23,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable sbom: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index d150fee64..f62373132 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -27,7 +27,7 @@ extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: settings: - networkIsolationPolicy: Permissive,CFSClean + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: From b6679f4f0a68352ca410cd57b5572a936d7880a0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 20 Feb 2026 11:43:10 -0700 Subject: [PATCH 1568/1753] Fix new analyzer warnings --- test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs b/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs index 0867a7998..279634de2 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AssertEx.cs @@ -10,7 +10,7 @@ public static void Equal(T expected, T actual, string message) { if (!EqualityComparer.Default.Equals(expected, actual)) { - throw Xunit.Sdk.EqualException.ForMismatchedValues(expected, actual, message); + throw Xunit.Sdk.EqualException.ForMismatchedValues(expected?.ToString() ?? string.Empty, actual?.ToString() ?? string.Empty, message); } } @@ -18,7 +18,7 @@ public static void Equal(T expected, T actual, string formattingMessage, para { if (!EqualityComparer.Default.Equals(expected, actual)) { - throw Xunit.Sdk.EqualException.ForMismatchedValues(expected, actual, string.Format(CultureInfo.CurrentCulture, formattingMessage, formattingArgs)); + throw Xunit.Sdk.EqualException.ForMismatchedValues(expected?.ToString() ?? string.Empty, actual?.ToString() ?? string.Empty, string.Format(CultureInfo.CurrentCulture, formattingMessage, formattingArgs)); } } From 91ac42f0937804b0b37191d78346f7d8125cca9b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 19:02:41 +0000 Subject: [PATCH 1569/1753] Merge pull request #1536 from microsoft/renovate/microsoft.windows.cswin32-0.x Update dependency Microsoft.Windows.CsWin32 to 0.3.269 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 248de2a8b..853c2710f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From 1456643773efa3f82c2f4b91fabe4774d9c08bff Mon Sep 17 00:00:00 2001 From: Abhitej John Date: Fri, 20 Feb 2026 11:10:26 -0800 Subject: [PATCH 1570/1753] Merge pull request #1533 from AbhitejJohn/patch-1 Fix link to documentation in VSTHRD111.md --- docfx/analyzers/VSTHRD111.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docfx/analyzers/VSTHRD111.md b/docfx/analyzers/VSTHRD111.md index 0495e84f0..aaa46ced5 100644 --- a/docfx/analyzers/VSTHRD111.md +++ b/docfx/analyzers/VSTHRD111.md @@ -2,7 +2,7 @@ Some code bases, particularly libraries with no affinity to an app's UI thread, are advised to use `.ConfigureAwait(false)` for each and every _await_ because it can avoid deadlocks after those calls start on an application's UI thread and the app later decides to synchronously block the UI thread waiting for those tasks to finish. Using `.ConfigureAwait(false)` also allows continuations to switch to a background thread even when no synchronous blocking would cause a deadlock, which makes for a more responsive application and possibly higher throughput of async operations. -Note that this scenario can also be solved using the `JoinableTaskFactory`, but many class libraries may not wish to depend on the application proffers an instance of that type to the library. Where JoinableTaskFactory _does_ apply, use of `.ConfigureAwait(false)` is _not_ recommended. See [this topic](https://github.com/Microsoft/vs-threading/blob/main/doc/cookbook_vs.md#should-i-await-a-task-with-configureawaitfalse) for more on when `.ConfigureAwait(false)` and `.ConfigureAwait(true)` are appropriate. +Note that this scenario can also be solved using the `JoinableTaskFactory`, but many class libraries may not wish to depend on the application proffers an instance of that type to the library. Where JoinableTaskFactory _does_ apply, use of `.ConfigureAwait(false)` is _not_ recommended. See [this topic](../docs/cookbook_vs.md#should-i-await-a-task-with-configureawaitfalse) for more on when `.ConfigureAwait(false)` and `.ConfigureAwait(true)` are appropriate. **This analyzer's diagnostics are *hidden* by default**. You should enable the rule for libraries that use to require this await suffix. From 541e7ed794709a77604bd2c22679e3f4a988dd27 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 19:42:22 +0000 Subject: [PATCH 1571/1753] Update CodefixTestingVersion to 1.1.3 (#1534) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d8e55ac11..70be4b476 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ 2.1.0 2.0.208 3.11.0 - 1.1.2 + 1.1.3 3.11.0-beta1.25076.3 From a4badce4e33c30e969112d7dae0a64f940404c04 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 13:06:26 -0800 Subject: [PATCH 1572/1753] Update dependency Microsoft.Bcl.AsyncInterfaces to v10 (#1543) * Update dependency Microsoft.Bcl.AsyncInterfaces to v10 * Fix package downgrade warnings --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- Directory.Packages.props | 6 +++--- test/IsolatedTestHost/App.config | 12 ------------ .../Helpers/ReferencesHelper.cs | 2 +- 3 files changed, 4 insertions(+), 16 deletions(-) delete mode 100644 test/IsolatedTestHost/App.config diff --git a/Directory.Packages.props b/Directory.Packages.props index 70be4b476..19e8ef579 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + @@ -33,8 +33,8 @@ - - + + diff --git a/test/IsolatedTestHost/App.config b/test/IsolatedTestHost/App.config deleted file mode 100644 index aed254391..000000000 --- a/test/IsolatedTestHost/App.config +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs index 50edf5917..8c440cafb 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs @@ -24,7 +24,7 @@ internal static class ReferencesHelper .WithNuGetConfigFilePath(NuGetConfigPath) .WithPackages(ImmutableArray.Create( new PackageIdentity("System.Collections.Immutable", "6.0.0"), - new PackageIdentity("System.Threading.Tasks.Extensions", "4.6.0"), + new PackageIdentity("System.Threading.Tasks.Extensions", "4.6.3"), new PackageIdentity("Microsoft.Bcl.AsyncInterfaces", "6.0.0"))); internal static readonly ImmutableArray VSSDKPackageReferences = ImmutableArray.Create(new string[] From 40cca616afc5722ccac7ade32242753b0aa54476 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 21:07:11 +0000 Subject: [PATCH 1573/1753] Update dotnet monorepo (major) (#1516) * Update dotnet monorepo * Fix package downgrade warning --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- Directory.Packages.props | 2 +- test/Directory.Packages.props | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 19e8ef579..d66848e24 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -14,7 +14,7 @@ - + diff --git a/test/Directory.Packages.props b/test/Directory.Packages.props index 6875d8235..e359b4cdb 100644 --- a/test/Directory.Packages.props +++ b/test/Directory.Packages.props @@ -3,12 +3,13 @@ - 4.13.0 + 5.0.0 + From aa2d6080298460cb2be4790f445ac596fc73fd42 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 21:30:19 +0000 Subject: [PATCH 1574/1753] Merge pull request #1542 from microsoft/renovate/net-packages Update dependency System.Memory to 4.6.3 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index d66848e24..a4db7cd64 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -32,7 +32,7 @@ - + From 5af463e6d7ecfa05a57d96944ec74e086055534d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 20 Feb 2026 17:39:30 -0700 Subject: [PATCH 1575/1753] Fix flaky GC-based tests in AsyncLazyTests ValueFactoryReleasedAfterExecution and AsyncPumpReleasedAfterExecution were intermittently failing in CI because GC.Collect() alone does not guarantee collection of objects tied to async state machines. Replace the non-deterministic collection loop with a single Task.Yield() to release async state machine references, followed by forced blocking full GC with GC.WaitForPendingFinalizers() to ensure deterministic cleanup. --- .../AsyncLazyTests.cs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs index 79fb5b395..051c960d5 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncLazyTests.cs @@ -153,10 +153,11 @@ public async Task ValueFactoryReleasedAfterExecution() { WeakReference collectible = await this.ValueFactoryReleasedAfterExecution_Helper(); + await Task.Yield(); for (int i = 0; i < 3; i++) { - await Task.Yield(); - GC.Collect(); + GC.Collect(GC.MaxGeneration, GCCollectionMode.Forced, blocking: true); + GC.WaitForPendingFinalizers(); } Assert.False(collectible.IsAlive); @@ -167,10 +168,11 @@ public async Task AsyncPumpReleasedAfterExecution(bool throwInValueFactory) { WeakReference collectible = await this.AsyncPumpReleasedAfterExecution_Helper(throwInValueFactory); + await Task.Yield(); for (int i = 0; i < 3; i++) { - await Task.Yield(); - GC.Collect(); + GC.Collect(GC.MaxGeneration, GCCollectionMode.Forced, blocking: true); + GC.WaitForPendingFinalizers(); } Assert.False(collectible.IsAlive); From b5f38e9d651386858d9a3d6bcb30742708eb4e18 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 21 Feb 2026 01:00:55 +0000 Subject: [PATCH 1576/1753] Merge pull request #1454 from microsoft/renovate/dotnet-monorepo Update dotnet monorepo --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index a4db7cd64..ab2176186 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 2.0.208 3.11.0 1.1.3 - 3.11.0-beta1.25076.3 + 3.11.0-beta1.26057.1 From 4332894cbeaad95797e24004cf3adc5abc5b9be7 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 23 Feb 2026 11:33:25 -0600 Subject: [PATCH 1577/1753] Update Visual Studio SDK (#1455) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 10 +++++----- ...icrosoft.VisualStudio.Threading.JointPackage.csproj | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ab2176186..71c955695 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -24,14 +24,14 @@ - - - - + + + + - + diff --git a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj index 4d7805ae0..6d30fbae5 100644 --- a/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj +++ b/src/Microsoft.VisualStudio.Threading.JointPackage/Microsoft.VisualStudio.Threading.JointPackage.csproj @@ -4,7 +4,7 @@ Microsoft.VisualStudio.Threading false false - $(NoWarn);NU5128 + $(NoWarn);NU5128;MSB3277 false From 6103b65b8fa48cb06b355f4f3419cdee3620de45 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 23 Feb 2026 12:55:23 -0700 Subject: [PATCH 1578/1753] Only disable NBGV_GitEngine when necessary --- .github/Prime-ForCopilot.ps1 | 5 +++++ .github/copilot-instructions.md | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .github/Prime-ForCopilot.ps1 diff --git a/.github/Prime-ForCopilot.ps1 b/.github/Prime-ForCopilot.ps1 new file mode 100644 index 000000000..4de91ab66 --- /dev/null +++ b/.github/Prime-ForCopilot.ps1 @@ -0,0 +1,5 @@ +if ((git rev-parse --is-shallow-repository) -eq 'true') +{ + Write-Host "Shallow clone detected, disabling NBGV Git engine so the build can succeed." + $env:NBGV_GitEngine='Disabled' +} diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index deb29535e..654fbfe44 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -3,7 +3,8 @@ ## High level guidance * Review the `CONTRIBUTING.md` file for instructions to build and test the software. -* Set the `NBGV_GitEngine` environment variable to `Disabled` before running any `dotnet` or `msbuild` commands. +* Run the `.github\Prime-ForCopilot.ps1` script (once) before running any `dotnet` or `msbuild` commands. + If you see any build errors about not finding git objects or a shallow clone, it may be time to run this script again. ## Software Design From c04c3a806f192422e315d5645941ba62df9a8b7a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 24 Feb 2026 07:51:54 -0700 Subject: [PATCH 1579/1753] Merge pull request 481 from AArnott/renovate/docfx-2.x Update dependency docfx to v2.78.5 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index c22a2eb07..20472ac39 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -24,7 +24,7 @@ "rollForward": false }, "docfx": { - "version": "2.78.4", + "version": "2.78.5", "commands": [ "docfx" ], From f4c9c8108cc71be37ff4fe2d661fd2c2c8469b51 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 24 Feb 2026 07:52:14 -0700 Subject: [PATCH 1580/1753] Update mcr.microsoft.com/dotnet/sdk:10.0.103 Docker digest to e362a8d (480) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 3df45f85a..8fc20d609 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.103@sha256:0a506ab0c8aa077361af42f82569d364ab1b8741e967955d883e3f23683d473a +FROM mcr.microsoft.com/dotnet/sdk:10.0.103@sha256:e362a8dbcd691522456da26a5198b8f3ca1d7641c95624fadc5e3e82678bd08a # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From b275911f16fa6bf8c64b09c8ee6c9ad3117984ef Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Feb 2026 09:34:14 -0700 Subject: [PATCH 1581/1753] Add an mcp.json file --- .vscode/mcp.json | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .vscode/mcp.json diff --git a/.vscode/mcp.json b/.vscode/mcp.json new file mode 100644 index 000000000..cbe47099a --- /dev/null +++ b/.vscode/mcp.json @@ -0,0 +1,8 @@ +{ + "servers": { + "github": { + "url": "https://api.githubcopilot.com/mcp/" + } + }, + "inputs": [] +} From ed9bfee84341ef76535b0d717460f26522a5346a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Feb 2026 10:16:00 -0700 Subject: [PATCH 1582/1753] Document `InternalsVisibleTo` ban so Copilot knows --- .github/copilot-instructions.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index deb29535e..1aefbe271 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -9,6 +9,7 @@ * Design APIs to be highly testable, and all functionality should be tested. * Avoid introducing binary breaking changes in public APIs of projects under `src` unless their project files have `IsPackable` set to `false`. +* `InternalsVisibleTo` attributes are *not allowed*. ## Testing @@ -17,6 +18,8 @@ * There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Tests` suffix. * Tests use xunit v3 with Microsoft.Testing.Platform (MTP v2). Traditional VSTest `--filter` syntax does NOT work. * Some tests are known to be unstable. When running tests, you should skip the unstable ones by using `-- --filter-not-trait "FailsInCloudTest=true"`. +* Since `InternalsVisibleTo` is not allowed, testing must be done at the public API level. + In rare cases where there are static utility methods that need to be thoroughly tested, which may be impossible or inefficient to do via public APIs, the static methods may be moved to a .cs file that is then linked both into the product and into the test project so that it may be tested directly. ### Running Tests From c4644e82ab60eb2787fbd8bd1eee181544c0e057 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 25 Feb 2026 09:13:47 -0700 Subject: [PATCH 1583/1753] Remove slow regex from threading analyzers --- .../CommonInterest.cs | 77 +++--- .../CommonInterestParsing.cs | 193 ++++++++++++++ .../CommonInterestParsingTests.cs | 244 ++++++++++++++++++ ...ualStudio.Threading.Analyzers.Tests.csproj | 4 + .../Usings.cs | 1 + 5 files changed, 479 insertions(+), 40 deletions(-) create mode 100644 src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterestParsing.cs create mode 100644 test/Microsoft.VisualStudio.Threading.Analyzers.Tests/CommonInterestParsingTests.cs diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs index d0efdc342..b4fdfc07a 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterest.cs @@ -69,17 +69,6 @@ public static class CommonInterest private const string GetAwaiterMethodName = "GetAwaiter"; - private static readonly TimeSpan RegexMatchTimeout = TimeSpan.FromSeconds(5); // Prevent expensive CPU hang in Regex.Match if backtracking occurs due to pathological input (see #485). - - private static readonly Regex NegatableTypeOrMemberReferenceRegex = new Regex(@"^(?!)?\[(?[^\[\]\:]+)+\](?:\:\:(?\S+))?\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); - - private static readonly Regex MemberReferenceRegex = new Regex(@"^\[(?[^\[\]\:]+)+\]::(?\S+)\s*$", RegexOptions.Singleline | RegexOptions.CultureInvariant, RegexMatchTimeout); - - /// - /// An array with '.' as its only element. - /// - private static readonly char[] QualifiedIdentifierSeparators = ['.']; - public static IEnumerable ReadMethods(AnalyzerOptions analyzerOptions, Regex fileNamePattern, CancellationToken cancellationToken) { foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) @@ -92,28 +81,15 @@ public static IEnumerable ReadTypesAndMembers(AnalyzerOptions ana { foreach (string line in ReadAdditionalFiles(analyzerOptions, fileNamePattern, cancellationToken)) { - Match? match = null; - try - { - match = NegatableTypeOrMemberReferenceRegex.Match(line); - } - catch (RegexMatchTimeoutException) - { - throw new InvalidOperationException($"Regex.Match timeout when parsing line: {line}"); - } - - if (!match.Success) + if (!CommonInterestParsing.TryParseNegatableTypeOrMemberReference(line, out bool negated, out ReadOnlyMemory typeNameMemory, out string? memberNameValue)) { throw new InvalidOperationException($"Parsing error on line: {line}"); } - bool inverted = match.Groups["negated"].Success; - string[] typeNameElements = match.Groups["typeName"].Value.Split(QualifiedIdentifierSeparators); - string typeName = typeNameElements[typeNameElements.Length - 1]; - var containingNamespace = typeNameElements.Take(typeNameElements.Length - 1).ToImmutableArray(); + (ImmutableArray containingNamespace, string? typeName) = SplitQualifiedIdentifier(typeNameMemory); var type = new QualifiedType(containingNamespace, typeName); - QualifiedMember member = match.Groups["memberName"].Success ? new QualifiedMember(type, match.Groups["memberName"].Value) : default(QualifiedMember); - yield return new TypeMatchSpec(type, member, inverted); + QualifiedMember member = memberNameValue is not null ? new QualifiedMember(type, memberNameValue) : default(QualifiedMember); + yield return new TypeMatchSpec(type, member, negated); } } @@ -345,26 +321,47 @@ public static IEnumerable ReadLinesFromAdditionalFile(SourceText text) public static QualifiedMember ParseAdditionalFileMethodLine(string line) { - Match? match = null; - try + if (!CommonInterestParsing.TryParseMemberReference(line, out ReadOnlyMemory typeNameMemory, out string? memberName)) { - match = MemberReferenceRegex.Match(line); + throw new InvalidOperationException($"Parsing error on line: {line}"); } - catch (RegexMatchTimeoutException) + + (ImmutableArray containingNamespace, string? typeName) = SplitQualifiedIdentifier(typeNameMemory); + var containingType = new QualifiedType(containingNamespace, typeName); + return new QualifiedMember(containingType, memberName!); + } + + /// + /// Splits a qualified type name (e.g. My.Namespace.MyType) into its containing namespace + /// segments and the simple type name, without allocating an intermediate joined string. + /// + /// The qualified type name as a memory slice. + /// The namespace segments and the simple type name. + private static (ImmutableArray ContainingNamespace, string TypeName) SplitQualifiedIdentifier(ReadOnlyMemory qualifiedName) + { + int lastDot = qualifiedName.Span.LastIndexOf('.'); + if (lastDot < 0) { - throw new InvalidOperationException($"Regex.Match timeout when parsing line: {line}"); + return (ImmutableArray.Empty, qualifiedName.ToString()); } - if (!match.Success) + string typeName = qualifiedName.Slice(lastDot + 1).ToString(); + ReadOnlyMemory nsPart = qualifiedName.Slice(0, lastDot); + ImmutableArray.Builder nsBuilder = ImmutableArray.CreateBuilder(); + while (!nsPart.IsEmpty) { - throw new InvalidOperationException($"Parsing error on line: {line}"); + int dot = nsPart.Span.IndexOf('.'); + if (dot < 0) + { + nsBuilder.Add(nsPart.ToString()); + break; + } + + nsBuilder.Add(nsPart.Slice(0, dot).ToString()); + nsPart = nsPart.Slice(dot + 1); } - string methodName = match.Groups["memberName"].Value; - string[] typeNameElements = match.Groups["typeName"].Value.Split(QualifiedIdentifierSeparators); - string typeName = typeNameElements[typeNameElements.Length - 1]; - var containingType = new QualifiedType(typeNameElements.Take(typeNameElements.Length - 1).ToImmutableArray(), typeName); - return new QualifiedMember(containingType, methodName); + return (nsBuilder.ToImmutable(), typeName); } private static bool TestGetAwaiterMethod(IMethodSymbol getAwaiterMethod) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterestParsing.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterestParsing.cs new file mode 100644 index 000000000..7088ab858 --- /dev/null +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/CommonInterestParsing.cs @@ -0,0 +1,193 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; + +namespace Microsoft.VisualStudio.Threading.Analyzers; + +/// +/// Parsing helpers for additional-file lines used by . +/// This class is intentionally kept free of Roslyn dependencies so it can be +/// linked directly into test projects for unit testing. +/// +internal static class CommonInterestParsing +{ + /// + /// Parses a line that may begin with an optional !, followed by [TypeName], + /// and optionally ::MemberName, without using regular expressions. + /// + /// The line to parse. + /// if the line begins with '!'. + /// The type name parsed from the brackets. + /// The member name after '::', or if not present. + /// if parsing succeeded. + internal static bool TryParseNegatableTypeOrMemberReference(string line, out bool negated, out ReadOnlyMemory typeName, out string? memberName) + { + negated = false; + typeName = default; + memberName = null; + + ReadOnlySpan span = line.AsSpan(); + int pos = 0; + + // Optional negation prefix. + if (pos < span.Length && span[pos] == '!') + { + negated = true; + pos++; + } + + // Required '[TypeName]'. + int bracketStart = pos; + if (!TryParseBracketedTypeName(span, ref pos, out _)) + { + return false; + } + + // Compute memory slice for type name (between the brackets), using recorded bracket position. + ReadOnlyMemory typeNameMemory = line.AsMemory(bracketStart + 1, pos - bracketStart - 2); + + // Optional '::memberName'. + ReadOnlySpan memberNameSpan = default; + if (pos + 1 < span.Length && span[pos] == ':' && span[pos + 1] == ':') + { + pos += 2; + int memberNameStart = pos; + while (pos < span.Length && !char.IsWhiteSpace(span[pos])) + { + pos++; + } + + if (pos == memberNameStart) + { + // '::' present but no member name follows. + return false; + } + + memberNameSpan = span.Slice(memberNameStart, pos - memberNameStart); + } + + // Allow only trailing whitespace. + while (pos < span.Length && char.IsWhiteSpace(span[pos])) + { + pos++; + } + + if (pos != span.Length) + { + return false; + } + + // Only allocate strings after full validation. + typeName = typeNameMemory; + memberName = memberNameSpan.IsEmpty ? null : memberNameSpan.ToString(); + return true; + } + + /// + /// Parses a line of the form [TypeName]::MemberName, without using regular expressions. + /// + /// The line to parse. + /// The type name parsed from the brackets. + /// The member name after '::'. + /// if parsing succeeded. + internal static bool TryParseMemberReference(string line, out ReadOnlyMemory typeName, out string? memberName) + { + typeName = default; + memberName = null; + + ReadOnlySpan span = line.AsSpan(); + int pos = 0; + + // Required '[TypeName]'. + int bracketStart = pos; + if (!TryParseBracketedTypeName(span, ref pos, out _)) + { + return false; + } + + // Compute memory slice for type name (between the brackets), using recorded bracket position. + ReadOnlyMemory typeNameMemory = line.AsMemory(bracketStart + 1, pos - bracketStart - 2); + + // Required '::'. + if (pos + 1 >= span.Length || span[pos] != ':' || span[pos + 1] != ':') + { + return false; + } + + pos += 2; + + // Member name: one or more non-whitespace chars. + int memberNameStart = pos; + while (pos < span.Length && !char.IsWhiteSpace(span[pos])) + { + pos++; + } + + if (pos == memberNameStart) + { + return false; + } + + ReadOnlySpan memberNameSpan = span.Slice(memberNameStart, pos - memberNameStart); + + // Allow only trailing whitespace. + while (pos < span.Length && char.IsWhiteSpace(span[pos])) + { + pos++; + } + + if (pos != span.Length) + { + return false; + } + + // Only allocate strings after full validation. + typeName = typeNameMemory; + memberName = memberNameSpan.ToString(); + return true; + } + + /// + /// Advances past a [TypeName] token and outputs the type-name span. + /// + /// The full input span. + /// The current parse position; advanced past the closing ] on success. + /// A slice of containing the type name, without the brackets. + /// if a non-empty bracketed type name was consumed. + internal static bool TryParseBracketedTypeName(ReadOnlySpan span, ref int pos, out ReadOnlySpan typeName) + { + typeName = default; + + // Required opening bracket. + if (pos >= span.Length || span[pos] != '[') + { + return false; + } + + pos++; + + // Type name: one or more chars that are not '[', ']', or ':'. + int typeNameStart = pos; + while (pos < span.Length && span[pos] != '[' && span[pos] != ']' && span[pos] != ':') + { + pos++; + } + + if (pos == typeNameStart) + { + return false; + } + + typeName = span.Slice(typeNameStart, pos - typeNameStart); + + // Required closing bracket. + if (pos >= span.Length || span[pos] != ']') + { + return false; + } + + pos++; + return true; + } +} diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/CommonInterestParsingTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/CommonInterestParsingTests.cs new file mode 100644 index 000000000..879c1fe53 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/CommonInterestParsingTests.cs @@ -0,0 +1,244 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using Microsoft.VisualStudio.Threading.Analyzers; + +public class CommonInterestParsingTests +{ + public class TryParseNegatableTypeOrMemberReferenceTests + { + [Fact] + public void TypeOnly() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType]", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.False(negated); + Assert.Equal("MyType", typeName.ToString()); + Assert.Null(memberName); + } + + [Fact] + public void TypeWithNamespace() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[My.Namespace.MyType]", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.False(negated); + Assert.Equal("My.Namespace.MyType", typeName.ToString()); + Assert.Null(memberName); + } + + [Fact] + public void TypeAndMember() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType]::MyMethod", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.False(negated); + Assert.Equal("MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + [Fact] + public void TypeWithNamespaceAndMember() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[My.Namespace.MyType]::MyMethod", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.False(negated); + Assert.Equal("My.Namespace.MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + [Fact] + public void NegatedTypeOnly() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("![MyType]", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.True(negated); + Assert.Equal("MyType", typeName.ToString()); + Assert.Null(memberName); + } + + [Fact] + public void NegatedTypeAndMember() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("![MyType]::MyMethod", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.True(negated); + Assert.Equal("MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + [Fact] + public void TrailingWhitespace() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType] ", out _, out ReadOnlyMemory typeName, out _)); + Assert.Equal("MyType", typeName.ToString()); + } + + [Fact] + public void TrailingWhitespaceAfterMember() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType]::MyMethod ", out _, out ReadOnlyMemory typeName, out string? memberName)); + Assert.Equal("MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + /// + /// Regression test: the long type name from the bug report must parse quickly without catastrophic backtracking. + /// + [Fact] + public void LongQualifiedTypeNameFromBugReport() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("![Microsoft.VisualStudio.Shell.Interop.IVsRunningDocumentTablePrivate]", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.True(negated); + Assert.Equal("Microsoft.VisualStudio.Shell.Interop.IVsRunningDocumentTablePrivate", typeName.ToString()); + Assert.Null(memberName); + } + + [Fact] + public void EmptyString() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference(string.Empty, out _, out _, out _)); + } + + [Fact] + public void NoBrackets() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("MyType", out _, out _, out _)); + } + + [Fact] + public void MissingOpeningBracket() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("MyType]", out _, out _, out _)); + } + + [Fact] + public void MissingClosingBracket() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType", out _, out _, out _)); + } + + [Fact] + public void EmptyTypeName() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[]", out _, out _, out _)); + } + + [Fact] + public void SingleColonNotDouble() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType]:MyMethod", out _, out _, out _)); + } + + [Fact] + public void DoubleColonWithoutMemberName() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType]::", out _, out _, out _)); + } + + [Fact] + public void ColonInsideBrackets() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType::NotAllowed]", out _, out _, out _)); + } + + [Fact] + public void LeadingWhitespace() + { + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference(" [MyType]", out _, out _, out _)); + } + + [Fact] + public void SpaceInMiddleOfMemberName() + { + // The member name scanner stops at whitespace, so "extra" content after a space is not consumed + // and the trailing-only-whitespace check rejects the line. + Assert.False(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[MyType]::MyMethod extra", out _, out _, out _)); + } + + [Fact] + public void WildcardTypeName() + { + Assert.True(CommonInterestParsing.TryParseNegatableTypeOrMemberReference("[*]", out bool negated, out ReadOnlyMemory typeName, out string? memberName)); + Assert.False(negated); + Assert.Equal("*", typeName.ToString()); + Assert.Null(memberName); + } + } + + public class TryParseMemberReferenceTests + { + [Fact] + public void TypeAndMember() + { + Assert.True(CommonInterestParsing.TryParseMemberReference("[MyType]::MyMethod", out ReadOnlyMemory typeName, out string? memberName)); + Assert.Equal("MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + [Fact] + public void TypeWithNamespaceAndMember() + { + Assert.True(CommonInterestParsing.TryParseMemberReference("[My.Namespace.MyType]::MyMethod", out ReadOnlyMemory typeName, out string? memberName)); + Assert.Equal("My.Namespace.MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + [Fact] + public void TrailingWhitespace() + { + Assert.True(CommonInterestParsing.TryParseMemberReference("[MyType]::MyMethod ", out ReadOnlyMemory typeName, out string? memberName)); + Assert.Equal("MyType", typeName.ToString()); + Assert.Equal("MyMethod", memberName); + } + + [Fact] + public void EmptyString() + { + Assert.False(CommonInterestParsing.TryParseMemberReference(string.Empty, out _, out _)); + } + + [Fact] + public void TypeOnly_NoMember() + { + Assert.False(CommonInterestParsing.TryParseMemberReference("[MyType]", out _, out _)); + } + + [Fact] + public void NoBrackets() + { + Assert.False(CommonInterestParsing.TryParseMemberReference("MyType::MyMethod", out _, out _)); + } + + [Fact] + public void MissingClosingBracket() + { + Assert.False(CommonInterestParsing.TryParseMemberReference("[MyType::MyMethod", out _, out _)); + } + + [Fact] + public void EmptyTypeName() + { + Assert.False(CommonInterestParsing.TryParseMemberReference("[]::MyMethod", out _, out _)); + } + + [Fact] + public void SingleColonNotDouble() + { + Assert.False(CommonInterestParsing.TryParseMemberReference("[MyType]:MyMethod", out _, out _)); + } + + [Fact] + public void DoubleColonWithoutMemberName() + { + Assert.False(CommonInterestParsing.TryParseMemberReference("[MyType]::", out _, out _)); + } + + [Fact] + public void LeadingWhitespace() + { + Assert.False(CommonInterestParsing.TryParseMemberReference(" [MyType]::MyMethod", out _, out _)); + } + + [Fact] + public void Negation_NotSupported() + { + // TryParseMemberReference does not accept a leading '!'. + Assert.False(CommonInterestParsing.TryParseMemberReference("![MyType]::MyMethod", out _, out _)); + } + } +} diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 50bbac324..78d772b56 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -44,6 +44,10 @@ + + + + diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs index d38229f3d..4fb29506c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Usings.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +global using System; global using System.Threading.Tasks; global using Microsoft; global using Microsoft.CodeAnalysis; From 965b77e16cfb3040c67f9f321e9b3f72108dbbc3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 26 Feb 2026 09:24:18 -0700 Subject: [PATCH 1584/1753] Reduce AsyncLazy value factory retention to improve GC-test stability --- src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs index 1f9c3ae6f..bbe9018e0 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncLazy`1.cs @@ -199,13 +199,16 @@ public Task GetValueAsync(CancellationToken cancellationToken) this.valueFactory = null; Func> valueFactory = async delegate { + Func>? localValueFactory = originalValueFactory; + originalValueFactory = null; try { await resumableAwaiter; - return await originalValueFactory().ConfigureAwaitRunInline(); + return await localValueFactory().ConfigureAwaitRunInline(); } finally { + localValueFactory = null; this.joinableTask = null; } }; From df06a8f52df3c781bb0775caa81c87e0f87f5078 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 26 Feb 2026 10:20:15 -0700 Subject: [PATCH 1585/1753] Re-enable some analyzer tests (#1550) * Re-enable tests that were disabled for #1364 * Initial plan * Add SkipLocalDiagnosticCheck to transitive code fix tests The VSTHRD010 analyzer reports transitive diagnostics via RegisterCompilationEndAction, which the Roslyn testing framework classifies as 'non-local'. The test framework throws 'Code fix is attempting to provide a fix for a non-local analyzer diagnostic' unless CodeFixTestBehaviors.SkipLocalDiagnosticCheck is set. This adds that flag to the three affected test instances. Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --- .../VSTHRD010MainThreadUsageAnalyzerTests.cs | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs index 090aaf35e..a8a74b77b 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD010MainThreadUsageAnalyzerTests.cs @@ -215,7 +215,7 @@ class Test { }.RunAsync(); } - [Fact(Skip = "Started failing after CodeAnalysis upgrade that caught a bug in the code fix. #1364")] + [Fact] public async Task TransitiveNoCheck_InCtor() { var test = @" @@ -285,6 +285,10 @@ static void VerifyOnUIThread() { ExpectedDiagnostics = { expected }, FixedCode = fix1, CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + + // SkipLocalDiagnosticCheck is required because this diagnostic is reported at compilation-end + // (as a transitive/indirect diagnostic), not as a local one. See https://github.com/microsoft/vs-threading/issues/1364. + CodeFixTestBehaviors = CodeFixTestBehaviors.SkipLocalDiagnosticCheck, }.RunAsync(); await new CSVerify.Test @@ -293,6 +297,10 @@ static void VerifyOnUIThread() { ExpectedDiagnostics = { expected }, FixedCode = fix2, CodeActionIndex = CodeFixIndex.ThrowIfNotOnUIThreadIndex1, + + // SkipLocalDiagnosticCheck is required because this diagnostic is reported at compilation-end + // (as a transitive/indirect diagnostic), not as a local one. See https://github.com/microsoft/vs-threading/issues/1364. + CodeFixTestBehaviors = CodeFixTestBehaviors.SkipLocalDiagnosticCheck, }.RunAsync(); } @@ -522,7 +530,7 @@ void VerifyOnUIThread() { await CSVerify.VerifyAnalyzerAsync(test, expected); } - [Fact(Skip = "Started failing after CodeAnalysis upgrade that caught a bug in the code fix. #1364")] + [Fact] public async Task RequiresUIThreadTransitive_MultipleInMember() { var test = @" @@ -587,6 +595,10 @@ static void VerifyOnUIThread() { } }, FixedCode = fix, CodeActionIndex = CodeFixIndex.VerifyOnUIThread, + + // SkipLocalDiagnosticCheck is required because this diagnostic is reported at compilation-end + // (as a transitive/indirect diagnostic), not as a local one. See https://github.com/microsoft/vs-threading/issues/1364. + CodeFixTestBehaviors = CodeFixTestBehaviors.SkipLocalDiagnosticCheck, }.RunAsync(); } From 05374d1b5e188762e6e362fd18e696eb17e44154 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Thu, 26 Feb 2026 09:52:51 -0800 Subject: [PATCH 1586/1753] Fix VSTHRD114 not firing for null in ternary conditional expressions (#1548) * Initial plan * Fix VSTHRD114: detect null in ternary/conditional expressions Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --- ...VSTHRD114AvoidReturningNullTaskAnalyzer.cs | 39 ++++++++++++---- ...D114AvoidReturningNullTaskAnalyzerTests.cs | 45 ++++++++++++++++++- 2 files changed, 74 insertions(+), 10 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs index dcd2e9425..b677d1bfe 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD114AvoidReturningNullTaskAnalyzer.cs @@ -55,19 +55,42 @@ public override void Initialize(AnalysisContext context) }; } + private static void CheckForNullValue(OperationAnalysisContext context, IOperation operation) + { + if (operation is IConditionalOperation conditionalOp) + { + if (conditionalOp.WhenTrue is { } whenTrue) + { + CheckForNullValue(context, whenTrue); + } + + if (conditionalOp.WhenFalse is { } whenFalse) + { + CheckForNullValue(context, whenFalse); + } + } + else if (operation.ConstantValue is { HasValue: true, Value: null } && + operation.Syntax is { } nullSyntax) + { + context.ReportDiagnostic(Diagnostic.Create(Descriptor, nullSyntax.GetLocation())); + } + } + private void AnalyzerReturnOperation(OperationAnalysisContext context) { var returnOperation = (IReturnOperation)context.Operation; - if (returnOperation.ReturnedValue is { ConstantValue: { HasValue: true, Value: null } } && // could be null for implicit returns - returnOperation.ReturnedValue.Syntax is { } returnedValueSyntax && - Utils.GetContainingFunctionBlock(returnOperation) is { } block && - FindOwningSymbol(block, context.ContainingSymbol) is { } method && - !method.IsAsync && - Utils.IsTask(method.ReturnType) && - !this.LanguageUtils.MethodReturnsNullableReferenceType(method)) + // ReturnedValue is null for implicit/void returns + if (returnOperation.ReturnedValue is not { } returnedValue || + Utils.GetContainingFunctionBlock(returnOperation) is not { } block || + FindOwningSymbol(block, context.ContainingSymbol) is not { } owningMethod || + owningMethod.IsAsync || + !Utils.IsTask(owningMethod.ReturnType) || + this.LanguageUtils.MethodReturnsNullableReferenceType(owningMethod)) { - context.ReportDiagnostic(Diagnostic.Create(Descriptor, returnedValueSyntax.GetLocation())); + return; } + + CheckForNullValue(context, returnedValue); } } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs index 63822876f..5487ddbe6 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD114AvoidReturningNullTaskAnalyzerTests.cs @@ -147,7 +147,7 @@ public Task GetTaskObj() } [Fact] - public async Task NullInTernary_NoDiagnostic_FalseNegative() + public async Task NullInTernary_Diagnostic() { var test = @" using System.Threading.Tasks; @@ -156,7 +156,7 @@ class Test { public Task GetTaskObj(bool b) { - return b ? default(Task) : null; + return b ? [|default(Task)|] : [|null|]; } } "; @@ -166,6 +166,47 @@ public Task GetTaskObj(bool b) }.RunAsync(); } + [Fact] + public async Task NullInTernaryReturnStatement_Diagnostic() + { + var csharpTest = @" +using System.Threading.Tasks; + +class Test +{ + public Task First(bool flag) + { + return flag + ? [|null|] + : Task.CompletedTask; + } + + public Task Second(bool flag) => + flag + ? [|null|] + : Task.CompletedTask; +} +"; + await new CSVerify.Test + { + TestCode = csharpTest, + }.RunAsync(); + + var vbTest = @" +Imports System.Threading.Tasks + +Friend Class Test + Public Function First(flag As Boolean) As Task + Return If(flag, [|Nothing|], Task.CompletedTask) + End Function +End Class +"; + await new VerifyVB.Test + { + TestCode = vbTest, + }.RunAsync(); + } + [Fact] public async Task MultipleFaultyReturns_MultipleDiagnostics() { From a9b48e169f97cfa22a2b18c3d031807f73583545 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 27 Feb 2026 06:35:36 -0700 Subject: [PATCH 1587/1753] Update dependency dotnet-coverage to v18.5.1 (483) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 20472ac39..b1bd90bba 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.4.1", + "version": "18.5.1", "commands": [ "dotnet-coverage" ], From 824209761c8a0614a8e921cd642c05c2064d3d5b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 27 Feb 2026 06:36:11 -0700 Subject: [PATCH 1588/1753] Update dependency Microsoft.Testing.Extensions.CodeCoverage to 18.5.1 (484) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 73d0d36e6..37275ba94 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 2960fc588ac92372e603de9b1f5ab84c054668b4 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 27 Feb 2026 06:36:42 -0700 Subject: [PATCH 1589/1753] Update GitHub Artifact Actions (482) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/actions/publish-artifacts/action.yaml | 14 +++++++------- .github/workflows/release.yml | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index e0246825d..9982cf18e 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -14,46 +14,46 @@ runs: - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 + uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 51b11386d..4c2f0a5d3 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,7 +57,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 + uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From 582d263d8bd5c187aa9e6e0047f152809fe8ed77 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 27 Feb 2026 23:17:43 -0700 Subject: [PATCH 1590/1753] Bump DotNetRepoTools to 1.2.1 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index b1bd90bba..9e1878232 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.1.1", + "version": "1.2.1", "commands": [ "repo" ], From 85514fab35853970d769db0f762941b6ddb88c48 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 5 Mar 2026 09:51:43 -0700 Subject: [PATCH 1591/1753] Update dependency Microsoft.Testing.Extensions.CodeCoverage to 18.5.2 (486) --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 37275ba94..0657db895 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From ebc35701512d7c7b7b3bce3fedd46d7f0c7243bb Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 5 Mar 2026 09:51:54 -0700 Subject: [PATCH 1592/1753] Update dependency dotnet-coverage to v18.5.2 (485) --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9e1878232..16f077b86 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.5.1", + "version": "18.5.2", "commands": [ "dotnet-coverage" ], From e4a2493e50089f6c2872da08bb46da972499cad8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2026 09:33:43 -0700 Subject: [PATCH 1593/1753] Fix warning message --- tools/variables/ProfilingInputsPropsName.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/variables/ProfilingInputsPropsName.ps1 b/tools/variables/ProfilingInputsPropsName.ps1 index e66cce0ca..9e6bc4a16 100644 --- a/tools/variables/ProfilingInputsPropsName.ps1 +++ b/tools/variables/ProfilingInputsPropsName.ps1 @@ -2,5 +2,5 @@ if ($env:SYSTEM_TEAMPROJECT) { $repoName = $env:BUILD_REPOSITORY_NAME.Replace('/', '.') "$env:SYSTEM_TEAMPROJECT.$repoName.props" } else { - Write-Warning "No Azure Pipelines build detected. No Azure Pipelines drop name will be computed." + Write-Warning "No Azure Pipelines build detected. No profiling inputs filename will be computed." } From 41b6a219f210a07213e2c3d354c0c304378bbbc6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2026 10:14:42 -0700 Subject: [PATCH 1594/1753] Fix Prime-ForCopilot.ps1 when invoked from outside the repo --- .github/Prime-ForCopilot.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/Prime-ForCopilot.ps1 b/.github/Prime-ForCopilot.ps1 index 4de91ab66..e0b1fb79d 100644 --- a/.github/Prime-ForCopilot.ps1 +++ b/.github/Prime-ForCopilot.ps1 @@ -1,4 +1,4 @@ -if ((git rev-parse --is-shallow-repository) -eq 'true') +if ((git -C $PSScriptRoot rev-parse --is-shallow-repository) -eq 'true') { Write-Host "Shallow clone detected, disabling NBGV Git engine so the build can succeed." $env:NBGV_GitEngine='Disabled' From 2e49a12aa3315019b7fe89d0d88cf41bc9215d90 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2026 10:14:52 -0700 Subject: [PATCH 1595/1753] Use forward slashes consistently in docs --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 654fbfe44..0187843a6 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -3,7 +3,7 @@ ## High level guidance * Review the `CONTRIBUTING.md` file for instructions to build and test the software. -* Run the `.github\Prime-ForCopilot.ps1` script (once) before running any `dotnet` or `msbuild` commands. +* Run the `.github/Prime-ForCopilot.ps1` script (once) before running any `dotnet` or `msbuild` commands. If you see any build errors about not finding git objects or a shallow clone, it may be time to run this script again. ## Software Design From 62a1ccc2379f534f60922690bc4eecc373c2b625 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2026 10:17:11 -0700 Subject: [PATCH 1596/1753] Avoid assigning to an unused variable --- tools/Prepare-Legacy-Symbols.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Prepare-Legacy-Symbols.ps1 b/tools/Prepare-Legacy-Symbols.ps1 index e566d6241..0ab7e4f59 100644 --- a/tools/Prepare-Legacy-Symbols.ps1 +++ b/tools/Prepare-Legacy-Symbols.ps1 @@ -22,7 +22,7 @@ Get-ChildItem "$ArtifactStagingFolder\*.pdb" -Recurse |% { if ($BinaryImagePath) { # Native binaries can't have their PDBs converted to legacy (Windows) format so just skip them try { - $assembly = [System.Reflection.AssemblyName]::GetAssemblyName($BinaryImagePath) + [System.Reflection.AssemblyName]::GetAssemblyName($BinaryImagePath) | Out-Null $isManaged = $true } catch { From 0a7200aa069f5583d11ef44d15f50ef603ece7af Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 6 Mar 2026 12:58:19 -0700 Subject: [PATCH 1597/1753] Avoid returning early while preparing legacy symbols --- tools/Prepare-Legacy-Symbols.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Prepare-Legacy-Symbols.ps1 b/tools/Prepare-Legacy-Symbols.ps1 index 0ab7e4f59..8a007c2a3 100644 --- a/tools/Prepare-Legacy-Symbols.ps1 +++ b/tools/Prepare-Legacy-Symbols.ps1 @@ -31,7 +31,7 @@ Get-ChildItem "$ArtifactStagingFolder\*.pdb" -Recurse |% { if (-not $isManaged) { Write-Host "Skipping native binary PDB: $_" -ForegroundColor DarkYellow - return + continue } # Convert the PDB to legacy Windows PDBs From 7d4a9ecbc8274a7f659273542c27b2addf4b1b49 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 11 Mar 2026 07:12:27 -0600 Subject: [PATCH 1598/1753] Update Dockerfile and global.json updates to v10.0.200 (487) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 8fc20d609..5a23e8011 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.103@sha256:e362a8dbcd691522456da26a5198b8f3ca1d7641c95624fadc5e3e82678bd08a +FROM mcr.microsoft.com/dotnet/sdk:10.0.200@sha256:ea13841f10c6c410a6df63c6c97ab549dfd2b5fcfff1c00186531ba30208117d # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index bdc382f30..c98253b4e 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.103", + "version": "10.0.200", "rollForward": "patch", "allowPrerelease": false }, From c20fa1afa282a1cb410d1bab4d5cf61a50fed82b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 12 Mar 2026 15:19:29 -0600 Subject: [PATCH 1599/1753] Update dependency powershell to v7.5.5 (#489) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 16f077b86..d4570a60f 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.5.4", + "version": "7.5.5", "commands": [ "pwsh" ], From 56dfa063913051dee37780664e70d16025f50850 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 12 Mar 2026 15:20:08 -0600 Subject: [PATCH 1600/1753] Update actions/download-artifact action to v8.0.1 (488) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4c2f0a5d3..11bebbe22 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,7 +57,7 @@ jobs: Echo "runid=$runid" >> $env:GITHUB_OUTPUT - name: 🔻 Download deployables artifacts - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: name: deployables-Linux path: ${{ runner.temp }}/deployables From b58cafc7bf3a81eee5db7408b01b9405058626e8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 13 Mar 2026 20:05:11 -0600 Subject: [PATCH 1601/1753] Update Dockerfile and global.json updates to v10.0.201 (490) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 5a23e8011..ab98561c9 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.200@sha256:ea13841f10c6c410a6df63c6c97ab549dfd2b5fcfff1c00186531ba30208117d +FROM mcr.microsoft.com/dotnet/sdk:10.0.201@sha256:478b9038d187e5b5c29bfa8173ded5d29e864b5ad06102a12106380ee01e2e49 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index c98253b4e..c331692b9 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.200", + "version": "10.0.201", "rollForward": "patch", "allowPrerelease": false }, From 326764f52487bcb3bc3d09c6bace30c5fdd2ebfc Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 19 Mar 2026 14:45:44 +1300 Subject: [PATCH 1602/1753] Update dependency powershell to v7.6.0 (#491) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index d4570a60f..7c912c3ef 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.5.5", + "version": "7.6.0", "commands": [ "pwsh" ], From 330fbbed2b433d111128ebce59152a12047f7488 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 25 Mar 2026 12:06:43 -0600 Subject: [PATCH 1603/1753] Update actions/deploy-pages action to v5 (492) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 53af0a052..e19cf640f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -40,4 +40,4 @@ jobs: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 + uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 From c7e63e775696a62eed687d0bd01394576b8d9f77 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 30 Mar 2026 12:16:41 -0600 Subject: [PATCH 1604/1753] Harden path joining in VSInsertion.ps1 --- tools/artifacts/VSInsertion.ps1 | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/tools/artifacts/VSInsertion.ps1 b/tools/artifacts/VSInsertion.ps1 index 700b24f69..2858f7f22 100644 --- a/tools/artifacts/VSInsertion.ps1 +++ b/tools/artifacts/VSInsertion.ps1 @@ -21,7 +21,7 @@ $NuGetPackages = "$PackagesRoot/NuGet" $VsixPackages = "$PackagesRoot/Vsix" $AzurePipelinesPath = "$RepoRoot/azure-pipelines" if ($env:BUILD_ARTIFACTSTAGINGDIRECTORY) { - $InsertionOutputs = "$env:BUILD_ARTIFACTSTAGINGDIRECTORY/InsertionOutputs" + $InsertionOutputs = Join-Path $env:BUILD_ARTIFACTSTAGINGDIRECTORY 'InsertionOutputs' } if (!(Test-Path $NuGetPackages) -and !(Test-Path $VsixPackages)) { @@ -38,8 +38,11 @@ if (Test-Path $VsixPackages) { $result["$PackagesRoot"] += Get-ChildItem $VsixPackages -Recurse } -if ($InsertionOutputs -and $env:PROFILINGINPUTSPROPSNAME -and (Test-Path "$InsertionOutputs/$env:PROFILINGINPUTSPROPSNAME")) { - $result[$InsertionOutputs] = (Get-ChildItem "$InsertionOutputs/$env:PROFILINGINPUTSPROPSNAME"); # OptProf ProfilingInputs +if ($InsertionOutputs -and $env:PROFILINGINPUTSPROPSNAME) { + $InsertOutputsProfilingInputs = Join-Path $InsertionOutputs $env:PROFILINGINPUTSPROPSNAME + if (Test-Path -LiteralPath $InsertOutputsProfilingInputs) { + $result[$InsertionOutputs] = Get-ChildItem -LiteralPath $InsertOutputsProfilingInputs # OptProf ProfilingInputs + } } $result From 2106ee95755f1d396f026a8b3ddd3a56cfb35d0d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 4 Apr 2026 06:24:10 -0600 Subject: [PATCH 1605/1753] Update mcr.microsoft.com/dotnet/sdk:10.0.201 Docker digest to f061e5a (493) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index ab98561c9..14b064da3 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.201@sha256:478b9038d187e5b5c29bfa8173ded5d29e864b5ad06102a12106380ee01e2e49 +FROM mcr.microsoft.com/dotnet/sdk:10.0.201@sha256:f061e5a7532b36fa1d1b684857fe1f504ba92115b9934f154643266613c44c62 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 3c72508949517b488ea7adff2f44d3f13d00abe3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 6 Apr 2026 12:20:23 -0600 Subject: [PATCH 1606/1753] Harden release workflow to use better runs --- .github/workflows/release.yml | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 11bebbe22..a14587a7d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -40,16 +40,30 @@ jobs: Write-Host "Resolved ${{ github.ref_name }} to $commitSha" - $releases = gh run list -R ${{ github.repository }} -c $commitSha -w .github/workflows/build.yml -s success --json databaseId,startedAt ` + $releases = gh run list -R ${{ github.repository }} -c $commitSha -w .github/workflows/build.yml -s success --json databaseId,startedAt,event,headBranch ` | ConvertFrom-Json | Sort-Object startedAt -Descending + $preferredReleases = $releases | Where-Object { + $_.event -eq 'push' -and ($_.headBranch -eq 'main' -or $_.headBranch -match '^v\d+(?:\.\d+)?$') + } + if ($releases.length -eq 0) { Write-Error "No successful builds found for ${{ github.ref }}." - } elseif ($releases.length -gt 1) { - Write-Warning "More than one successful run found for ${{ github.ref }}. Artifacts from the most recent successful run will ship." - } + } else { + if ($preferredReleases.length -gt 0) { + $selectedReleases = $preferredReleases + $multipleRunsWarning = "More than one successful run found for ${{ github.ref }}. Preferring the most recent push build from a public-release branch." + } else { + $selectedReleases = $releases + $multipleRunsWarning = "More than one successful run found for ${{ github.ref }} and none were from a public-release branch. Artifacts from the most recent successful run will ship." + } - $runid = $releases[0].databaseId + if ($releases.length -gt 1) { + Write-Warning $multipleRunsWarning + } + + $runid = $selectedReleases[0].databaseId + } } Write-Host "Using artifacts from run-id: $runid" From f398becc80f946a9c52ba2f2ed1146da4716aded Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 6 Apr 2026 12:29:37 -0600 Subject: [PATCH 1607/1753] Fix the build status badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aa2dfb599..3f8c9764b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![NuGet package](https://img.shields.io/badge/nuget-your--package--here-yellow.svg) [![Azure Pipelines status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/AArnott.Library.Template?branchName=main)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=29&branchName=main) -![GitHub Actions status](https://github.com/aarnott/Library.Template/workflows/CI/badge.svg) +[![🏭 Build](https://github.com/AArnott/Library.Template/actions/workflows/build.yml/badge.svg)](https://github.com/AArnott/Library.Template/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/aarnott/library.template/branch/main/graph/badge.svg)](https://codecov.io/gh/aarnott/library.template) ## Features From 903963452da5c47500f9620688b6fbd7e723a2c2 Mon Sep 17 00:00:00 2001 From: Andrii Tretiak Date: Mon, 6 Apr 2026 11:33:12 -0700 Subject: [PATCH 1608/1753] Switch from using nuget.exe to dotnet cli commands (#494) * Switch from using nuget.exe to dotnet cli commands * Fix Download-NuGetPackage failure and version selection --------- Co-authored-by: Andrew Arnott --- tools/Download-NuGetPackage.ps1 | 77 +++++++++++++++++++++++++++++++ tools/Get-3rdPartySymbolFiles.ps1 | 50 +++++++++++--------- tools/Get-NuGetTool.ps1 | 22 --------- tools/Get-ProcDump.ps1 | 6 +-- tools/Install-NuGetPackage.ps1 | 63 ------------------------- 5 files changed, 108 insertions(+), 110 deletions(-) create mode 100644 tools/Download-NuGetPackage.ps1 delete mode 100644 tools/Get-NuGetTool.ps1 delete mode 100644 tools/Install-NuGetPackage.ps1 diff --git a/tools/Download-NuGetPackage.ps1 b/tools/Download-NuGetPackage.ps1 new file mode 100644 index 000000000..924b9edf4 --- /dev/null +++ b/tools/Download-NuGetPackage.ps1 @@ -0,0 +1,77 @@ +<# +.SYNOPSIS + Downloads a NuGet package to a local folder using dotnet package download. +.PARAMETER PackageId + The Package ID to download. +.PARAMETER Version + The version of the package to download. If unspecified, the latest version is downloaded. +.PARAMETER Source + An additional package source to search. Used as a fallback alongside the configured feeds. +.PARAMETER OutputDirectory + The directory to download the package to. By default, it uses the obj\tools folder at the root of the repo. +.PARAMETER ConfigFile + The nuget.config file to use. By default, it uses the repo root nuget.config. +.PARAMETER Verbosity + The verbosity level for the download. Defaults to quiet. +.OUTPUTS + System.String. The path to the downloaded package directory. +#> +[CmdletBinding()] +Param( + [Parameter(Position=1,Mandatory=$true)] + [string]$PackageId, + [Parameter()] + [string]$Version, + [Parameter()] + [string]$Source, + [Parameter()] + [string]$OutputDirectory="$PSScriptRoot\..\obj\tools", + [Parameter()] + [string]$ConfigFile="$PSScriptRoot\..\nuget.config", + [Parameter()] + [ValidateSet('quiet','minimal','normal','detailed','diagnostic')] + [string]$Verbosity='quiet' +) + +if (!(Test-Path $OutputDirectory)) { New-Item -ItemType Directory -Path $OutputDirectory -Force | Out-Null } +$OutputDirectory = (Resolve-Path $OutputDirectory).Path +$ConfigFile = (Resolve-Path $ConfigFile).Path + +$packageArg = $PackageId +if ($Version) { $packageArg = "$PackageId@$Version" } + +$extraArgs = @() +if ($Source) { $extraArgs += '--source', $Source } + +$prevErrorActionPreference = $ErrorActionPreference +$ErrorActionPreference = 'Continue' +& dotnet package download $packageArg --configfile $ConfigFile --output $OutputDirectory --verbosity $Verbosity @extraArgs 2>&1 | Out-Null +$downloadExitCode = $LASTEXITCODE +$ErrorActionPreference = $prevErrorActionPreference + +if ($downloadExitCode -ne 0) { + throw "Failed to download package $packageArg (exit code $downloadExitCode)." +} + +# Return the path to the downloaded package directory (dotnet package download uses lowercase id) +$packageIdLower = $PackageId.ToLower() +if ($Version) { + $packageRoot = Join-Path $OutputDirectory $packageIdLower + $packageDir = Get-ChildItem -Path $packageRoot -Directory -ErrorAction SilentlyContinue | + Where-Object { $_.Name -ieq $Version } | + Select-Object -First 1 + if ($packageDir) { $packageDir = $packageDir.FullName } +} else { + # When no version is specified, pick the most recently written version directory. + $packageRoot = Join-Path $OutputDirectory $packageIdLower + $packageDir = Get-ChildItem -Path $packageRoot -Directory -ErrorAction SilentlyContinue | + Sort-Object -Property LastWriteTimeUtc -Descending | + Select-Object -First 1 + if ($packageDir) { $packageDir = $packageDir.FullName } +} + +if ($packageDir -and (Test-Path $packageDir)) { + Write-Output $packageDir +} else { + Write-Error "Package directory not found after download." +} diff --git a/tools/Get-3rdPartySymbolFiles.ps1 b/tools/Get-3rdPartySymbolFiles.ps1 index ef6bbef28..7e15f912e 100644 --- a/tools/Get-3rdPartySymbolFiles.ps1 +++ b/tools/Get-3rdPartySymbolFiles.ps1 @@ -1,16 +1,8 @@ -Function Get-FileFromWeb([Uri]$Uri, $OutFile) { - $OutDir = Split-Path $OutFile - if (!(Test-Path $OutFile)) { - Write-Verbose "Downloading $Uri..." - if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir | Out-Null } - try { - (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile) - } - finally { - # This try/finally causes the script to abort - } - } -} +# Symbol servers to search for PDBs, in order of priority. +$SymbolServers = @( + 'https://msdl.microsoft.com/download/symbols' + 'https://symbols.nuget.org/download/symbols' +) Function Unzip($Path, $OutDir) { $OutDir = (New-Item -ItemType Directory -Path $OutDir -Force).FullName @@ -33,17 +25,31 @@ Function Unzip($Path, $OutDir) { Function Get-SymbolsFromPackage($id, $version) { $symbolPackagesPath = "$PSScriptRoot/../obj/SymbolsPackages" New-Item -ItemType Directory -Path $symbolPackagesPath -Force | Out-Null - $nupkgPath = Join-Path $symbolPackagesPath "$id.$version.nupkg" - $snupkgPath = Join-Path $symbolPackagesPath "$id.$version.snupkg" $unzippedPkgPath = Join-Path $symbolPackagesPath "$id.$version" - Get-FileFromWeb -Uri "https://www.nuget.org/api/v2/package/$id/$version" -OutFile $nupkgPath - Get-FileFromWeb -Uri "https://www.nuget.org/api/v2/symbolpackage/$id/$version" -OutFile $snupkgPath - Unzip -Path $nupkgPath -OutDir $unzippedPkgPath - Unzip -Path $snupkgPath -OutDir $unzippedPkgPath + # Download the package from configured feeds (failures are non-fatal for symbol collection) + & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue | Out-Null + $global:LASTEXITCODE = 0 + $nupkgFile = Get-ChildItem -Recurse -Path $symbolPackagesPath -Filter "$id.$version.nupkg" -ErrorAction SilentlyContinue | Select-Object -First 1 + if (!$nupkgFile) { + Write-Warning "Package $id $version not found in configured feeds. Skipping." + return + } + + Unzip -Path $nupkgFile.FullName -OutDir $unzippedPkgPath + + # Download symbols for each binary using dotnet-symbol + $serverArgs = $SymbolServers | ForEach-Object { '--server-path'; $_ } + $binaries = Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Include *.dll, *.exe + foreach ($binary in $binaries) { + $prevErrorActionPreference = $ErrorActionPreference + $ErrorActionPreference = 'Continue' + & dotnet symbol --symbols @serverArgs --output $binary.DirectoryName $binary.FullName 2>&1 | Out-Null + $ErrorActionPreference = $prevErrorActionPreference + } + # Output pairs of binary + PDB paths for archival Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Filter *.pdb | % { - # Collect the DLLs/EXEs as well. $rootName = Join-Path $_.Directory $_.BaseName if ($rootName.EndsWith('.ni')) { $rootName = $rootName.Substring(0, $rootName.Length - 3) @@ -80,7 +86,9 @@ Function Get-PackageVersion($id) { } # All 3rd party packages for which symbols packages are expected should be listed here. -# These must all be sourced from nuget.org, as it is the only feed that supports symbol packages. +# Packages are downloaded from configured feeds in nuget.config. +# We should NOT add 3rd party packages to this list because PDBs may be unsafe for our debuggers to load, +# so we should only archive 1st party symbols. $3rdPartyPackageIds = @() $3rdPartyPackageIds | % { diff --git a/tools/Get-NuGetTool.ps1 b/tools/Get-NuGetTool.ps1 deleted file mode 100644 index bed0cba1d..000000000 --- a/tools/Get-NuGetTool.ps1 +++ /dev/null @@ -1,22 +0,0 @@ -<# -.SYNOPSIS - Downloads the NuGet.exe tool and returns the path to it. -.PARAMETER NuGetVersion - The version of the NuGet tool to acquire. -#> -Param( - [Parameter()] - [string]$NuGetVersion='6.14.0' -) - -$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" -$binaryToolsPath = Join-Path $toolsPath $NuGetVersion -if (!(Test-Path $binaryToolsPath)) { $null = mkdir $binaryToolsPath } -$nugetPath = Join-Path $binaryToolsPath nuget.exe - -if (!(Test-Path $nugetPath)) { - Write-Host "Downloading nuget.exe $NuGetVersion..." -ForegroundColor Yellow - (New-Object System.Net.WebClient).DownloadFile("https://dist.nuget.org/win-x86-commandline/v$NuGetVersion/NuGet.exe", $nugetPath) -} - -return (Resolve-Path $nugetPath).Path diff --git a/tools/Get-ProcDump.ps1 b/tools/Get-ProcDump.ps1 index 1493fe4b2..8b1f7d1e7 100644 --- a/tools/Get-ProcDump.ps1 +++ b/tools/Get-ProcDump.ps1 @@ -4,11 +4,9 @@ Downloads 32-bit and 64-bit procdump executables and returns the path to where t #> $version = '0.0.1' $baseDir = "$PSScriptRoot\..\obj\tools" -$procDumpToolPath = "$baseDir\procdump.$version\bin" +$procDumpToolPath = "$baseDir\procdump\$version\bin" if (-not (Test-Path $procDumpToolPath)) { - if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } - $baseDir = (Resolve-Path $baseDir).Path # Normalize it - & (& $PSScriptRoot\Get-NuGetTool.ps1) install procdump -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://api.nuget.org/v3/index.json | Out-Null + & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId procdump -Version $version -OutputDirectory $baseDir | Out-Null } (Resolve-Path $procDumpToolPath).Path diff --git a/tools/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 deleted file mode 100644 index 3c11b0f6b..000000000 --- a/tools/Install-NuGetPackage.ps1 +++ /dev/null @@ -1,63 +0,0 @@ -<# -.SYNOPSIS - Installs a NuGet package. -.PARAMETER PackageID - The Package ID to install. -.PARAMETER Version - The version of the package to install. If unspecified, the latest stable release is installed. -.PARAMETER Source - The package source feed to find the package to install from. -.PARAMETER Prerelease - Include prerelease packages when searching for the latest version. -.PARAMETER ExcludeVersion - Installs the package without adding the version to the folder name. -.PARAMETER DirectDownload - Bypass the local cache when downloading packages. -.PARAMETER PackagesDir - The directory to install the package to. By default, it uses the Packages folder at the root of the repo. -.PARAMETER ConfigFile - The nuget.config file to use. By default, it uses :/nuget.config. -.OUTPUTS - System.String. The path to the installed package. -#> -[CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Low')] -Param( - [Parameter(Position=1,Mandatory=$true)] - [string]$PackageId, - [Parameter()] - [string]$Version, - [Parameter()] - [string]$Source, - [Parameter()] - [switch]$Prerelease, - [Parameter()] - [switch]$ExcludeVersion, - [Parameter()] - [switch]$DirectDownload, - [Parameter()] - [string]$PackagesDir="$PSScriptRoot\..\packages", - [Parameter()] - [string]$ConfigFile="$PSScriptRoot\..\nuget.config", - [Parameter()] - [ValidateSet('Quiet','Normal','Detailed')] - [string]$Verbosity='normal' -) - -$nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" - -Write-Verbose "Installing $PackageId..." -$nugetArgs = "Install",$PackageId,"-OutputDirectory",$PackagesDir,'-ConfigFile',$ConfigFile -if ($Version) { $nugetArgs += "-Version",$Version } -if ($Source) { $nugetArgs += "-FallbackSource",$Source } -if ($Prerelease) { $nugetArgs += "-Prerelease" } -if ($ExcludeVersion) { $nugetArgs += '-ExcludeVersion' } -if ($DirectDownload) { $nugetArgs += '-DirectDownload' } -$nugetArgs += '-Verbosity',$Verbosity - -if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { - $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru - if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { throw } -} - -# Provide the path to the installed package directory to our caller. -Write-Output (Get-ChildItem "$PackagesDir\$PackageId.*")[0].FullName From 3ae7b3f2b706e1d497b9f9df6e819a73f08c71bf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 6 Apr 2026 21:14:37 -0600 Subject: [PATCH 1609/1753] Fix Expand-Template --- Expand-Template.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Expand-Template.ps1 b/Expand-Template.ps1 index 568ee7999..eb525325a 100755 --- a/Expand-Template.ps1 +++ b/Expand-Template.ps1 @@ -158,7 +158,7 @@ try { Replace-Placeholders -Path "README.md" -Replacements @{ "(?m)^.*\[NuGet package\][^`r`n]*"="[![NuGet package](https://img.shields.io/nuget/v/$LibraryName.svg)](https://nuget.org/packages/$LibraryName)" "(?m)^.*\[Azure Pipelines status\].*`r?`n"="" - "(?m)^.*\[GitHub Actions status\].*`r?`n"="" + "(?m)^.*\ Build\].*`r?`n"="" "(?m)^.*\[codecov\].*`r?`n"="" } Replace-Placeholders -Path "docfx/docfx.json" -Replacements @{ From 8f9002cc5c14f1040d8998b242b2b495479c994a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 7 Apr 2026 07:24:55 -0600 Subject: [PATCH 1610/1753] Update Microsoft Testing Platform to 2.2.1 (497) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 0657db895..546c6bcd4 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.1.0 + 2.2.1 From eca7d5692364420c7f248b98261fab811e58cf8e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Apr 2026 07:26:12 -0600 Subject: [PATCH 1611/1753] Update dependency dotnet-coverage to v18.6.2 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 7c912c3ef..b38002439 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.5.2", + "version": "18.6.2", "commands": [ "dotnet-coverage" ], From 4266d52bb2512a350a1114e8e58ad917d1982945 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Apr 2026 07:27:19 -0600 Subject: [PATCH 1612/1753] Update dependency Microsoft.Testing.Extensions.CodeCoverage to v18.6.2 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 546c6bcd4..c20bfdc12 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From c01a46afdf58b6097440b22b81aad2c595f48c83 Mon Sep 17 00:00:00 2001 From: Artur Dorochowicz Date: Tue, 7 Apr 2026 18:54:48 +0200 Subject: [PATCH 1613/1753] Disable VSTHRD010 in AppWithoutMainThread.editorconfig VSTHRD010 "Invoke single-threaded types on Main thread" does not apply to apps without main thread. --- doc/editorconfigs/AppWithoutMainThread.editorconfig | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/editorconfigs/AppWithoutMainThread.editorconfig b/doc/editorconfigs/AppWithoutMainThread.editorconfig index 51bd71f2d..960bfc41f 100644 --- a/doc/editorconfigs/AppWithoutMainThread.editorconfig +++ b/doc/editorconfigs/AppWithoutMainThread.editorconfig @@ -6,3 +6,6 @@ dotnet_diagnostic.VSTHRD012.severity = none # VSTHRD003: Avoid awaiting foreign Tasks dotnet_diagnostic.VSTHRD003.severity = none + +# VSTHRD010: Invoke single-threaded types on Main thread +dotnet_diagnostic.VSTHRD010.severity = none From 58c98c495b2c771f56d5587b9945ca6e1a66eecf Mon Sep 17 00:00:00 2001 From: Andrii Tretiak Date: Tue, 7 Apr 2026 10:57:12 -0700 Subject: [PATCH 1614/1753] Remove usage of old NuGet tools (#496) * Remove usage of old NuGet tools * Add source for procdump package * Add feed for getting Microsoft.DiaSymReader.Pdb2Pdb * try Copilot suggested fixes * Add pre-release support --- init.ps1 | 14 +++++++------- tools/Convert-PDB.ps1 | 22 ++++++++++++---------- tools/Download-NuGetPackage.ps1 | 4 +++- 3 files changed, 22 insertions(+), 18 deletions(-) diff --git a/init.ps1 b/init.ps1 index 8bb78ad8f..9c62b5e78 100755 --- a/init.ps1 +++ b/init.ps1 @@ -126,40 +126,40 @@ try { } } - $InstallNuGetPkgScriptPath = "$PSScriptRoot\tools\Install-NuGetPackage.ps1" + $DownloadNuGetPkgScriptPath = "$PSScriptRoot\tools\Download-NuGetPackage.ps1" $nugetVerbosity = 'quiet' if ($Verbose) { $nugetVerbosity = 'normal' } $MicroBuildPackageSource = 'https://pkgs.dev.azure.com/devdiv/_packaging/MicroBuildToolset%40Local/nuget/v3/index.json' if ($Signing) { Write-Host "Installing MicroBuild signing plugin" -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Signing -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.Signing -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['SignType'] = "Test" } if ($Setup) { Write-Host "Installing MicroBuild SwixBuild plugin..." -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath Microsoft.VisualStudioEng.MicroBuild.Plugins.SwixBuild -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $DownloadNuGetPkgScriptPath -PackageId Microsoft.VisualStudioEng.MicroBuild.Plugins.SwixBuild -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity } if ($OptProf) { Write-Host "Installing MicroBuild OptProf plugin" -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath MicroBuild.Plugins.OptProf -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.OptProf -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['OptProfEnabled'] = '1' } if ($Localization) { Write-Host "Installing MicroBuild localization plugin" -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Localization -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.Localization -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['LocType'] = "Pseudo" $EnvVars['LocLanguages'] = "JPN" } if ($SBOM) { Write-Host "Installing MicroBuild SBOM plugin" -ForegroundColor $HeaderColor - & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Sbom -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.Sbom -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity # The feed with the latest versions of the tool is at 'https://1essharedassets.pkgs.visualstudio.com/1esPkgs/_packaging/SBOMTool/nuget/v3/index.json', # but we'll use the feed that the SBOM task itself uses to install the tool for consistency. - $PkgMicrosoft_ManifestTool_CrossPlatform = & $InstallNuGetPkgScriptPath Microsoft.ManifestTool.CrossPlatform -source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $PkgMicrosoft_ManifestTool_CrossPlatform = & $DownloadNuGetPkgScriptPath -PackageId Microsoft.ManifestTool.CrossPlatform -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['GenerateSBOM'] = "true" $EnvVars['PkgMicrosoft_ManifestTool_CrossPlatform'] = $PkgMicrosoft_ManifestTool_CrossPlatform } diff --git a/tools/Convert-PDB.ps1 b/tools/Convert-PDB.ps1 index 7e1303a2a..ad0079964 100644 --- a/tools/Convert-PDB.ps1 +++ b/tools/Convert-PDB.ps1 @@ -10,11 +10,11 @@ #> [CmdletBinding()] Param( - [Parameter(Mandatory=$true,Position=0)] + [Parameter(Mandatory = $true, Position = 0)] [string]$DllPath, [Parameter()] [string]$PdbPath, - [Parameter(Mandatory=$true,Position=1)] + [Parameter(Mandatory = $true, Position = 1)] [string]$OutputPath ) @@ -25,24 +25,26 @@ if ($IsMacOS -or $IsLinux) { $version = '1.1.0-beta2-21101-01' $baseDir = "$PSScriptRoot/../obj/tools" -$pdb2pdbpath = "$baseDir/Microsoft.DiaSymReader.Pdb2Pdb.$version/tools/Pdb2Pdb.exe" +$pdb2pdbpath = "$baseDir/microsoft.diasymreader.pdb2pdb/$version/tools/Pdb2Pdb.exe" if (-not (Test-Path $pdb2pdbpath)) { if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } $baseDir = (Resolve-Path $baseDir).Path # Normalize it - Write-Verbose "& (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json | Out-Null" # This package originally comes from the https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json feed. # Add this feed as an upstream to whatever feed is in nuget.config if this step fails. - & (& $PSScriptRoot/Get-NuGetTool.ps1) install Microsoft.DiaSymReader.Pdb2Pdb -version $version -PackageSaveMode nuspec -OutputDirectory $baseDir | Out-Null - if ($LASTEXITCODE -ne 0) { + try { + & "$PSScriptRoot/Download-NuGetPackage.ps1" -PackageId Microsoft.DiaSymReader.Pdb2Pdb -Version $version -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json -OutputDirectory $baseDir | Out-Null + } + catch { Write-Error "Failed to install Microsoft.DiaSymReader.Pdb2Pdb. Consider adding https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json as an upstream to your nuget.config feed." return } + $pdb2pdbpath = "$baseDir/microsoft.diasymreader.pdb2pdb/$version/tools/Pdb2Pdb.exe" } -$args = $DllPath,'/out',$OutputPath,'/nowarn','0021' +$arguments = $DllPath, '/out', $OutputPath, '/nowarn', '0021' if ($PdbPath) { - $args += '/pdb',$PdbPath + $arguments += '/pdb', $PdbPath } -Write-Verbose "$pdb2pdbpath $args" -& $pdb2pdbpath $args +Write-Verbose "$pdb2pdbpath $arguments" +& $pdb2pdbpath $arguments diff --git a/tools/Download-NuGetPackage.ps1 b/tools/Download-NuGetPackage.ps1 index 924b9edf4..ce31167ab 100644 --- a/tools/Download-NuGetPackage.ps1 +++ b/tools/Download-NuGetPackage.ps1 @@ -42,14 +42,16 @@ if ($Version) { $packageArg = "$PackageId@$Version" } $extraArgs = @() if ($Source) { $extraArgs += '--source', $Source } +if ($Version -and $Version -match '-') { $extraArgs += '--prerelease' } $prevErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Continue' -& dotnet package download $packageArg --configfile $ConfigFile --output $OutputDirectory --verbosity $Verbosity @extraArgs 2>&1 | Out-Null +$downloadOutput = & dotnet package download $packageArg --configfile $ConfigFile --output $OutputDirectory --verbosity $Verbosity @extraArgs 2>&1 $downloadExitCode = $LASTEXITCODE $ErrorActionPreference = $prevErrorActionPreference if ($downloadExitCode -ne 0) { + $downloadOutput | Write-Host throw "Failed to download package $packageArg (exit code $downloadExitCode)." } From 8075c3f022308d59a585976a8864837f833e4cf5 Mon Sep 17 00:00:00 2001 From: Andrey Tretyak Date: Tue, 7 Apr 2026 11:08:33 -0700 Subject: [PATCH 1615/1753] Use default configuration for Network Isolation --- azure-pipelines/archive-sourcecode.yml | 2 -- azure-pipelines/libtemplate-update.yml | 2 -- azure-pipelines/official.yml | 2 -- azure-pipelines/release.yml | 2 -- azure-pipelines/unofficial.yml | 2 -- azure-pipelines/vs-insertion.yml | 2 -- azure-pipelines/vs-validation.yml | 2 -- 7 files changed, 14 deletions(-) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 84b70ec37..211881fa7 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -35,8 +35,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index 6d0051a05..384be7cfc 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -30,8 +30,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: name: AzurePipelines-EO diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 9f0a89d8e..22a5d6a33 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -45,8 +45,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable codeSignValidation: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 5824b0a74..edc565290 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -20,8 +20,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 47a2a2e29..36aaf6e50 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -55,8 +55,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 22481c971..f1a257684 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -22,8 +22,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable sbom: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index f62373132..5e5438635 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -26,8 +26,6 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: - settings: - networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: From dee711b126050a090c72ea2c70dbbe9b0dfe2ea0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 10 Apr 2026 06:58:17 -0600 Subject: [PATCH 1616/1753] Bump MicroBuildVersion to 2.0.226 --- .github/prompts/update-library-template.prompt.md | 6 ++++++ Directory.Packages.props | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/prompts/update-library-template.prompt.md b/.github/prompts/update-library-template.prompt.md index f9fe67209..13eb2bd46 100644 --- a/.github/prompts/update-library-template.prompt.md +++ b/.github/prompts/update-library-template.prompt.md @@ -37,6 +37,12 @@ The `test/Library.Tests/Library.Tests.csproj` file is very typical of this. Changes to this file should very typically be applied to any and all test projects in the repo. You are responsible for doing this in addition to re-deleting this template file. +## Updating package and SDK versions + +After the merge, always check global.json for MSBuild Sdks with names starting with `Microsoft.VisualStudio.Internal.MicroBuild`. +These SDK versions should match the value of the `MicroBuildVersion` property found in `Directory.Packages.props`. +Always take the latest of the versions you see among these SDKs and the `MicroBuildVersion` property. + ## Validation Validate the merge result (after resolving any conflicts, if applicable). diff --git a/Directory.Packages.props b/Directory.Packages.props index e8e064419..67ad6cdf1 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,7 +6,7 @@ true 2.2.1 - 2.0.208 + 2.0.226 From 29fe9fa1b192031e937f30983c0516a97eb7830b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 10 Apr 2026 10:02:50 -0600 Subject: [PATCH 1617/1753] Update dependency nerdbank.dotnetrepotools to v1.3.1 (#501) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index b38002439..881a5808d 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.2.1", + "version": "1.3.1", "commands": [ "repo" ], From 5732a7ff7e49d2703433c16902f7c3414dc36a39 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 10 Apr 2026 15:18:33 -0600 Subject: [PATCH 1618/1753] Update mcr.microsoft.com/dotnet/sdk:10.0.201 Docker digest to 127d7d4 (502) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 14b064da3..063dac8fc 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.201@sha256:f061e5a7532b36fa1d1b684857fe1f504ba92115b9934f154643266613c44c62 +FROM mcr.microsoft.com/dotnet/sdk:10.0.201@sha256:127d7d4d601ae26b8e04c54efb37e9ce8766931bded0ee59fcd799afd21d6850 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From 1d433b85cc2e40b2f4d25d33c471b1defbae5a99 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 10 Apr 2026 21:22:18 +0000 Subject: [PATCH 1619/1753] Update actions/upload-artifact action to v7.0.1 (503) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/actions/publish-artifacts/action.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/actions/publish-artifacts/action.yaml b/.github/actions/publish-artifacts/action.yaml index 9982cf18e..87b2f9c03 100644 --- a/.github/actions/publish-artifacts/action.yaml +++ b/.github/actions/publish-artifacts/action.yaml @@ -14,46 +14,46 @@ runs: - name: 📢 Upload project.assets.json files if: always() - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: projectAssetsJson-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/projectAssetsJson continue-on-error: true - name: 📢 Upload variables - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: variables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/Variables continue-on-error: true - name: 📢 Upload build_logs if: always() - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: build_logs-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/build_logs continue-on-error: true - name: 📢 Upload testResults if: always() - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: testResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/testResults continue-on-error: true - name: 📢 Upload coverageResults if: always() - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: coverageResults-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/coverageResults continue-on-error: true - name: 📢 Upload symbols - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: symbols-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/symbols continue-on-error: true - name: 📢 Upload deployables - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: deployables-${{ runner.os }} path: ${{ runner.temp }}/_artifacts/deployables From ab3f99d1213957a7477df43bfa7b636b669827d2 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 10 Apr 2026 21:25:09 +0000 Subject: [PATCH 1620/1753] Update actions/upload-pages-artifact action to v5 (504) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e19cf640f..fbfcd1440 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -34,7 +34,7 @@ jobs: name: 📚 Generate documentation - name: Upload artifact - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4 + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 with: path: docfx/_site From 7163e58259613ed4cca79f1598393cb27211ae2d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 11 Apr 2026 07:09:31 -0600 Subject: [PATCH 1621/1753] Update dependency nerdbank.dotnetrepotools to v1.3.13 (505) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 881a5808d..130ff5eb8 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.3.1", + "version": "1.3.13", "commands": [ "repo" ], From 41a316f44b16c38ff23b1bb00b14b211fd631fe7 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 06:56:08 -0600 Subject: [PATCH 1622/1753] Update Dockerfile and global.json updates to v10.0.202 (506) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 063dac8fc..6e0c04523 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.201@sha256:127d7d4d601ae26b8e04c54efb37e9ce8766931bded0ee59fcd799afd21d6850 +FROM mcr.microsoft.com/dotnet/sdk:10.0.202@sha256:adc02be8b87957d07208a4a3e51775935b33bad3317de8c45b1e67357b4c073b # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index c331692b9..8f4695913 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.201", + "version": "10.0.202", "rollForward": "patch", "allowPrerelease": false }, From 863f9e1844b4067746bc2a337115d6b07cf59f41 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 07:45:12 -0600 Subject: [PATCH 1623/1753] Throw on Download-NuGetPackage errors Instead of writing an error and returning `$null` to the caller, we should do something that's harder to ignore. --- tools/Download-NuGetPackage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Download-NuGetPackage.ps1 b/tools/Download-NuGetPackage.ps1 index 924b9edf4..760ac90ff 100644 --- a/tools/Download-NuGetPackage.ps1 +++ b/tools/Download-NuGetPackage.ps1 @@ -73,5 +73,5 @@ if ($Version) { if ($packageDir -and (Test-Path $packageDir)) { Write-Output $packageDir } else { - Write-Error "Package directory not found after download." + throw "Package directory not found after download. PackageId='$PackageId'; Version='$Version'; OutputDirectory='$OutputDirectory'; PackageRoot='$packageRoot'." } From a8db2fc2f8a72d68a9b1df8255180fa32e0d35f9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:04:29 -0600 Subject: [PATCH 1624/1753] Rename variable for better consistency --- tools/artifacts/VSInsertion.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/artifacts/VSInsertion.ps1 b/tools/artifacts/VSInsertion.ps1 index 2858f7f22..32d35dff3 100644 --- a/tools/artifacts/VSInsertion.ps1 +++ b/tools/artifacts/VSInsertion.ps1 @@ -39,9 +39,9 @@ if (Test-Path $VsixPackages) { } if ($InsertionOutputs -and $env:PROFILINGINPUTSPROPSNAME) { - $InsertOutputsProfilingInputs = Join-Path $InsertionOutputs $env:PROFILINGINPUTSPROPSNAME - if (Test-Path -LiteralPath $InsertOutputsProfilingInputs) { - $result[$InsertionOutputs] = Get-ChildItem -LiteralPath $InsertOutputsProfilingInputs # OptProf ProfilingInputs + $InsertionOutputsProfilingInputs = Join-Path $InsertionOutputs $env:PROFILINGINPUTSPROPSNAME + if (Test-Path -LiteralPath $InsertionOutputsProfilingInputs) { + $result[$InsertionOutputs] = Get-ChildItem -LiteralPath $InsertionOutputsProfilingInputs # OptProf ProfilingInputs } } From b83fca49232d18bcecd7c1ce472f93f2fb422c85 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:04:45 -0600 Subject: [PATCH 1625/1753] Defend against exceptions thrown from `Download-NugetPackage.ps1` --- tools/Get-ExternalSymbolFiles.ps1 | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 481e7a12a..9cd78a28c 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -28,7 +28,12 @@ Function Get-SymbolsFromPackage($id, $version) { $unzippedPkgPath = Join-Path $symbolPackagesPath "$id.$version" # Download the package from configured feeds (failures are non-fatal for symbol collection) - & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue | Out-Null + try { + & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue | Out-Null + } + catch { + Write-Warning "Failed to download package $id $version from configured feeds. Skipping if not found locally. $($_.Exception.Message)" + } $global:LASTEXITCODE = 0 $nupkgFile = Get-ChildItem -Recurse -Path $symbolPackagesPath -Filter "$id.$version.nupkg" -ErrorAction SilentlyContinue | Select-Object -First 1 if (!$nupkgFile) { From a871231f024b5a7ed3995de8ffac53725574b6e3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:13:56 -0600 Subject: [PATCH 1626/1753] Add missing `dotnet symbol` command to manifest --- .config/dotnet-tools.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 130ff5eb8..9019f11ba 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -36,6 +36,13 @@ "repo" ], "rollForward": false + }, + "dotnet-symbol": { + "version": "10.0.721401", + "commands": [ + "dotnet-symbol" + ], + "rollForward": false } } -} +} \ No newline at end of file From a9956c45aee43ac62ffa29e909e957dbb22dfb62 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:29:20 -0600 Subject: [PATCH 1627/1753] Improve resilience of fetching PackageVersion items --- tools/Get-ExternalSymbolFiles.ps1 | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 9cd78a28c..12ea2b0ba 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -80,9 +80,36 @@ Function Get-SymbolsFromPackage($id, $version) { } } +Function Get-PackageVersions() { + if ($script:PackageVersions) { + return $script:PackageVersions + } + + $propsPath = (Resolve-Path -LiteralPath (Join-Path $PSScriptRoot '..\Directory.Packages.props')).Path + $output = & dotnet build $propsPath -nologo -verbosity:quiet -getItem:PackageVersion 2>&1 + if ($LASTEXITCODE -ne 0) { + Write-Error "Failed to evaluate package versions from Directory.Packages.props.`n$($output | Out-String)" + return @{} + } + + $jsonText = ($output | Out-String).Trim() + $jsonStart = $jsonText.IndexOf('{') + if ($jsonStart -lt 0) { + Write-Error 'Failed to locate JSON output from `dotnet build -getItem:PackageVersion`.' + return @{} + } + + $packageVersions = @{} + foreach ($item in @((ConvertFrom-Json $jsonText.Substring($jsonStart)).Items.PackageVersion)) { + $packageVersions[$item.Identity] = $item.Version + } + + $script:PackageVersions = $packageVersions + $packageVersions +} + Function Get-PackageVersion($id) { - $versionProps = [xml](Get-Content -LiteralPath $PSScriptRoot\..\Directory.Packages.props) - $version = $versionProps.Project.ItemGroup.PackageVersion | ? { $_.Include -eq $id } | % { $_.Version } + $version = Get-PackageVersions | Select-Object -ExpandProperty $id -ErrorAction SilentlyContinue if (!$version) { Write-Error "No package version found in Directory.Packages.props for the package '$id'" } From b9fdfc7adfe5082a17362011c2e637b5e49e746f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:37:29 -0600 Subject: [PATCH 1628/1753] Avoid re-unzipping downloaded symbol packages Get-ExternalSymbolFiles.ps1 was downloading Nerdbank.Streams into obj/SymbolsPackages/nerdbank.streams/2.13.16 via Download-NuGetPackage.ps1, which uses dotnet package download. After that, the script searched for the .nupkg inside that directory and extracted it again into obj/SymbolsPackages/Nerdbank.Streams.2.13.16. That second extraction was redundant and only existed so dotnet symbol and the PDB archival logic had a package root to inspect. The downloaded package directory already contains the package contents in NuGet's normal lowercase layout, so the script can operate on that directory directly. Use the package path returned by Download-NuGetPackage.ps1 for symbol download and PDB discovery, and remove the extra unzip step. This leaves only one materialized package tree under obj/SymbolsPackages. --- tools/Get-ExternalSymbolFiles.ps1 | 31 +++++-------------------------- 1 file changed, 5 insertions(+), 26 deletions(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 12ea2b0ba..87e020fcf 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -4,48 +4,27 @@ $SymbolServers = @( 'https://symbols.nuget.org/download/symbols' ) -Function Unzip($Path, $OutDir) { - $OutDir = (New-Item -ItemType Directory -Path $OutDir -Force).FullName - Add-Type -AssemblyName System.IO.Compression.FileSystem - - # Start by extracting to a temporary directory so that there are no file conflicts. - [System.IO.Compression.ZipFile]::ExtractToDirectory($Path, "$OutDir.out") - - # Now move all files from the temp directory to $OutDir, overwriting any files. - Get-ChildItem -Path "$OutDir.out" -Recurse -File | ForEach-Object { - $destinationPath = Join-Path -Path $OutDir -ChildPath $_.FullName.Substring("$OutDir.out".Length).TrimStart([io.path]::DirectorySeparatorChar, [io.path]::AltDirectorySeparatorChar) - if (!(Test-Path -Path (Split-Path -Path $destinationPath -Parent))) { - New-Item -ItemType Directory -Path (Split-Path -Path $destinationPath -Parent) | Out-Null - } - Move-Item -Path $_.FullName -Destination $destinationPath -Force - } - Remove-Item -Path "$OutDir.out" -Recurse -Force -} - Function Get-SymbolsFromPackage($id, $version) { $symbolPackagesPath = "$PSScriptRoot/../obj/SymbolsPackages" New-Item -ItemType Directory -Path $symbolPackagesPath -Force | Out-Null - $unzippedPkgPath = Join-Path $symbolPackagesPath "$id.$version" + $packagePath = $null # Download the package from configured feeds (failures are non-fatal for symbol collection) try { - & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue | Out-Null + $packagePath = & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue } catch { Write-Warning "Failed to download package $id $version from configured feeds. Skipping if not found locally. $($_.Exception.Message)" } $global:LASTEXITCODE = 0 - $nupkgFile = Get-ChildItem -Recurse -Path $symbolPackagesPath -Filter "$id.$version.nupkg" -ErrorAction SilentlyContinue | Select-Object -First 1 - if (!$nupkgFile) { + if (!$packagePath -or !(Test-Path -LiteralPath $packagePath)) { Write-Warning "Package $id $version not found in configured feeds. Skipping." return } - Unzip -Path $nupkgFile.FullName -OutDir $unzippedPkgPath - # Download symbols for each binary using dotnet-symbol $serverArgs = $SymbolServers | ForEach-Object { '--server-path'; $_ } - $binaries = Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Include *.dll, *.exe + $binaries = Get-ChildItem -Recurse -LiteralPath $packagePath -Include *.dll, *.exe foreach ($binary in $binaries) { $prevErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Continue' @@ -54,7 +33,7 @@ Function Get-SymbolsFromPackage($id, $version) { } # Output pairs of binary + PDB paths for archival - Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Filter *.pdb | % { + Get-ChildItem -Recurse -LiteralPath $packagePath -Filter *.pdb | % { $rootName = Join-Path $_.Directory $_.BaseName if ($rootName.EndsWith('.ni')) { $rootName = $rootName.Substring(0, $rootName.Length - 3) From fd7d87ee2edf99a2500eb0884c5a73f3d671cd1a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:43:36 -0600 Subject: [PATCH 1629/1753] Avoid stomping on LASTEXITCODE while simply trying to reset it --- tools/Get-ExternalSymbolFiles.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 87e020fcf..7bd2c2b70 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -10,13 +10,14 @@ Function Get-SymbolsFromPackage($id, $version) { $packagePath = $null # Download the package from configured feeds (failures are non-fatal for symbol collection) + $previousLastExitCode = $global:LASTEXITCODE try { $packagePath = & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue } catch { Write-Warning "Failed to download package $id $version from configured feeds. Skipping if not found locally. $($_.Exception.Message)" } - $global:LASTEXITCODE = 0 + $global:LASTEXITCODE = $previousLastExitCode if (!$packagePath -or !(Test-Path -LiteralPath $packagePath)) { Write-Warning "Package $id $version not found in configured feeds. Skipping." return From 86ad5cd7a10dd6f20400a9126db34496f15ff94b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 09:05:54 -0600 Subject: [PATCH 1630/1753] Fix init.ps1 installation of local microbuild plugins We need the packages *with their dependencies* to be installed, and only I filed https://github.com/dotnet/sdk/issues/53890 to track this missing feature that requires us to go back to using nuget.exe. --- init.ps1 | 14 +++--- tools/Get-NuGetTool.ps1 | 49 ++++++++++++++++++++ tools/Install-NuGetPackage.ps1 | 85 ++++++++++++++++++++++++++++++++++ 3 files changed, 141 insertions(+), 7 deletions(-) create mode 100644 tools/Get-NuGetTool.ps1 create mode 100644 tools/Install-NuGetPackage.ps1 diff --git a/init.ps1 b/init.ps1 index 9c62b5e78..8bb78ad8f 100755 --- a/init.ps1 +++ b/init.ps1 @@ -126,40 +126,40 @@ try { } } - $DownloadNuGetPkgScriptPath = "$PSScriptRoot\tools\Download-NuGetPackage.ps1" + $InstallNuGetPkgScriptPath = "$PSScriptRoot\tools\Install-NuGetPackage.ps1" $nugetVerbosity = 'quiet' if ($Verbose) { $nugetVerbosity = 'normal' } $MicroBuildPackageSource = 'https://pkgs.dev.azure.com/devdiv/_packaging/MicroBuildToolset%40Local/nuget/v3/index.json' if ($Signing) { Write-Host "Installing MicroBuild signing plugin" -ForegroundColor $HeaderColor - & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.Signing -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Signing -source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['SignType'] = "Test" } if ($Setup) { Write-Host "Installing MicroBuild SwixBuild plugin..." -ForegroundColor $HeaderColor - & $DownloadNuGetPkgScriptPath -PackageId Microsoft.VisualStudioEng.MicroBuild.Plugins.SwixBuild -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $InstallNuGetPkgScriptPath Microsoft.VisualStudioEng.MicroBuild.Plugins.SwixBuild -source $MicroBuildPackageSource -Verbosity $nugetVerbosity } if ($OptProf) { Write-Host "Installing MicroBuild OptProf plugin" -ForegroundColor $HeaderColor - & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.OptProf -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.OptProf -source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['OptProfEnabled'] = '1' } if ($Localization) { Write-Host "Installing MicroBuild localization plugin" -ForegroundColor $HeaderColor - & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.Localization -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Localization -source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['LocType'] = "Pseudo" $EnvVars['LocLanguages'] = "JPN" } if ($SBOM) { Write-Host "Installing MicroBuild SBOM plugin" -ForegroundColor $HeaderColor - & $DownloadNuGetPkgScriptPath -PackageId MicroBuild.Plugins.Sbom -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity + & $InstallNuGetPkgScriptPath MicroBuild.Plugins.Sbom -source $MicroBuildPackageSource -Verbosity $nugetVerbosity # The feed with the latest versions of the tool is at 'https://1essharedassets.pkgs.visualstudio.com/1esPkgs/_packaging/SBOMTool/nuget/v3/index.json', # but we'll use the feed that the SBOM task itself uses to install the tool for consistency. - $PkgMicrosoft_ManifestTool_CrossPlatform = & $DownloadNuGetPkgScriptPath -PackageId Microsoft.ManifestTool.CrossPlatform -Source $MicroBuildPackageSource -Verbosity $nugetVerbosity + $PkgMicrosoft_ManifestTool_CrossPlatform = & $InstallNuGetPkgScriptPath Microsoft.ManifestTool.CrossPlatform -source $MicroBuildPackageSource -Verbosity $nugetVerbosity $EnvVars['GenerateSBOM'] = "true" $EnvVars['PkgMicrosoft_ManifestTool_CrossPlatform'] = $PkgMicrosoft_ManifestTool_CrossPlatform } diff --git a/tools/Get-NuGetTool.ps1 b/tools/Get-NuGetTool.ps1 new file mode 100644 index 000000000..e50759649 --- /dev/null +++ b/tools/Get-NuGetTool.ps1 @@ -0,0 +1,49 @@ +<# +.SYNOPSIS + Downloads the NuGet.exe tool and returns the path to it. +.PARAMETER NuGetVersion + The version of the NuGet tool to acquire. +#> +Param( + [Parameter()] + [string]$NuGetVersion='7.3.1' +) + +function Test-NuGetExecutableSignature { + Param( + [Parameter(Mandatory=$true)] + [string]$Path + ) + + if (!(Test-Path $Path)) { + return $false + } + + $signature = Get-AuthenticodeSignature -FilePath $Path + if ($signature.Status -eq [System.Management.Automation.SignatureStatus]::Valid -and + $null -ne $signature.SignerCertificate -and + $signature.SignerCertificate.Subject -like '*CN=Microsoft Corporation*') { + Write-Verbose "NuGet executable signature is valid." + return $true + } + + Write-Verbose "NuGet executable signature is invalid." + return $false +} + +$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1" +$binaryToolsPath = Join-Path $toolsPath $NuGetVersion +if (!(Test-Path $binaryToolsPath)) { $null = mkdir $binaryToolsPath } +$nugetPath = Join-Path $binaryToolsPath nuget.exe + +if (!(Test-Path $nugetPath) -or -not (Test-NuGetExecutableSignature -Path $nugetPath)) { + Write-Host "Downloading nuget.exe $NuGetVersion..." -ForegroundColor Yellow + (New-Object System.Net.WebClient).DownloadFile("https://dist.nuget.org/win-x86-commandline/v$NuGetVersion/NuGet.exe", $nugetPath) + + if (!(Test-NuGetExecutableSignature -Path $nugetPath)) { + Remove-Item $nugetPath -Force -ErrorAction SilentlyContinue + throw "Downloaded nuget.exe $NuGetVersion failed Authenticode signature validation." + } +} + +return (Resolve-Path $nugetPath).Path diff --git a/tools/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 new file mode 100644 index 000000000..42ad12370 --- /dev/null +++ b/tools/Install-NuGetPackage.ps1 @@ -0,0 +1,85 @@ +<# +.SYNOPSIS + Installs a NuGet package. +.PARAMETER PackageID + The Package ID to install. +.PARAMETER Version + The version of the package to install. If unspecified, the latest stable release is installed. +.PARAMETER Source + The package source feed to find the package to install from. +.PARAMETER Prerelease + Include prerelease packages when searching for the latest version. +.PARAMETER ExcludeVersion + Installs the package without adding the version to the folder name. +.PARAMETER DirectDownload + Bypass the local cache when downloading packages. +.PARAMETER PackagesDir + The directory to install the package to. By default, it uses the Packages folder at the root of the repo. +.PARAMETER ConfigFile + The nuget.config file to use. By default, it uses :/nuget.config. +.OUTPUTS + System.String. The path to the installed package. +#> +[CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Low')] +Param( + [Parameter(Position=1,Mandatory=$true)] + [string]$PackageId, + [Parameter()] + [string]$Version, + [Parameter()] + [string]$Source, + [Parameter()] + [switch]$Prerelease, + [Parameter()] + [switch]$ExcludeVersion, + [Parameter()] + [switch]$DirectDownload, + [Parameter()] + [string]$PackagesDir="$PSScriptRoot\..\packages", + [Parameter()] + [string]$ConfigFile="$PSScriptRoot\..\nuget.config", + [Parameter()] + [ValidateSet('Quiet','Normal','Detailed')] + [string]$Verbosity='normal' +) + +$nugetPath = & "$PSScriptRoot\Get-NuGetTool.ps1" + +Write-Verbose "Installing $PackageId..." +$nugetArgs = "Install",$PackageId,"-OutputDirectory",$PackagesDir,'-ConfigFile',$ConfigFile +if ($Version) { $nugetArgs += "-Version",$Version } +if ($Source) { $nugetArgs += "-FallbackSource",$Source } +if ($Prerelease) { $nugetArgs += "-Prerelease" } +if ($ExcludeVersion) { $nugetArgs += '-ExcludeVersion' } +if ($DirectDownload) { $nugetArgs += '-DirectDownload' } +$nugetArgs += '-Verbosity',$Verbosity + +if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { + $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru + if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { + throw "NuGet install failed for package '$PackageId' (version '$requestedVersion') with exit code $exitCode." + } +} + +# Provide the path to the installed package directory to our caller. +if ($ExcludeVersion) { + $packageDir = Get-ChildItem -Path $PackagesDir -Directory -ErrorAction SilentlyContinue | + Where-Object { $_.Name -ieq $PackageId } | + Select-Object -First 1 +} elseif ($Version) { + $expectedDirectoryName = "$PackageId.$Version" + $packageDir = Get-ChildItem -Path $PackagesDir -Directory -ErrorAction SilentlyContinue | + Where-Object { $_.Name -ieq $expectedDirectoryName } | + Select-Object -First 1 +} else { + $packageDir = Get-ChildItem -Path $PackagesDir -Directory -ErrorAction SilentlyContinue | + Where-Object { $_.Name -like "$PackageId.*" } | + Sort-Object -Property LastWriteTimeUtc -Descending | + Select-Object -First 1 +} + +if ($packageDir -and (Test-Path -Path $packageDir.FullName -PathType Container)) { + Write-Output $packageDir.FullName +} else { + throw "Installed package directory not found. PackageId='$PackageId'; Version='$Version'; ExcludeVersion='$ExcludeVersion'; PackagesDir='$PackagesDir'." +} From 1f9ec2408cc6330ba466441fbb181dc5845c4899 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 09:25:31 -0600 Subject: [PATCH 1631/1753] Don't download a nuget package twice --- tools/Download-NuGetPackage.ps1 | 14 +++++++++++--- tools/Get-ProcDump.ps1 | 9 +-------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/tools/Download-NuGetPackage.ps1 b/tools/Download-NuGetPackage.ps1 index 8104b921e..6eef937f8 100644 --- a/tools/Download-NuGetPackage.ps1 +++ b/tools/Download-NuGetPackage.ps1 @@ -37,6 +37,17 @@ if (!(Test-Path $OutputDirectory)) { New-Item -ItemType Directory -Path $OutputD $OutputDirectory = (Resolve-Path $OutputDirectory).Path $ConfigFile = (Resolve-Path $ConfigFile).Path +$packageIdLower = $PackageId.ToLower() +$packageRoot = Join-Path $OutputDirectory $packageIdLower + +if ($Version) { + $predictedPackageDir = Join-Path $packageRoot $Version + if (Test-Path -Path $predictedPackageDir -PathType Container) { + Write-Output (Resolve-Path $predictedPackageDir).Path + return + } +} + $packageArg = $PackageId if ($Version) { $packageArg = "$PackageId@$Version" } @@ -56,16 +67,13 @@ if ($downloadExitCode -ne 0) { } # Return the path to the downloaded package directory (dotnet package download uses lowercase id) -$packageIdLower = $PackageId.ToLower() if ($Version) { - $packageRoot = Join-Path $OutputDirectory $packageIdLower $packageDir = Get-ChildItem -Path $packageRoot -Directory -ErrorAction SilentlyContinue | Where-Object { $_.Name -ieq $Version } | Select-Object -First 1 if ($packageDir) { $packageDir = $packageDir.FullName } } else { # When no version is specified, pick the most recently written version directory. - $packageRoot = Join-Path $OutputDirectory $packageIdLower $packageDir = Get-ChildItem -Path $packageRoot -Directory -ErrorAction SilentlyContinue | Sort-Object -Property LastWriteTimeUtc -Descending | Select-Object -First 1 diff --git a/tools/Get-ProcDump.ps1 b/tools/Get-ProcDump.ps1 index 8b1f7d1e7..9d9bcd8d6 100644 --- a/tools/Get-ProcDump.ps1 +++ b/tools/Get-ProcDump.ps1 @@ -2,11 +2,4 @@ .SYNOPSIS Downloads 32-bit and 64-bit procdump executables and returns the path to where they were installed. #> -$version = '0.0.1' -$baseDir = "$PSScriptRoot\..\obj\tools" -$procDumpToolPath = "$baseDir\procdump\$version\bin" -if (-not (Test-Path $procDumpToolPath)) { - & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId procdump -Version $version -OutputDirectory $baseDir | Out-Null -} - -(Resolve-Path $procDumpToolPath).Path +Join-Path (& "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId procdump -Version 0.0.1) 'bin' From f1de0ce66c2ffacb6ed6eaf2e324053d513cd110 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 09:31:24 -0600 Subject: [PATCH 1632/1753] Don't assume unpacked structure in Convert-PDB.ps1 --- tools/Convert-PDB.ps1 | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/tools/Convert-PDB.ps1 b/tools/Convert-PDB.ps1 index ad0079964..d1d0e888d 100644 --- a/tools/Convert-PDB.ps1 +++ b/tools/Convert-PDB.ps1 @@ -23,28 +23,25 @@ if ($IsMacOS -or $IsLinux) { return } -$version = '1.1.0-beta2-21101-01' -$baseDir = "$PSScriptRoot/../obj/tools" -$pdb2pdbpath = "$baseDir/microsoft.diasymreader.pdb2pdb/$version/tools/Pdb2Pdb.exe" -if (-not (Test-Path $pdb2pdbpath)) { - if (-not (Test-Path $baseDir)) { New-Item -Type Directory -Path $baseDir | Out-Null } - $baseDir = (Resolve-Path $baseDir).Path # Normalize it - # This package originally comes from the https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json feed. - # Add this feed as an upstream to whatever feed is in nuget.config if this step fails. - try { - & "$PSScriptRoot/Download-NuGetPackage.ps1" -PackageId Microsoft.DiaSymReader.Pdb2Pdb -Version $version -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json -OutputDirectory $baseDir | Out-Null - } - catch { - Write-Error "Failed to install Microsoft.DiaSymReader.Pdb2Pdb. Consider adding https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json as an upstream to your nuget.config feed." - return - } - $pdb2pdbpath = "$baseDir/microsoft.diasymreader.pdb2pdb/$version/tools/Pdb2Pdb.exe" +# This package originally comes from the https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json feed. +# Add this feed as an upstream to whatever feed is in nuget.config if this step fails. +$packageID = 'Microsoft.DiaSymReader.Pdb2Pdb' +$packageVersion = '1.1.0-beta2-21101-01' +try { + $pdb2pdbpath = & "$PSScriptRoot/Download-NuGetPackage.ps1" -PackageId $packageID -Version $packageVersion -Source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json } +catch { + Write-Error "Failed to install $packageID. Consider adding https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json as an upstream to your nuget.config feed." + return +} + +New-Item -ItemType Directory -Force -Path (Split-Path $OutputPath -Parent) | Out-Null +$toolpath = "$pdb2pdbpath/tools/Pdb2Pdb.exe" $arguments = $DllPath, '/out', $OutputPath, '/nowarn', '0021' if ($PdbPath) { $arguments += '/pdb', $PdbPath } -Write-Verbose "$pdb2pdbpath $arguments" -& $pdb2pdbpath $arguments +Write-Verbose "$toolpath $arguments" +& $toolpath $arguments From cb09f6d198e462eb190d2d8dbfeaf94155ca0484 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 09:41:47 -0600 Subject: [PATCH 1633/1753] Improve `dotnet symbol` performance We can invoke it just once with all the binaries we want symbols for. --- tools/Get-ExternalSymbolFiles.ps1 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 7bd2c2b70..257f2f495 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -25,11 +25,11 @@ Function Get-SymbolsFromPackage($id, $version) { # Download symbols for each binary using dotnet-symbol $serverArgs = $SymbolServers | ForEach-Object { '--server-path'; $_ } - $binaries = Get-ChildItem -Recurse -LiteralPath $packagePath -Include *.dll, *.exe - foreach ($binary in $binaries) { + $binaries = @(Get-ChildItem -Recurse -LiteralPath $packagePath -Include *.dll, *.exe) + if ($binaries) { $prevErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Continue' - & dotnet symbol --symbols @serverArgs --output $binary.DirectoryName $binary.FullName 2>&1 | Out-Null + & dotnet symbol --symbols @serverArgs @($binaries.FullName) 2>&1 | Out-Null $ErrorActionPreference = $prevErrorActionPreference } From fdd1b12dcbc401f987a99636bde411f6651c4ae9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 10:15:12 -0600 Subject: [PATCH 1634/1753] Call out when package versions are missing --- tools/Get-ExternalSymbolFiles.ps1 | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 257f2f495..8e6d42db3 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -1,3 +1,7 @@ +[CmdletBinding(SupportsShouldProcess = $true)] +Param ( +) + # Symbol servers to search for PDBs, in order of priority. $SymbolServers = @( 'https://msdl.microsoft.com/download/symbols' @@ -106,6 +110,9 @@ $1stPartyPackageIds = @() $1stPartyPackageIds | % { $version = Get-PackageVersion $_ if ($version) { + Write-Verbose "Downloading symbols for package '$_' version '$version'." Get-SymbolsFromPackage -id $_ -version $version + } else { + Write-Warning "No version found for package '$_'. Skipping symbol download." } } From 3453297682586e443862305a0ff68bfb5a5327ba Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 10:34:43 -0600 Subject: [PATCH 1635/1753] Use `dotnet-symbols` 9.0.661903 (the latest public version) --- .config/dotnet-tools.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9019f11ba..5ebc2dcbd 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -38,11 +38,11 @@ "rollForward": false }, "dotnet-symbol": { - "version": "10.0.721401", + "version": "9.0.661903", "commands": [ "dotnet-symbol" ], "rollForward": false } } -} \ No newline at end of file +} From 6fd4c225f77977cc1194497078540ccb33351e7b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 10:48:15 -0600 Subject: [PATCH 1636/1753] Fix references to undefined variables --- tools/Install-NuGetPackage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Install-NuGetPackage.ps1 b/tools/Install-NuGetPackage.ps1 index 42ad12370..30e9c4fae 100644 --- a/tools/Install-NuGetPackage.ps1 +++ b/tools/Install-NuGetPackage.ps1 @@ -57,7 +57,7 @@ $nugetArgs += '-Verbosity',$Verbosity if ($PSCmdlet.ShouldProcess($PackageId, 'nuget install')) { $p = Start-Process $nugetPath $nugetArgs -NoNewWindow -Wait -PassThru if ($null -ne $p.ExitCode -and $p.ExitCode -ne 0) { - throw "NuGet install failed for package '$PackageId' (version '$requestedVersion') with exit code $exitCode." + throw "NuGet install failed for package '$PackageId' (version '$Version') with exit code $($p.ExitCode)." } } From 710ab015903ef1e1a2dc334cb616652c388c07c7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 10:50:46 -0600 Subject: [PATCH 1637/1753] Simplify ps1 syntax The old way worked, but copilot reviews kept flagging it as wrong anyway. So we're just appeasing it. --- tools/Get-ExternalSymbolFiles.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 8e6d42db3..7b498af58 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -93,7 +93,7 @@ Function Get-PackageVersions() { } Function Get-PackageVersion($id) { - $version = Get-PackageVersions | Select-Object -ExpandProperty $id -ErrorAction SilentlyContinue + $version = (Get-PackageVersions)[$id] if (!$version) { Write-Error "No package version found in Directory.Packages.props for the package '$id'" } From 5c12a14ff4648586cdd85b0c309f63958d97a75d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 10:57:01 -0600 Subject: [PATCH 1638/1753] Defend against filename-only output paths --- tools/Convert-PDB.ps1 | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tools/Convert-PDB.ps1 b/tools/Convert-PDB.ps1 index d1d0e888d..d4e548a34 100644 --- a/tools/Convert-PDB.ps1 +++ b/tools/Convert-PDB.ps1 @@ -35,7 +35,10 @@ catch { return } -New-Item -ItemType Directory -Force -Path (Split-Path $OutputPath -Parent) | Out-Null +$outputDirectory = Split-Path $OutputPath -Parent +if ($outputDirectory) { + New-Item -ItemType Directory -Force -Path $outputDirectory | Out-Null +} $toolpath = "$pdb2pdbpath/tools/Pdb2Pdb.exe" $arguments = $DllPath, '/out', $OutputPath, '/nowarn', '0021' From b2635644c1820f1b80660c272e7f45c58d1dcc59 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 11:09:18 -0600 Subject: [PATCH 1639/1753] Fix foreground thread leak in AsyncCrossProcessMutex causing test host exit failure The AsyncCrossProcessMutex dedicated owner thread was created as a foreground thread, which prevents the process from exiting when the mutex is not disposed. Two tests (EnterAsync_Contested, TryEnterAsync_Contested) created secondary mutex instances without disposing them, leaving foreground threads alive after the test suite finished. The xunit v3 / MTP v2 test host detects this and force-kills the process with a non-zero exit code, producing the non-deterministic CI failure. Changes: - Mark the mutex owner thread as IsBackground = true so an undisposed instance cannot keep the process alive. - Add missing 'using' declarations for secondary mutex instances in the two contested-lock tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../AsyncCrossProcessMutex.cs | 1 + .../AsyncCrossProcessMutexTests.cs | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs b/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs index 599d66d76..612656fc1 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncCrossProcessMutex.cs @@ -56,6 +56,7 @@ public AsyncCrossProcessMutex(string name) Requires.NotNullOrEmpty(name); this.namedMutexOwner = new Thread(this.MutexOwnerThread, 256 * 1024) { + IsBackground = true, Name = $"{nameof(AsyncCrossProcessMutex)}-{name}", }; this.mutex = new Mutex(false, name); diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs index 8872ad9aa..409769123 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs @@ -72,7 +72,7 @@ public async Task TryEnterAsync_Reentrancy() public async Task EnterAsync_Contested() { // We don't allow attempted reentrancy, so create a new mutex object to use for the contested locks. - AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); + using AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); // Acquire and hold the mutex so that we can test timeout behavior. using (AsyncCrossProcessMutex.LockReleaser releaser = await this.mutex.EnterAsync()) @@ -95,7 +95,7 @@ public async Task EnterAsync_Contested() public async Task TryEnterAsync_Contested() { // We don't allow attempted reentrancy, so create a new mutex object to use for the contested locks. - AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); + using AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); // Acquire and hold the mutex so that we can test timeout behavior. using (AsyncCrossProcessMutex.LockReleaser? releaser = await this.mutex.TryEnterAsync(Timeout.InfiniteTimeSpan)) From 4738c2bc518d06f21320c5cf24a151eba680e8d0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 11:14:04 -0600 Subject: [PATCH 1640/1753] Drop `SupportsShouldProcess` from `Get-ExternalSymbolFiles.ps1` --- tools/Get-ExternalSymbolFiles.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index 7b498af58..e9f832079 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -1,4 +1,4 @@ -[CmdletBinding(SupportsShouldProcess = $true)] +[CmdletBinding()] Param ( ) From 44ed582605a7de4c2a9b6d783a4b01402c1542b6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 11:15:25 -0600 Subject: [PATCH 1641/1753] Use `dotnet msbuild` for `-getItem` parameters --- tools/Get-ExternalSymbolFiles.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/Get-ExternalSymbolFiles.ps1 b/tools/Get-ExternalSymbolFiles.ps1 index e9f832079..c5dbfd3c3 100644 --- a/tools/Get-ExternalSymbolFiles.ps1 +++ b/tools/Get-ExternalSymbolFiles.ps1 @@ -70,7 +70,7 @@ Function Get-PackageVersions() { } $propsPath = (Resolve-Path -LiteralPath (Join-Path $PSScriptRoot '..\Directory.Packages.props')).Path - $output = & dotnet build $propsPath -nologo -verbosity:quiet -getItem:PackageVersion 2>&1 + $output = & dotnet msbuild $propsPath -nologo -verbosity:quiet -getItem:PackageVersion 2>&1 if ($LASTEXITCODE -ne 0) { Write-Error "Failed to evaluate package versions from Directory.Packages.props.`n$($output | Out-String)" return @{} @@ -79,7 +79,7 @@ Function Get-PackageVersions() { $jsonText = ($output | Out-String).Trim() $jsonStart = $jsonText.IndexOf('{') if ($jsonStart -lt 0) { - Write-Error 'Failed to locate JSON output from `dotnet build -getItem:PackageVersion`.' + Write-Error 'Failed to locate JSON output from `dotnet msbuild -getItem:PackageVersion`.' return @{} } From e62e0e7015c618884b509507fb13dd78d1f2aa0f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 11:16:14 -0600 Subject: [PATCH 1642/1753] Use -LiteralPath where appropriate --- tools/Get-NuGetTool.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Get-NuGetTool.ps1 b/tools/Get-NuGetTool.ps1 index e50759649..088c5f307 100644 --- a/tools/Get-NuGetTool.ps1 +++ b/tools/Get-NuGetTool.ps1 @@ -15,7 +15,7 @@ function Test-NuGetExecutableSignature { [string]$Path ) - if (!(Test-Path $Path)) { + if (!(Test-Path -LiteralPath $Path)) { return $false } From 9ee0ec1b9da2691d9945868a0d1abadc97d43fde Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 11:17:55 -0600 Subject: [PATCH 1643/1753] Use Join-Path --- tools/Convert-PDB.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Convert-PDB.ps1 b/tools/Convert-PDB.ps1 index d4e548a34..27346d683 100644 --- a/tools/Convert-PDB.ps1 +++ b/tools/Convert-PDB.ps1 @@ -40,7 +40,7 @@ if ($outputDirectory) { New-Item -ItemType Directory -Force -Path $outputDirectory | Out-Null } -$toolpath = "$pdb2pdbpath/tools/Pdb2Pdb.exe" +$toolpath = Join-Path $pdb2pdbpath 'tools\Pdb2Pdb.exe' $arguments = $DllPath, '/out', $OutputPath, '/nowarn', '0021' if ($PdbPath) { $arguments += '/pdb', $PdbPath From ea91d46bea5b11cebdf56f6dd1311d6d4eb86f13 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 08:13:56 -0600 Subject: [PATCH 1644/1753] Add missing `dotnet symbol` command to manifest --- .config/dotnet-tools.json | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 130ff5eb8..5ebc2dcbd 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -36,6 +36,13 @@ "repo" ], "rollForward": false + }, + "dotnet-symbol": { + "version": "9.0.661903", + "commands": [ + "dotnet-symbol" + ], + "rollForward": false } } } From b547bed407e06ea7b0890793df32e3748add1a64 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Apr 2026 12:48:20 -0600 Subject: [PATCH 1645/1753] Backport fixes from microbuild branch --- tools/Get-3rdPartySymbolFiles.ps1 | 81 +++++++++++++++++++------------ 1 file changed, 50 insertions(+), 31 deletions(-) diff --git a/tools/Get-3rdPartySymbolFiles.ps1 b/tools/Get-3rdPartySymbolFiles.ps1 index 7e15f912e..180843845 100644 --- a/tools/Get-3rdPartySymbolFiles.ps1 +++ b/tools/Get-3rdPartySymbolFiles.ps1 @@ -1,55 +1,44 @@ +[CmdletBinding()] +Param ( +) + # Symbol servers to search for PDBs, in order of priority. $SymbolServers = @( 'https://msdl.microsoft.com/download/symbols' 'https://symbols.nuget.org/download/symbols' ) -Function Unzip($Path, $OutDir) { - $OutDir = (New-Item -ItemType Directory -Path $OutDir -Force).FullName - Add-Type -AssemblyName System.IO.Compression.FileSystem - - # Start by extracting to a temporary directory so that there are no file conflicts. - [System.IO.Compression.ZipFile]::ExtractToDirectory($Path, "$OutDir.out") - - # Now move all files from the temp directory to $OutDir, overwriting any files. - Get-ChildItem -Path "$OutDir.out" -Recurse -File | ForEach-Object { - $destinationPath = Join-Path -Path $OutDir -ChildPath $_.FullName.Substring("$OutDir.out".Length).TrimStart([io.path]::DirectorySeparatorChar, [io.path]::AltDirectorySeparatorChar) - if (!(Test-Path -Path (Split-Path -Path $destinationPath -Parent))) { - New-Item -ItemType Directory -Path (Split-Path -Path $destinationPath -Parent) | Out-Null - } - Move-Item -Path $_.FullName -Destination $destinationPath -Force - } - Remove-Item -Path "$OutDir.out" -Recurse -Force -} - Function Get-SymbolsFromPackage($id, $version) { $symbolPackagesPath = "$PSScriptRoot/../obj/SymbolsPackages" New-Item -ItemType Directory -Path $symbolPackagesPath -Force | Out-Null - $unzippedPkgPath = Join-Path $symbolPackagesPath "$id.$version" + $packagePath = $null # Download the package from configured feeds (failures are non-fatal for symbol collection) - & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue | Out-Null - $global:LASTEXITCODE = 0 - $nupkgFile = Get-ChildItem -Recurse -Path $symbolPackagesPath -Filter "$id.$version.nupkg" -ErrorAction SilentlyContinue | Select-Object -First 1 - if (!$nupkgFile) { + $previousLastExitCode = $global:LASTEXITCODE + try { + $packagePath = & "$PSScriptRoot\Download-NuGetPackage.ps1" -PackageId $id -Version $version -OutputDirectory $symbolPackagesPath -ErrorAction SilentlyContinue + } + catch { + Write-Warning "Failed to download package $id $version from configured feeds. Skipping if not found locally. $($_.Exception.Message)" + } + $global:LASTEXITCODE = $previousLastExitCode + if (!$packagePath -or !(Test-Path -LiteralPath $packagePath)) { Write-Warning "Package $id $version not found in configured feeds. Skipping." return } - Unzip -Path $nupkgFile.FullName -OutDir $unzippedPkgPath - # Download symbols for each binary using dotnet-symbol $serverArgs = $SymbolServers | ForEach-Object { '--server-path'; $_ } - $binaries = Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Include *.dll, *.exe - foreach ($binary in $binaries) { + $binaries = @(Get-ChildItem -Recurse -LiteralPath $packagePath -Include *.dll, *.exe) + if ($binaries) { $prevErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Continue' - & dotnet symbol --symbols @serverArgs --output $binary.DirectoryName $binary.FullName 2>&1 | Out-Null + & dotnet symbol --symbols @serverArgs @($binaries.FullName) 2>&1 | Out-Null $ErrorActionPreference = $prevErrorActionPreference } # Output pairs of binary + PDB paths for archival - Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Filter *.pdb | % { + Get-ChildItem -Recurse -LiteralPath $packagePath -Filter *.pdb | % { $rootName = Join-Path $_.Directory $_.BaseName if ($rootName.EndsWith('.ni')) { $rootName = $rootName.Substring(0, $rootName.Length - 3) @@ -75,9 +64,36 @@ Function Get-SymbolsFromPackage($id, $version) { } } +Function Get-PackageVersions() { + if ($script:PackageVersions) { + return $script:PackageVersions + } + + $propsPath = (Resolve-Path -LiteralPath (Join-Path $PSScriptRoot '..\Directory.Packages.props')).Path + $output = & dotnet msbuild $propsPath -nologo -verbosity:quiet -getItem:PackageVersion 2>&1 + if ($LASTEXITCODE -ne 0) { + Write-Error "Failed to evaluate package versions from Directory.Packages.props.`n$($output | Out-String)" + return @{} + } + + $jsonText = ($output | Out-String).Trim() + $jsonStart = $jsonText.IndexOf('{') + if ($jsonStart -lt 0) { + Write-Error 'Failed to locate JSON output from `dotnet msbuild -getItem:PackageVersion`.' + return @{} + } + + $packageVersions = @{} + foreach ($item in @((ConvertFrom-Json $jsonText.Substring($jsonStart)).Items.PackageVersion)) { + $packageVersions[$item.Identity] = $item.Version + } + + $script:PackageVersions = $packageVersions + $packageVersions +} + Function Get-PackageVersion($id) { - $versionProps = [xml](Get-Content -LiteralPath $PSScriptRoot\..\Directory.Packages.props) - $version = $versionProps.Project.ItemGroup.PackageVersion | ? { $_.Include -eq $id } | % { $_.Version } + $version = (Get-PackageVersions)[$id] if (!$version) { Write-Error "No package version found in Directory.Packages.props for the package '$id'" } @@ -94,6 +110,9 @@ $3rdPartyPackageIds = @() $3rdPartyPackageIds | % { $version = Get-PackageVersion $_ if ($version) { + Write-Verbose "Downloading symbols for package '$_' version '$version'." Get-SymbolsFromPackage -id $_ -version $version + } else { + Write-Warning "No version found for package '$_'. Skipping symbol download." } } From 60d88b849191f07aeb87b0808ff473e461323982 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 14:34:57 -0600 Subject: [PATCH 1646/1753] Merge pull request #1572 from microsoft/renovate/microsoft.windows.cswin32-0.x Update dependency Microsoft.Windows.CsWin32 to 0.3.275 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index e9f64fa1a..cfe4c6f60 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From 5e1816dffaad8f736b5828eb436c3742ff85e9e8 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 15 Apr 2026 20:54:48 +0000 Subject: [PATCH 1647/1753] Update dependency DNNE to 2.1.0 (#1573) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index cfe4c6f60..55fedc7ed 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ 3.11.0-beta1.26057.1 - + From 0a9483f1a451fc483985a81f072ee632dac55d65 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 16 Apr 2026 09:22:19 -0600 Subject: [PATCH 1648/1753] Update dependency nerdbank.dotnetrepotools to v1.3.22 (509) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 5ebc2dcbd..89c1b1b69 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.3.13", + "version": "1.3.22", "commands": [ "repo" ], From ebd4ed33e94ce64a2d35349006d6c092c9e86a89 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 08:48:26 -0600 Subject: [PATCH 1649/1753] Resolve (new) null ref annotation warnings --- .../AsyncCrossProcessMutexTests.cs | 4 ++-- .../NonConcurrentSynchronizationContextTests.cs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs index 409769123..1223a8491 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncCrossProcessMutexTests.cs @@ -157,14 +157,14 @@ public async Task TryEnterAsync_AbandonedMutex() using AsyncCrossProcessMutex mutex2 = new(this.mutex.Name); AsyncCrossProcessMutex.LockReleaser? abandonedReleaser = await this.mutex.TryEnterAsync(Timeout.InfiniteTimeSpan); - Assert.False(abandonedReleaser.Value.IsAbandoned); + Assert.False(abandonedReleaser?.IsAbandoned); // Dispose the mutex WITHOUT first releasing it. this.mutex.Dispose(); using (AsyncCrossProcessMutex.LockReleaser? releaser2 = await mutex2.TryEnterAsync(Timeout.InfiniteTimeSpan)) { - Assert.True(releaser2.Value.IsAbandoned); + Assert.True(releaser2?.IsAbandoned); } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs index 650a23f3b..4ac2e9b75 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/NonConcurrentSynchronizationContextTests.cs @@ -48,7 +48,7 @@ public async Task UnhandledException_WithHandler() var eventArgs = new TaskCompletionSource<(object?, Exception)>(); this.nonSticky.UnhandledException += (s, e) => eventArgs.SetResult((s, e)); this.nonSticky.Post(s => throw new InvalidOperationException(), null); - (object sender, Exception ex) = await eventArgs.Task.WithCancellation(this.TimeoutToken); + (object? sender, Exception? ex) = await eventArgs.Task.WithCancellation(this.TimeoutToken); Assert.Same(this.nonSticky, sender); Assert.IsType(ex); } From 99fdb5018c0f6d931324739d7957d5eda104839d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 12:42:21 -0600 Subject: [PATCH 1650/1753] Add `JoinableTaskFactory.DisableProcessing()` This method is like the WPF `Dispatcher.DisableProcessing()` method, except that it impacts the `SynchronizationContext` that `JoinableTask` delegates execute within. As part of this, I introduce a test helper class for actually testing the penetrability of sync blocks so we can adequately test this new API. Since this test helper also can apply to `NoMessagePumpSyncContext` testing (which did not exist), I added new tests for that class too. --- .github/copilot-instructions.md | 3 +- samples/DisableProcessing.cs | 50 +++++ samples/Polyfill.cs | 18 ++ .../{ApiSamples.cs => SuppressRelevance.cs} | 5 +- ...Task+JoinableTaskSynchronizationContext.cs | 60 +++++- .../JoinableTask.cs | 22 +- .../JoinableTaskFactory.cs | 81 +++++++ .../NoMessagePumpSyncContext.cs | 9 +- .../ReentrantSemaphore.cs | 2 +- .../Strings.resx | 3 + .../CoWaitMainThreadTransition.cs | 199 ++++++++++++++++++ .../JoinableTaskFactoryTests.cs | 100 ++++++++- .../NoMessagePumpSyncContextTests.cs | 80 +++++++ version.json | 2 +- 14 files changed, 618 insertions(+), 16 deletions(-) create mode 100644 samples/DisableProcessing.cs create mode 100644 samples/Polyfill.cs rename samples/{ApiSamples.cs => SuppressRelevance.cs} (92%) create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/CoWaitMainThreadTransition.cs create mode 100644 test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index dfd8663b4..387894689 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -82,5 +82,6 @@ dotnet run --no-build -c Release --framework net9.0 -- --list-tests ## Coding style * Honor StyleCop rules and fix any reported build warnings *after* getting tests to pass. -* In C# files, use namespace *statements* instead of namespace *blocks* for all new files. +* In C# files, use namespace *statements* instead of namespace *blocks* for all new files that define namespaces. +* Test files are *not* expected to declare namespaces. * Add API doc comments to all new public and internal members. diff --git a/samples/DisableProcessing.cs b/samples/DisableProcessing.cs new file mode 100644 index 000000000..0deddb1d1 --- /dev/null +++ b/samples/DisableProcessing.cs @@ -0,0 +1,50 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +#pragma warning disable VSTHRD103 // Call async methods when in an async method + +using System.IO; +using Microsoft.VisualStudio.Threading; + +internal class DisableProcessing +{ + private readonly JoinableTaskFactory joinableTaskFactory = null!; + + private void Simple() + { + #region Simple + this.joinableTaskFactory.Run(async delegate + { + this.joinableTaskFactory.DisableProcessing(); + + // Synchronous I/O and lock contentions will NOT result in any reentrancy within this JoinableTask. + }); + #endregion + } + + private void Exhaustive() + { + #region Exhaustive + this.joinableTaskFactory.Run(async delegate + { + // Async I/O isn't expected to synchronously block, and thus would never allow unwanted reentrancy. + string content = await File.ReadAllTextAsync(@"somefile.txt"); + + // Here, synchronous I/O and lock contentions MAY allow certain reentrancy (e.g. COM RPC messages). + content = File.ReadAllText(@"somefile.txt"); + + using (this.joinableTaskFactory.DisableProcessing()) + { + // Within this block, synchronous I/O and lock contentions will NOT result in any reentrancy. + content = File.ReadAllText(@"somefile.txt"); + } + + // Just disable the synchronous wait message pump for the rest of this JoinableTask. + this.joinableTaskFactory.DisableProcessing(); + + // Sync I/O and lock contentions will NOT result in any reentrancy here. + content = File.ReadAllText(@"somefile.txt"); + }); + #endregion + } +} diff --git a/samples/Polyfill.cs b/samples/Polyfill.cs new file mode 100644 index 000000000..5853f02ea --- /dev/null +++ b/samples/Polyfill.cs @@ -0,0 +1,18 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +#if NETFRAMEWORK + +using System; +using System.IO; +using System.Threading.Tasks; + +internal static class PolyfillExtensions +{ + extension(File) + { + internal static Task ReadAllTextAsync(string path) => throw new NotImplementedException(); + } +} + +#endif diff --git a/samples/ApiSamples.cs b/samples/SuppressRelevance.cs similarity index 92% rename from samples/ApiSamples.cs rename to samples/SuppressRelevance.cs index 6fa40c624..348eb2ce6 100644 --- a/samples/ApiSamples.cs +++ b/samples/SuppressRelevance.cs @@ -1,11 +1,10 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. -using System.Threading; using System.Threading.Tasks; using Microsoft.VisualStudio.Threading; -public class SuppressRelevanceSample +public class SuppressRelevance { private readonly ReentrantSemaphore semaphore = ReentrantSemaphore.Create(1, null, ReentrantSemaphore.ReentrancyMode.NotAllowed); @@ -19,7 +18,7 @@ await this.semaphore.ExecuteAsync(async delegate await Task.Yield(); // represents some async work // Fire and forget code that uses the semaphore, but should *not* - // inherit our own posession of the semaphore. + // inherit our own possession of the semaphore. using (this.semaphore.SuppressRelevance()) { this.DoSomethingLaterAsync().Forget(); // Don't await this, or a deadlock will occur. diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs index 776f67679..d06f50e5c 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs @@ -2,11 +2,11 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; +using System.Runtime.InteropServices; using System.Threading; using System.Threading.Tasks; +using Windows.Win32; +using Windows.Win32.Foundation; namespace Microsoft.VisualStudio.Threading { @@ -67,6 +67,24 @@ internal bool MainThreadAffinitized get { return this.mainThreadAffinitized; } } + /// + /// Gets or sets a value indicating whether synchronous waits should prohibit any message pump (e.g. CoWait). + /// + /// The default value is . + internal bool DisableProcessing + { + get => field; + set + { + field = value; + if (value) + { + // This is required so that our override of Wait is invoked. + this.SetWaitNotificationRequired(); + } + } + } + /// /// Forwards the specified message to the job this instance belongs to if applicable; otherwise to the factory. /// @@ -134,6 +152,42 @@ public override void Send(SendOrPostCallback d, object? state) } } + /// + /// Synchronously blocks without a message pump. + /// + /// An array of type that contains the native operating system handles. + /// true to wait for all handles; false to wait for any handle. + /// The number of milliseconds to wait, or (-1) to wait indefinitely. + /// + /// The array index of the object that satisfied the wait. + /// + public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisecondsTimeout) + { + Requires.NotNull(waitHandles, nameof(waitHandles)); + + if (this.DisableProcessing) + { + // On .NET Framework we must take special care to NOT end up in a call to CoWait (which lets in RPC calls). + // Off Windows, we can't p/invoke to kernel32, but it appears that .NET never calls CoWait, so we can rely on default behavior. + // We're just going to use the OS as the switch instead of the runtime so that (one day) if we drop our .NET Framework specific target, + // and if .NET ever adds CoWait support on Windows, we'll still behave properly. +#if NET + if (OperatingSystem.IsWindowsVersionAtLeast(5, 1, 2600)) +#else + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) +#endif + { + fixed (IntPtr* pHandles = waitHandles) + { + return (int)PInvoke.WaitForMultipleObjects((uint)waitHandles.Length, (HANDLE*)pHandles, waitAll, (uint)millisecondsTimeout); + } + } + } + + // Fallback to sync blocking such that CoWait might be called. + return WaitHelper(waitHandles, waitAll, millisecondsTimeout); + } + /// /// Called by the joinable task when it has completed. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 7490f3672..6f3fd7b1e 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -330,7 +330,10 @@ internal SynchronizationContext? ApplicableJobSyncContext { if (this.mainThreadJobSyncContext is null) { - this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true); + this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true) + { + DisableProcessing = this.DisableProcessing, + }; } } } @@ -372,6 +375,23 @@ internal SynchronizationContext? ApplicableJobSyncContext } } + /// + /// Gets or sets a value indicating whether CoWait will be prohibited + /// during synchronously blocking waits from code actively running within this . + /// + internal bool DisableProcessing + { + get => field; + set + { + field = value; + if (this.mainThreadJobSyncContext is { } syncContext) + { + syncContext.DisableProcessing = value; + } + } + } + /// /// Gets a weak reference to this object. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 3417adb3a..2951e736c 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -294,6 +294,56 @@ public JoinableTask RunAsync(Func> asyncMethod, string? parentToke return this.RunAsync(asyncMethod, synchronouslyBlocking: false, parentToken, creationOptions: creationOptions); } +#pragma warning disable SA1629 // Documentation text should end with a period + /// + /// Prevents filtered message pumps from running during synchronous waits for the ambient . + /// + /// + /// A value that may be disposed of when the need to suppress synchronous wait message pumps is ended. + /// Alternatively it may be discarded if the rest of the is intended to have processing disabled. + /// + /// Thrown when called outside the context of a . + /// + /// + /// During a yielding within a , no message pump ever runs + /// regardless of whether this method is called, except for the internal one that lets in only relevant work. + /// When user code runs within the delegate or its callees that ends up requiring + /// a synchronous block of the main thread (e.g. synchronous I/O or lock contention), this wait is typically + /// implemented by calling on . + /// The default implementation of this method allows for certain interruptions (e.g. COM RPC calls), which + /// may avoid deadlocks in certain situations. + /// + /// + /// Calling this method will replace the default implementation of + /// with one that will not allow such interruptions while that is active and in control of + /// . + /// + /// + /// Disabling processing has no effect on non-Windows operating systems. + /// + /// + /// Nested calls to are ignored. Only the outermost call has an effect on the behavior of the ambient + /// and only disposing the return value from the outermost call will restore the default behavior. + /// + /// + /// Disposing the resulting value will revert to the default behavior. + /// Callers need not ever dispose of this value if the intent is to disable processing for the remainder of that + /// 's execution. + /// + /// + /// + /// + /// Here is a simple, common usage of this method: + /// + /// + /// + /// Following are more examples of how it might be used: + /// + /// + /// + public ProcessingDisabledOperation DisableProcessing() => new(this.Context.AmbientTask ?? throw new InvalidOperationException(Strings.NoAmbientTask)); +#pragma warning restore SA1629 // Documentation text should end with a period + /// /// Responds to calls to /// by scheduling a continuation to execute on the Main thread. @@ -682,6 +732,37 @@ static bool FailFast(Exception ex) } } + /// + /// A struct whose disposal will revert the effect of an earlier call to . + /// + public struct ProcessingDisabledOperation : IDisposable + { + private JoinableTask? owner; + + /// + /// Initializes a new instance of the struct. + /// + /// The owner of this struct. + internal ProcessingDisabledOperation(JoinableTask owner) + { + if (owner.DisableProcessing is false) + { + owner.DisableProcessing = true; + this.owner = owner; + } + } + + /// + public void Dispose() + { + if (this.owner is { } owner) + { + owner.DisableProcessing = false; + this.owner = null; + } + } + } + /// /// An awaitable struct that facilitates an asynchronous transition to the Main thread. /// diff --git a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs index feea9a501..fa92b754c 100644 --- a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs @@ -2,7 +2,6 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Buffers; using System.Runtime.InteropServices; using System.Threading; using global::Windows.Win32; @@ -52,10 +51,10 @@ public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisec Requires.NotNull(waitHandles, nameof(waitHandles)); // On .NET Framework we must take special care to NOT end up in a call to CoWait (which lets in RPC calls). - // Off Windows, we can't p/invoke to kernel32, but it appears that .NET Core never calls CoWait, so we can rely on default behavior. - // We're just going to use the OS as the switch instead of the framework so that (one day) if we drop our .NET Framework specific target, - // and if .NET Core ever adds CoWait support on Windows, we'll still behave properly. -#if NET5_0_OR_GREATER + // Off Windows, we can't p/invoke to kernel32, but it appears that .NET never calls CoWait, so we can rely on default behavior. + // We're just going to use the OS as the switch instead of the runtime so that (one day) if we drop our .NET Framework specific target, + // and if .NET ever adds CoWait support on Windows, we'll still behave properly. +#if NET if (OperatingSystem.IsWindowsVersionAtLeast(5, 1, 2600)) #else if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) diff --git a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs index 5ee34752a..fbe46fe2d 100644 --- a/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs +++ b/src/Microsoft.VisualStudio.Threading/ReentrantSemaphore.cs @@ -191,7 +191,7 @@ public static ReentrantSemaphore Create(int initialCount = 1, JoinableTaskContex /// /// The following snippet demonstrates a way to use this method. /// - /// + /// /// public virtual RevertRelevance SuppressRelevance() => default; diff --git a/src/Microsoft.VisualStudio.Threading/Strings.resx b/src/Microsoft.VisualStudio.Threading/Strings.resx index 2537d49ff..4983aee85 100644 --- a/src/Microsoft.VisualStudio.Threading/Strings.resx +++ b/src/Microsoft.VisualStudio.Threading/Strings.resx @@ -193,4 +193,7 @@ No SynchronizationContext to reach the main thread has been set. + + No JoinableTask is active. + \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Tests/CoWaitMainThreadTransition.cs b/test/Microsoft.VisualStudio.Threading.Tests/CoWaitMainThreadTransition.cs new file mode 100644 index 000000000..f10cc753d --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/CoWaitMainThreadTransition.cs @@ -0,0 +1,199 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +#if NETFRAMEWORK + +using System; +using System.Reflection; +using System.Runtime.ExceptionServices; +using System.Runtime.InteropServices; +using System.Threading; + +/// +/// Probes whether the calling STA thread's current synchronous wait allows COM RPC calls to +/// penetrate. Spawns an MTA thread that marshals a COM call back to the STA thread; the call +/// succeeds if and only if the thread is performing a CoWait (message-pumping wait) rather than +/// a plain WaitForMultipleObjects wait. +/// +/// +/// Create the probe before blocking the STA thread, then call after unblocking +/// to learn whether the COM call was delivered. Dispose when done to cancel any pending call and +/// release resources. +/// +public sealed class CoWaitMainThreadTransition : IDisposable +{ + /// Best-effort delay in milliseconds used when cancelling or joining the caller thread. + private const int CallCancellationDelayMs = 500; + + private const int RpcECallCanceled = unchecked((int)0x80010002); + + private static readonly Guid IDispatchGuid = new("00020400-0000-0000-C000-000000000046"); + + private readonly ManualResetEventSlim signalReceived = new(); + private readonly ManualResetEventSlim callerReady = new(); + private readonly Thread callerThread; + private Exception? backgroundFailure; + private uint callerThreadId; + + /// + /// Initializes a new instance of the class and + /// immediately starts the background MTA thread that will attempt the COM call. + /// + internal CoWaitMainThreadTransition() + { + IMainThreadSignaler signaler = new MainThreadSignaler(this.signalReceived); + IntPtr signalerInterface = Marshal.GetIDispatchForObject(signaler); + try + { + Marshal.ThrowExceptionForHR(NativeMethods.CoMarshalInterThreadInterfaceInStream(in IDispatchGuid, signalerInterface, out IntPtr stream)); + + this.callerThread = new Thread(() => this.InvokeSignalOnBackgroundThread(stream)) + { + IsBackground = true, + }; + } + finally + { + Marshal.Release(signalerInterface); + } + +#pragma warning disable CA1416 // Apartment state is only relevant on Windows, and the probe is not used elsewhere. + this.callerThread.SetApartmentState(ApartmentState.MTA); +#pragma warning restore CA1416 + this.callerThread.Start(); + } + + /// + /// A COM-visible IDispatch interface used to signal the main STA thread from an MTA background thread. + /// + [ComVisible(true)] + [Guid("A1D1F0E7-564F-4B9F-8DB2-D40185F115FB")] + [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)] + public interface IMainThreadSignaler + { + /// Signals the main thread that it has received a COM RPC call. + [DispId(1)] + void Signal(); + } + + /// + public void Dispose() + { + if (this.callerThread.IsAlive) + { + this.CancelPendingCall(); + _ = this.callerThread.Join(CallCancellationDelayMs); + } + + this.callerReady.Dispose(); + this.signalReceived.Dispose(); + } + + /// + /// Blocks until the COM call completes or elapses. + /// + /// The maximum time to wait. + /// + /// if the COM call was delivered within ; + /// if the call did not penetrate the wait (i.e., no CoWait was used). + /// + internal bool Wait(TimeSpan timeout) + { + bool interruptedWait = this.signalReceived.Wait(timeout); + if (!interruptedWait) + { + this.CancelPendingCall(); + } + + if (interruptedWait) + { + Assert.True(this.callerThread.Join(timeout), "Timed out waiting for the COM call to finish."); + } + else + { + _ = this.callerThread.Join(CallCancellationDelayMs); + } + + if (this.backgroundFailure is object && (interruptedWait || this.backgroundFailure.HResult != RpcECallCanceled)) + { + ExceptionDispatchInfo.Capture(this.backgroundFailure).Throw(); + } + + return interruptedWait; + } + + private void CancelPendingCall() + { + Assert.True(this.callerReady.Wait(CallCancellationDelayMs), "Timed out waiting for the COM caller thread to initialize."); + if (this.callerThread.IsAlive && this.callerThreadId != 0) + { + _ = NativeMethods.CoCancelCall(this.callerThreadId, 0); + } + } + + private void InvokeSignalOnBackgroundThread(IntPtr stream) + { + try + { + this.callerThreadId = NativeMethods.GetCurrentThreadId(); + Marshal.ThrowExceptionForHR(NativeMethods.CoEnableCallCancellation(IntPtr.Zero)); + this.callerReady.Set(); + + Thread.Sleep(50); + Marshal.ThrowExceptionForHR(NativeMethods.CoGetInterfaceAndReleaseStream(stream, in IDispatchGuid, out object signaler)); + signaler.GetType().InvokeMember(nameof(IMainThreadSignaler.Signal), BindingFlags.InvokeMethod, binder: null, target: signaler, args: Array.Empty()); + } + catch (Exception ex) + { + this.backgroundFailure = ex; + this.callerReady.Set(); + } + finally + { + _ = NativeMethods.CoDisableCallCancellation(IntPtr.Zero); + } + } + + /// + /// COM-visible implementation of that uses the free-threaded + /// marshaler so the COM proxy routes calls back to whichever STA thread holds the object. + /// + [ComVisible(true)] + [ClassInterface(ClassInterfaceType.None)] + public sealed class MainThreadSignaler : StandardOleMarshalObject, IMainThreadSignaler + { + private readonly ManualResetEventSlim signalReceived; + + /// Initializes a new instance of the class. + /// The event to set when is called. + internal MainThreadSignaler(ManualResetEventSlim signalReceived) + { + this.signalReceived = signalReceived; + } + + /// + public void Signal() => this.signalReceived.Set(); + } + + private static class NativeMethods + { + [DllImport("ole32.dll")] + internal static extern int CoMarshalInterThreadInterfaceInStream(in Guid riid, IntPtr pUnk, out IntPtr ppStm); + + [DllImport("ole32.dll")] + internal static extern int CoGetInterfaceAndReleaseStream(IntPtr pStm, in Guid iid, [MarshalAs(UnmanagedType.IDispatch)] out object ppv); + + [DllImport("ole32.dll")] + internal static extern int CoEnableCallCancellation(IntPtr pReserved); + + [DllImport("ole32.dll")] + internal static extern int CoDisableCallCancellation(IntPtr pReserved); + + [DllImport("ole32.dll")] + internal static extern int CoCancelCall(uint dwThreadId, uint ulTimeout); + + [DllImport("kernel32.dll")] + internal static extern uint GetCurrentThreadId(); + } +} +#endif diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs index 7f05a3d5b..f02df6ebf 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs @@ -1,7 +1,9 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. +// Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; +using System.Runtime.InteropServices; +using System.Threading; using System.Threading.Tasks; public class JoinableTaskFactoryTests : JoinableTaskTestBase @@ -11,6 +13,13 @@ public JoinableTaskFactoryTests(ITestOutputHelper logger) { } + private static bool MightCoWaitBeUsed +#if NETFRAMEWORK + => RuntimeInformation.IsOSPlatform(OSPlatform.Windows); +#else + => false; +#endif + [Fact] public void OnTransitioningToMainThread_DoesNotHoldPrivateLock() { @@ -138,6 +147,95 @@ public void SwitchToMainThreadAlwaysYield() }); } + [Fact] + public void DisableProcessing_ThrowsOutsideJoinableTask() + { + Assert.Throws(() => this.asyncPump.DisableProcessing()); + } + + [Fact] + public void DisableProcessing_InsideJoinableTask() + { + this.asyncPump.Run(delegate + { + using (this.asyncPump.DisableProcessing()) + { + } + + return Task.CompletedTask; + }); + } + + [Fact] + public void ProcessingDisabledOperation_Dispose_DoesNotThrowFromDefaultValue() + { + default(JoinableTaskFactory.ProcessingDisabledOperation).Dispose(); + } + +#if NETFRAMEWORK + [StaFact] + public void DisableProcessing() + { + this.asyncPump.Run(() => + { + this.AssertProcessingAllowed(); + + using (this.asyncPump.DisableProcessing()) + { + this.AssertProcessingDisabled(); + } + + this.AssertProcessingAllowed(); + return Task.CompletedTask; + }); + } + + [StaFact] + public void DisableProcessing_Nested() + { + this.asyncPump.Run(() => + { + using (this.asyncPump.DisableProcessing()) + { + using (this.asyncPump.DisableProcessing()) + { + this.AssertProcessingDisabled(); + } + + this.AssertProcessingDisabled(); + } + + this.AssertProcessingAllowed(); + return Task.CompletedTask; + }); + } + + private void AssertProcessingDisabled() + { + Assert.SkipUnless(MightCoWaitBeUsed, "DisableProcessing has no effect in this environment."); + + // For this check to work, we need to be on the main thread. + Assert.True(this.asyncPump.Context.IsOnMainThread); + Assert.Equal(ApartmentState.STA, Thread.CurrentThread.GetApartmentState()); + + using CoWaitMainThreadTransition transition = new(); + Assert.False(transition.Wait(ExpectedTimeout)); + } + + private void AssertProcessingAllowed() + { + Assert.SkipUnless(MightCoWaitBeUsed, "DisableProcessing has no effect in this environment."); + + // For this check to work, we need to be on the main thread. + Assert.True(this.asyncPump.Context.IsOnMainThread); + Assert.Equal(ApartmentState.STA, Thread.CurrentThread.GetApartmentState()); + + using CoWaitMainThreadTransition transition = new(); + Assert.True(transition.Wait(UnexpectedTimeout)); + } + +#endif + /// /// A that allows a test to inject code /// in the main thread transition events. diff --git a/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs new file mode 100644 index 000000000..1c95be9d3 --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs @@ -0,0 +1,80 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using System.Threading; + +/// +/// Tests for . +/// +public class NoMessagePumpSyncContextTests : TestBase +{ + /// + /// Initializes a new instance of the class. + /// + /// The logger to use for test output. + public NoMessagePumpSyncContextTests(ITestOutputHelper logger) + : base(logger) + { + } + + /// + /// Verifies that returns a usable singleton instance. + /// + [Fact] + public void Default_IsNonNull() + { + Assert.NotNull(NoMessagePumpSyncContext.Default); + } + + /// + /// Verifies that the default singleton is itself a . + /// + [Fact] + public void Default_IsNoMessagePumpSyncContext() + { + Assert.IsType(NoMessagePumpSyncContext.Default); + } + +#if NETFRAMEWORK + /// + /// Establishes the baseline: on a plain STA thread without a special synchronization context, + /// uses CoWaitForMultipleHandles, + /// which allows COM RPC calls to be dispatched to the thread while it waits. + /// + [StaFact] + public void Wait_ComRpcPenetratesDefaultStaWait() + { + using CoWaitMainThreadTransition probe = new(); + using ManualResetEvent mre = new(false); + + // Block the STA thread; the default CoWait allows the COM call to execute Signal(). + mre.WaitOne((int)ExpectedTimeout.TotalMilliseconds); + + // The COM call should have been delivered while the thread was blocked. + Assert.True(probe.Wait(TimeSpan.FromMilliseconds(AsyncDelay))); + } + + /// + /// Verifies that uses + /// WaitForMultipleObjects rather than CoWaitForMultipleHandles, preventing + /// COM RPC calls from being dispatched to the thread while it is synchronously waiting. + /// + [StaFact] + public void Wait_BlocksComRpcCalls() + { + using (NoMessagePumpSyncContext.Default.Apply()) + { + using CoWaitMainThreadTransition probe = new(); + using ManualResetEvent mre = new(false); + + // Block the STA thread; NoMessagePumpSyncContext uses WaitForMultipleObjects, + // so the COM call cannot be dispatched while the thread is waiting. + mre.WaitOne((int)ExpectedTimeout.TotalMilliseconds); + + // The COM call should NOT have been delivered. + Assert.False(probe.Wait(TimeSpan.FromMilliseconds(AsyncDelay))); + } + } +#endif +} diff --git a/version.json b/version.json index 2f478c761..e53c28ed4 100644 --- a/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json", - "version": "18.0", + "version": "18.7", "publicReleaseRefSpec": [ "^refs/heads/main$", "^refs/heads/v\\d+(?:\\.\\d+)?$" From 9ad206a16f966df7cd79cad7b57e4cc42c4387c1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 14:00:07 -0600 Subject: [PATCH 1651/1753] Switch AI-assisted merging from a prompt to a skill This makes it available in Copilot CLI. Co-authored-by: Copilot --- .../update-library-template/SKILL.md} | 6 ++++-- .../update-library-template}/template-release-notes.md | 0 2 files changed, 4 insertions(+), 2 deletions(-) rename .github/{prompts/update-library-template.prompt.md => skills/update-library-template/SKILL.md} (92%) rename .github/{prompts => skills/update-library-template}/template-release-notes.md (100%) diff --git a/.github/prompts/update-library-template.prompt.md b/.github/skills/update-library-template/SKILL.md similarity index 92% rename from .github/prompts/update-library-template.prompt.md rename to .github/skills/update-library-template/SKILL.md index f9fe67209..a05a2c16e 100644 --- a/.github/prompts/update-library-template.prompt.md +++ b/.github/skills/update-library-template/SKILL.md @@ -1,17 +1,19 @@ --- +name: update-library-template description: Merges the latest Library.Template into this repo (at position of HEAD) and resolves conflicts. +disable-model-invocation: true --- # Instructions -1. Run `tools/MergeFrom-Template.ps1` +1. Run `./tools/MergeFrom-Template.ps1` from the repo root. 2. Resolve merge conflicts, taking into account conflict resolution policy below. 3. Validate the changes, as described in the validation section below. 4. Committing your changes (if applicable). ## Conflict resolution policy -There may be special notes in `.github/prompts/template-release-notes.md` that describe special considerations for certain files or scenarios to help you resolve conflicts appropriately. +There may be [special notes](template-release-notes.md) that describe special considerations for certain files or scenarios to help you resolve conflicts appropriately. Always refer to that file before proceeding. In particular, focus on the *incoming* part of the file, since it represents the changes from the Library.Template that you are merging into your repo. diff --git a/.github/prompts/template-release-notes.md b/.github/skills/update-library-template/template-release-notes.md similarity index 100% rename from .github/prompts/template-release-notes.md rename to .github/skills/update-library-template/template-release-notes.md From f3742aa3058f24767c7ba8317f947d4e5c0e6be0 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 14:01:11 -0600 Subject: [PATCH 1652/1753] Update dependency powershell to v7.6.1 (510) --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 89c1b1b69..781fe3cf3 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.6.0", + "version": "7.6.1", "commands": [ "pwsh" ], From 17e9184bfd1327f4724d5ff96221cbe082480f82 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 14:01:46 -0600 Subject: [PATCH 1653/1753] Update Dockerfile and global.json updates to v10.0.203 (511) --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 6e0c04523..5344ba504 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.202@sha256:adc02be8b87957d07208a4a3e51775935b33bad3317de8c45b1e67357b4c073b +FROM mcr.microsoft.com/dotnet/sdk:10.0.203@sha256:8a90a473da5205a16979de99d2fc20975e922c68304f5c79d564e666dc3982fc # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 8f4695913..441e15ad5 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.202", + "version": "10.0.203", "rollForward": "patch", "allowPrerelease": false }, From 7c3735c27f78ba6b9e0f475c760e103b32ae687f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 13:25:47 -0600 Subject: [PATCH 1654/1753] Match `Dispatcher.DisableProcessing()` behavior for Dispatcher-aware `JoinableTaskFactory`-derived types --- .../DispatcherExtensions.cs | 10 +++++ ...Task+JoinableTaskSynchronizationContext.cs | 25 +++++++++++ .../JoinableTask.cs | 1 + .../JoinableTaskFactory.cs | 11 +++++ .../DispatcherExtensionsTests.cs | 44 +++++++++++++++++++ .../JoinableTaskFactoryTests.cs | 33 -------------- .../JoinableTaskTestBase.cs | 26 +++++++++++ .../TestBase.cs | 8 ++++ .../NativeAOTCompatibility.Test.csproj | 1 + 9 files changed, 126 insertions(+), 33 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs index 900977100..1b93c4bef 100644 --- a/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs +++ b/src/Microsoft.VisualStudio.Threading/DispatcherExtensions.cs @@ -27,6 +27,13 @@ public static class DispatcherExtensions /// and for each asynchronous return to the main thread after an . /// /// A that may be used for scheduling async work with the specified priority. + /// + /// In addition to scheduling work on the UI thread with the specified priority, + /// this also ensures that any synchronous waits + /// on the main thread within objects created with the returned factory + /// will honor calls to , producing similar behavior + /// to . + /// public static JoinableTaskFactory WithPriority(this JoinableTaskFactory joinableTaskFactory, Dispatcher dispatcher, DispatcherPriority priority) { Requires.NotNull(joinableTaskFactory, nameof(joinableTaskFactory)); @@ -61,6 +68,9 @@ internal DispatcherJoinableTaskFactory(JoinableTaskFactory innerFactory, Dispatc : base(innerFactory) { this.dispatcher = dispatcher ?? throw new ArgumentNullException(nameof(dispatcher)); +#if NETFRAMEWORK // Avoid trim warnings on .NET, and only .NET Framework calls CoWait anyway. + this.DefaultWaitPolicy = new DispatcherSynchronizationContext(dispatcher); +#endif this.priority = priority; } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs index d06f50e5c..82915161b 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs @@ -85,6 +85,25 @@ internal bool DisableProcessing } } + /// + /// Gets a on which + /// should be called from + /// when has not been called. + /// + internal SynchronizationContext? DefaultWaitPolicy + { + get => field; + init + { + field = value; + if (value is not null) + { + // This is required so that our override of Wait is invoked. + this.SetWaitNotificationRequired(); + } + } + } + /// /// Forwards the specified message to the job this instance belongs to if applicable; otherwise to the factory. /// @@ -184,6 +203,12 @@ public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisec } } + // Use a surrogate default policy if provided. + if (this.DefaultWaitPolicy is { } waitPolicy) + { + return waitPolicy.Wait(waitHandles, waitAll, millisecondsTimeout); + } + // Fallback to sync blocking such that CoWait might be called. return WaitHelper(waitHandles, waitAll, millisecondsTimeout); } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 6f3fd7b1e..f291b1535 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -333,6 +333,7 @@ internal SynchronizationContext? ApplicableJobSyncContext this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true) { DisableProcessing = this.DisableProcessing, + DefaultWaitPolicy = this.owner.DefaultWaitPolicy, }; } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 2951e736c..8fb3224f8 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -98,6 +98,17 @@ internal JoinableTaskCollection? Collection get { return this.jobCollection; } } + /// + /// Gets a on which + /// should be called from + /// when has not been called. + /// + /// + /// This allows a WPF-aware -derived class within this assembly + /// to match Dispatcher.DisableProcessing() behavior. + /// + internal SynchronizationContext? DefaultWaitPolicy { get; init; } + /// /// Gets or sets the timeout after which no activity while synchronously blocking /// suggests a hang has occurred. diff --git a/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs index 65d324840..44b5cf011 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/DispatcherExtensionsTests.cs @@ -66,6 +66,50 @@ public void WithPriority_LowPriorityCanBlockOnHighPriorityWork() await Task.WhenAll(idleTask.Task, normalTask.Task).WithCancellation(this.TimeoutToken); }); } + +#if NETFRAMEWORK + [StaFact] + public void WithPriority_MatchesDisableProcessingWithinDelegate() + { + this.SimulateUIThread(delegate + { + JoinableTaskFactory? normalPriorityJtf = this.asyncPump.WithPriority(Dispatcher.CurrentDispatcher, DispatcherPriority.Normal); + normalPriorityJtf.Run(delegate + { + this.AssertProcessingAllowed(); + + using (Dispatcher.CurrentDispatcher.DisableProcessing()) + { + this.AssertProcessingDisabled(); + } + + return Task.CompletedTask; + }); + + return Task.CompletedTask; + }); + } + + [StaFact] + public void WithPriority_MatchesDisableProcessingOutsideDelegate() + { + this.SimulateUIThread(delegate + { + JoinableTaskFactory? normalPriorityJtf = this.asyncPump.WithPriority(Dispatcher.CurrentDispatcher, DispatcherPriority.Normal); + using (Dispatcher.CurrentDispatcher.DisableProcessing()) + { + normalPriorityJtf.Run(delegate + { + this.AssertProcessingDisabled(); + + return Task.CompletedTask; + }); + } + + return Task.CompletedTask; + }); + } +#endif } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs index f02df6ebf..011d71a62 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs @@ -2,8 +2,6 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Runtime.InteropServices; -using System.Threading; using System.Threading.Tasks; public class JoinableTaskFactoryTests : JoinableTaskTestBase @@ -13,13 +11,6 @@ public JoinableTaskFactoryTests(ITestOutputHelper logger) { } - private static bool MightCoWaitBeUsed -#if NETFRAMEWORK - => RuntimeInformation.IsOSPlatform(OSPlatform.Windows); -#else - => false; -#endif - [Fact] public void OnTransitioningToMainThread_DoesNotHoldPrivateLock() { @@ -210,30 +201,6 @@ public void DisableProcessing_Nested() }); } - private void AssertProcessingDisabled() - { - Assert.SkipUnless(MightCoWaitBeUsed, "DisableProcessing has no effect in this environment."); - - // For this check to work, we need to be on the main thread. - Assert.True(this.asyncPump.Context.IsOnMainThread); - Assert.Equal(ApartmentState.STA, Thread.CurrentThread.GetApartmentState()); - - using CoWaitMainThreadTransition transition = new(); - Assert.False(transition.Wait(ExpectedTimeout)); - } - - private void AssertProcessingAllowed() - { - Assert.SkipUnless(MightCoWaitBeUsed, "DisableProcessing has no effect in this environment."); - - // For this check to work, we need to be on the main thread. - Assert.True(this.asyncPump.Context.IsOnMainThread); - Assert.Equal(ApartmentState.STA, Thread.CurrentThread.GetApartmentState()); - - using CoWaitMainThreadTransition transition = new(); - Assert.True(transition.Wait(UnexpectedTimeout)); - } - #endif /// diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs index f415f93ba..bd64031a9 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTestBase.cs @@ -96,4 +96,30 @@ protected void PushFrameTillQueueIsEmpty() this.dispatcherContext.Post(s => this.testFrame.Continue = false, null); this.PushFrame(); } + +#if NETFRAMEWORK + protected void AssertProcessingDisabled() + { + Assert.SkipUnless(MightCoWaitBeUsed, "DisableProcessing has no effect in this environment."); + + // For this check to work, we need to be on the main thread. + Assert.True(this.asyncPump.Context.IsOnMainThread); + Assert.Equal(ApartmentState.STA, Thread.CurrentThread.GetApartmentState()); + + using CoWaitMainThreadTransition transition = new(); + Assert.False(transition.Wait(ExpectedTimeout)); + } + + protected void AssertProcessingAllowed() + { + Assert.SkipUnless(MightCoWaitBeUsed, "DisableProcessing has no effect in this environment."); + + // For this check to work, we need to be on the main thread. + Assert.True(this.asyncPump.Context.IsOnMainThread); + Assert.Equal(ApartmentState.STA, Thread.CurrentThread.GetApartmentState()); + + using CoWaitMainThreadTransition transition = new(); + Assert.True(transition.Wait(UnexpectedTimeout)); + } +#endif } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs index d3a837504..704e1440b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/TestBase.cs @@ -5,6 +5,7 @@ using System.Diagnostics; using System.Runtime.CompilerServices; using System.Runtime.ExceptionServices; +using System.Runtime.InteropServices; using System.Threading; using System.Threading.Tasks; using Microsoft; @@ -35,6 +36,13 @@ protected TestBase(ITestOutputHelper logger) this.Logger = logger; } + protected static bool MightCoWaitBeUsed +#if NETFRAMEWORK + => RuntimeInformation.IsOSPlatform(OSPlatform.Windows); +#else + => false; +#endif + /// /// Gets or sets the source of that influences /// when tests consider themselves to be timed out. diff --git a/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj b/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj index 87b9e251d..1c29d7486 100644 --- a/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj +++ b/test/NativeAOTCompatibility.Test/NativeAOTCompatibility.Test.csproj @@ -3,6 +3,7 @@ net10.0 false + false $(TargetFrameworks);net10.0-windows From 1613479bed1ccce7802f509a4f8043e2884cd792 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 14:11:21 -0600 Subject: [PATCH 1655/1753] Use ref-counting for DisableProcessing to allow non-LIFO ordered requests --- ...Task+JoinableTaskSynchronizationContext.cs | 53 +++++-------------- .../JoinableTask.cs | 10 ++-- .../JoinableTaskFactory.cs | 15 ++---- .../JoinableTaskFactoryTests.cs | 19 +++++++ 4 files changed, 41 insertions(+), 56 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs index 82915161b..00432f5ae 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask+JoinableTaskSynchronizationContext.cs @@ -44,6 +44,11 @@ internal JoinableTaskSynchronizationContext(JoinableTaskFactory owner) this.jobFactory = owner; this.mainThreadAffinitized = true; + + if (owner.DefaultWaitPolicy is not null) + { + this.SetWaitNotificationRequired(); + } } /// @@ -56,6 +61,11 @@ internal JoinableTaskSynchronizationContext(JoinableTask joinableTask, bool main { this.job = joinableTask; this.mainThreadAffinitized = mainThreadAffinitized; + + if (joinableTask.DisableProcessing > 0) + { + this.SetWaitNotificationRequired(); + } } /// @@ -67,43 +77,6 @@ internal bool MainThreadAffinitized get { return this.mainThreadAffinitized; } } - /// - /// Gets or sets a value indicating whether synchronous waits should prohibit any message pump (e.g. CoWait). - /// - /// The default value is . - internal bool DisableProcessing - { - get => field; - set - { - field = value; - if (value) - { - // This is required so that our override of Wait is invoked. - this.SetWaitNotificationRequired(); - } - } - } - - /// - /// Gets a on which - /// should be called from - /// when has not been called. - /// - internal SynchronizationContext? DefaultWaitPolicy - { - get => field; - init - { - field = value; - if (value is not null) - { - // This is required so that our override of Wait is invoked. - this.SetWaitNotificationRequired(); - } - } - } - /// /// Forwards the specified message to the job this instance belongs to if applicable; otherwise to the factory. /// @@ -184,7 +157,7 @@ public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisec { Requires.NotNull(waitHandles, nameof(waitHandles)); - if (this.DisableProcessing) + if (this.job?.DisableProcessing > 0) { // On .NET Framework we must take special care to NOT end up in a call to CoWait (which lets in RPC calls). // Off Windows, we can't p/invoke to kernel32, but it appears that .NET never calls CoWait, so we can rely on default behavior. @@ -204,7 +177,7 @@ public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisec } // Use a surrogate default policy if provided. - if (this.DefaultWaitPolicy is { } waitPolicy) + if (this.jobFactory.DefaultWaitPolicy is { } waitPolicy) { return waitPolicy.Wait(waitHandles, waitAll, millisecondsTimeout); } @@ -213,6 +186,8 @@ public override unsafe int Wait(IntPtr[] waitHandles, bool waitAll, int millisec return WaitHelper(waitHandles, waitAll, millisecondsTimeout); } + internal void ConsiderDisableProcessing() => this.SetWaitNotificationRequired(); + /// /// Called by the joinable task when it has completed. /// diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index f291b1535..2cb35d17c 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -330,11 +330,7 @@ internal SynchronizationContext? ApplicableJobSyncContext { if (this.mainThreadJobSyncContext is null) { - this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true) - { - DisableProcessing = this.DisableProcessing, - DefaultWaitPolicy = this.owner.DefaultWaitPolicy, - }; + this.mainThreadJobSyncContext = new JoinableTaskSynchronizationContext(this, true); } } } @@ -380,7 +376,7 @@ internal SynchronizationContext? ApplicableJobSyncContext /// Gets or sets a value indicating whether CoWait will be prohibited /// during synchronously blocking waits from code actively running within this . /// - internal bool DisableProcessing + internal int DisableProcessing { get => field; set @@ -388,7 +384,7 @@ internal bool DisableProcessing field = value; if (this.mainThreadJobSyncContext is { } syncContext) { - syncContext.DisableProcessing = value; + syncContext.ConsiderDisableProcessing(); } } } diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 8fb3224f8..2c3d9ed0b 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -328,15 +328,13 @@ public JoinableTask RunAsync(Func> asyncMethod, string? parentToke /// Calling this method will replace the default implementation of /// with one that will not allow such interruptions while that is active and in control of /// . + /// As this method may be called multiple times, this effect remains until all invocations' + /// return values are disposed (in any order). /// /// /// Disabling processing has no effect on non-Windows operating systems. /// /// - /// Nested calls to are ignored. Only the outermost call has an effect on the behavior of the ambient - /// and only disposing the return value from the outermost call will restore the default behavior. - /// - /// /// Disposing the resulting value will revert to the default behavior. /// Callers need not ever dispose of this value if the intent is to disable processing for the remainder of that /// 's execution. @@ -756,11 +754,8 @@ public struct ProcessingDisabledOperation : IDisposable /// The owner of this struct. internal ProcessingDisabledOperation(JoinableTask owner) { - if (owner.DisableProcessing is false) - { - owner.DisableProcessing = true; - this.owner = owner; - } + owner.DisableProcessing++; + this.owner = owner; } /// @@ -768,7 +763,7 @@ public void Dispose() { if (this.owner is { } owner) { - owner.DisableProcessing = false; + owner.DisableProcessing--; this.owner = null; } } diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs index 011d71a62..1f02f1f06 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs @@ -201,6 +201,25 @@ public void DisableProcessing_Nested() }); } + [StaFact] + public void DisableProcessing_RefCounted() + { + this.asyncPump.Run(() => + { + JoinableTaskFactory.ProcessingDisabledOperation first = this.asyncPump.DisableProcessing(); + JoinableTaskFactory.ProcessingDisabledOperation second = this.asyncPump.DisableProcessing(); + + // Dispose things in a FIFO order instead of a nested LIFO order. + // Processing should only be re-enabled after the last reference is disposed. + first.Dispose(); + this.AssertProcessingDisabled(); + second.Dispose(); + this.AssertProcessingAllowed(); + + return Task.CompletedTask; + }); + } + #endif /// From 203696c05271a4daa713f8ee40e6399d58f8f180 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 15:34:21 -0600 Subject: [PATCH 1656/1753] Use safer `ToLower` variant for package IDs --- tools/Download-NuGetPackage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/Download-NuGetPackage.ps1 b/tools/Download-NuGetPackage.ps1 index 760ac90ff..5eaa2071b 100644 --- a/tools/Download-NuGetPackage.ps1 +++ b/tools/Download-NuGetPackage.ps1 @@ -54,7 +54,7 @@ if ($downloadExitCode -ne 0) { } # Return the path to the downloaded package directory (dotnet package download uses lowercase id) -$packageIdLower = $PackageId.ToLower() +$packageIdLower = $PackageId.ToLowerInvariant() if ($Version) { $packageRoot = Join-Path $OutputDirectory $packageIdLower $packageDir = Get-ChildItem -Path $packageRoot -Directory -ErrorAction SilentlyContinue | From 6ca0eebbe31ca84ad86614c4d8ad2c6aeb9ea714 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 16:31:48 -0600 Subject: [PATCH 1657/1753] Update dependency Microsoft.CodeAnalysis.Analyzers to v5 (#1557) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 55fedc7ed..7ff9af8e2 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -14,7 +14,7 @@ - + From 16cf845527c49e9117a1c8f5a1b51cd424d7803f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 16:45:35 -0600 Subject: [PATCH 1658/1753] Bump roslyn to 5.3.0 --- Directory.Packages.props | 2 +- test/Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7ff9af8e2..7654d0c96 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 2.0.226 3.11.0 1.1.3 - 3.11.0-beta1.26057.1 + 3.11.0-beta1.26075.3 diff --git a/test/Directory.Packages.props b/test/Directory.Packages.props index e359b4cdb..11d31c355 100644 --- a/test/Directory.Packages.props +++ b/test/Directory.Packages.props @@ -3,7 +3,7 @@ - 5.0.0 + 5.3.0 From de0fe96070be77bc49d3bd70cdcb1796fd0f85d7 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 16:46:14 -0600 Subject: [PATCH 1659/1753] Update dependency DNNE to 2.1.1 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 7654d0c96..b789106d5 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ 3.11.0-beta1.26075.3 - + From 43e84c630ca3ee4870e3b533971f56d32e671997 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 23 Apr 2026 08:48:19 -0600 Subject: [PATCH 1660/1753] Document and assert that DisableProcessing state is not inherited by child JoinableTasks --- .../JoinableTaskFactory.cs | 5 +++-- .../JoinableTaskFactoryTests.cs | 22 ++++++++++++++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs index 2c3d9ed0b..b6bc0acfd 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTaskFactory.cs @@ -328,8 +328,9 @@ public JoinableTask RunAsync(Func> asyncMethod, string? parentToke /// Calling this method will replace the default implementation of /// with one that will not allow such interruptions while that is active and in control of /// . - /// As this method may be called multiple times, this effect remains until all invocations' - /// return values are disposed (in any order). + /// As this method may be called multiple times, this effect remains on the target + /// until all invocations' return values are disposed (in any order). + /// The effect only applies to the direct . It does not affect any of its children or parents. /// /// /// Disabling processing has no effect on non-Windows operating systems. diff --git a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs index 1f02f1f06..b7b8832e0 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskFactoryTests.cs @@ -182,7 +182,7 @@ public void DisableProcessing() } [StaFact] - public void DisableProcessing_Nested() + public void DisableProcessing_NestedProcessingDisabled() { this.asyncPump.Run(() => { @@ -201,6 +201,26 @@ public void DisableProcessing_Nested() }); } + [StaFact] + public void DisableProcessing_NestedTasks() + { + this.asyncPump.Run(() => + { + using (this.asyncPump.DisableProcessing()) + { + this.asyncPump.Run(() => + { + // Child JoinableTasks do not inherit the processing-disabled state of their parents. + this.AssertProcessingAllowed(); + + return Task.CompletedTask; + }); + } + + return Task.CompletedTask; + }); + } + [StaFact] public void DisableProcessing_RefCounted() { From bb3388f8bd183869b948d24784574e614208f0b1 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Apr 2026 13:43:10 -0600 Subject: [PATCH 1661/1753] Add `NoMessagePumpSyncContext..ctor(SynchronizationContext)` for Post/Send behaviors Previously, this class would always schedule work to the threadpool. This doesn't match requirements where the non-pumping code expects to schedule work on the main thread. --- .../NoMessagePumpSyncContext.cs | 48 ++++++ .../NoMessagePumpSyncContextTests.cs | 150 ++++++++++++++++++ 2 files changed, 198 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs index fa92b754c..8bd72aab3 100644 --- a/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs +++ b/src/Microsoft.VisualStudio.Threading/NoMessagePumpSyncContext.cs @@ -20,15 +20,33 @@ public class NoMessagePumpSyncContext : SynchronizationContext /// private static readonly SynchronizationContext DefaultInstance = new NoMessagePumpSyncContext(); + private readonly SynchronizationContext? underlyingSyncContext; + /// /// Initializes a new instance of the class. /// + /// + /// When using this constructor, uses the default + /// behavior and schedules work on the thread pool, while uses the default + /// behavior and invokes the callback synchronously on the calling thread. + /// public NoMessagePumpSyncContext() { // This is required so that our override of Wait is invoked. this.SetWaitNotificationRequired(); } + /// + /// Initializes a new instance of the class. + /// + /// The that should handle calls to and . + public NoMessagePumpSyncContext(SynchronizationContext underlyingSyncContext) + : this() + { + Requires.NotNull(underlyingSyncContext, nameof(underlyingSyncContext)); + this.underlyingSyncContext = underlyingSyncContext; + } + /// /// Gets a shared instance of this class. /// @@ -37,6 +55,36 @@ public static SynchronizationContext Default get { return DefaultInstance; } } + /// + public override void Send(SendOrPostCallback d, object? state) + { + Requires.NotNull(d, nameof(d)); + + if (this.underlyingSyncContext is { } underlying) + { + underlying.Send(d, state); + } + else + { + base.Send(d, state); + } + } + + /// + public override void Post(SendOrPostCallback d, object? state) + { + Requires.NotNull(d, nameof(d)); + + if (this.underlyingSyncContext is { } underlying) + { + underlying.Post(d, state); + } + else + { + base.Post(d, state); + } + } + /// /// Synchronously blocks without a message pump. /// diff --git a/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs index 1c95be9d3..245006e50 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/NoMessagePumpSyncContextTests.cs @@ -3,6 +3,7 @@ using System; using System.Threading; +using System.Threading.Tasks; /// /// Tests for . @@ -36,6 +37,109 @@ public void Default_IsNoMessagePumpSyncContext() Assert.IsType(NoMessagePumpSyncContext.Default); } + /// + /// Verifies that schedules work on the thread pool + /// when no underlying sync context is provided. + /// + [Fact] + public async Task Post_DefaultConstructor_ExecutesOnThreadPool() + { + NoMessagePumpSyncContext sc = new(); + TaskCompletionSource tcs = new(); + sc.Post(_ => tcs.SetResult(Thread.CurrentThread.IsThreadPoolThread), null); + Assert.True(await tcs.Task.WithCancellation(this.TimeoutToken)); + } + + /// + /// Verifies that executes work synchronously + /// on the calling thread when no underlying sync context is provided. + /// + [Fact] + public void Send_DefaultConstructor_ExecutesInlineOnCallingThread() + { + NoMessagePumpSyncContext sc = new(); + int callingThreadId = Thread.CurrentThread.ManagedThreadId; + int? callbackThreadId = null; + bool callbackInvoked = false; + + sc.Send( + _ => + { + callbackInvoked = true; + callbackThreadId = Thread.CurrentThread.ManagedThreadId; + }, + null); + + Assert.True(callbackInvoked); + Assert.Equal(callingThreadId, callbackThreadId); + } + + /// + /// Verifies that throws + /// when a null underlying context is passed. + /// + [Fact] + public void Constructor_WithNullUnderlyingContext_Throws() + { + Assert.Throws(() => new NoMessagePumpSyncContext(null!)); + } + + /// + /// Verifies that rejects a null callback before + /// delegating to the underlying sync context. + /// + [Fact] + public void Post_WithNullCallback_Throws() + { + ThrowingSyncContext underlying = new(); + NoMessagePumpSyncContext sc = new(underlying); + + Assert.Throws(() => sc.Post(null!, null)); + Assert.False(underlying.PostInvoked); + } + + /// + /// Verifies that rejects a null callback before + /// delegating to the underlying sync context. + /// + [Fact] + public void Send_WithNullCallback_Throws() + { + ThrowingSyncContext underlying = new(); + NoMessagePumpSyncContext sc = new(underlying); + + Assert.Throws(() => sc.Send(null!, null)); + Assert.False(underlying.SendInvoked); + } + + /// + /// Verifies that delegates to the underlying + /// sync context when one is provided. + /// + [Fact] + public async Task Post_WithUnderlyingContext_DelegatesToUnderlying() + { + TaskCompletionSource tcs = new(); + RecordingPostSyncContext underlying = new(posted: _ => tcs.SetResult(true)); + NoMessagePumpSyncContext sc = new(underlying); + sc.Post(_ => { }, null); + Assert.True(await tcs.Task.WithCancellation(this.TimeoutToken)); + } + + /// + /// Verifies that delegates to the underlying + /// sync context when one is provided. + /// + [Fact] + public void Send_WithUnderlyingContext_DelegatesToUnderlying() + { + bool sendInvoked = false; + RecordingSendSyncContext underlying = new(sent: _ => sendInvoked = true); + NoMessagePumpSyncContext sc = new(underlying); + sc.Send(_ => { }, null); + Assert.True(sendInvoked); + } + #if NETFRAMEWORK /// /// Establishes the baseline: on a plain STA thread without a special synchronization context, @@ -77,4 +181,50 @@ public void Wait_BlocksComRpcCalls() } } #endif + + /// + /// A that invokes a callback when is called. + /// + private class RecordingPostSyncContext(Action posted) : SynchronizationContext + { + public override void Post(SendOrPostCallback d, object? state) + { + posted(d); + base.Post(d, state); + } + } + + /// + /// A that invokes a callback when is called. + /// + private class RecordingSendSyncContext(Action sent) : SynchronizationContext + { + public override void Send(SendOrPostCallback d, object? state) + { + sent(d); + base.Send(d, state); + } + } + + /// + /// A that records whether or were invoked. + /// + private class ThrowingSyncContext : SynchronizationContext + { + public bool PostInvoked { get; private set; } + + public bool SendInvoked { get; private set; } + + public override void Post(SendOrPostCallback d, object? state) + { + this.PostInvoked = true; + throw new InvalidOperationException(); + } + + public override void Send(SendOrPostCallback d, object? state) + { + this.SendInvoked = true; + throw new InvalidOperationException(); + } + } } From d0fa8d03c8c1d16c5dd1c99d351a0f475a1da8ac Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 25 Apr 2026 00:41:54 +0000 Subject: [PATCH 1662/1753] Update .NET packages to v4 --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index b789106d5..e18f22c38 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -22,8 +22,8 @@ - - + + From 8068d898cbf34263a127febcb4d10e318345db8c Mon Sep 17 00:00:00 2001 From: "CSIGS@microsoft.com" Date: Sat, 25 Apr 2026 09:01:31 -0700 Subject: [PATCH 1663/1753] Juno: check in to juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20260425114721881. (#1580) --- loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ 12 files changed, 108 insertions(+) diff --git a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl index 5168395d6..e4dec9e54 100644 --- a/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CHS/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl index 5d44c68c0..d63dff3e6 100644 --- a/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CHT/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl index d640658d3..20da45a4e 100644 --- a/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/CSY/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl index 087c0d92f..67f888530 100644 --- a/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/DEU/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl index 9ef19b70f..154ae0b95 100644 --- a/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/ESN/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl index acc786527..2fce11fe6 100644 --- a/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/ITA/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl index 04b91b6be..dbfc1d77a 100644 --- a/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/JPN/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl index 0c7c09a2e..0e1fd43ee 100644 --- a/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/KOR/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl index 693c50fde..38944da90 100644 --- a/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/PLK/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl index 284219293..5a4986ab8 100644 --- a/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/PTB/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl index b34aad47c..123e425e5 100644 --- a/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/RUS/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + diff --git a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl index 781c173fc..3d5116402 100644 --- a/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/TRK/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + From 0bc8d5624ac6ab2297b3873f973d50fbb59a096b Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 25 Apr 2026 10:29:35 -0600 Subject: [PATCH 1664/1753] Fix build after dependency upgrade --- Directory.Packages.props | 2 +- global.json | 1 - .../SosThreadingTools.csproj | 5 ++-- .../SosThreadingTools.targets | 23 ++++++++++++++----- 4 files changed, 20 insertions(+), 11 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index e18f22c38..5a869eb8b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -31,7 +31,7 @@ - + diff --git a/global.json b/global.json index 26ea1f754..1ebb0a7a5 100644 --- a/global.json +++ b/global.json @@ -8,7 +8,6 @@ "runner": "Microsoft.Testing.Platform" }, "msbuild-sdks": { - "MSBuild.Sdk.Extras": "3.0.44", "Microsoft.Build.NoTargets": "3.7.134", "Microsoft.Build.Traversal": "4.1.82" } diff --git a/src/SosThreadingTools/SosThreadingTools.csproj b/src/SosThreadingTools/SosThreadingTools.csproj index 8fb9ffbe4..0881f882c 100644 --- a/src/SosThreadingTools/SosThreadingTools.csproj +++ b/src/SosThreadingTools/SosThreadingTools.csproj @@ -1,8 +1,7 @@ - + - net8.0-windows + net10.0-windows win-x86;win-x64 - true true true false diff --git a/src/SosThreadingTools/SosThreadingTools.targets b/src/SosThreadingTools/SosThreadingTools.targets index d53fcec4a..166bb82e5 100644 --- a/src/SosThreadingTools/SosThreadingTools.targets +++ b/src/SosThreadingTools/SosThreadingTools.targets @@ -26,7 +26,7 @@ - + @@ -41,12 +41,23 @@ - + - - - - + <_InnerBuildRid Include="$(RuntimeIdentifiers)" /> + + + + + + + <_PackRid Include="$(RuntimeIdentifiers)" /> + + + From ea0435c5722123fa16b8dae3bb9d6d1da28f37ec Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Sat, 25 Apr 2026 11:51:51 -0600 Subject: [PATCH 1665/1753] Fix VSTHRD103 missing diagnostic for sync extension methods with async alternatives in the same static class (#1569) * Initial plan * Fix VSTHRD103 to detect sync extension methods when async alternative exists in same static class Agent-Logs-Url: https://github.com/microsoft/vs-threading/sessions/d0908deb-1f03-4a2b-8c97-4c4530598e07 Co-authored-by: drewnoakes <350947+drewnoakes@users.noreply.github.com> * Revert accidental nuget.config change (local package source for testing only) Agent-Logs-Url: https://github.com/microsoft/vs-threading/sessions/d0908deb-1f03-4a2b-8c97-4c4530598e07 Co-authored-by: drewnoakes <350947+drewnoakes@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: drewnoakes <350947+drewnoakes@users.noreply.github.com> --- .../VSTHRD103UseAsyncOptionAnalyzer.cs | 12 ++++- .../VSTHRD103UseAsyncOptionAnalyzerTests.cs | 49 +++++++++++++++++++ 2 files changed, 60 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs index a478e12bb..2578f59b8 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/VSTHRD103UseAsyncOptionAnalyzer.cs @@ -132,9 +132,19 @@ internal void AnalyzeInvocation(SyntaxNodeAnalysisContext context) !methodSymbol.HasAsyncCompatibleReturnType()) { string asyncMethodName = methodSymbol.Name + VSTHRD200UseAsyncNamingConventionAnalyzer.MandatoryAsyncSuffix; + + // For reduced extension methods (invoked as instance.Method()), look up the async + // alternative on the receiver type so that extension methods defined in a separate + // static class (but applicable to the receiver) are found via includeReducedExtensionMethods. + // LookupSymbols with the static declaring class as container does not return extension + // methods applicable to the receiver type. + INamespaceOrTypeSymbol lookupContainer = methodSymbol.ReducedFrom is { } reducedFrom && reducedFrom.Parameters.Length > 0 + ? (INamespaceOrTypeSymbol)reducedFrom.Parameters[0].Type + : methodSymbol.ContainingType; + ImmutableArray symbols = context.SemanticModel.LookupSymbols( invocationExpressionSyntax.Expression.GetLocation().SourceSpan.Start, - methodSymbol.ContainingType, + lookupContainer, asyncMethodName, includeReducedExtensionMethods: true); diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs index cdeb73583..0e27c2c55 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD103UseAsyncOptionAnalyzerTests.cs @@ -1410,6 +1410,55 @@ async Task BarAsync(int id) { await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task SyncExtensionMethodWhereAsyncAlternativeExistsInSameStaticClassGeneratesWarning() + { + var test = @" +using System.Threading.Tasks; + +public interface IExecutable { } + +public static class ExecutableExtensions +{ + public static string GetOutput(this IExecutable executable) => """"; + public static Task GetOutputAsync(this IExecutable executable) => Task.FromResult(""""); +} + +class Test +{ + async Task DoWorkAsync() + { + IExecutable exec = null!; + string result = exec.{|#0:GetOutput|}(); + } +} +"; + + var withFix = @" +using System.Threading.Tasks; + +public interface IExecutable { } + +public static class ExecutableExtensions +{ + public static string GetOutput(this IExecutable executable) => """"; + public static Task GetOutputAsync(this IExecutable executable) => Task.FromResult(""""); +} + +class Test +{ + async Task DoWorkAsync() + { + IExecutable exec = null!; + string result = await exec.GetOutputAsync(); + } +} +"; + + DiagnosticResult expected = CSVerify.Diagnostic(Descriptor).WithLocation(0).WithArguments("GetOutput", "GetOutputAsync"); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } + private DiagnosticResult CreateDiagnostic(int line, int column, int length, string methodName) => CSVerify.Diagnostic(DescriptorNoAlternativeMethod).WithSpan(line, column, line, column + length).WithArguments(methodName); From cbf54de73f617abe1eb3bfd56eadddd273a6f379 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sun, 26 Apr 2026 16:40:34 -0600 Subject: [PATCH 1666/1753] Update NuGet/login action to v1.2.0 (512) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a14587a7d..7b1332218 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -79,7 +79,7 @@ jobs: github-token: ${{ github.token }} - name: 🪪 Authorize NuGet package push - uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1.1.0 + uses: NuGet/login@8d196754b4036150537f80ac539e15c2f1028841 # v1.2.0 id: nuget-login with: user: ${{ secrets.NUGET_USER }} From da99eddf2c5d7b056e89e9e6e3ce48e593e00824 Mon Sep 17 00:00:00 2001 From: "CSIGS@microsoft.com" Date: Mon, 27 Apr 2026 09:39:01 -0700 Subject: [PATCH 1667/1753] Merge pull request #1581 from microsoft/juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20260426114702253 LEGO: Pull request from juno/hb_f2f230f9-08b4-4714-af00-6fce66aaeb84_20260426114702253 to main --- loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl index 7994090ff..541874b3a 100644 --- a/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl +++ b/loc/lcl/FRA/Microsoft.VisualStudio.Threading.dll.lcl @@ -131,6 +131,15 @@ + + + + + + + + + From 81a01d8d5da7280da2fc7197528dfb3fc58af9ca Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 29 Apr 2026 09:07:44 -0600 Subject: [PATCH 1668/1753] Ignore C# Dev Kit generated cache files --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index cc2b12470..31ec35418 100644 --- a/.gitignore +++ b/.gitignore @@ -358,3 +358,6 @@ MigrationBackup/ # Analysis results *.sarif + +# C# Dev Kit cache files +*.lscache From 16dd4d1df95076263c1eaaddb06c25f647d28864 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 30 Apr 2026 10:01:58 -0600 Subject: [PATCH 1669/1753] Update Microsoft Testing Platform to 2.2.2 (514) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c20bfdc12..398de4866 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.2.1 + 2.2.2 From df9e05a97240eb49707350b8202287fe163ebf32 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 9 May 2026 06:56:43 -0600 Subject: [PATCH 1670/1753] Update dependency nerdbank.dotnetrepotools to v1.4.1 (515) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 781fe3cf3..777e86bfd 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.3.22", + "version": "1.4.1", "commands": [ "repo" ], From aa6e14adfa33d83406fa8b116d1f953d8ff73b94 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 07:59:49 -0600 Subject: [PATCH 1671/1753] Update Dockerfile and global.json updates to v10.0.300 (516) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 5344ba504..1b6732ac7 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.203@sha256:8a90a473da5205a16979de99d2fc20975e922c68304f5c79d564e666dc3982fc +FROM mcr.microsoft.com/dotnet/sdk:10.0.300@sha256:dc8430e6024d454edadad1e160e1973be3cabbb7125998ef190d9e5c6adf7dbb # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 441e15ad5..bc8f3b85f 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.203", + "version": "10.0.300", "rollForward": "patch", "allowPrerelease": false }, From 4c83df672f6127f1cb5432a2d7db418118eb453a Mon Sep 17 00:00:00 2001 From: "microsoft-github-policy-service[bot]" <77245923+microsoft-github-policy-service[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 04:54:42 +0000 Subject: [PATCH 1672/1753] Auto-generated baselines by 1ES Pipeline Templates (#1587) * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=8123 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=10178215 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=8123 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=10182291 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=13635 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=10182518 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=8123 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=10642213 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=17763 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=10819386 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=25079 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=10852729 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=25079 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=11801419 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=8123 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=11806555 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=13635 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=11806752 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=17763 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=11946930 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=25079 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=14087567 * Updated for https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build?definitionId=8123 by using baselines generated in https://dev.azure.com/devdiv/0bdbc590-a062-4c3f-b0f6-9383f67865ee/_build/results?buildId=14094116 --------- Co-authored-by: microsoft-github-policy-service[bot] <77245923+microsoft-github-policy-service[bot]@users.noreply.github.com> --- .../1espt/PipelineAutobaseliningConfig.yml | 68 ++++++++++++++++++ .config/guardian/.gdnbaselines | 72 +++++++++++++++++++ 2 files changed, 140 insertions(+) create mode 100644 .config/1espt/PipelineAutobaseliningConfig.yml create mode 100644 .config/guardian/.gdnbaselines diff --git a/.config/1espt/PipelineAutobaseliningConfig.yml b/.config/1espt/PipelineAutobaseliningConfig.yml new file mode 100644 index 000000000..746296617 --- /dev/null +++ b/.config/1espt/PipelineAutobaseliningConfig.yml @@ -0,0 +1,68 @@ +## DO NOT MODIFY THIS FILE MANUALLY. This is part of auto-baselining from 1ES Pipeline Templates. Go to [https://aka.ms/1espt-autobaselining] for more details. + +pipelines: + 8123: + retail: + source: + credscan: + lastModifiedDate: 2024-09-06 + eslint: + lastModifiedDate: 2026-05-14 + armory: + lastModifiedDate: 2026-05-14 + policheck: + lastModifiedDate: 2026-05-14 + psscriptanalyzer: + lastModifiedDate: 2026-05-14 + accessibilityinsights: + lastModifiedDate: 2025-06-21 + binary: + credscan: + lastModifiedDate: 2024-09-06 + binskim: + lastModifiedDate: 2026-05-14 + spotbugs: + lastModifiedDate: 2026-05-14 + usedNonDefaultBranch: true + 13635: + retail: + source: + credscan: + lastModifiedDate: 2024-09-07 + eslint: + lastModifiedDate: 2024-09-07 + psscriptanalyzer: + lastModifiedDate: 2024-09-07 + armory: + lastModifiedDate: 2024-09-07 + accessibilityinsights: + lastModifiedDate: 2025-06-21 + 17763: + retail: + source: + credscan: + lastModifiedDate: 2025-01-13 + eslint: + lastModifiedDate: 2025-01-13 + psscriptanalyzer: + lastModifiedDate: 2025-01-13 + armory: + lastModifiedDate: 2025-01-13 + accessibilityinsights: + lastModifiedDate: 2025-07-13 + 25079: + retail: + source: + credscan: + lastModifiedDate: 2025-01-17 + eslint: + lastModifiedDate: 2025-01-17 + armory: + lastModifiedDate: 2025-01-17 + accessibilityinsights: + lastModifiedDate: 2025-06-20 + binary: + credscan: + lastModifiedDate: 2025-01-17 + binskim: + lastModifiedDate: 2025-01-17 diff --git a/.config/guardian/.gdnbaselines b/.config/guardian/.gdnbaselines new file mode 100644 index 000000000..ab8c543bd --- /dev/null +++ b/.config/guardian/.gdnbaselines @@ -0,0 +1,72 @@ +{ + "properties": { + "helpUri": "https://eng.ms/docs/microsoft-security/security/azure-security/cloudai-security-fundamentals-engineering/security-integration/guardian-wiki/microsoft-guardian/general/baselines" + }, + "version": "1.0.0", + "baselines": { + "default": { + "name": "default", + "createdDate": "2026-05-14 03:47:36Z", + "lastUpdatedDate": "2026-05-14 03:47:36Z" + } + }, + "results": { + "dbff8dc971433ca7c818c690a4ae28b107c7e546bc335b049fabe2e160f0e628": { + "signature": "dbff8dc971433ca7c818c690a4ae28b107c7e546bc335b049fabe2e160f0e628", + "alternativeSignatures": [ + "c02350748c2f2ca142c3e8ae36ede02fda37ded67cb625a18294826debb8b022", + "b66593a9d8a961d03e7a676fc73a7c92acf9752f6030227a1867dc4b16280108", + "efb2054ac15706638108be5009009b5ba37343dce3caa258a39db002c4b88b9f" + ], + "target": "src/Microsoft.VisualStudio.Threading.Analyzers/AbstractVSTHRD110ObserveResultOfAsyncCallsAnalyzer.cs", + "line": 130, + "uriBaseId": "file:///D:/a/_work/1/s/", + "memberOf": [ + "default" + ], + "tool": "roslynanalyzers", + "ruleId": "CA1310", + "createdDate": "2026-05-14 03:47:36Z", + "expirationDate": "2026-10-31 04:34:32Z", + "justification": "This error is baselined with an expiration date of 180 days from 2026-05-14 04:34:32Z" + }, + "958ce3ce50b885fffd9057ceb48c553e916907958a3e8d423a3f79a0e9388708": { + "signature": "958ce3ce50b885fffd9057ceb48c553e916907958a3e8d423a3f79a0e9388708", + "alternativeSignatures": [ + "3f4623ce40b316b0f163abc6400237af661fc4b06722531df8d09350c1f2eddc", + "ad182cab3408ce61b793d348de8b5a1732b19094d97231d000e6a0ac2c873a15", + "066d02f45b528967d832e064f7c0ee32e8edd8c0dce2d19da340d916baa39c92" + ], + "target": "test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs", + "line": 61, + "uriBaseId": "file:///D:/a/_work/1/s/", + "memberOf": [ + "default" + ], + "tool": "roslynanalyzers", + "ruleId": "CA1307", + "createdDate": "2026-05-14 03:47:36Z", + "expirationDate": "2026-10-31 04:34:32Z", + "justification": "This error is baselined with an expiration date of 180 days from 2026-05-14 04:34:32Z" + }, + "d42f90bce28d3afe46faac67d711461f29995ee74a396bc9298f743af6c3bed6": { + "signature": "d42f90bce28d3afe46faac67d711461f29995ee74a396bc9298f743af6c3bed6", + "alternativeSignatures": [ + "fe52ee2339bc08550c0f5f481b6ad5abdd2b454d4ac85937dbd9e1b84f17156e", + "d688160bab0f20b29f2c7d0c04997973a608a9ce5e4222ee39142cdea765bd5a", + "fd005193dd710be4c2450f024a68c79f2be97321323c35e043d9c282cade492c" + ], + "target": "test/Microsoft.VisualStudio.Threading.Tests/JoinableTaskTokenTests.cs", + "line": 194, + "uriBaseId": "file:///D:/a/_work/1/s/", + "memberOf": [ + "default" + ], + "tool": "roslynanalyzers", + "ruleId": "CA1307", + "createdDate": "2026-05-14 03:47:36Z", + "expirationDate": "2026-10-31 04:34:32Z", + "justification": "This error is baselined with an expiration date of 180 days from 2026-05-14 04:34:32Z" + } + } +} \ No newline at end of file From 50290571365add4a439306c249c338c474520c2b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 15 May 2026 17:48:26 -0600 Subject: [PATCH 1673/1753] Update Microsoft Testing Platform to 2.2.3 (517) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 398de4866..15b07759f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.2.2 + 2.2.3 From f24b9f116bf073eac8ffbf94a5cf3377ff893665 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 18 May 2026 13:39:23 -0600 Subject: [PATCH 1674/1753] Update dependency Microsoft.Testing.Extensions.CodeCoverage to 18.7.0 (519) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 15b07759f..45a63a64c 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From 1de022c1dedcd670f196ab5e930628e96dd656fe Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 18 May 2026 13:39:35 -0600 Subject: [PATCH 1675/1753] Update dependency dotnet-coverage to v18.7.0 (518) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 777e86bfd..9769f1b40 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.6.2", + "version": "18.7.0", "commands": [ "dotnet-coverage" ], From a5761756d78c15aa3c2d360f148356fb4333fd33 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 20 May 2026 12:00:09 -0600 Subject: [PATCH 1676/1753] Update dependency DNNE to 2.1.2 (#1574) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index c11799795..6de390a18 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -11,7 +11,7 @@ 3.11.0-beta1.26075.3 - + From caa057e4738bcb1a2fc57db1ffa2774964862584 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 06:56:28 -0600 Subject: [PATCH 1677/1753] Update mcr.microsoft.com/dotnet/sdk:10.0.300 Docker digest to c079063 (520) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 1b6732ac7..810a6ed62 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.300@sha256:dc8430e6024d454edadad1e160e1973be3cabbb7125998ef190d9e5c6adf7dbb +FROM mcr.microsoft.com/dotnet/sdk:10.0.300@sha256:c0790639332692a0d56cdd81ed581cfd24d040d9839764c138994866df89a3b6 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From e7468d63c0882b20043187b8a80845a516d4d4b7 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 20:46:25 +0000 Subject: [PATCH 1678/1753] Update dependency powershell to v7.6.2 (#521) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9769f1b40..a5037f9ea 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.6.1", + "version": "7.6.2", "commands": [ "pwsh" ], From 08ad1ded6d1bd8cf617e85be9d00747e69433a42 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 25 May 2026 20:56:48 -0600 Subject: [PATCH 1679/1753] Update dependency PolySharp to 1.16.0 (#522) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 45a63a64c..a10e35497 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -24,7 +24,7 @@ - + From 3bdfd03e728296005215aaa052ccab20f14a086b Mon Sep 17 00:00:00 2001 From: Artur Spychaj Date: Tue, 26 May 2026 04:57:11 +0200 Subject: [PATCH 1680/1753] Fix Install-DotNetSdk.ps1 hang from recursive Directory.Build.props search (#513) * Fix Install-DotNetSdk.ps1 hang from recursive Directory.Build.props search The Get-ChildItem call applied -Recurse to all three path arguments, including Directory.Build.props. PowerShell splits this into container + leaf filter, so -Recurse causes it to search the entire repo root for every file named Directory.Build.props, crawling into large directories (bin, obj, tmp, etc.) and causing the script to hang. Split the call so -Recurse only applies to the src/ and test/ project file globs. Directory.Build.props is fetched with Get-Item -LiteralPath (single file, no recursion, no wildcard interpretation). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Recursively search src/ and test/ for Directory.Build.props Address review feedback: keep recursive Directory.Build.props discovery under src/ and test/, while still picking up the repo-root file. Avoids crawling top-level bin/obj/tmp directories. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: drognanar <3418274+drognanar@users.noreply.github.com> --- tools/Install-DotNetSdk.ps1 | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index 590581e26..d9d35bb1e 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -59,7 +59,10 @@ $runtimeVersions = @() $windowsDesktopRuntimeVersions = @() $aspnetRuntimeVersions = @() if (!$SdkOnly) { - Get-ChildItem "$PSScriptRoot\..\src\*.*proj", "$PSScriptRoot\..\test\*.*proj", "$PSScriptRoot\..\Directory.Build.props" -Recurse | % { + $projFiles = Get-ChildItem "$PSScriptRoot\..\src\*.*proj", "$PSScriptRoot\..\test\*.*proj" -Recurse + $projFiles += Get-ChildItem "$PSScriptRoot\..\src\Directory.Build.props", "$PSScriptRoot\..\test\Directory.Build.props" -Recurse + $projFiles += Get-Item -LiteralPath "$PSScriptRoot\..\Directory.Build.props" + $projFiles | % { $projXml = [xml](Get-Content -LiteralPath $_) $pg = $projXml.Project.PropertyGroup if ($pg) { From 14a7d275d59780ea380bfbb9992baaefeb918c83 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Jun 2026 08:55:44 -0600 Subject: [PATCH 1681/1753] Call out `dotnet-test-cloud.ps1` script --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4322a7ba..05e4d16b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,11 @@ This repository can be built on Windows, Linux, and OSX. Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). -[pwsh]: https://learn.microsoft.com/powershell/scripting/install/installing-powershell +## Testing + +You can use `dotnet test` to build and/or test the repo. + +There may be tests that are known to be unstable or have special requirements. These can be avoided by running tests using the [dotnet-test-cloud.ps1](tools/dotnet-test-cloud.ps1) script *after* running `dotnet build`. ## Releases @@ -96,3 +100,5 @@ git checkout origin/main # resolve any conflicts, then commit the merge commit. git push origin -u HEAD ``` + +[pwsh]: https://learn.microsoft.com/powershell/scripting/install/installing-powershell From 8be6654ffab1359c69821619911bda4f072e165d Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Jun 2026 11:24:36 -0600 Subject: [PATCH 1682/1753] Add Copilot skill for bundling dependency update PRs --- .github/skills/bundle-dependency-prs/SKILL.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/skills/bundle-dependency-prs/SKILL.md diff --git a/.github/skills/bundle-dependency-prs/SKILL.md b/.github/skills/bundle-dependency-prs/SKILL.md new file mode 100644 index 000000000..50f8b557a --- /dev/null +++ b/.github/skills/bundle-dependency-prs/SKILL.md @@ -0,0 +1,42 @@ +--- +name: bundle-dependency-prs +description: Fix broken dependency update PRs and aggregate the ones that work into one PR. +disable-model-invocation: true +--- + +# Instructions + +You have two goals: + +1. Get all dependency PRs to a state where their PR checks pass. +2. Aggregate dependency PRs with passing checks into just one PR. + +You can identify dependency update PRs by those authored by `dependabot` or `renovate`. + +You'll find instructions for building and validating the repo in the [CONTRIBUTING.md](../../../CONTRIBUTING.md) doc. +Always validate your changes locally before pushing them to the remote repository. + +When writing PR bodies or comments, avoid unmatched markdown code fences. Keep markdown well-formed. + +## Fix up dependency PRs with failing checks + +Before aggregating PRs, first try to fix any individual dependency update PRs with failing build/test checks. + +1. For the dependency PRs with failing build or test PR checks, check out their source branch and fix any issues. +2. Push your fixes as fresh commits to the individual dependency PRs. +3. If you can't fix a particular PR, add a comment to the PR describing your attempt and outcome. + +## Group dependency PRs that are ready to go + +Your next goal is to collect all the dependency updates that are ready to go into a single PR. + +1. Prepare a local branch called `bulkDepUpdates`. + 1. Consider that a remote branch by the same name may already exist. If it does, base your local branch on it. + 2. Merge `origin/main` into this branch. + 3. Resolve any conflicts. +2. For the dependency PRs whose build and test PR checks already pass, merge them into the `bulkDepUpdates` branch. + Consider that your local branch may have already merged an equivalent PR in the past (from a past run). If so, you should skip merging that PR. + Resolve any conflicts. + Build and run tests to validate your branch. +3. Push the branch. +4. Create a PR, if one does not already exist. From e6bb7a16e9aeb35b4e6af6fae116e7051ee96263 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 2 Jun 2026 11:49:47 -0600 Subject: [PATCH 1683/1753] Call out docfx checks when bundling dependency update PRs --- .github/skills/bundle-dependency-prs/SKILL.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/skills/bundle-dependency-prs/SKILL.md b/.github/skills/bundle-dependency-prs/SKILL.md index 50f8b557a..a147e81e0 100644 --- a/.github/skills/bundle-dependency-prs/SKILL.md +++ b/.github/skills/bundle-dependency-prs/SKILL.md @@ -18,6 +18,9 @@ Always validate your changes locally before pushing them to the remote repositor When writing PR bodies or comments, avoid unmatched markdown code fences. Keep markdown well-formed. +For purposes of assessing PR readiness by its PR checks, consider docfx related checks to be irrelevant. +If a docfx check fails but all other checks succeed, then that is a 'successful' dependency update PR. + ## Fix up dependency PRs with failing checks Before aggregating PRs, first try to fix any individual dependency update PRs with failing build/test checks. From 81b34965726bf8bea093822bde1528e9aad32af5 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 2 Jun 2026 14:55:04 -0600 Subject: [PATCH 1684/1753] Update actions/checkout action to v6.0.3 (523) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 26bc9eb48..69e7ae4f8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,7 +28,7 @@ jobs: - windows-2025 steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -75,7 +75,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 3c032fae7..d933871a5 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fbfcd1440..99b3c0583 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 62a6417df..fc8a631f6 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From 2816e2020f300f27f1abf943f6db0e49ed7badb9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 3 Jun 2026 07:06:04 -0600 Subject: [PATCH 1685/1753] Update dependency nerdbank.dotnetrepotools to v1.5.6 (524) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index a5037f9ea..d0e7d7ff0 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.4.1", + "version": "1.5.6", "commands": [ "repo" ], From dba613e0d4a1a94250ea4224450e3cea68c89f60 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 4 Jun 2026 14:30:25 -0600 Subject: [PATCH 1686/1753] Update dependency nerdbank.dotnetrepotools to v1.5.15 (525) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index d0e7d7ff0..e11e39cba 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -31,7 +31,7 @@ "rollForward": false }, "nerdbank.dotnetrepotools": { - "version": "1.5.6", + "version": "1.5.15", "commands": [ "repo" ], From cd79894c0736662230511b03853e4ceff353f5ef Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 8 Jun 2026 15:56:58 -0600 Subject: [PATCH 1687/1753] Update dependency dotnet-coverage to v18.8.0 (526) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index e11e39cba..f88bae603 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.7.0", + "version": "18.8.0", "commands": [ "dotnet-coverage" ], From 03a29b92ffecc6951c3379a3b737db47ae7dfbde Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 10 Jun 2026 03:55:42 +0000 Subject: [PATCH 1688/1753] Update Dockerfile and global.json updates to v10.0.301 (527) * Update Dockerfile and global.json updates to v10.0.301 * Bump global.json too --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 810a6ed62..08c018507 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.300@sha256:c0790639332692a0d56cdd81ed581cfd24d040d9839764c138994866df89a3b6 +FROM mcr.microsoft.com/dotnet/sdk:10.0.301@sha256:548d93f8a18a1acbe6cc127bc4f47281430d34a9e35c18afa80a8d6741c2adc3 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index bc8f3b85f..4c9fb87c8 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.300", + "version": "10.0.301", "rollForward": "patch", "allowPrerelease": false }, From d48cdf885d0e3661e442b5b955d3195469f298ff Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Jun 2026 07:20:24 -0600 Subject: [PATCH 1689/1753] Fix GitHub Actions env file writes (528) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Use explicit UTF-8 appends for GitHub Actions environment files so Linux runners don't hit an invalid empty-name env entry after build. This updates both the general env propagation helper and the pipeline variable definition script. Co-authored-by: 🤖 Copilot Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- tools/Set-EnvVars.ps1 | 16 ++++++++++++++-- tools/variables/_define.ps1 | 14 +++++++++++++- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index 2bd3ca4db..460e63e30 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -43,6 +43,18 @@ if ($env:GITHUB_ACTIONS) { Write-Host "GitHub Actions detected. Logging commands will be used to propagate environment variables and prepend path." } +function Add-GitHubActionsFileCommand { + param( + [Parameter(Mandatory = $true)] + [string]$Path, + [Parameter(Mandatory = $true)] + [string]$Value + ) + + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) + [System.IO.File]::AppendAllText($Path, "$Value`n", $utf8NoBom) +} + $CmdEnvScript = '' $Variables.GetEnumerator() |% { Set-Item -LiteralPath env:$($_.Key) -Value $_.Value @@ -52,7 +64,7 @@ $Variables.GetEnumerator() |% { Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" } if ($env:GITHUB_ACTIONS) { - Add-Content -LiteralPath $env:GITHUB_ENV -Value "$($_.Key)=$($_.Value)" + Add-GitHubActionsFileCommand -Path $env:GITHUB_ENV -Value "$($_.Key)=$($_.Value)" } if ($cmdInstructions) { @@ -79,7 +91,7 @@ if ($PrependPath) { Write-Host "##vso[task.prependpath]$_" } if ($env:GITHUB_ACTIONS) { - Add-Content -LiteralPath $env:GITHUB_PATH -Value $_ + Add-GitHubActionsFileCommand -Path $env:GITHUB_PATH -Value $_ } $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" diff --git a/tools/variables/_define.ps1 b/tools/variables/_define.ps1 index d40e5cf14..8cb536c21 100644 --- a/tools/variables/_define.ps1 +++ b/tools/variables/_define.ps1 @@ -11,6 +11,18 @@ param ( ) +function Add-GitHubActionsFileCommand { + param( + [Parameter(Mandatory = $true)] + [string]$Path, + [Parameter(Mandatory = $true)] + [string]$Value + ) + + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) + [System.IO.File]::AppendAllText($Path, "$Value`n", $utf8NoBom) +} + (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. $keyCaps = $_.Key.ToUpper() @@ -24,7 +36,7 @@ param ( # and the second that works across jobs and stages but must be fully qualified when referenced. Write-Host "##vso[task.setvariable variable=$keyCaps;isOutput=true]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { - Add-Content -LiteralPath $env:GITHUB_ENV -Value "$keyCaps=$($_.Value)" + Add-GitHubActionsFileCommand -Path $env:GITHUB_ENV -Value "$keyCaps=$($_.Value)" } Set-Item -LiteralPath "env:$keyCaps" -Value $_.Value } From d3e365b987508e1b54c86808674841b2c98bc066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=F0=9F=A4=96=20Copilot?= Date: Wed, 10 Jun 2026 07:20:32 -0600 Subject: [PATCH 1690/1753] Normalize Win7 watcher test path Normalize the helper executable path before calling Process.Start so the Win7 registry watcher test works under the current Microsoft.Testing.Platform runner. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../AwaitExtensionsTests.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs index 1a8bad136..a120ec547 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AwaitExtensionsTests.cs @@ -790,7 +790,7 @@ public async Task AwaitRegKeyChange_CallingThreadDestroyed() public async Task AwaitRegKeyChange_DoesNotPreventAppTerminationOnWin7() { Assert.SkipUnless(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), "Windows only"); - string testExePath = Path.Combine( + string testExePath = Path.GetFullPath(Path.Combine( AppDomain.CurrentDomain.BaseDirectory!, "..", "..", @@ -802,7 +802,7 @@ public async Task AwaitRegKeyChange_DoesNotPreventAppTerminationOnWin7() "Release", #endif "net472", - "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.exe"); + "Microsoft.VisualStudio.Threading.Tests.Win7RegistryWatcher.exe")); this.Logger.WriteLine("Using testexe path: {0}", testExePath); var psi = new ProcessStartInfo(testExePath) { From 910fad855551262c156477cf9d50d04b54c61a3e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Jun 2026 10:48:58 -0600 Subject: [PATCH 1691/1753] Update actions/checkout action to v6.0.3 --- .github/workflows/docs_validate.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index fa08fdb0c..96e06329a 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -13,7 +13,7 @@ jobs: name: 📚 Doc validation runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: 🔗 Markup Link Checker (mlc) From 72ac8a906ecacc231b03fe992280f97ad9029ab6 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 10 Jun 2026 12:02:31 -0600 Subject: [PATCH 1692/1753] Improve PR checks after fixing dependency PRs --- .github/skills/bundle-dependency-prs/SKILL.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/skills/bundle-dependency-prs/SKILL.md b/.github/skills/bundle-dependency-prs/SKILL.md index a147e81e0..48dedbe9b 100644 --- a/.github/skills/bundle-dependency-prs/SKILL.md +++ b/.github/skills/bundle-dependency-prs/SKILL.md @@ -27,6 +27,7 @@ Before aggregating PRs, first try to fix any individual dependency update PRs wi 1. For the dependency PRs with failing build or test PR checks, check out their source branch and fix any issues. 2. Push your fixes as fresh commits to the individual dependency PRs. + If pushing to a repo in the `microsoft` org when the PR is authord by `renovate`, follow-up the push with a PR comment that says exactly this: "/azp run" which triggers PR checks to re-run. 3. If you can't fix a particular PR, add a comment to the PR describing your attempt and outcome. ## Group dependency PRs that are ready to go From 937aeb05c332bdc78f26e6420a7bd4438182ab83 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 11 Jun 2026 08:12:59 -0600 Subject: [PATCH 1693/1753] Update Microsoft Testing Platform to 18.8.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index a10e35497..8630c4587 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From ae58ae90c19527586198dc12f170c849c10d0a53 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 13 Jun 2026 14:40:21 +0000 Subject: [PATCH 1694/1753] Update dependency Microsoft.Windows.CsWin32 to 0.3.287 (#1599) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 11d4d25fa..67e28e5af 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From b6a83ba2146af6803ca285d9e3f899db641cd420 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 13 Jun 2026 15:00:59 +0000 Subject: [PATCH 1695/1753] Update CodefixTestingVersion to 1.1.4 (#1598) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 67e28e5af..3c8e40bd9 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -7,7 +7,7 @@ 2.2.3 2.0.226 3.11.0 - 1.1.3 + 1.1.4 3.11.0-beta1.26075.3 From 8ce74d4fc06c1923546ca84e8431b83a362f86d8 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jun 2026 08:32:30 -0600 Subject: [PATCH 1696/1753] Support multi-line env var values properly --- tools/Set-EnvVars.ps1 | 24 ++++++++++++++++-------- tools/variables/_define.ps1 | 14 +++++++++++--- 2 files changed, 27 insertions(+), 11 deletions(-) diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index 460e63e30..6fa4ffb9c 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -43,16 +43,24 @@ if ($env:GITHUB_ACTIONS) { Write-Host "GitHub Actions detected. Logging commands will be used to propagate environment variables and prepend path." } -function Add-GitHubActionsFileCommand { +function Add-GitHubActionsEnvVariable { param( [Parameter(Mandatory = $true)] [string]$Path, [Parameter(Mandatory = $true)] - [string]$Value - ) - - $utf8NoBom = [System.Text.UTF8Encoding]::new($false) - [System.IO.File]::AppendAllText($Path, "$Value`n", $utf8NoBom) + [string]$Name, + [Parameter(Mandatory = $true)] + [AllowEmptyString()] + [string]$Value + ) + + if ([string]::IsNullOrWhiteSpace($Name)) { + throw "GitHub Actions environment variable names must not be empty." + } + + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) + $delimiter = [guid]::NewGuid().ToString('N') + [System.IO.File]::AppendAllText($Path, "$Name<<$delimiter`n$Value`n$delimiter`n", $utf8NoBom) } $CmdEnvScript = '' @@ -64,7 +72,7 @@ $Variables.GetEnumerator() |% { Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" } if ($env:GITHUB_ACTIONS) { - Add-GitHubActionsFileCommand -Path $env:GITHUB_ENV -Value "$($_.Key)=$($_.Value)" + Add-GitHubActionsEnvVariable -Path $env:GITHUB_ENV -Name $_.Key -Value ([string]$_.Value) } if ($cmdInstructions) { @@ -91,7 +99,7 @@ if ($PrependPath) { Write-Host "##vso[task.prependpath]$_" } if ($env:GITHUB_ACTIONS) { - Add-GitHubActionsFileCommand -Path $env:GITHUB_PATH -Value $_ + Add-GitHubActionsEnvVariable -Path $env:GITHUB_ENV -Name PATH -Value $newPathValue } $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" diff --git a/tools/variables/_define.ps1 b/tools/variables/_define.ps1 index 8cb536c21..4a8503d9c 100644 --- a/tools/variables/_define.ps1 +++ b/tools/variables/_define.ps1 @@ -11,16 +11,24 @@ param ( ) -function Add-GitHubActionsFileCommand { +function Add-GitHubActionsEnvVariable { param( [Parameter(Mandatory = $true)] [string]$Path, [Parameter(Mandatory = $true)] + [string]$Name, + [Parameter(Mandatory = $true)] + [AllowEmptyString()] [string]$Value ) + if ([string]::IsNullOrWhiteSpace($Name)) { + throw "GitHub Actions environment variable names must not be empty." + } + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) - [System.IO.File]::AppendAllText($Path, "$Value`n", $utf8NoBom) + $delimiter = [guid]::NewGuid().ToString('N') + [System.IO.File]::AppendAllText($Path, "$Name<<$delimiter`n$Value`n$delimiter`n", $utf8NoBom) } (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { @@ -36,7 +44,7 @@ function Add-GitHubActionsFileCommand { # and the second that works across jobs and stages but must be fully qualified when referenced. Write-Host "##vso[task.setvariable variable=$keyCaps;isOutput=true]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { - Add-GitHubActionsFileCommand -Path $env:GITHUB_ENV -Value "$keyCaps=$($_.Value)" + Add-GitHubActionsEnvVariable -Path $env:GITHUB_ENV -Name $keyCaps -Value ([string]$_.Value) } Set-Item -LiteralPath "env:$keyCaps" -Value $_.Value } From 22ebcf56330c216c8b39d6b746b05b3ebda78c58 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 15 Jun 2026 08:36:28 -0600 Subject: [PATCH 1697/1753] Centralize the github env var function --- tools/GitHubActions.ps1 | 18 ++++++++++++++++++ tools/Set-EnvVars.ps1 | 37 ++++++++++--------------------------- tools/variables/_define.ps1 | 22 ++-------------------- 3 files changed, 30 insertions(+), 47 deletions(-) create mode 100644 tools/GitHubActions.ps1 diff --git a/tools/GitHubActions.ps1 b/tools/GitHubActions.ps1 new file mode 100644 index 000000000..c742a5888 --- /dev/null +++ b/tools/GitHubActions.ps1 @@ -0,0 +1,18 @@ +function Add-GitHubActionsEnvVariable { + param( + [string]$Path = $env:GITHUB_ENV, + [Parameter(Mandatory = $true)] + [string]$Name, + [Parameter(Mandatory = $true)] + [AllowEmptyString()] + [string]$Value + ) + + if ([string]::IsNullOrWhiteSpace($Name)) { + throw "GitHub Actions environment variable names must not be empty." + } + + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) + $delimiter = [guid]::NewGuid().ToString('N') + [System.IO.File]::AppendAllText($Path, "$Name<<$delimiter`n$Value`n$delimiter`n", $utf8NoBom) +} diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index 6fa4ffb9c..0816c0e2c 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -12,13 +12,15 @@ The CmdEnvScriptPath environment variable may be optionally set to a path to a cmd shell script to be created (or appended to if it already exists) that will set the environment variables in cmd.exe that are set within the PowerShell environment. This is used by init.cmd in order to reapply any new environment variables to the parent cmd.exe process that were set in the powershell child process. #> -[CmdletBinding(SupportsShouldProcess=$true)] +[CmdletBinding(SupportsShouldProcess = $true)] Param( - [Parameter(Mandatory=$true, Position=1)] + [Parameter(Mandatory = $true, Position = 1)] $Variables, [string[]]$PrependPath ) +. "$PSScriptRoot\GitHubActions.ps1" + if ($Variables.Count -eq 0) { return $true } @@ -27,7 +29,8 @@ $cmdInstructions = !$env:TF_BUILD -and !$env:GITHUB_ACTIONS -and !$env:CmdEnvScr if ($cmdInstructions) { Write-Warning "Environment variables have been set that will be lost because you're running under cmd.exe" Write-Host "Environment variables that must be set manually:" -ForegroundColor Blue -} else { +} +else { Write-Host "Environment variables set:" -ForegroundColor Blue Write-Host ($Variables | Out-String) if ($PrependPath) { @@ -43,28 +46,8 @@ if ($env:GITHUB_ACTIONS) { Write-Host "GitHub Actions detected. Logging commands will be used to propagate environment variables and prepend path." } -function Add-GitHubActionsEnvVariable { - param( - [Parameter(Mandatory = $true)] - [string]$Path, - [Parameter(Mandatory = $true)] - [string]$Name, - [Parameter(Mandatory = $true)] - [AllowEmptyString()] - [string]$Value - ) - - if ([string]::IsNullOrWhiteSpace($Name)) { - throw "GitHub Actions environment variable names must not be empty." - } - - $utf8NoBom = [System.Text.UTF8Encoding]::new($false) - $delimiter = [guid]::NewGuid().ToString('N') - [System.IO.File]::AppendAllText($Path, "$Name<<$delimiter`n$Value`n$delimiter`n", $utf8NoBom) -} - $CmdEnvScript = '' -$Variables.GetEnumerator() |% { +$Variables.GetEnumerator() | % { Set-Item -LiteralPath env:$($_.Key) -Value $_.Value # If we're running in a cloud CI, set these environment variables so they propagate. @@ -72,7 +55,7 @@ $Variables.GetEnumerator() |% { Write-Host "##vso[task.setvariable variable=$($_.Key);]$($_.Value)" } if ($env:GITHUB_ACTIONS) { - Add-GitHubActionsEnvVariable -Path $env:GITHUB_ENV -Name $_.Key -Value ([string]$_.Value) + Add-GitHubActionsEnvVariable -Name $_.Key -Value ([string]$_.Value) } if ($cmdInstructions) { @@ -88,7 +71,7 @@ if ($IsMacOS -or $IsLinux) { } if ($PrependPath) { - $PrependPath |% { + $PrependPath | % { $newPathValue = "$_$pathDelimiter$env:PATH" Set-Item -LiteralPath env:PATH -Value $newPathValue if ($cmdInstructions) { @@ -99,7 +82,7 @@ if ($PrependPath) { Write-Host "##vso[task.prependpath]$_" } if ($env:GITHUB_ACTIONS) { - Add-GitHubActionsEnvVariable -Path $env:GITHUB_ENV -Name PATH -Value $newPathValue + Add-GitHubActionsEnvVariable -Name PATH -Value $newPathValue } $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" diff --git a/tools/variables/_define.ps1 b/tools/variables/_define.ps1 index 4a8503d9c..dfa9cba42 100644 --- a/tools/variables/_define.ps1 +++ b/tools/variables/_define.ps1 @@ -11,25 +11,7 @@ param ( ) -function Add-GitHubActionsEnvVariable { - param( - [Parameter(Mandatory = $true)] - [string]$Path, - [Parameter(Mandatory = $true)] - [string]$Name, - [Parameter(Mandatory = $true)] - [AllowEmptyString()] - [string]$Value - ) - - if ([string]::IsNullOrWhiteSpace($Name)) { - throw "GitHub Actions environment variable names must not be empty." - } - - $utf8NoBom = [System.Text.UTF8Encoding]::new($false) - $delimiter = [guid]::NewGuid().ToString('N') - [System.IO.File]::AppendAllText($Path, "$Name<<$delimiter`n$Value`n$delimiter`n", $utf8NoBom) -} +. "$PSScriptRoot\..\GitHubActions.ps1" (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. @@ -44,7 +26,7 @@ function Add-GitHubActionsEnvVariable { # and the second that works across jobs and stages but must be fully qualified when referenced. Write-Host "##vso[task.setvariable variable=$keyCaps;isOutput=true]$($_.Value)" } elseif ($env:GITHUB_ACTIONS) { - Add-GitHubActionsEnvVariable -Path $env:GITHUB_ENV -Name $keyCaps -Value ([string]$_.Value) + Add-GitHubActionsEnvVariable -Name $keyCaps -Value ([string]$_.Value) } Set-Item -LiteralPath "env:$keyCaps" -Value $_.Value } From cc2636789124cdddb81cfa6b88a366f2df2ca4e5 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 15 Jun 2026 15:42:29 +0000 Subject: [PATCH 1698/1753] Update dotnet monorepo to 3.11.0-beta1.26226.5 (#1600) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 3c8e40bd9..2cc502092 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -8,7 +8,7 @@ 2.0.226 3.11.0 1.1.4 - 3.11.0-beta1.26075.3 + 3.11.0-beta1.26226.5 From adf10d816ce09a6abec7b6c3156b0b8597d0bc99 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 15 Jun 2026 15:43:16 +0000 Subject: [PATCH 1699/1753] Update dependency Microsoft.Windows.CsWin32 to 0.3.296 (#1602) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 2cc502092..cf75ac677 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -29,7 +29,7 @@ - + From 4a5b860e5ed5e9a41599955a8d16f7dba1475028 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 16 Jun 2026 18:02:26 -0600 Subject: [PATCH 1700/1753] Update dependency powershell to v7.6.3 (#530) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index f88bae603..f82fc36a4 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.6.2", + "version": "7.6.3", "commands": [ "pwsh" ], From 3fcf71e38c502f58e3329a44c247d7d11ef74ae4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 18 Jun 2026 12:30:32 -0600 Subject: [PATCH 1701/1753] Update actions/checkout action to v7 --- .github/workflows/build.yml | 104 ++++++++-------- .github/workflows/copilot-setup-steps.yml | 30 ++--- .github/workflows/docs.yml | 30 ++--- .github/workflows/libtemplate-update.yml | 140 +++++++++++----------- 4 files changed, 152 insertions(+), 152 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 69e7ae4f8..110b0af51 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,9 +3,9 @@ name: 🏭 Build on: push: branches: - - main - - 'v*.*' - - validate/* + - main + - "v*.*" + - validate/* pull_request: workflow_dispatch: @@ -23,60 +23,60 @@ jobs: fail-fast: false matrix: os: - - ubuntu-24.04 - - macOS-15 - - windows-2025 + - ubuntu-24.04 + - macOS-15 + - windows-2025 steps: - - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: | - ./init.ps1 -UpgradePrerequisites - dotnet --info + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites + dotnet --info - # Print mono version if it is present. - if (Get-Command mono -ErrorAction SilentlyContinue) { - mono --version - } - shell: pwsh - - name: ⚙️ Set pipeline variables based on source - run: tools/variables/_define.ps1 - shell: pwsh - - name: 🛠 build - run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - - name: 🧪 test - run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} - shell: pwsh - - name: 💅🏻 Verify formatted code - run: dotnet format --verify-no-changes --no-restore - shell: pwsh - if: runner.os == 'Linux' - - name: 📚 Verify docfx build - run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures - if: runner.os == 'Linux' - - name: ⚙ Update pipeline variables based on build outputs - run: tools/variables/_define.ps1 - shell: pwsh - - name: 📢 Publish artifacts - uses: ./.github/actions/publish-artifacts - if: cancelled() == false - - name: 📢 Publish code coverage results to codecov.io - run: | - if ('${{ secrets.CODECOV_TOKEN }}') { - ./tools/publish-CodeCov.ps1 -CodeCovToken '${{ secrets.CODECOV_TOKEN }}' -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" - } - shell: pwsh - timeout-minutes: 3 - continue-on-error: true + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } + shell: pwsh + - name: ⚙️ Set pipeline variables based on source + run: tools/variables/_define.ps1 + shell: pwsh + - name: 🛠 build + run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" + - name: 🧪 test + run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} + shell: pwsh + - name: 💅🏻 Verify formatted code + run: dotnet format --verify-no-changes --no-restore + shell: pwsh + if: runner.os == 'Linux' + - name: 📚 Verify docfx build + run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures + if: runner.os == 'Linux' + - name: ⚙ Update pipeline variables based on build outputs + run: tools/variables/_define.ps1 + shell: pwsh + - name: 📢 Publish artifacts + uses: ./.github/actions/publish-artifacts + if: cancelled() == false + - name: 📢 Publish code coverage results to codecov.io + run: | + if ('${{ secrets.CODECOV_TOKEN }}') { + ./tools/publish-CodeCov.ps1 -CodeCovToken '${{ secrets.CODECOV_TOKEN }}' -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" + } + shell: pwsh + timeout-minutes: 3 + continue-on-error: true docs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 - with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - name: 🔗 Markup Link Checker (mlc) + uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 + with: + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index d933871a5..e61bfd524 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -6,12 +6,12 @@ on: workflow_dispatch: push: branches: - - main + - main paths: - - .github/workflows/copilot-setup-steps.yml + - .github/workflows/copilot-setup-steps.yml pull_request: paths: - - .github/workflows/copilot-setup-steps.yml + - .github/workflows/copilot-setup-steps.yml jobs: # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot. @@ -26,16 +26,16 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: | - ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider - dotnet --info + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider + dotnet --info - # Print mono version if it is present. - if (Get-Command mono -ErrorAction SilentlyContinue) { - mono --version - } - shell: pwsh + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } + shell: pwsh diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 99b3c0583..6f0fbaa57 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,7 @@ name: 📚 Docs on: push: branches: - - main + - main # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. @@ -24,20 +24,20 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: ./init.ps1 -UpgradePrerequisites + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: ./init.ps1 -UpgradePrerequisites - - run: dotnet docfx docfx/docfx.json - name: 📚 Generate documentation + - run: dotnet docfx docfx/docfx.json + name: 📚 Generate documentation - - name: Upload artifact - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 - with: - path: docfx/_site + - name: Upload artifact + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 + with: + path: docfx/_site - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index fc8a631f6..6336d6380 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -7,7 +7,7 @@ name: ⛜ Library.Template update on: schedule: - - cron: "0 3 * * Mon" # Sun @ 8 or 9 PM Mountain Time (depending on DST) + - cron: "0 3 * * Mon" # Sun @ 8 or 9 PM Mountain Time (depending on DST) workflow_dispatch: jobs: @@ -17,82 +17,82 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: merge - id: merge - shell: pwsh - run: | - $LibTemplateBranch = & ./tools/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated - if ($LASTEXITCODE -ne 0) { - exit $LASTEXITCODE - } - - git fetch https://github.com/aarnott/Library.Template $LibTemplateBranch - if ($LASTEXITCODE -ne 0) { - exit $LASTEXITCODE - } - $LibTemplateCommit = git rev-parse FETCH_HEAD - git diff --stat ...FETCH_HEAD - - if ((git rev-list FETCH_HEAD ^HEAD --count) -eq 0) { - Write-Host "There are no Library.Template updates to merge." - echo "uptodate=true" >> $env:GITHUB_OUTPUT - exit 0 - } + - name: merge + id: merge + shell: pwsh + run: | + $LibTemplateBranch = & ./tools/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated + if ($LASTEXITCODE -ne 0) { + exit $LASTEXITCODE + } - # Pushing commits that add or change files under .github/workflows will cause our workflow to fail. - # But it usually isn't necessary because the target branch already has (or doesn't have) these changes. - # So if the merge doesn't bring in any changes to these files, try the merge locally and push that - # to keep github happy. - if ((git rev-list FETCH_HEAD ^HEAD --count -- .github/workflows) -eq 0) { - # Indeed there are no changes in that area. So merge locally to try to appease GitHub. - git checkout -b auto/libtemplateUpdate - git config user.name "Andrew Arnott" - git config user.email "andrewarnott@live.com" - git merge FETCH_HEAD + git fetch https://github.com/aarnott/Library.Template $LibTemplateBranch if ($LASTEXITCODE -ne 0) { - Write-Host "Merge conflicts prevent creating the pull request. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." - exit 2 + exit $LASTEXITCODE } + $LibTemplateCommit = git rev-parse FETCH_HEAD + git diff --stat ...FETCH_HEAD - git -c http.extraheader="AUTHORIZATION: bearer $env:GH_TOKEN" push origin -u HEAD - } else { - Write-Host "Changes to github workflows are included in this update. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." - exit 1 - } - - name: pull request - shell: pwsh - if: success() && steps.merge.outputs.uptodate != 'true' - run: | - # If there is already an active pull request, don't create a new one. - $existingPR = gh pr list -H auto/libtemplateUpdate --json url | ConvertFrom-Json - if ($existingPR) { - Write-Host "::warning::Skipping pull request creation because one already exists at $($existingPR[0].url)" - exit 0 - } + if ((git rev-list FETCH_HEAD ^HEAD --count) -eq 0) { + Write-Host "There are no Library.Template updates to merge." + echo "uptodate=true" >> $env:GITHUB_OUTPUT + exit 0 + } + + # Pushing commits that add or change files under .github/workflows will cause our workflow to fail. + # But it usually isn't necessary because the target branch already has (or doesn't have) these changes. + # So if the merge doesn't bring in any changes to these files, try the merge locally and push that + # to keep github happy. + if ((git rev-list FETCH_HEAD ^HEAD --count -- .github/workflows) -eq 0) { + # Indeed there are no changes in that area. So merge locally to try to appease GitHub. + git checkout -b auto/libtemplateUpdate + git config user.name "Andrew Arnott" + git config user.email "andrewarnott@live.com" + git merge FETCH_HEAD + if ($LASTEXITCODE -ne 0) { + Write-Host "Merge conflicts prevent creating the pull request. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." + exit 2 + } + + git -c http.extraheader="AUTHORIZATION: bearer $env:GH_TOKEN" push origin -u HEAD + } else { + Write-Host "Changes to github workflows are included in this update. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." + exit 1 + } + - name: pull request + shell: pwsh + if: success() && steps.merge.outputs.uptodate != 'true' + run: | + # If there is already an active pull request, don't create a new one. + $existingPR = gh pr list -H auto/libtemplateUpdate --json url | ConvertFrom-Json + if ($existingPR) { + Write-Host "::warning::Skipping pull request creation because one already exists at $($existingPR[0].url)" + exit 0 + } - $prTitle = "Merge latest Library.Template" - $prBody = "This merges the latest features and fixes from [Library.Template's branch](https://github.com/AArnott/Library.Template/tree/). + $prTitle = "Merge latest Library.Template" + $prBody = "This merges the latest features and fixes from [Library.Template's branch](https://github.com/AArnott/Library.Template/tree/). - ⚠️ Do **not** squash this pull request when completing it. You must *merge* it. + ⚠️ Do **not** squash this pull request when completing it. You must *merge* it. -
- Merge conflicts? - Resolve merge conflicts locally by carrying out these steps: +
+ Merge conflicts? + Resolve merge conflicts locally by carrying out these steps: - ``` - git fetch - git checkout auto/libtemplateUpdate - git merge origin/main - # resolve conflicts - git commit - git push - ``` -
" + ``` + git fetch + git checkout auto/libtemplateUpdate + git merge origin/main + # resolve conflicts + git commit + git push + ``` +
" - gh pr create -H auto/libtemplateUpdate -b $prBody -t $prTitle - env: - GH_TOKEN: ${{ github.token }} + gh pr create -H auto/libtemplateUpdate -b $prBody -t $prTitle + env: + GH_TOKEN: ${{ github.token }} From 93197387762654785bc0772c82bbd28f418a6fb9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 19 Jun 2026 10:13:38 -0600 Subject: [PATCH 1702/1753] Update nbgv and nerdbank.gitversioning updates to 3.10.85 (531) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index f82fc36a4..2ddce27dc 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -17,7 +17,7 @@ "rollForward": false }, "nbgv": { - "version": "3.9.50", + "version": "3.10.85", "commands": [ "nbgv" ], diff --git a/Directory.Packages.props b/Directory.Packages.props index 8630c4587..82ce8d720 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -23,7 +23,7 @@ - + From 3f53cb6c23aacacd3ba715a1f01460eee869b527 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 20 Jun 2026 11:27:25 -0600 Subject: [PATCH 1703/1753] Revert unintended whitespace changes --- .github/workflows/build.yml | 104 ++++++++-------- .github/workflows/copilot-setup-steps.yml | 30 ++--- .github/workflows/docs.yml | 30 ++--- .github/workflows/libtemplate-update.yml | 140 +++++++++++----------- 4 files changed, 152 insertions(+), 152 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 110b0af51..94a48d768 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,9 +3,9 @@ name: 🏭 Build on: push: branches: - - main - - "v*.*" - - validate/* + - main + - 'v*.*' + - validate/* pull_request: workflow_dispatch: @@ -23,60 +23,60 @@ jobs: fail-fast: false matrix: os: - - ubuntu-24.04 - - macOS-15 - - windows-2025 + - ubuntu-24.04 + - macOS-15 + - windows-2025 steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: | - ./init.ps1 -UpgradePrerequisites - dotnet --info + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites + dotnet --info - # Print mono version if it is present. - if (Get-Command mono -ErrorAction SilentlyContinue) { - mono --version - } - shell: pwsh - - name: ⚙️ Set pipeline variables based on source - run: tools/variables/_define.ps1 - shell: pwsh - - name: 🛠 build - run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" - - name: 🧪 test - run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} - shell: pwsh - - name: 💅🏻 Verify formatted code - run: dotnet format --verify-no-changes --no-restore - shell: pwsh - if: runner.os == 'Linux' - - name: 📚 Verify docfx build - run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures - if: runner.os == 'Linux' - - name: ⚙ Update pipeline variables based on build outputs - run: tools/variables/_define.ps1 - shell: pwsh - - name: 📢 Publish artifacts - uses: ./.github/actions/publish-artifacts - if: cancelled() == false - - name: 📢 Publish code coverage results to codecov.io - run: | - if ('${{ secrets.CODECOV_TOKEN }}') { - ./tools/publish-CodeCov.ps1 -CodeCovToken '${{ secrets.CODECOV_TOKEN }}' -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" - } - shell: pwsh - timeout-minutes: 3 - continue-on-error: true + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } + shell: pwsh + - name: ⚙️ Set pipeline variables based on source + run: tools/variables/_define.ps1 + shell: pwsh + - name: 🛠 build + run: dotnet build -t:build,pack --no-restore -c ${{ env.BUILDCONFIGURATION }} -warnAsError -warnNotAsError:NU1901,NU1902,NU1903,NU1904 /bl:"${{ runner.temp }}/_artifacts/build_logs/build.binlog" + - name: 🧪 test + run: tools/dotnet-test-cloud.ps1 -Configuration ${{ env.BUILDCONFIGURATION }} -Agent ${{ runner.os }} + shell: pwsh + - name: 💅🏻 Verify formatted code + run: dotnet format --verify-no-changes --no-restore + shell: pwsh + if: runner.os == 'Linux' + - name: 📚 Verify docfx build + run: dotnet docfx docfx/docfx.json --warningsAsErrors --disableGitFeatures + if: runner.os == 'Linux' + - name: ⚙ Update pipeline variables based on build outputs + run: tools/variables/_define.ps1 + shell: pwsh + - name: 📢 Publish artifacts + uses: ./.github/actions/publish-artifacts + if: cancelled() == false + - name: 📢 Publish code coverage results to codecov.io + run: | + if ('${{ secrets.CODECOV_TOKEN }}') { + ./tools/publish-CodeCov.ps1 -CodeCovToken '${{ secrets.CODECOV_TOKEN }}' -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}" + } + shell: pwsh + timeout-minutes: 3 + continue-on-error: true docs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - - name: 🔗 Markup Link Checker (mlc) - uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 - with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - name: 🔗 Markup Link Checker (mlc) + uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 + with: + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx -i https://www.npmjs.com/package/*,https://get.dot.net/ diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index e61bfd524..c0436e855 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -6,12 +6,12 @@ on: workflow_dispatch: push: branches: - - main + - main paths: - - .github/workflows/copilot-setup-steps.yml + - .github/workflows/copilot-setup-steps.yml pull_request: paths: - - .github/workflows/copilot-setup-steps.yml + - .github/workflows/copilot-setup-steps.yml jobs: # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot. @@ -26,16 +26,16 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: | - ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider - dotnet --info + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: | + ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider + dotnet --info - # Print mono version if it is present. - if (Get-Command mono -ErrorAction SilentlyContinue) { - mono --version - } - shell: pwsh + # Print mono version if it is present. + if (Get-Command mono -ErrorAction SilentlyContinue) { + mono --version + } + shell: pwsh diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6f0fbaa57..9729dc34b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,7 @@ name: 📚 Docs on: push: branches: - - main + - main # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. @@ -24,20 +24,20 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: ⚙ Install prerequisites - run: ./init.ps1 -UpgradePrerequisites + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - name: ⚙ Install prerequisites + run: ./init.ps1 -UpgradePrerequisites - - run: dotnet docfx docfx/docfx.json - name: 📚 Generate documentation + - run: dotnet docfx docfx/docfx.json + name: 📚 Generate documentation - - name: Upload artifact - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 - with: - path: docfx/_site + - name: Upload artifact + uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 + with: + path: docfx/_site - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index 6336d6380..dfd3f578b 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -7,7 +7,7 @@ name: ⛜ Library.Template update on: schedule: - - cron: "0 3 * * Mon" # Sun @ 8 or 9 PM Mountain Time (depending on DST) + - cron: "0 3 * * Mon" # Sun @ 8 or 9 PM Mountain Time (depending on DST) workflow_dispatch: jobs: @@ -17,82 +17,82 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - with: - fetch-depth: 0 # avoid shallow clone so nbgv can do its work. + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - - name: merge - id: merge - shell: pwsh - run: | - $LibTemplateBranch = & ./tools/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated - if ($LASTEXITCODE -ne 0) { - exit $LASTEXITCODE - } + - name: merge + id: merge + shell: pwsh + run: | + $LibTemplateBranch = & ./tools/Get-LibTemplateBasis.ps1 -ErrorIfNotRelated + if ($LASTEXITCODE -ne 0) { + exit $LASTEXITCODE + } - git fetch https://github.com/aarnott/Library.Template $LibTemplateBranch - if ($LASTEXITCODE -ne 0) { - exit $LASTEXITCODE - } - $LibTemplateCommit = git rev-parse FETCH_HEAD - git diff --stat ...FETCH_HEAD + git fetch https://github.com/aarnott/Library.Template $LibTemplateBranch + if ($LASTEXITCODE -ne 0) { + exit $LASTEXITCODE + } + $LibTemplateCommit = git rev-parse FETCH_HEAD + git diff --stat ...FETCH_HEAD - if ((git rev-list FETCH_HEAD ^HEAD --count) -eq 0) { - Write-Host "There are no Library.Template updates to merge." - echo "uptodate=true" >> $env:GITHUB_OUTPUT - exit 0 - } + if ((git rev-list FETCH_HEAD ^HEAD --count) -eq 0) { + Write-Host "There are no Library.Template updates to merge." + echo "uptodate=true" >> $env:GITHUB_OUTPUT + exit 0 + } - # Pushing commits that add or change files under .github/workflows will cause our workflow to fail. - # But it usually isn't necessary because the target branch already has (or doesn't have) these changes. - # So if the merge doesn't bring in any changes to these files, try the merge locally and push that - # to keep github happy. - if ((git rev-list FETCH_HEAD ^HEAD --count -- .github/workflows) -eq 0) { - # Indeed there are no changes in that area. So merge locally to try to appease GitHub. - git checkout -b auto/libtemplateUpdate - git config user.name "Andrew Arnott" - git config user.email "andrewarnott@live.com" - git merge FETCH_HEAD - if ($LASTEXITCODE -ne 0) { - Write-Host "Merge conflicts prevent creating the pull request. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." - exit 2 - } - - git -c http.extraheader="AUTHORIZATION: bearer $env:GH_TOKEN" push origin -u HEAD - } else { - Write-Host "Changes to github workflows are included in this update. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." - exit 1 - } - - name: pull request - shell: pwsh - if: success() && steps.merge.outputs.uptodate != 'true' - run: | - # If there is already an active pull request, don't create a new one. - $existingPR = gh pr list -H auto/libtemplateUpdate --json url | ConvertFrom-Json - if ($existingPR) { - Write-Host "::warning::Skipping pull request creation because one already exists at $($existingPR[0].url)" - exit 0 + # Pushing commits that add or change files under .github/workflows will cause our workflow to fail. + # But it usually isn't necessary because the target branch already has (or doesn't have) these changes. + # So if the merge doesn't bring in any changes to these files, try the merge locally and push that + # to keep github happy. + if ((git rev-list FETCH_HEAD ^HEAD --count -- .github/workflows) -eq 0) { + # Indeed there are no changes in that area. So merge locally to try to appease GitHub. + git checkout -b auto/libtemplateUpdate + git config user.name "Andrew Arnott" + git config user.email "andrewarnott@live.com" + git merge FETCH_HEAD + if ($LASTEXITCODE -ne 0) { + Write-Host "Merge conflicts prevent creating the pull request. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." + exit 2 } - $prTitle = "Merge latest Library.Template" - $prBody = "This merges the latest features and fixes from [Library.Template's branch](https://github.com/AArnott/Library.Template/tree/). + git -c http.extraheader="AUTHORIZATION: bearer $env:GH_TOKEN" push origin -u HEAD + } else { + Write-Host "Changes to github workflows are included in this update. Please run tools/MergeFrom-Template.ps1 locally and push the result as a pull request." + exit 1 + } + - name: pull request + shell: pwsh + if: success() && steps.merge.outputs.uptodate != 'true' + run: | + # If there is already an active pull request, don't create a new one. + $existingPR = gh pr list -H auto/libtemplateUpdate --json url | ConvertFrom-Json + if ($existingPR) { + Write-Host "::warning::Skipping pull request creation because one already exists at $($existingPR[0].url)" + exit 0 + } + + $prTitle = "Merge latest Library.Template" + $prBody = "This merges the latest features and fixes from [Library.Template's branch](https://github.com/AArnott/Library.Template/tree/). - ⚠️ Do **not** squash this pull request when completing it. You must *merge* it. + ⚠️ Do **not** squash this pull request when completing it. You must *merge* it. -
- Merge conflicts? - Resolve merge conflicts locally by carrying out these steps: +
+ Merge conflicts? + Resolve merge conflicts locally by carrying out these steps: - ``` - git fetch - git checkout auto/libtemplateUpdate - git merge origin/main - # resolve conflicts - git commit - git push - ``` -
" + ``` + git fetch + git checkout auto/libtemplateUpdate + git merge origin/main + # resolve conflicts + git commit + git push + ``` +
" - gh pr create -H auto/libtemplateUpdate -b $prBody -t $prTitle - env: - GH_TOKEN: ${{ github.token }} + gh pr create -H auto/libtemplateUpdate -b $prBody -t $prTitle + env: + GH_TOKEN: ${{ github.token }} From 8a8921ae310197c01b11573034e4ac859269ed70 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 22 Jun 2026 11:11:10 -0600 Subject: [PATCH 1704/1753] Update jobs to ubuntu 24 --- azure-pipelines/archive-sourcecode.yml | 2 +- azure-pipelines/libtemplate-update.yml | 2 +- azure-pipelines/official.yml | 2 +- azure-pipelines/prepare-insertion-stages.yml | 2 +- azure-pipelines/release.yml | 4 ++-- azure-pipelines/unofficial.yml | 2 +- azure-pipelines/vs-validation.yml | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 211881fa7..9e075df5a 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -45,7 +45,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux steps: diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index 384be7cfc..4efbd2079 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -45,7 +45,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux steps: - checkout: self diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 22a5d6a33..38e95f2f5 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -74,7 +74,7 @@ extends: linuxPool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux macOSPool: name: Azure Pipelines diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 9f934f92c..675912bce 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -51,7 +51,7 @@ stages: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux templateContext: outputs: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index edc565290..a16f98a4d 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -31,7 +31,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux templateContext: outputs: @@ -54,7 +54,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux templateContext: type: releaseJob diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 36aaf6e50..51752535a 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -87,7 +87,7 @@ extends: linuxPool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux macOSPool: name: Azure Pipelines diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 6a839d472..0eb2c2abe 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -48,7 +48,7 @@ extends: linuxPool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 + - ImageOverride -equals 1ESPT-Ubuntu24.04 os: Linux macOSPool: name: Azure Pipelines From d7904f8c308a457ae2d06adea4040c1f8f2dc275 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 25 Jun 2026 07:25:38 -0600 Subject: [PATCH 1705/1753] Update Dockerfile and global.json updates (532) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 08c018507..635ed8c6e 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.301@sha256:548d93f8a18a1acbe6cc127bc4f47281430d34a9e35c18afa80a8d6741c2adc3 +FROM mcr.microsoft.com/dotnet/sdk:10.0.301@sha256:ea8bde36c11b6e7eec2656d0e59101d4462f6bd630730f2c8201ed0572b295d5 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. From a1ba5694dbf42e55db3a4da4a10896a8c8ca586e Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 16:33:41 +0000 Subject: [PATCH 1706/1753] Update Microsoft Testing Platform to 2.3.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 82ce8d720..fa4d20367 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.2.3 + 2.3.0 From 35daa41ee3d87b5ac610ef03b49733ca77613695 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jul 2026 13:40:09 -0600 Subject: [PATCH 1707/1753] Pin Microsoft.Testing.Extensions.Telemetry to the common MTP version --- Directory.Packages.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Packages.props b/Directory.Packages.props index fa4d20367..31eb8113a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -13,6 +13,7 @@ + From eba6257dfab62a90bbc00fbb9778d7a3382a0f9a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jul 2026 15:48:59 -0600 Subject: [PATCH 1708/1753] Revert "Use default configuration for Network Isolation" (#534) --- azure-pipelines/archive-sourcecode.yml | 2 ++ azure-pipelines/libtemplate-update.yml | 2 ++ azure-pipelines/official.yml | 2 ++ azure-pipelines/release.yml | 2 ++ azure-pipelines/unofficial.yml | 2 ++ azure-pipelines/vs-insertion.yml | 2 ++ azure-pipelines/vs-validation.yml | 2 ++ 7 files changed, 14 insertions(+) diff --git a/azure-pipelines/archive-sourcecode.yml b/azure-pipelines/archive-sourcecode.yml index 9e075df5a..cb8d68e9c 100644 --- a/azure-pipelines/archive-sourcecode.yml +++ b/azure-pipelines/archive-sourcecode.yml @@ -35,6 +35,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable diff --git a/azure-pipelines/libtemplate-update.yml b/azure-pipelines/libtemplate-update.yml index 4efbd2079..acbfbacef 100644 --- a/azure-pipelines/libtemplate-update.yml +++ b/azure-pipelines/libtemplate-update.yml @@ -30,6 +30,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: name: AzurePipelines-EO diff --git a/azure-pipelines/official.yml b/azure-pipelines/official.yml index 38e95f2f5..99815ebbe 100644 --- a/azure-pipelines/official.yml +++ b/azure-pipelines/official.yml @@ -45,6 +45,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable codeSignValidation: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index a16f98a4d..8b7f8c908 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -20,6 +20,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable diff --git a/azure-pipelines/unofficial.yml b/azure-pipelines/unofficial.yml index 51752535a..efc60f322 100644 --- a/azure-pipelines/unofficial.yml +++ b/azure-pipelines/unofficial.yml @@ -55,6 +55,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index 5e5a476cf..edb114c46 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -22,6 +22,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Official.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable sbom: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 0eb2c2abe..3f2a194f6 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -26,6 +26,8 @@ variables: extends: template: azure-pipelines/MicroBuild.1ES.Unofficial.yml@MicroBuildTemplate parameters: + settings: + networkIsolationPolicy: Permissive,CFSClean2 sdl: sourceAnalysisPool: VSEng-MicroBuildVSStable credscan: From 4299650d88d492c5d1725c81c55e4e734e477c73 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jul 2026 16:25:20 -0600 Subject: [PATCH 1709/1753] Fix typo --- .github/skills/bundle-dependency-prs/SKILL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/skills/bundle-dependency-prs/SKILL.md b/.github/skills/bundle-dependency-prs/SKILL.md index 48dedbe9b..3fec66838 100644 --- a/.github/skills/bundle-dependency-prs/SKILL.md +++ b/.github/skills/bundle-dependency-prs/SKILL.md @@ -27,7 +27,7 @@ Before aggregating PRs, first try to fix any individual dependency update PRs wi 1. For the dependency PRs with failing build or test PR checks, check out their source branch and fix any issues. 2. Push your fixes as fresh commits to the individual dependency PRs. - If pushing to a repo in the `microsoft` org when the PR is authord by `renovate`, follow-up the push with a PR comment that says exactly this: "/azp run" which triggers PR checks to re-run. + If pushing to a repo in the `microsoft` org when the PR is authored by `renovate`, follow-up the push with a PR comment that says exactly this: "/azp run" which triggers PR checks to re-run. 3. If you can't fix a particular PR, add a comment to the PR describing your attempt and outcome. ## Group dependency PRs that are ready to go From 90ac1ee05f361d25ff36e42ce217316768c2ee11 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jul 2026 16:32:43 -0600 Subject: [PATCH 1710/1753] Use preferred pattern for appending to PATH in GitHub Actions --- tools/GitHubActions.ps1 | 15 +++++++++++++++ tools/Set-EnvVars.ps1 | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/tools/GitHubActions.ps1 b/tools/GitHubActions.ps1 index c742a5888..8678d0da3 100644 --- a/tools/GitHubActions.ps1 +++ b/tools/GitHubActions.ps1 @@ -16,3 +16,18 @@ function Add-GitHubActionsEnvVariable { $delimiter = [guid]::NewGuid().ToString('N') [System.IO.File]::AppendAllText($Path, "$Name<<$delimiter`n$Value`n$delimiter`n", $utf8NoBom) } + +function Add-GitHubActionsPath { + param( + [string]$Path = $env:GITHUB_PATH, + [Parameter(Mandatory = $true)] + [string]$Value + ) + + if ([string]::IsNullOrWhiteSpace($Path)) { + throw "GitHub Actions path file must not be empty." + } + + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) + [System.IO.File]::AppendAllText($Path, "$Value`n", $utf8NoBom) +} diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index 0816c0e2c..c2d95b8f7 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -82,7 +82,7 @@ if ($PrependPath) { Write-Host "##vso[task.prependpath]$_" } if ($env:GITHUB_ACTIONS) { - Add-GitHubActionsEnvVariable -Name PATH -Value $newPathValue + Add-GitHubActionsPath -Value $_ } $CmdEnvScript += "SET PATH=$_$pathDelimiter%PATH%" From 5a0a13fe6340618056b81b8e1d90092fc012ff03 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jul 2026 16:51:06 -0600 Subject: [PATCH 1711/1753] Avoid loading GitHubActions.ps1 on Azure Pipelines --- tools/variables/_define.ps1 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tools/variables/_define.ps1 b/tools/variables/_define.ps1 index dfa9cba42..90fd080df 100644 --- a/tools/variables/_define.ps1 +++ b/tools/variables/_define.ps1 @@ -11,7 +11,9 @@ param ( ) -. "$PSScriptRoot\..\GitHubActions.ps1" +if ($env:GITHUB_ACTIONS) { + . "$PSScriptRoot\..\GitHubActions.ps1" +} (& "$PSScriptRoot\_all.ps1").GetEnumerator() |% { # Always use ALL CAPS for env var names since Azure Pipelines converts variable names to all caps and on non-Windows OS, env vars are case sensitive. From 097060adc6c79e0aa7cb16ec4995e868c7350b44 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 7 Jul 2026 17:42:55 -0600 Subject: [PATCH 1712/1753] Validate Path parameter in Add-GitHubActionsEnvVariable --- tools/GitHubActions.ps1 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tools/GitHubActions.ps1 b/tools/GitHubActions.ps1 index 8678d0da3..1546d991e 100644 --- a/tools/GitHubActions.ps1 +++ b/tools/GitHubActions.ps1 @@ -8,6 +8,10 @@ function Add-GitHubActionsEnvVariable { [string]$Value ) + if ([string]::IsNullOrWhiteSpace($Path)) { + throw "GitHub Actions environment file must not be empty." + } + if ([string]::IsNullOrWhiteSpace($Name)) { throw "GitHub Actions environment variable names must not be empty." } From 410f74a3156883d58856b2b126df9b2c6eed9dad Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 8 Jul 2026 07:38:53 -0600 Subject: [PATCH 1713/1753] Pin System.Memory to 4.5.5 to fix VS 2022 analyzer load failure (#1612) * Initial plan * Pin System.Memory to 4.5.5 to match VS 2022 runtime The analyzer was compiled against System.Memory 4.6.3 (assembly version 4.0.2.0), but VS 2022 only ships System.Memory 4.5.5 (assembly version 4.0.1.1). This caused a FileNotFoundException when loading the analyzer. Pinning to 4.5.5 matches what VS 2022 provides and is compatible with all APIs used by this codebase (ReadOnlyMemory, ReadOnlySpan, AsMemory(), AsSpan() extensions). The transitive dependency graph only required 4.5.4-4.5.5 anyway; the old pin to 4.6.3 was artificially high. Fixes #1608 Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> * Use IsAnalyzerProject pattern to pin System.Memory for analyzer projects Follows the same pattern as microsoft/vs-streamjsonrpc: - Add src/Analyzers.props that sets IsAnalyzerProject=true - Import it in all 4 analyzer csproj files - In Directory.Packages.props, restore global System.Memory to 4.6.3 and add a conditional ItemGroup for IsAnalyzerProject='true' projects that overrides System.Memory down to 4.5.5 (what VS 2022 provides) This way a dependency update bot can safely bump the global System.Memory version without breaking the VS 2022 analyzer load, because the override for analyzer projects will continue to cap it at the VS-provided version. Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --- Directory.Packages.props | 5 +++++ src/Analyzers.props | 7 +++++++ ...icrosoft.VisualStudio.Threading.Analyzers.CSharp.csproj | 1 + ...osoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj | 1 + ...oft.VisualStudio.Threading.Analyzers.VisualBasic.csproj | 1 + .../Microsoft.VisualStudio.Threading.Analyzers.csproj | 1 + 6 files changed, 16 insertions(+) create mode 100644 src/Analyzers.props diff --git a/Directory.Packages.props b/Directory.Packages.props index 8bdb08c77..faec00452 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -40,6 +40,11 @@ + + + + diff --git a/src/Analyzers.props b/src/Analyzers.props new file mode 100644 index 000000000..bdb4fd3ee --- /dev/null +++ b/src/Analyzers.props @@ -0,0 +1,7 @@ + + + + + true + + diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj index f1209f918..d834a1b3d 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CSharp/Microsoft.VisualStudio.Threading.Analyzers.CSharp.csproj @@ -1,4 +1,5 @@  + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj index fd269bbb4..38a21a074 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes.csproj @@ -1,4 +1,5 @@  + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj index 0ed35b358..110f7c1a4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic/Microsoft.VisualStudio.Threading.Analyzers.VisualBasic.csproj @@ -1,4 +1,5 @@  + netstandard2.0 Microsoft.VisualStudio.Threading.Analyzers diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj index 89e942d24..c2e860993 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Microsoft.VisualStudio.Threading.Analyzers.csproj @@ -1,4 +1,5 @@  + netstandard2.0 true From f90eec874d344d6d69b607372ad9a80f19036107 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 8 Jul 2026 07:39:12 -0600 Subject: [PATCH 1714/1753] Fix VSTHRD200 misfiring on methods returning IAsyncEnumerator (#1613) * Initial plan * Fix VSTHRD200 to treat IAsyncEnumerator as async-compatible return type Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: AArnott <3548+AArnott@users.noreply.github.com> --- .../Utils.cs | 6 ++-- ...00UseAsyncNamingConventionAnalyzerTests.cs | 36 +++++++++++++++++++ 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs index 047c50c0a..9a2c376f4 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs @@ -293,11 +293,11 @@ public static bool IsAsyncCompatibleReturnType([NotNullWhen(true)] this ITypeSym // ValueTask and ValueTask have the AsyncMethodBuilderAttribute. return (typeSymbol.Name == nameof(Task) && typeSymbol.BelongsToNamespace(Namespaces.SystemThreadingTasks)) - || IsIAsyncEnumerable(typeSymbol) || typeSymbol.AllInterfaces.Any(IsIAsyncEnumerable) + || IsIAsyncEnumerableOrEnumerator(typeSymbol) || typeSymbol.AllInterfaces.Any(IsIAsyncEnumerableOrEnumerator) || typeSymbol.GetAttributes().Any(ad => ad.AttributeClass?.Name == Types.AsyncMethodBuilderAttribute.TypeName && ad.AttributeClass.BelongsToNamespace(Types.AsyncMethodBuilderAttribute.Namespace)); - static bool IsIAsyncEnumerable(ITypeSymbol symbol) - => symbol.Name == "IAsyncEnumerable" // TODO: Use nameof(IAsyncEnumerable) after upgrade to netstandard2.1 + static bool IsIAsyncEnumerableOrEnumerator(ITypeSymbol symbol) + => (symbol.Name == "IAsyncEnumerable" || symbol.Name == "IAsyncEnumerator") // TODO: Use nameof after upgrade to netstandard2.1 && symbol.BelongsToNamespace(Namespaces.SystemCollectionsGeneric); } diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs index 9e4d60ac6..2e852c49c 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/VSTHRD200UseAsyncNamingConventionAnalyzerTests.cs @@ -190,6 +190,29 @@ class Test { await CSVerify.VerifyCodeFixAsync(test, expected, withFix); } + [Fact] + public async Task IAsyncEnumeratorOfTReturningMethodWithoutSuffix_GeneratesWarning() + { + var test = @" +using System.Collections.Generic; + +class Test { + IAsyncEnumerator Foo() => default; +} +"; + + var withFix = @" +using System.Collections.Generic; + +class Test { + IAsyncEnumerator FooAsync() => default; +} +"; + + DiagnosticResult expected = CSVerify.Diagnostic(AddSuffixDescriptor).WithSpan(5, 27, 5, 30); + await CSVerify.VerifyCodeFixAsync(test, expected, withFix); + } + [Fact] public async Task HomemadeIAsyncEnumerableOfTReturningMethodWithoutSuffix_GeneratesWarning() { @@ -392,6 +415,19 @@ class Test { await CSVerify.VerifyAnalyzerAsync(test); } + [Fact] + public async Task IAsyncEnumeratorOfTReturningMethodWithSuffix_GeneratesNoWarning() + { + var test = @" +using System.Collections.Generic; + +class Test { + IAsyncEnumerator FooAsync() => null; +} +"; + await CSVerify.VerifyAnalyzerAsync(test); + } + [Fact] public async Task HomemadeIAsyncEnumerableOfTReturningMethodWithSuffix_GeneratesNoWarning() { From 5cd226ad1977e1fc3150ccf6614b3afd81c0b3b4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 07:46:02 -0600 Subject: [PATCH 1715/1753] Fix 1ES PT nuget push --- azure-pipelines/prepare-insertion-stages.yml | 2 +- azure-pipelines/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index 675912bce..d77233251 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -51,7 +51,7 @@ stages: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu24.04 + - ImageOverride -equals 1ESPT-Ubuntu22.04 # Do NOT upgrade to Ubuntu24 until this is fixed: https://portal.microsofticm.com/imp/v5/incidents/details/830879871/summary os: Linux templateContext: outputs: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index 8b7f8c908..dda671c05 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -33,7 +33,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu24.04 + - ImageOverride -equals 1ESPT-Ubuntu22.04 # Do NOT upgrade to Ubuntu24 until this is fixed: https://portal.microsofticm.com/imp/v5/incidents/details/830879871/summary os: Linux templateContext: outputs: From b5153f6c64e58cc4cc09e44c3e8a0a76235cfdae Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 8 Jul 2026 07:49:19 -0600 Subject: [PATCH 1716/1753] Update dependency dotnet-coverage to v18.9.0 (536) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 2ddce27dc..9484456cc 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.8.0", + "version": "18.9.0", "commands": [ "dotnet-coverage" ], From 42c5cea6cd1a74c3fc6c41c2f92018ec6faba81c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 8 Jul 2026 13:55:40 +0000 Subject: [PATCH 1717/1753] Update dependency Microsoft.Testing.Extensions.CodeCoverage to 18.9.0 (537) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 31eb8113a..2e095f234 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,7 +10,7 @@ - + From e6e3c19ad90332fe95b2c9e84aafef423a8b6ac3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 08:23:09 -0600 Subject: [PATCH 1718/1753] Revert "Update dependency dotnet-coverage to v18.9.0 (536)" This reverts commit b5153f6c64e58cc4cc09e44c3e8a0a76235cfdae. The dependency isn't allowed per CFS policy yet. --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9484456cc..2ddce27dc 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.9.0", + "version": "18.8.0", "commands": [ "dotnet-coverage" ], From c43fba65f1989efc05d45b822c32f657705d766c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 08:42:01 -0600 Subject: [PATCH 1719/1753] Prevent empty paths from being added to the PATH --- tools/GitHubActions.ps1 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tools/GitHubActions.ps1 b/tools/GitHubActions.ps1 index 1546d991e..fbe543903 100644 --- a/tools/GitHubActions.ps1 +++ b/tools/GitHubActions.ps1 @@ -32,6 +32,10 @@ function Add-GitHubActionsPath { throw "GitHub Actions path file must not be empty." } + if ([string]::IsNullOrWhiteSpace($Value)) { + throw "GitHub Actions path entries must not be empty." + } + $utf8NoBom = [System.Text.UTF8Encoding]::new($false) [System.IO.File]::AppendAllText($Path, "$Value`n", $utf8NoBom) } From 21218ea4bcd823a6725bcf9198eb096de7a26477 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 08:51:05 -0600 Subject: [PATCH 1720/1753] Fix package restore failures --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 9bbdfbeef..ae306be39 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,7 +12,7 @@ - + @@ -35,7 +35,7 @@ - + From a4d4554915ecf1e181db41e2274969c21761d1f4 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 09:15:07 -0600 Subject: [PATCH 1721/1753] Fix up error messages --- tools/GitHubActions.ps1 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/GitHubActions.ps1 b/tools/GitHubActions.ps1 index fbe543903..a2a04c5df 100644 --- a/tools/GitHubActions.ps1 +++ b/tools/GitHubActions.ps1 @@ -9,11 +9,11 @@ function Add-GitHubActionsEnvVariable { ) if ([string]::IsNullOrWhiteSpace($Path)) { - throw "GitHub Actions environment file must not be empty." + throw "GitHub Actions environment file path must not be empty." } if ([string]::IsNullOrWhiteSpace($Name)) { - throw "GitHub Actions environment variable names must not be empty." + throw "GitHub Actions environment variable name must not be empty." } $utf8NoBom = [System.Text.UTF8Encoding]::new($false) @@ -29,11 +29,11 @@ function Add-GitHubActionsPath { ) if ([string]::IsNullOrWhiteSpace($Path)) { - throw "GitHub Actions path file must not be empty." + throw "GitHub Actions path file path must not be empty." } if ([string]::IsNullOrWhiteSpace($Value)) { - throw "GitHub Actions path entries must not be empty." + throw "GitHub Actions path entry must not be empty." } $utf8NoBom = [System.Text.UTF8Encoding]::new($false) From 8201f772e034b548f6fef19445abf5495235594e Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 09:18:58 -0600 Subject: [PATCH 1722/1753] Avoid importing GitHubActions.ps1 outside GitHub Actions --- tools/Set-EnvVars.ps1 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tools/Set-EnvVars.ps1 b/tools/Set-EnvVars.ps1 index c2d95b8f7..c85d6941a 100644 --- a/tools/Set-EnvVars.ps1 +++ b/tools/Set-EnvVars.ps1 @@ -19,7 +19,9 @@ Param( [string[]]$PrependPath ) -. "$PSScriptRoot\GitHubActions.ps1" +if ($env:GITHUB_ACTIONS) { + . "$PSScriptRoot\GitHubActions.ps1" +} if ($Variables.Count -eq 0) { return $true From 3ee5eeb3ffaad4da5b5c474d46231033bd64a6df Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 09:20:03 -0600 Subject: [PATCH 1723/1753] Clarify yml comment --- azure-pipelines/prepare-insertion-stages.yml | 2 +- azure-pipelines/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml index d77233251..9abd3770b 100644 --- a/azure-pipelines/prepare-insertion-stages.yml +++ b/azure-pipelines/prepare-insertion-stages.yml @@ -51,7 +51,7 @@ stages: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 # Do NOT upgrade to Ubuntu24 until this is fixed: https://portal.microsofticm.com/imp/v5/incidents/details/830879871/summary + - ImageOverride -equals 1ESPT-Ubuntu22.04 # Do NOT upgrade this job to Ubuntu24 until this is fixed: https://portal.microsofticm.com/imp/v5/incidents/details/830879871/summary os: Linux templateContext: outputs: diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index dda671c05..a8218f052 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -33,7 +33,7 @@ extends: pool: name: AzurePipelines-EO demands: - - ImageOverride -equals 1ESPT-Ubuntu22.04 # Do NOT upgrade to Ubuntu24 until this is fixed: https://portal.microsofticm.com/imp/v5/incidents/details/830879871/summary + - ImageOverride -equals 1ESPT-Ubuntu22.04 # Do NOT upgrade this job to Ubuntu24 until this is fixed: https://portal.microsofticm.com/imp/v5/incidents/details/830879871/summary os: Linux templateContext: outputs: From 3948cdc9c039c4915500da6c63d9d3bd0ac7a40f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 09:21:17 -0600 Subject: [PATCH 1724/1753] Update script synopsis --- tools/variables/_define.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/variables/_define.ps1 b/tools/variables/_define.ps1 index 90fd080df..ba081f0fd 100644 --- a/tools/variables/_define.ps1 +++ b/tools/variables/_define.ps1 @@ -1,7 +1,7 @@ <# .SYNOPSIS This script translates the variables returned by the _all.ps1 script - into commands that instruct Azure Pipelines to actually set those variables for other pipeline tasks to consume. + into commands that instruct Azure Pipelines or GitHub Actions to actually set those variables for other pipeline tasks to consume. The build or release definition may have set these variables to override what the build would do. So only set them if they have not already been set. From 6a14f7669346ca5247dfb0666586f9a100bdeb5a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 09:45:21 -0600 Subject: [PATCH 1725/1753] Clarify what looks like bad wording --- tools/GitHubActions.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/GitHubActions.ps1 b/tools/GitHubActions.ps1 index a2a04c5df..c732a0f9f 100644 --- a/tools/GitHubActions.ps1 +++ b/tools/GitHubActions.ps1 @@ -9,7 +9,7 @@ function Add-GitHubActionsEnvVariable { ) if ([string]::IsNullOrWhiteSpace($Path)) { - throw "GitHub Actions environment file path must not be empty." + throw "GitHub Actions GITHUB_ENV file path must not be empty." } if ([string]::IsNullOrWhiteSpace($Name)) { @@ -29,7 +29,7 @@ function Add-GitHubActionsPath { ) if ([string]::IsNullOrWhiteSpace($Path)) { - throw "GitHub Actions path file path must not be empty." + throw "GitHub Actions GITHUB_PATH file path must not be empty." } if ([string]::IsNullOrWhiteSpace($Value)) { From 041558c10ff2dacadee10ab3390cc0f5093a300a Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 10:59:38 -0600 Subject: [PATCH 1726/1753] Fix failing analyzer tests --- .../App.net472.config | 11 +++++++++++ ...soft.VisualStudio.Threading.Analyzers.Tests.csproj | 1 + 2 files changed, 12 insertions(+) create mode 100644 test/Microsoft.VisualStudio.Threading.Analyzers.Tests/App.net472.config diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/App.net472.config b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/App.net472.config new file mode 100644 index 000000000..f47db784d --- /dev/null +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/App.net472.config @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj index 78d772b56..a0a354341 100644 --- a/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj +++ b/test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Microsoft.VisualStudio.Threading.Analyzers.Tests.csproj @@ -6,6 +6,7 @@ true $(NoWarn);NU1701 $(DefineConstants);WINDOWS + App.net472.config true From e8034505a7a68667bfc4fa60e8b71579423a4453 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 11:12:29 -0600 Subject: [PATCH 1727/1753] Bring CONTRIBUTING into better conformance --- CONTRIBUTING.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39e738280..05e4d16b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,19 +7,17 @@ FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. -We welcome 3rd party pull requests. -For significant changes we strongly recommend opening an issue to start a design discussion first. - ## Best practices * Use Windows PowerShell or [PowerShell Core][pwsh] (including on Linux/OSX) to run .ps1 scripts. Some scripts set environment variables to help you, but they are only retained if you use PowerShell as your shell. -### Prerequisites +## Prerequisites -* [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/2.2) with the version matching our [global.json](global.json) file. The version you install must be at least the version specified in the global.json file, and must be within the same hundreds version for the 3rd integer: x.y.Czz (x.y.C must match, and zz must be at least as high). - The easiest way to get this is to run the `init` script at the root of the repo. Use the `-InstallLocality Machine` and approve admin elevation if you wish so the SDK is always discoverable from VS. See the `init` script usage doc for more details. -* Optional: [Visual Studio 2022](https://visualstudio.microsoft.com/) +All dependencies can be installed by running the `init.ps1` script at the root of the repository +using Windows PowerShell or [PowerShell Core][pwsh] (on any OS). +Some dependencies installed by `init.ps1` may only be discoverable from the same command line environment the init script was run from due to environment variables, so be sure to launch Visual Studio or build the repo from that same environment. +Alternatively, run `init.ps1 -InstallLocality Machine` (which may require elevation) in order to install dependencies at machine-wide locations so Visual Studio and builds work everywhere. The only prerequisite for building, testing, and deploying from this repository is the [.NET SDK](https://get.dot.net/). @@ -37,12 +35,9 @@ to the feeds that packages for this repo come from, if any. ## Building -This project can be built with the follow commands from a Visual Studio Developer Command Prompt, -assuming the working directory is the root of this repository: +This repository can be built on Windows, Linux, and OSX. -```ps1 -msbuild src -``` +Building, testing, and packing this repository can be done by using the standard dotnet CLI commands (e.g. `dotnet build`, `dotnet test`, `dotnet pack`, etc.). ## Testing From c456c941b5df24d5eb6184fa5033a139abf29e9a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 8 Jul 2026 14:06:22 -0600 Subject: [PATCH 1728/1753] Update nbgv and nerdbank.gitversioning updates to 3.10.91 (538) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- Directory.Packages.props | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9484456cc..30cea5a75 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -17,7 +17,7 @@ "rollForward": false }, "nbgv": { - "version": "3.10.85", + "version": "3.10.91", "commands": [ "nbgv" ], diff --git a/Directory.Packages.props b/Directory.Packages.props index 2e095f234..ca1e17d7a 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -24,7 +24,7 @@ - + From 444e9f0fb82352ea14d040732bc4f15f3aa6cb30 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 17:28:55 -0600 Subject: [PATCH 1729/1753] Bump MessagePack (for tests) to 2.5.302 This resolves a Component Governance alert. --- Directory.Packages.props | 1 + 1 file changed, 1 insertion(+) diff --git a/Directory.Packages.props b/Directory.Packages.props index ae306be39..ac02a6011 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -12,6 +12,7 @@ + From 036db57c0053f15d56761acb53fb01cd2f331ccb Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 19:23:23 -0600 Subject: [PATCH 1730/1753] Cache the dotnet-install scripts locally This should avoid the failures we're seeing in azure pipelines from github throttling unauthenticated requests. --- tools/Install-DotNetSdk.ps1 | 13 +- tools/Update-DotNetInstallScript.ps1 | 36 + tools/dotnet-install.ps1 | 1356 ++++++++++++++++++ tools/dotnet-install.sh | 1888 ++++++++++++++++++++++++++ 4 files changed, 3285 insertions(+), 8 deletions(-) create mode 100644 tools/Update-DotNetInstallScript.ps1 create mode 100644 tools/dotnet-install.ps1 create mode 100644 tools/dotnet-install.sh diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1 index d9d35bb1e..bec37c9eb 100644 --- a/tools/Install-DotNetSdk.ps1 +++ b/tools/Install-DotNetSdk.ps1 @@ -284,18 +284,15 @@ if ($IncludeX86) { } if ($IsMacOS -or $IsLinux) { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/a3fbd0fd625032bac207f1f590e5353fe26faa59/src/dotnet-install.sh" - $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.sh" + $DotNetInstallScriptPath = "$PSScriptRoot/dotnet-install.sh" } else { - $DownloadUri = "https://raw.githubusercontent.com/dotnet/install-scripts/a3fbd0fd625032bac207f1f590e5353fe26faa59/src/dotnet-install.ps1" - $DotNetInstallScriptPath = "$DotNetInstallScriptRoot/dotnet-install.ps1" + $DotNetInstallScriptPath = "$PSScriptRoot/dotnet-install.ps1" } +# Verify the cached script exists if (-not (Test-Path $DotNetInstallScriptPath)) { - Invoke-WebRequest -Uri $DownloadUri -OutFile $DotNetInstallScriptPath -UseBasicParsing - if ($IsMacOS -or $IsLinux) { - chmod +x $DotNetInstallScriptPath - } + Write-Error "Cached dotnet-install script not found at $DotNetInstallScriptPath. Run tools/Update-DotNetInstallScript.ps1 to download it." + exit 1 } # In case the script we invoke is in a directory with spaces, wrap it with single quotes. diff --git a/tools/Update-DotNetInstallScript.ps1 b/tools/Update-DotNetInstallScript.ps1 new file mode 100644 index 000000000..bc0cba65b --- /dev/null +++ b/tools/Update-DotNetInstallScript.ps1 @@ -0,0 +1,36 @@ +#!/usr/bin/env pwsh + +<# +.SYNOPSIS + Updates the cached dotnet-install scripts from the dotnet/install-scripts GitHub repository. +.DESCRIPTION + Downloads the latest dotnet-install.ps1 and dotnet-install.sh scripts from + https://github.com/dotnet/install-scripts and caches them locally to avoid GitHub API rate limiting. + Run this script periodically to get the latest installation scripts. +#> +[CmdletBinding(SupportsShouldProcess = $true)] +Param() + +$ScriptRoot = Split-Path -Parent $MyInvocation.MyCommand.Path +$DownloadBaseUri = "https://raw.githubusercontent.com/dotnet/install-scripts/main/src" + +$scripts = @('dotnet-install.ps1', 'dotnet-install.sh') + +foreach ($script in $scripts) { + $Uri = "$DownloadBaseUri/$script" + $OutFile = Join-Path $ScriptRoot $script + + Write-Host "Updating $script from GitHub..." + try { + if ($PSCmdlet.ShouldProcess($OutFile, "Update from $Uri")) { + Invoke-WebRequest -Uri $Uri -OutFile $OutFile -UseBasicParsing + Write-Host "✓ Successfully updated $script" -ForegroundColor Green + } + } + catch { + Write-Error "Failed to update ${script}: $_" + exit 1 + } +} + +Write-Host "All cached scripts have been updated." -ForegroundColor Green diff --git a/tools/dotnet-install.ps1 b/tools/dotnet-install.ps1 new file mode 100644 index 000000000..e62264b16 --- /dev/null +++ b/tools/dotnet-install.ps1 @@ -0,0 +1,1356 @@ +# +# Copyright (c) .NET Foundation and contributors. All rights reserved. +# Licensed under the MIT license. See LICENSE file in the project root for full license information. +# + +<# +.SYNOPSIS + Installs dotnet cli +.DESCRIPTION + Installs dotnet cli. If dotnet installation already exists in the given directory + it will update it only if the requested version differs from the one already installed. + + Note that the intended use of this script is for Continuous Integration (CI) scenarios, where: + - The SDK needs to be installed without user interaction and without admin rights. + - The SDK installation doesn't need to persist across multiple CI runs. + To set up a development environment or to run apps, use installers rather than this script. Visit https://dotnet.microsoft.com/download to get the installer. + +.PARAMETER Channel + Default: LTS + Download from the Channel specified. Possible values: + - STS - the most recent Standard Term Support release + - LTS - the most recent Long Term Support release + - 2-part version in a format A.B - represents a specific release + examples: 2.0, 1.0 + - 3-part version in a format A.B.Cxx - represents a specific SDK release + examples: 5.0.1xx, 5.0.2xx + Supported since 5.0 release + Warning: Value "Current" is deprecated for the Channel parameter. Use "STS" instead. + Note: The version parameter overrides the channel parameter when any version other than 'latest' is used. +.PARAMETER Quality + Download the latest build of specified quality in the channel. The possible values are: daily, preview, GA. + Works only in combination with channel. Not applicable for STS and LTS channels and will be ignored if those channels are used. + For SDK use channel in A.B.Cxx format: using quality together with channel in A.B format is not supported. + Supported since 5.0 release. + Note: The version parameter overrides the channel parameter when any version other than 'latest' is used, and therefore overrides the quality. +.PARAMETER Version + Default: latest + Represents a build version on specific channel. Possible values: + - latest - the latest build on specific channel + - 3-part version in a format A.B.C - represents specific version of build + examples: 2.0.0-preview2-006120, 1.1.0 +.PARAMETER Internal + Download internal builds. Requires providing credentials via -FeedCredential parameter. +.PARAMETER FeedCredential + Token to access Azure feed. Used as a query string to append to the Azure feed. + This parameter typically is not specified. +.PARAMETER InstallDir + Default: %LocalAppData%\Microsoft\dotnet + Path to where to install dotnet. Note that binaries will be placed directly in a given directory. +.PARAMETER Architecture + Default: - this value represents currently running OS architecture + Architecture of dotnet binaries to be installed. + Possible values are: , amd64, x64, x86, arm64, arm +.PARAMETER SharedRuntime + This parameter is obsolete and may be removed in a future version of this script. + The recommended alternative is '-Runtime dotnet'. + Installs just the shared runtime bits, not the entire SDK. +.PARAMETER Runtime + Installs just a shared runtime, not the entire SDK. + Possible values: + - dotnet - the Microsoft.NETCore.App shared runtime + - aspnetcore - the Microsoft.AspNetCore.App shared runtime + - windowsdesktop - the Microsoft.WindowsDesktop.App shared runtime +.PARAMETER DryRun + If set it will not perform installation but instead display what command line to use to consistently install + currently requested version of dotnet cli. In example if you specify version 'latest' it will display a link + with specific version so that this command can be used deterministically in a build script. + It also displays binaries location if you prefer to install or download it yourself. +.PARAMETER NoPath + By default this script will set environment variable PATH for the current process to the binaries folder inside installation folder. + If set it will display binaries location but not set any environment variable. +.PARAMETER Verbose + Displays diagnostics information. +.PARAMETER AzureFeed + Default: https://builds.dotnet.microsoft.com/dotnet + For internal use only. + Allows using a different storage to download SDK archives from. +.PARAMETER UncachedFeed + For internal use only. + Allows using a different storage to download SDK archives from. +.PARAMETER ProxyAddress + If set, the installer will use the proxy when making web requests +.PARAMETER ProxyUseDefaultCredentials + Default: false + Use default credentials, when using proxy address. +.PARAMETER ProxyBypassList + If set with ProxyAddress, will provide the list of comma separated urls that will bypass the proxy +.PARAMETER SkipNonVersionedFiles + Default: false + Skips installing non-versioned files if they already exist, such as dotnet.exe. +.PARAMETER JSonFile + Determines the SDK version from a user specified global.json file + Note: global.json must have a value for 'SDK:Version' +.PARAMETER DownloadTimeout + Determines timeout duration in seconds for downloading of the SDK file + Default: 1200 seconds (20 minutes) +.PARAMETER KeepZip + If set, downloaded file is kept +.PARAMETER ZipPath + Use that path to store installer, generated by default +.EXAMPLE + dotnet-install.ps1 -Version 7.0.401 + Installs the .NET SDK version 7.0.401 +.EXAMPLE + dotnet-install.ps1 -Channel 8.0 -Quality GA + Installs the latest GA (general availability) version of the .NET 8.0 SDK +#> +[cmdletbinding()] +param( + [string]$Channel = "LTS", + [string]$Quality, + [string]$Version = "Latest", + [switch]$Internal, + [string]$JSonFile, + [Alias('i')][string]$InstallDir = "", + [string]$Architecture = "", + [string]$Runtime, + [Obsolete("This parameter may be removed in a future version of this script. The recommended alternative is '-Runtime dotnet'.")] + [switch]$SharedRuntime, + [switch]$DryRun, + [switch]$NoPath, + [string]$AzureFeed, + [string]$UncachedFeed, + [string]$FeedCredential, + [string]$ProxyAddress, + [switch]$ProxyUseDefaultCredentials, + [string[]]$ProxyBypassList = @(), + [switch]$SkipNonVersionedFiles, + [int]$DownloadTimeout = 1200, + [switch]$KeepZip, + [string]$ZipPath = [System.IO.Path]::combine([System.IO.Path]::GetTempPath(), [System.IO.Path]::GetRandomFileName()), + [switch]$Help +) + +Set-StrictMode -Version Latest +$ErrorActionPreference = "Stop" +$ProgressPreference = "SilentlyContinue" + +function Say($str) { + try { + Write-Host "dotnet-install: $str" + } + catch { + # Some platforms cannot utilize Write-Host (Azure Functions, for instance). Fall back to Write-Output + Write-Output "dotnet-install: $str" + } +} + +function Say-Warning($str) { + try { + Write-Warning "dotnet-install: $str" + } + catch { + # Some platforms cannot utilize Write-Warning (Azure Functions, for instance). Fall back to Write-Output + Write-Output "dotnet-install: Warning: $str" + } +} + +# Writes a line with error style settings. +# Use this function to show a human-readable comment along with an exception. +function Say-Error($str) { + try { + # Write-Error is quite verbose for the purpose of the function, let's write one line with error style settings. + $Host.UI.WriteErrorLine("dotnet-install: $str") + } + catch { + Write-Output "dotnet-install: Error: $str" + } +} + +function Say-Verbose($str) { + try { + Write-Verbose "dotnet-install: $str" + } + catch { + # Some platforms cannot utilize Write-Verbose (Azure Functions, for instance). Fall back to Write-Output + Write-Output "dotnet-install: $str" + } +} + +function Measure-Action($name, $block) { + $time = Measure-Command $block + $totalSeconds = $time.TotalSeconds + Say-Verbose "Action '$name' took $totalSeconds seconds" +} + +function Get-Remote-File-Size($zipUri) { + try { + $response = Invoke-WebRequest -Uri $zipUri -Method Head + $fileSize = $response.Headers["Content-Length"] + if ((![string]::IsNullOrEmpty($fileSize))) { + Say "Remote file $zipUri size is $fileSize bytes." + + return $fileSize + } + } + catch { + Say-Verbose "Content-Length header was not extracted for $zipUri." + } + + return $null +} + +function Say-Invocation($Invocation) { + $command = $Invocation.MyCommand; + $args = (($Invocation.BoundParameters.Keys | foreach { "-$_ `"$($Invocation.BoundParameters[$_])`"" }) -join " ") + Say-Verbose "$command $args" +} + +function Invoke-With-Retry([ScriptBlock]$ScriptBlock, [System.Threading.CancellationToken]$cancellationToken = [System.Threading.CancellationToken]::None, [int]$MaxAttempts = 3, [int]$SecondsBetweenAttempts = 1) { + $Attempts = 0 + $local:startTime = $(get-date) + + while ($true) { + try { + return & $ScriptBlock + } + catch { + $Attempts++ + if (($Attempts -lt $MaxAttempts) -and -not $cancellationToken.IsCancellationRequested) { + Start-Sleep $SecondsBetweenAttempts + } + else { + $local:elapsedTime = $(get-date) - $local:startTime + if (($local:elapsedTime.TotalSeconds - $DownloadTimeout) -gt 0 -and -not $cancellationToken.IsCancellationRequested) { + throw New-Object System.TimeoutException("Failed to reach the server: connection timeout: default timeout is $DownloadTimeout second(s)"); + } + throw; + } + } + } +} + +function Get-Machine-Architecture() { + Say-Invocation $MyInvocation + + # On PS x86, PROCESSOR_ARCHITECTURE reports x86 even on x64 systems. + # To get the correct architecture, we need to use PROCESSOR_ARCHITEW6432. + # PS x64 doesn't define this, so we fall back to PROCESSOR_ARCHITECTURE. + # Possible values: amd64, x64, x86, arm64, arm + if ( $ENV:PROCESSOR_ARCHITEW6432 -ne $null ) { + return $ENV:PROCESSOR_ARCHITEW6432 + } + + try { + if ( ((Get-CimInstance -ClassName CIM_OperatingSystem).OSArchitecture) -like "ARM*") { + if ( [Environment]::Is64BitOperatingSystem ) { + return "arm64" + } + return "arm" + } + } + catch { + # Machine doesn't support Get-CimInstance + } + + return $ENV:PROCESSOR_ARCHITECTURE +} + +function Get-CLIArchitecture-From-Architecture([string]$Architecture) { + Say-Invocation $MyInvocation + + if ($Architecture -eq "") { + $Architecture = Get-Machine-Architecture + } + + switch ($Architecture.ToLowerInvariant()) { + { ($_ -eq "amd64") -or ($_ -eq "x64") } { return "x64" } + { $_ -eq "x86" } { return "x86" } + { $_ -eq "arm" } { return "arm" } + { $_ -eq "arm64" } { return "arm64" } + default { throw "Architecture '$Architecture' not supported. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues" } + } +} + +function ValidateFeedCredential([string] $FeedCredential) { + if ($Internal -and [string]::IsNullOrWhitespace($FeedCredential)) { + $message = "Provide credentials via -FeedCredential parameter." + if ($DryRun) { + Say-Warning "$message" + } + else { + throw "$message" + } + } + + #FeedCredential should start with "?", for it to be added to the end of the link. + #adding "?" at the beginning of the FeedCredential if needed. + if ((![string]::IsNullOrWhitespace($FeedCredential)) -and ($FeedCredential[0] -ne '?')) { + $FeedCredential = "?" + $FeedCredential + } + + return $FeedCredential +} +function Get-NormalizedQuality([string]$Quality) { + Say-Invocation $MyInvocation + + if ([string]::IsNullOrEmpty($Quality)) { + return "" + } + + switch ($Quality) { + { @("daily", "preview") -contains $_ } { return $Quality.ToLowerInvariant() } + #ga quality is available without specifying quality, so normalizing it to empty + { $_ -eq "ga" } { return "" } + default { throw "'$Quality' is not a supported value for -Quality option. Supported values are: daily, preview, ga. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues." } + } +} + +function Get-NormalizedChannel([string]$Channel) { + Say-Invocation $MyInvocation + + if ([string]::IsNullOrEmpty($Channel)) { + return "" + } + + if ($Channel.Contains("Current")) { + Say-Warning 'Value "Current" is deprecated for -Channel option. Use "STS" instead.' + } + + if ($Channel.StartsWith('release/')) { + Say-Warning 'Using branch name with -Channel option is no longer supported with newer releases. Use -Quality option with a channel in X.Y format instead, such as "-Channel 5.0 -Quality Daily."' + } + + switch ($Channel) { + { $_ -eq "lts" } { return "LTS" } + { $_ -eq "sts" } { return "STS" } + { $_ -eq "current" } { return "STS" } + default { return $Channel.ToLowerInvariant() } + } +} + +function Get-NormalizedProduct([string]$Runtime) { + Say-Invocation $MyInvocation + + switch ($Runtime) { + { $_ -eq "dotnet" } { return "dotnet-runtime" } + { $_ -eq "aspnetcore" } { return "aspnetcore-runtime" } + { $_ -eq "windowsdesktop" } { return "windowsdesktop-runtime" } + { [string]::IsNullOrEmpty($_) } { return "dotnet-sdk" } + default { throw "'$Runtime' is not a supported value for -Runtime option, supported values are: dotnet, aspnetcore, windowsdesktop. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues." } + } +} + + +# The version text returned from the feeds is a 1-line or 2-line string: +# For the SDK and the dotnet runtime (2 lines): +# Line 1: # commit_hash +# Line 2: # 4-part version +# For the aspnetcore runtime (1 line): +# Line 1: # 4-part version +function Get-Version-From-LatestVersion-File-Content([string]$VersionText) { + Say-Invocation $MyInvocation + + $Data = -split $VersionText + + $VersionInfo = @{ + CommitHash = $(if ($Data.Count -gt 1) { $Data[0] }) + Version = $Data[-1] # last line is always the version number. + } + return $VersionInfo +} + +function Load-Assembly([string] $Assembly) { + try { + Add-Type -Assembly $Assembly | Out-Null + } + catch { + # On Nano Server, Powershell Core Edition is used. Add-Type is unable to resolve base class assemblies because they are not GAC'd. + # Loading the base class assemblies is not unnecessary as the types will automatically get resolved. + } +} + +function GetHTTPResponse([Uri] $Uri, [bool]$HeaderOnly, [bool]$DisableRedirect, [bool]$DisableFeedCredential) { + $cts = New-Object System.Threading.CancellationTokenSource + + $downloadScript = { + + $HttpClient = $null + + try { + # HttpClient is used vs Invoke-WebRequest in order to support Nano Server which doesn't support the Invoke-WebRequest cmdlet. + Load-Assembly -Assembly System.Net.Http + + if (-not $ProxyAddress) { + try { + # Despite no proxy being explicitly specified, we may still be behind a default proxy + $DefaultProxy = [System.Net.WebRequest]::DefaultWebProxy; + if ($DefaultProxy -and (-not $DefaultProxy.IsBypassed($Uri))) { + if ($null -ne $DefaultProxy.GetProxy($Uri)) { + $ProxyAddress = $DefaultProxy.GetProxy($Uri).OriginalString + } + else { + $ProxyAddress = $null + } + $ProxyUseDefaultCredentials = $true + } + } + catch { + # Eat the exception and move forward as the above code is an attempt + # at resolving the DefaultProxy that may not have been a problem. + $ProxyAddress = $null + Say-Verbose("Exception ignored: $_.Exception.Message - moving forward...") + } + } + + $HttpClientHandler = New-Object System.Net.Http.HttpClientHandler + if ($ProxyAddress) { + $HttpClientHandler.Proxy = New-Object System.Net.WebProxy -Property @{ + Address = $ProxyAddress; + UseDefaultCredentials = $ProxyUseDefaultCredentials; + BypassList = $ProxyBypassList; + } + } + if ($DisableRedirect) { + $HttpClientHandler.AllowAutoRedirect = $false + } + $HttpClient = New-Object System.Net.Http.HttpClient -ArgumentList $HttpClientHandler + + # Default timeout for HttpClient is 100s. For a 50 MB download this assumes 500 KB/s average, any less will time out + # Defaulting to 20 minutes allows it to work over much slower connections. + $HttpClient.Timeout = New-TimeSpan -Seconds $DownloadTimeout + + if ($HeaderOnly) { + $completionOption = [System.Net.Http.HttpCompletionOption]::ResponseHeadersRead + } + else { + $completionOption = [System.Net.Http.HttpCompletionOption]::ResponseContentRead + } + + if ($DisableFeedCredential) { + $UriWithCredential = $Uri + } + else { + $UriWithCredential = "${Uri}${FeedCredential}" + } + + $Task = $HttpClient.GetAsync("$UriWithCredential", $completionOption).ConfigureAwait("false"); + $Response = $Task.GetAwaiter().GetResult(); + + if (($null -eq $Response) -or ((-not $HeaderOnly) -and (-not ($Response.IsSuccessStatusCode)))) { + # The feed credential is potentially sensitive info. Do not log FeedCredential to console output. + $DownloadException = [System.Exception] "Unable to download $Uri." + + if ($null -ne $Response) { + $DownloadException.Data["StatusCode"] = [int] $Response.StatusCode + $DownloadException.Data["ErrorMessage"] = "Unable to download $Uri. Returned HTTP status code: " + $DownloadException.Data["StatusCode"] + + if (404 -eq [int] $Response.StatusCode) { + $cts.Cancel() + } + } + + throw $DownloadException + } + + return $Response + } + catch [System.Net.Http.HttpRequestException] { + $DownloadException = [System.Exception] "Unable to download $Uri." + + # Pick up the exception message and inner exceptions' messages if they exist + $CurrentException = $PSItem.Exception + $ErrorMsg = $CurrentException.Message + "`r`n" + while ($CurrentException.InnerException) { + $CurrentException = $CurrentException.InnerException + $ErrorMsg += $CurrentException.Message + "`r`n" + } + + # Check if there is an issue concerning TLS. + if ($ErrorMsg -like "*SSL/TLS*") { + $ErrorMsg += "Ensure that TLS 1.2 or higher is enabled to use this script.`r`n" + } + + $DownloadException.Data["ErrorMessage"] = $ErrorMsg + throw $DownloadException + } + finally { + if ($null -ne $HttpClient) { + $HttpClient.Dispose() + } + } + } + + try { + return Invoke-With-Retry $downloadScript $cts.Token + } + finally { + if ($null -ne $cts) { + $cts.Dispose() + } + } +} + +function Get-Version-From-LatestVersion-File([string]$AzureFeed, [string]$Channel) { + Say-Invocation $MyInvocation + + $VersionFileUrl = $null + if ($Runtime -eq "dotnet") { + $VersionFileUrl = "$AzureFeed/Runtime/$Channel/latest.version" + } + elseif ($Runtime -eq "aspnetcore") { + $VersionFileUrl = "$AzureFeed/aspnetcore/Runtime/$Channel/latest.version" + } + elseif ($Runtime -eq "windowsdesktop") { + $VersionFileUrl = "$AzureFeed/WindowsDesktop/$Channel/latest.version" + } + elseif (-not $Runtime) { + $VersionFileUrl = "$AzureFeed/Sdk/$Channel/latest.version" + } + else { + throw "Invalid value for `$Runtime" + } + + Say-Verbose "Constructed latest.version URL: $VersionFileUrl" + + try { + $Response = GetHTTPResponse -Uri $VersionFileUrl + } + catch { + Say-Verbose "Failed to download latest.version file." + throw + } + $StringContent = $Response.Content.ReadAsStringAsync().Result + + switch ($Response.Content.Headers.ContentType) { + { ($_ -eq "application/octet-stream") } { $VersionText = $StringContent } + { ($_ -eq "text/plain") } { $VersionText = $StringContent } + { ($_ -eq "text/plain; charset=UTF-8") } { $VersionText = $StringContent } + default { throw "``$Response.Content.Headers.ContentType`` is an unknown .version file content type." } + } + + $VersionInfo = Get-Version-From-LatestVersion-File-Content $VersionText + + return $VersionInfo +} + +function Parse-Jsonfile-For-Version([string]$JSonFile) { + Say-Invocation $MyInvocation + + If (-Not (Test-Path $JSonFile)) { + throw "Unable to find '$JSonFile'" + } + try { + $JSonContent = Get-Content($JSonFile) -Raw | ConvertFrom-Json | Select-Object -expand "sdk" -ErrorAction SilentlyContinue + } + catch { + Say-Error "Json file unreadable: '$JSonFile'" + throw + } + if ($JSonContent) { + try { + $JSonContent.PSObject.Properties | ForEach-Object { + $PropertyName = $_.Name + if ($PropertyName -eq "version") { + $Version = $_.Value + Say-Verbose "Version = $Version" + } + } + } + catch { + Say-Error "Unable to parse the SDK node in '$JSonFile'" + throw + } + } + else { + throw "Unable to find the SDK node in '$JSonFile'" + } + If ($Version -eq $null) { + throw "Unable to find the SDK:version node in '$JSonFile'" + } + return $Version +} + +function Get-Specific-Version-From-Version([string]$AzureFeed, [string]$Channel, [string]$Version, [string]$JSonFile) { + Say-Invocation $MyInvocation + + if (-not $JSonFile) { + if ($Version.ToLowerInvariant() -eq "latest") { + $LatestVersionInfo = Get-Version-From-LatestVersion-File -AzureFeed $AzureFeed -Channel $Channel + return $LatestVersionInfo.Version + } + else { + return $Version + } + } + else { + return Parse-Jsonfile-For-Version $JSonFile + } +} + +function Get-Download-Link([string]$AzureFeed, [string]$SpecificVersion, [string]$CLIArchitecture) { + Say-Invocation $MyInvocation + + # If anything fails in this lookup it will default to $SpecificVersion + $SpecificProductVersion = Get-Product-Version -AzureFeed $AzureFeed -SpecificVersion $SpecificVersion + + if ($Runtime -eq "dotnet") { + $PayloadURL = "$AzureFeed/Runtime/$SpecificVersion/dotnet-runtime-$SpecificProductVersion-win-$CLIArchitecture.zip" + } + elseif ($Runtime -eq "aspnetcore") { + $PayloadURL = "$AzureFeed/aspnetcore/Runtime/$SpecificVersion/aspnetcore-runtime-$SpecificProductVersion-win-$CLIArchitecture.zip" + } + elseif ($Runtime -eq "windowsdesktop") { + # The windows desktop runtime is part of the core runtime layout prior to 5.0 + $PayloadURL = "$AzureFeed/Runtime/$SpecificVersion/windowsdesktop-runtime-$SpecificProductVersion-win-$CLIArchitecture.zip" + if ($SpecificVersion -match '^(\d+)\.(.*)$') { + $majorVersion = [int]$Matches[1] + if ($majorVersion -ge 5) { + $PayloadURL = "$AzureFeed/WindowsDesktop/$SpecificVersion/windowsdesktop-runtime-$SpecificProductVersion-win-$CLIArchitecture.zip" + } + } + } + elseif (-not $Runtime) { + $PayloadURL = "$AzureFeed/Sdk/$SpecificVersion/dotnet-sdk-$SpecificProductVersion-win-$CLIArchitecture.zip" + } + else { + throw "Invalid value for `$Runtime" + } + + Say-Verbose "Constructed primary named payload URL: $PayloadURL" + + return $PayloadURL, $SpecificProductVersion +} + +function Get-LegacyDownload-Link([string]$AzureFeed, [string]$SpecificVersion, [string]$CLIArchitecture) { + Say-Invocation $MyInvocation + + if (-not $Runtime) { + $PayloadURL = "$AzureFeed/Sdk/$SpecificVersion/dotnet-dev-win-$CLIArchitecture.$SpecificVersion.zip" + } + elseif ($Runtime -eq "dotnet") { + $PayloadURL = "$AzureFeed/Runtime/$SpecificVersion/dotnet-win-$CLIArchitecture.$SpecificVersion.zip" + } + else { + return $null + } + + Say-Verbose "Constructed legacy named payload URL: $PayloadURL" + + return $PayloadURL +} + +function Get-Product-Version([string]$AzureFeed, [string]$SpecificVersion, [string]$PackageDownloadLink) { + Say-Invocation $MyInvocation + + # Try to get the version number, using the productVersion.txt file located next to the installer file. + $ProductVersionTxtURLs = (Get-Product-Version-Url $AzureFeed $SpecificVersion $PackageDownloadLink -Flattened $true), + (Get-Product-Version-Url $AzureFeed $SpecificVersion $PackageDownloadLink -Flattened $false) + + Foreach ($ProductVersionTxtURL in $ProductVersionTxtURLs) { + Say-Verbose "Checking for the existence of $ProductVersionTxtURL" + + try { + $productVersionResponse = GetHTTPResponse($productVersionTxtUrl) + + if ($productVersionResponse.StatusCode -eq 200) { + $productVersion = $productVersionResponse.Content.ReadAsStringAsync().Result.Trim() + if ($productVersion -ne $SpecificVersion) { + Say "Using alternate version $productVersion found in $ProductVersionTxtURL" + } + return $productVersion + } + else { + Say-Verbose "Got StatusCode $($productVersionResponse.StatusCode) when trying to get productVersion.txt at $productVersionTxtUrl." + } + } + catch { + Say-Verbose "Could not read productVersion.txt at $productVersionTxtUrl (Exception: '$($_.Exception.Message)'. )" + } + } + + # Getting the version number with productVersion.txt has failed. Try parsing the download link for a version number. + if ([string]::IsNullOrEmpty($PackageDownloadLink)) { + Say-Verbose "Using the default value '$SpecificVersion' as the product version." + return $SpecificVersion + } + + $productVersion = Get-ProductVersionFromDownloadLink $PackageDownloadLink $SpecificVersion + return $productVersion +} + +function Get-Product-Version-Url([string]$AzureFeed, [string]$SpecificVersion, [string]$PackageDownloadLink, [bool]$Flattened) { + Say-Invocation $MyInvocation + + $majorVersion = $null + if ($SpecificVersion -match '^(\d+)\.(.*)') { + $majorVersion = $Matches[1] -as [int] + } + + $pvFileName = 'productVersion.txt' + if ($Flattened) { + if (-not $Runtime) { + $pvFileName = 'sdk-productVersion.txt' + } + elseif ($Runtime -eq "dotnet") { + $pvFileName = 'runtime-productVersion.txt' + } + else { + $pvFileName = "$Runtime-productVersion.txt" + } + } + + if ([string]::IsNullOrEmpty($PackageDownloadLink)) { + if ($Runtime -eq "dotnet") { + $ProductVersionTxtURL = "$AzureFeed/Runtime/$SpecificVersion/$pvFileName" + } + elseif ($Runtime -eq "aspnetcore") { + $ProductVersionTxtURL = "$AzureFeed/aspnetcore/Runtime/$SpecificVersion/$pvFileName" + } + elseif ($Runtime -eq "windowsdesktop") { + # The windows desktop runtime is part of the core runtime layout prior to 5.0 + $ProductVersionTxtURL = "$AzureFeed/Runtime/$SpecificVersion/$pvFileName" + if ($majorVersion -ne $null -and $majorVersion -ge 5) { + $ProductVersionTxtURL = "$AzureFeed/WindowsDesktop/$SpecificVersion/$pvFileName" + } + } + elseif (-not $Runtime) { + $ProductVersionTxtURL = "$AzureFeed/Sdk/$SpecificVersion/$pvFileName" + } + else { + throw "Invalid value '$Runtime' specified for `$Runtime" + } + } + else { + $ProductVersionTxtURL = $PackageDownloadLink.Substring(0, $PackageDownloadLink.LastIndexOf("/")) + "/$pvFileName" + } + + Say-Verbose "Constructed productVersion link: $ProductVersionTxtURL" + + return $ProductVersionTxtURL +} + +function Get-ProductVersionFromDownloadLink([string]$PackageDownloadLink, [string]$SpecificVersion) { + Say-Invocation $MyInvocation + + #product specific version follows the product name + #for filename 'dotnet-sdk-3.1.404-win-x64.zip': the product version is 3.1.400 + $filename = $PackageDownloadLink.Substring($PackageDownloadLink.LastIndexOf("/") + 1) + $filenameParts = $filename.Split('-') + if ($filenameParts.Length -gt 2) { + $productVersion = $filenameParts[2] + Say-Verbose "Extracted product version '$productVersion' from download link '$PackageDownloadLink'." + } + else { + Say-Verbose "Using the default value '$SpecificVersion' as the product version." + $productVersion = $SpecificVersion + } + return $productVersion +} + +function Get-User-Share-Path() { + Say-Invocation $MyInvocation + + $InstallRoot = $env:DOTNET_INSTALL_DIR + if (!$InstallRoot) { + $InstallRoot = "$env:LocalAppData\Microsoft\dotnet" + } + elseif ($InstallRoot -like "$env:ProgramFiles\dotnet\?*") { + Say-Warning "The install root specified by the environment variable DOTNET_INSTALL_DIR points to the sub folder of $env:ProgramFiles\dotnet which is the default dotnet install root using .NET SDK installer. It is better to keep aligned with .NET SDK installer." + } + return $InstallRoot +} + +function Resolve-Installation-Path([string]$InstallDir) { + Say-Invocation $MyInvocation + + if ($InstallDir -eq "") { + return Get-User-Share-Path + } + return $InstallDir +} + +function Test-User-Write-Access([string]$InstallDir) { + try { + $tempFileName = [guid]::NewGuid().ToString() + $tempFilePath = Join-Path -Path $InstallDir -ChildPath $tempFileName + New-Item -Path $tempFilePath -ItemType File -Force + Remove-Item $tempFilePath -Force + return $true + } + catch { + return $false + } +} + +function Is-Dotnet-Package-Installed([string]$InstallRoot, [string]$RelativePathToPackage, [string]$SpecificVersion) { + Say-Invocation $MyInvocation + + $DotnetPackagePath = Join-Path -Path $InstallRoot -ChildPath $RelativePathToPackage | Join-Path -ChildPath $SpecificVersion + Say-Verbose "Is-Dotnet-Package-Installed: DotnetPackagePath=$DotnetPackagePath" + return Test-Path $DotnetPackagePath -PathType Container +} + +function Get-Absolute-Path([string]$RelativeOrAbsolutePath) { + # Too much spam + # Say-Invocation $MyInvocation + + return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($RelativeOrAbsolutePath) +} + +function Get-Path-Prefix-With-Version($path) { + # example path with regex: shared/1.0.0-beta-12345/somepath + $match = [regex]::match($path, "/\d+\.\d+[^/]+/") + if ($match.Success) { + return $entry.FullName.Substring(0, $match.Index + $match.Length) + } + + return $null +} + +function Get-List-Of-Directories-And-Versions-To-Unpack-From-Dotnet-Package([System.IO.Compression.ZipArchive]$Zip, [string]$OutPath) { + Say-Invocation $MyInvocation + + $ret = @() + foreach ($entry in $Zip.Entries) { + $dir = Get-Path-Prefix-With-Version $entry.FullName + if ($null -ne $dir) { + $path = Get-Absolute-Path $(Join-Path -Path $OutPath -ChildPath $dir) + if (-Not (Test-Path $path -PathType Container)) { + $ret += $dir + } + } + } + + $ret = $ret | Sort-Object | Get-Unique + + $values = ($ret | foreach { "$_" }) -join ";" + Say-Verbose "Directories to unpack: $values" + + return $ret +} + +# Example zip content and extraction algorithm: +# Rule: files if extracted are always being extracted to the same relative path locally +# .\ +# a.exe # file does not exist locally, extract +# b.dll # file exists locally, override only if $OverrideFiles set +# aaa\ # same rules as for files +# ... +# abc\1.0.0\ # directory contains version and exists locally +# ... # do not extract content under versioned part +# abc\asd\ # same rules as for files +# ... +# def\ghi\1.0.1\ # directory contains version and does not exist locally +# ... # extract content +function Extract-Dotnet-Package([string]$ZipPath, [string]$OutPath) { + Say-Invocation $MyInvocation + + Load-Assembly -Assembly System.IO.Compression.FileSystem + Set-Variable -Name Zip + try { + $Zip = [System.IO.Compression.ZipFile]::OpenRead($ZipPath) + + $DirectoriesToUnpack = Get-List-Of-Directories-And-Versions-To-Unpack-From-Dotnet-Package -Zip $Zip -OutPath $OutPath + + foreach ($entry in $Zip.Entries) { + $PathWithVersion = Get-Path-Prefix-With-Version $entry.FullName + if (($null -eq $PathWithVersion) -Or ($DirectoriesToUnpack -contains $PathWithVersion)) { + $DestinationPath = Get-Absolute-Path $(Join-Path -Path $OutPath -ChildPath $entry.FullName) + $DestinationDir = Split-Path -Parent $DestinationPath + $OverrideFiles = $OverrideNonVersionedFiles -Or (-Not (Test-Path $DestinationPath)) + if ((-Not $DestinationPath.EndsWith("\")) -And $OverrideFiles) { + New-Item -ItemType Directory -Force -Path $DestinationDir | Out-Null + [System.IO.Compression.ZipFileExtensions]::ExtractToFile($entry, $DestinationPath, $OverrideNonVersionedFiles) + } + } + } + } + catch { + Say-Error "Failed to extract package. Exception: $_" + throw; + } + finally { + if ($null -ne $Zip) { + $Zip.Dispose() + } + } +} + +function DownloadFile($Source, [string]$OutPath) { + if ($Source -notlike "http*") { + # Using System.IO.Path.GetFullPath to get the current directory + # does not work in this context - $pwd gives the current directory + if (![System.IO.Path]::IsPathRooted($Source)) { + $Source = $(Join-Path -Path $pwd -ChildPath $Source) + } + $Source = Get-Absolute-Path $Source + Say "Copying file from $Source to $OutPath" + Copy-Item $Source $OutPath + return + } + + $Stream = $null + + try { + $Response = GetHTTPResponse -Uri $Source + $Stream = $Response.Content.ReadAsStreamAsync().Result + $File = [System.IO.File]::Create($OutPath) + $Stream.CopyTo($File) + $File.Close() + + ValidateRemoteLocalFileSizes -LocalFileOutPath $OutPath -SourceUri $Source + } + finally { + if ($null -ne $Stream) { + $Stream.Dispose() + } + } +} + +function ValidateRemoteLocalFileSizes([string]$LocalFileOutPath, $SourceUri) { + try { + $remoteFileSize = Get-Remote-File-Size -zipUri $SourceUri + $fileSize = [long](Get-Item $LocalFileOutPath).Length + Say "Downloaded file $SourceUri size is $fileSize bytes." + + if ((![string]::IsNullOrEmpty($remoteFileSize)) -and !([string]::IsNullOrEmpty($fileSize)) ) { + if ($remoteFileSize -ne $fileSize) { + Say "The remote and local file sizes are not equal. Remote file size is $remoteFileSize bytes and local size is $fileSize bytes. The local package may be corrupted." + } + else { + Say "The remote and local file sizes are equal." + } + } + else { + Say "Either downloaded or local package size can not be measured. One of them may be corrupted." + } + } + catch { + Say "Either downloaded or local package size can not be measured. One of them may be corrupted." + } +} + +function SafeRemoveFile($Path) { + try { + if (Test-Path $Path) { + Remove-Item $Path + Say-Verbose "The temporary file `"$Path`" was removed." + } + else { + Say-Verbose "The temporary file `"$Path`" does not exist, therefore is not removed." + } + } + catch { + Say-Warning "Failed to remove the temporary file: `"$Path`", remove it manually." + } +} + +function Prepend-Sdk-InstallRoot-To-Path([string]$InstallRoot) { + $BinPath = Get-Absolute-Path $(Join-Path -Path $InstallRoot -ChildPath "") + if (-Not $NoPath) { + $SuffixedBinPath = "$BinPath;" + if (-Not $env:path.Contains($SuffixedBinPath)) { + Say "Adding to current process PATH: `"$BinPath`". Note: This change will not be visible if PowerShell was run as a child process." + $env:path = $SuffixedBinPath + $env:path + } + else { + Say-Verbose "Current process PATH already contains `"$BinPath`"" + } + } + else { + Say "Binaries of dotnet can be found in $BinPath" + } +} + +function PrintDryRunOutput($Invocation, $DownloadLinks) { + Say "Payload URLs:" + + for ($linkIndex = 0; $linkIndex -lt $DownloadLinks.count; $linkIndex++) { + Say "URL #$linkIndex - $($DownloadLinks[$linkIndex].type): $($DownloadLinks[$linkIndex].downloadLink)" + } + $RepeatableCommand = ".\$ScriptName -Version `"$SpecificVersion`" -InstallDir `"$InstallRoot`" -Architecture `"$CLIArchitecture`"" + if ($Runtime -eq "dotnet") { + $RepeatableCommand += " -Runtime `"dotnet`"" + } + elseif ($Runtime -eq "aspnetcore") { + $RepeatableCommand += " -Runtime `"aspnetcore`"" + } + + foreach ($key in $Invocation.BoundParameters.Keys) { + if (-not (@("Architecture", "Channel", "DryRun", "InstallDir", "Runtime", "SharedRuntime", "Version", "Quality", "FeedCredential") -contains $key)) { + $RepeatableCommand += " -$key `"$($Invocation.BoundParameters[$key])`"" + } + } + if ($Invocation.BoundParameters.Keys -contains "FeedCredential") { + $RepeatableCommand += " -FeedCredential `"`"" + } + Say "Repeatable invocation: $RepeatableCommand" + if ($SpecificVersion -ne $EffectiveVersion) { + Say "NOTE: Due to finding a version manifest with this runtime, it would actually install with version '$EffectiveVersion'" + } +} + +function Get-AkaMSDownloadLink([string]$Channel, [string]$Quality, [bool]$Internal, [string]$Product, [string]$Architecture) { + Say-Invocation $MyInvocation + + #quality is not supported for LTS or STS channel + if (![string]::IsNullOrEmpty($Quality) -and (@("LTS", "STS") -contains $Channel)) { + $Quality = "" + Say-Warning "Specifying quality for STS or LTS channel is not supported, the quality will be ignored." + } + Say-Verbose "Retrieving primary payload URL from aka.ms link for channel: '$Channel', quality: '$Quality' product: '$Product', os: 'win', architecture: '$Architecture'." + + #construct aka.ms link + $akaMsLink = "https://aka.ms/dotnet" + if ($Internal) { + $akaMsLink += "/internal" + } + $akaMsLink += "/$Channel" + if (-not [string]::IsNullOrEmpty($Quality)) { + $akaMsLink += "/$Quality" + } + $akaMsLink += "/$Product-win-$Architecture.zip" + Say-Verbose "Constructed aka.ms link: '$akaMsLink'." + $akaMsDownloadLink = $null + + for ($maxRedirections = 9; $maxRedirections -ge 0; $maxRedirections--) { + #get HTTP response + #do not pass credentials as a part of the $akaMsLink and do not apply credentials in the GetHTTPResponse function + #otherwise the redirect link would have credentials as well + #it would result in applying credentials twice to the resulting link and thus breaking it, and in echoing credentials to the output as a part of redirect link + $Response = GetHTTPResponse -Uri $akaMsLink -HeaderOnly $true -DisableRedirect $true -DisableFeedCredential $true + Say-Verbose "Received response:`n$Response" + + if ([string]::IsNullOrEmpty($Response)) { + Say-Verbose "The link '$akaMsLink' is not valid: failed to get redirect location. The resource is not available." + return $null + } + + #if HTTP code is 301 (Moved Permanently), the redirect link exists + if ($Response.StatusCode -eq 301) { + try { + $akaMsDownloadLink = $Response.Headers.GetValues("Location")[0] + + if ([string]::IsNullOrEmpty($akaMsDownloadLink)) { + Say-Verbose "The link '$akaMsLink' is not valid: server returned 301 (Moved Permanently), but the headers do not contain the redirect location." + return $null + } + + Say-Verbose "The redirect location retrieved: '$akaMsDownloadLink'." + # This may yet be a link to another redirection. Attempt to retrieve the page again. + $akaMsLink = $akaMsDownloadLink + continue + } + catch { + Say-Verbose "The link '$akaMsLink' is not valid: failed to get redirect location." + return $null + } + } + elseif ((($Response.StatusCode -lt 300) -or ($Response.StatusCode -ge 400)) -and (-not [string]::IsNullOrEmpty($akaMsDownloadLink))) { + # Redirections have ended. + return $akaMsDownloadLink + } + + Say-Verbose "The link '$akaMsLink' is not valid: failed to retrieve the redirection location." + return $null + } + + Say-Verbose "Aka.ms links have redirected more than the maximum allowed redirections. This may be caused by a cyclic redirection of aka.ms links." + return $null + +} + +function Get-AkaMsLink-And-Version([string] $NormalizedChannel, [string] $NormalizedQuality, [bool] $Internal, [string] $ProductName, [string] $Architecture) { + $AkaMsDownloadLink = Get-AkaMSDownloadLink -Channel $NormalizedChannel -Quality $NormalizedQuality -Internal $Internal -Product $ProductName -Architecture $Architecture + + if ([string]::IsNullOrEmpty($AkaMsDownloadLink)) { + if (-not [string]::IsNullOrEmpty($NormalizedQuality)) { + # if quality is specified - exit with error - there is no fallback approach + Say-Error "Failed to locate the latest version in the channel '$NormalizedChannel' with '$NormalizedQuality' quality for '$ProductName', os: 'win', architecture: '$Architecture'." + Say-Error "Refer to: https://aka.ms/dotnet-os-lifecycle for information on .NET Core support." + throw "aka.ms link resolution failure" + } + Say-Verbose "Falling back to latest.version file approach." + return ($null, $null, $null) + } + else { + Say-Verbose "Retrieved primary named payload URL from aka.ms link: '$AkaMsDownloadLink'." + Say-Verbose "Downloading using legacy url will not be attempted." + + #get version from the path + $pathParts = $AkaMsDownloadLink.Split('/') + if ($pathParts.Length -ge 2) { + $SpecificVersion = $pathParts[$pathParts.Length - 2] + Say-Verbose "Version: '$SpecificVersion'." + } + else { + Say-Error "Failed to extract the version from download link '$AkaMsDownloadLink'." + return ($null, $null, $null) + } + + #retrieve effective (product) version + $EffectiveVersion = Get-Product-Version -SpecificVersion $SpecificVersion -PackageDownloadLink $AkaMsDownloadLink + Say-Verbose "Product version: '$EffectiveVersion'." + + return ($AkaMsDownloadLink, $SpecificVersion, $EffectiveVersion); + } +} + +function Get-Feeds-To-Use() { + $feeds = @( + "https://builds.dotnet.microsoft.com/dotnet" + "https://ci.dot.net/public" + ) + + if (-not [string]::IsNullOrEmpty($AzureFeed)) { + $feeds = @($AzureFeed) + } + + if (-not [string]::IsNullOrEmpty($UncachedFeed)) { + $feeds = @($UncachedFeed) + } + + Write-Verbose "Initialized feeds: $feeds" + + return $feeds +} + +function Resolve-AssetName-And-RelativePath([string] $Runtime) { + + if ($Runtime -eq "dotnet") { + $assetName = ".NET Core Runtime" + $dotnetPackageRelativePath = "shared\Microsoft.NETCore.App" + } + elseif ($Runtime -eq "aspnetcore") { + $assetName = "ASP.NET Core Runtime" + $dotnetPackageRelativePath = "shared\Microsoft.AspNetCore.App" + } + elseif ($Runtime -eq "windowsdesktop") { + $assetName = ".NET Core Windows Desktop Runtime" + $dotnetPackageRelativePath = "shared\Microsoft.WindowsDesktop.App" + } + elseif (-not $Runtime) { + $assetName = ".NET Core SDK" + $dotnetPackageRelativePath = "sdk" + } + else { + throw "Invalid value for `$Runtime" + } + + return ($assetName, $dotnetPackageRelativePath) +} + +function Prepare-Install-Directory { + $diskSpaceWarning = "Failed to check the disk space. Installation will continue, but it may fail if you do not have enough disk space."; + + if ($PSVersionTable.PSVersion.Major -lt 7) { + Say-Verbose $diskSpaceWarning + return + } + + New-Item -ItemType Directory -Force -Path $InstallRoot | Out-Null + + $installDrive = $((Get-Item $InstallRoot -Force).PSDrive.Name); + $diskInfo = $null + try { + $diskInfo = Get-PSDrive -Name $installDrive + } + catch { + Say-Warning $diskSpaceWarning + } + + # The check is relevant for PS version >= 7, the result can be irrelevant for older versions. See https://github.com/PowerShell/PowerShell/issues/12442. + if ( ($null -ne $diskInfo) -and ($diskInfo.Free / 1MB -le 100)) { + throw "There is not enough disk space on drive ${installDrive}:" + } +} + +if ($Help) { + Get-Help $PSCommandPath -Examples + exit +} + +Say-Verbose "Note that the intended use of this script is for Continuous Integration (CI) scenarios, where:" +Say-Verbose "- The SDK needs to be installed without user interaction and without admin rights." +Say-Verbose "- The SDK installation doesn't need to persist across multiple CI runs." +Say-Verbose "To set up a development environment or to run apps, use installers rather than this script. Visit https://dotnet.microsoft.com/download to get the installer.`r`n" + +if ($SharedRuntime -and (-not $Runtime)) { + $Runtime = "dotnet" +} + +$OverrideNonVersionedFiles = !$SkipNonVersionedFiles + +Measure-Action "Product discovery" { + $script:CLIArchitecture = Get-CLIArchitecture-From-Architecture $Architecture + $script:NormalizedQuality = Get-NormalizedQuality $Quality + Say-Verbose "Normalized quality: '$NormalizedQuality'" + $script:NormalizedChannel = Get-NormalizedChannel $Channel + Say-Verbose "Normalized channel: '$NormalizedChannel'" + $script:NormalizedProduct = Get-NormalizedProduct $Runtime + Say-Verbose "Normalized product: '$NormalizedProduct'" + $script:FeedCredential = ValidateFeedCredential $FeedCredential +} + +$InstallRoot = Resolve-Installation-Path $InstallDir +if (-not (Test-User-Write-Access $InstallRoot)) { + Say-Error "The current user doesn't have write access to the installation root '$InstallRoot' to install .NET. Please try specifying a different installation directory using the -InstallDir parameter, or ensure the selected directory has the appropriate permissions." + throw +} +Say-Verbose "InstallRoot: $InstallRoot" +$ScriptName = $MyInvocation.MyCommand.Name +($assetName, $dotnetPackageRelativePath) = Resolve-AssetName-And-RelativePath -Runtime $Runtime + +$feeds = Get-Feeds-To-Use +$DownloadLinks = @() + +if ($Version.ToLowerInvariant() -ne "latest" -and -not [string]::IsNullOrEmpty($Quality)) { + throw "Quality and Version options are not allowed to be specified simultaneously. See https:// learn.microsoft.com/dotnet/core/tools/dotnet-install-script#options for details." +} + +# aka.ms links can only be used if the user did not request a specific version via the command line or a global.json file. +if ([string]::IsNullOrEmpty($JSonFile) -and ($Version -eq "latest")) { + ($DownloadLink, $SpecificVersion, $EffectiveVersion) = Get-AkaMsLink-And-Version $NormalizedChannel $NormalizedQuality $Internal $NormalizedProduct $CLIArchitecture + + if ($null -ne $DownloadLink) { + $DownloadLinks += New-Object PSObject -Property @{downloadLink = "$DownloadLink"; specificVersion = "$SpecificVersion"; effectiveVersion = "$EffectiveVersion"; type = 'aka.ms' } + Say-Verbose "Generated aka.ms link $DownloadLink with version $EffectiveVersion" + + if (-Not $DryRun) { + Say-Verbose "Checking if the version $EffectiveVersion is already installed" + if (Is-Dotnet-Package-Installed -InstallRoot $InstallRoot -RelativePathToPackage $dotnetPackageRelativePath -SpecificVersion $EffectiveVersion) { + Say "$assetName with version '$EffectiveVersion' is already installed." + Prepend-Sdk-InstallRoot-To-Path -InstallRoot $InstallRoot + return + } + } + } +} + +# Primary and legacy links cannot be used if a quality was specified. +# If we already have an aka.ms link, no need to search the blob feeds. +if ([string]::IsNullOrEmpty($NormalizedQuality) -and 0 -eq $DownloadLinks.count) { + foreach ($feed in $feeds) { + try { + $SpecificVersion = Get-Specific-Version-From-Version -AzureFeed $feed -Channel $Channel -Version $Version -JSonFile $JSonFile + $DownloadLink, $EffectiveVersion = Get-Download-Link -AzureFeed $feed -SpecificVersion $SpecificVersion -CLIArchitecture $CLIArchitecture + $LegacyDownloadLink = Get-LegacyDownload-Link -AzureFeed $feed -SpecificVersion $SpecificVersion -CLIArchitecture $CLIArchitecture + + $DownloadLinks += New-Object PSObject -Property @{downloadLink = "$DownloadLink"; specificVersion = "$SpecificVersion"; effectiveVersion = "$EffectiveVersion"; type = 'primary' } + Say-Verbose "Generated primary link $DownloadLink with version $EffectiveVersion" + + if (-not [string]::IsNullOrEmpty($LegacyDownloadLink)) { + $DownloadLinks += New-Object PSObject -Property @{downloadLink = "$LegacyDownloadLink"; specificVersion = "$SpecificVersion"; effectiveVersion = "$EffectiveVersion"; type = 'legacy' } + Say-Verbose "Generated legacy link $LegacyDownloadLink with version $EffectiveVersion" + } + + if (-Not $DryRun) { + Say-Verbose "Checking if the version $EffectiveVersion is already installed" + if (Is-Dotnet-Package-Installed -InstallRoot $InstallRoot -RelativePathToPackage $dotnetPackageRelativePath -SpecificVersion $EffectiveVersion) { + Say "$assetName with version '$EffectiveVersion' is already installed." + Prepend-Sdk-InstallRoot-To-Path -InstallRoot $InstallRoot + return + } + } + } + catch { + Say-Verbose "Failed to acquire download links from feed $feed. Exception: $_" + } + } +} + +if ($DownloadLinks.count -eq 0) { + throw "Failed to resolve the exact version number." +} + +if ($DryRun) { + PrintDryRunOutput $MyInvocation $DownloadLinks + return +} + +Measure-Action "Installation directory preparation" { Prepare-Install-Directory } + +Say-Verbose "Zip path: $ZipPath" + +$DownloadSucceeded = $false +$DownloadedLink = $null +$ErrorMessages = @() + +foreach ($link in $DownloadLinks) { + Say-Verbose "Downloading `"$($link.type)`" link $($link.downloadLink)" + + try { + Measure-Action "Package download" { DownloadFile -Source $link.downloadLink -OutPath $ZipPath } + Say-Verbose "Download succeeded." + $DownloadSucceeded = $true + $DownloadedLink = $link + break + } + catch { + $StatusCode = $null + $ErrorMessage = $null + + if ($PSItem.Exception.Data.Contains("StatusCode")) { + $StatusCode = $PSItem.Exception.Data["StatusCode"] + } + + if ($PSItem.Exception.Data.Contains("ErrorMessage")) { + $ErrorMessage = $PSItem.Exception.Data["ErrorMessage"] + } + else { + $ErrorMessage = $PSItem.Exception.Message + } + + Say-Verbose "Download failed with status code $StatusCode. Error message: $ErrorMessage" + $ErrorMessages += "Downloading from `"$($link.type)`" link has failed with error:`nUri: $($link.downloadLink)`nStatusCode: $StatusCode`nError: $ErrorMessage" + } + + # This link failed. Clean up before trying the next one. + SafeRemoveFile -Path $ZipPath +} + +if (-not $DownloadSucceeded) { + foreach ($ErrorMessage in $ErrorMessages) { + Say-Error $ErrorMessages + } + + throw "Could not find `"$assetName`" with version = $($DownloadLinks[0].effectiveVersion)`nRefer to: https://aka.ms/dotnet-os-lifecycle for information on .NET support" +} + +Say "Extracting the archive." +Measure-Action "Package extraction" { Extract-Dotnet-Package -ZipPath $ZipPath -OutPath $InstallRoot } + +# Check if the SDK version is installed; if not, fail the installation. +$isAssetInstalled = $false + +# if the version contains "RTM" or "servicing"; check if a 'release-type' SDK version is installed. +if ($DownloadedLink.effectiveVersion -Match "rtm" -or $DownloadedLink.effectiveVersion -Match "servicing") { + $ReleaseVersion = $DownloadedLink.effectiveVersion.Split("-")[0] + Say-Verbose "Checking installation: version = $ReleaseVersion" + $isAssetInstalled = Is-Dotnet-Package-Installed -InstallRoot $InstallRoot -RelativePathToPackage $dotnetPackageRelativePath -SpecificVersion $ReleaseVersion +} + +# Check if the SDK version is installed. +if (!$isAssetInstalled) { + Say-Verbose "Checking installation: version = $($DownloadedLink.effectiveVersion)" + $isAssetInstalled = Is-Dotnet-Package-Installed -InstallRoot $InstallRoot -RelativePathToPackage $dotnetPackageRelativePath -SpecificVersion $DownloadedLink.effectiveVersion +} + +# Version verification failed. More likely something is wrong either with the downloaded content or with the verification algorithm. +if (!$isAssetInstalled) { + Say-Error "Failed to verify the version of installed `"$assetName`".`nInstallation source: $($DownloadedLink.downloadLink).`nInstallation location: $InstallRoot.`nReport the bug at https://github.com/dotnet/install-scripts/issues." + throw "`"$assetName`" with version = $($DownloadedLink.effectiveVersion) failed to install with an unknown error." +} + +if (-not $KeepZip) { + SafeRemoveFile -Path $ZipPath +} + +Measure-Action "Setting up shell environment" { Prepend-Sdk-InstallRoot-To-Path -InstallRoot $InstallRoot } + +Say "Note that the script does not ensure your Windows version is supported during the installation." +Say "To check the list of supported versions, go to https://learn.microsoft.com/dotnet/core/install/windows#supported-versions" +Say "Installed version is $($DownloadedLink.effectiveVersion)" +Say "Installation finished" diff --git a/tools/dotnet-install.sh b/tools/dotnet-install.sh new file mode 100644 index 000000000..6180745ea --- /dev/null +++ b/tools/dotnet-install.sh @@ -0,0 +1,1888 @@ +#!/usr/bin/env bash +# Copyright (c) .NET Foundation and contributors. All rights reserved. +# Licensed under the MIT license. See LICENSE file in the project root for full license information. +# + +# Stop script on NZEC +set -e +# Stop script if unbound variable found (use ${var:-} if intentional) +set -u +# By default cmd1 | cmd2 returns exit code of cmd2 regardless of cmd1 success +# This is causing it to fail +set -o pipefail + +# Use in the the functions: eval $invocation +invocation='say_verbose "Calling: ${yellow:-}${FUNCNAME[0]} ${green:-}$*${normal:-}"' + +# standard output may be used as a return value in the functions +# we need a way to write text on the screen in the functions so that +# it won't interfere with the return value. +# Exposing stream 3 as a pipe to standard output of the script itself +exec 3>&1 + +# Setup some colors to use. These need to work in fairly limited shells, like the Ubuntu Docker container where there are only 8 colors. +# See if stdout is a terminal +if [ -t 1 ] && command -v tput > /dev/null; then + # see if it supports colors + ncolors=$(tput colors || echo 0) + if [ -n "$ncolors" ] && [ $ncolors -ge 8 ]; then + bold="$(tput bold || echo)" + normal="$(tput sgr0 || echo)" + black="$(tput setaf 0 || echo)" + red="$(tput setaf 1 || echo)" + green="$(tput setaf 2 || echo)" + yellow="$(tput setaf 3 || echo)" + blue="$(tput setaf 4 || echo)" + magenta="$(tput setaf 5 || echo)" + cyan="$(tput setaf 6 || echo)" + white="$(tput setaf 7 || echo)" + fi +fi + +say_warning() { + printf "%b\n" "${yellow:-}dotnet_install: Warning: $1${normal:-}" >&3 +} + +say_err() { + printf "%b\n" "${red:-}dotnet_install: Error: $1${normal:-}" >&2 +} + +say() { + # using stream 3 (defined in the beginning) to not interfere with stdout of functions + # which may be used as return value + printf "%b\n" "${cyan:-}dotnet-install:${normal:-} $1" >&3 +} + +say_verbose() { + if [ "$verbose" = true ]; then + say "$1" + fi +} + +# This platform list is finite - if the SDK/Runtime has supported Linux distribution-specific assets, +# then and only then should the Linux distribution appear in this list. +# Adding a Linux distribution to this list does not imply distribution-specific support. +get_legacy_os_name_from_platform() { + eval $invocation + + platform="$1" + case "$platform" in + "centos.7") + echo "centos" + return 0 + ;; + "debian.8") + echo "debian" + return 0 + ;; + "debian.9") + echo "debian.9" + return 0 + ;; + "fedora.23") + echo "fedora.23" + return 0 + ;; + "fedora.24") + echo "fedora.24" + return 0 + ;; + "fedora.27") + echo "fedora.27" + return 0 + ;; + "fedora.28") + echo "fedora.28" + return 0 + ;; + "opensuse.13.2") + echo "opensuse.13.2" + return 0 + ;; + "opensuse.42.1") + echo "opensuse.42.1" + return 0 + ;; + "opensuse.42.3") + echo "opensuse.42.3" + return 0 + ;; + "rhel.7"*) + echo "rhel" + return 0 + ;; + "ubuntu.14.04") + echo "ubuntu" + return 0 + ;; + "ubuntu.16.04") + echo "ubuntu.16.04" + return 0 + ;; + "ubuntu.16.10") + echo "ubuntu.16.10" + return 0 + ;; + "ubuntu.18.04") + echo "ubuntu.18.04" + return 0 + ;; + "alpine.3.4.3") + echo "alpine" + return 0 + ;; + esac + return 1 +} + +get_legacy_os_name() { + eval $invocation + + local uname=$(uname) + if [ "$uname" = "Darwin" ]; then + echo "osx" + return 0 + elif [ -n "$runtime_id" ]; then + echo $(get_legacy_os_name_from_platform "${runtime_id%-*}" || echo "${runtime_id%-*}") + return 0 + else + if [ -e /etc/os-release ]; then + . /etc/os-release + os=$(get_legacy_os_name_from_platform "$ID${VERSION_ID:+.${VERSION_ID}}" || echo "") + if [ -n "$os" ]; then + echo "$os" + return 0 + fi + fi + fi + + say_verbose "Distribution specific OS name and version could not be detected: UName = $uname" + return 1 +} + +get_linux_platform_name() { + eval $invocation + + if [ -n "$runtime_id" ]; then + echo "${runtime_id%-*}" + return 0 + else + if [ -e /etc/os-release ]; then + . /etc/os-release + echo "$ID${VERSION_ID:+.${VERSION_ID}}" + return 0 + elif [ -e /etc/redhat-release ]; then + local redhatRelease=$(&1 || true) | grep -q musl +} + +get_current_os_name() { + eval $invocation + + local uname=$(uname) + if [ "$uname" = "Darwin" ]; then + echo "osx" + return 0 + elif [ "$uname" = "FreeBSD" ]; then + echo "freebsd" + return 0 + elif [ "$uname" = "Linux" ]; then + local linux_platform_name="" + linux_platform_name="$(get_linux_platform_name)" || true + + if [ "$linux_platform_name" = "rhel.6" ]; then + echo $linux_platform_name + return 0 + elif is_musl_based_distro; then + echo "linux-musl" + return 0 + elif [ "$linux_platform_name" = "linux-musl" ]; then + echo "linux-musl" + return 0 + else + echo "linux" + return 0 + fi + fi + + say_err "OS name could not be detected: UName = $uname" + return 1 +} + +machine_has() { + eval $invocation + + command -v "$1" > /dev/null 2>&1 + return $? +} + +check_min_reqs() { + local hasMinimum=false + if machine_has "curl"; then + hasMinimum=true + elif machine_has "wget"; then + hasMinimum=true + fi + + if [ "$hasMinimum" = "false" ]; then + say_err "curl (recommended) or wget are required to download dotnet. Install missing prerequisite to proceed." + return 1 + fi + return 0 +} + +# args: +# input - $1 +to_lowercase() { + #eval $invocation + + echo "$1" | tr '[:upper:]' '[:lower:]' + return 0 +} + +# args: +# input - $1 +remove_trailing_slash() { + #eval $invocation + + local input="${1:-}" + echo "${input%/}" + return 0 +} + +# args: +# input - $1 +remove_beginning_slash() { + #eval $invocation + + local input="${1:-}" + echo "${input#/}" + return 0 +} + +# args: +# root_path - $1 +# child_path - $2 - this parameter can be empty +combine_paths() { + eval $invocation + + # TODO: Consider making it work with any number of paths. For now: + if [ ! -z "${3:-}" ]; then + say_err "combine_paths: Function takes two parameters." + return 1 + fi + + local root_path="$(remove_trailing_slash "$1")" + local child_path="$(remove_beginning_slash "${2:-}")" + say_verbose "combine_paths: root_path=$root_path" + say_verbose "combine_paths: child_path=$child_path" + echo "$root_path/$child_path" + return 0 +} + +get_machine_architecture() { + eval $invocation + + if command -v uname > /dev/null; then + CPUName=$(uname -m) + case $CPUName in + armv1*|armv2*|armv3*|armv4*|armv5*|armv6*) + echo "armv6-or-below" + return 0 + ;; + armv*l) + echo "arm" + return 0 + ;; + aarch64|arm64) + if [ "$(getconf LONG_BIT)" -lt 64 ]; then + # This is 32-bit OS running on 64-bit CPU (for example Raspberry Pi OS) + echo "arm" + return 0 + fi + echo "arm64" + return 0 + ;; + s390x) + echo "s390x" + return 0 + ;; + ppc64le) + echo "ppc64le" + return 0 + ;; + loongarch64) + echo "loongarch64" + return 0 + ;; + riscv64) + echo "riscv64" + return 0 + ;; + powerpc|ppc) + echo "ppc" + return 0 + ;; + esac + fi + + # Always default to 'x64' + echo "x64" + return 0 +} + +# args: +# architecture - $1 +get_normalized_architecture_from_architecture() { + eval $invocation + + local architecture="$(to_lowercase "$1")" + + if [[ $architecture == \ ]]; then + machine_architecture="$(get_machine_architecture)" + if [[ "$machine_architecture" == "armv6-or-below" ]]; then + say_err "Architecture \`$machine_architecture\` not supported. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues" + return 1 + fi + + echo $machine_architecture + return 0 + fi + + case "$architecture" in + amd64|x64) + echo "x64" + return 0 + ;; + arm) + echo "arm" + return 0 + ;; + arm64) + echo "arm64" + return 0 + ;; + s390x) + echo "s390x" + return 0 + ;; + ppc64le) + echo "ppc64le" + return 0 + ;; + loongarch64) + echo "loongarch64" + return 0 + ;; + esac + + say_err "Architecture \`$architecture\` not supported. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues" + return 1 +} + +# args: +# version - $1 +# channel - $2 +# architecture - $3 +get_normalized_architecture_for_specific_sdk_version() { + eval $invocation + + local is_version_support_arm64="$(is_arm64_supported "$1")" + local is_channel_support_arm64="$(is_arm64_supported "$2")" + local architecture="$3"; + local osname="$(get_current_os_name)" + + if [ "$osname" == "osx" ] && [ "$architecture" == "arm64" ] && { [ "$is_version_support_arm64" = false ] || [ "$is_channel_support_arm64" = false ]; }; then + #check if rosetta is installed + if [ "$(/usr/bin/pgrep oahd >/dev/null 2>&1;echo $?)" -eq 0 ]; then + say_verbose "Changing user architecture from '$architecture' to 'x64' because .NET SDKs prior to version 6.0 do not support arm64." + echo "x64" + return 0; + else + say_err "Architecture \`$architecture\` is not supported for .NET SDK version \`$version\`. Please install Rosetta to allow emulation of the \`$architecture\` .NET SDK on this platform" + return 1 + fi + fi + + echo "$architecture" + return 0 +} + +# args: +# version or channel - $1 +is_arm64_supported() { + # Extract the major version by splitting on the dot + major_version="${1%%.*}" + + # Check if the major version is a valid number and less than 6 + case "$major_version" in + [0-9]*) + if [ "$major_version" -lt 6 ]; then + echo false + return 0 + fi + ;; + esac + + echo true + return 0 +} + +# args: +# user_defined_os - $1 +get_normalized_os() { + eval $invocation + + local osname="$(to_lowercase "$1")" + if [ ! -z "$osname" ]; then + case "$osname" in + osx | freebsd | rhel.6 | linux-musl | linux) + echo "$osname" + return 0 + ;; + macos) + osname='osx' + echo "$osname" + return 0 + ;; + *) + say_err "'$user_defined_os' is not a supported value for --os option, supported values are: osx, macos, linux, linux-musl, freebsd, rhel.6. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues." + return 1 + ;; + esac + else + osname="$(get_current_os_name)" || return 1 + fi + echo "$osname" + return 0 +} + +# args: +# quality - $1 +get_normalized_quality() { + eval $invocation + + local quality="$(to_lowercase "$1")" + if [ ! -z "$quality" ]; then + case "$quality" in + daily | preview) + echo "$quality" + return 0 + ;; + ga) + #ga quality is available without specifying quality, so normalizing it to empty + return 0 + ;; + *) + say_err "'$quality' is not a supported value for --quality option. Supported values are: daily, preview, ga. If you think this is a bug, report it at https://github.com/dotnet/install-scripts/issues." + return 1 + ;; + esac + fi + return 0 +} + +# args: +# channel - $1 +get_normalized_channel() { + eval $invocation + + local channel="$(to_lowercase "$1")" + + if [[ $channel == current ]]; then + say_warning 'Value "Current" is deprecated for -Channel option. Use "STS" instead.' + fi + + if [[ $channel == release/* ]]; then + say_warning 'Using branch name with -Channel option is no longer supported with newer releases. Use -Quality option with a channel in X.Y format instead.'; + fi + + if [ ! -z "$channel" ]; then + case "$channel" in + lts) + echo "LTS" + return 0 + ;; + sts) + echo "STS" + return 0 + ;; + current) + echo "STS" + return 0 + ;; + *) + echo "$channel" + return 0 + ;; + esac + fi + + return 0 +} + +# args: +# runtime - $1 +get_normalized_product() { + eval $invocation + + local product="" + local runtime="$(to_lowercase "$1")" + if [[ "$runtime" == "dotnet" ]]; then + product="dotnet-runtime" + elif [[ "$runtime" == "aspnetcore" ]]; then + product="aspnetcore-runtime" + elif [ -z "$runtime" ]; then + product="dotnet-sdk" + fi + echo "$product" + return 0 +} + +# The version text returned from the feeds is a 1-line or 2-line string: +# For the SDK and the dotnet runtime (2 lines): +# Line 1: # commit_hash +# Line 2: # 4-part version +# For the aspnetcore runtime (1 line): +# Line 1: # 4-part version + +# args: +# version_text - stdin +get_version_from_latestversion_file_content() { + eval $invocation + + cat | tail -n 1 | sed 's/\r$//' + return 0 +} + +# args: +# install_root - $1 +# relative_path_to_package - $2 +# specific_version - $3 +is_dotnet_package_installed() { + eval $invocation + + local install_root="$1" + local relative_path_to_package="$2" + local specific_version="${3//[$'\t\r\n']}" + + local dotnet_package_path="$(combine_paths "$(combine_paths "$install_root" "$relative_path_to_package")" "$specific_version")" + say_verbose "is_dotnet_package_installed: dotnet_package_path=$dotnet_package_path" + + if [ -d "$dotnet_package_path" ]; then + return 0 + else + return 1 + fi +} + +# args: +# downloaded file - $1 +# remote_file_size - $2 +validate_remote_local_file_sizes() +{ + eval $invocation + + local downloaded_file="$1" + local remote_file_size="$2" + local file_size='' + + if [[ "$OSTYPE" == "linux-gnu"* ]]; then + file_size="$(stat -c '%s' "$downloaded_file")" + elif [[ "$OSTYPE" == "darwin"* ]]; then + # hardcode in order to avoid conflicts with GNU stat + file_size="$(/usr/bin/stat -f '%z' "$downloaded_file")" + fi + + if [ -n "$file_size" ]; then + say "Downloaded file size is $file_size bytes." + + if [ -n "$remote_file_size" ] && [ -n "$file_size" ]; then + if [ "$remote_file_size" -ne "$file_size" ]; then + say "The remote and local file sizes are not equal. The remote file size is $remote_file_size bytes and the local size is $file_size bytes. The local package may be corrupted." + else + say "The remote and local file sizes are equal." + fi + fi + + else + say "Either downloaded or local package size can not be measured. One of them may be corrupted." + fi +} + +# args: +# azure_feed - $1 +# channel - $2 +# normalized_architecture - $3 +get_version_from_latestversion_file() { + eval $invocation + + local azure_feed="$1" + local channel="$2" + local normalized_architecture="$3" + + local version_file_url=null + if [[ "$runtime" == "dotnet" ]]; then + version_file_url="$azure_feed/Runtime/$channel/latest.version" + elif [[ "$runtime" == "aspnetcore" ]]; then + version_file_url="$azure_feed/aspnetcore/Runtime/$channel/latest.version" + elif [ -z "$runtime" ]; then + version_file_url="$azure_feed/Sdk/$channel/latest.version" + else + say_err "Invalid value for \$runtime" + return 1 + fi + say_verbose "get_version_from_latestversion_file: latest url: $version_file_url" + + download "$version_file_url" || return $? + return 0 +} + +# args: +# json_file - $1 +parse_globaljson_file_for_version() { + eval $invocation + + local json_file="$1" + if [ ! -f "$json_file" ]; then + say_err "Unable to find \`$json_file\`" + return 1 + fi + + sdk_section=$(cat "$json_file" | tr -d "\r" | awk '/"sdk"/,/}/') + if [ -z "$sdk_section" ]; then + say_err "Unable to parse the SDK node in \`$json_file\`" + return 1 + fi + + sdk_list=$(echo $sdk_section | awk -F"[{}]" '{print $2}') + sdk_list=${sdk_list//[\" ]/} + sdk_list=${sdk_list//,/$'\n'} + + local version_info="" + while read -r line; do + IFS=: + while read -r key value; do + if [[ "$key" == "version" ]]; then + version_info=$value + fi + done <<< "$line" + done <<< "$sdk_list" + if [ -z "$version_info" ]; then + say_err "Unable to find the SDK:version node in \`$json_file\`" + return 1 + fi + + unset IFS; + echo "$version_info" + return 0 +} + +# args: +# azure_feed - $1 +# channel - $2 +# normalized_architecture - $3 +# version - $4 +# json_file - $5 +get_specific_version_from_version() { + eval $invocation + + local azure_feed="$1" + local channel="$2" + local normalized_architecture="$3" + local version="$(to_lowercase "$4")" + local json_file="$5" + + if [ -z "$json_file" ]; then + if [[ "$version" == "latest" ]]; then + local version_info + version_info="$(get_version_from_latestversion_file "$azure_feed" "$channel" "$normalized_architecture" false)" || return 1 + say_verbose "get_specific_version_from_version: version_info=$version_info" + echo "$version_info" | get_version_from_latestversion_file_content + return 0 + else + echo "$version" + return 0 + fi + else + local version_info + version_info="$(parse_globaljson_file_for_version "$json_file")" || return 1 + echo "$version_info" + return 0 + fi +} + +# args: +# azure_feed - $1 +# channel - $2 +# normalized_architecture - $3 +# specific_version - $4 +# normalized_os - $5 +construct_download_link() { + eval $invocation + + local azure_feed="$1" + local channel="$2" + local normalized_architecture="$3" + local specific_version="${4//[$'\t\r\n']}" + local specific_product_version="$(get_specific_product_version "$1" "$4")" + local osname="$5" + + local download_link=null + if [[ "$runtime" == "dotnet" ]]; then + download_link="$azure_feed/Runtime/$specific_version/dotnet-runtime-$specific_product_version-$osname-$normalized_architecture.tar.gz" + elif [[ "$runtime" == "aspnetcore" ]]; then + download_link="$azure_feed/aspnetcore/Runtime/$specific_version/aspnetcore-runtime-$specific_product_version-$osname-$normalized_architecture.tar.gz" + elif [ -z "$runtime" ]; then + download_link="$azure_feed/Sdk/$specific_version/dotnet-sdk-$specific_product_version-$osname-$normalized_architecture.tar.gz" + else + return 1 + fi + + echo "$download_link" + return 0 +} + +# args: +# azure_feed - $1 +# specific_version - $2 +# download link - $3 (optional) +get_specific_product_version() { + # If we find a 'productVersion.txt' at the root of any folder, we'll use its contents + # to resolve the version of what's in the folder, superseding the specified version. + # if 'productVersion.txt' is missing but download link is already available, product version will be taken from download link + eval $invocation + + local azure_feed="$1" + local specific_version="${2//[$'\t\r\n']}" + local package_download_link="" + if [ $# -gt 2 ]; then + local package_download_link="$3" + fi + local specific_product_version=null + + # Try to get the version number, using the productVersion.txt file located next to the installer file. + local download_links=($(get_specific_product_version_url "$azure_feed" "$specific_version" true "$package_download_link") + $(get_specific_product_version_url "$azure_feed" "$specific_version" false "$package_download_link")) + + for download_link in "${download_links[@]}" + do + say_verbose "Checking for the existence of $download_link" + + if machine_has "curl" + then + if ! specific_product_version=$(curl -s --fail "${download_link}${feed_credential}" 2>&1); then + continue + else + echo "${specific_product_version//[$'\t\r\n']}" + return 0 + fi + + elif machine_has "wget" + then + specific_product_version=$(wget -qO- "${download_link}${feed_credential}" 2>&1) + if [ $? = 0 ]; then + echo "${specific_product_version//[$'\t\r\n']}" + return 0 + fi + fi + done + + # Getting the version number with productVersion.txt has failed. Try parsing the download link for a version number. + say_verbose "Failed to get the version using productVersion.txt file. Download link will be parsed instead." + specific_product_version="$(get_product_specific_version_from_download_link "$package_download_link" "$specific_version")" + echo "${specific_product_version//[$'\t\r\n']}" + return 0 +} + +# args: +# azure_feed - $1 +# specific_version - $2 +# is_flattened - $3 +# download link - $4 (optional) +get_specific_product_version_url() { + eval $invocation + + local azure_feed="$1" + local specific_version="$2" + local is_flattened="$3" + local package_download_link="" + if [ $# -gt 3 ]; then + local package_download_link="$4" + fi + + local pvFileName="productVersion.txt" + if [ "$is_flattened" = true ]; then + if [ -z "$runtime" ]; then + pvFileName="sdk-productVersion.txt" + elif [[ "$runtime" == "dotnet" ]]; then + pvFileName="runtime-productVersion.txt" + else + pvFileName="$runtime-productVersion.txt" + fi + fi + + local download_link=null + + if [ -z "$package_download_link" ]; then + if [[ "$runtime" == "dotnet" ]]; then + download_link="$azure_feed/Runtime/$specific_version/${pvFileName}" + elif [[ "$runtime" == "aspnetcore" ]]; then + download_link="$azure_feed/aspnetcore/Runtime/$specific_version/${pvFileName}" + elif [ -z "$runtime" ]; then + download_link="$azure_feed/Sdk/$specific_version/${pvFileName}" + else + return 1 + fi + else + download_link="${package_download_link%/*}/${pvFileName}" + fi + + say_verbose "Constructed productVersion link: $download_link" + echo "$download_link" + return 0 +} + +# args: +# download link - $1 +# specific version - $2 +get_product_specific_version_from_download_link() +{ + eval $invocation + + local download_link="$1" + local specific_version="$2" + local specific_product_version="" + + if [ -z "$download_link" ]; then + echo "$specific_version" + return 0 + fi + + #get filename + filename="${download_link##*/}" + + #product specific version follows the product name + #for filename 'dotnet-sdk-3.1.404-linux-x64.tar.gz': the product version is 3.1.404 + IFS='-' + read -ra filename_elems <<< "$filename" + count=${#filename_elems[@]} + if [[ "$count" -gt 2 ]]; then + specific_product_version="${filename_elems[2]}" + else + specific_product_version=$specific_version + fi + unset IFS; + echo "$specific_product_version" + return 0 +} + +# args: +# azure_feed - $1 +# channel - $2 +# normalized_architecture - $3 +# specific_version - $4 +construct_legacy_download_link() { + eval $invocation + + local azure_feed="$1" + local channel="$2" + local normalized_architecture="$3" + local specific_version="${4//[$'\t\r\n']}" + + local distro_specific_osname + distro_specific_osname="$(get_legacy_os_name)" || return 1 + + local legacy_download_link=null + if [[ "$runtime" == "dotnet" ]]; then + legacy_download_link="$azure_feed/Runtime/$specific_version/dotnet-$distro_specific_osname-$normalized_architecture.$specific_version.tar.gz" + elif [ -z "$runtime" ]; then + legacy_download_link="$azure_feed/Sdk/$specific_version/dotnet-dev-$distro_specific_osname-$normalized_architecture.$specific_version.tar.gz" + else + return 1 + fi + + echo "$legacy_download_link" + return 0 +} + +get_user_install_path() { + eval $invocation + + if [ ! -z "${DOTNET_INSTALL_DIR:-}" ]; then + echo "$DOTNET_INSTALL_DIR" + else + echo "$HOME/.dotnet" + fi + return 0 +} + +# args: +# install_dir - $1 +resolve_installation_path() { + eval $invocation + + local install_dir=$1 + if [ "$install_dir" = "" ]; then + local user_install_path="$(get_user_install_path)" + say_verbose "resolve_installation_path: user_install_path=$user_install_path" + echo "$user_install_path" + return 0 + fi + + echo "$install_dir" + return 0 +} + +# args: +# relative_or_absolute_path - $1 +get_absolute_path() { + eval $invocation + + local relative_or_absolute_path=$1 + echo "$(cd "$(dirname "$1")" && pwd -P)/$(basename "$1")" + return 0 +} + +# args: +# override - $1 (boolean, true or false) +get_cp_options() { + eval $invocation + + local override="$1" + local override_switch="" + + if [ "$override" = false ]; then + override_switch="-n" + + # create temporary files to check if 'cp -u' is supported + tmp_dir="$(mktemp -d)" + tmp_file="$tmp_dir/testfile" + tmp_file2="$tmp_dir/testfile2" + + touch "$tmp_file" + + # use -u instead of -n if it's available + if cp -u "$tmp_file" "$tmp_file2" 2>/dev/null; then + override_switch="-u" + fi + + # clean up + rm -f "$tmp_file" "$tmp_file2" + rm -rf "$tmp_dir" + fi + + echo "$override_switch" +} + +# args: +# input_files - stdin +# root_path - $1 +# out_path - $2 +# override - $3 +copy_files_or_dirs_from_list() { + eval $invocation + + local root_path="$(remove_trailing_slash "$1")" + local out_path="$(remove_trailing_slash "$2")" + local override="$3" + local override_switch="$(get_cp_options "$override")" + + cat | uniq | while read -r file_path; do + local path="$(remove_beginning_slash "${file_path#$root_path}")" + local target="$out_path/$path" + if [ "$override" = true ] || (! ([ -d "$target" ] || [ -e "$target" ])); then + mkdir -p "$out_path/$(dirname "$path")" + if [ -d "$target" ]; then + rm -rf "$target" + fi + cp -R $override_switch "$root_path/$path" "$target" + fi + done +} + +# args: +# zip_uri - $1 +get_remote_file_size() { + local zip_uri="$1" + + if machine_has "curl"; then + file_size=$(curl -sI "$zip_uri" | grep -i content-length | awk '{ num = $2 + 0; print num }') + elif machine_has "wget"; then + file_size=$(wget --spider --server-response -O /dev/null "$zip_uri" 2>&1 | grep -i 'Content-Length:' | awk '{ num = $2 + 0; print num }') + else + say "Neither curl nor wget is available on this system." + return + fi + + if [ -n "$file_size" ]; then + say "Remote file $zip_uri size is $file_size bytes." + echo "$file_size" + else + say_verbose "Content-Length header was not extracted for $zip_uri." + echo "" + fi +} + +# args: +# zip_path - $1 +# out_path - $2 +# remote_file_size - $3 +extract_dotnet_package() { + eval $invocation + + local zip_path="$1" + local out_path="$2" + local remote_file_size="$3" + + local temp_out_path="$(mktemp -d "$temporary_file_template")" + + local failed=false + tar -xzf "$zip_path" -C "$temp_out_path" > /dev/null || failed=true + + local folders_with_version_regex='^.*/[0-9]+\.[0-9]+[^/]+/' + find "$temp_out_path" -type f | grep -Eo "$folders_with_version_regex" | sort | copy_files_or_dirs_from_list "$temp_out_path" "$out_path" false + find "$temp_out_path" -type f | grep -Ev "$folders_with_version_regex" | copy_files_or_dirs_from_list "$temp_out_path" "$out_path" "$override_non_versioned_files" + + validate_remote_local_file_sizes "$zip_path" "$remote_file_size" + + rm -rf "$temp_out_path" + if [ -z ${keep_zip+x} ]; then + rm -f "$zip_path" && say_verbose "Temporary archive file $zip_path was removed" + fi + + if [ "$failed" = true ]; then + say_err "Extraction failed" + return 1 + fi + return 0 +} + +# args: +# remote_path - $1 +# disable_feed_credential - $2 +get_http_header() +{ + eval $invocation + local remote_path="$1" + local disable_feed_credential="$2" + + local failed=false + local response + if machine_has "curl"; then + get_http_header_curl $remote_path $disable_feed_credential || failed=true + elif machine_has "wget"; then + get_http_header_wget $remote_path $disable_feed_credential || failed=true + else + failed=true + fi + if [ "$failed" = true ]; then + say_verbose "Failed to get HTTP header: '$remote_path'." + return 1 + fi + return 0 +} + +# args: +# remote_path - $1 +# disable_feed_credential - $2 +get_http_header_curl() { + eval $invocation + local remote_path="$1" + local disable_feed_credential="$2" + + remote_path_with_credential="$remote_path" + if [ "$disable_feed_credential" = false ]; then + remote_path_with_credential+="$feed_credential" + fi + + curl_options="-I -sSL --retry 5 --retry-delay 2 --connect-timeout 15 " + curl $curl_options "$remote_path_with_credential" 2>&1 || return 1 + return 0 +} + +# args: +# remote_path - $1 +# disable_feed_credential - $2 +get_http_header_wget() { + eval $invocation + local remote_path="$1" + local disable_feed_credential="$2" + local wget_options="-q -S --spider --tries 5 " + + local wget_options_extra='' + + # Test for options that aren't supported on all wget implementations. + if [[ $(wget -h 2>&1 | grep -E 'waitretry|connect-timeout') ]]; then + wget_options_extra="--waitretry 2 --connect-timeout 15 " + else + say "wget extra options are unavailable for this environment" + fi + + remote_path_with_credential="$remote_path" + if [ "$disable_feed_credential" = false ]; then + remote_path_with_credential+="$feed_credential" + fi + + wget $wget_options $wget_options_extra "$remote_path_with_credential" 2>&1 + + return $? +} + +# args: +# remote_path - $1 +# [out_path] - $2 - stdout if not provided +download() { + eval $invocation + + local remote_path="$1" + local out_path="${2:-}" + + if [[ "$remote_path" != "http"* ]]; then + cp "$remote_path" "$out_path" + return $? + fi + + local failed=false + local attempts=0 + while [ $attempts -lt 3 ]; do + attempts=$((attempts+1)) + failed=false + if machine_has "curl"; then + downloadcurl "$remote_path" "$out_path" || failed=true + elif machine_has "wget"; then + downloadwget "$remote_path" "$out_path" || failed=true + else + say_err "Missing dependency: neither curl nor wget was found." + exit 1 + fi + + if [ "$failed" = false ] || [ $attempts -ge 3 ] || { [ -n "${http_code-}" ] && [ "${http_code}" = "404" ]; }; then + break + fi + + say "Download attempt #$attempts has failed: ${http_code-} ${download_error_msg-}" + say "Attempt #$((attempts+1)) will start in $((attempts*10)) seconds." + sleep $((attempts*10)) + done + + if [ "$failed" = true ]; then + say_verbose "Download failed: $remote_path" + return 1 + fi + return 0 +} + +# Updates global variables $http_code and $download_error_msg +downloadcurl() { + eval $invocation + unset http_code + unset download_error_msg + local remote_path="$1" + local out_path="${2:-}" + # Append feed_credential as late as possible before calling curl to avoid logging feed_credential + # Avoid passing URI with credentials to functions: note, most of them echoing parameters of invocation in verbose output. + local remote_path_with_credential="${remote_path}${feed_credential}" + local curl_options="--retry 20 --retry-delay 2 --connect-timeout 15 -sSL -f --create-dirs " + local curl_exit_code=0; + if [ -z "$out_path" ]; then + curl_output=$(curl $curl_options "$remote_path_with_credential" 2>&1) + curl_exit_code=$? + echo "$curl_output" + else + curl_output=$(curl $curl_options -o "$out_path" "$remote_path_with_credential" 2>&1) + curl_exit_code=$? + fi + + # Regression in curl causes curl with --retry to return a 0 exit code even when it fails to download a file - https://github.com/curl/curl/issues/17554 + if [ $curl_exit_code -eq 0 ] && echo "$curl_output" | grep -q "^curl: ([0-9]*) "; then + curl_exit_code=$(echo "$curl_output" | sed 's/curl: (\([0-9]*\)).*/\1/') + fi + + if [ $curl_exit_code -gt 0 ]; then + download_error_msg="Unable to download $remote_path." + # Check for curl timeout codes + if [[ $curl_exit_code == 7 || $curl_exit_code == 28 ]]; then + download_error_msg+=" Failed to reach the server: connection timeout." + else + local disable_feed_credential=false + local response=$(get_http_header_curl $remote_path $disable_feed_credential) + http_code=$( echo "$response" | awk '/^HTTP/{print $2}' | tail -1 ) + if [[ ! -z $http_code && $http_code != 2* ]]; then + download_error_msg+=" Returned HTTP status code: $http_code." + fi + fi + say_verbose "$download_error_msg" + return 1 + fi + return 0 +} + + +# Updates global variables $http_code and $download_error_msg +downloadwget() { + eval $invocation + unset http_code + unset download_error_msg + local remote_path="$1" + local out_path="${2:-}" + # Append feed_credential as late as possible before calling wget to avoid logging feed_credential + local remote_path_with_credential="${remote_path}${feed_credential}" + local wget_options="--tries 20 " + + local wget_options_extra='' + local wget_result='' + + # Test for options that aren't supported on all wget implementations. + if [[ $(wget -h 2>&1 | grep -E 'waitretry|connect-timeout') ]]; then + wget_options_extra="--waitretry 2 --connect-timeout 15 " + else + say "wget extra options are unavailable for this environment" + fi + + if [ -z "$out_path" ]; then + wget -q $wget_options $wget_options_extra -O - "$remote_path_with_credential" 2>&1 + wget_result=$? + else + wget $wget_options $wget_options_extra -O "$out_path" "$remote_path_with_credential" 2>&1 + wget_result=$? + fi + + if [[ $wget_result != 0 ]]; then + local disable_feed_credential=false + local response=$(get_http_header_wget $remote_path $disable_feed_credential) + http_code=$( echo "$response" | awk '/^ HTTP/{print $2}' | tail -1 ) + download_error_msg="Unable to download $remote_path." + if [[ ! -z $http_code && $http_code != 2* ]]; then + download_error_msg+=" Returned HTTP status code: $http_code." + # wget exit code 4 stands for network-issue + elif [[ $wget_result == 4 ]]; then + download_error_msg+=" Failed to reach the server: connection timeout." + fi + say_verbose "$download_error_msg" + return 1 + fi + + return 0 +} + +get_download_link_from_aka_ms() { + eval $invocation + + #quality is not supported for LTS or STS channel + #STS maps to current + if [[ ! -z "$normalized_quality" && ("$normalized_channel" == "LTS" || "$normalized_channel" == "STS") ]]; then + normalized_quality="" + say_warning "Specifying quality for STS or LTS channel is not supported, the quality will be ignored." + fi + + say_verbose "Retrieving primary payload URL from aka.ms for channel: '$normalized_channel', quality: '$normalized_quality', product: '$normalized_product', os: '$normalized_os', architecture: '$normalized_architecture'." + + #construct aka.ms link + aka_ms_link="https://aka.ms/dotnet" + if [ "$internal" = true ]; then + aka_ms_link="$aka_ms_link/internal" + fi + aka_ms_link="$aka_ms_link/$normalized_channel" + if [[ ! -z "$normalized_quality" ]]; then + aka_ms_link="$aka_ms_link/$normalized_quality" + fi + aka_ms_link="$aka_ms_link/$normalized_product-$normalized_os-$normalized_architecture.tar.gz" + say_verbose "Constructed aka.ms link: '$aka_ms_link'." + + #get HTTP response + #do not pass credentials as a part of the $aka_ms_link and do not apply credentials in the get_http_header function + #otherwise the redirect link would have credentials as well + #it would result in applying credentials twice to the resulting link and thus breaking it, and in echoing credentials to the output as a part of redirect link + disable_feed_credential=true + response="$(get_http_header $aka_ms_link $disable_feed_credential)" + + say_verbose "Received response: $response" + # Get results of all the redirects. + http_codes=$( echo "$response" | awk '$1 ~ /^HTTP/ {print $2}' ) + # They all need to be 301, otherwise some links are broken (except for the last, which is not a redirect but 200 or 404). + broken_redirects=$( echo "$http_codes" | sed '$d' | grep -v '301' ) + # The response may end without final code 2xx/4xx/5xx somehow, e.g. network restrictions on www.bing.com causes redirecting to bing.com fails with connection refused. + # In this case it should not exclude the last. + last_http_code=$( echo "$http_codes" | tail -n 1 ) + if ! [[ $last_http_code =~ ^(2|4|5)[0-9][0-9]$ ]]; then + broken_redirects=$( echo "$http_codes" | grep -v '301' ) + fi + + # All HTTP codes are 301 (Moved Permanently), the redirect link exists. + if [[ -z "$broken_redirects" ]]; then + aka_ms_download_link=$( echo "$response" | awk '$1 ~ /^Location/{print $2}' | tail -1 | tr -d '\r') + + if [[ -z "$aka_ms_download_link" ]]; then + say_verbose "The aka.ms link '$aka_ms_link' is not valid: failed to get redirect location." + return 1 + fi + + say_verbose "The redirect location retrieved: '$aka_ms_download_link'." + return 0 + else + say_verbose "The aka.ms link '$aka_ms_link' is not valid: received HTTP code: $(echo "$broken_redirects" | paste -sd "," -)." + return 1 + fi +} + +get_feeds_to_use() +{ + feeds=( + "https://builds.dotnet.microsoft.com/dotnet" + "https://ci.dot.net/public" + ) + + if [[ -n "$azure_feed" ]]; then + feeds=("$azure_feed") + fi + + if [[ -n "$uncached_feed" ]]; then + feeds=("$uncached_feed") + fi +} + +# THIS FUNCTION MAY EXIT (if the determined version is already installed). +generate_download_links() { + + download_links=() + specific_versions=() + effective_versions=() + link_types=() + + # If generate_akams_links returns false, no fallback to old links. Just terminate. + # This function may also 'exit' (if the determined version is already installed). + generate_akams_links || return + + # Check other feeds only if we haven't been able to find an aka.ms link. + if [[ "${#download_links[@]}" -lt 1 ]]; then + for feed in ${feeds[@]} + do + # generate_regular_links may also 'exit' (if the determined version is already installed). + generate_regular_links $feed || return + done + fi + + if [[ "${#download_links[@]}" -eq 0 ]]; then + say_err "Failed to resolve the exact version number." + return 1 + fi + + say_verbose "Generated ${#download_links[@]} links." + for link_index in ${!download_links[@]} + do + say_verbose "Link $link_index: ${link_types[$link_index]}, ${effective_versions[$link_index]}, ${download_links[$link_index]}" + done +} + +# THIS FUNCTION MAY EXIT (if the determined version is already installed). +generate_akams_links() { + local valid_aka_ms_link=true; + + normalized_version="$(to_lowercase "$version")" + if [[ "$normalized_version" != "latest" ]] && [ -n "$normalized_quality" ]; then + say_err "Quality and Version options are not allowed to be specified simultaneously. See https://learn.microsoft.com/dotnet/core/tools/dotnet-install-script#options for details." + return 1 + fi + + if [[ -n "$json_file" || "$normalized_version" != "latest" ]]; then + # aka.ms links are not needed when exact version is specified via command or json file + return + fi + + get_download_link_from_aka_ms || valid_aka_ms_link=false + + if [[ "$valid_aka_ms_link" == true ]]; then + say_verbose "Retrieved primary payload URL from aka.ms link: '$aka_ms_download_link'." + say_verbose "Downloading using legacy url will not be attempted." + + download_link=$aka_ms_download_link + + #get version from the path + IFS='/' + read -ra pathElems <<< "$download_link" + count=${#pathElems[@]} + specific_version="${pathElems[count-2]}" + unset IFS; + say_verbose "Version: '$specific_version'." + + #Retrieve effective version + effective_version="$(get_specific_product_version "$azure_feed" "$specific_version" "$download_link")" + + # Add link info to arrays + download_links+=($download_link) + specific_versions+=($specific_version) + effective_versions+=($effective_version) + link_types+=("aka.ms") + + # Check if the SDK version is already installed. + if [[ "$dry_run" != true ]] && is_dotnet_package_installed "$install_root" "$asset_relative_path" "$effective_version"; then + say "$asset_name with version '$effective_version' is already installed." + exit 0 + fi + + return 0 + fi + + # if quality is specified - exit with error - there is no fallback approach + if [ ! -z "$normalized_quality" ]; then + say_err "Failed to locate the latest version in the channel '$normalized_channel' with '$normalized_quality' quality for '$normalized_product', os: '$normalized_os', architecture: '$normalized_architecture'." + say_err "Refer to: https://aka.ms/dotnet-os-lifecycle for information on .NET Core support." + return 1 + fi + say_verbose "Falling back to latest.version file approach." +} + +# THIS FUNCTION MAY EXIT (if the determined version is already installed) +# args: +# feed - $1 +generate_regular_links() { + local feed="$1" + local valid_legacy_download_link=true + + specific_version=$(get_specific_version_from_version "$feed" "$channel" "$normalized_architecture" "$version" "$json_file") || specific_version='0' + + if [[ "$specific_version" == '0' ]]; then + say_verbose "Failed to resolve the specific version number using feed '$feed'" + return + fi + + effective_version="$(get_specific_product_version "$feed" "$specific_version")" + say_verbose "specific_version=$specific_version" + + download_link="$(construct_download_link "$feed" "$channel" "$normalized_architecture" "$specific_version" "$normalized_os")" + say_verbose "Constructed primary named payload URL: $download_link" + + # Add link info to arrays + download_links+=($download_link) + specific_versions+=($specific_version) + effective_versions+=($effective_version) + link_types+=("primary") + + legacy_download_link="$(construct_legacy_download_link "$feed" "$channel" "$normalized_architecture" "$specific_version")" || valid_legacy_download_link=false + + if [ "$valid_legacy_download_link" = true ]; then + say_verbose "Constructed legacy named payload URL: $legacy_download_link" + + download_links+=($legacy_download_link) + specific_versions+=($specific_version) + effective_versions+=($effective_version) + link_types+=("legacy") + else + legacy_download_link="" + say_verbose "Could not construct a legacy_download_link; omitting..." + fi + + # Check if the SDK version is already installed. + if [[ "$dry_run" != true ]] && is_dotnet_package_installed "$install_root" "$asset_relative_path" "$effective_version"; then + say "$asset_name with version '$effective_version' is already installed." + exit 0 + fi +} + +print_dry_run() { + + say "Payload URLs:" + + for link_index in "${!download_links[@]}" + do + say "URL #$link_index - ${link_types[$link_index]}: ${download_links[$link_index]}" + done + + resolved_version=${specific_versions[0]} + repeatable_command="./$script_name --version "\""$resolved_version"\"" --install-dir "\""$install_root"\"" --architecture "\""$normalized_architecture"\"" --os "\""$normalized_os"\""" + + if [ ! -z "$normalized_quality" ]; then + repeatable_command+=" --quality "\""$normalized_quality"\""" + fi + + if [[ "$runtime" == "dotnet" ]]; then + repeatable_command+=" --runtime "\""dotnet"\""" + elif [[ "$runtime" == "aspnetcore" ]]; then + repeatable_command+=" --runtime "\""aspnetcore"\""" + fi + + repeatable_command+="$non_dynamic_parameters" + + if [ -n "$feed_credential" ]; then + repeatable_command+=" --feed-credential "\"""\""" + fi + + say "Repeatable invocation: $repeatable_command" +} + +calculate_vars() { + eval $invocation + + script_name=$(basename "$0") + normalized_architecture="$(get_normalized_architecture_from_architecture "$architecture")" + say_verbose "Normalized architecture: '$normalized_architecture'." + normalized_os="$(get_normalized_os "$user_defined_os")" + say_verbose "Normalized OS: '$normalized_os'." + normalized_quality="$(get_normalized_quality "$quality")" + say_verbose "Normalized quality: '$normalized_quality'." + normalized_channel="$(get_normalized_channel "$channel")" + say_verbose "Normalized channel: '$normalized_channel'." + normalized_product="$(get_normalized_product "$runtime")" + say_verbose "Normalized product: '$normalized_product'." + install_root="$(resolve_installation_path "$install_dir")" + say_verbose "InstallRoot: '$install_root'." + + normalized_architecture="$(get_normalized_architecture_for_specific_sdk_version "$version" "$normalized_channel" "$normalized_architecture")" + + if [[ "$runtime" == "dotnet" ]]; then + asset_relative_path="shared/Microsoft.NETCore.App" + asset_name=".NET Core Runtime" + elif [[ "$runtime" == "aspnetcore" ]]; then + asset_relative_path="shared/Microsoft.AspNetCore.App" + asset_name="ASP.NET Core Runtime" + elif [ -z "$runtime" ]; then + asset_relative_path="sdk" + asset_name=".NET Core SDK" + fi + + get_feeds_to_use +} + +install_dotnet() { + eval $invocation + local download_failed=false + local download_completed=false + local remote_file_size=0 + + mkdir -p "$install_root" + zip_path="${zip_path:-$(mktemp "$temporary_file_template")}" + say_verbose "Archive path: $zip_path" + + for link_index in "${!download_links[@]}" + do + download_link="${download_links[$link_index]}" + specific_version="${specific_versions[$link_index]}" + effective_version="${effective_versions[$link_index]}" + link_type="${link_types[$link_index]}" + + say "Attempting to download using $link_type link $download_link" + + # The download function will set variables $http_code and $download_error_msg in case of failure. + download_failed=false + download "$download_link" "$zip_path" 2>&1 || download_failed=true + + if [ "$download_failed" = true ]; then + case ${http_code-} in + 404) + say "The resource at $link_type link '$download_link' is not available." + ;; + *) + say "Failed to download $link_type link '$download_link': ${http_code-} ${download_error_msg-}" + ;; + esac + rm -f "$zip_path" 2>&1 && say_verbose "Temporary archive file $zip_path was removed" + else + download_completed=true + break + fi + done + + if [[ "$download_completed" == false ]]; then + say_err "Could not find \`$asset_name\` with version = $specific_version" + say_err "Refer to: https://aka.ms/dotnet-os-lifecycle for information on .NET Core support" + return 1 + fi + + remote_file_size="$(get_remote_file_size "$download_link")" + + say "Extracting archive from $download_link" + extract_dotnet_package "$zip_path" "$install_root" "$remote_file_size" || return 1 + + # Check if the SDK version is installed; if not, fail the installation. + # if the version contains "RTM" or "servicing"; check if a 'release-type' SDK version is installed. + if [[ $specific_version == *"rtm"* || $specific_version == *"servicing"* ]]; then + IFS='-' + read -ra verArr <<< "$specific_version" + release_version="${verArr[0]}" + unset IFS; + say_verbose "Checking installation: version = $release_version" + if is_dotnet_package_installed "$install_root" "$asset_relative_path" "$release_version"; then + say "Installed version is $effective_version" + return 0 + fi + fi + + # Check if the standard SDK version is installed. + say_verbose "Checking installation: version = $effective_version" + if is_dotnet_package_installed "$install_root" "$asset_relative_path" "$effective_version"; then + say "Installed version is $effective_version" + return 0 + fi + + # Version verification failed. More likely something is wrong either with the downloaded content or with the verification algorithm. + say_err "Failed to verify the version of installed \`$asset_name\`.\nInstallation source: $download_link.\nInstallation location: $install_root.\nReport the bug at https://github.com/dotnet/install-scripts/issues." + say_err "\`$asset_name\` with version = $effective_version failed to install with an error." + return 1 +} + +args=("$@") + +local_version_file_relative_path="/.version" +bin_folder_relative_path="" +temporary_file_template="${TMPDIR:-/tmp}/dotnet.XXXXXXXXX" + +channel="LTS" +version="Latest" +json_file="" +install_dir="" +architecture="" +dry_run=false +no_path=false +azure_feed="" +uncached_feed="" +feed_credential="" +verbose=false +runtime="" +runtime_id="" +quality="" +internal=false +override_non_versioned_files=true +non_dynamic_parameters="" +user_defined_os="" + +while [ $# -ne 0 ] +do + name="$1" + case "$name" in + -c|--channel|-[Cc]hannel) + shift + channel="$1" + ;; + -v|--version|-[Vv]ersion) + shift + version="$1" + ;; + -q|--quality|-[Qq]uality) + shift + quality="$1" + ;; + --internal|-[Ii]nternal) + internal=true + non_dynamic_parameters+=" $name" + ;; + -i|--install-dir|-[Ii]nstall[Dd]ir) + shift + install_dir="$1" + ;; + --arch|--architecture|-[Aa]rch|-[Aa]rchitecture) + shift + architecture="$1" + ;; + --os|-[Oo][SS]) + shift + user_defined_os="$1" + ;; + --shared-runtime|-[Ss]hared[Rr]untime) + say_warning "The --shared-runtime flag is obsolete and may be removed in a future version of this script. The recommended usage is to specify '--runtime dotnet'." + if [ -z "$runtime" ]; then + runtime="dotnet" + fi + ;; + --runtime|-[Rr]untime) + shift + runtime="$1" + if [[ "$runtime" != "dotnet" ]] && [[ "$runtime" != "aspnetcore" ]]; then + say_err "Unsupported value for --runtime: '$1'. Valid values are 'dotnet' and 'aspnetcore'." + if [[ "$runtime" == "windowsdesktop" ]]; then + say_err "WindowsDesktop archives are manufactured for Windows platforms only." + fi + exit 1 + fi + ;; + --dry-run|-[Dd]ry[Rr]un) + dry_run=true + ;; + --no-path|-[Nn]o[Pp]ath) + no_path=true + non_dynamic_parameters+=" $name" + ;; + --verbose|-[Vv]erbose) + verbose=true + non_dynamic_parameters+=" $name" + ;; + --azure-feed|-[Aa]zure[Ff]eed) + shift + azure_feed="$1" + non_dynamic_parameters+=" $name "\""$1"\""" + ;; + --uncached-feed|-[Uu]ncached[Ff]eed) + shift + uncached_feed="$1" + non_dynamic_parameters+=" $name "\""$1"\""" + ;; + --feed-credential|-[Ff]eed[Cc]redential) + shift + feed_credential="$1" + #feed_credential should start with "?", for it to be added to the end of the link. + #adding "?" at the beginning of the feed_credential if needed. + [[ -z "$(echo $feed_credential)" ]] || [[ $feed_credential == \?* ]] || feed_credential="?$feed_credential" + ;; + --runtime-id|-[Rr]untime[Ii]d) + shift + runtime_id="$1" + non_dynamic_parameters+=" $name "\""$1"\""" + say_warning "Use of --runtime-id is obsolete and should be limited to the versions below 2.1. To override architecture, use --architecture option instead. To override OS, use --os option instead." + ;; + --jsonfile|-[Jj][Ss]on[Ff]ile) + shift + json_file="$1" + ;; + --skip-non-versioned-files|-[Ss]kip[Nn]on[Vv]ersioned[Ff]iles) + override_non_versioned_files=false + non_dynamic_parameters+=" $name" + ;; + --keep-zip|-[Kk]eep[Zz]ip) + keep_zip=true + non_dynamic_parameters+=" $name" + ;; + --zip-path|-[Zz]ip[Pp]ath) + shift + zip_path="$1" + ;; + -?|--?|-h|--help|-[Hh]elp) + script_name="dotnet-install.sh" + echo ".NET Tools Installer" + echo "Usage:" + echo " # Install a .NET SDK of a given Quality from a given Channel" + echo " $script_name [-c|--channel ] [-q|--quality ]" + echo " # Install a .NET SDK of a specific public version" + echo " $script_name [-v|--version ]" + echo " $script_name -h|-?|--help" + echo "" + echo "$script_name is a simple command line interface for obtaining dotnet cli." + echo " Note that the intended use of this script is for Continuous Integration (CI) scenarios, where:" + echo " - The SDK needs to be installed without user interaction and without admin rights." + echo " - The SDK installation doesn't need to persist across multiple CI runs." + echo " To set up a development environment or to run apps, use installers rather than this script. Visit https://dotnet.microsoft.com/download to get the installer." + echo "" + echo "Options:" + echo " -c,--channel Download from the channel specified, Defaults to \`$channel\`." + echo " -Channel" + echo " Possible values:" + echo " - STS - the most recent Standard Term Support release" + echo " - LTS - the most recent Long Term Support release" + echo " - 2-part version in a format A.B - represents a specific release" + echo " examples: 2.0; 1.0" + echo " - 3-part version in a format A.B.Cxx - represents a specific SDK release" + echo " examples: 5.0.1xx, 5.0.2xx." + echo " Supported since 5.0 release" + echo " Warning: Value 'Current' is deprecated for the Channel parameter. Use 'STS' instead." + echo " Note: The version parameter overrides the channel parameter when any version other than 'latest' is used." + echo " -v,--version Use specific VERSION, Defaults to \`$version\`." + echo " -Version" + echo " Possible values:" + echo " - latest - the latest build on specific channel" + echo " - 3-part version in a format A.B.C - represents specific version of build" + echo " examples: 2.0.0-preview2-006120; 1.1.0" + echo " -q,--quality Download the latest build of specified quality in the channel." + echo " -Quality" + echo " The possible values are: daily, preview, GA." + echo " Works only in combination with channel. Not applicable for STS and LTS channels and will be ignored if those channels are used." + echo " For SDK use channel in A.B.Cxx format. Using quality for SDK together with channel in A.B format is not supported." + echo " Supported since 5.0 release." + echo " Note: The version parameter overrides the channel parameter when any version other than 'latest' is used, and therefore overrides the quality." + echo " --internal,-Internal Download internal builds. Requires providing credentials via --feed-credential parameter." + echo " --feed-credential Token to access Azure feed. Used as a query string to append to the Azure feed." + echo " -FeedCredential This parameter typically is not specified." + echo " -i,--install-dir Install under specified location (see Install Location below)" + echo " -InstallDir" + echo " --architecture Architecture of dotnet binaries to be installed, Defaults to \`$architecture\`." + echo " --arch,-Architecture,-Arch" + echo " Possible values: x64, arm, arm64, s390x, ppc64le and loongarch64" + echo " --os Specifies operating system to be used when selecting the installer." + echo " Overrides the OS determination approach used by the script. Supported values: osx, linux, linux-musl, freebsd, rhel.6." + echo " In case any other value is provided, the platform will be determined by the script based on machine configuration." + echo " Not supported for legacy links. Use --runtime-id to specify platform for legacy links." + echo " Refer to: https://aka.ms/dotnet-os-lifecycle for more information." + echo " --runtime Installs a shared runtime only, without the SDK." + echo " -Runtime" + echo " Possible values:" + echo " - dotnet - the Microsoft.NETCore.App shared runtime" + echo " - aspnetcore - the Microsoft.AspNetCore.App shared runtime" + echo " --dry-run,-DryRun Do not perform installation. Display download link." + echo " --no-path, -NoPath Do not set PATH for the current process." + echo " --verbose,-Verbose Display diagnostics information." + echo " --azure-feed,-AzureFeed For internal use only." + echo " Allows using a different storage to download SDK archives from." + echo " --uncached-feed,-UncachedFeed For internal use only." + echo " Allows using a different storage to download SDK archives from." + echo " --skip-non-versioned-files Skips non-versioned files if they already exist, such as the dotnet executable." + echo " -SkipNonVersionedFiles" + echo " --jsonfile Determines the SDK version from a user specified global.json file." + echo " Note: global.json must have a value for 'SDK:Version'" + echo " --keep-zip,-KeepZip If set, downloaded file is kept." + echo " --zip-path, -ZipPath If set, downloaded file is stored at the specified path." + echo " -?,--?,-h,--help,-Help Shows this help message" + echo "" + echo "Install Location:" + echo " Location is chosen in following order:" + echo " - --install-dir option" + echo " - Environmental variable DOTNET_INSTALL_DIR" + echo " - $HOME/.dotnet" + exit 0 + ;; + *) + say_err "Unknown argument \`$name\`" + exit 1 + ;; + esac + + shift +done + +say_verbose "Note that the intended use of this script is for Continuous Integration (CI) scenarios, where:" +say_verbose "- The SDK needs to be installed without user interaction and without admin rights." +say_verbose "- The SDK installation doesn't need to persist across multiple CI runs." +say_verbose "To set up a development environment or to run apps, use installers rather than this script. Visit https://dotnet.microsoft.com/download to get the installer.\n" + +if [ "$internal" = true ] && [ -z "$(echo $feed_credential)" ]; then + message="Provide credentials via --feed-credential parameter." + if [ "$dry_run" = true ]; then + say_warning "$message" + else + say_err "$message" + exit 1 + fi +fi + +check_min_reqs +calculate_vars +# generate_regular_links call below will 'exit' if the determined version is already installed. +generate_download_links + +if [[ "$dry_run" = true ]]; then + print_dry_run + exit 0 +fi + +install_dotnet + +bin_path="$(get_absolute_path "$(combine_paths "$install_root" "$bin_folder_relative_path")")" +if [ "$no_path" = false ]; then + say "Adding to current process PATH: \`$bin_path\`. Note: This change will be visible only when sourcing script." + export PATH="$bin_path":"$PATH" +else + say "Binaries of dotnet can be found in $bin_path" +fi + +say "Note that the script does not resolve dependencies during installation." +say "To check the list of dependencies, go to https://learn.microsoft.com/dotnet/core/install, select your operating system and check the \"Dependencies\" section." +say "Installation finished successfully." From bac6223e7e7b1066b04017036f04da35b8263540 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 8 Jul 2026 21:03:54 -0600 Subject: [PATCH 1731/1753] Restore missing VSInsertion artifact download task --- azure-pipelines/vs-insertion.yml | 3 +++ azure-pipelines/vs-validation.yml | 3 +++ 2 files changed, 6 insertions(+) diff --git a/azure-pipelines/vs-insertion.yml b/azure-pipelines/vs-insertion.yml index edb114c46..9f5743aec 100644 --- a/azure-pipelines/vs-insertion.yml +++ b/azure-pipelines/vs-insertion.yml @@ -69,6 +69,9 @@ extends: steps: - checkout: none - template: azure-pipelines/release-deployment-prep.yml@self + - download: CI + artifact: VSInsertion-Windows + displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index 3f2a194f6..cbfeb30b8 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -111,6 +111,9 @@ extends: displayName: 🔻 Download Variables-Windows artifact - powershell: $(Pipeline.Workspace)/Variables-Windows/_define.ps1 displayName: ⚙️ Set pipeline variables based on artifacts + - download: CI + artifact: VSInsertion-Windows + displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 displayName: 🏭 Insert VS Payload inputs: From 6b93b0dabf2f09033e865eef65c42f4b411cc02b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 9 Jul 2026 07:38:30 -0600 Subject: [PATCH 1732/1753] Update Microsoft Testing Platform to 2.3.1 (539) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ca1e17d7a..11bef2954 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.3.0 + 2.3.1 From 1573a0b176ab7b0e67df7f75843086abcc39cc49 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Jul 2026 07:43:58 -0600 Subject: [PATCH 1733/1753] Fix vs-validation pipeline's artifact download task --- azure-pipelines/vs-validation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml index cbfeb30b8..e7e4c9787 100644 --- a/azure-pipelines/vs-validation.yml +++ b/azure-pipelines/vs-validation.yml @@ -111,7 +111,7 @@ extends: displayName: 🔻 Download Variables-Windows artifact - powershell: $(Pipeline.Workspace)/Variables-Windows/_define.ps1 displayName: ⚙️ Set pipeline variables based on artifacts - - download: CI + - download: current artifact: VSInsertion-Windows displayName: 🔻 Download VSInsertion-Windows artifact - task: MicroBuildInsertVsPayload@5 From 7d23f03e236698092d4eedcc3a3ce6c0752fe47f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 9 Jul 2026 09:18:55 -0600 Subject: [PATCH 1734/1753] Remove obsolete `TaskCompletionSourceWithoutInlining` class This was originally created before .NET Framework offered the `RunContinuationsAsynchronously` flag. When support for the flag was added, but we still supported downlevel systems, we updated the class to use the flag when supported as a light-up, and keep our old implementation around for downlevel. Then later, we removed the downlevel implementation, but kept the class, which was now just forwarding everything to .NET in every case. So here, I remove the class and redirect all its users to the proper .NET types. --- .../AsyncAutoResetEvent.cs | 6 +- .../AsyncManualResetEvent.cs | 98 ++++--------------- .../AsyncQueue`1.cs | 4 +- .../JoinableTask.cs | 16 +-- .../JoinableTask`1.cs | 8 +- .../TaskCompletionSourceWithoutInlining`1.cs | 63 ------------ .../AsyncManualResetEventTests.cs | 81 +++++++++++++++ 7 files changed, 113 insertions(+), 163 deletions(-) delete mode 100644 src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs diff --git a/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs index cb4e2e095..aa0d5d6a8 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncAutoResetEvent.cs @@ -4,8 +4,6 @@ using System; using System.Collections.Generic; using System.Diagnostics; -using System.Linq; -using System.Text; using System.Threading; using System.Threading.Tasks; @@ -162,7 +160,7 @@ private void OnCancellationRequest(object state) /// /// Tracks someone waiting for a signal from the event. /// - private class WaiterCompletionSource : TaskCompletionSourceWithoutInlining + private class WaiterCompletionSource : TaskCompletionSource { /// /// Initializes a new instance of the class. @@ -171,7 +169,7 @@ private class WaiterCompletionSource : TaskCompletionSourceWithoutInlining to allow continuations to be inlined upon the completer's callstack. /// The cancellation token associated with the waiter. internal WaiterCompletionSource(AsyncAutoResetEvent owner, bool allowInliningContinuations, CancellationToken cancellationToken) - : base(allowInliningContinuations) + : base(allowInliningContinuations ? TaskCreationOptions.None : TaskCreationOptions.RunContinuationsAsynchronously) { this.CancellationToken = cancellationToken; this.Registration = cancellationToken.Register(NullableHelpers.AsNullableArgAction(owner.onCancellationRequestHandler), this); diff --git a/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs b/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs index 4bbab53a0..10f081c03 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncManualResetEvent.cs @@ -2,12 +2,9 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics; -using System.Linq; using System.Runtime.CompilerServices; -using System.Text; using System.Threading; using System.Threading.Tasks; @@ -20,9 +17,9 @@ namespace Microsoft.VisualStudio.Threading; public class AsyncManualResetEvent { /// - /// Whether the task completion source should allow executing continuations synchronously. + /// Options to use while creating the to return from . /// - private readonly bool allowInliningAwaiters; + private readonly TaskCreationOptions options; /// /// The object to lock when accessing fields. @@ -36,21 +33,7 @@ public class AsyncManualResetEvent /// This should not need the volatile modifier because it is /// always accessed within a lock. /// - private TaskCompletionSourceWithoutInlining taskCompletionSource; - - /// - /// A flag indicating whether the event is signaled. - /// When this is set to true, it's possible that - /// .Task.IsCompleted is still false - /// if the completion has been scheduled asynchronously. - /// Thus, this field should be the definitive answer as to whether - /// the event is signaled because it is synchronously updated. - /// - /// - /// This should not need the volatile modifier because it is - /// always accessed within a lock. - /// - private bool isSet; + private TaskCompletionSource taskCompletionSource; /// /// Initializes a new instance of the class. @@ -58,17 +41,14 @@ public class AsyncManualResetEvent /// A value indicating whether the event should be initially signaled. /// /// A value indicating whether to allow callers' continuations to execute - /// on the thread that calls before the call returns. - /// callers should not hold private locks if this value is to avoid deadlocks. - /// When , the task returned from may not have fully transitioned to - /// its completed state by the time returns to its caller. + /// on the thread that calls before the call returns. + /// callers should not hold private locks if this value is to avoid deadlocks. /// public AsyncManualResetEvent(bool initialState = false, bool allowInliningAwaiters = false) { - this.allowInliningAwaiters = allowInliningAwaiters; + this.options = allowInliningAwaiters ? TaskCreationOptions.None : TaskCreationOptions.RunContinuationsAsynchronously; - this.taskCompletionSource = this.CreateTaskSource(); - this.isSet = initialState; + this.taskCompletionSource = new(this.options); if (initialState) { this.taskCompletionSource.SetResult(EmptyStruct.Instance); @@ -84,7 +64,7 @@ public bool IsSet { lock (this.syncObject) { - return this.isSet; + return this.taskCompletionSource.Task.IsCompleted; } } } @@ -112,40 +92,21 @@ public Task WaitAsync() /// /// A task that completes when the signal has been set. /// - /// - /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). - /// The returned task completes when the signal has definitely been set. - /// - /// - /// On .NET 4.6 and later: /// This method is not asynchronous. The returned Task is always completed. - /// /// [Obsolete("Use Set() instead."), EditorBrowsable(EditorBrowsableState.Never)] public Task SetAsync() { - TaskCompletionSourceWithoutInlining? tcs = null; - bool transitionRequired = false; + TaskCompletionSource? tcs = null; lock (this.syncObject) { - transitionRequired = !this.isSet; tcs = this.taskCompletionSource; - this.isSet = true; } - // Snap the Task that is exposed to the outside so we return that one. - // Once we complete the TaskCompletionSourceWithoutInlinining's task, - // the Task property will return the inner Task. - // SetAsync should return the same Task that WaitAsync callers would have observed previously. - Task result = tcs.Task; - - if (transitionRequired) - { - tcs.TrySetResult(default(EmptyStruct)); - } + tcs.TrySetResult(default); - return result; + // SetAsync should return the same Task that WaitAsync callers would have observed previously. + return tcs.Task; } /// @@ -165,10 +126,9 @@ public void Reset() { lock (this.syncObject) { - if (this.isSet) + if (this.taskCompletionSource.Task.IsCompleted) { - this.taskCompletionSource = this.CreateTaskSource(); - this.isSet = false; + this.taskCompletionSource = new(this.options); } } } @@ -178,20 +138,12 @@ public void Reset() /// /// A task that completes when the signal has been set. /// - /// - /// On .NET versions prior to 4.6: - /// This method may return before the signal set has propagated (so may return for a bit more if called immediately). - /// The returned task completes when the signal has definitely been set. - /// - /// - /// On .NET 4.6 and later: /// This method is not asynchronous. The returned Task is always completed. - /// /// [Obsolete("Use PulseAll() instead."), EditorBrowsable(EditorBrowsableState.Never)] public Task PulseAllAsync() { - TaskCompletionSourceWithoutInlining? tcs = null; + TaskCompletionSource? tcs = null; lock (this.syncObject) { // Atomically replace the completion source with a new, uncompleted source @@ -200,17 +152,13 @@ public Task PulseAllAsync() // continue to return completed Tasks due to a Pulse method which should // execute instantaneously. tcs = this.taskCompletionSource; - this.taskCompletionSource = this.CreateTaskSource(); - this.isSet = false; + this.taskCompletionSource = new(this.options); } - // Snap the Task that is exposed to the outside so we return that one. - // Once we complete the TaskCompletionSourceWithoutInlinining's task, - // the Task property will return the inner Task. + tcs.TrySetResult(default); + // PulseAllAsync should return the same Task that WaitAsync callers would have observed previously. - Task result = tcs.Task; - tcs.TrySetResult(default(EmptyStruct)); - return result; + return tcs.Task; } /// @@ -231,12 +179,4 @@ public TaskAwaiter GetAwaiter() { return this.WaitAsync().GetAwaiter(); } - - /// - /// Creates a new TaskCompletionSource to represent an unset event. - /// - private TaskCompletionSourceWithoutInlining CreateTaskSource() - { - return new TaskCompletionSourceWithoutInlining(this.allowInliningAwaiters); - } } diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs index 10c7624ba..61affeb04 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs @@ -5,8 +5,6 @@ using System.Collections.Generic; using System.Diagnostics; using System.Diagnostics.CodeAnalysis; -using System.Linq; -using System.Text; using System.Threading; using System.Threading.Tasks; @@ -298,7 +296,7 @@ public T Peek() this.FreeCanceledDequeuers(); } - var waiterTcs = new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); + var waiterTcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); waiterTcs.AttachCancellation(cancellationToken, this); this.dequeuingWaiters.Enqueue(waiterTcs); return waiterTcs.Task; diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs index 2cb35d17c..2cf498fdc 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask.cs @@ -867,28 +867,28 @@ internal void Post(SendOrPostCallback d, object? state, bool mainThreadAffinitiz } /// - /// Instantiate a that can track the ultimate result of . + /// Instantiate a that can track the ultimate result of . /// /// The new task completion source. /// /// The implementation should be sure to instantiate a that will /// NOT inline continuations, since we'll be completing this ourselves, potentially while holding a private lock. /// - internal virtual object CreateTaskCompletionSource() => new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); + internal virtual object CreateTaskCompletionSource() => new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); /// - /// Retrieves the from a . + /// Retrieves the from a . /// /// The task completion source. - /// The that will complete with this . - internal virtual Task GetTaskFromCompletionSource(object taskCompletionSource) => ((TaskCompletionSourceWithoutInlining)taskCompletionSource).Task; + /// The that will complete with this . + internal virtual Task GetTaskFromCompletionSource(object taskCompletionSource) => ((TaskCompletionSource)taskCompletionSource).Task; /// - /// Completes a . + /// Completes a . /// /// The task to read a result from. - /// The created earlier with to apply the result to. - internal virtual void CompleteTaskSourceFromWrappedTask(Task wrappedTask, object taskCompletionSource) => wrappedTask.ApplyResultTo((TaskCompletionSourceWithoutInlining)taskCompletionSource); + /// The created earlier with to apply the result to. + internal virtual void CompleteTaskSourceFromWrappedTask(Task wrappedTask, object taskCompletionSource) => wrappedTask.ApplyResultTo((TaskCompletionSource)taskCompletionSource); internal void SetWrappedTask(Task wrappedTask) { diff --git a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs index c367d5752..9affc39a1 100644 --- a/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs +++ b/src/Microsoft.VisualStudio.Threading/JoinableTask`1.cs @@ -2,12 +2,8 @@ // Licensed under the MIT license. See LICENSE file in the project root for full license information. using System; -using System.Collections.Generic; using System.Diagnostics; -using System.Linq; -using System.Reflection; using System.Runtime.CompilerServices; -using System.Text; using System.Threading; using System.Threading.Tasks; @@ -135,10 +131,10 @@ static async Task JoinSlowAsync(JoinableTask me, bool continueOnCapturedCo } /// - internal override object CreateTaskCompletionSource() => new TaskCompletionSourceWithoutInlining(allowInliningContinuations: false); + internal override object CreateTaskCompletionSource() => new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); /// - internal override Task GetTaskFromCompletionSource(object taskCompletionSource) => ((TaskCompletionSourceWithoutInlining)taskCompletionSource).Task; + internal override Task GetTaskFromCompletionSource(object taskCompletionSource) => ((TaskCompletionSource)taskCompletionSource).Task; /// internal override void CompleteTaskSourceFromWrappedTask(Task wrappedTask, object taskCompletionSource) => ((Task)wrappedTask).ApplyResultTo((TaskCompletionSource)taskCompletionSource); diff --git a/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs b/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs deleted file mode 100644 index 5e5002ce2..000000000 --- a/src/Microsoft.VisualStudio.Threading/TaskCompletionSourceWithoutInlining`1.cs +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using System; -using System.Diagnostics.CodeAnalysis; -using System.Threading; -using System.Threading.Tasks; - -namespace Microsoft.VisualStudio.Threading; - -/// -/// A -derivative that -/// does not inline continuations if so configured. -/// -/// The type of the task's resulting value. -internal class TaskCompletionSourceWithoutInlining : TaskCompletionSource -{ - /// - /// The Task that we expose to others that may not inline continuations. - /// - private readonly Task exposedTask; - - /// - /// Initializes a new instance of the class. - /// - /// - /// to allow continuations to be inlined; otherwise . - /// - /// - /// TaskCreationOptions to pass on to the base constructor. - /// - /// The state to set on the Task. - internal TaskCompletionSourceWithoutInlining(bool allowInliningContinuations, TaskCreationOptions options = TaskCreationOptions.None, object? state = null) - : base(state, AdjustFlags(options, allowInliningContinuations)) - { - this.exposedTask = base.Task; - } - - /// - /// Gets the that may never complete inline with completion of this . - /// - /// - /// Return the base.Task if it is already completed since inlining continuations - /// on the completer is no longer a concern. Also, when we are not inlining continuations, - /// this.exposedTask completes slightly later than base.Task, and callers expect - /// the Task we return to be complete as soon as they call TrySetResult. - /// - internal new Task Task => base.Task.IsCompleted ? base.Task : this.exposedTask; - - /// - /// Modifies the specified flags to include RunContinuationsAsynchronously - /// if wanted by the caller and supported by the platform. - /// - /// The base options supplied by the caller. - /// to allow inlining continuations. - /// The possibly modified flags. - private static TaskCreationOptions AdjustFlags(TaskCreationOptions options, bool allowInliningContinuations) - { - return allowInliningContinuations - ? (options & ~TaskCreationOptions.RunContinuationsAsynchronously) - : (options | TaskCreationOptions.RunContinuationsAsynchronously); - } -} diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs index 556bc7c20..beaf94e5b 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncManualResetEventTests.cs @@ -59,6 +59,87 @@ public void SetReturnsBeforeInlinedContinuations() Assert.True(inlinedContinuation.Wait(UnexpectedTimeout)); } + /// + /// Verifies that inlining continuations do not delay the Task returned from SetAsync() from completing. + /// + [Fact] + public void SetAsyncReturnsCompletedTaskBeforeNonInlinedContinuationsComplete() + { + ManualResetEventSlim setReturned = new(); + Task? inlinedContinuation = this.evt.WaitAsync() + .ContinueWith( + delegate + { + // Arrange to synchronously block the continuation until released, + // which would deadlock if SetAsync's Task does not complete until inlined continuations complete. + Assert.True(setReturned.Wait(UnexpectedTimeout)); + }, + TaskContinuationOptions.ExecuteSynchronously); +#pragma warning disable CS0618 // Type or member is obsolete + Task setTask = this.evt.SetAsync(); +#pragma warning restore CS0618 // Type or member is obsolete + Assert.True(setTask.IsCompleted); + Assert.True(this.evt.IsSet); + + // Release the continuation so the test doesn't leak a thread. + setReturned.Set(); + + Assert.True(inlinedContinuation.Wait(UnexpectedTimeout)); + } + + /// + /// Verifies that inlining continuations do not delay the Task returned from SetAsync() from completing. + /// + [Fact] + public void SetAsyncAndWaitAsyncReturnsCompletedTaskBeforeInlinedContinuationsComplete() + { + // Reconfigure the object to allow inlining awaiters. + this.evt = new(allowInliningAwaiters: true); + + // Arrange for an awaiter that is not only inlined, but synchronously blocks + // its caller, such that the SetAsync method that completes the Task cannot immediately return. + ManualResetEventSlim continuationStarted = new(); + ManualResetEventSlim setReturned = new(); + Task? inlinedContinuation = this.evt.WaitAsync() + .ContinueWith( + delegate + { + continuationStarted.Set(); + + // Arrange to synchronously block the continuation until released, + // which would deadlock if SetAsync's Task does not complete until inlined continuations complete. + Assert.True(setReturned.Wait(UnexpectedTimeout)); + }, + TaskContinuationOptions.ExecuteSynchronously); + +#pragma warning disable CS0618 // Type or member is obsolete + // First, spin off a thread to call SetAsync. This will be blocked. + Task.Run(() => this.evt.SetAsync(), TestContext.Current.CancellationToken); + + // Now wait for the continuation to start, to verify that SetAsync has done its work, + // even if it can't return to us. + Assert.True(continuationStarted.Wait(UnexpectedTimeout)); + + // Verify that the event is set, even though SetAsync has not yet returned. + Assert.True(this.evt.IsSet); + + // Now call SetAsync again. This time it should return immediately + // even though the first call hasn't yet, and it should return a completed Task. + Task setTask = this.evt.SetAsync(); +#pragma warning restore CS0618 // Type or member is obsolete + + Assert.True(setTask.IsCompleted); + + // Also verify that WaitAsync returns a completed Task, even though the first SetAsync call hasn't yet returned. + Assert.True(this.evt.WaitAsync().IsCompleted); + + // Release the continuation so the test doesn't leak a thread. + setReturned.Set(); + + // Verify that the inlined continuation has completed and didn't throw. + Assert.True(inlinedContinuation.Wait(UnexpectedTimeout)); + } + [Fact] public async Task Blocking() { From c98e75f8d6ab8eae749ff67d844d11b6d8bc1cde Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 10 Jul 2026 07:43:10 -0600 Subject: [PATCH 1735/1753] Reapply update to dotnet-coverage 18.9.0 (536) --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 2ddce27dc..9484456cc 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -10,7 +10,7 @@ "rollForward": false }, "dotnet-coverage": { - "version": "18.8.0", + "version": "18.9.0", "commands": [ "dotnet-coverage" ], From 327eaa2959ff41f3d16a6e391f5f583f6d9154f9 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sat, 11 Jul 2026 11:27:41 -0600 Subject: [PATCH 1736/1753] Move AI files to a more generic place This allows other AI providers (e.g. Grok Build) to find the AI instruction and skill files. --- {.github => .agents}/skills/bundle-dependency-prs/SKILL.md | 0 {.github => .agents}/skills/update-library-template/SKILL.md | 0 .../skills/update-library-template/template-release-notes.md | 0 .github/copilot-instructions.md => AGENTS.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename {.github => .agents}/skills/bundle-dependency-prs/SKILL.md (100%) rename {.github => .agents}/skills/update-library-template/SKILL.md (100%) rename {.github => .agents}/skills/update-library-template/template-release-notes.md (100%) rename .github/copilot-instructions.md => AGENTS.md (100%) diff --git a/.github/skills/bundle-dependency-prs/SKILL.md b/.agents/skills/bundle-dependency-prs/SKILL.md similarity index 100% rename from .github/skills/bundle-dependency-prs/SKILL.md rename to .agents/skills/bundle-dependency-prs/SKILL.md diff --git a/.github/skills/update-library-template/SKILL.md b/.agents/skills/update-library-template/SKILL.md similarity index 100% rename from .github/skills/update-library-template/SKILL.md rename to .agents/skills/update-library-template/SKILL.md diff --git a/.github/skills/update-library-template/template-release-notes.md b/.agents/skills/update-library-template/template-release-notes.md similarity index 100% rename from .github/skills/update-library-template/template-release-notes.md rename to .agents/skills/update-library-template/template-release-notes.md diff --git a/.github/copilot-instructions.md b/AGENTS.md similarity index 100% rename from .github/copilot-instructions.md rename to AGENTS.md From 1adc880ec6a0856656d36c2a44e7bbdd81b0b26a Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 13 Jul 2026 19:06:36 +0000 Subject: [PATCH 1737/1753] Update Microsoft Testing Platform to 2.3.2 (#541) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 11bef2954..6280399de 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.3.1 + 2.3.2 From c3b5b129e071551fb8f8dd06da6cb5213ab37d0d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 14 Jul 2026 22:41:05 +0000 Subject: [PATCH 1738/1753] Bump .NET SDK to v10.0.302 (#542) * Update mcr.microsoft.com/dotnet/sdk Docker tag to v10.0.302 * Bump to .NET SDK 10.0.302 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andrew Arnott --- .devcontainer/Dockerfile | 2 +- global.json | 2 +- tools/dotnet-install.sh | 0 3 files changed, 2 insertions(+), 2 deletions(-) mode change 100644 => 100755 tools/dotnet-install.sh diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 635ed8c6e..f18d31b16 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions -FROM mcr.microsoft.com/dotnet/sdk:10.0.301@sha256:ea8bde36c11b6e7eec2656d0e59101d4462f6bd630730f2c8201ed0572b295d5 +FROM mcr.microsoft.com/dotnet/sdk:10.0.302@sha256:ed034a8bf0b24ded0cbbac07e17825d8e9ebfe21e308191d0f7421eaf5ad4664 # Installing mono makes `dotnet test` work without errors even for net472. # But installing it takes a long time, so it's excluded by default. diff --git a/global.json b/global.json index 4c9fb87c8..dba80e90b 100644 --- a/global.json +++ b/global.json @@ -1,6 +1,6 @@ { "sdk": { - "version": "10.0.301", + "version": "10.0.302", "rollForward": "patch", "allowPrerelease": false }, diff --git a/tools/dotnet-install.sh b/tools/dotnet-install.sh old mode 100644 new mode 100755 From a35aefc04f4080bf094dcb9efc092754d3940735 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 15:51:41 +0000 Subject: [PATCH 1739/1753] Update dependency Microsoft.Windows.CsWin32 to 0.3.298 (#1603) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index ac02a6011..bbe78054e 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -30,7 +30,7 @@ - + From 86f25f025e3a1d4a58424a5bd2ac29487a668082 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jul 2026 10:14:06 -0600 Subject: [PATCH 1740/1753] Remodel how analyzer dependencies are managed This updates some dependencies, but more importantly it adopts the pattern in the vs-mef repo for how analyzer dependencies are expressed so that they don't accidentally get updated with other dependencies. --- .github/renovate.json | 2 +- Directory.Build.targets | 2 ++ Directory.Packages.Analyzers.props | 15 +++++++++++++++ Directory.Packages.props | 10 ++-------- .../FixUtils.cs | 3 +-- .../VSTHRD200UseAsyncNamingConventionCodeFix.cs | 2 +- 6 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 Directory.Packages.Analyzers.props diff --git a/.github/renovate.json b/.github/renovate.json index b5dfac106..d5154a48d 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -8,7 +8,7 @@ ], "packageRules": [ { - "matchJsonata": ["sharedVariableName='CodeAnalysisVersion'"], + "matchFileNames": ["Directory.Packages.Analyzers.props"], "enabled": false } ], diff --git a/Directory.Build.targets b/Directory.Build.targets index dbcb085dc..70909045c 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -5,5 +5,7 @@ + + diff --git a/Directory.Packages.Analyzers.props b/Directory.Packages.Analyzers.props new file mode 100644 index 000000000..dd6773138 --- /dev/null +++ b/Directory.Packages.Analyzers.props @@ -0,0 +1,15 @@ + + + 4.14.0 + + + + + + + + + + + + diff --git a/Directory.Packages.props b/Directory.Packages.props index ac02a6011..1e906dc48 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -6,9 +6,8 @@ true 2.3.0 2.0.226 - 3.11.0 + 5.6.0 1.1.4 - 3.11.0-beta1.26226.5 @@ -41,11 +40,6 @@ - - - - @@ -56,7 +50,7 @@ - + diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs index 9639738b9..164e28dbd 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs @@ -160,9 +160,8 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous Solution? solution = await Renamer.RenameSymbolAsync( document.Project.Solution, methodSymbol, - ////new SymbolRenameOptions { RenameInComments = true }, // Required by later compiler version + default, newName, - document.Project.Solution.Workspace.Options, cancellationToken).ConfigureAwait(false); document = solution.GetDocumentOrThrow(document.Id); semanticModel = null; diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index fe17ac2fb..a442aa527 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -70,8 +70,8 @@ public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic, string Solution? updatedSolution = await Renamer.RenameSymbolAsync( solution, methodSymbol, + default, this.newName, - solution.Workspace.Options, cancellationToken).ConfigureAwait(false); return updatedSolution; From a71fbbbb279cb949ed9de839b5ecd3742fa93212 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jul 2026 10:47:24 -0600 Subject: [PATCH 1741/1753] Retarget analyzers to .NET 8 SDK --- Directory.Packages.Analyzers.props | 16 +++++++++++----- .../FixUtils.cs | 2 +- .../VSTHRD200UseAsyncNamingConventionCodeFix.cs | 2 +- test/Directory.Packages.props | 9 +-------- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/Directory.Packages.Analyzers.props b/Directory.Packages.Analyzers.props index dd6773138..a5770f019 100644 --- a/Directory.Packages.Analyzers.props +++ b/Directory.Packages.Analyzers.props @@ -1,15 +1,21 @@ + - 4.14.0 + 4.11.0 - + + - - - + + + + + + + diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs index 164e28dbd..b408e9ede 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/FixUtils.cs @@ -160,7 +160,7 @@ internal static AnonymousFunctionExpressionSyntax MakeMethodAsync(this Anonymous Solution? solution = await Renamer.RenameSymbolAsync( document.Project.Solution, methodSymbol, - default, + default(SymbolRenameOptions), newName, cancellationToken).ConfigureAwait(false); document = solution.GetDocumentOrThrow(document.Id); diff --git a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs index a442aa527..e42db7232 100644 --- a/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs +++ b/src/Microsoft.VisualStudio.Threading.Analyzers.CodeFixes/VSTHRD200UseAsyncNamingConventionCodeFix.cs @@ -70,7 +70,7 @@ public AddAsyncSuffixCodeAction(Document document, Diagnostic diagnostic, string Solution? updatedSolution = await Renamer.RenameSymbolAsync( solution, methodSymbol, - default, + default(SymbolRenameOptions), this.newName, cancellationToken).ConfigureAwait(false); diff --git a/test/Directory.Packages.props b/test/Directory.Packages.props index 11d31c355..c79fbe79b 100644 --- a/test/Directory.Packages.props +++ b/test/Directory.Packages.props @@ -2,14 +2,7 @@ - - 5.3.0 - - - - - - + From 3e3dd7d043a75844089fd2e311bad34b3355c22e Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 18:26:41 +0000 Subject: [PATCH 1742/1753] Update .NET packages to 4.0.732401 --- Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 73902b17e..7ce3f83a3 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -22,8 +22,8 @@ - - + + From c6422b75a55e8995e55627f048fe417271235861 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 15 Jul 2026 12:49:54 -0600 Subject: [PATCH 1743/1753] Update dependency Microsoft.CodeAnalysis.Analyzers to 5.6.0 --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6cb8fee3c..c388c5d6f 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -14,7 +14,7 @@ - + From ce33bc6811c353a24a5a2d9acd10a863fc8f7f62 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 20 Jul 2026 19:15:38 -0600 Subject: [PATCH 1744/1753] Update actions/checkout action to v7.0.1 (543) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .github/workflows/build.yml | 4 ++-- .github/workflows/copilot-setup-steps.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/libtemplate-update.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 94a48d768..3caef3765 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,7 +28,7 @@ jobs: - windows-2025 steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites @@ -75,7 +75,7 @@ jobs: name: 📃 Docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0 with: diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index c0436e855..71adf9e73 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -26,7 +26,7 @@ jobs: # You can define any steps you want, and they will run before the agent starts. # If you do not check out your code, Copilot will do this for you. steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9729dc34b..c5a2fef4c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites diff --git a/.github/workflows/libtemplate-update.yml b/.github/workflows/libtemplate-update.yml index dfd3f578b..af1a9eef8 100644 --- a/.github/workflows/libtemplate-update.yml +++ b/.github/workflows/libtemplate-update.yml @@ -17,7 +17,7 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. From bf268cb04393c5b92ff2f66d7cf63009b8231a1b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 01:22:55 +0000 Subject: [PATCH 1745/1753] Update dependency powershell to v7.6.4 (544) * Update actions/checkout action to v7.0.1 (#543) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update dependency powershell to v7.6.4 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 30cea5a75..56c4ec6e7 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "powershell": { - "version": "7.6.3", + "version": "7.6.4", "commands": [ "pwsh" ], From 2b55315a6795ed98954bbace04118df4f1537691 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 21 Jul 2026 14:26:54 -0600 Subject: [PATCH 1746/1753] Update dependency dotnet-symbol to v10.0.737001 --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 30cea5a75..ac392d05d 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -38,7 +38,7 @@ "rollForward": false }, "dotnet-symbol": { - "version": "9.0.661903", + "version": "10.0.737001", "commands": [ "dotnet-symbol" ], From e3787d5a4f04fdc9a420a678e16a71c2ec665766 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 22 Jul 2026 20:56:38 -0600 Subject: [PATCH 1747/1753] Downgrade dotnet-symbol back to 9.0.661903 This is the latest available from `msft_consumption_public`. --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 1a1af61e2..56c4ec6e7 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -38,7 +38,7 @@ "rollForward": false }, "dotnet-symbol": { - "version": "10.0.737001", + "version": "9.0.661903", "commands": [ "dotnet-symbol" ], From fa8b3ed472d8a339d9ab822323dfc116c990952f Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Fri, 24 Jul 2026 17:02:43 -0600 Subject: [PATCH 1748/1753] Avoid duplicate test dump artifacts Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- tools/artifacts/testResults.ps1 | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/tools/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 index a841967e8..b988010f4 100644 --- a/tools/artifacts/testResults.ps1 +++ b/tools/artifacts/testResults.ps1 @@ -6,12 +6,19 @@ $result = @{} $RepoRoot = Resolve-Path "$PSScriptRoot\..\.." $testRoot = Join-Path $RepoRoot test -$result[$testRoot] = (Get-ChildItem "$testRoot\TestResults" -Recurse -Directory | Get-ChildItem -Recurse -File) +$legacyTestResults = Join-Path $testRoot TestResults +if (Test-Path $legacyTestResults) { + $result[$testRoot] = Get-ChildItem $legacyTestResults -Recurse -Directory | + Get-ChildItem -Recurse -File | + Where-Object { $_.Extension -ne '.dmp' -or $_.FullName -match '\\In\\' } +} $artifactStaging = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" $testlogsPath = Join-Path $artifactStaging "test_logs" if (Test-Path $testlogsPath) { - $result[$testlogsPath] = Get-ChildItem $testlogsPath -Recurse; + # Hang and crash dumps are copied into the TRX attachment directory. + $result[$testlogsPath] = Get-ChildItem $testlogsPath -Recurse | + Where-Object { $_.Extension -ne '.dmp' -or $_.FullName -match '\\In\\' } } $result From 6dc5571c909006fe3be4e22341630249dd4856e0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Sun, 26 Jul 2026 18:34:21 -0600 Subject: [PATCH 1749/1753] Apply `-NoNuGetCredProvider` consistently This will avoid github API rate throttling for OSS repos that use nuget.org as their package feed. --- .github/workflows/build.yml | 2 +- .github/workflows/docs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3caef3765..3e7e2f0ba 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -33,7 +33,7 @@ jobs: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites run: | - ./init.ps1 -UpgradePrerequisites + ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider dotnet --info # Print mono version if it is present. diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c5a2fef4c..c462a0898 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,7 +28,7 @@ jobs: with: fetch-depth: 0 # avoid shallow clone so nbgv can do its work. - name: ⚙ Install prerequisites - run: ./init.ps1 -UpgradePrerequisites + run: ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider - run: dotnet docfx docfx/docfx.json name: 📚 Generate documentation From 77c904f800010dfd5fb0e5600784116a365cccb5 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 28 Jul 2026 11:30:45 -0600 Subject: [PATCH 1750/1753] Update Microsoft Testing Platform to 2.3.3 (545) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- Directory.Packages.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Packages.props b/Directory.Packages.props index 6280399de..d026d2e89 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -4,7 +4,7 @@ true true - 2.3.2 + 2.3.3 From abe5a3b63cdc254023208161484f94f4edb723f3 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Wed, 29 Jul 2026 10:56:17 -0700 Subject: [PATCH 1751/1753] Fix non-Windows path matching --- tools/artifacts/testResults.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/artifacts/testResults.ps1 b/tools/artifacts/testResults.ps1 index b988010f4..1817ca09f 100644 --- a/tools/artifacts/testResults.ps1 +++ b/tools/artifacts/testResults.ps1 @@ -10,7 +10,7 @@ $legacyTestResults = Join-Path $testRoot TestResults if (Test-Path $legacyTestResults) { $result[$testRoot] = Get-ChildItem $legacyTestResults -Recurse -Directory | Get-ChildItem -Recurse -File | - Where-Object { $_.Extension -ne '.dmp' -or $_.FullName -match '\\In\\' } + Where-Object { $_.Extension -ne '.dmp' -or $_.FullName -match '[/\\]In[/\\]' } } $artifactStaging = & "$PSScriptRoot/../Get-ArtifactsStagingDirectory.ps1" @@ -18,7 +18,7 @@ $testlogsPath = Join-Path $artifactStaging "test_logs" if (Test-Path $testlogsPath) { # Hang and crash dumps are copied into the TRX attachment directory. $result[$testlogsPath] = Get-ChildItem $testlogsPath -Recurse | - Where-Object { $_.Extension -ne '.dmp' -or $_.FullName -match '\\In\\' } + Where-Object { $_.Extension -ne '.dmp' -or $_.FullName -match '[/\\]In[/\\]' } } $result From 4c53e3408b7cdf29a5a63544c48d9ccfd43d033f Mon Sep 17 00:00:00 2001 From: Lifeng Lu Date: Wed, 29 Jul 2026 14:31:46 -0700 Subject: [PATCH 1752/1753] Add fork detection for upgradeable read lock context (#1594) Add a virtual method OnLockForkDetected() that is called when a nested read lock request is detected from a forked execution context of an upgradeable read lock holder. This parallels the existing write lock fork check in TryIssueLock (line 1110-1113) but is non-breaking: instead of throwing, it calls a virtual method that consumers can override for telemetry/diagnostics. The fork is detected when: - A read lock is requested (!previouslyQueued, first request only) - The nesting chain contains an active upgradeable read lock - The calling thread is MTA (CanCurrentThreadHoldActiveLock) - The calling thread lacks NonConcurrentSynchronizationContext The virtual method is called outside syncObject to avoid reentrancy concerns. This addresses the root cause of Watson crash bug #1761459 in CPS, where IsLockSupportingContext can flip between IsCompleted and OnCompleted when a nesting UR lock is released by another thread. The detection enables CPS (and other consumers) to identify and diagnose fork scenarios via telemetry. Co-authored-by: Lifeng Lu Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../AsyncReaderWriterLock.cs | 39 ++++++++++ .../AsyncReaderWriterLockTests.cs | 76 +++++++++++++++++++ 2 files changed, 115 insertions(+) diff --git a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs index 8abf33a65..bbdefb950 100644 --- a/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs +++ b/src/Microsoft.VisualStudio.Threading/AsyncReaderWriterLock.cs @@ -709,6 +709,24 @@ protected virtual void OnUpgradeableReadLockReleased() { } + /// + /// Invoked when a nested lock request is detected from a forked execution context + /// of an upgradeable read lock holder — specifically, when the calling thread could hold + /// an active lock (it is not an STA thread) but lacks the required + /// . + /// + /// + /// This typically indicates that code holding an upgradeable read lock used + /// ConfigureAwait(false) or otherwise left the , + /// then requested a nested read lock on the forked context. + /// This method is called outside the lock's private synchronization object. + /// Implementations should be lightweight (e.g., setting a flag or posting a telemetry event). + /// The default implementation does nothing. Override to log diagnostics or telemetry. + /// + protected virtual void OnLockForkDetected() + { + } + /// /// Invoked when the lock detects an internal error or illegal usage pattern that /// indicates a serious flaw that should be immediately reported to the application @@ -1072,6 +1090,7 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi { bool issued = false; bool isOrdinaryNestedLock = false; // ordinary nested lock is a nested lock always granted immediately. We don't need write ETW event to reduce noise in traces. + bool lockForkDetected = false; lock (this.syncObject) { @@ -1097,6 +1116,21 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi switch (awaiter.Kind) { case LockKind.Read: + // Detect fork from upgradeable read context: the caller holds an active + // upgradeable read lock in its nesting chain but is executing on a thread + // that lacks the NonConcurrentSynchronizationContext, which typically means + // code used ConfigureAwait(false) and forked off the exclusive context. + // We skip this when hasWrite because the write fork path below already + // handles that case (with a hard failure), and we only report on the + // first request (!previouslyQueued) to avoid duplicate telemetry from + // PendAwaiter retries. + if (!previouslyQueued && hasUpgradeableRead && !hasWrite && + this.CanCurrentThreadHoldActiveLock && + !(SynchronizationContext.Current is NonConcurrentSynchronizationContext)) + { + lockForkDetected = true; + } + if (this.issuedWriteLocks.Count == 0 && (skipPendingWriteLockCheck || this.waitingWriters.Count == 0)) { issued = true; @@ -1178,6 +1212,11 @@ private bool TryIssueLock(Awaiter awaiter, bool previouslyQueued, bool skipPendi } } + if (lockForkDetected) + { + this.OnLockForkDetected(); + } + if (issued) { if (!isOrdinaryNestedLock) diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs index c62e537ab..e3daf893c 100644 --- a/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs +++ b/test/Microsoft.VisualStudio.Threading.Tests/AsyncReaderWriterLockTests.cs @@ -4084,6 +4084,70 @@ await Assert.ThrowsAsync(async delegate } } + [Fact] + public async Task UpgradeableReadLockForksAndAsksForReadLock() + { + var lck = new LockWithForkDetection(); + using (await lck.UpgradeableReadLockAsync()) + { + await Task.Run(async delegate + { + // This requests a read lock from a thread pool thread (no NonConcurrentSynchronizationContext) + // while holding an upgradeable read lock. This is a fork of the exclusive context and should + // be detected via the OnLockForkDetected virtual method. + using (await lck.ReadLockAsync()) + { + Assert.True(lck.IsReadLockHeld); + } + }); + } + + Assert.Equal(1, lck.ForkDetectedCount); + lck.Complete(); + Assert.True(lck.Completion.Wait(UnexpectedTimeout)); + } + + [Fact] + public async Task UpgradeableReadLockDoesNotForkOnCorrectContext() + { + var lck = new LockWithForkDetection(); + using (await lck.UpgradeableReadLockAsync()) + { + // Request a nested read lock on the correct context (with NonConcurrentSynchronizationContext). + // This should NOT trigger fork detection. + using (await lck.ReadLockAsync()) + { + Assert.True(lck.IsReadLockHeld); + } + } + + Assert.Equal(0, lck.ForkDetectedCount); + lck.Complete(); + Assert.True(lck.Completion.Wait(UnexpectedTimeout)); + } + + [Fact] + public async Task ReadLockForkFromReadOnlyContextDoesNotTriggerDetection() + { + var lck = new LockWithForkDetection(); + using (await lck.ReadLockAsync()) + { + await Task.Run(async delegate + { + // Fork from a read-only context. This should NOT trigger fork detection + // because read locks don't require NonConcurrentSynchronizationContext. + using (await lck.ReadLockAsync()) + { + Assert.True(lck.IsReadLockHeld); + } + }); + } + + Assert.Equal(0, lck.ForkDetectedCount); + lck.Complete(); + Assert.True(lck.Completion.Wait(UnexpectedTimeout)); + } + [Fact] public async Task WriteNestsReadWithWriteReleasedFirst() { @@ -5327,4 +5391,16 @@ public CriticalErrorException(Exception innerException) { } } + + private class LockWithForkDetection : AsyncReaderWriterLock + { + private int forkDetectedCount; + + internal int ForkDetectedCount => this.forkDetectedCount; + + protected override void OnLockForkDetected() + { + Interlocked.Increment(ref this.forkDetectedCount); + } + } } From 14190ba1d74ccdfc40be9f0aa05d59602f83931c Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Thu, 30 Jul 2026 10:15:42 -0700 Subject: [PATCH 1753/1753] Include WinDbg package in GitHub releases Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- azure-pipelines/release.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml index d1e88f74f..e7e804b60 100644 --- a/azure-pipelines/release.yml +++ b/azure-pipelines/release.yml @@ -87,7 +87,9 @@ extends: title: v$(resources.pipeline.CI.runName) isDraft: true # After running this step, visit the new draft release, edit, and publish. isPreRelease: $(IsPrerelease) - assets: $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg + assets: | + $(Pipeline.Workspace)/CI/deployables-Windows/NuGet/*.nupkg + $(Pipeline.Workspace)/CI/deployables-Windows/WinDBGGallery/*.nupkg changeLogCompareToRelease: lastNonDraftRelease changeLogType: issueBased changeLogLabels: |