sdk-typescript.yml

name: typescript
on:
  pull_request:
    paths:
      - ".github/**"
      - "api/**"
      - "api-contracts/**"
      - "internal/**"
      - "pkg/**"
      - "sdks/typescript/**"
  push:
    branches:
      - main
    paths:
      - "sdks/typescript/**"
defaults:
  run:
    working-directory: ./sdks/typescript

jobs:
  lint:
    runs-on: ubicloud-standard-4
    strategy:
      matrix:
        include:
          - package-manager: pnpm
            install-cmd: pnpm install
            lint-cmd: pnpm lint:check
            tsc-cmd: pnpm exec tsc
            unit-test-cmd: pnpm test:unit
            e2e-test-cmd: pnpm test:e2e
          - package-manager: bun
            install-cmd: bun install
            lint-cmd: bun run lint:check
            tsc-cmd: bunx tsc
            unit-test-cmd: bun run test:unit
            e2e-test-cmd: bun run test:e2e
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          submodules: recursive

      - name: Install pnpm
        if: matrix.package-manager == 'pnpm'
        run: npm install -g pnpm@10.16.1

      - name: Get pnpm store directory
        if: matrix.package-manager == 'pnpm'
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

      - name: Setup pnpm cache
        if: matrix.package-manager == 'pnpm'
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ${{ env.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Setup Bun
        if: matrix.package-manager == 'bun'
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: latest
          cache: true
          cache-dependency-path: sdks/typescript/pnpm-lock.yaml

      - name: Install dependencies
        run: ${{ matrix.install-cmd }}

      - name: Lint
        run: ${{ matrix.lint-cmd }}

      - name: Type check
        run: ${{ matrix.tsc-cmd }}

  test-unit:
    runs-on: ubicloud-standard-4
    strategy:
      matrix:
        include:
          - package-manager: pnpm
            install-cmd: pnpm install
            lint-cmd: pnpm lint:check
            tsc-cmd: pnpm exec tsc
            unit-test-cmd: pnpm test:unit
            e2e-test-cmd: pnpm test:e2e
          - package-manager: bun
            install-cmd: bun install
            lint-cmd: bun run lint:check
            tsc-cmd: bunx tsc
            unit-test-cmd: bun run test:unit
            e2e-test-cmd: bun run test:e2e
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          submodules: recursive

      - name: Install pnpm
        if: matrix.package-manager == 'pnpm'
        run: npm install -g pnpm@10.16.1

      - name: Get pnpm store directory
        if: matrix.package-manager == 'pnpm'
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

      - name: Setup pnpm cache
        if: matrix.package-manager == 'pnpm'
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ${{ env.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Setup Bun
        if: matrix.package-manager == 'bun'
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: latest
          cache: true
          cache-dependency-path: sdks/typescript/pnpm-lock.yaml

      - name: Install dependencies
        run: ${{ matrix.install-cmd }}

      - name: Unit tests
        run: ${{ matrix.test-cmd }}

  test-e2e:
    runs-on: ubicloud-standard-4
    timeout-minutes: 20
    strategy:
      matrix:
        include:
          - package-manager: pnpm
            install-cmd: pnpm install
            lint-cmd: pnpm lint:check
            tsc-cmd: pnpm exec tsc
            unit-test-cmd: pnpm test:unit
            e2e-test-cmd: pnpm test:e2e
          - package-manager: bun
            install-cmd: bun install
            lint-cmd: bun run lint:check
            tsc-cmd: bunx tsc
            unit-test-cmd: bun run test:unit
            e2e-test-cmd: bun run test:e2e
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
      - name: Sync Submodule Branch
        shell: bash
        run: |
          ./branch-sync.sh
      - name: Install Protoc
        uses: arduino/setup-protoc@c65c819552d16ad3c9b72d9dfd5ba5237b9c906b # v3.0.0
        with:
          version: "25.1"
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Install Task
        uses: arduino/setup-task@b91d5d2c96a56797b48ac1e0e89220bf64044611 # v2.0.0
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup Go
        uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
        with:
          go-version: "1.26"

      - name: Install pnpm
        if: matrix.package-manager == 'pnpm'
        run: npm install -g pnpm@10.16.1

      - name: Get pnpm store directory
        if: matrix.package-manager == 'pnpm'
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

      - name: Setup pnpm cache
        if: matrix.package-manager == 'pnpm'
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ${{ env.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Setup Bun
        if: matrix.package-manager == 'bun'
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: latest
          cache: true
          cache-dependency-path: sdks/typescript/pnpm-lock.yaml

      - name: Install Atlas
        run: |
          curl -sSf https://atlasgo.sh | sh

      - name: Compose
        working-directory: .
        run: docker compose up -d

      - name: Install dependencies
        run: ${{ matrix.install-cmd }}

      - name: Generate
        working-directory: .
        run: |
          export DATABASE_URL="postgresql://hatchet:hatchet@127.0.0.1:5431/hatchet"
          go run ./cmd/hatchet-migrate

      - name: Setup
        working-directory: .
        run: |
          export SEED_DEVELOPMENT=true
          export SERVER_PORT=8080
          export SERVER_URL=http://localhost:8080
          export SERVER_AUTH_COOKIE_DOMAIN=localhost
          export SERVER_AUTH_COOKIE_INSECURE=true
          export SERVER_MSGQUEUE_RABBITMQ_URL="amqp://user:password@localhost:5672/"
          export SERVER_LOGGER_LEVEL=info
          export SERVER_LOGGER_FORMAT=console
          export DATABASE_LOGGER_LEVEL=warn
          export DATABASE_LOGGER_FORMAT=console

          go run ./cmd/hatchet-admin quickstart

          go run ./cmd/hatchet-engine --config ./generated/ 2>&1 | tee $GITHUB_WORKSPACE/engine.log &
          go run ./cmd/hatchet-api --config ./generated/ 2>&1 | tee $GITHUB_WORKSPACE/api.log &

          sleep 30
      - name: E2E tests
        run: |
          cd ../..
          export HATCHET_CLIENT_TOKEN="$(go run ./cmd/hatchet-admin token create --config ./generated/ --tenant-id 707d0855-80ab-4e1f-a156-f1c4546cbf52)"

          cd sdks/typescript
          export HATCHET_CLIENT_TLS_ROOT_CA_FILE=../../certs/ca.cert
          export HATCHET_CLIENT_TLS_SERVER_NAME=cluster
          export NODE_TLS_REJECT_UNAUTHORIZED=0
          ${{ matrix.test-cmd }}

      - name: Upload engine logs
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: sdk-typescript-engine-logs-${{ matrix.package-manager }}
          path: engine.log

      - name: Upload API logs
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: sdk-typescript-api-logs-${{ matrix.package-manager }}
          path: api.log

  old-engine-new-sdk:
    runs-on: ubicloud-standard-4
    timeout-minutes: 20
    permissions:
      contents: read
      pull-requests: write
      issues: write
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          fetch-depth: 0
          fetch-tags: true

      - name: Start Docker dependencies
        working-directory: .
        run: docker compose up -d

      - name: Determine latest stable release tag
        working-directory: .
        run: |
          LATEST_TAG=$(git tag --sort=-v:refname | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | head -1)
          if [ -z "$LATEST_TAG" ]; then
            echo "ERROR: No stable release tag found"
            exit 1
          fi
          echo "Latest stable tag: $LATEST_TAG"
          echo "LATEST_TAG=$LATEST_TAG" >> $GITHUB_ENV

      - name: Pull release images
        working-directory: .
        run: docker compose -f docker-compose.yml -f docker-compose.release.yml pull hatchet-migrate hatchet-admin hatchet-engine hatchet-api

      - name: Run migrations
        working-directory: .
        run: docker compose -f docker-compose.yml -f docker-compose.release.yml run --rm hatchet-migrate

      - name: Setup config and seed database
        working-directory: .
        run: |
          mkdir -p generated
          docker compose -f docker-compose.yml -f docker-compose.release.yml run --rm \
            hatchet-admin /hatchet/hatchet-admin quickstart --skip certs --generated-config-dir /hatchet/generated

      - name: Generate API token
        working-directory: .
        run: |
          TOKEN=$(docker compose -f docker-compose.yml -f docker-compose.release.yml run -T --rm \
            hatchet-admin /hatchet/hatchet-admin token create --config /hatchet/generated --tenant-id 707d0855-80ab-4e1f-a156-f1c4546cbf52)
          echo "HATCHET_CLIENT_TOKEN=$TOKEN" >> $GITHUB_ENV

      - name: Start engine and API
        working-directory: .
        run: |
          docker compose -f docker-compose.yml -f docker-compose.release.yml up -d hatchet-engine hatchet-api
          sleep 30

      - name: Install pnpm
        run: npm install -g pnpm@10.16.1

      - name: Get pnpm store directory
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

      - name: Setup pnpm cache
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ${{ env.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Install dependencies
        run: pnpm install

      - name: Set HATCHET_CLIENT_NAMESPACE
        run: |
          SHORT_SHA=$(git rev-parse --short HEAD)
          echo "HATCHET_CLIENT_NAMESPACE=old-engine-new-sdk-ts-${SHORT_SHA}" >> $GITHUB_ENV

      - name: Run e2e tests
        id: run-tests
        continue-on-error: true
        env:
          HATCHET_CLIENT_TLS_STRATEGY: none
          HATCHET_CLIENT_WORKER_HEALTHCHECK_ENABLED: "false"
          NODE_TLS_REJECT_UNAUTHORIZED: "0"
        run: |
          echo "Testing current SDK against engine ${{ env.LATEST_TAG }}"
          echo "Using HATCHET_CLIENT_NAMESPACE: $HATCHET_CLIENT_NAMESPACE"
          pnpm test:e2e

      - name: Collect engine logs
        if: always()
        working-directory: .
        run: docker compose -f docker-compose.yml -f docker-compose.release.yml logs hatchet-engine > /tmp/engine.log 2>&1 || true

      - name: Upload engine logs
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: ${{ env.HATCHET_CLIENT_NAMESPACE }}-engine-logs
          path: /tmp/engine.log

      - name: Collect API logs
        if: always()
        working-directory: .
        run: docker compose -f docker-compose.yml -f docker-compose.release.yml logs hatchet-api > /tmp/api.log 2>&1 || true

      - name: Upload API logs
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: ${{ env.HATCHET_CLIENT_NAMESPACE }}-api-logs
          path: /tmp/api.log

      - name: Comment on PR
        if: steps.run-tests.outcome == 'failure' && github.event_name == 'pull_request'
        run: |
          gh pr comment ${{ github.event.pull_request.number }} \
            --body "⚠️ **Optional test failure**: The \`old-engine-new-sdk\` (TypeScript) job failed on this PR. This check is non-mandatory and does not block merging, but may be worth investigating. [View logs](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})"
        env:
          GH_TOKEN: ${{ github.token }}

      - name: Teardown
        if: always()
        working-directory: .
        run: docker compose -f docker-compose.yml -f docker-compose.release.yml down

  publish:
    runs-on: ubicloud-standard-4
    needs: [lint, test-unit, test-e2e]
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          submodules: recursive

      - name: Install pnpm
        run: npm install -g pnpm@10.16.1

      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: "24.x"
          registry-url: "https://registry.npmjs.org"

      - name: Get pnpm store directory
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

      - name: Setup pnpm cache
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ${{ env.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Install dependencies
        run: pnpm install

      - name: Build and Publish SDK
        run: |
          VERSION=$(jq '.version' package.json)
          CURRENT_NPM_VERSION=$(pnpm view @hatchet-dev/typescript-sdk version)

          if [[ "$VERSION" == "$CURRENT_NPM_VERSION" ]]; then
            echo "Version has not changed. Skipping publish."
            exit 0
          fi

          ## If the version contains `alpha`, it's an alpha version
          ## and we should tag it as such.=
          if [[ "$VERSION" == *alpha* ]]; then
              pnpm publish:ci:alpha
          else
              pnpm publish:ci
          fi
          echo "VERSION_TAG=$NEW_VERSION" >> $GITHUB_ENV
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

      - name: "Generate release notes"
        if: env.VERSION_TAG != ''
        working-directory: ${{ github.workspace }}
        run: ./hack/ci/release-notes.sh typescript > ./release_notes.md
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: "Release"
        if: env.VERSION_TAG != ''
        working-directory: ${{ github.workspace }}
        run: |
          gh release create "ts/${VERSION_TAG}" \
            --target "$GITHUB_SHA" \
            --title "Typescript SDK ${VERSION_TAG}" \
            --notes-file ./release_notes.md \
            --latest=false
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}