js.yaml

name: JavaScript

on:
  # Filter the whole workflow so unrelated changes don't create skipped
  # matrix jobs. Keep both events' paths in sync. Release tags always run it.
  push:
    branches:
      - master
    paths:
      - ".github/actions/setup-js/**"
      - ".github/workflows/js.yaml"
      - "Makefile"
      - "conformance/**"
      - "js/**"
      - "riverdriver/**/*.sql"
    tags: ["js/v*"]
  pull_request:
    paths:
      - ".github/actions/setup-js/**"
      - ".github/workflows/js.yaml"
      - "Makefile"
      - "conformance/**"
      - "js/**"
      - "riverdriver/**/*.sql"

concurrency:
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
  group: ${{ github.workflow }}-${{ github.ref }}

permissions:
  contents: read

# Node 24 exercises the Temporal polyfill; Node 26 exercises native Temporal.
# Jobs use js/.node-version unless a matrix selects a different release.

defaults:
  run:
    working-directory: js

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    timeout-minutes: 20

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: ./.github/actions/setup-js

      - run: pnpm run build:all

      - run: pnpm run typecheck:tests

      - run: pnpm run typecheck:next

      # Compares the generated mirror with River's canonical migration sources.
      - run: pnpm run verify:migrations

      - run: pnpm run api:check

      - run: pnpm run docs:api

      - run: pnpm run docs:snippets

      - run: pnpm run migration:legacy

  lint:
    name: Lint
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: ./.github/actions/setup-js

      # Type-aware lint reads `riverqueue` through its built declarations.
      - run: pnpm run build

      - run: pnpm run lint

      - run: pnpm run fmt:check

      - run: pnpm run license:check

  packages:
    name: Package archives (Node ${{ matrix.node-version || 'from .node-version' }})
    runs-on: ubuntu-latest
    timeout-minutes: 20

    strategy:
      fail-fast: false
      matrix:
        node-version: ["24", ""]

    # The packed `node:test` suite runs its Postgres tests against this
    # database, and RIVER_REQUIRE_POSTGRES makes them fail instead of skip
    # when DATABASE_URL is missing.
    services:
      postgres:
        image: postgres:18
        env:
          POSTGRES_DB: river_test
          POSTGRES_PASSWORD: postgres
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432

    env:
      DATABASE_URL: postgres://postgres:postgres@localhost:5432/river_test?sslmode=disable
      RIVER_REQUIRE_POSTGRES: "1"

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: ./.github/actions/setup-js
        with:
          node-version: ${{ matrix.node-version }}

      - run: pnpm run build:all

      # The packed examples that need a database use its default schema.
      - run: node cli/dist/bin.js migrate-up --database-url "$DATABASE_URL"

      - run: pnpm run package:check

  examples:
    name: Examples
    runs-on: ubuntu-latest
    timeout-minutes: 20

    services:
      postgres:
        image: postgres:18
        env:
          POSTGRES_DB: river_test
          POSTGRES_PASSWORD: postgres
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432

    env:
      DATABASE_URL: postgres://postgres:postgres@localhost:5432/river_test?sslmode=disable

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: ./.github/actions/setup-js

      - run: pnpm run build:all

      - run: node cli/dist/bin.js migrate-up --database-url "$DATABASE_URL"

      - run: pnpm run package:examples

  test:
    name: Test (Node ${{ matrix.node-version || 'from .node-version' }})
    runs-on: ubuntu-latest
    timeout-minutes: 15

    strategy:
      fail-fast: false
      matrix:
        # Current releases for both supported Node lines.
        node-version: ["24", ""]

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: ./.github/actions/setup-js
        with:
          node-version: ${{ matrix.node-version }}

      # Some unit tests read fixtures generated from River's Go
      # implementation.
      - uses: actions/setup-go@v7
        with:
          go-version-file: go.work

      - run: make generate/fixtures
        working-directory: .

      # The unit tests import the other workspace packages through their
      # build output, and worker threads run compiled handler modules.
      - run: pnpm run build:all

      - run: pnpm run test

  test_integration:
    name: Test (integration, Node ${{ matrix.node-version || 'from .node-version' }}, Postgres ${{ matrix.postgres-version }})
    runs-on: ubuntu-latest
    timeout-minutes: 20

    strategy:
      fail-fast: false
      matrix:
        postgres-version: [14, 15, 16, 17, 18]
        node-version: [""]
        include:
          - node-version: "24"
            postgres-version: 18

    services:
      postgres:
        image: postgres:${{ matrix.postgres-version }}
        env:
          POSTGRES_DB: river_test
          POSTGRES_PASSWORD: postgres
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432

    env:
      TEST_DATABASE_URL: postgres://postgres:postgres@localhost:5432/river_test?sslmode=disable

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: ./.github/actions/setup-js
        with:
          node-version: ${{ matrix.node-version }}

      - run: pnpm run build:all

      - run: node cli/dist/bin.js migrate-up --database-url "$TEST_DATABASE_URL"

      - run: pnpm run test:integration