LibArrow in Contrib is missing Debug libs

[cbielow]

When Arrow is build via contrib the Release and Debug libs are created in their respective subfolders, e.g.
C:\dev\contrib\build\src\arrow-apache-arrow-23.0.0\cpp\src\arrow\arrow_array_static.dir\Debug\arrow_array_static.lib
and
C:\dev\contrib\build\src\arrow-apache-arrow-23.0.0\cpp\src\arrow\arrow_array_static.dir\Release\arrow_array_static.lib

Since both versions have the same name, only one of them ends up in contrib/build/lib.
When compiling, MSVC complains that it cannot use the release arrow lib when building OpenMS in Debug mode
e.g.
mismatch detected for '_ITERATOR_DEBUG_LEVEL': value '0' doesn't match value '2' in MockImplementation.obj

Fix: provide a arrow_array_staticd.lib version, I guess. This is required for all arrow-related libs (parquet_static.lib, arrow_bundled_dependencies.lib, ...)

[coderabbitai]

🔗 Related PRs

OpenMS/OpenMS#8091 - Arrow Integration + Test in CI [merged]
OpenMS/OpenMS#8283 - windlls [merged]
OpenMS/OpenMS#8988 - fix Windows non-Arrow build [merged]

---

📝 Issue Planner

_{Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.}

✅ Successfully generated implementation plan.

💡 Use @coderabbitai <feedback> to replan

---

🧪 Issue enrichment is currently in open beta.

You can configure auto-planning by selecting labels in the issue_enrichment configuration.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!

[coderabbitai]

Coding Plan

Summary

• The fix centers on adding -DCMAKE_DEBUG_POSTFIX=d to Arrow's CMake configuration in the contrib repository's libraries.cmake/arrow.cmake
• This leverages standard CMake multi-configuration library naming rather than custom patching or renaming logic
• Arrow's CMake export infrastructure will automatically generate target files with correct IMPORTED_LOCATION_DEBUG/IMPORTED_LOCATION_RELEASE properties
• The OpenMS main repository requires no modifications – its existing find_package(Arrow CONFIG) approach will automatically consume the correctly-named libraries per build configuration

Design Choices

Design Choice 1: Arrow's CMake build respects CMAKE_DEBUG_POSTFIX for naming installed libraries

Options Considered:

1. Set CMAKE_DEBUG_POSTFIX=d during Arrow's CMake configuration – relies on Arrow's CMake respecting this variable
2. Manually rename libraries post-install and patch CMake config files – more fragile, requires maintaining custom patching logic
3. Build Debug and Release into separate directories and add both to search paths – complicates find logic and breaks standard CMake patterns

Chosen Option: 1

Rationale: Setting CMAKE_DEBUG_POSTFIX=d is the standard CMake approach for multi-configuration library naming and should integrate cleanly with Arrow's existing CMake infrastructure without requiring extensive custom patching.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Enable Debug Library Postfix in Contrib Arrow Build

This phase modifies the contrib repository's Arrow build script to produce distinctly-named Debug libraries that can coexist with Release libraries in the same installation directory.

Task 1: Add CMAKE_DEBUG_POSTFIX to Arrow CMake Configuration

Modify the Arrow CMake configuration in the contrib build system to append a d suffix to all Debug-built libraries.

• In libraries.cmake/arrow.cmake (in the OpenMS/contrib repository), locate the CMake configure command for Arrow's cpp build
• Add -DCMAKE_DEBUG_POSTFIX=d to the list of CMake configuration options passed to Arrow
• This single addition will cause all Debug static libraries to be named with the d suffix (e.g., arrow_staticd.lib, parquet_staticd.lib, arrow_bundled_dependenciesd.lib)

Task 2: Verify Multi-Config Install Behavior

Ensure the existing Debug and Release install steps correctly install both library variants.

• Confirm the existing cmake --build ... --target INSTALL --config Debug and --config Release commands will now install differently-named libraries
• The Debug install should place arrow_staticd.lib while Release install places arrow_static.lib
• Both files will coexist in contrib/build/lib/ without overwriting each other

🤖 Prompt for AI agents

This phase modifies `libraries.cmake/arrow.cmake` in the `OpenMS/contrib`
repository to produce distinctly-named Debug libraries, allowing Debug and
Release static libraries to coexist in the same installation directory.

- In `libraries.cmake/arrow.cmake`, locate the CMake configure command for
Arrow's cpp build
- Add `-DCMAKE_DEBUG_POSTFIX=d` to the list of CMake configuration options
passed to Arrow
- This will cause all Debug static libraries to be named with the `d` suffix
(e.g., `arrow_staticd.lib`, `parquet_staticd.lib`,
`arrow_bundled_dependenciesd.lib`)
- The existing `cmake --build ... --target INSTALL --config Debug` and `--config
Release` commands should now install differently-named libraries without any
further changes
- Debug install places `arrow_staticd.lib`; Release install places
`arrow_static.lib`
  - Both files coexist in `contrib/build/lib/` without overwriting each other

Phase 2: Validate CMake Export File Generation

This phase ensures Arrow's generated CMake configuration files correctly reference both Debug and Release library variants for proper consumption by downstream projects.

Task 1: Review Post-Install CMake Config Fixup

Verify that the existing relocatability fixup in arrow.cmake properly handles the multi-config target exports.

• The contrib script already rewrites Arrow/Parquet CMake config files (e.g., ArrowTargets-debug.cmake, ArrowTargets-release.cmake) to replace absolute paths with ${_IMPORT_PREFIX}-relative paths
• Confirm this fixup processes both configuration-specific files and correctly preserves the IMPORTED_LOCATION_DEBUG and IMPORTED_LOCATION_RELEASE properties
• The debug config file should reference the d-suffixed library path while release references the non-suffixed path

Task 2: Handle Arrow Bundled Dependencies

Ensure the bundled dependencies static library also receives proper debug/release naming.

• arrow_bundled_dependencies is built as part of Arrow's static build and must also get the d postfix
• Verify that CMAKE_DEBUG_POSTFIX propagates to this internal target (standard CMake behavior)
• If Arrow's build treats this as a separate internal target that doesn't inherit the postfix, additional configuration may be needed (check Arrow's CMake for arrow_bundled_dependencies target definition)

🤖 Prompt for AI agents

This phase validates that Arrow's generated CMake configuration files correctly
reference both Debug and Release library variants after the
`-DCMAKE_DEBUG_POSTFIX=d` change.

- In `arrow.cmake`, review the existing post-install relocatability fixup that
rewrites `ArrowTargets-debug.cmake` and `ArrowTargets-release.cmake`
- Confirm the fixup processes both configuration-specific files and replaces
absolute paths with `${_IMPORT_PREFIX}`-relative paths
- Ensure `IMPORTED_LOCATION_DEBUG` references the `d`-suffixed library (e.g.,
`arrow_staticd.lib`) and `IMPORTED_LOCATION_RELEASE` references the non-suffixed
library (e.g., `arrow_static.lib`)
- For `arrow_bundled_dependencies`:
- Verify `CMAKE_DEBUG_POSTFIX` propagates to this internal target via standard
CMake behavior
- If Arrow's CMake treats `arrow_bundled_dependencies` as a separate internal
target that does not inherit the postfix, add any necessary additional
configuration to the Arrow CMake build options in `arrow.cmake`

Phase 3: Verify OpenMS Consumption (No Changes Expected)

This phase confirms that the OpenMS main repository requires no modifications to consume the fixed Arrow libraries.

Task 1: Validate Existing CMake Discovery

Confirm OpenMS's existing Arrow discovery logic handles the fixed libraries correctly.

• The find_package(Arrow CONFIG REQUIRED) call in cmake/cmake_findExternalLibs.cmake will import Arrow's targets with both IMPORTED_LOCATION_DEBUG and IMPORTED_LOCATION_RELEASE properties automatically set
• CMake's generator expressions will select the appropriate library based on build configuration at compile time
• No changes to OPENMS_ARROW_TARGET, OPENMS_PARQUET_TARGET, or related variables should be necessary
• The --exclude-libs,libarrow_bundled_dependencies.a linker option in src/openms/CMakeLists.txt is Linux-only and unaffected

Task 2: Integration Testing

Verify the complete build chain works for both Debug and Release configurations.

• Build contrib with the updated arrow.cmake on Windows with MSVC
• Verify both arrow_static.lib and arrow_staticd.lib (and corresponding Parquet libs) exist in contrib/build/lib/
• Configure OpenMS pointing to the updated contrib build
• Build OpenMS in Debug mode – should link against *d.lib variants without iterator debug level mismatch
• Build OpenMS in Release mode – should link against non-suffixed variants

🤖 Prompt for AI agents

This phase confirms that no changes are needed in the OpenMS main repository to
consume the fixed Arrow libraries, and validates the full build chain.

- Review `cmake/cmake_findExternalLibs.cmake` and confirm the
`find_package(Arrow CONFIG REQUIRED)` call will automatically import Arrow
targets with both `IMPORTED_LOCATION_DEBUG` and `IMPORTED_LOCATION_RELEASE`
properties set correctly
- Confirm no changes are required to `OPENMS_ARROW_TARGET`,
`OPENMS_PARQUET_TARGET`, or related variables
- Confirm the `--exclude-libs,libarrow_bundled_dependencies.a` linker option in
`src/openms/CMakeLists.txt` is Linux-only and remains unaffected
- For integration testing on Windows with MSVC:
  - Build contrib with the updated `arrow.cmake`
- Verify both `arrow_static.lib` and `arrow_staticd.lib` (and corresponding
Parquet libs) exist in `contrib/build/lib/`
  - Configure OpenMS pointing to the updated contrib build
- Build OpenMS in Debug mode and confirm it links against `*d.lib` variants
without iterator debug level mismatch
- Build OpenMS in Release mode and confirm it links against non-suffixed
variants

Research

Codebase Summary

The OpenMS build system discovers Arrow via find_package(Arrow CONFIG REQUIRED) in cmake/cmake_findExternalLibs.cmake, relying on Arrow's own CMake exported targets (Arrow::arrow_static, Parquet::parquet_static, etc.). The actual Arrow build logic resides in the external OpenMS/contrib repository (specifically libraries.cmake/arrow.cmake), which configures and installs Arrow for both Debug and Release configurations using multi-config CMake builds. OpenMS links these targets through variables like OPENMS_ARROW_TARGET and OPENMS_PARQUET_TARGET, with no current debug/release differentiation logic since it expects the upstream CMake targets to handle multi-configuration automatically.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

This phase modifies `libraries.cmake/arrow.cmake` in the `OpenMS/contrib`
repository to produce distinctly-named Debug libraries, allowing Debug and
Release static libraries to coexist in the same installation directory.

- In `libraries.cmake/arrow.cmake`, locate the CMake configure command for
Arrow's cpp build
- Add `-DCMAKE_DEBUG_POSTFIX=d` to the list of CMake configuration options
passed to Arrow
- This will cause all Debug static libraries to be named with the `d` suffix
(e.g., `arrow_staticd.lib`, `parquet_staticd.lib`,
`arrow_bundled_dependenciesd.lib`)
- The existing `cmake --build ... --target INSTALL --config Debug` and `--config
Release` commands should now install differently-named libraries without any
further changes
- Debug install places `arrow_staticd.lib`; Release install places
`arrow_static.lib`
  - Both files coexist in `contrib/build/lib/` without overwriting each other
===============================================================================

Task: 2

This phase validates that Arrow's generated CMake configuration files correctly
reference both Debug and Release library variants after the
`-DCMAKE_DEBUG_POSTFIX=d` change.

- In `arrow.cmake`, review the existing post-install relocatability fixup that
rewrites `ArrowTargets-debug.cmake` and `ArrowTargets-release.cmake`
- Confirm the fixup processes both configuration-specific files and replaces
absolute paths with `${_IMPORT_PREFIX}`-relative paths
- Ensure `IMPORTED_LOCATION_DEBUG` references the `d`-suffixed library (e.g.,
`arrow_staticd.lib`) and `IMPORTED_LOCATION_RELEASE` references the non-suffixed
library (e.g., `arrow_static.lib`)
- For `arrow_bundled_dependencies`:
- Verify `CMAKE_DEBUG_POSTFIX` propagates to this internal target via standard
CMake behavior
- If Arrow's CMake treats `arrow_bundled_dependencies` as a separate internal
target that does not inherit the postfix, add any necessary additional
configuration to the Arrow CMake build options in `arrow.cmake`
===============================================================================

Task: 3

This phase confirms that no changes are needed in the OpenMS main repository to
consume the fixed Arrow libraries, and validates the full build chain.

- Review `cmake/cmake_findExternalLibs.cmake` and confirm the
`find_package(Arrow CONFIG REQUIRED)` call will automatically import Arrow
targets with both `IMPORTED_LOCATION_DEBUG` and `IMPORTED_LOCATION_RELEASE`
properties set correctly
- Confirm no changes are required to `OPENMS_ARROW_TARGET`,
`OPENMS_PARQUET_TARGET`, or related variables
- Confirm the `--exclude-libs,libarrow_bundled_dependencies.a` linker option in
`src/openms/CMakeLists.txt` is Linux-only and remains unaffected
- For integration testing on Windows with MSVC:
  - Build contrib with the updated `arrow.cmake`
- Verify both `arrow_static.lib` and `arrow_staticd.lib` (and corresponding
Parquet libs) exist in `contrib/build/lib/`
  - Configure OpenMS pointing to the updated contrib build
- Build OpenMS in Debug mode and confirm it links against `*d.lib` variants
without iterator debug level mismatch
- Build OpenMS in Release mode and confirm it links against non-suffixed
variants

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[cbielow]

can someone throw an AI at this?

[coderabbitai]

🔗 Related PRs

#163 - Fix eigen [merged]
#165 - More arrow bullshit [merged]
#168 - More arrow bullshit [merged]
#169 - Upgrade Arrow from 22.0.0 to 23.0.0 [merged]
#171 - fix: bundle Arrow deps to fix build on Debian 12 [merged]

---

📝 Issue Planner

_{Check the box below or use the @coderabbitai plan command to generate an implementation plan and prompts that you can use with your favorite coding assistant.}

• Create Plan

---

🧪 Issue enrichment is currently in open beta.

You can configure auto-planning by selecting labels in the issue_enrichment configuration.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!