Blackrock: Added QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag in connection #2618

divang · 2025-02-27T11:55:02Z

Moved the QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag setting in initResettableValues() method to handle the resetting of QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag for both - new and pooled connection.

…in initResettableValues() method to handle it in pooled connection too

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java

… and CONCAT_NULL_YIELDS_NULL

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java

lilgreenbird

there are formatting issues, looks like the formatter wasn't run

…YIELDS_NULL flag

codecov · 2025-02-28T17:14:02Z

Codecov Report

Attention: Patch coverage is 67.21311% with 20 lines in your changes missing coverage. Please review.

Project coverage is 51.53%. Comparing base (7e795d4) to head (4e7192a).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
.../com/microsoft/sqlserver/jdbc/SQLServerDriver.java	67.74%	8 Missing and 2 partials ⚠️
.../microsoft/sqlserver/jdbc/SQLServerConnection.java	63.15%	5 Missing and 2 partials ⚠️
.../microsoft/sqlserver/jdbc/SQLServerDataSource.java	72.72%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2618      +/-   ##
============================================
- Coverage     51.54%   51.53%   -0.01%     
- Complexity     3996     3997       +1     
============================================
  Files           147      147              
  Lines         33694    33756      +62     
  Branches       5630     5639       +9     
============================================
+ Hits          17366    17397      +31     
- Misses        13877    13905      +28     
- Partials       2451     2454       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…EFAULTS=ON on LOGIN7 call and CONCAT_NULL_YIELDS_NULL/QUOTED_IDENTIFIER are set ON by default.

…s are not supplied (server default case)

… value for new and pooled connection

microsoft-github-policy-service · 2025-03-04T09:07:46Z

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

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

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

David-Engel · 2025-03-21T22:35:39Z

src/test/java/com/microsoft/sqlserver/jdbc/SQLServerConnectionTest.java

+        ds.setConcatNullYieldsNull("OFF");
+        int expectedResultForNewConnection = 0;
+        // Server default is CONCAT_NULL_YIELDS_NULL = ON  
+        int expectedResultForPooledConnection = 1;


When we set concat null yields null to OFF, the expected result == 0 for all connections, even pooled connections. If that's not happening, we need to figure out what's not working correctly in the implementation so it can be fixed.

David-Engel · 2025-03-21T22:38:01Z

src/test/java/com/microsoft/sqlserver/jdbc/SQLServerConnectionTest.java

+        try (Connection con = ds.getConnection(); Statement stmt = con.createStatement()) {
+            try (ResultSet rs = stmt.executeQuery(sqlSelect)) {
+                if (rs.next()) {
+                    assertEquals(expectedResultForNewConnection, rs.getInt(1));
+                } else {
+                    assertTrue(false, "Expected row of data was not found.");
+                }
+            }
+        }


I'd extract this out into a helper that takes a Connection object so you don't have to duplicate this code so much.

David-Engel · 2025-03-21T22:41:43Z

src/test/java/com/microsoft/sqlserver/jdbc/SQLServerConnectionTest.java

+         try (Connection con = pc.getConnection(); Statement statement = con.createStatement()) {
+             try (ResultSet rs = statement.executeQuery(sqlSelect)) {
+                 if (rs.next()) {
+                     assertEquals(expectedResultForNewConnection, rs.getInt(1));
+                 } else {
+                     assertTrue(false, "Expected row of data was not found.");
+                 }
+             }
+         }
+         // Repeat getConnection to put the physical connection through a RESETCONNECTION
+         try (Connection con = pc.getConnection(); Statement statement = con.createStatement()) {
+             try (ResultSet rs = statement.executeQuery(sqlSelect)) {
+                 if (rs.next()) {
+                     assertEquals(expectedResultForPooledConnection, rs.getInt(1));
+                 } else {
+                     assertTrue(false, "Expected row of data was not found.");
+                 }
+             }
+         }


Nit: Indentation for this block needs to be fixed.

David-Engel · 2025-03-21T22:43:56Z

src/test/java/com/microsoft/sqlserver/jdbc/SQLServerConnectionTest.java

+     * @throws SQLException
+     */
+    @Test
+    public void testConcatNullYieldsNull() throws SQLException {


High level: Both of these new tests should also test "ON" for each setting.

lilgreenbird and others added 9 commits November 13, 2024 12:34

add props

9bc117c

add test

a93cfae

change default

c3e8fed

change to use executeQuery

c24c9e7

change default

e530011

update test

70d0f96

Deadlock and null TDSCommand counter fix

29a12c9

Moved the QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag setting …

90a1d0e

…in initResettableValues() method to handle it in pooled connection too

Merged from main branch

8d7f987

github-project-automation bot moved this to In progress in MSSQL JDBC Feb 27, 2025

github-project-automation bot added this to MSSQL JDBC Feb 27, 2025

David-Engel reviewed Feb 27, 2025

View reviewed changes

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java Outdated Show resolved Hide resolved

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java Outdated Show resolved Hide resolved

David-Engel reviewed Feb 27, 2025

View reviewed changes

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java Outdated Show resolved Hide resolved

Removed the default Flag setting call to server for QUOTED_IDENTIFIER…

cf9ea3a

… and CONCAT_NULL_YIELDS_NULL

lilgreenbird reviewed Feb 28, 2025

View reviewed changes

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java Outdated Show resolved Hide resolved

lilgreenbird suggested changes Feb 28, 2025

View reviewed changes

Divang Sharma added 2 commits February 28, 2025 22:07

Added one more state - NOT_SET for QUOTED_IDENTIFIER and CONCAT_NULL_…

1b333c0

…YIELDS_NULL flag

Fixed setCustomFlags to set correct state of a flag

bb41fb6

Divang Sharma added 3 commits March 3, 2025 19:50

Reverted defaultFlagSet method. It is not required. Server set ANSI_D…

bfad8d7

…EFAULTS=ON on LOGIN7 call and CONCAT_NULL_YIELDS_NULL/QUOTED_IDENTIFIER are set ON by default.

Optimized the code for QUOTED_IDENTIFIER/CONCAT_NULL_YIELDS_NULL flag…

e3d0cf2

…s are not supplied (server default case)

Added test cases for QUOTED_IDENTIFIER/CONCAT_NULL_YIELDS_NULL flags'…

4e7192a

… value for new and pooled connection

divang changed the title ~~Blackrock: Moved the QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag setting in initResettableValues()~~ Blackrock: Added QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag in connection Mar 4, 2025

Jeffery-Wasty moved this from In progress to Under Peer Review in MSSQL JDBC Mar 4, 2025

David-Engel reviewed Mar 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Blackrock: Added QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag in connection #2618

Blackrock: Added QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag in connection #2618

divang commented Feb 27, 2025

lilgreenbird left a comment

codecov bot commented Feb 28, 2025 •

edited

Loading

microsoft-github-policy-service bot commented Mar 4, 2025

Contribution License Agreement

David-Engel Mar 21, 2025

David-Engel Mar 21, 2025

David-Engel Mar 21, 2025

David-Engel Mar 21, 2025

Blackrock: Added QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag in connection #2618

Are you sure you want to change the base?

Blackrock: Added QUOTED_IDENTIFIER and CONCAT_NULL_YIELDS_NULL flag in connection #2618

Conversation

divang commented Feb 27, 2025

lilgreenbird left a comment

Choose a reason for hiding this comment

codecov bot commented Feb 28, 2025 • edited Loading

Codecov Report

microsoft-github-policy-service bot commented Mar 4, 2025

Contribution License Agreement

David-Engel Mar 21, 2025

Choose a reason for hiding this comment

David-Engel Mar 21, 2025

Choose a reason for hiding this comment

David-Engel Mar 21, 2025

Choose a reason for hiding this comment

David-Engel Mar 21, 2025

Choose a reason for hiding this comment

codecov bot commented Feb 28, 2025 •

edited

Loading