x64 installer bundles both 64-bit and 32-bit ODBC drivers

fdcastel · fdcastel · commit 738233c5c95a · 2026-04-10T19:45:24.000-03:00
The x64 MSI now installs both the native 64-bit driver (System32) and the
32-bit driver (SysWOW64), matching the old InnoSetup behavior. Both 64-bit
and WoW64 32-bit applications can use the ODBC driver after a single install.

Changes:
- Product.wxs: x64 builds include DriverPathX86 components with
  Bitness='always32' for the 32-bit DLL and WOW6432Node registry entries
- release.yml: x64 package-windows job downloads both x64 and x86 artifacts;
  passes DriverPathX86 to WiX; includes x86/ subfolder in ZIP
- release.yml: new test-installer job verifies MSI install/uninstall and
  checks both 64-bit and 32-bit ODBC driver registrations for x64 MSI
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -73,6 +73,13 @@ jobs:
         name: ${{ matrix.artifact }}
         path: artifacts
 
+    - name: Download Windows x86 artifacts (bundled in x64 installer)
+      if: matrix.target-arch == 'x64'
+      uses: actions/download-artifact@v8
+      with:
+        name: windows-x86-binaries
+        path: artifacts-x86
+
     - name: Install WiX Toolset
       run: dotnet tool install --global wix --version 5.0.2
 
@@ -84,12 +91,19 @@ jobs:
         $msiVersion = ($version -replace '-.*', '') + '.0'
         $dllPath = Resolve-Path "artifacts/FirebirdODBC.dll"
 
+        $extraArgs = @()
+        if ('${{ matrix.target-arch }}' -eq 'x64') {
+          $x86DllPath = Resolve-Path "artifacts-x86/FirebirdODBC.dll"
+          $extraArgs = @('-d', "DriverPathX86=$x86DllPath")
+        }
+
         wix build `
           -d ProductVersion=$msiVersion `
           -d DriverPath="$dllPath" `
           -d Configuration=Release `
           -d TargetArch=${{ matrix.target-arch }} `
           -arch ${{ matrix.wix-arch }} `
+          @extraArgs `
           -o "firebird-odbc-driver-$version-${{ matrix.suffix }}.msi" `
           installer/Product.wxs
 
@@ -104,6 +118,13 @@ jobs:
         Copy-Item "artifacts/FirebirdODBC.lib" -Destination $packageDir -ErrorAction SilentlyContinue
         Copy-Item "README.md" -Destination $packageDir -ErrorAction SilentlyContinue
 
+        # x64 package also includes the 32-bit DLL for WoW64 applications
+        if ('${{ matrix.target-arch }}' -eq 'x64') {
+          $x86Dir = Join-Path $packageDir "x86"
+          New-Item -ItemType Directory -Path $x86Dir -Force | Out-Null
+          Copy-Item "artifacts-x86/FirebirdODBC.dll" -Destination $x86Dir
+        }
+
         Compress-Archive -Path "$packageDir/*" `
           -DestinationPath "firebird-odbc-driver-$version-${{ matrix.suffix }}.zip"
 
@@ -114,6 +135,99 @@ jobs:
           firebird-odbc-driver-${{ needs.release.outputs.version }}-${{ matrix.suffix }}.msi
           firebird-odbc-driver-${{ needs.release.outputs.version }}-${{ matrix.suffix }}.zip
 
+    - name: Upload MSI as workflow artifact (for installer tests)
+      uses: actions/upload-artifact@v7
+      with:
+        name: msi-${{ matrix.suffix }}
+        path: firebird-odbc-driver-${{ needs.release.outputs.version }}-${{ matrix.suffix }}.msi
+
+  test-installer:
+    needs: [package-windows]
+    runs-on: windows-2022
+
+    strategy:
+      matrix:
+        include:
+          - suffix: win-x64
+            expect-x86: true
+          - suffix: win-x86
+            expect-x86: false
+          # ARM64 MSI cannot be installed on x64 runners — skip
+
+    steps:
+    - name: Download MSI
+      uses: actions/download-artifact@v8
+      with:
+        name: msi-${{ matrix.suffix }}
+        path: msi
+
+    - name: Find MSI file
+      id: find-msi
+      shell: pwsh
+      run: |
+        $msi = Get-ChildItem -Path msi -Filter '*.msi' -Recurse | Select-Object -First 1
+        if (-not $msi) { throw "No MSI file found" }
+        "msi_path=$($msi.FullName)" >> $env:GITHUB_OUTPUT
+        Write-Host "Found MSI: $($msi.FullName)"
+
+    - name: Install MSI
+      shell: pwsh
+      run: |
+        $proc = Start-Process msiexec.exe -ArgumentList "/i `"${{ steps.find-msi.outputs.msi_path }}`" /qn /l*v install.log" -Wait -PassThru
+        if ($proc.ExitCode -ne 0) {
+          Get-Content install.log -Tail 50
+          throw "MSI install failed with exit code $($proc.ExitCode)"
+        }
+
+    - name: Verify ODBC driver registration
+      shell: pwsh
+      run: |
+        $driverName = 'Firebird ODBC Driver'
+
+        # Check 64-bit or 32-bit native registration
+        $drivers = Get-OdbcDriver -Name $driverName -ErrorAction SilentlyContinue
+        if (-not $drivers) {
+          throw "ODBC driver '$driverName' not found after install"
+        }
+        Write-Host "Found ODBC drivers:"
+        $drivers | Format-Table -AutoSize
+
+        # For x64 installer, verify both 64-bit and 32-bit registrations
+        if ('${{ matrix.expect-x86 }}' -eq 'true') {
+          $reg64 = Test-Path "HKLM:\SOFTWARE\ODBC\ODBCINST.INI\$driverName"
+          $reg32 = Test-Path "HKLM:\SOFTWARE\WOW6432Node\ODBC\ODBCINST.INI\$driverName"
+
+          if (-not $reg64) { throw "64-bit ODBC registration missing" }
+          if (-not $reg32) { throw "32-bit (WOW6432Node) ODBC registration missing" }
+
+          $dll64 = Join-Path $env:SystemRoot 'System32' 'FirebirdODBC.dll'
+          $dll32 = Join-Path $env:SystemRoot 'SysWOW64' 'FirebirdODBC.dll'
+
+          if (-not (Test-Path $dll64)) { throw "64-bit DLL missing: $dll64" }
+          if (-not (Test-Path $dll32)) { throw "32-bit DLL missing: $dll32" }
+
+          Write-Host "PASS: Both 64-bit and 32-bit drivers installed correctly"
+        }
+
+    - name: Uninstall MSI
+      shell: pwsh
+      run: |
+        $proc = Start-Process msiexec.exe -ArgumentList "/x `"${{ steps.find-msi.outputs.msi_path }}`" /qn /l*v uninstall.log" -Wait -PassThru
+        if ($proc.ExitCode -ne 0) {
+          Get-Content uninstall.log -Tail 50
+          throw "MSI uninstall failed with exit code $($proc.ExitCode)"
+        }
+
+    - name: Verify clean uninstall
+      shell: pwsh
+      run: |
+        $driverName = 'Firebird ODBC Driver'
+        $drivers = Get-OdbcDriver -Name $driverName -ErrorAction SilentlyContinue
+        if ($drivers) {
+          throw "ODBC driver '$driverName' still registered after uninstall"
+        }
+        Write-Host "PASS: Driver cleanly uninstalled"
+
   package-linux:
     needs: [build-and-test, release]
     runs-on: ubuntu-latest
diff --git a/installer/Product.wxs b/installer/Product.wxs
@@ -2,9 +2,10 @@
 
   <!-- Variables passed from the build: -->
   <!-- $(ProductVersion) — e.g. 3.5.0.0 -->
-  <!-- $(DriverPath) — full path to FirebirdODBC.dll -->
+  <!-- $(DriverPath) — full path to native FirebirdODBC.dll -->
   <!-- $(Configuration) — Debug or Release -->
   <!-- $(TargetArch) — x86, x64, or arm64 -->
+  <!-- $(DriverPathX86) — (x64 only) full path to 32-bit FirebirdODBC.dll -->
 
   <?define DriverName = "Firebird ODBC Driver" ?>
 
@@ -40,7 +41,7 @@
 
     <MediaTemplate EmbedCab="yes" />
 
-    <!-- The driver DLL -->
+    <!-- Native driver DLL -->
     <StandardDirectory Id="$(SystemDir)">
       <Component Id="DriverDLL" Guid="B8F4E3C2-5D6E-7F8A-9B0C-1D2E3F4A5B6C">
         <File Id="FirebirdODBCDll"
@@ -50,7 +51,7 @@
       </Component>
     </StandardDirectory>
 
-    <!-- ODBC Driver registration -->
+    <!-- Native ODBC Driver registration -->
     <Component Id="OdbcDriverReg" Directory="$(SystemDir)"
                Guid="C9F5E4D3-6E7F-8A9B-0C1D-2E3F4A5B6C7D">
       <RegistryKey Root="HKLM" Key="SOFTWARE\ODBC\ODBCINST.INI\$(DriverName)">
@@ -70,10 +71,53 @@
                      KeyPath="yes" />
     </Component>
 
+    <?if $(TargetArch) = "x64" ?>
+    <!-- ── 32-bit (x86) driver bundled in the x64 installer ──────────── -->
+    <!-- The x64 installer ships both 64-bit and 32-bit drivers so that  -->
+    <!-- both native x64 and WoW64 32-bit applications can use ODBC.     -->
+    <!-- This matches the behavior of the old InnoSetup installer.       -->
+
+    <!-- 32-bit driver DLL → SysWOW64 -->
+    <StandardDirectory Id="SystemFolder">
+      <Component Id="DriverDLL_x86" Guid="F1A2B3C4-5D6E-7F8A-9B0C-1D2E3F4A5B6C"
+                 Bitness="always32">
+        <File Id="FirebirdODBCDll_x86"
+              Source="$(DriverPathX86)"
+              Name="FirebirdODBC.dll"
+              KeyPath="yes" />
+      </Component>
+    </StandardDirectory>
+
+    <!-- 32-bit ODBC Driver registration (writes to WOW6432Node via 32-bit registry view) -->
+    <Component Id="OdbcDriverReg_x86" Directory="SystemFolder"
+               Guid="F2B3C4D5-6E7F-8A9B-0C1D-2E3F4A5B6C7D"
+               Bitness="always32">
+      <RegistryKey Root="HKLM" Key="SOFTWARE\ODBC\ODBCINST.INI\$(DriverName)">
+        <RegistryValue Name="Driver"           Type="string" Value="[SystemFolder]FirebirdODBC.dll" />
+        <RegistryValue Name="Setup"            Type="string" Value="[SystemFolder]FirebirdODBC.dll" />
+        <RegistryValue Name="APILevel"         Type="string" Value="1" />
+        <RegistryValue Name="ConnectFunctions" Type="string" Value="YYY" />
+        <RegistryValue Name="DriverODBCVer"    Type="string" Value="03.51" />
+        <RegistryValue Name="FileUsage"        Type="string" Value="0" />
+        <RegistryValue Name="SQLLevel"         Type="string" Value="1" />
+      </RegistryKey>
+      <RegistryValue Root="HKLM"
+                     Key="SOFTWARE\ODBC\ODBCINST.INI\ODBC Drivers"
+                     Name="$(DriverName)"
+                     Type="string"
+                     Value="Installed"
+                     KeyPath="yes" />
+    </Component>
+    <?endif?>
+
     <!-- Features -->
     <Feature Id="DriverFeature" Title="$(DriverName)" Level="1">
       <ComponentRef Id="DriverDLL" />
       <ComponentRef Id="OdbcDriverReg" />
+      <?if $(TargetArch) = "x64" ?>
+      <ComponentRef Id="DriverDLL_x86" />
+      <ComponentRef Id="OdbcDriverReg_x86" />
+      <?endif?>
     </Feature>
 
   </Package>
