config.yml

version: 2.1

orbs:
  browser-tools: circleci/browser-tools@1.4.8

executors:
  docker-container:
    parameters:
      python_version:
        description: "python version"
        default: "3.12"
        type: string
    docker:
      - image: cimg/python:<<parameters.python_version>>-browsers

commands:
  test_core:
    steps:
      - checkout
      - browser-tools/install-chrome
      - browser-tools/install-chromedriver
      - run:
          name: Install dependencies
          command: |
            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv venv
            source .venv/bin/activate
            uv lock --check
            uv sync --extra dev_core
      - run:
          name: List installed packages and python version
          command: |
            source .venv/bin/activate
            uv pip list
            python --version
      - run:
          name: Test core
          command: |
            source .venv/bin/activate
            python -m pytest tests/test_core
          no_output_timeout: 20m

  test_optional:
    parameters:
      pandas_version:
        type: string
      numpy_version:
        type: string
    steps:
      - checkout
      - browser-tools/install-chrome
      - browser-tools/install-chromedriver
      - run:
          name: Install dependencies
          command: |
            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv venv
            source .venv/bin/activate
            uv sync --extra dev_optional

      - when:
          condition:
            not:
              equal:
                - <<parameters.pandas_version>>
                - ""
          steps:
            - run:
                name: Install pandas
                command: |
                  source .venv/bin/activate
                  uv pip install pandas==<<parameters.pandas_version>> numpy==<<parameters.numpy_version>>

      - run:
          name: Test core
          command: |
            source .venv/bin/activate
            python -m pytest tests/test_core
          no_output_timeout: 20m
      - run:
          name: List installed packages and python version
          command: |
            source .venv/bin/activate
            uv pip list
            python --version
      - run:
          name: Test optional
          command: |
            source .venv/bin/activate
            python -m pytest tests/test_optional
          no_output_timeout: 40m
      - run:
          name: Test utils
          command: |
            source .venv/bin/activate
            python -m pytest tests/test_plotly_utils/
          no_output_timeout: 20m
      - run:
          name: Test io
          command: |
            source .venv/bin/activate
            python -m pytest tests/test_io
          no_output_timeout: 20m
      - run:
          name: Test dependencies not imported
          command: |
            source .venv/bin/activate
            python -m pytest -x test_init/test_dependencies_not_imported.py
      - run:
          name: Test lazy imports
          command: |
            source .venv/bin/activate
            python -m pytest -x test_init/test_lazy_imports.py

  test_io_kaleido_v0:
    steps:
      - checkout
      - browser-tools/install-chrome
      - browser-tools/install-chromedriver
      - run:
          name: Install dependencies
          command: |
            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv venv
            source .venv/bin/activate
            uv sync --extra dev_optional
            # Install Kaleido v0 instead of the v1 specified in requirements_optional.txt
            uv pip uninstall kaleido
            uv pip install kaleido==0.2.1
      - run:
          name: List installed packages and python version
          command: |
            source .venv/bin/activate
            uv pip list
            python --version
      - run:
          name: Test plotly.io image output with Kaleido v0
          command: |
            source .venv/bin/activate
            python -m pytest tests/test_optional/test_kaleido
          no_output_timeout: 20m

jobs:
  check-code-formatting:
    docker:
      - image: cimg/python:3.12

    steps:
      - checkout
      - run:
          name: Install ruff
          command: |
            uv venv
            source .venv/bin/activate
            uv sync --extra dev_core
      - run:
          name: Check handwritten code with ruff
          command: |
            source .venv/bin/activate
            ruff format --check .

  test_core_py:
    parameters:
      python_version:
        default: "3.12"
        type: string
    executor:
      name: docker-container
      python_version: <<parameters.python_version>>
    steps:
      - test_core

  test_optional_py:
    parameters:
      python_version:
        default: "3.12"
        type: string
      pandas_version:
        default: ""
        type: string
      numpy_version:
        default: ""
        type: string
    executor:
      name: docker-container
      python_version: <<parameters.python_version>>
    steps:
      - test_optional:
          pandas_version: <<parameters.pandas_version>>
          numpy_version: <<parameters.numpy_version>>

  test_kaleido_v0:
    parameters:
      python_version:
        default: "3.12"
        type: string
    executor:
      name: docker-container
      python_version: <<parameters.python_version>>
    steps:  
      - test_io_kaleido_v0

  # Percy
  python_311_percy:
    docker:
      - image: cimg/python:3.11-browsers
        environment:
          PERCY_ENABLED: True
          PERCY_PROJECT: plotly/plotly.py
    resource_class: large

    steps:
      - checkout
      - browser-tools/install-chrome
      - browser-tools/install-chromedriver
      - run:
          name: Inject Percy Environment variables
          command: |
            echo 'export PERCY_TOKEN="$PERCY_PYTHON_TOKEN_V0"' >> $BASH_ENV
      - run:
          name: Install requirements
          command: |
            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv venv
            source .venv/bin/activate
            uv sync --extra dev_optional

      - run:
          name: Build HTML figures (Pandas 2)
          command: |
            source .venv/bin/activate
            python tests/percy/plotly-express.py
      - run:
          name: Build HTML figures (Pandas 1) and compare
          command: |
            source .venv/bin/activate
            mkdir tests/percy/pandas2
            mv tests/percy/*.html tests/percy/pandas2/
            uv pip install pandas==1.5.3 numpy==1.26.4
            python tests/percy/plotly-express.py
            python tests/percy/compare-pandas.py
            rm -rf tests/percy/pandas2
      - run:
          name: List installed packages and python version
          command: |
            source .venv/bin/activate
            uv pip list
            python --version
      - run:
          name: Run percy snapshots
          command: |
            npm i @percy/cli
            npx percy snapshot -c tests/percy/snapshots.yml tests/percy/
            rm tests/percy/*.html

  plotlyjs_dev_build:
    docker:
      - image: cimg/python:3.12-node
        environment:
          LANG: en_US.UTF-8
    resource_class: large

    steps:
      - checkout
      - run:
          name: Install dependencies
          command: |
            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv venv
            source .venv/bin/activate
            uv sync --extra dev_optional
      - run:
          name: Update plotly.js to dev
          command: |
            source .venv/bin/activate
            python commands.py updateplotlyjsdev
      - run:
          name: Test core
          command: |
            source .venv/bin/activate
            locale
            pytest -k 'not nodev' tests/test_core
          no_output_timeout: 20m
      - run:
          name: Build source distribution packages
          command: |
            source .venv/bin/activate
            uv sync --extra dev_build
            python -m build --sdist --wheel -o dist
          when: always
      - store_artifacts:
          path: dist/

  full_build:
    docker:
      - image: cimg/python:3.12-node
        environment:
          LANG: en_US.UTF-8
    resource_class: large

    steps:
      - checkout
      - run:
          name: PyPI Build
          command: |
            curl -LsSf https://astral.sh/uv/install.sh | sh
            uv venv
            source .venv/bin/activate
            uv sync --extra dev_build
            cd js
            npm ci
            npm run build
            cd ..
            python -m build --sdist --wheel -o dist
            cp -R dist output
            git status

      - run:
          name: Zip output
          command: |
            tar czf output.tgz output

      - store_artifacts:
          path: output.tgz

workflows:
  code_formatting:
    jobs:
      - check-code-formatting
  dev_build:
    jobs:
      - plotlyjs_dev_build
  release_build:
    jobs:
      - full_build
  build:
    jobs:
      - test_core_py:
          matrix:
            parameters:
              python_version:
                - "3.8"
                - "3.9"
                - "3.10"
                - "3.11"
                - "3.12"
                - "3.13"
      - test_optional_py:
          matrix:
            parameters:
              python_version:
                - "3.8"
                - "3.9"
                - "3.10"
                - "3.11"
                - "3.12"
                - "3.13"
      - test_optional_py:
          name: "test_optional_py-3.9_pandas-1.2.4"
          python_version: "3.9"
          pandas_version: "1.2.4"
          numpy_version: "1.26.4"
      - test_kaleido_v0:
          matrix:
            parameters:
              python_version:
                - "3.12"
      - python_311_percy