LibreChat/.github/workflows/cache-integration-tests.yml

name: Cache Integration Tests

on:
  pull_request:
    branches:
      - main
      - dev
      - dev-staging
      - release/*
    # The tested modules import across packages/api (e.g. mcp/oauth pulls in
    # flow/manager) and consume built data-provider and data-schemas, so the
    # whole src trees must trigger — subdirectory filters silently skip
    # regressions in imported files.
    paths:
      - 'packages/api/src/**'
      - 'packages/api/package.json'
      - 'packages/data-provider/src/**'
      - 'packages/data-provider/package.json'
      - 'packages/data-schemas/src/**'
      - 'packages/data-schemas/package.json'
      - 'redis-config/**'
      - '.github/workflows/cache-integration-tests.yml'
      - '!**.md'

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  cache_integration_tests:
    name: Integration Tests that use actual Redis Cache
    timeout-minutes: 30
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v5

      - name: Use Node.js 24.16.0
        uses: actions/setup-node@v5
        with:
          node-version: '24.16.0'

      - name: Install Redis tools
        timeout-minutes: 10
        run: |
          # Same runner apt contention that broke the MCP job in
          # playwright-mock.yml: apt-daily/unattended-upgrades hold
          # /var/lib/apt/lists/lock at boot. Without a step timeout this hung
          # until the job-level one fired, taking the whole leg with it.
          sudo systemctl stop apt-daily.service apt-daily-upgrade.service \
            unattended-upgrades.service 2>/dev/null || true
          sudo systemctl kill --kill-who=all apt-daily.service \
            apt-daily-upgrade.service 2>/dev/null || true

          apt_with_lock_wait() {
            for attempt in $(seq 1 30); do
              if sudo apt-get -o DPkg::Lock::Timeout=60 "$@"; then
                return 0
              fi
              echo "apt-get $1 could not take the lock (attempt ${attempt}/30), retrying"
              sleep 10
            done
            return 1
          }
          apt_with_lock_wait update
          apt_with_lock_wait install -y redis-server redis-tools

      - name: Start Single Redis Instance
        run: |
          redis-server --daemonize yes --port 6379
          sleep 2
          # Verify single Redis is running
          redis-cli -p 6379 ping || exit 1

      - name: Start Redis Cluster
        working-directory: redis-config
        run: |
          chmod +x start-cluster.sh stop-cluster.sh
          ./start-cluster.sh
          sleep 10
          # Verify cluster is running
          redis-cli -p 7001 cluster info || exit 1
          redis-cli -p 7002 cluster info || exit 1
          redis-cli -p 7003 cluster info || exit 1

      - name: Restore node_modules cache
        id: cache-node-modules
        uses: actions/cache@v5
        with:
          path: |
            node_modules
            api/node_modules
            packages/api/node_modules
            packages/data-provider/node_modules
            packages/data-schemas/node_modules
          key: node-modules-backend-${{ runner.os }}-24.16.0-${{ hashFiles('package-lock.json') }}

      - name: Install dependencies
        if: steps.cache-node-modules.outputs.cache-hit != 'true'
        run: npm ci

      - name: Restore data-provider build cache
        id: cache-data-provider
        uses: actions/cache@v5
        with:
          path: packages/data-provider/dist
          key: build-data-provider-${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json', 'packages/data-provider/src/**', 'packages/data-provider/tsconfig*.json', 'packages/data-provider/tsdown.config.mjs', 'packages/data-provider/package.json') }}

      - name: Build data-provider
        if: steps.cache-data-provider.outputs.cache-hit != 'true'
        run: npm run build:data-provider

      - name: Restore data-schemas build cache
        id: cache-data-schemas
        uses: actions/cache@v5
        with:
          path: packages/data-schemas/dist
          key: build-data-schemas-${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json', 'packages/data-schemas/src/**', 'packages/data-schemas/tsconfig*.json', 'packages/data-schemas/tsdown.config.mjs', 'packages/data-schemas/package.json', 'packages/data-provider/src/**', 'packages/data-provider/tsconfig*.json', 'packages/data-provider/tsdown.config.mjs', 'packages/data-provider/package.json') }}

      - name: Build data-schemas
        if: steps.cache-data-schemas.outputs.cache-hit != 'true'
        run: npm run build:data-schemas

      - name: Restore api build cache
        id: cache-api
        uses: actions/cache@v5
        with:
          path: packages/api/dist
          key: build-api-${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json', 'packages/api/src/**', 'packages/api/tsconfig*.json', 'packages/api/tsdown.config.mjs', 'packages/api/package.json', 'packages/data-provider/src/**', 'packages/data-provider/tsconfig*.json', 'packages/data-provider/tsdown.config.mjs', 'packages/data-provider/package.json', 'packages/data-schemas/src/**', 'packages/data-schemas/tsconfig*.json', 'packages/data-schemas/tsdown.config.mjs', 'packages/data-schemas/package.json') }}

      - name: Build api
        if: steps.cache-api.outputs.cache-hit != 'true'
        run: npm run build:api

      - name: Run all cache integration tests (Single Redis Node)
        working-directory: packages/api
        env:
          NODE_ENV: test
          USE_REDIS: true
          USE_REDIS_CLUSTER: false
          REDIS_URI: redis://127.0.0.1:6379
        run: npm run test:cache-integration

      - name: Run all cache integration tests (Redis Cluster)
        working-directory: packages/api
        env:
          NODE_ENV: test
          USE_REDIS: true
          USE_REDIS_CLUSTER: true
          REDIS_URI: redis://127.0.0.1:7001,redis://127.0.0.1:7002,redis://127.0.0.1:7003
        run: npm run test:cache-integration

      - name: Stop Redis Cluster
        if: always()
        working-directory: redis-config
        run: ./stop-cluster.sh || true

      - name: Stop Single Redis Instance
        if: always()
        run: redis-cli -p 6379 shutdown || true