Fix Object Explorer mislabeling Columnstore Indexes as Clustered/Non-Clustered

[Sahil Kulhar (Cy-nape)]

What

Object Explorer was labeling Clustered and Nonclustered Columnstore Indexes identically to regular clustered/non-clustered indexes, since IndexCustomeNodeHelper.GetCustomLabel only checked Index.IsClustered
and never Index.IndexType.

Fixes microsoft/vscode-mssql#22713

Change

• Added IndexType checks for the two columnstore variants
• Extracted the label logic into BuildIndexLabel(name, isUnique, isClustered, indexType) — a pure function, independently testable without a live SQL connection
• Added new localized strings: "Clustered Columnstore" / "Nonclustered Columnstore"
• Existing behavior for all non-columnstore index types is unchanged (verified by regression tests below)

Testing

Added IndexCustomeNodeHelperTests.cs — 4 unit tests covering:

• Clustered Columnstore label
• Nonclustered Columnstore label
• Regression: standard clustered index still labels correctly
• Regression: standard non-clustered index still labels correctly

All 4 pass locally; full SqlCore build succeeds.

[Copilot]

Pull request overview

Fixes Object Explorer index labeling so clustered/nonclustered columnstore indexes are no longer displayed as regular clustered/non-clustered indexes by incorporating IndexType into the label construction, adding the necessary localized strings, and introducing unit tests around a new pure label-building helper.

Changes:

• Refactors index label creation into IndexCustomeNodeHelper.BuildIndexLabel(...) and adds IndexType-based handling for clustered/nonclustered columnstore indexes.
• Adds localized resource entries for “Clustered Columnstore” and “Nonclustered Columnstore”.
• Adds unit tests covering both columnstore variants plus regression cases for regular clustered/non-clustered indexes.

Reviewed changes

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

Show a summary per file

File	Description
test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs	Adds unit tests for the extracted index label builder and columnstore cases.
src/Microsoft.SqlTools.SqlCore/ObjectExplorer/SmoModel/SmoKeyCustomNode.cs	Implements BuildIndexLabel and adds IndexType checks for columnstore index labeling.
src/Microsoft.SqlTools.SqlCore/Localization/sr.strings	Adds new resource keys for columnstore index label parts.
src/Microsoft.SqlTools.SqlCore/Localization/sr.resx	Adds localized string values for the new columnstore label parts.
src/Microsoft.SqlTools.SqlCore/Localization/sr.cs	Updates generated resource accessor keys/properties to include the new strings.

Suppressed comments (4)

src/Microsoft.SqlTools.SqlCore/Localization/sr.resx:875

• This newly added .resx entry is mis-indented compared to the surrounding resource nodes. Align the / indentation with the rest of the file for consistency.

  <data name="NonClusteredColumnStoreIndex_LabelPart" xml:space="preserve">
  <value>Nonclustered Columnstore</value>
  <comment></comment>
  </data>

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:27

• This assertion hard-codes English resource text even though BuildIndexLabel uses localized SR strings. Build the expected value from SR parts so the test stays stable across cultures and resource updates.

            Assert.That(label, Is.EqualTo("IX_Test_NCCS (Non-Unique, Nonclustered Columnstore)"));

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:34

• This assertion hard-codes English resource text even though BuildIndexLabel uses localized SR strings. Use SR label parts in the expected string to avoid culture-dependent test failures.

            Assert.That(label, Is.EqualTo("IX_Test_Regular (Unique, Clustered)"));

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:41

• This assertion hard-codes English resource text even though BuildIndexLabel uses localized SR strings. Use SR label parts in the expected string to avoid culture-dependent test failures.

            Assert.That(label, Is.EqualTo("IX_Test_Regular2 (Non-Unique, Non-Clustered)"));

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Sahil Kulhar (Cy-nape)]

Aasim Khan (@aasimkhan30) PR is up! Thanks for confirming this belonged in sqltoolsservice rather than vscode-mssql — saved me from chasing it in the wrong repo. Would appreciate a review whenever you get a chance.

[Sahil Kulhar (Cy-nape)]

Sahil Kulhar (Sahil Kulhar (@Cy-nape)) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-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.

@microsoft-github-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.

@microsoft-github-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 Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft 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 Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft 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.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, 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.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, 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.
• 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 Microsoft. You agree to notify Microsoft 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 Microsoft.

@microsoft-github-policy-service agree

[Aasim Khan (aasimkhan30)]

Sahil Kulhar (@Cy-nape) please fix the copilot review comments.

[Copilot]

🟡 Changes recommended

The new unit tests currently contain a C# compile error (positional argument after named arguments), and there’s a likely missing SMO property prefetch for IndexType that can impact correctness/performance at runtime.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (4)

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:26

• These calls mix named and positional arguments (a positional argument after named ones), which is a C# compile error. Name the final parameter (indexType) or make all arguments positional.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_NCCS", isUnique: false, isClustered: false, IndexType.NonClusteredColumnStoreIndex);

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:33

• These calls mix named and positional arguments (a positional argument after named ones), which is a C# compile error. Name the final parameter (indexType) or make all arguments positional.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular", isUnique: true, isClustered: true, IndexType.ClusteredIndex);

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:40

• These calls mix named and positional arguments (a positional argument after named ones), which is a C# compile error. Name the final parameter (indexType) or make all arguments positional.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular2", isUnique: false, isClustered: false, IndexType.NonClusteredIndex);

src/Microsoft.SqlTools.SqlCore/Localization/sr.resx:875

• The new resx entry is inconsistently indented versus the surrounding entries, which tends to cause noisy diffs when tooling auto-formats the .resx file later.

  <data name="NonClusteredColumnStoreIndex_LabelPart" xml:space="preserve">
  <value>Nonclustered Columnstore</value>
  <comment></comment>
  </data>

• Files reviewed: 5/5 changed files
• Comments generated: 2
• Review effort level: Lite

[Copilot]

🟡 Changes recommended

The newly added unit tests won’t compile due to mixing named and positional arguments in BuildIndexLabel(...) calls.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (4)

Previously missed (2) — in code that hasn't changed since the last review.

src/Microsoft.SqlTools.SqlCore/Localization/sr.cs:1506

• There are trailing spaces after this closing brace. With code style enforced in build, it’s best to avoid introducing trailing whitespace in committed files.
  src/Microsoft.SqlTools.SqlCore/Localization/sr.resx:875
• The new NonClusteredColumnStoreIndex_LabelPart entry is formatted inconsistently compared to the surrounding resx entries (indentation). Keeping the standard formatting reduces churn and merge conflicts when resources are updated/generated.

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:33

• This call mixes named and positional arguments; positional arguments cannot appear after named arguments, so this test won’t compile. Name the last parameter (indexType) or make all arguments positional.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular", isUnique: true, isClustered: true, IndexType.ClusteredIndex);

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:40

• This call mixes named and positional arguments; positional arguments cannot appear after named arguments, so this test won’t compile. Name the last parameter (indexType) or make all arguments positional.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular2", isUnique: false, isClustered: false, IndexType.NonClusteredIndex);

• Files reviewed: 5/5 changed files
• Comments generated: 1
• Review effort level: Lite

[Copilot]

🟡 Changes recommended

The new unit tests contain C# argument syntax that won’t compile (positional args after named args), blocking the build.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (5)

Previously missed (1) — in code that hasn't changed since the last review.

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:20

• The expected label is hard-coded in English, but BuildIndexLabel uses localized SR values. Building the expected string from the same SR parts will keep the test culture/locale-independent (consistent with other ObjectExplorer tests that assert SR-based labels).

This issue also appears in the following locations of the same file:

• line 27
• line 34
• line 41

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:40

• This call mixes named and positional arguments; C# disallows positional arguments after named ones, so this test won't compile. Make the final argument named (or make all arguments positional).

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular2", isUnique: false, isClustered: false, IndexType.NonClusteredIndex);

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:34

• The expected label is hard-coded in English, but BuildIndexLabel uses localized SR values. Building the expected string from the same SR parts will keep the test culture/locale-independent (consistent with other ObjectExplorer tests that assert SR-based labels).

            Assert.That(label, Is.EqualTo("IX_Test_Regular (Unique, Clustered)"));

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:41

• The expected label is hard-coded in English, but BuildIndexLabel uses localized SR values. Building the expected string from the same SR parts will keep the test culture/locale-independent (consistent with other ObjectExplorer tests that assert SR-based labels).

            Assert.That(label, Is.EqualTo("IX_Test_Regular2 (Non-Unique, Non-Clustered)"));

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:27

• The expected label is hard-coded in English, but BuildIndexLabel uses localized SR values. Building the expected string from the same SR parts will keep the test culture/locale-independent (consistent with other ObjectExplorer tests that assert SR-based labels).

            Assert.That(label, Is.EqualTo("IX_Test_NCCS (Non-Unique, Nonclustered Columnstore)"));

• Files reviewed: 5/5 changed files
• Comments generated: 2
• Review effort level: Lite

[Copilot]

🟡 Changes recommended

The new unit tests currently won’t compile due to named/positional argument ordering, and the updated .resx includes inconsistent line-ending characters on newly added lines.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:40

• This test call mixes named arguments with a positional argument at the end. In C#, positional arguments cannot follow named arguments, so this will not compile.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular2", isUnique: false, isClustered: false, IndexType.NonClusteredIndex);

• Files reviewed: 5/5 changed files
• Comments generated: 2
• Review effort level: Lite

[Copilot]

🔵 Needs a closer look

The newly added unit test file contains a C# compilation error (named + positional argument mix) that will break the build.

Review details

Suppressed comments (2)

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/IndexCustomeNodeHelperTests.cs:40

• This call mixes named arguments with a trailing positional argument, which is a C# compile error (positional arguments cannot follow named arguments). Pass the last argument using the indexType: name as well.

            string label = IndexCustomeNodeHelper.BuildIndexLabel("IX_Test_Regular2", isUnique: false, isClustered: false, IndexType.NonClusteredIndex);

src/Microsoft.SqlTools.SqlCore/Localization/sr.cs:1507

• There are trailing spaces after the closing brace on this line, which creates noisy diffs and can violate whitespace/style checks depending on editorconfig settings. Remove the extra whitespace.

        public static string NonClusteredColumnStoreIndex_LabelPart
        {
            get { return Keys.GetString(Keys.NonClusteredColumnStoreIndex_LabelPart); }
        }   

• Files reviewed: 5/5 changed files
• Comments generated: 0 new
• Review effort level: Lite

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.