From 1079c8099dcf3938f157d821162ddbd43b10f405 Mon Sep 17 00:00:00 2001 From: Paolo Insogna Date: Thu, 15 Sep 2022 12:38:45 +0200 Subject: [PATCH] tools: add update-llhttp.sh MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/44652 Reviewed-By: Michael Dawson Reviewed-By: Matteo Collina Co-authored-by: Antoine du Hamel Co-authored-by: Tobias Nießen Co-authored-by: Luigi Pinca --- deps/llhttp/CMakeLists.txt | 2 +- doc/contributing/maintaining-http.md | 48 ++++++++++----------- tools/update-llhttp.sh | 63 ++++++++++++++++++++++++++++ 3 files changed, 88 insertions(+), 25 deletions(-) create mode 100755 tools/update-llhttp.sh diff --git a/deps/llhttp/CMakeLists.txt b/deps/llhttp/CMakeLists.txt index da0ce17b0cb3c9..7d63f77d2aea51 100644 --- a/deps/llhttp/CMakeLists.txt +++ b/deps/llhttp/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.5.1) cmake_policy(SET CMP0069 NEW) -project(llhttp VERSION ) +project(llhttp VERSION 6.0.9) include(GNUInstallDirs) set(CMAKE_C_STANDARD 99) diff --git a/doc/contributing/maintaining-http.md b/doc/contributing/maintaining-http.md index 2888367d861103..a0a2316844c1dd 100644 --- a/doc/contributing/maintaining-http.md +++ b/doc/contributing/maintaining-http.md @@ -78,32 +78,32 @@ are maintained in the [llhttp](https://github.com/nodejs/llhttp) repository. Updates are pulled into Node.js under [deps/llhttp](https://github.com/nodejs/node/tree/HEAD/deps/llhttp). -In order to update Node.js with a new version of llhttp: - -* check out the tagged release that you want to update to (a release - should be created in the llhttp repo before updating Node.js). -* run `npm install` in the directory that you checked out llhttp. -* run `make release` in the directory that you checked out llhttp. -* copy the contents of the `release` directory from the directory you - checked llhttp out to - [deps/llhttp](https://github.com/nodejs/node/tree/HEAD/deps/llhttp) - -It should look like the following: - -```console -├── CMakeLists.txt -├── common.gypi -├── include -│ └── llhttp.h -├── LICENSE-MIT -├── llhttp.gyp -├── README.md -└── src - ├── api.c - ├── http.c - └── llhttp.c +In order to update Node.js with a new version of llhttp you can use the +`tools/update-llhttp.sh` script. + +The contents of the `deps/llhttp` folder should look like the following: + +```bash +$ find deps/llhttp + +deps/llhttp/ +deps/llhttp/CMakeLists.txt +deps/llhttp/include +deps/llhttp/include/llhttp.h +deps/llhttp/llhttp.gyp +deps/llhttp/README.md +deps/llhttp/common.gypi +deps/llhttp/libllhttp.pc.in +deps/llhttp/LICENSE-MIT +deps/llhttp/src +deps/llhttp/src/api.c +deps/llhttp/src/http.c +deps/llhttp/src/llhttp.c ``` +After updating, make sure the version in `CMakeLists.txt` and `include/llhttp.h` +are the same and that they match the one you are expecting. + The low-level implementation is made available in the Node.js API through JavaScript code in the [lib](https://github.com/nodejs/node/tree/HEAD/lib) directory and C++ code in the diff --git a/tools/update-llhttp.sh b/tools/update-llhttp.sh new file mode 100755 index 00000000000000..12e2f465d7d26c --- /dev/null +++ b/tools/update-llhttp.sh @@ -0,0 +1,63 @@ +#!/bin/sh +set -e + +# Shell script to update llhttp in the source tree to specific version + +BASE_DIR="$( pwd )"/ +DEPS_DIR="${BASE_DIR}deps/" +LLHTTP_VERSION="$1" + +if [ "$#" -le 0 ]; then + echo "Error: Please provide an llhttp version to update to." + echo "Error: To download directly from GitHub, use the organization/repository syntax, without the .git suffix." + exit 1 +fi + +cleanup () { + EXIT_CODE=$? + [ -d "$WORKSPACE" ] && rm -rf "$WORKSPACE" + exit $EXIT_CODE +} + +echo "Making temporary workspace ..." +WORKSPACE=$(mktemp -d 2> /dev/null || mktemp -d -t 'tmp') +trap cleanup INT TERM EXIT + +cd "$WORKSPACE" + +if echo "$LLHTTP_VERSION" | grep -qs "/" ; then # Download a release + REPO="git@github.com:$LLHTTP_VERSION.git" + BRANCH=$2 + [ -z "$BRANCH" ] && BRANCH=main + + echo "Cloning llhttp source archive $REPO ..." + git clone "$REPO" llhttp + cd llhttp + echo "Checking out branch $BRANCH ..." + git checkout "$BRANCH" + + echo "Building llhtttp ..." + npm install + make release + + echo "Copying llhtttp release ..." + rm -rf "$DEPS_DIR/llhttp" + cp -a release "$DEPS_DIR/llhttp" +else + echo "Download llhttp release $LLHTTP_VERSION ..." + curl -sL -o llhttp.tar.gz "https://github.com/nodejs/llhttp/archive/refs/tags/release/v$LLHTTP_VERSION.tar.gz" + gzip -dc llhttp.tar.gz | tar xf - + + echo "Copying llhtttp release ..." + rm -rf "$DEPS_DIR/llhttp" + cp -a "llhttp-release-v$LLHTTP_VERSION" "$DEPS_DIR/llhttp" +fi + +echo "" +echo "All done!" +echo "" +echo "Please git add llhttp, commit the new version:" +echo "" +echo "$ git add -A deps/llhttp" +echo "$ git commit -m \"deps: update nghttp2 to $LLHTTP_VERSION\"" +echo ""