Remove DCP and Dashboard from the .NET Aspire SDK Workload

docs/specs/future-of-workload.md

@@ -0,0 +1,43 @@
+# Design proposal for the .NET Aspire workload going forward
+
+.NET Aspire currently ships as a .NET SDK Workload. This workload currently includes the following components:
+
+- Aspire.Hosting.SDK (MSBuild SDK): This SDK contains some props and targets with the required logic to properly handle `ProjectReferences` in the .NET Aspire AppHost projects, which then drives the source generation that allows the AppHost project to have strongly typed references to project resources. This component cannot be changed into a regular NuGet package, as the logic it carries neeeds to be executed before the initial restore.
+- Aspire.ProjectTemplates (.NET Template Pack): This is a set of project templates that allow users to create new .NET Aspire projects using `dotnet new` commands and Visual Studio "New Project" dialog.
+- Aspire.Hosting.Orchestration (MSBuild SDK): This SDK contains two main things: the Developer Control Plane executable (DCP) as well as a targets file which defines properties for the AppHost to be able to find the DCP executable and run it.
+- Aspire.Dashboard.SDK (MSBuild SDK): Similar to the Orchestration SDK, this one provides the .NET Aspire Dashboard application (self-contained app that depends on .NET 8 runtime) and the targets file that defines properties for the AppHost to be able to find the Dashboard executable and launch it.
+- Aspire.Hosting (Regular NuGet Library): This package isn't really required to be in the workload, as this is a PackageReference that all AppHost projects will have. The advantage that we get currently from having it in the workload is that this would install it into the global NuGet cache when the workload is installed, so that the AppHost projects can find it without needing to restore it from the NuGet feed. This is helpful especially for offline scenarios. The package itself provides the Aspire.Hosting library which contains all of the main logic in Aspire for building and running .NET Aspire applications.
+
+![Current state of the workload](workload-current-state.png "Current state of the workload")
+
+## Problem statement
+
+The current design of the workload has led to some usability issues, and after a lot of deep analysis, we finally understand what is the root cause of these issues. SDK Workloads are meant to be used for tooling components, which lifetime should be tied to the lifetime of the SDK itself. When we were originally designing the workload, we believed that both DCP and Dashboard were tooling components, and that they should be installed as part of the workload. However, we have come to realize that this is not the case. DCP and Dashboard are tightly coupled to the version of Aspire.Hosting package that the AppHost project references, and therefore are part of the AppHost itself, as opposed to tooling that supports it. This is the root cause of the issues that we have seen with the workload, such as the need to ensure that the version of the workload installed matches the project reference of Aspire.Hosting, which is also a problem when trying to work with multiple Aspire projects that reference different versions of Aspire.Hosting. SDK typically makes the assumption that customers want to always be in the latest version of all of the workloads, which is likely the right thing to do for tooling components; however, this is a problem for .NET Aspire given the tight coupling between the AppHost and the DCP/Dashboard.
+
+## Proposed solution
+
+Given the above, we propose to move the DCP and Dashboard components out of the workload, and into NuGet packages that are referenced as dependencies of the Aspire.Hosting.AppHost package. This will allow the AppHost project to reference the version of Aspire.Hosting that it wants, and then the DCP and Dashboard will be installed as dependencies of that version of Aspire.Hosting. This will allow the AppHost project to have full control over the version of the DCP and Dashboard that it wants to use, and will also allow customers to have multiple AppHost projects that reference different versions of Aspire.Hosting without any issues. This will also allow us to update the DCP and Dashboard independently of the workload, which will allow us to ship updates to these components more frequently and with less risk, with a far less complex compatibility matrix.
+
+Also, there is no real need of including the Aspire.Hosting package as part of the workload, as there is no guarantee that this is the version that the AppHost project will want to use, therefore we would also remove this package from the workload. In the end, the workload will only contain the Aspire.Hosting.SDK and Aspire.ProjectTemplates components, which are the ones that can be truly considered as tooling components, and in both cases you would want to always be in the latest version. These two are also not tightly coupled to the version of the Aspire.Hosting package that the AppHost project references, so they can be updated independently of the AppHost.
+
+This is the proposed new design:
+
+![Proposal](workload-proposed-state.png "Proposal")
+
+### Pros
+
+This proposal has many benefits which will solve the issues we currently have with the workload:
+
+- The AppHost project will have full control over the version of the DCP and Dashboard that it wants to use.
+- Customers can have multiple AppHost projects that reference different versions of Aspire.Hosting without any issues.
+- We can update the DCP and Dashboard independently of the workload, which will allow us to ship updates to these components more frequently and with less risk.
+- Customers can stay in the latest version of the workload without worrying about compatibility issues with the AppHost project.
+
+### Cons
+
+- The main drawback of removing DCP and Dashboard from the workload, is the potential impacts it may have with restore times and local package caches. DCP especially is not small in size (~150mb) and it is also a native executable (written in Go), so we currently have separate packages each carrying the executable for each individual platform. One thing we were getting for free with DCP being part of the workload, is that the SDK authoring would automatically only install the DCP package for the platform that the SDK is being installed on. NuGet doesn't have great support today for platform-specific dependencies, which means that with the above proposal the Aspire.Hosting.AppHost package would depend on all of the DCP packages for all platforms, which would increase the size of the things that need to be restored, as well as the time it takes to do it.
+- Additionally, workloads also have a way of keeping a reference count on workload packs, so it is able to clean them up when workloads don't reference it any more (for example, if you update your workload, then the old DCP package will be cleaned up automatically). This doesn't happen with regular NuGet packages, where customers are responsible for cleaning up their NuGet package caches themselves.
+
+## Next steps
+
+I have a working prototype of the proposed design on this branch: https://github.com/joperezr/aspire/tree/workloads/MSBuildSDKs. (Changes can be easily seen by going to this [link](https://github.com/dotnet/aspire/compare/main...joperezr:aspire:workloads/MSBuildSDKs)). I have tested this proof of concept and it works as expected. The next steps would be to get feedback from the team and stakeholders, and if there are no major concerns, then we can proceed with the implementation of this proposal. The prototype has temporarily disabled building tests and playground apps, as those weren't required for testing the proof of concept, but once the proposal is approved, we can re-enable them and make sure that everything is working as expected.

eng/Build.props

@@ -1,8 +1,10 @@
 <Project>
   <ItemGroup Condition="'$(DotNetBuildFromSource)' != 'true' and '$(DotNetBuild)' != 'true'">
     <ProjectToBuild Include="$(RepoRoot)src\**\*.csproj" Exclude="$(RepoRoot)src\Aspire.ProjectTemplates\templates\**\*.csproj" />
-    <ProjectToBuild Include="$(RepoRoot)tests\**\*.csproj"  />
+    <ProjectToBuild Include="$(RepoRoot)eng\dcppack\**\*.csproj" Exclude="$(RepoRoot)src\Aspire.ProjectTemplates\templates\**\*.csproj" />
+    <ProjectToBuild Include="$(RepoRoot)eng\dashboardpack\**\*.csproj" Exclude="$(RepoRoot)src\Aspire.ProjectTemplates\templates\**\*.csproj" />
     <ProjectToBuild Include="$(RepoRoot)playground\**\*.csproj" />
+    <ProjectToBuild Include="$(RepoRoot)tests\**\*.csproj"  />
   </ItemGroup>
   <!-- If we are building for SourceBuild, then we only want to build the Aspire manifest package -->
   <ItemGroup Condition="'$(DotNetBuildFromSource)' == 'true' or '$(DotNetBuild)' == 'true'">

eng/Versions.props

@@ -2,9 +2,9 @@
   <PropertyGroup>
     <!-- This repo version -->
     <MajorVersion>8</MajorVersion>
-    <MinorVersion>1</MinorVersion>
-    <PatchVersion>1</PatchVersion>
-    <VersionPrefix>8.1.1</VersionPrefix>
+    <MinorVersion>2</MinorVersion>
+    <PatchVersion>0</PatchVersion>
+    <VersionPrefix>8.2.0</VersionPrefix>
     <PreReleaseVersionLabel>preview.1</PreReleaseVersionLabel>
     <!--
       When running package validation as part of the build, we want to ensure we didn't break the API against the previous

eng/dashboardpack/Aspire.Dashboard.Sdk.linux-arm64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>linux-arm64</DashboardRuntime>
+    <DashboardPlatformType>Unix</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Aspire.Dashboard.Sdk.linux-x64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>linux-x64</DashboardRuntime>
+    <DashboardPlatformType>Unix</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Aspire.Dashboard.Sdk.osx-arm64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>osx-arm64</DashboardRuntime>
+    <DashboardPlatformType>Unix</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Aspire.Dashboard.Sdk.osx-x64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>osx-x64</DashboardRuntime>
+    <DashboardPlatformType>Unix</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Aspire.Dashboard.Sdk.win-arm64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>win-arm64</DashboardRuntime>
+    <DashboardPlatformType>Windows</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Aspire.Dashboard.Sdk.win-x64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>win-x64</DashboardRuntime>
+    <DashboardPlatformType>Windows</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Aspire.Dashboard.Sdk.win-x86.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DashboardRuntime>win-x86</DashboardRuntime>
+    <DashboardPlatformType>Windows</DashboardPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dashboardpack/Common.projitems

@@ -0,0 +1,65 @@
+<Project>
+  <Import Sdk="Microsoft.NET.Sdk" Project="Sdk.props" />
+
+  <Import Project="$(SharedDir)Workload.targets" />
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <IsPackable>true</IsPackable>
+    <!-- Unset PackageType as that is being set by Workload.targets to DotnetPlatform, which this package no longer is. -->
+    <PackageType />
+    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
+    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <IncludeBuildOutput>false</IncludeBuildOutput>
+    <PackageOutputPath Condition=" '$(PackageOutputPath)' == '' ">$(ArtifactsShippingPackagesDir)</PackageOutputPath>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <Description>Dashboard browser interface for .NET Aspire.</Description>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <TextReplacementValue Include="PlatformRuntime" NewValue="$(DashboardRuntime)" />
+    <TextReplacementValue Include="PackageName" NewValue="$(AssemblyName)" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="build*/*.props;**/*.targets" Pack="true" PerformTextReplacement="true" PackagePath="%(RecursiveDir)$(AssemblyName)%(Extension)" />
+  </ItemGroup>
+
+  <Import Sdk="Microsoft.NET.Sdk" Project="Sdk.targets" />
+
+  <Target Name="Build" />
+
+
+  <Target Name="BeforeBuild" BeforeTargets="Build">
+    <MSBuild Projects="../../src/Aspire.Dashboard/Aspire.Dashboard.csproj" Targets="publish"
+      Properties="Configuration=$(Configuration);Platform=$(Platform);TargetFramework=$(TargetFramework);RuntimeIdentifier=$(DashboardRuntime);PlatformName=$(DashboardRuntime)" />
+
+    <!-- After publishing the project, we ensure that the published assets get packed in the nuspec. -->
+    <ItemGroup>
+      <_PublishItems
+        Include="$(DotNetOutputPath)Aspire.Dashboard/$(DashboardRuntime)/$(Configuration)/$(TargetFramework)/$(DashboardRuntime)/publish/**/*" />
+      <None Include="@(_PublishItems)" Pack="true" PackagePath="tools/" />
+    </ItemGroup>
+
+    <MakeDir Directories="$(DashboardPublishedArtifactsOutputDir)/$(DashboardRuntime)" />
+    <ZipDirectory
+      SourceDirectory="$(DotNetOutputPath)Aspire.Dashboard/$(DashboardRuntime)/$(Configuration)/$(TargetFramework)/$(DashboardRuntime)/publish"
+      DestinationFile="$(DashboardPublishedArtifactsOutputDir)/$(DashboardRuntime)/aspire-dashboard-$(DashboardRuntime).zip"
+      Overwrite="true" />
+
+    <!-- Throw an error if _PublishItems is empty. -->
+    <Error Condition="'@(_PublishItems)' == ''"
+      Text="No files were found to pack. Ensure that the project being packed has a publish target defined." />
+  </Target>
+
+  <ItemGroup>
+    <None Include="Sdk.props" Pack="true" PackagePath="build/$(AssemblyName).props" />
+    <None Include="Sdk.in.targets" Pack="true" PerformTextReplacement="true"
+      PackagePath="build/$(AssemblyName).targets" />
+    <None Include="UnixFilePermissions.xml" Pack="true" PackagePath="data/"
+      Condition=" '$(DashboardPlatformType)' == 'Unix' " />
+  </ItemGroup>
+
+</Project>

eng/dashboardpack/Sdk.targets → eng/dashboardpack/Sdk.in.targets

@@ -2,15 +2,15 @@
 
   <!-- *** BEGIN *** -->
 
-  <PropertyGroup>
+  <PropertyGroup Condition="'$(NETCoreSdkRuntimeIdentifier)' == '@PlatformRuntime@'">
     <AspireDashboardDir Condition=" '$(AspireDashboardDir)' == '' ">$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'tools'))</AspireDashboardDir>
     <AspireDashboardDir>$([MSBuild]::EnsureTrailingSlash('$(AspireDashboardDir)'))</AspireDashboardDir>
     <AspireDashboardPath Condition=" '$(AspireDashboardPath)' == '' ">$([MSBuild]::NormalizePath($(AspireDashboardDir), 'Aspire.Dashboard'))</AspireDashboardPath>
     <AspireDashboardPath Condition=" '$(OS)' == 'Windows_NT' and !$(AspireDashboardPath.EndsWith('.exe')) ">$(AspireDashboardPath).exe</AspireDashboardPath>
     <AspireDashboardPath Condition="$([MSBuild]::IsOsPlatform('OSX')) and !$(AspireDashboardPath.EndsWith('.dll'))">$(AspireDashboardPath).dll</AspireDashboardPath>
   </PropertyGroup>
 
-  <ItemGroup>
+  <ItemGroup Condition="'$(NETCoreSdkRuntimeIdentifier)' == '@PlatformRuntime@'">
     <ProjectCapability Include="AspireDashboard" />
   </ItemGroup>
 

eng/dashboardpack/buildMultiTargeting/Aspire.Dashboard.Sdk.in.props

@@ -0,0 +1,3 @@
+<Project>
+  <Import Project="..\build\@PackageName@.props" />
+</Project>  

eng/dashboardpack/buildMultiTargeting/Aspire.Dashboard.Sdk.in.targets

@@ -0,0 +1,3 @@
+<Project>
+  <Import Project="..\build\@PackageName@.targets" />
+</Project>  

eng/dashboardpack/buildTransitive/Aspire.Dashboard.Sdk.in.props

@@ -0,0 +1,3 @@
+<Project>
+  <Import Project="..\build\@PackageName@.props" />
+</Project>  

eng/dashboardpack/buildTransitive/Aspire.Dashboard.Sdk.in.targets

@@ -0,0 +1,3 @@
+<Project>
+  <Import Project="..\build\@PackageName@.targets" />
+</Project>  

eng/dcppack/Aspire.Hosting.Orchestration.targets → eng/dcppack/Aspire.Hosting.Orchestration.in.targets

@@ -1,6 +1,6 @@
 <Project>
 
-  <PropertyGroup>
+  <PropertyGroup Condition="'$(NETCoreSdkRuntimeIdentifier)' == '@PlatformRuntime@'">
     <DcpDir Condition=" '$(DcpDir)' == '' ">$([MSBuild]::NormalizeDirectory($(MSBuildThisFileDirectory), '..', 'tools'))</DcpDir>
     <DcpDir>$([MSBuild]::EnsureTrailingSlash('$(DcpDir)'))</DcpDir>
     <DcpExtensionsDir Condition=" '$(DcpExtensionsDir)' == '' ">$([MSBuild]::NormalizeDirectory($(DcpDir), 'ext'))</DcpExtensionsDir>

eng/dcppack/Aspire.Hosting.Orchestration.linux-arm64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>linux-arm64</DcpRuntime>
+    <DcpPlatformType>Unix</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dcppack/Aspire.Hosting.Orchestration.linux-x64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>linux-x64</DcpRuntime>
+    <DcpPlatformType>Unix</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dcppack/Aspire.Hosting.Orchestration.osx-arm64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>osx-arm64</DcpRuntime>
+    <DcpPlatformType>Unix</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dcppack/Aspire.Hosting.Orchestration.osx-x64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>osx-x64</DcpRuntime>
+    <DcpPlatformType>Unix</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dcppack/Aspire.Hosting.Orchestration.win-arm64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>win-arm64</DcpRuntime>
+    <DcpPlatformType>Windows</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dcppack/Aspire.Hosting.Orchestration.win-x64.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>win-x64</DcpRuntime>
+    <DcpPlatformType>Windows</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>

eng/dcppack/Aspire.Hosting.Orchestration.win-x86.csproj

@@ -0,0 +1,9 @@
+<Project>
+  <PropertyGroup>
+    <DcpRuntime>win-x86</DcpRuntime>
+    <DcpPlatformType>Windows</DcpPlatformType>
+  </PropertyGroup>
+
+  <Import Project="Common.projitems" />
+
+</Project>