fix: display shard key in collection tooltip

[lte-z]

Fixes #661

Changes

This PR exposes shard key information for sharded collections in the tree view tooltip.

• Extended CollectionItemModel to include optional shardKey field
• Extracted shard key from MongoDB listCollections() response in ClustersClient
• Rendered shard key in CollectionItem tooltip when present
• Added localization entry for "Shard Key"

Behavior

• Sharded collections now display their shard key in tooltip, e.g.:

Database: my-database
Documents: 5.2k
Shard Key: { userId: "hashed" }

• Non-sharded collections are unaffected (no shard key section shown)

Notes

• Handles missing or undefined shard key safely
• Supports both numeric (1) and hashed shard key formats

[lte-z]

@microsoft-github-policy-service agree

[Copilot]

Pull request overview

Exposes sharding metadata in the DocumentDB tree UI by preserving the shard key from listCollections() and rendering it in the collection tooltip.

Changes:

• Extend CollectionItemModel with an optional shardKey property populated from listCollections() results.
• Update CollectionItem tooltip to conditionally display shard key details when present.
• Add localization string for “Shard Key”.

Reviewed changes

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

File	Description
src/tree/documentdb/CollectionItem.ts	Adds shard key section to the collection tooltip.
src/documentdb/ClustersClient.ts	Extracts and stores shard key from listCollections() into the collection model.
l10n/bundle.l10n.json	Adds localized string entry for “Shard Key”.

[tnaum-ms]

@lte-z Thank you for your contribution and for addressing Copilot review. I'll review your PR tomorrow.

[tnaum-ms]

I pushed one follow-up commit on top of yours.

What changed: The shard key entries are now each wrapped in their own inline code span instead of being joined into a single one. So a two-key shard key renders as:

userId: 1, tenantId: "hashed"

Why: The original code applied escapeMarkdown to key and value strings before placing them inside a backtick code span. Inside a code span the Markdown renderer never interprets special characters, so the escape backslashes were rendered literally (e.g. user\_id showed up as user\_id with a visible backslash). Wrapping each entry in its own code span removes the need for escaping entirely and also makes multi-key shard keys easier to scan.

[tnaum-ms]

Hey @lte-z, thanks for not just one, but the three PRs (#670, #674, #679) focused and quality contributions.

I'll have to work on the badges I use :)

[lte-z]

Thank you so much for the warm welcome and for merging this!

I also appreciate the follow-up commit and the explanation about the inline code spans. That makes sense to me now, especially for shard keys with underscores or multiple fields.

And thank you for the kind words about the three PRs. I’m really glad they were helpful, and I’d be happy to keep contributing to vscode-documentdb 🙂