fixing the MacOS build #2586

winitzki · 2024-05-12T08:11:10Z

The goal of this PR is to fix any problems with the build of dhall-haskell.

Current issues:

Mac OS build failing on Sonoma 14.4.1 (Intel x86_64) due to failures with building saltine after stack build.
Mac OS build failing due to libsodium in the PR optimize Natural/fold in the strict case #2585 (but builds are successful on other OSes)

The error is in installing libsodium.

tried: '/opt/homebrew/lib/libsodium.dylib' (mach-o file, but is an incompatible architecture (have 'arm64', need 'x86_64'))

This discussion https://stackoverflow.com/questions/72970363 suggests using the command: arch -x86_64 /usr/local/bin/brew install libsodium

This reverts commit ada55e1.

This reverts commit ab71435.

This reverts commit 81631fc.

winitzki · 2024-05-25T07:10:27Z

Currently the macos build seems to be broken. I've been trying randomly poking around to fix it but I don't really know what I'm doing in this build system. #2586 Anyone has any ideas? The failure is around libsodium and has to do with macos architectures (x86 vs arm).

The error seems to be confusingly worded. The error message says that it found libsodium with arm64 architecture but it requires libsodium with x86 architecture. However, it is wrong that it should have looked for libsodium with x86 architecture, because the build is for macos-latest which is arm64. See here for the list. https://github.com/actions/runner-images?tab=readme-ov-file#available-images

It seems that macos-latest is configured to build arm64. However, I am also not able to change that into building x86.

What I have tried so far:

Adding a command to install libsodium (brew install libsodium). This did not help because libsodium was already installed by another command somewhere.
Adding a command to install libsodium on mac (brew reinstall libsodium) with x86 architecture specifically. This fails because brew is installed for arm64 and refuses to install x86 artifacts. I don't know how I can reinstall brew correctly.
Changing the build in main.yaml to use a different macos runner: macos-latest-large, macos-14-large and so on. This simply fails even to start the build, with no error messages.

winitzki · 2024-05-26T18:08:34Z

The build fails immediately if the runner is set to macos-14, macos-14-large, macos-latest-large. (Although those runners are supposed to be working now. https://github.com/actions/runner-images?tab=readme-ov-file#available-images )

The previous working version was macos-13 and I'm trying it right now. However, the github settings for this repo require macOS-latest build to succeed.

winitzki · 2024-05-27T07:11:14Z

I found this page:
https://docs.github.com/en/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#about-macos-larger-runners
which says:

Larger runners are only available for organizations and enterprises using the GitHub Team or GitHub Enterprise Cloud plans.
Probably, this is why the CI job simply fails immediately when I specified macos-14-large or other "large" runners.

So, we have a choice:

Keep the macos build at version 13 (this still works) and change the github repository settings for dhall-lang/dhall-haskell to require macos-13 build to pass instead of macos-latest.
Somehow fix the macOS ARM64 build. Currently, the ARM64 build fails because of some dependency problems with hnix-store that depends on libsodium and appears to be misconfigured: when building hnix-store on ARM64 architecture, the build expects libsodium to be for the x86 architecture. I don't know how to fix that. There seems to be some dependency issues for hnix-store.

mmhat · 2024-05-30T19:47:30Z

@winitzki Thank's for your efforts; I am trying to understand why this happens and here is what I have found so far:

I suspect the reason is that GH changed the runners to arm64 only: actions/runner-images#9741 (comment)
Their issue tracker has a bunch of interesting issues in this regard, involving caching issues
(e.g. actions/runner-images#9741 (comment)), wrong uname -m output (actions/runner-images#9755 (comment)).
Apparently Homebrew choked on that change as well (actions/runner-images#9760), and there are some more interesting issues here:
actions/runner-images#9766
actions/runner-images#9676

I also re-run an old GH action of this PR with debug logging enabled:
https://github.com/dhall-lang/dhall-haskell/actions/runs/9049961867/job/25621271094
There is something weird going on: For example https://github.com/dhall-lang/dhall-haskell/actions/runs/9049961867/job/25621271094#step:3:73 indicates that we are running on arm64 architecture (which is correct), and then a few lines later (e.g. https://github.com/dhall-lang/dhall-haskell/actions/runs/9049961867/job/25621271094#step:3:117) ghcup fetches and installs an x86_64 bindist of GHC.
Later, stack appears to build x86_64 objects as well (See e.g. https://github.com/dhall-lang/dhall-haskell/actions/runs/9049961867/job/25621271094#step:6:2309).

mmhat

I think we should pin the MacOS runner first in order to get working mac builds again, but #2587 should stay open and the subject should be adjusted. Thought?

mmhat · 2024-05-30T21:18:08Z

.github/workflows/main.yml

@@ -49,7 +49,7 @@ jobs:
 ${{ matrix.os.runner }}-
 path: |
 ${{ steps.setup-haskell-cabal.outputs.stack-root }}
- - name: Install libsodium
+ - name: Install libsodium x86_64


Suggested change

- name: Install libsodium x86_64

- name: Install libsodium

mmhat · 2024-05-30T21:46:47Z

@winitzki It might be worth trying to use the latest haskell setup action -- Which is haskell-actions/[email protected].

The various "Downloading ..." debug messages (e.g. https://github.com/dhall-lang/dhall-haskell/actions/runs/9049961867/job/25621271094#step:3:465) in the GH Actions run linked previously originate from the haskell setup action: See https://github.com/haskell-actions/setup/blob/33585e1a16afa5875e124b0ebc89dd0c2f872c21/dist/index.js#L4523 in the definition and https://github.com/haskell-actions/setup/blob/33585e1a16afa5875e124b0ebc89dd0c2f872c21/src/installer.ts#L343 for the usage of the downloadTool function.

winitzki · 2024-05-31T08:00:07Z

I think we should pin the MacOS runner first in order to get working mac builds again, but #2587 should stay open and the subject should be adjusted. Thought?

In my view, the root cause is that dhall-haskell cannot build under macos-arm64 due to some dependency problems in hnix-store and/or elsewhere. The macos-arm64 build was actually never tested in dhall-haskell, and in fact there were never any macos-arm64 executables released for dhall. When github changed the macos-latest runners to arm64, all builds started failing.

To resolve this issue, I propose the following path forward:

Use macos-13 instead of macos-latest (as in this PR). Change the repo settings so that macos-latest is no longer a requirement for passing the CI builds. (I don't have permissions to do this.) Mention in the README that macos-arm64 is currently unsupported.
Fix the dependency problems so that macos-arm64 build becomes successful. Enable macos-13 and macos-latest builds and publish both dhall-darwin-x86 and dhall-darwin-arm64 executables. Mention in the README that macos-arm64 is now supported.

winitzki · 2024-05-31T09:35:05Z

The macos-latest build passed with haskell actions 2.7. Thank you for suggesting that!

Let me add a macos-13 build as well.

winitzki · 2024-05-31T11:13:52Z

Let me know if this is OK to merge. This will unblock other builds.

What needs to be done in order to publish both macos-x86 and macos-arm64 executables when a release is made?

mmhat · 2024-05-31T12:39:04Z

I think we should pin the MacOS runner first in order to get working mac builds again, but #2587 should stay open and the subject should be adjusted. Thought?

In my view, the root cause is that dhall-haskell cannot build under macos-arm64 due to some dependency problems in hnix-store and/or elsewhere. The macos-arm64 build was actually never tested in dhall-haskell, and in fact there were never any macos-arm64 executables released for dhall. When github changed the macos-latest runners to arm64, all builds started failing.

Indeed.

To resolve this issue, I propose the following path forward:

Use macos-13 instead of macos-latest (as in this PR). Change the repo settings so that macos-latest is no longer a requirement for passing the CI builds. (I don't have permissions to do this.) Mention in the README that macos-arm64 is currently unsupported.

Would you mind adding that comment to the README?

Fix the dependency problems so that macos-arm64 build becomes successful. Enable macos-13 and macos-latest builds and publish both dhall-darwin-x86 and dhall-darwin-arm64 executables. Mention in the README that macos-arm64 is now supported.

👍

Let me know if this is OK to merge. This will unblock other builds.

LGTM, merge it when you're done. If you include bigger changes, don't hesitate to ask for another review!

What needs to be done in order to publish both macos-x86 and macos-arm64 executables when a release is made?

I'd proceed as follows:

Parameterize the objects of the workflow with runner.arch from https://docs.github.com/en/actions/learn-github-actions/contexts#runner-context. In particular

dhall-haskell/.github/workflows/main.yml

Line 31 in e281834

name: ${{ matrix.os.runner }} - ${{ matrix.stack-yaml }}

,

dhall-haskell/.github/workflows/main.yml

Line 47 in e281834

key: ${{ matrix.os.runner }}-${{ hashFiles(matrix.stack-yaml) }}-${{ env.cache_generation }}

(maybe the restore-key: too) and

dhall-haskell/.github/workflows/main.yml

Line 158 in e281834

name: 'dhall-${{runner.os}}.${{matrix.os.file-extension}}'
Also use runner.arch in the conditional executions here:

dhall-haskell/.github/workflows/main.yml

Line 74 in e281834

if [ '${{matrix.os.runner}}' == 'windows-latest' ] && [ "${package}" == 'dhall-nix' ]; then

,

dhall-haskell/.github/workflows/main.yml

Line 99 in e281834

if [ '${{matrix.os.runner}}' == 'windows-latest' ] && [ "${package}" == 'dhall-nix' ]; then

,

dhall-haskell/.github/workflows/main.yml

Line 148 in e281834

if [ '${{matrix.os.runner}}' != 'windows-latest' ]; then
I think it is good to get rid of

dhall-haskell/.github/workflows/main.yml

Line 130 in e281834

architecture="$(uname -m)"

and use runner.arch in

dhall-haskell/.github/workflows/main.yml

Line 137 in e281834

local package_file="${package}-${version}-${architecture}-${{runner.os}}.${{ matrix.os.file-extension }}"

.

winitzki · 2024-05-31T12:44:48Z

@mmhat The current build with macOS-latest is an arm64 build, correct?

https://github.com/dhall-lang/dhall-haskell/actions/runs/9316129247/job/25643704112?pr=2586

Current runner version: '2.316.1'
Operating System
  macOS
  14.5
  23F79
Runner Image
  Image: macos-14-arm64
  Version: 20240526.2
  Included Software: https://github.com/actions/runner-images/blob/macos-14-arm64/20240526.2/images/macos/macos-14-arm64-Readme.md
  Image Release: [https://g](https://github.com/actions/runner-images/releases/tag/macos-14-arm64%2F20240526.2)

So, it looks like macos-arm64 build is working and passing all tests. I don't think we need to say in the readme that it is unsupported. Should we?

no-op change just to test the build

178ea96

This was referenced May 12, 2024

optimize Natural/fold in the strict case #2585

Merged

Build failure on macos-latest stack.yaml #2587

Closed

wip add explicit homebrew command for libsodium

ada55e1

winitzki changed the title ~~no-op change just to test the build~~ fixing the MacOS build May 14, 2024

winitzki added 14 commits May 14, 2024 10:46

wip

2051af2

Revert "wip add explicit homebrew command for libsodium"

7a07825

This reverts commit ada55e1.

wip

64f5b08

bump ci

f65cd84

change a to b

ab71435

Revert "change a to b"

81631fc

This reverts commit ab71435.

reinstall libsodium

31d208d

Revert "Revert "change a to b""

403e3b2

This reverts commit 81631fc.

remove libsodium override as it does not work

bab2328

wip

c7eeed9

wip

f22df54

use macos-14-large

676cc85

remove hnix override

6af4a2e

wip

80c3493

This was referenced May 25, 2024

improve Dhall.Map.traverseWithKey performance #2589

Merged

dhall: raise upper bound on Diff #2588

Merged

winitzki added 3 commits May 25, 2024 20:44

wip

3b52b01

use macos-14-latest

d92796b

use macos-13

220841f

winitzki requested a review from mmhat May 27, 2024 07:02

winitzki assigned Gabriella439 and unassigned Gabriella439 May 27, 2024

winitzki requested a review from Gabriella439 May 27, 2024 07:28

mmhat approved these changes May 30, 2024

View reviewed changes

winitzki added 3 commits May 31, 2024 10:06

respond to comments from mmhut

372f259

try with macos-latest once again

eea223e

revert dummy change

f57f72f

add macos-13

f23ccaf

winitzki merged commit 1088e3c into dhall-lang:main May 31, 2024
7 checks passed

winitzki deleted the feature/test-build branch May 31, 2024 12:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fixing the MacOS build #2586

fixing the MacOS build #2586

winitzki commented May 12, 2024 •

edited

winitzki commented May 25, 2024

winitzki commented May 26, 2024

winitzki commented May 27, 2024 •

edited

mmhat commented May 30, 2024 •

edited

mmhat left a comment

mmhat May 30, 2024

mmhat commented May 30, 2024 •

edited

winitzki commented May 31, 2024

winitzki commented May 31, 2024 •

edited

winitzki commented May 31, 2024 •

edited

mmhat commented May 31, 2024

winitzki commented May 31, 2024

fixing the MacOS build #2586

fixing the MacOS build #2586

Conversation

winitzki commented May 12, 2024 • edited

winitzki commented May 25, 2024

winitzki commented May 26, 2024

winitzki commented May 27, 2024 • edited

mmhat commented May 30, 2024 • edited

mmhat left a comment

Choose a reason for hiding this comment

mmhat May 30, 2024

Choose a reason for hiding this comment

mmhat commented May 30, 2024 • edited

winitzki commented May 31, 2024

winitzki commented May 31, 2024 • edited

winitzki commented May 31, 2024 • edited

mmhat commented May 31, 2024

winitzki commented May 31, 2024

winitzki commented May 12, 2024 •

edited

winitzki commented May 27, 2024 •

edited

mmhat commented May 30, 2024 •

edited

mmhat commented May 30, 2024 •

edited

winitzki commented May 31, 2024 •

edited

winitzki commented May 31, 2024 •

edited