KMP の xcframework を R2 にキャッシュして Xcode Cloud のビルドを速くする

#!/bin/bash
#
# KMP の xcframework を、入力のハッシュをキーにしてキャッシュする。
#
# 使い方: kmp_framework_cache.sh <framework を生成するコマンド...>
#   例: kmp_framework_cache.sh ./gradlew :shared:assembleSharedReleaseXCFramework
#
# キャッシュにあれば xcframework を取得して展開し、生成コマンドを実行せず、
# なければ生成コマンドを実行して保存する。
#
# 保存先（優先順）:
#   KMP_CACHE_DIR                   ローカルのディレクトリ（検証用）
#   R2_BUCKET_NAME / R2_ENDPOINT_URL / AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY
#                                   Cloudflare R2（aws CLI が必要）
#   どちらもない                    キャッシュなしで生成コマンドを実行する
#
# 書き込みは KMP_CACHE_WRITE=1、または Xcode Cloud の main ブランチ（PR 以外）のときだけ。
# KMP_CACHE_DISABLE=1 でキャッシュを使わない。
# キャッシュ関連の失敗はビルドを止めず、キャッシュなしで生成コマンドを実行する。

set -uo pipefail

[[ $# -gt 0 ]] || { echo "使い方: $0 <command...>" >&2; exit 2; }

readonly REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
readonly OUT_DIR="${REPO_ROOT}/shared/build/XCFrameworks/release/Shared.xcframework"
readonly PREFIX="kmp-framework"

log() { echo "[kmp-cache] $*"; }

# Xcode Cloud には JDK が無く、PATH にも Homebrew が無いため、ci_post_clone.sh で入れたものを探す。
if [[ -z ${JAVA_HOME:-} ]] && ! /usr/libexec/java_home > /dev/null 2>&1; then
  for prefix in /opt/homebrew /usr/local; do
    jdk="${prefix}/opt/openjdk@17/libexec/openjdk.jdk/Contents/Home"
    [[ -d ${jdk} ]] && { export JAVA_HOME="${jdk}"; break; }
  done
fi
for prefix in /opt/homebrew /usr/local; do
  [[ -d ${prefix}/bin ]] && PATH="${PATH}:${prefix}/bin"
done
export PATH

# --- キー -------------------------------------------------------------------

# 作業ツリーの内容をハッシュする（未コミットの変更や新規ファイルも反映するため）。
compute_key() {
  cd "${REPO_ROOT}" || return 1
  local files
  files=$(
    git ls-files -z --cached --others --exclude-standard -- \
      shared gradle build.gradle.kts settings.gradle.kts gradle.properties \
      | while IFS= read -r -d '' f; do [[ -f ${f} ]] && printf '%s\0' "${f}"; done \
      | LC_ALL=C sort -z | xargs -0 shasum -a 256
  ) || return 1
  [[ -n ${files} ]] || return 1
  {
    echo "${files}"
    echo "xcode=${XCODE_PRODUCT_BUILD_VERSION:-$(xcodebuild -version | tr '\n' ' ')}"
  } | shasum -a 256 | cut -d' ' -f1
}

# --- 保存先 -----------------------------------------------------------------

backend() {
  if [[ ${KMP_CACHE_DISABLE:-} == 1 ]]; then
    echo none
  elif [[ -n ${KMP_CACHE_DIR:-} ]]; then
    echo local
  elif command -v aws > /dev/null && [[ -n ${R2_BUCKET_NAME:-} && -n ${R2_ENDPOINT_URL:-} \
    && -n ${AWS_ACCESS_KEY_ID:-} && -n ${AWS_SECRET_ACCESS_KEY:-} ]]; then
    echo r2
  else
    echo none
  fi
}

can_write() {
  [[ ${KMP_CACHE_WRITE:-} == 1 ]] \
    || [[ -z ${KMP_CACHE_WRITE:-} && ${CI_BRANCH:-} == main && -z ${CI_PULL_REQUEST_NUMBER:-} ]]
}

# fetch <key> <dest>: 成功で 0。キャッシュに無い場合は静かに、それ以外の失敗は理由を出して非 0。
fetch() {
  local err
  case "$(backend)" in
    local) cp "${KMP_CACHE_DIR}/${PREFIX}-$1.tar.gz" "$2" 2> /dev/null ;;
    r2)
      err=$(aws s3 cp "s3://${R2_BUCKET_NAME}/${PREFIX}/$1.tar.gz" "$2" \
        --endpoint-url "${R2_ENDPOINT_URL}" --region auto --only-show-errors 2>&1) && return 0
      [[ ${err} == *404* ]] || log "R2 からの取得に失敗しました: ${err##*$'\n'}"
      return 1
      ;;
  esac
}

store() {
  case "$(backend)" in
    local) mkdir -p "${KMP_CACHE_DIR}" && cp "$2" "${KMP_CACHE_DIR}/${PREFIX}-$1.tar.gz" ;;
    r2) aws s3 cp "$2" "s3://${R2_BUCKET_NAME}/${PREFIX}/$1.tar.gz" \
      --endpoint-url "${R2_ENDPOINT_URL}" --region auto --only-show-errors ;;
  esac
}

# --- 取得と保存 -------------------------------------------------------------

# 一時ディレクトリに展開してから出力先へ移す（壊れたキャッシュで出力先を消さないため）。
restore() {
  local tmp
  tmp=$(mktemp -d) || return 1
  if fetch "$1" "${tmp}/cache.tar.gz" && mkdir "${tmp}/out" \
    && tar -xzf "${tmp}/cache.tar.gz" -C "${tmp}/out" \
    && rm -rf "${OUT_DIR}" && mkdir -p "$(dirname "${OUT_DIR}")" && mv "${tmp}/out/$(basename "${OUT_DIR}")" "${OUT_DIR}"; then
    rm -rf "${tmp}"
    return 0
  fi
  rm -rf "${tmp}"
  return 1
}

save() {
  local tmp start
  tmp=$(mktemp -d) || return 1
  start=$(date +%s)
  if tar -czf "${tmp}/cache.tar.gz" -C "$(dirname "${OUT_DIR}")" "$(basename "${OUT_DIR}")" && store "$1" "${tmp}/cache.tar.gz"; then
    log "保存しました ($(du -h "${tmp}/cache.tar.gz" | cut -f1), $(( $(date +%s) - start ))s)"
  else
    log "保存に失敗しました"
  fi
  rm -rf "${tmp}"
}

# --- 本体 -------------------------------------------------------------------

if [[ $(backend) == none ]]; then
  [[ -n ${CI_XCODE_CLOUD:-} && ${KMP_CACHE_DISABLE:-} != 1 ]] && log "保存先の設定が不足しているため、キャッシュを使いません"
  exec "$@"
fi

KEY=$(compute_key) || KEY=""
if [[ -z ${KEY} ]]; then
  log "キーを計算できないため、キャッシュを使いません"
  exec "$@"
fi

START=$(date +%s)
if restore "${KEY}"; then
  log "HIT ${KEY:0:12} ($(( $(date +%s) - START ))s)"
  exit 0
fi
log "MISS ${KEY:0:12}"

"$@" || exit $?

if can_write && [[ -d ${OUT_DIR} ]]; then
  save "${KEY}"
fi
exit 0