cross-sdk.yml

name: Cross-SDK and load scenarios

# Runs integration-testing/ (interop with the TypeScript, Rust, Python and Kotlin SDKs, plus load
# runs) against this checkout. One job per peer and transport, each installing only its own
# toolchain; a prepare job per peer builds the peer once and caches it under the peer's commit, so
# that peer's transport jobs reuse the build. Deliberately not on push or pull_request (the
# Java <-> Java cells run there, from interop-java.yml): it needs several toolchains, clones the
# peer SDKs and takes minutes. It never gates the release workflow.
on:
  workflow_dispatch:
    inputs:
      peers-ref:
        description: 'Branch, tag or SHA to test every peer SDK at (empty: each peer''s ref in peers.json)'
        required: false
        default: ''
      peer-overrides:
        description: 'Per-peer refs, space separated, e.g. "typescript-sdk=v0.5.0 rust-sdk=v1.2.0"'
        required: false
        default: ''
      peer:
        description: 'Run one peer only (java: the Java <-> Java cells, conformance and load)'
        type: choice
        required: false
        default: 'all'
        options: [all, java, typescript, rust, python, kotlin]
  schedule:
    - cron: '17 4 * * *'

permissions:
  contents: read

concurrency:
  group: cross-sdk-${{ github.ref }}
  cancel-in-progress: false

jobs:
  # The job matrices, computed so that a manual run can pick one peer (a static include cannot be
  # filtered by an input). One "prepare" leg per peer SDK, one "cells" leg per peer and transport.
  plan:
    runs-on: ubuntu-latest
    timeout-minutes: 5
    outputs:
      prepare: ${{ steps.pick.outputs.prepare }}
      cells: ${{ steps.pick.outputs.cells }}
      has-prepare: ${{ steps.pick.outputs.has-prepare }}
    steps:
      - id: pick
        env:
          PEER: ${{ github.event.inputs.peer || 'all' }}
        run: |
          # Per peer: its toolchain, its transports (cells x-java-<peer>-<t> and x-<peer>-java-<t>),
          # and the cache paths of its build.
          # java runs as one leg: the Java <-> Java cells, conformance, load.
          # kotlin has no Streamable HTTP; its Gradle toolchain is JDK 21 while the SDK and the
          # Java programs stay on 17 (the last version listed is the default).
          peers="$(jq -c . <<'JSON'
          [
            { "peer": "java", "java": "17", "only": "x-java-java-*,conf-*,load-*" },
            { "peer": "typescript", "sdk": "typescript-sdk", "java": "17", "node": true,
              "transports": ["stdio", "http", "ws"],
              "cache-paths": "integration-testing/.cache/peers/typescript-sdk@*\n~/.npm" },
            { "peer": "rust", "sdk": "rust-sdk", "java": "17", "rust": true,
              "transports": ["stdio", "http", "ws"],
              "cache-paths": "integration-testing/.cache/peers/rust-sdk@*\nintegration-testing/.cache/build\n~/.cargo/registry/index\n~/.cargo/registry/cache\n~/.cargo/git/db" },
            { "peer": "python", "sdk": "python-sdk", "java": "17", "python": true,
              "transports": ["stdio", "http", "ws"],
              "cache-paths": "integration-testing/.cache/peers/python-sdk@*" },
            { "peer": "kotlin", "sdk": "kotlin-sdk", "java": "21\n17", "gradle": true,
              "transports": ["stdio", "ws"],
              "cache-paths": "integration-testing/.cache/peers/kotlin-sdk@*\n~/.gradle/caches\n~/.gradle/wrapper" }
          ]
          JSON
          )"
          picked="$(jq -c --arg p "$PEER" '[.[] | select($p == "all" or .peer == $p)]' <<< "$peers")"
          prepare="$(jq -c '{include: [.[] | select(.sdk)
            | . + {only: (["x-*-\(.peer)-*", "x-\(.peer)-*"] | join(","))}
            | del(.transports)]}' <<< "$picked")"
          cells="$(jq -c '{include: [.[] as $x | ($x.transports // ["all"])[] as $t
            | $x + (if $t == "all" then {leg: $x.peer} else {leg: "\($x.peer)-\($t)", transport: $t,
                only: (["x-java-\($x.peer)-\($t)*", "x-\($x.peer)-java-\($t)*"] | join(","))} end)
            | del(.transports)]}' <<< "$picked")"
          jq . <<< "$cells"
          {
            echo "prepare=$prepare"
            echo "cells=$cells"
            echo "has-prepare=$(jq '.include | length > 0' <<< "$prepare")"
          } >> "$GITHUB_OUTPUT"

  # Clone and build each peer once, and cache it under the peer's resolved commit for its legs.
  prepare:
    name: prepare ${{ matrix.peer }}
    needs: plan
    if: needs.plan.outputs.has-prepare == 'true'
    runs-on: ubuntu-latest
    timeout-minutes: 45
    strategy:
      fail-fast: false
      matrix: ${{ fromJSON(needs.plan.outputs.prepare) }}
    steps:
      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4

      - name: Set up JDK
        uses: actions/setup-java@cf277c60eb25467037889841efdb72551f06f6c3 # v4
        with:
          java-version: ${{ matrix.java }}
          distribution: 'temurin'
          cache: maven

      - name: Cache the Maven distribution the wrapper uses
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: ~/.m2/wrapper
          key: maven-wrapper-${{ hashFiles('.mvn/wrapper/maven-wrapper.properties') }}

      - name: Set up Node 20
        if: matrix.node
        id: node
        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
        with:
          node-version: '20'

      - name: Set up Rust stable
        if: matrix.rust
        uses: dtolnay/rust-toolchain@02cb101ec7c40f2c49e1d9714d64511d8e1b74de # v1
        with:
          toolchain: stable

      - name: Set up Python 3.12
        if: matrix.python
        id: python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: '3.12'

      - name: Point Gradle toolchains at JDK 21
        if: matrix.gradle
        run: |
          mkdir -p ~/.gradle
          echo "org.gradle.java.installations.fromEnv=JAVA_HOME_21_X64" >> ~/.gradle/gradle.properties
          # The Kotlin SDK's buildSrc needs Gradle itself to run on JDK 21 (JAVA_HOME is 17 here).
          echo "org.gradle.java.home=$JAVA_HOME_21_X64" >> ~/.gradle/gradle.properties

      - name: Set up JBang
        uses: jbangdev/setup-jbang@2b1b465a7b75f4222b81426f23a01e013aa7b95c # v0.1.1
        with:
          version: '0.135.1'
          setup-java: 'false'

      - name: Resolve the peer SDK commit
        id: peer
        env:
          SDK: ${{ matrix.sdk }}
          PEERS_REF: ${{ github.event.inputs.peers-ref || '' }}
          PEER_OVERRIDES: ${{ github.event.inputs.peer-overrides || '' }}
        run: integration-testing/scripts/peer-sha.sh "$SDK" "$PEERS_REF" "$PEER_OVERRIDES" >> "$GITHUB_OUTPUT"

      # The key carries the toolchain version the build depends on (the Python venv, Node's
      # node_modules) and the commit; a newer commit restores the last build and updates it.
      - name: Cache the peer SDK build
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: ${{ matrix.cache-paths }}
          key: cross-sdk-${{ matrix.sdk }}-tc${{ steps.python.outputs.python-version }}${{ steps.node.outputs.node-version }}-${{ steps.peer.outputs.sha }}-${{ hashFiles('integration-testing/programs/**/Cargo.toml', 'integration-testing/programs/**/*.gradle.kts') }}
          restore-keys: |
            cross-sdk-${{ matrix.sdk }}-tc${{ steps.python.outputs.python-version }}${{ steps.node.outputs.node-version }}-

      - name: Fetch and build the ${{ matrix.peer }} peer and programs
        env:
          PEERS_REF: ${{ github.event.inputs.peers-ref || '' }}
          PEER_OVERRIDES: ${{ github.event.inputs.peer-overrides || '' }}
          ONLY: ${{ matrix.only }}
        run: |
          args=(--only "$ONLY" --prepare-only)
          if [ -n "$PEERS_REF" ]; then args+=(--peers-ref "$PEERS_REF"); fi
          for o in $PEER_OVERRIDES; do args+=(--peer "$o"); done
          integration-testing/scripts/run-all.sh "${args[@]}"

      - name: Upload preparation logs
        if: failure()
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
        with:
          name: cross-sdk-prepare-logs-${{ matrix.peer }}
          path: integration-testing/logs/
          if-no-files-found: ignore
          retention-days: 14

  scenarios:
    name: ${{ matrix.leg }}
    needs: [plan, prepare]
    # Also runs when a prepare leg failed (that peer's legs then build for themselves) or was
    # skipped (java only).
    if: ${{ !cancelled() && needs.plan.result == 'success' }}
    runs-on: ubuntu-latest
    timeout-minutes: 45
    strategy:
      fail-fast: false
      matrix: ${{ fromJSON(needs.plan.outputs.cells) }}

    steps:
      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4

      - name: Set up JDK
        uses: actions/setup-java@cf277c60eb25467037889841efdb72551f06f6c3 # v4
        with:
          java-version: ${{ matrix.java }}
          distribution: 'temurin'
          cache: maven

      - name: Cache the Maven distribution the wrapper uses
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: ~/.m2/wrapper
          key: maven-wrapper-${{ hashFiles('.mvn/wrapper/maven-wrapper.properties') }}

      - name: Set up Node 20
        if: matrix.node
        id: node
        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
        with:
          node-version: '20'

      - name: Set up Rust stable
        if: matrix.rust
        uses: dtolnay/rust-toolchain@02cb101ec7c40f2c49e1d9714d64511d8e1b74de # v1
        with:
          toolchain: stable

      - name: Set up Python 3.12
        if: matrix.python
        id: python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: '3.12'

      - name: Point Gradle toolchains at JDK 21
        if: matrix.gradle
        run: |
          mkdir -p ~/.gradle
          echo "org.gradle.java.installations.fromEnv=JAVA_HOME_21_X64" >> ~/.gradle/gradle.properties
          # The Kotlin SDK's buildSrc needs Gradle itself to run on JDK 21 (JAVA_HOME is 17 here).
          echo "org.gradle.java.home=$JAVA_HOME_21_X64" >> ~/.gradle/gradle.properties

      - name: Set up JBang
        uses: jbangdev/setup-jbang@2b1b465a7b75f4222b81426f23a01e013aa7b95c # v0.1.1
        with:
          version: '0.135.1'
          setup-java: 'false'

      - name: Check the generated configs are up to date
        if: matrix.peer == 'java'
        working-directory: integration-testing
        run: |
          jbang GenConfigs.java --check
          python3 programs/raw/gen_conf.py --check

      - name: Resolve the peer SDK commit
        if: matrix.sdk
        id: peer
        env:
          SDK: ${{ matrix.sdk }}
          PEERS_REF: ${{ github.event.inputs.peers-ref || '' }}
          PEER_OVERRIDES: ${{ github.event.inputs.peer-overrides || '' }}
        run: integration-testing/scripts/peer-sha.sh "$SDK" "$PEERS_REF" "$PEER_OVERRIDES" >> "$GITHUB_OUTPUT"

      # Restore only: the prepare job saved this key. On a miss the leg builds for itself.
      - name: Restore the peer SDK build
        if: matrix.sdk
        uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: ${{ matrix.cache-paths }}
          key: cross-sdk-${{ matrix.sdk }}-tc${{ steps.python.outputs.python-version }}${{ steps.node.outputs.node-version }}-${{ steps.peer.outputs.sha }}-${{ hashFiles('integration-testing/programs/**/Cargo.toml', 'integration-testing/programs/**/*.gradle.kts') }}
          restore-keys: |
            cross-sdk-${{ matrix.sdk }}-tc${{ steps.python.outputs.python-version }}${{ steps.node.outputs.node-version }}-

      - name: Run the ${{ matrix.leg }} scenarios
        env:
          PEERS_REF: ${{ github.event.inputs.peers-ref || '' }}
          PEER_OVERRIDES: ${{ github.event.inputs.peer-overrides || '' }}
          ONLY: ${{ matrix.only }}
          RUN_LABEL: ${{ matrix.leg }}
        run: |
          args=(--only "$ONLY")
          if [ -n "$PEERS_REF" ]; then args+=(--peers-ref "$PEERS_REF"); fi
          for o in $PEER_OVERRIDES; do args+=(--peer "$o"); done
          integration-testing/scripts/run-all.sh "${args[@]}"

      - name: Upload scenario logs
        if: always()
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
        with:
          name: cross-sdk-logs-${{ matrix.leg }}
          path: integration-testing/logs/
          if-no-files-found: ignore
          retention-days: 14