Skip to content

Per-database "RavenDB Studio" links in the Aspire dashboard#1444

Open
Scooletz wants to merge 6 commits into
CommunityToolkit:mainfrom
Scooletz:ravendb-direct-db-link
Open

Per-database "RavenDB Studio" links in the Aspire dashboard#1444
Scooletz wants to merge 6 commits into
CommunityToolkit:mainfrom
Scooletz:ravendb-direct-db-link

Conversation

@Scooletz

@Scooletz Scooletz commented Jun 29, 2026

Copy link
Copy Markdown

Closes #1443

Each database added via AddDatabase(...) now shows a clickable RavenDB Studio link in the Aspire dashboard that deep-links straight into that database's Documents view, instead of only the server being reachable. The link is added automatically for every database with no extra configuration. For secured servers the link uses the configured public server URL; for unsecured ones it uses the server's allocated HTTP endpoint. The server resource itself is left unchanged. Because a database is an endpoint-less child resource (where Aspire's normal WithUrls pipeline never renders), the link is built on the parent server's endpoint-allocated event and pushed via a resource snapshot update.

PR Checklist

  • Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
  • Based off latest main branch of toolkit
  • PR doesn't include merge commits (always rebase on top of our main, if needed)
  • New integration
    • Docs are written
    • Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
  • Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Contains NO breaking changes
  • Every new API (including internal ones) has full XML docs
  • Code follows all style conventions

Other information

Dogfooding

Aspire Dashboard

image

After clicking the link

image

Copilot AI review requested due to automatic review settings June 29, 2026 14:32
@github-actions

Copy link
Copy Markdown
Contributor

🚀 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/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1444

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1444"

@Scooletz Scooletz marked this pull request as draft June 29, 2026 14:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds per-database RavenDB Studio deep links to the Aspire dashboard for RavenDB database child resources, so users can jump directly into a specific database’s Documents view rather than only reaching the server.

Changes:

  • Subscribes to the parent server’s endpoint allocation event and publishes a snapshot update so the dashboard renders a per-database “RavenDB Studio” URL.
  • Adds unit/integration tests validating Studio URL composition and presence on the database resource.
  • Documents the new dashboard behavior and exposes internals to the test assembly.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AppHostTests.cs Adds an integration test asserting the per-database Studio link is present.
tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AddRavenDBTests.cs Adds unit tests for BuildStudioUrl formatting/escaping.
src/CommunityToolkit.Aspire.Hosting.RavenDB/README.md Documents the per-database Studio link behavior in the dashboard.
src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBBuilderExtensions.cs Implements Studio deep-link creation and pushes a resource snapshot URL update.
src/CommunityToolkit.Aspire.Hosting.RavenDB/CommunityToolkit.Aspire.Hosting.RavenDB.csproj Grants test assembly access to internals for URL-builder testing.

Comment thread tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AppHostTests.cs Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comment thread tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AppHostTests.cs Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comment thread tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AppHostTests.cs

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comment thread tests/CommunityToolkit.Aspire.Hosting.RavenDB.Tests/AppHostTests.cs Outdated
@Scooletz Scooletz marked this pull request as ready for review July 1, 2026 14:56
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.

RavenDB: Per-database "RavenDB Studio" links in the Aspire dashboard

2 participants