mirror of
https://github.com/open-goal/jak-project
synced 2026-08-07 02:06:59 -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)
232 lines
10 KiB
Python
Vendored
Generated
232 lines
10 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 socket
|
|
import threading
|
|
|
|
import pytest
|
|
from testenv import CurlClient, Env
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
@pytest.mark.skipif(condition=not Env.httpd_is_at_least('2.4.55'),
|
|
reason=f"httpd version too old for this: {Env.httpd_version()}")
|
|
class TestErrors:
|
|
|
|
# download 1 file, check that we get CURLE_PARTIAL_FILE
|
|
@pytest.mark.parametrize("proto", Env.http_protos())
|
|
def test_05_01_partial_1(self, env: Env, httpd, nghttpx, proto):
|
|
if proto == 'h3' and env.curl_uses_lib('quiche') and \
|
|
not env.curl_lib_version_at_least('quiche', '0.29.0'):
|
|
pytest.skip("quiche issue #2277 not fixed")
|
|
count = 1
|
|
curl = CurlClient(env=env)
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}' \
|
|
f'/curltest/tweak?id=[0-{count - 1}]'\
|
|
'&chunks=3&chunk_size=16000&body_error=reset'
|
|
r = curl.http_download(urls=[urln], alpn_proto=proto, extra_args=[
|
|
'--retry', '0'
|
|
])
|
|
r.check_exit_code(False)
|
|
invalid_stats = []
|
|
for idx, s in enumerate(r.stats):
|
|
if 'exitcode' not in s or s['exitcode'] not in [18, 56, 92, 95]:
|
|
invalid_stats.append(f'request {idx} exit with {s["exitcode"]}')
|
|
assert len(invalid_stats) == 0, f'failed: {invalid_stats}'
|
|
|
|
# download files, check that we get CURLE_PARTIAL_FILE for all
|
|
@pytest.mark.parametrize("proto", Env.http_mplx_protos())
|
|
def test_05_02_partial_20(self, env: Env, httpd, nghttpx, proto):
|
|
if proto == 'h3' and env.curl_uses_lib('quiche') and \
|
|
not env.curl_lib_version_at_least('quiche', '0.29.0'):
|
|
pytest.skip("quiche issue #2277 not fixed")
|
|
count = 20
|
|
curl = CurlClient(env=env)
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}' \
|
|
f'/curltest/tweak?id=[0-{count - 1}]'\
|
|
'&chunks=5&chunk_size=16000&body_error=reset'
|
|
r = curl.http_download(urls=[urln], alpn_proto=proto, extra_args=[
|
|
'--retry', '0', '--parallel',
|
|
])
|
|
r.check_exit_code(False)
|
|
assert len(r.stats) == count, f'did not get all stats: {r}'
|
|
invalid_stats = []
|
|
for idx, s in enumerate(r.stats):
|
|
if 'exitcode' not in s or s['exitcode'] not in [18, 55, 56, 92, 95]:
|
|
invalid_stats.append(f'request {idx} exit with {s["exitcode"]}\n{r.dump_logs()}')
|
|
assert len(invalid_stats) == 0, f'failed: {invalid_stats}\n{r.dump_logs()}'
|
|
|
|
# access a resource that, on h2, RST the stream with HTTP_1_1_REQUIRED
|
|
@pytest.mark.skipif(condition=not Env.have_h2_curl(), reason="curl without h2")
|
|
def test_05_03_required(self, env: Env, httpd, nghttpx):
|
|
curl = CurlClient(env=env)
|
|
proto = 'http/1.1'
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}/curltest/1_1'
|
|
r = curl.http_download(urls=[urln], alpn_proto=proto)
|
|
r.check_exit_code(0)
|
|
r.check_response(http_status=200, count=1)
|
|
proto = 'h2'
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}/curltest/1_1'
|
|
r = curl.http_download(urls=[urln], alpn_proto=proto)
|
|
r.check_exit_code(0)
|
|
r.check_response(http_status=200, count=1)
|
|
# check that we did a downgrade
|
|
assert r.stats[0]['http_version'] == '1.1', r.dump_logs()
|
|
|
|
# On the URL used here, Apache is doing an "unclean" TLS shutdown,
|
|
# meaning it sends no shutdown notice and closes TCP.
|
|
# The HTTP response delivers a body without Content-Length. We expect:
|
|
# - http/1.0 to fail since it relies on a clean connection close to
|
|
# detect the end of the body
|
|
# - http/1.1 to work since it will used "chunked" transfer encoding
|
|
# and stop receiving when that signals the end
|
|
# - h2 to work since it will signal the end of the response before
|
|
# and not see the "unclean" close either
|
|
@pytest.mark.parametrize("proto", ['http/1.0', 'http/1.1', 'h2'])
|
|
def test_05_04_unclean_tls_shutdown(self, env: Env, httpd, nghttpx, proto):
|
|
if proto == 'h2' and not env.have_h2_curl():
|
|
pytest.skip("h2 not supported")
|
|
if proto == 'h3' and not env.have_h3():
|
|
pytest.skip("h3 not supported")
|
|
count = 10 if proto == 'h2' else 1
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}'\
|
|
f'/curltest/shutdown_unclean?id=[0-{count-1}]&chunks=4'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--parallel', '--trace-config', 'ssl'
|
|
])
|
|
if proto == 'http/1.0':
|
|
# we are inconsistent if we fail or not in missing TLS shutdown
|
|
# openssl code ignore such errors intentionally in non-debug builds
|
|
r.check_exit_code(56)
|
|
else:
|
|
r.check_exit_code(0)
|
|
r.check_response(http_status=200, count=count)
|
|
|
|
# Make a connect with a fail for '::1' and wrong certificate for '127.0.0.1'
|
|
# The error message reported needs to be from the certificate.
|
|
# verifies issue #20608
|
|
@pytest.mark.parametrize("proto", Env.http_h1_h2_protos())
|
|
def test_05_05_failed_peer(self, env: Env, proto, httpd, nghttpx):
|
|
domain = f'invalid.{env.tld}'
|
|
url = f'https://{domain}:{env.port_for(proto)}/'
|
|
run_env = os.environ.copy()
|
|
run_env['CURL_DBG_SOCK_FAIL_IPV6'] = '1'
|
|
curl = CurlClient(env=env, run_env=run_env)
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--resolve', f'{domain}:{env.port_for(proto)}:::1,127.0.0.1',
|
|
])
|
|
assert r.exit_code == 60, f'{r}'
|
|
assert r.stats[0]['errormsg'] != 'CURL_DBG_SOCK_FAIL_IPV6: failed to open socket'
|
|
|
|
# Get, retry on 502
|
|
def test_05_06_retry_502(self, env: Env, httpd, nghttpx):
|
|
proto = 'http/1.1'
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/tweak?status=502'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--retry', '2', '--retry-all-errors', '--retry-delay', '1',
|
|
])
|
|
r.check_response(http_status=502)
|
|
assert r.stats[0]['num_retries'] == 2, f'{r}'
|
|
# curious, since curl does the retries, it finds the previous
|
|
# connection in the cache and reports that no connects were done
|
|
assert r.stats[0]['num_connects'] == 0, f'{r}'
|
|
|
|
# Get, retry on 502 in parallel mode
|
|
def test_05_07_retry_502_parallel(self, env: Env, httpd, nghttpx):
|
|
proto = 'http/1.1'
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/tweak?status=502'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--retry', '2', '--retry-all-errors', '--retry-delay', '1', '--parallel'
|
|
])
|
|
r.check_response(http_status=502)
|
|
assert r.stats[0]['num_retries'] == 2, f'{r}'
|
|
|
|
# Get, retry on 401, not happening
|
|
def test_05_08_retry_401(self, env: Env, httpd, nghttpx):
|
|
proto = 'http/1.1'
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/tweak?status=401'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--retry', '2', '--retry-all-errors', '--retry-delay', '1'
|
|
])
|
|
r.check_response(http_status=401)
|
|
# No retries on a 401
|
|
assert r.stats[0]['num_retries'] == 0, f'{r}'
|
|
|
|
# Server closes the connection immediately after accept,
|
|
def test_05_09_handshake_eof(self, env: Env):
|
|
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as server:
|
|
server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
server.bind(('127.0.0.1', 0))
|
|
server.listen(1)
|
|
port = server.getsockname()[1]
|
|
|
|
# accept one connection and immediately close it
|
|
def accept_and_close():
|
|
try:
|
|
conn, _ = server.accept()
|
|
conn.recv(1) # wait for ClientHello
|
|
conn.close()
|
|
except Exception:
|
|
# ignore expected socket error
|
|
pass
|
|
|
|
t = threading.Thread(target=accept_and_close)
|
|
t.start()
|
|
|
|
run_env = os.environ.copy()
|
|
run_env['CURL_DEBUG'] = 'all'
|
|
curl = CurlClient(env=env, timeout=env.test_timeout, run_env=run_env)
|
|
url = f'https://127.0.0.1:{port}/'
|
|
r = curl.run_direct(args=[url, '--insecure', '-v'])
|
|
|
|
t.join(timeout=10)
|
|
|
|
# We expect an error code, not success (0) and not timeout (-1)
|
|
# Expected error codes are:
|
|
# - CURLE_SSL_CONNECT_ERROR (35) - common for handshake failures
|
|
# - CURLE_RECV_ERROR (56) - some TLS backends fail with that
|
|
assert r.exit_code in [35, 56], \
|
|
f'unexpected error {r.exit_code}\n{r.dump_logs()}'
|
|
|
|
# Get a resource many times with limited requests
|
|
@pytest.mark.skipif(condition=not Env.have_h2_curl(), reason='curl without HTTP/2')
|
|
def test_05_10_limits(self, env: Env, httpd):
|
|
proto = 'h2'
|
|
count = 6
|
|
curl = CurlClient(env=env)
|
|
url = f'https://{env.authority_for(env.domain1, proto)}/curltest/limit?id=[0-{count-1}]'
|
|
r = curl.http_download(urls=[url], alpn_proto=proto, extra_args=[
|
|
'--parallel', '--retry', '5'
|
|
])
|
|
r.check_stats(count=count, http_status=200, exitcode=0)
|