-
Notifications
You must be signed in to change notification settings - Fork 110
Add frontend monorepo support for Nx and Turborepo #786
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
- Adding some annotations to know more about how resources are connected - Making TurboApp and NxApp inherit from NodeApp so they can be used through extension methods better - New method to map the port cli arg through - Test coverage
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds frontend monorepo support for Nx and Turborepo to prevent package installation race conditions when multiple applications share the same workspace directory. The implementation introduces dedicated monorepo resources and extension methods that create shared package installers, ensuring proper startup ordering without manual dependency management.
Key changes:
- New Resource Types: Added
NxResource
,NxAppResource
,TurborepoResource
, andTurborepoAppResource
to represent monorepo workspaces and individual apps - Shared Package Installers: Extended package installer methods to work with monorepo resources, preventing race conditions through single shared installers per workspace
- Enhanced Extension Methods: Added
AddNxApp
,AddTurborepoApp
, and related methods with automatic dependency management
Reviewed Changes
Copilot reviewed 58 out of 80 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
NodeJSHostingExtensions.cs |
Split into partial class with new monorepo extension methods and port mapping utilities |
NodeJSHostingExtensions.PackageInstallers.cs |
Moved and enhanced package installer methods with monorepo support |
Resource classes (NxResource.cs , etc.) |
New resource types representing monorepo workspaces and applications |
Annotation classes | Added package manager and installer tracking annotations |
Test files | Comprehensive test coverage for monorepo functionality and enhanced package installation tests |
Documentation files | Added detailed monorepo documentation and updated README |
Example files | Complete Turborepo demo workspace with multiple apps and packages |
Lifecycle hook files | Removed obsolete lifecycle hook classes |
Comments suppressed due to low confidence (4)
src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/NodeJSHostingExtensions.PackageInstallers.cs:30
- According to the .NET Aspire Community Toolkit coding guidelines, resources should follow proper annotation patterns. The installer resource should be added to the parent resource's annotations, not the installer builder itself. Consider adding the annotation to the parent resource instead.
.WithAnnotation(new JavaScriptPackageInstallerAnnotation(installer));
src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/NodeJSHostingExtensions.PackageInstallers.cs:118
- According to the .NET Aspire Community Toolkit coding guidelines, annotations should be added to the parent resource to maintain proper resource relationships. The installer annotation should be added to the workspace resource, not the installer builder.
.WithAnnotation(new JavaScriptPackageInstallerAnnotation(installer));
src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/NodeJSHostingExtensions.cs:162
- According to the .NET Aspire Community Toolkit coding guidelines, resource dependencies should be properly established. The annotation should be retrieved from the workspace resource to ensure proper dependency tracking. The current implementation may not correctly establish the dependency chain.
if (builder.Resource.TryGetLastAnnotation<JavaScriptPackageInstallerAnnotation>(out var installerAnnotation))
{
rb.WaitFor(builder.ApplicationBuilder.CreateResourceBuilder(installerAnnotation.Resource));
}
src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/NodeJSHostingExtensions.cs:193
- According to the .NET Aspire Community Toolkit coding guidelines, resource dependencies should be properly established. The annotation should be retrieved from the workspace resource to ensure proper dependency tracking. The current implementation may not correctly establish the dependency chain.
if (builder.Resource.TryGetLastAnnotation<JavaScriptPackageInstallerAnnotation>(out var installerAnnotation))
{
rb.WaitFor(builder.ApplicationBuilder.CreateResourceBuilder(installerAnnotation.Resource));
}
Minimum allowed line rate is |
@copilot please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
Adds support for frontend monorepos using Nx and Turborepo to prevent package installation race conditions when multiple apps share the same workspace directory.
Problem
When using monorepos, multiple applications share the same
package.json
and workspace setup. Previously, trying to run multiple apps with individual package installers would cause race conditions:Solution
This PR introduces dedicated monorepo support with shared package installers:
Implementation Details
New Resource Types:
NxResource
- Wrapper resource for Nx workspacesNxAppResource
- Individual Nx apps (runsnx serve {appName}
)TurborepoResource
- Wrapper resource for Turborepo workspacesTurborepoAppResource
- Individual Turborepo apps (runsturbo run dev --filter {filter}
)Dependency Chain:
The implementation ensures proper startup ordering where all apps wait for package installation to complete:
Package Manager Support:
Both Nx and Turborepo support all three package managers:
.WithNpmPackageInstaller()
(supportsuseCI
parameter).WithYarnPackageInstaller()
.WithPnpmPackageInstaller()
Files Added
NxResource.cs
,NxAppResource.cs
,TurborepoResource.cs
,TurborepoAppResource.cs
NodeJSHostingExtensions.cs
MonorepoResourceCreationTests.cs
and enhancedPackageInstallationTests.cs
MONOREPO.md
with detailed usage examplesREADME.md
and exampleProgram.cs
Benefits
WaitFor
callsFixes #772.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
dnceng.pkgs.visualstudio.com
dotnet build src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions.csproj
(dns block)dotnet test tests/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions.Tests/ --verbosity minimal
(dns block)dotnet workload install aspire
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.