Skip to content

Conversation

@priyankatiwari08
Copy link
Contributor

Description

This Pull Request addresses issue #3716 by introducing a null check for systemParams, which stores the system-level parameters for SQL RPC (Remote Procedure Call) operations. In batch scenarios, certain SQL RPC calls may not include system parameters, and this change ensures proper handling in such cases.

Issues

#3716

@priyankatiwari08 priyankatiwari08 requested a review from a team as a code owner November 6, 2025 17:37
Copilot AI review requested due to automatic review settings November 6, 2025 17:37
Copy link
Contributor

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 pull request adds a null check for systemParams before accessing its Length property in the parameter encryption metadata retrieval logic. This defensive programming change prevents a potential NullReferenceException when processing RPC batch commands.

Key Changes

  • Added null check for _RPCList[i].systemParams before accessing its Length property in TryFetchInputParameterEncryptionInfo method
Comments suppressed due to low confidence (1)

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.Encryption.cs:1296

  • The added null check for systemParams lacks test coverage. Based on the code analysis, systemParams is initialized through GetRPCObject() which always allocates and initializes the array when systemParamCount > 0. However, a newly constructed _SqlRPC object (as seen in AddBatchCommand line 21) has systemParams initially null. A test case should be added that exercises the batch RPC mode encryption path with an RPC object that has not yet had its systemParams initialized to verify this defensive check works correctly.
                    if (_RPCList[i].systemParams != null && _RPCList[i].systemParams.Length > 1)

Copy link
Contributor

@paulmedynski paulmedynski left a comment

Choose a reason for hiding this comment

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

Need some tests for this.

@paulmedynski paulmedynski self-assigned this Nov 6, 2025
Copy link
Contributor

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

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

Copy link
Contributor

@apoorvdeshmukh apoorvdeshmukh left a comment

Choose a reason for hiding this comment

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

There are build failures while compiling the tests.

…SqlClient.ManualTesting.Tests.csproj

Co-authored-by: Copilot <[email protected]>
Copilot AI review requested due to automatic review settings November 11, 2025 17:14
Copilot finished reviewing on behalf of priyankatiwari08 November 11, 2025 17:18
Copy link
Contributor

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

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

// Mutate values for update
MutateForUpdate(dataTable);

// Act - This is where NullReferenceException was being thrown previously(which is now fixed)
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

Missing space after 'previously' in the comment.

Suggested change
// Act - This is where NullReferenceException was being thrown previously(which is now fixed)
// Act - This is where NullReferenceException was being thrown previously (which is now fixed)

Copilot uses AI. Check for mistakes.
@apoorvdeshmukh apoorvdeshmukh self-assigned this Nov 11, 2025
Copy link
Contributor

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

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

…/SqlDataAdapterBatchUpdateTests.cs

Co-authored-by: Copilot <[email protected]>
Copilot finished reviewing on behalf of priyankatiwari08 November 18, 2025 18:20
Copy link
Contributor

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

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

…/SqlDataAdapterBatchUpdateTests.cs

Co-authored-by: Copilot <[email protected]>
Copilot AI review requested due to automatic review settings November 18, 2025 18:23
Copilot finished reviewing on behalf of priyankatiwari08 November 18, 2025 18:25
Copy link
Contributor

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

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

Copy link
Contributor

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

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

{
using var connection = new SqlConnection(GetOpenConnectionString(connectionString, encryptionEnabled: true));
connection.Open();
SilentRunCommand($@"TRUNCATE TABLE [dbo].[{SqlCommandHelper.EscapeIdentifier(tableNames[tableName])}]", connection);
Copy link

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

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

The SqlCommandHelper class does not exist in the codebase. The correct class to use is SqlServerEscapeHelper which is available in the Microsoft.Data.SqlClient namespace.

Replace SqlCommandHelper.EscapeIdentifier with SqlServerEscapeHelper.EscapeIdentifier.

Copilot uses AI. Check for mistakes.
foreach (var (id, s1, s2) in rows)
{
using var cmd = new SqlCommand(
$@"INSERT INTO [dbo].[{SqlCommandHelper.EscapeIdentifier(tableNames[tableName])}] (BuyerSellerID, SSN1, SSN2) VALUES (@id, @s1, @s2)",
Copy link

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

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

The SqlCommandHelper class does not exist in the codebase. The correct class to use is SqlServerEscapeHelper which is available in the Microsoft.Data.SqlClient namespace.

Replace SqlCommandHelper.EscapeIdentifier with SqlServerEscapeHelper.EscapeIdentifier.

Copilot uses AI. Check for mistakes.
{
using var connection = new SqlConnection(GetOpenConnectionString(connectionString, encryptionEnabled: true));
connection.Open();
SilentRunCommand($"DELETE FROM [dbo].[{SqlCommandHelper.EscapeIdentifier(tableNames["BuyerSeller"])}]", connection);
Copy link

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

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

The SqlCommandHelper class does not exist in the codebase. The correct class to use is SqlServerEscapeHelper which is available in the Microsoft.Data.SqlClient namespace.

Replace SqlCommandHelper.EscapeIdentifier with SqlServerEscapeHelper.EscapeIdentifier.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

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

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

@cheenamalhotra cheenamalhotra removed the P1 label Nov 21, 2025
@dotnet-policy-service
Copy link

@priyankatiwari08 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.

…apterIssue

r Please enter a commit message to explain why this merge is necessary,
Merging with main
Copilot AI review requested due to automatic review settings December 2, 2025 10:44
Copilot finished reviewing on behalf of priyankatiwari08 December 2, 2025 10:48
Copy link
Contributor

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

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

Comment on lines +24 to +26
// Provide table names to mirror repo patterns.
// If your fixture already exposes specific names for BuyerSeller and procs, wire them here.
// Otherwise use literal names as below.
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

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

The comment states "Provide table names to mirror repo patterns" but the test is creating its own hardcoded table names that don't exist in the fixture. This comment is misleading as it suggests the fixture provides these names, when it doesn't.

Consider updating the comment to clarify that these are test-specific table names that need to be created, or better yet, define these as constants or properties in the fixture.

Suggested change
// Provide table names to mirror repo patterns.
// If your fixture already exposes specific names for BuyerSeller and procs, wire them here.
// Otherwise use literal names as below.
// The following are test-specific table and procedure names required for these tests.
// The fixture does not provide these names; they must be created and managed within the test.
// For better maintainability, consider defining these as constants or exposing them via the fixture.

Copilot uses AI. Check for mistakes.
Comment on lines +58 to +63
// Act - With batch updates (UpdateBatchSize > 1), this previously threw NullReferenceException due to null systemParams in batch RPC mode
var updated = await Task.Run(() => adapter.Update(dataTable));

// Assert
Assert.Equal(dataTable.Rows.Count, updated);

Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

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

The test does not verify that the data was actually updated in the database after the adapter.Update() call. It only checks that the number of rows updated matches the expected count, but doesn't confirm that the values were correctly persisted.

Consider adding an assertion that queries the database after the update and verifies the actual values match the expected mutated values (e.g., using LoadCurrentRowsIntoDataTable on a fresh DataTable and comparing values).

Copilot uses AI. Check for mistakes.
Comment on lines +88 to +92
// Act (should not throw)
var updatedRows = await Task.Run(() => adapter.Update(dataTable));

// Assert
Assert.Equal(dataTable.Rows.Count, updatedRows);
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

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

The test does not verify that the data was actually updated in the database after the adapter.Update() call. It only checks that the number of rows updated matches the expected count, but doesn't confirm that the values were correctly persisted.

Consider adding an assertion that queries the database after the update and verifies the actual values match the expected mutated values.

Copilot uses AI. Check for mistakes.
Comment on lines +160 to +166
var fixedTime = new DateTime(2023, 01, 01, 12, 34, 56); // Use any fixed value
string timeStr = fixedTime.ToString("HHmm");
foreach (DataRow row in dt.Rows)
{
i++;
row["SSN1"] = $"{i:000}-11-{timeStr}";
row["SSN2"] = $"{i:000}-22-{timeStr}";
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

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

[nitpick] The fixedTime variable is commented as "Use any fixed value" but this appears to be unnecessarily complex. The mutation logic only needs to generate unique values for each row, and the timestamp-based suffix adds unnecessary complexity.

Consider simplifying this to just use the row index or a simple counter to generate unique test values, e.g., row["SSN1"] = $"{i:000}-11-1234";

Suggested change
var fixedTime = new DateTime(2023, 01, 01, 12, 34, 56); // Use any fixed value
string timeStr = fixedTime.ToString("HHmm");
foreach (DataRow row in dt.Rows)
{
i++;
row["SSN1"] = $"{i:000}-11-{timeStr}";
row["SSN2"] = $"{i:000}-22-{timeStr}";
foreach (DataRow row in dt.Rows)
{
i++;
row["SSN1"] = $"{i:000}-11-1234";
row["SSN2"] = $"{i:000}-22-1234";

Copilot uses AI. Check for mistakes.
Comment on lines +227 to +242
// Only swallow "object does not exist" (error 208), log others
bool onlyObjectNotExist = true;
foreach (SqlError err in ex.Errors)
{
if (err.Number != 208)
{
onlyObjectNotExist = false;
break;
}
}
if (!onlyObjectNotExist)
{
Console.WriteLine($"SilentRunCommand: Unexpected SqlException during cleanup: {ex}");
}
// Swallow all exceptions, but log unexpected ones
}
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

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

The comment "Only swallow 'object does not exist' (error 208), log others" at line 227 is misleading. The code actually swallows all exceptions (line 242: "Swallow all exceptions, but log unexpected ones"), not just error 208. The check for error 208 only affects whether the exception is logged to console, but all exceptions are still caught and ignored.

Consider clarifying the comment to accurately reflect the behavior, or better yet, rethrow non-208 errors instead of just logging them to ensure unexpected cleanup failures are visible.

Copilot uses AI. Check for mistakes.
Comment on lines +27 to +29
tableNames["BuyerSeller"] = "BuyerSeller";
tableNames["ProcInsertBuyerSeller"] = "InsertBuyerSeller";
tableNames["ProcUpdateBuyerSeller"] = "UpdateBuyerSeller";
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

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

The BuyerSeller table and associated stored procedures (InsertBuyerSeller, UpdateBuyerSeller) referenced in this test are not created by the SQLSetupStrategyCertStoreProvider fixture.

The fixture's CreateTables method (defined in the base SQLSetupStrategy class) does not include the creation of these database objects, which means these tests will fail when executed because the table and stored procedures don't exist in the test database.

To fix this, you should either:

  1. Add the BuyerSeller table and stored procedure creation to the SQLSetupStrategyCertStoreProvider.SetupDatabase() method or the base CreateTables() method, similar to how other test tables like ApiTestTable are created.
  2. Create a dedicated table class like BuyerSellerTable in the AlwaysEncrypted/TestFixtures/Setup/ directory that implements the ICreatable and IDroppable interfaces.

Copilot uses AI. Check for mistakes.
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.

5 participants