From 30c667ec3a11ef4fdf4a681112be7c293fecebe5 Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Fri, 31 Mar 2023 10:31:01 +0200 Subject: [PATCH] tools: automate brotli update PR-URL: https://github.com/nodejs/node/pull/47205 Refs: https://github.com/nodejs/security-wg/issues/828 Reviewed-By: Matteo Collina Reviewed-By: Adrian Estrada --- .github/workflows/tools.yml | 8 +++ tools/dep_updaters/update-brotli.sh | 75 +++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100755 tools/dep_updaters/update-brotli.sh diff --git a/.github/workflows/tools.yml b/.github/workflows/tools.yml index 0865467060bde1..0ee2cfc758f757 100644 --- a/.github/workflows/tools.yml +++ b/.github/workflows/tools.yml @@ -159,6 +159,14 @@ jobs: cat temp-output tail -n1 temp-output | grep "NEW_VERSION=" >> "$GITHUB_ENV" || true rm temp-output + - id: brotli + subsystem: deps + label: dependencies + run: | + ./tools/dep_updaters/update-brotli.sh > temp-output + cat temp-output + tail -n1 temp-output | grep "NEW_VERSION=" >> "$GITHUB_ENV" || true + rm temp-output steps: - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 with: diff --git a/tools/dep_updaters/update-brotli.sh b/tools/dep_updaters/update-brotli.sh new file mode 100755 index 00000000000000..651ae57d3f2e62 --- /dev/null +++ b/tools/dep_updaters/update-brotli.sh @@ -0,0 +1,75 @@ +#!/bin/sh +set -e +# Shell script to update brotli in the source tree to a specific version + +BASE_DIR=$(cd "$(dirname "$0")/../.." && pwd) +DEPS_DIR="$BASE_DIR/deps" + +[ -z "$NODE" ] && NODE="$BASE_DIR/out/Release/node" +[ -x "$NODE" ] || NODE=$(command -v node) + +NEW_VERSION="$("$NODE" --input-type=module <<'EOF' +const res = await fetch('https://api.github.com/repos/google/brotli/releases/latest'); +if (!res.ok) throw new Error(`FetchError: ${res.status} ${res.statusText}`, { cause: res }); +const { tag_name } = await res.json(); +console.log(tag_name.replace('v', '')); +EOF +)" + +VERSION_HEX=$(grep "#define BROTLI_VERSION" ./deps/brotli/c/common/version.h | sed 's/.* //') + +major=$(( ($VERSION_HEX >> 24) & 0xff )) +minor=$(( ($VERSION_HEX >> 12) & 0xfff )) +patch=$(( $VERSION_HEX & 0xfff )) +CURRENT_VERSION="${major}.${minor}.${patch}" + +echo "Comparing $NEW_VERSION with $CURRENT_VERSION" + +if [ "$NEW_VERSION" = "$CURRENT_VERSION" ]; then + echo "Skipped because brotli is on the latest version." + exit 0 +fi + +echo "Making temporary workspace" + +WORKSPACE=$(mktemp -d 2> /dev/null || mktemp -d -t 'tmp') + +cleanup () { + EXIT_CODE=$? + [ -d "$WORKSPACE" ] && rm -rf "$WORKSPACE" + exit $EXIT_CODE +} + +trap cleanup INT TERM EXIT + +cd "$WORKSPACE" + +BROTLI_TARBALL="v$NEW_VERSION.tar.gz" + +echo "Fetching brotli source archive" +curl -sL -o "$BROTLI_TARBALL" "https://github.com/google/brotli/archive/$BROTLI_TARBALL" +gzip -dc "$BROTLI_TARBALL" | tar xf - +rm "$BROTLI_TARBALL" +mv "brotli-$NEW_VERSION" "brotli" + +echo "Copying existing gyp file" +cp "$DEPS_DIR/brotli/brotli.gyp" "$WORKSPACE/brotli" + +echo "Deleting existing brotli" +rm -rf "$DEPS_DIR/brotli" +mkdir "$DEPS_DIR/brotli" + +echo "Update c and LICENSE" +mv "$WORKSPACE/brotli/c" "$WORKSPACE/brotli/LICENSE" "$WORKSPACE/brotli/brotli.gyp" "$DEPS_DIR/brotli" + +echo "All done!" +echo "" +echo "Please git add brotli, commit the new version:" +echo "" +echo "$ git add -A deps/brotli" +echo "$ git commit -m \"deps: update brotli to $NEW_VERSION\"" +echo "" + +# The last line of the script should always print the new version, +# as we need to add it to $GITHUB_ENV variable. +echo "NEW_VERSION=$NEW_VERSION"