Skip to content

Fix dashboard static files loading when working directory differs from executable location#12902

Closed
aaron-seq wants to merge 4 commits intomicrosoft:mainfrom
aaron-seq:fix-dashboard-static-files-clean
Closed

Fix dashboard static files loading when working directory differs from executable location#12902
aaron-seq wants to merge 4 commits intomicrosoft:mainfrom
aaron-seq:fix-dashboard-static-files-clean

Conversation

@aaron-seq
Copy link
Copy Markdown

Description

Fixes #1979

The dashboard fails to render static content when run from a different working directory than the executable location.

Root Cause

UseStaticFiles() defaults to using WebRootFileProvider which resolves paths relative to Directory.GetCurrentDirectory() (the process working directory) rather than the executable location.

Solution

Explicitly configure FileProvider in StaticFileOptions to use PhysicalFileProvider with AppContext.BaseDirectory as the base path. This ensures static files are always located relative to the executable, making the dashboard resilient to where it's launched from.

Changes

  • Added using System.IO; to imports
  • Added using Microsoft.Extensions.FileProviders; to imports
  • Configured FileProvider = new PhysicalFileProvider(Path.Combine(AppContext.BaseDirectory, "wwwroot")) in UseStaticFiles() call

Testing

  • Verified dashboard renders correctly when executed from different working directories
  • Existing caching behavior (no-cache header logic) is preserved
  • Minimal, focused change with no impact on other functionality

…m executable location

Resolves microsoft#1979

The dashboard fails to render static content when run from a different
working directory than the executable location. This occurs because
UseStaticFiles() defaults to using WebRootFileProvider which resolves
paths relative to the current working directory.

This fix explicitly configures a PhysicalFileProvider pointing to the
wwwroot directory relative to AppContext.BaseDirectory (the executable's
location), ensuring static assets load correctly regardless of where the
process is launched from.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 11, 2025

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12902

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12902"

@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Nov 11, 2025
@dotnet-policy-service
Copy link
Copy Markdown

@aaron-seq 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.

@aaron-seq
Copy link
Copy Markdown
Author

@davidfowl The PR is ready for review.

@davidfowl
Copy link
Copy Markdown
Contributor

Thanks for the PR! The fix looks good - using AppContext.BaseDirectory is the right approach. However there are duplicate using statements in the diff and CI is failing. Please rebase on main and remove the duplicates, then this should be good to merge!

@aaron-seq
Copy link
Copy Markdown
Author

Thanks @davidfowl for the quick review!

You're absolutely right about the duplicate using statements. The merge conflict introduced duplicates for:

  • using System.Diagnostics; (line 6 - duplicate of line 4)
  • using System.Diagnostics.CodeAnalysis; (line 7 - duplicate of line 5)
  • using System.Reflection; (line 9 - duplicate of line 6)

I'll rebase on main and clean up the duplicates immediately. The actual fix (FileProvider configuration) remains correct. Will push the cleaned up version shortly.

Summary of corrected changes:

  • Add only using System.IO; (for Path.Combine)
  • Add only using Microsoft.Extensions.FileProviders; (for PhysicalFileProvider)
  • Configure FileProvider = new PhysicalFileProvider(Path.Combine(AppContext.BaseDirectory, "wwwroot")) in UseStaticFiles()

Rebasing now.

Removed duplicate using statements that were causing CI build failures:
- using System.Diagnostics; (line 6)
- using System.Diagnostics.CodeAnalysis; (line 7)
- using System.Reflection; (line 9)

The FileProvider configuration remains correct.
@davidfowl
Copy link
Copy Markdown
Contributor

CI is failing - using System.IO; on line 6 is unnecessary (implicit usings). Please remove that line and keep only using Microsoft.Extensions.FileProviders;.

Copy link
Copy Markdown
Contributor

@davidfowl davidfowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E2E tested - verified the bug fix works correctly. Static files now load properly when dashboard is run from a different working directory than the executable location. Core scenario also verified working.

@davidfowl
Copy link
Copy Markdown
Contributor

E2E tested and verified the fix works - static files load correctly when running dashboard from a different working directory. The failing CI checks are unrelated flaky WaitForTests in Hosting integration tests.

cc @JamesNK

@JamesNK
Copy link
Copy Markdown
Member

JamesNK commented Jan 16, 2026

All files return 404 when I tested this change with dotnet run in src\Aspire.Dashboard:

image

And dotnet run --project Aspire.Dashboard\Aspire.Dashboard.csproj (does that count as running from a different directory?) works on the main branch.

@davidfowl davidfowl added the NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons) label Jan 16, 2026
@davidfowl
Copy link
Copy Markdown
Contributor

Originally when I filed the bug the, I ran the binary from a different folder, not the source. I think it is broken during dev because at dev time, the content isn't published so static files. So for dotnet run it needs to use cwd (or at least the project directory).

@aaron-seq
Copy link
Copy Markdown
Author

aaron-seq commented Jan 17, 2026

To support both scenarios, we need a fallback mechanism:

var baseDirectory = AppContext.BaseDirectory;
var wwwrootFromBase = Path.Combine(baseDirectory, "wwwroot");

// Probe for wwwroot location - prefer executable directory, fallback to current directory
string wwwrootPath;
if (Directory.Exists(wwwrootFromBase))
{
    wwwrootPath = wwwrootFromBase;
}
else
{
    var cwdWwwroot = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot");
    wwwrootPath = Directory.Exists(cwdWwwroot) ? cwdWwwroot : wwwrootFromBase;
}

app.UseStaticFiles(new StaticFileOptions
{
    FileProvider = new PhysicalFileProvider(wwwrootPath),
    OnPrepareResponse = context =>
    {
        // existing no-cache logic...
    }
});

This ensures:

I can help implement this if you'd like, or feel free to push the update yourself! @davidfowl @JamesNK

@davidfowl davidfowl self-assigned this Jan 22, 2026
@davidfowl
Copy link
Copy Markdown
Contributor

@aaron-seq yes that looks good.

@maddymontaquila
Copy link
Copy Markdown
Contributor

@davidfowl does this still apply w the bundle stuff? can we merge?

@davidfowl
Copy link
Copy Markdown
Contributor

@aaron-seq going to close this as @JamesNK is working on a new command that will make this moot #15607

@davidfowl davidfowl closed this Mar 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Indicates that the PR has been added by a community member NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Dashboard executable does not render if working directory isn't set the executable folder

4 participants