mirror of
https://github.com/open-goal/jak-project
synced 2026-08-25 07:54:43 -04:00
5d5e35fb9b
## Problem Windows builds break with a current local toolchain (Scoop LLVM 22.1.8, CMake 4.4.0, VS 2026), in two independent ways: 1. The build stops at curl's deliberate guard: `#error "no non-blocking method was found/used/set"` in `third-party/curl/lib/nonblock.c`. 2. From the second configure onward, `cmake --build` re-runs CMake in an endless loop (observed 42 consecutive reconfigure cycles in a single build). Likely the same mechanism behind the "endlessly building" VS 2026 note in `docs/setup/dev/vs.md`. ## Root cause 1. `third-party/curl/CMake/CurlTests.c` passes `int *` to `ioctlsocket()`, whose third parameter is `u_long *`. Clang 22 promotes `-Wincompatible-pointer-types` to a hard error in C, so the `HAVE_IOCTLSOCKET_FIONBIO` try_compile silently fails and `curl_config.h` never defines it. Upstream CI does not see this because the windows-2022 runner image ships an older LLVM. GCC 14 promotes the same warning to a hard error, which is very likely the `CurlTests.c.obj` failure reported from MSYS2 in open-goal/jak-project#3551. Upstream curl hit the identical problem with GCC 14 and fixed the probe in curl 8.8.0 (curl/curl#13578). 2. The root CMakeLists copies the build tree's `compile_commands.json` into `<src>/build/` for clangd using `configure_file()`, which registers its input as a configure dependency. CMake rewrites `compile_commands.json` late in every generation, after `CTestTestfile.cmake` and `cmake_install.cmake` (outputs of the same Ninja regen rule), so once the dependency is registered the rule is deterministically dirty and every `ninja` invocation re-runs CMake. A pristine first configure is safe (the file does not exist yet, so the `if(EXISTS ...)` guard skips the copy), which is why the loop looks machine- or IDE-specific. ## Fix 1. Per review, re-vendor `third-party/curl` at the `curl-8_21_0` tag (previously `curl-8_3_0`), which carries the upstream probe fix plus two years of upstream development; `vendor.yaml` updated to match. Adjustments the version jump forced: - curl 8.15 removed the native macOS Secure Transport backend (`CURL_USE_SECTRANSP`), so macOS now builds curl against OpenSSL like Linux. The two macOS workflows install Homebrew `openssl@3` and export `OPENSSL_ROOT_DIR` (keg-only), and the macOS setup docs gained the same two lines. - `CURL_BROTLI` / `CURL_ZSTD` switched to AUTO-detection in curl 8.10; pinned OFF to keep the previous no-compression behavior and avoid silently linking whatever the CI images happen to have. - curl's new top-level `BUILD_EXAMPLES` cache option (default ON) leaked into discord-rpc's identically named option and broke configure at a nonexistent `examples/send-presence` directory; pinned OFF ahead of the third-party subdirectories. The diff is dominated by the mechanical tag-tree swap under `third-party/curl` (linguist-vendored, collapsed in review). The hand-written changes are `CMakeLists.txt`, the two macOS workflows, `docs/setup/system/macos.md`, and `vendor.yaml`. 2. Swap `configure_file()` for `file(COPY ...)`: the same clangd copy with no configure dependency registered. (`file(COPY_FILE ... ONLY_IF_DIFFERENT)` would be cleaner still but requires CMake 3.21, above the declared `cmake_minimum_required(VERSION 3.10)`.) ## Test plan - [x] Fresh `cmake --preset Release-windows-clang` (LLVM 22, no cache seeding) completes and logs `Enabled SSL backends: Schannel`; the FIONBIO probe passes without the previous `#error` - [x] Full Windows Release build from scratch in the branch worktree (all 1422 targets) - [x] goalc-test suite: 1509 passed, 0 failed - [x] Second consecutive configure with `compile_commands.json` present: the regen rule in `build.ninja` has no `compile_commands.json` input; `<src>/build/compile_commands.json` is still refreshed for clangd - [x] Repeated `ninja` invocations after a full build no longer re-run CMake - [x] macOS Intel and ARM CI green (first exercise of the OpenSSL backend switch) --- I work off a self-hosted forge, so this GitHub account is quiet; the configure logs and ninja dirty-node traces from the investigation are available if anyone wants the raw data. (AI-assisted)
123 lines
5.5 KiB
Python
Vendored
Generated
123 lines
5.5 KiB
Python
Vendored
Generated
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#***************************************************************************
|
|
# _ _ ____ _
|
|
# Project ___| | | | _ \| |
|
|
# / __| | | | |_) | |
|
|
# | (__| |_| | _ <| |___
|
|
# \___|\___/|_| \_\_____|
|
|
#
|
|
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
#
|
|
# This software is licensed as described in the file COPYING, which
|
|
# you should have received as part of this distribution. The terms
|
|
# are also available at https://curl.se/docs/copyright.html.
|
|
#
|
|
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
# copies of the Software, and permit persons to whom the Software is
|
|
# furnished to do so, under the terms of the COPYING file.
|
|
#
|
|
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
# KIND, either express or implied.
|
|
#
|
|
# SPDX-License-Identifier: curl
|
|
#
|
|
###########################################################################
|
|
#
|
|
import logging
|
|
import os
|
|
|
|
import pytest
|
|
from testenv import CurlClient, Env
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class TestInfo:
|
|
|
|
@pytest.fixture(autouse=True, scope='class')
|
|
def _class_scope(self, env, httpd):
|
|
indir = httpd.docs_dir
|
|
env.make_data_file(indir=indir, fname="data-10k", fsize=10 * 1024)
|
|
env.make_data_file(indir=indir, fname="data-100k", fsize=100 * 1024)
|
|
env.make_data_file(indir=indir, fname="data-1m", fsize=1024 * 1024)
|
|
env.make_data_file(indir=env.gen_dir, fname="data-100k", fsize=100 * 1024)
|
|
|
|
# download plain file
|
|
@pytest.mark.parametrize("proto", Env.http_protos())
|
|
def test_16_01_info_download(self, env: Env, httpd, nghttpx, proto):
|
|
count = 2
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/data.json?[0-{count-1}]'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, with_stats=True)
|
|
r.check_stats(count=count, http_status=200, exitcode=0,
|
|
remote_port=env.port_for(alpn_proto=proto),
|
|
remote_ip='127.0.0.1')
|
|
for idx, s in enumerate(r.stats):
|
|
self.check_stat(idx, s, r, dl_size=30, ul_size=0)
|
|
r.check_stats_timeline(idx)
|
|
|
|
# download plain file with a 302 redirect
|
|
@pytest.mark.parametrize("proto", Env.http_protos())
|
|
def test_16_02_info_302_download(self, env: Env, httpd, nghttpx, proto):
|
|
count = 2
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/data.json.302?[0-{count-1}]'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, with_stats=True, extra_args=[
|
|
'--location'
|
|
])
|
|
r.check_stats(count=count, http_status=200, exitcode=0,
|
|
remote_port=env.port_for(alpn_proto=proto),
|
|
remote_ip='127.0.0.1')
|
|
for idx, s in enumerate(r.stats):
|
|
self.check_stat(idx, s, r, dl_size=30, ul_size=0)
|
|
r.check_stats_timeline(idx)
|
|
|
|
@pytest.mark.parametrize("proto", Env.http_protos())
|
|
def test_16_03_info_upload(self, env: Env, httpd, nghttpx, proto):
|
|
count = 2
|
|
fdata = os.path.join(env.gen_dir, 'data-100k')
|
|
fsize = 100 * 1024
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/echo?id=[0-{count-1}]'
|
|
r = curl.http_upload(urls=[url], data=f'@{fdata}', alpn_proto=proto,
|
|
with_headers=True, extra_args=[
|
|
'--trace-config', 'http/2,http/3'
|
|
])
|
|
r.check_response(count=count, http_status=200)
|
|
r.check_stats(count=count, http_status=200, exitcode=0,
|
|
remote_port=env.port_for(alpn_proto=proto),
|
|
remote_ip='127.0.0.1')
|
|
for idx, s in enumerate(r.stats):
|
|
self.check_stat(idx, s, r, dl_size=fsize, ul_size=fsize)
|
|
r.check_stats_timeline(idx)
|
|
|
|
# download plain file via http: ('time_appconnect' is 0)
|
|
@pytest.mark.parametrize("proto", ['http/1.1'])
|
|
def test_16_04_info_http_download(self, env: Env, httpd, nghttpx, proto):
|
|
count = 2
|
|
curl = CurlClient(env=env)
|
|
url = f'http://{env.domain1}:{env.http_port}/data.json?[0-{count-1}]'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, with_stats=True)
|
|
r.check_stats(count=count, http_status=200, exitcode=0,
|
|
remote_port=env.http_port, remote_ip='127.0.0.1')
|
|
for idx, s in enumerate(r.stats):
|
|
self.check_stat(idx, s, r, dl_size=30, ul_size=0)
|
|
r.check_stats_timeline(idx)
|
|
|
|
def check_stat(self, idx, s, r, dl_size=None, ul_size=None):
|
|
# we always send something
|
|
self.check_stat_positive(s, idx, 'size_request')
|
|
# we always receive response headers
|
|
self.check_stat_positive(s, idx, 'size_header')
|
|
if ul_size is not None:
|
|
assert s['size_upload'] == ul_size, f'stat #{idx}\n{r.dump_logs()}' # the file we sent
|
|
assert s['size_request'] >= s['size_upload'], \
|
|
f'stat #{idx}, "size_request" smaller than "size_upload", {s}\n{r.dump_logs()}'
|
|
if dl_size is not None:
|
|
assert s['size_download'] == dl_size, f'stat #{idx}\n{r.dump_logs()}' # the file we received
|
|
|
|
def check_stat_positive(self, s, idx, key):
|
|
assert key in s, f'stat #{idx} "{key}" missing: {s}'
|
|
assert s[key] > 0, f'stat #{idx} "{key}" not positive: {s}'
|