Skip to content

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 5, 2025

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:

// This causes race conditions - multiple installers for the same directory
var app1 = builder.AddYarnApp("app-1", "./Frontend", args: ["app1"])
    .WithYarnPackageInstallation();
    
var app2 = builder.AddYarnApp("app-2", "./Frontend", args: ["app2"])
    .WithYarnPackageInstallation();
    
var app3 = builder.AddYarnApp("app-3", "./Frontend", args: ["app3"])
    .WithYarnPackageInstallation();

Solution

This PR introduces dedicated monorepo support with shared package installers:

// Nx monorepo - single shared installer, no race conditions
var nx = builder.AddNxApp("nx", workingDirectory: "../frontend")
    .WithNpmPackageInstaller();

var app1 = nx.AddApp("app1");
var app2 = nx.AddApp("app2", appName: "my-app-2");

// Turborepo monorepo
var turbo = builder.AddTurborepoApp("turbo", workingDirectory: "../frontend")
    .WithYarnPackageInstaller();

var turboApp1 = turbo.AddApp("app1");
var turboApp2 = turbo.AddApp("app2", filter: "custom-filter");

Implementation Details

New Resource Types:

  • NxResource - Wrapper resource for Nx workspaces
  • NxAppResource - Individual Nx apps (runs nx serve {appName})
  • TurborepoResource - Wrapper resource for Turborepo workspaces
  • TurborepoAppResource - Individual Turborepo apps (runs turbo run dev --filter {filter})

Dependency Chain:
The implementation ensures proper startup ordering where all apps wait for package installation to complete:

NxApp1 → waits for → NxWorkspace → waits for → SharedInstaller
NxApp2 → waits for → NxWorkspace (same installer)
NxApp3 → waits for → NxWorkspace (same installer)

Package Manager Support:
Both Nx and Turborepo support all three package managers:

  • .WithNpmPackageInstaller() (supports useCI parameter)
  • .WithYarnPackageInstaller()
  • .WithPnpmPackageInstaller()

Files Added

  • Core resource classes: NxResource.cs, NxAppResource.cs, TurborepoResource.cs, TurborepoAppResource.cs
  • Extension methods in NodeJSHostingExtensions.cs
  • Comprehensive tests in MonorepoResourceCreationTests.cs and enhanced PackageInstallationTests.cs
  • Documentation: MONOREPO.md with detailed usage examples
  • Updated README.md and example Program.cs

Benefits

  • Eliminates Race Conditions - Only one package installer per workspace directory
  • Clean API - Intuitive workspace → apps hierarchy following Aspire patterns
  • Automatic Dependencies - Proper startup ordering without manual WaitFor calls
  • No Breaking Changes - Purely additive functionality

Fixes #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
    • Triggering command: dotnet build src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions.csproj (dns block)
    • Triggering command: dotnet test tests/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions.Tests/ --verbosity minimal (dns block)
    • Triggering command: 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.

Copilot AI and others added 2 commits August 6, 2025 00:11
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Improve support for Frontend monorepos Add frontend monorepo support for Nx and Turborepo Aug 6, 2025
@Copilot Copilot AI requested a review from aaronpowell August 6, 2025 00:20
Copilot finished work on behalf of aaronpowell August 6, 2025 00:20
turbobot-temp and others added 4 commits August 7, 2025 04:48
- 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
@aaronpowell aaronpowell marked this pull request as ready for review August 7, 2025 06:16
@Copilot Copilot AI review requested due to automatic review settings August 7, 2025 06:16
Copy link
Contributor

@Copilot Copilot AI left a 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, and TurborepoAppResource 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));
        }

Copy link
Contributor

github-actions bot commented Aug 7, 2025

Code Coverage

Package Line Rate Branch Rate Complexity Health
CommunityToolkit.Aspire.EventStore 100% 100% 46
CommunityToolkit.Aspire.GoFeatureFlag 100% 97% 74
CommunityToolkit.Aspire.Hosting.ActiveMQ 79% 40% 100
CommunityToolkit.Aspire.Hosting.ActiveMQ.MassTransit 1% 0% 14
CommunityToolkit.Aspire.Hosting.Adminer 73% 50% 20
CommunityToolkit.Aspire.Hosting.Azure.Dapr 66% 50% 832
CommunityToolkit.Aspire.Hosting.Azure.Dapr.Redis 97% 88% 36
CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder 100% 100% 22
CommunityToolkit.Aspire.Hosting.Bun 82% 71% 54
CommunityToolkit.Aspire.Hosting.Dapr 62% 51% 728
CommunityToolkit.Aspire.Hosting.DbGate 94% 50% 18
CommunityToolkit.Aspire.Hosting.Deno 84% 75% 72
CommunityToolkit.Aspire.Hosting.EventStore 94% 100% 18
CommunityToolkit.Aspire.Hosting.GoFeatureFlag 93% 50% 18
CommunityToolkit.Aspire.Hosting.Golang 87% 70% 28
CommunityToolkit.Aspire.Hosting.Java 69% 72% 120
CommunityToolkit.Aspire.Hosting.k6 58% 12% 20
CommunityToolkit.Aspire.Hosting.LavinMQ 78% 50% 18
CommunityToolkit.Aspire.Hosting.LavinMQ.MassTransit 1% 0% 14
CommunityToolkit.Aspire.Hosting.MailPit 91% 50% 14
CommunityToolkit.Aspire.Hosting.McpInspector 91% 48% 98
CommunityToolkit.Aspire.Hosting.Meilisearch 73% 57% 50
CommunityToolkit.Aspire.Hosting.Minio 93% 75% 48
CommunityToolkit.Aspire.Hosting.MongoDB.Extensions 96% 83% 36
CommunityToolkit.Aspire.Hosting.MySql.Extensions 100% 88% 78
CommunityToolkit.Aspire.Hosting.Ngrok 52% 35% 82
CommunityToolkit.Aspire.Hosting.NodeJS.Extensions 86% 73% 206
CommunityToolkit.Aspire.Hosting.Ollama 67% 70% 174
CommunityToolkit.Aspire.Hosting.PapercutSmtp 92% 50% 10
CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions 99% 89% 84
CommunityToolkit.Aspire.Hosting.Python.Extensions 68% 55% 90
CommunityToolkit.Aspire.Hosting.RavenDB 63% 49% 136
CommunityToolkit.Aspire.Hosting.Redis.Extensions 100% 71% 48
CommunityToolkit.Aspire.Hosting.Rust 94% 83% 16
CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects 76% 64% 154
CommunityToolkit.Aspire.Hosting.Sqlite 99% 89% 42
CommunityToolkit.Aspire.Hosting.SqlServer.Extensions 100% 87% 78
CommunityToolkit.Aspire.Hosting.SurrealDb 71% 54% 152
CommunityToolkit.Aspire.MassTransit.RabbitMQ 100% 100% 30
CommunityToolkit.Aspire.Meilisearch 97% 92% 68
CommunityToolkit.Aspire.Microsoft.Data.Sqlite 89% 85% 52
CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite 50% 50% 88
CommunityToolkit.Aspire.Minio.Client 73% 59% 88
CommunityToolkit.Aspire.OllamaSharp 74% 69% 120
CommunityToolkit.Aspire.RavenDB.Client 60% 53% 237
CommunityToolkit.Aspire.SurrealDb 96% 90% 56
Summary 73% (7425 / 10141) 61% (2315 / 3826) 4587

Minimum allowed line rate is 60%

@github-actions github-actions bot added Stale and removed Stale labels Aug 13, 2025
@github-actions github-actions bot added Stale and removed Stale labels Aug 20, 2025
Copy link

@copilot please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve support for Frontend monorepos
3 participants