Merge pull request #2298 from tweag/cb/fix-examples-bindist

Fix examples with ghc bindist

Author: mergify[bot]

.github/workflows/workflow.yaml

@@ -252,10 +252,90 @@ jobs:
           name: Logs ${{ matrix.os }} ${{ matrix.module }} ${{ matrix.bzlmod }}
           path: logs
 
+  examples-bindist:
+    name: Build & Test Examples - bindist
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-22.04, macos-13, macos-14, windows-latest]
+        bzlmod: [true, false]
+        bazel:
+          - "6.x"
+          - "7.x"
+        exclude:
+          # TODO(cb) add full support for Bazel 7
+          - os: windows-latest
+            bazel: "7.x"
+    env:
+      USE_BAZEL_VERSION: ${{ matrix.bazel }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/free_disk_space_on_linux
+      - uses: ./.github/actions/install_apt_pkgs
+        with:
+          packages: libtinfo5
+      - name: Mount Bazel cache
+        uses: actions/cache@v4
+        with:
+          path: ~/repo-cache
+          key: repo-cache-${{ runner.os }}-bindist-${{ env.cache-version }}
+      - uses: tweag/configure-bazel-remote-cache-auth@v0
+        with:
+          buildbuddy_api_key: ${{ secrets.BUILDBUDDY_API_KEY }}
+          bazelrc_path: .bazelrc.auth
+      - uses: ./.github/actions/set_tcp_keepalive_time
+      - uses: extractions/netrc@v2
+        with:
+          machine: api.github.com
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Configure
+        shell: bash
+        run: |
+          case "${{ runner.os }}" in
+            macOS) BUILD_CONFIG=macos-bindist;;
+            Linux) BUILD_CONFIG=linux-bindist;;
+            Windows) BUILD_CONFIG=ci-windows-bindist;;
+          esac
+          if [[ ${{ runner.os }} == Windows ]]; then
+              output_root_setting="startup --output_user_root=C:/_bzl"
+              # On windows, we use a separate remote cache for bzlmod,
+              # because the c dependency analysis is leaking absolute paths which are different
+              if ${{ matrix.bzlmod }}; then
+                bzlmod_cache_silo_key='build --remote_default_exec_properties=bzlmod-cache-silo-key=bzlmod'
+              else
+                bzlmod_cache_silo_key='build --remote_default_exec_properties=bzlmod-cache-silo-key=workspace'
+              fi
+          else
+              output_root_setting=""
+              bzlmod_cache_silo_key=""
+          fi
+          cat >>.bazelrc.local <<EOF
+          common --config=ci
+          build --config=$BUILD_CONFIG
+          $output_root_setting
+          $bzlmod_cache_silo_key
+          common --enable_bzlmod=${{ matrix.bzlmod }}
+          EOF
+      - name: Build
+        shell: bash
+        working-directory: examples
+        run: |
+          # Quote the package specifier so that it works on Windows
+          bazelisk build "//..."
+
+      - name: Test
+        shell: bash
+        working-directory: examples
+        run: |
+          # Quote the package specifier so that it works on Windows
+          bazelisk build "//..."
+
   all_ci_tests:
     runs-on: ubuntu-22.04
     needs:
       - lint
+      - examples-bindist
       - test-nixpkgs
       - test-bindist
     if: ${{ always() }}

examples/.bazelrc.auth

@@ -0,0 +1 @@
+../.bazelrc.auth

examples/.bazelrc.bzlmod

@@ -1,2 +1,2 @@
 common:bzlmod --enable_bzlmod
-common:common --registry=file://%workspace%/../registry --registry=https://bcr.bazel.build
+common:common --registry=file:///%workspace%/../registry --registry=https://bcr.bazel.build

examples/MODULE.bazel

@@ -37,6 +37,7 @@ bazel_dep(
     name = "bazel_skylib",
     version = "1.7.1",
 )
+bazel_dep(name = "platforms", version = "0.0.11")
 
 non_module_deps = use_extension(":non_module_deps.bzl", "non_module_deps")
 use_repo(
@@ -83,13 +84,23 @@ stack_snapshot.package(
         "conduit",
         "conduit-extra",
         "hspec",
-        # Remove hspec-* packages once https://github.com/tweag/rules_haskell/issues/1871 is resolved
-        "hspec-core",
-        "hspec-discover",
-        "hspec-expectations",
         "optparse-applicative",
         "text",
         "text-show",
+        # TODO(cb) remove these transitive deps once
+        #          https://github.com/tweag/rules_haskell/issues/1871 is resolved
+        "bifunctors",
+        "call-stack",
+        "generic-deriving",
+        "hspec-core",
+        "hspec-discover",
+        "hspec-expectations",
+        "HUnit",
+        "mono-traversable",
+        "quickcheck-io",
+        "transformers-compat",
+        "typed-process",
+        "unliftio-core",
     ]
 ]
 

examples/WORKSPACE

@@ -80,6 +80,31 @@ stack_snapshot(
         "text",
         "text-show",
     ],
+    # TODO(cb) remove once we use Cabal >= 3.10.1 / GHC >= 9.6.1
+    # See https://github.com/tweag/rules_haskell/issues/1871
+    setup_deps = {
+        pkg: ["@Cabal//:Cabal"]
+        for pkg in [
+            "bifunctors",
+            "call-stack",
+            "conduit",
+            "conduit-extra",
+            "generic-deriving",
+            "hspec",
+            "hspec-core",
+            "hspec-discover",
+            "hspec-expectations",
+            "HUnit",
+            "mono-traversable",
+            "optparse-applicative",
+            "quickcheck-io",
+            "split",
+            "text-show",
+            "transformers-compat",
+            "typed-process",
+            "unliftio-core",
+        ]
+    },
     # This example uses an unpinned version of stack_snapshot, meaning that stack is invoked on every build.
     # To switch to pinned stackage dependencies, run `bazel run @stackage-unpinned//:pin` and
     # uncomment the following line.

examples/nixpkgs

@@ -0,0 +1 @@
+../nixpkgs/

examples/non_module_deps.bzl

@@ -68,13 +68,13 @@ haskell_cabal_library(
     name = "Cabal",
     srcs = glob(["Cabal/**"]),
     verbose = False,
-    version = "3.6.3.0",
+    version = "3.8.1.0",
     visibility = ["//visibility:public"],
 )
 """,
-        sha256 = "f69b46cb897edab3aa8d5a4bd7b8690b76cd6f0b320521afd01ddd20601d1356",
-        strip_prefix = "cabal-gg-8220-with-3630",
-        urls = ["https://github.com/tweag/cabal/archive/refs/heads/gg/8220-with-3630.zip"],
+        sha256 = "b697b558558f351d2704e520e7dcb1f300cd77fea5677d4b2ee71d0b965a4fe9",
+        strip_prefix = "cabal-ghc-9.4-paths-module-relocatable",
+        urls = ["https://github.com/tweag/cabal/archive/refs/heads/ghc-9.4-paths-module-relocatable.zip"],
     )
 
 def _non_module_deps_impl(_ctx):

examples/rts/BUILD.bazel

@@ -12,6 +12,11 @@ haskell_toolchain_library(name = "rts")
 haskell_library(
     name = "add-one-hs",
     srcs = ["One.hs"],
+    # FIXME: this is broken on Windows, see https://github.com/tweag/rules_haskell/issues/2299
+    target_compatible_with = select({
+        "@platforms//os:windows": ["@platforms//:incompatible"],
+        "//conditions:default": [],
+    }),
     deps = [":base"],
 )
 

haskell/BUILD.bazel

@@ -32,7 +32,6 @@ exports_files(
         "private/coverage_wrapper.sh.tpl",
         "private/ghci_repl_wrapper.sh",
         "private/hie_bios_wrapper.sh",
-        "private/haddock_wrapper.sh.tpl",
         "private/cc_wrapper.py.tpl",
         "private/cc_wrapper_windows.sh.tpl",
         "private/pkgdb_to_bzl.py",

haskell/haddock.bzl

@@ -135,26 +135,7 @@ def _haskell_doc_aspect_impl(target, ctx):
         [lib for li in target[CcInfo].linking_context.linker_inputs.to_list() for lib in li.libraries],
     )
 
-    # TODO(mboes): we should be able to instantiate this template only
-    # once per toolchain instance, rather than here.
-    # TODO(aherrmann): Convert to a standalone sh_binary.
-    # Executable shell script files don't work on Windows.
-    # This fails with `%1 is not a valid Win32 application.`.
-    haddock_wrapper = ctx.actions.declare_file("haddock_wrapper-{}".format(hs.name))
-    ctx.actions.expand_template(
-        template = ctx.file._haddock_wrapper_tpl,
-        output = haddock_wrapper,
-        substitutions = {
-            "%{ghc-pkg}": hs.tools.ghc_pkg.path,  # not mentioned in bash XXX delete?
-            "%{haddock}": shell.quote(hs.tools.haddock.path),
-            # XXX Workaround
-            # https://github.com/bazelbuild/bazel/issues/5980.
-            "%{env}": render_env(hs.env),
-        },
-        is_executable = True,
-    )
-
-    ctx.actions.run(
+    ctx.actions.run_shell(
         inputs = depset(transitive = [
             target[HaskellInfo].package_databases,
             target[HaskellInfo].interface_dirs,
@@ -177,7 +158,21 @@ def _haskell_doc_aspect_impl(target, ctx):
         outputs = [haddock_file, html_dir],
         mnemonic = "HaskellHaddock",
         progress_message = "HaskellHaddock {}".format(ctx.label),
-        executable = haddock_wrapper,
+        command = """
+set -eo pipefail
+
+{env}
+
+# BSD and GNU mktemp are very different; attempt GNU first
+TEMP=$(mktemp -d 2>/dev/null || mktemp -d -t 'haddock_wrapper')
+trap cleanup 1 2 3 6
+cleanup() {{ rm -rf "$TEMP"; }}
+# XXX Override TMPDIR to prevent race conditions on certain platforms.
+# This is a workaround for
+# https://github.com/haskell/haddock/issues/894.
+TMPDIR=$TEMP {haddock} "$@"
+cleanup
+        """.format(env = render_env(hs.env), haddock = shell.quote(hs.tools.haddock.path)),
         arguments = [
             args,
             compile_flags,
@@ -201,12 +196,6 @@ def _haskell_doc_aspect_impl(target, ctx):
 
 haskell_doc_aspect = aspect(
     _haskell_doc_aspect_impl,
-    attrs = {
-        "_haddock_wrapper_tpl": attr.label(
-            allow_single_file = True,
-            default = Label("@rules_haskell//haskell:private/haddock_wrapper.sh.tpl"),
-        ),
-    },
     attr_aspects = ["deps", "exports"],
     required_aspect_providers = [HaskellCcLibrariesInfo],
     toolchains = [

haskell/private/cabal_wrapper.py

@@ -245,7 +245,7 @@ def distdir_prefix():
         for db in deps_package_databases:
             try:
                 ps = subprocess.Popen([ghc_pkg, "dump", "--expand-pkgroot", "-f", os.path.dirname(os.path.join(execroot,db))], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-                subprocess.check_output([ghc_pkg, "update", "-f", deps_package_db, "-"], stdin=ps.stdout, stderr=subprocess.PIPE)
+                subprocess.check_output([ghc_pkg, "update", "--force", "-f", deps_package_db, "-"], stdin=ps.stdout, stderr=subprocess.PIPE)
                 ps.wait()
             except subprocess.CalledProcessError as err:
                 sys.stdout.buffer.write(err.stdout)

haskell/private/haddock_wrapper.sh.tpl

@@ -28,13 +28,6 @@ shellcheck(
     sh_flavor = "bash",
 )
 
-shellcheck(
-    name = "haddock_wrapper.sh",
-    args = ["$(location @rules_haskell//haskell:private/haddock_wrapper.sh.tpl)"],
-    data = ["@rules_haskell//haskell:private/haddock_wrapper.sh.tpl"],
-    sh_flavor = "bash",
-)
-
 shellcheck(
     name = "netlify-build",
     args = ["$(location @rules_haskell//:.netlify/build.sh)"],