FEAT: macOS support #96

gargsaumya · 2025-06-23T04:31:42Z

This pull request includes significant changes to streamline the pipeline configuration and implement macOS-specific functionality for the MSSQL Python bindings. The most important changes involve removing redundant pipeline jobs, adding macOS-specific logic for handling SQLWCHAR strings, and introducing platform-agnostic code for driver handling.

Pipeline Configuration Updates:

Removed the PytestOnWindows job and its associated steps, including Python installation, LocalDB setup, test execution, and artifact publishing. This simplifies the pipeline and reduces redundancy.
Removed commented-out steps related to Colima-based Docker setup and SQL Server container initialization in the macOS job. These steps were unused and unnecessary.
Removed tasks for publishing test results and code coverage from the macOS job, aligning it with the streamlined pipeline approach.

macOS-Specific Enhancements:

Added macOS-specific logic for handling SQLWCHAR strings in connection.cpp, including buffer creation and null-termination to ensure compatibility with the ODBC driver.
Introduced macOS-specific headers and helper functions for string conversion in ddbc_bindings.h. These changes address differences in Unicode encoding between macOS and other platforms. [1] [2]

Platform-Agnostic Improvements:

Defined a platform-agnostic type for the driver handle (DriverHandle) and implemented a cross-platform function (GetFunctionPointer) to resolve function pointers from libraries. This ensures compatibility across Windows and macOS.
Modified the CMakeLists.txt file to comment out the macOS-specific source file block, indicating that only the standard source file is currently used.

Miscellaneous Updates:

Relaxed the MSVC warning level flags by removing the /WX option, which treats warnings as errors, to avoid build failures during development.

Checklist

Tests Passed (if applicable)

Copilot

Pull Request Overview

This PR adds macOS support by streamlining the CI pipeline and introducing macOS‐specific logic for handling SQLWCHAR strings in the MSSQL Python bindings. Key changes include updating header and source files with macOS-specific string conversion helpers, implementing a platform-agnostic driver handle and function pointer retrieval, and simplifying the CI pipeline by removing redundant Windows jobs and unused steps.

Reviewed Changes

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

File	Description
mssql_python/pybind/ddbc_bindings.h	Added macOS-specific headers, string conversion helper functions, and API changes.
mssql_python/pybind/connection/connection.cpp	Introduced macOS-specific connection string handling using a local buffer.
mssql_python/pybind/CMakeLists.txt	Updated the source file selection and removed the /WX flag from MSVC build options.
eng/pipelines/pr-validation-pipeline.yml	Removed unnecessary Windows-specific jobs and commented code for a streamlined macOS job.

Comments suppressed due to low confidence (1)

eng/pipelines/pr-validation-pipeline.yml:9

Review and remove any obsolete commented-out steps and jobs from the pipeline configuration to reduce noise and potential confusion.

jobs:

Copilot · 2025-06-23T04:32:08Z

mssql_python/pybind/CMakeLists.txt

+# if(APPLE)
+#     set(DDBC_SOURCE "ddbc_bindings_mac.cpp")
+#     message(STATUS "Using macOS-specific source file: ${DDBC_SOURCE}")
+#     # Only ddbc_bindings_mac.cpp is used on macOS
+#     # TODO: Implement smart pointer in macOS
+#     add_library(ddbc_bindings MODULE ${DDBC_SOURCE})
+# else()
    # This is just windows block
-    set(DDBC_SOURCE "ddbc_bindings.cpp")
-    message(STATUS "Using standard source file: ${DDBC_SOURCE}")
-    # Include connection module for Windows
-    add_library(ddbc_bindings MODULE ${DDBC_SOURCE} connection/connection.cpp connection/connection_pool.cpp)
-endif()
+set(DDBC_SOURCE "ddbc_bindings.cpp")
+message(STATUS "Using standard source file: ${DDBC_SOURCE}")
+# Include connection module for Windows
+add_library(ddbc_bindings MODULE ${DDBC_SOURCE} connection/connection.cpp connection/connection_pool.cpp)
+# endif()


Consider removing the commented-out macOS-specific source file block if it is no longer needed to improve clarity and maintainability.

mssql_python/pybind/ddbc_bindings.cpp

bewithgaurav · 2025-06-27T05:02:03Z

mssql_python/pybind/ddbc_bindings.cpp

+    fs::path primaryPath = fs::path(moduleDir) / "libs" / "macos" / runtimeArch / "lib" / "libmsodbcsql.18.dylib";
+    if (fs::exists(primaryPath)) {
+        driverPath = primaryPath;
+        LOG("macOS driver found at: {}", driverPath.string());


I am facing an issue w.r.t stdout logs while running main.py normally, if you see main.py sends out all these logs from ddbc bindings to stdout
I noticed that these logs are not showing up while we run main, actually raising this since I'm working on top of this branch for linux and got an issue with logs even in linux. checked macOS logs in latest pipeline run of this branch, and looks like they're not there - https://sqlclientdrivers.visualstudio.com/public/_build/results?buildId=118869&view=logs&j=bee890e9-c040-5cc9-d6a5-bdcb2ba73021&t=e9a69565-b417-5aac-952f-906672102243

Have you tried printing these directly to stdout. I have seen this issue with logger since quite sometime now, even on windows and I think we also have a work item related to this.

bewithgaurav · 2025-06-27T06:27:01Z

merging main here for comparison purposes with the linux PR #110

gargsaumya · 2025-07-01T06:12:39Z

Closing this PR. The mac support has been merged as part of following PRs:
#101
#102
#103

gargsaumya added 5 commits June 20, 2025 15:08

update macos-support

2b6dfd6

modify pipeline for mac

609a941

deleting ddbc for mac

629513b

testing commit new

dcff649

testing commit new again

017c075

Copilot AI review requested due to automatic review settings June 23, 2025 04:31

Copilot AI reviewed Jun 23, 2025

View reviewed changes

testing mac pipeline with main ddbc

725ceb9

gargsaumya force-pushed the saumya/mac branch from 647290e to 725ceb9 Compare June 23, 2025 04:35

fix mac compilation

49c5210

gargsaumya force-pushed the saumya/mac branch from 61ad8db to 49c5210 Compare June 23, 2025 05:18

main.py

c6d280b

gargsaumya force-pushed the saumya/mac branch 7 times, most recently from 1d8dc8c to 34bd339 Compare June 23, 2025 07:37

wstring fix in mac

e711459

gargsaumya force-pushed the saumya/mac branch from 34bd339 to e711459 Compare June 23, 2025 07:44

fix

f5f461d

gargsaumya force-pushed the saumya/mac branch 8 times, most recently from 9c3a89c to bd8b56c Compare June 23, 2025 11:18

gargsaumya force-pushed the saumya/mac branch 2 times, most recently from 8072499 to 6380f4a Compare June 23, 2025 11:28

fix

eab3234

gargsaumya force-pushed the saumya/mac branch from 6380f4a to eab3234 Compare June 23, 2025 11:43

PR cleanup

75c137a

github-advanced-security bot found potential problems Jun 25, 2025

View reviewed changes

mssql_python/pybind/ddbc_bindings.cpp Fixed Show fixed Hide fixed

gargsaumya added 4 commits June 25, 2025 10:55

fix banned c function

9d5581a

mac support

76a8fe6

mac support

5164ba5

mac support

e6bccff

bewithgaurav reviewed Jun 27, 2025

View reviewed changes

Merge branch 'main' into saumya/mac

742d4f0

gargsaumya closed this Jul 1, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

FEAT: macOS support #96

FEAT: macOS support #96

Uh oh!

gargsaumya commented Jun 23, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jun 23, 2025

Uh oh!

Uh oh!

bewithgaurav Jun 27, 2025

Uh oh!

gargsaumya Jun 27, 2025 •

edited

Loading

Uh oh!

bewithgaurav commented Jun 27, 2025 •

edited

Loading

Uh oh!

gargsaumya commented Jul 1, 2025

Uh oh!

Uh oh!

FEAT: macOS support #96

FEAT: macOS support #96

Uh oh!

Conversation

gargsaumya commented Jun 23, 2025

Pipeline Configuration Updates:

macOS-Specific Enhancements:

Platform-Agnostic Improvements:

Miscellaneous Updates:

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bewithgaurav Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

gargsaumya Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bewithgaurav commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gargsaumya commented Jul 1, 2025

Uh oh!

Uh oh!

gargsaumya Jun 27, 2025 •

edited

Loading

bewithgaurav commented Jun 27, 2025 •

edited

Loading