Skip to content

Conversation

paulmedynski
Copy link
Contributor

@paulmedynski paulmedynski commented Aug 5, 2025

  • Adhere to strict CodeQL suppression format.

@paulmedynski paulmedynski added this to the 7.0-preview1 milestone Aug 5, 2025
@Copilot Copilot AI review requested due to automatic review settings August 5, 2025 14:54
@paulmedynski paulmedynski requested a review from a team as a code owner August 5, 2025 14:54
Copy link
Contributor

@Copilot 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 PR adds a CodeQL suppression comment to address a security analysis warning about DefaultAzureCredential instantiation in production code. The change restructures the comment placement to comply with CodeQL's requirement that suppression comments appear on the same line as the flagged code.

  • Moved CodeQL suppression comment to the same line as the DefaultAzureCredential instantiation
  • Added explanatory documentation about CodeQL suppression placement requirements
  • Split the credential instantiation and return statement for better code organization
Comments suppressed due to low confidence (1)

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ActiveDirectoryAuthenticationProvider.cs:599

  • The variable name 'cred' is too abbreviated and unclear. Consider using a more descriptive name like 'credential' or 'azureCredential' to improve code readability.
                DefaultAzureCredential cred = new(defaultAzureCredentialOptions); // CodeQL [SM05137] See above for justification.

- Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.
- Adding catch for macOS socket error to log and ignore.
Copy link

codecov bot commented Aug 6, 2025

Codecov Report

❌ Patch coverage is 28.57143% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 64.58%. Comparing base (18becfe) to head (40359b1).
⚠️ Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
.../Data/SqlClient/ManagedSni/SniTcpHandle.netcore.cs 16.66% 10 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3542      +/-   ##
==========================================
+ Coverage   60.32%   64.58%   +4.25%     
==========================================
  Files         270      270              
  Lines       62098    62110      +12     
==========================================
+ Hits        37463    40113    +2650     
+ Misses      24635    21997    -2638     
Flag Coverage Δ
netcore 67.85% <28.57%> (+5.70%) ⬆️
netfx 64.47% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cheenamalhotra
Copy link
Member

This will be back-ported to release branches as well?

@paulmedynski
Copy link
Contributor Author

Yes, we can backport for the ReceiveTimeout change. The CodeQL part is benign on non-default branches AFAIK.

@paulmedynski paulmedynski merged commit 55cc333 into main Aug 7, 2025
237 checks passed
@paulmedynski paulmedynski deleted the dev/paul/codeql branch August 7, 2025 18:18
paulmedynski added a commit that referenced this pull request Aug 8, 2025
…3542)

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adding catch for macOS socket error to log and ignore.
paulmedynski added a commit that referenced this pull request Aug 8, 2025
…3542)

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adding catch for macOS socket error to log and ignore.
cheenamalhotra pushed a commit that referenced this pull request Aug 11, 2025
…3542) (#3550)

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adding catch for macOS socket error to log and ignore.
cheenamalhotra pushed a commit that referenced this pull request Aug 12, 2025
… CI failures (#3551)

* Add CodeQL suppression for DefaultAzureCredential use in Production (#3542)

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.

* Task 37261: [S360] [SM05137] DefaultAzureCredential use in Production

- Adding catch for macOS socket error to log and ignore.

* Fixed SniTcpHandle -> SNITCPHandle class case difference.
paulmedynski added a commit that referenced this pull request Sep 8, 2025
…3542)

  - Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.
  - Adding catch for macOS socket error to log and ignore.
paulmedynski added a commit that referenced this pull request Sep 8, 2025
…3542)

  - Adjusted CodeQL suppression to meet the strict requirements of where it may appear relative to the flagged code.
  - Adding catch for macOS socket error to log and ignore.
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.

4 participants