version: 2.1

parameters:
  upload-to-s3:
    type: string
    default: '1'

  run-lint:
    type: boolean
    default: true

  run-build-linux:
    type: boolean
    default: true

  run-build-mac:
    type: boolean
    default: true

  run-linux-x64-publish:
    type: boolean
    default: false

  run-linux-ia32-publish:
    type: boolean
    default: false

  run-linux-arm-publish:
    type: boolean
    default: false

  run-linux-arm64-publish:
    type: boolean
    default: false

  run-osx-publish:
    type: boolean
    default: false

  run-mas-publish:
    type: boolean
    default: false

# The config expects the following environment variables to be set:
#  - "SLACK_WEBHOOK" Slack hook URL to send notifications.
#
# The publishing scripts expect access tokens to be defined as env vars,
# but those are not covered here.
#
# CircleCI docs on variables:
# https://circleci.com/docs/2.0/env-vars/

# Build machines configs.
docker-image: &docker-image
  docker:
    - image: electronjs/build:697b894f36d127155e020f4e8ad4b2e5f6a09613

machine-linux-medium: &machine-linux-medium
  <<: *docker-image
  resource_class: medium

machine-linux-2xlarge: &machine-linux-2xlarge
  <<: *docker-image
  resource_class: 2xlarge+

machine-mac: &machine-mac
  macos:
    xcode: "10.3.0"

machine-mac-large: &machine-mac-large
  resource_class: large
  macos:
    xcode: "10.3.0"

# Build configurations options.
env-testing-build: &env-testing-build
  GN_CONFIG: //electron/build/args/testing.gn
  CHECK_DIST_MANIFEST: '1'

env-release-build: &env-release-build
  GN_CONFIG: //electron/build/args/release.gn
  STRIP_BINARIES: true
  GENERATE_SYMBOLS: true
  CHECK_DIST_MANIFEST: '1'

env-headless-testing: &env-headless-testing
  DISPLAY: ':99.0'

env-stack-dumping: &env-stack-dumping
  ELECTRON_ENABLE_STACK_DUMPING: '1'

env-browsertests: &env-browsertests
  GN_CONFIG: //electron/build/args/native_tests.gn
  BUILD_TARGET: electron/spec:chromium_browsertests
  TESTS_CONFIG: src/electron/spec/configs/browsertests.yml

env-unittests: &env-unittests
  GN_CONFIG: //electron/build/args/native_tests.gn
  BUILD_TARGET: electron/spec:chromium_unittests
  TESTS_CONFIG: src/electron/spec/configs/unittests.yml

# Build targets options.
env-ia32: &env-ia32
  GN_EXTRA_ARGS: 'target_cpu = "x86"'
  NPM_CONFIG_ARCH: ia32
  TARGET_ARCH: ia32

env-arm: &env-arm
  GN_EXTRA_ARGS: 'target_cpu = "arm"'
  MKSNAPSHOT_TOOLCHAIN: //build/toolchain/linux:clang_arm
  BUILD_NATIVE_MKSNAPSHOT: 1
  TARGET_ARCH: arm

env-arm64: &env-arm64
  GN_EXTRA_ARGS: 'target_cpu = "arm64" fatal_linker_warnings = false enable_linux_installer = false'
  MKSNAPSHOT_TOOLCHAIN: //build/toolchain/linux:clang_arm64
  BUILD_NATIVE_MKSNAPSHOT: 1
  TARGET_ARCH: arm64

env-mas: &env-mas
  GN_EXTRA_ARGS: 'is_mas_build = true'
  MAS_BUILD: 'true'

# Misc build configuration options.
env-enable-sccache: &env-enable-sccache
  USE_SCCACHE: true

env-send-slack-notifications: &env-send-slack-notifications
  NOTIFY_SLACK: true

env-linux-medium: &env-linux-medium
  NUMBER_OF_NINJA_PROCESSES: 3

env-linux-2xlarge: &env-linux-2xlarge
  NUMBER_OF_NINJA_PROCESSES: 34

env-linux-2xlarge-release: &env-linux-2xlarge-release
  NUMBER_OF_NINJA_PROCESSES: 16

env-machine-mac: &env-machine-mac
  NUMBER_OF_NINJA_PROCESSES: 6

env-mac-large: &env-mac-large
  NUMBER_OF_NINJA_PROCESSES: 18

env-mac-large-release: &env-mac-large-release
  NUMBER_OF_NINJA_PROCESSES: 8

env-ninja-status: &env-ninja-status
  NINJA_STATUS: "[%r processes, %f/%t @ %o/s : %es] "

env-disable-run-as-node: &env-disable-run-as-node
  GN_BUILDFLAG_ARGS: 'enable_run_as_node = false'

env-32bit-release: &env-32bit-release
  # Set symbol level to 1 for 32 bit releases because of https://crbug.com/648948
  GN_BUILDFLAG_ARGS: 'symbol_level = 1'

env-macos-build: &env-macos-build
  # Disable pre-compiled headers to reduce out size, only useful for rebuilds
  GN_BUILDFLAG_ARGS: 'enable_precompiled_headers = false'

# Individual (shared) steps.
step-maybe-notify-slack-failure: &step-maybe-notify-slack-failure
  run:
    name: Send a Slack notification on failure
    command: |
      if [ "$NOTIFY_SLACK" == "true" ]; then
        export MESSAGE="Build failed for *<$CIRCLE_BUILD_URL|$CIRCLE_JOB>* nightly build from *$CIRCLE_BRANCH*."
        curl -g -H "Content-Type: application/json" -X POST \
        -d "{\"text\": \"$MESSAGE\", \"attachments\": [{\"color\": \"#FC5C3C\",\"title\": \"$CIRCLE_JOB nightly build results\",\"title_link\": \"$CIRCLE_BUILD_URL\"}]}" $SLACK_WEBHOOK
      fi
    when: on_fail

step-maybe-notify-slack-success: &step-maybe-notify-slack-success
  run:
    name: Send a Slack notification on success
    command: |
      if [ "$NOTIFY_SLACK" == "true" ]; then
        export MESSAGE="Build succeeded for *<$CIRCLE_BUILD_URL|$CIRCLE_JOB>* nightly build from *$CIRCLE_BRANCH*."
        curl -g -H "Content-Type: application/json" -X POST \
        -d "{\"text\": \"$MESSAGE\", \"attachments\": [{\"color\": \"good\",\"title\": \"$CIRCLE_JOB nightly build results\",\"title_link\": \"$CIRCLE_BUILD_URL\"}]}" $SLACK_WEBHOOK
      fi
    when: on_success

step-checkout-electron: &step-checkout-electron
  checkout:
    path: src/electron

step-depot-tools-get: &step-depot-tools-get
  run:
    name: Get depot tools
    command: |
      git clone --depth=1 https://chromium.googlesource.com/chromium/tools/depot_tools.git

step-depot-tools-add-to-path: &step-depot-tools-add-to-path
  run:
    name: Add depot tools to PATH
    command: echo 'export PATH="$PATH:'"$PWD"'/depot_tools"' >> $BASH_ENV

step-gclient-sync: &step-gclient-sync
  run:
    name: Gclient sync
    command: |
      # If we did not restore a complete sync then we need to sync for realz
      if [ ! -s "src/electron/.circle-sync-done" ]; then
        gclient config \
          --name "src/electron" \
          --unmanaged \
          $GCLIENT_EXTRA_ARGS \
          "$CIRCLE_REPOSITORY_URL"

        gclient sync --with_branch_heads --with_tags
      fi

step-setup-env-for-build: &step-setup-env-for-build
  run:
    name: Setup Environment Variables
    command: |
      # To find `gn` executable.
      echo 'export CHROMIUM_BUILDTOOLS_PATH="'"$PWD"'/src/buildtools"' >> $BASH_ENV

      if [ "$USE_SCCACHE" == "true" ]; then
        # https://github.com/mozilla/sccache
        SCCACHE_PATH="$PWD/src/electron/external_binaries/sccache"
        echo 'export SCCACHE_PATH="'"$SCCACHE_PATH"'"' >> $BASH_ENV
        if [ "$CIRCLE_PR_NUMBER" != "" ]; then
          #if building a fork set readonly access to sccache
          echo 'export SCCACHE_BUCKET="electronjs-sccache-ci"' >> $BASH_ENV
          echo 'export SCCACHE_TWO_TIER=true' >> $BASH_ENV
        fi
      fi

step-restore-brew-cache: &step-restore-brew-cache
  restore_cache:
    paths:
      - /usr/local/Homebrew
    keys:
      - v1-brew-cache-{{ arch }}

step-save-brew-cache: &step-save-brew-cache
  save_cache:
    paths:
      - /usr/local/Homebrew
    key: v1-brew-cache-{{ arch }}
    name: Persisting brew cache

step-get-more-space-on-mac: &step-get-more-space-on-mac
  run:
    name: Free up space on MacOS
    command: |
      if [ "`uname`" == "Darwin" ]; then
        sudo rm -rf /Library/Developer/CoreSimulator
        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/AppleTVOS.platform
        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform
        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/WatchOS.platform
        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/WatchSimulator.platform
        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/AppleTVSimulator.platform
        sudo rm -rf /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform
      fi

step-delete-git-directories: &step-delete-git-directories
  run:
    name: Delete all .git directories under src on MacOS to free space
    command: |
      if [ "`uname`" == "Darwin" ]; then
        cd src
        ( find . -type d -name ".git" ) | xargs rm -rf
      fi

# On macOS the yarn install command during gclient sync was run on a linux
# machine and therefore installed a slightly different set of dependencies
# Notably "fsevents" is a macOS only dependency, we rerun yarn install once
# we are on a macOS machine to get the correct state
step-install-npm-deps-on-mac: &step-install-npm-deps-on-mac
  run:
    name: Install node_modules on MacOS
    command: |
      if [ "`uname`" == "Darwin" ]; then
        cd src/electron
        node script/yarn install
      fi

# This step handles the differences between the linux "gclient sync"
# and the expected state on macOS
step-fix-sync-on-mac: &step-fix-sync-on-mac
  run:
    name: Fix Sync on macOS
    command: |
      if [ "`uname`" == "Darwin" ]; then
        # Fix Clang Install (wrong binary)
        rm -rf src/third_party/llvm-build
        python src/tools/clang/scripts/update.py
        # Fix Framework Header Installs (symlinks not retained)
        rm -rf src/electron/external_binaries
        python src/electron/script/update-external-binaries.py
      fi

step-install-signing-cert-on-mac: &step-install-signing-cert-on-mac
  run:
    name: Import and trust self-signed codesigning cert on MacOS
    command: |
      if [ "`uname`" == "Darwin" ]; then
        cd src/electron
        ./script/codesign/import-testing-cert-ci.sh
      fi

step-install-gnutar-on-mac: &step-install-gnutar-on-mac
  run:
    name: Install gnu-tar on macos
    command: |
      if [ "`uname`" == "Darwin" ]; then
        brew update
        brew install gnu-tar
        ln -fs /usr/local/bin/gtar /usr/local/bin/tar
      fi

step-gn-gen-default: &step-gn-gen-default
  run:
    name: Default GN gen
    command: |
      cd src
      gn gen out/Default --args='import("'$GN_CONFIG'") cc_wrapper="'"$SCCACHE_PATH"'"'" $GN_EXTRA_ARGS $GN_BUILDFLAG_ARGS"

step-gn-check: &step-gn-check
  run:
    name: GN check
    command: |
      cd src
      gn check out/Default //electron:electron_lib
      gn check out/Default //electron:electron_app
      gn check out/Default //electron:manifests
      gn check out/Default //electron/shell/common/api:mojo
      # Check the hunspell filenames
      node electron/script/gen-hunspell-filenames.js --check

step-electron-build: &step-electron-build
  run:
    name: Electron build
    no_output_timeout: 30m
    command: |
      # On arm platforms we generate a cross-arch ffmpeg that ninja does not seem
      # to realize is not correct / should be rebuilt.  We delete it here so it is
      # rebuilt
      if [ "$TRIGGER_ARM_TEST" == "true" ]; then
        rm -f src/out/Default/libffmpeg.so
      fi
      cd src
      ninja -C out/Default electron -j $NUMBER_OF_NINJA_PROCESSES

step-native-unittests-build: &step-native-unittests-build
  run:
    name: Build native test targets
    no_output_timeout: 30m
    command: |
      cd src
      ninja -C out/Default shell_browser_ui_unittests -j $NUMBER_OF_NINJA_PROCESSES

step-maybe-electron-dist-strip: &step-maybe-electron-dist-strip
  run:
    name: Strip electron binaries
    command: |
      if [ "$STRIP_BINARIES" == "true" ] && [ "`uname`" == "Linux" ]; then
        if [ x"$TARGET_ARCH" == x ]; then
          target_cpu=x64
        elif [ "$TARGET_ARCH" == "ia32" ]; then
          target_cpu=x86
        else
          target_cpu="$TARGET_ARCH"
        fi
        cd src
        electron/script/copy-debug-symbols.py --target-cpu="$target_cpu" --out-dir=out/Default/debug --compress
        electron/script/strip-binaries.py --target-cpu="$target_cpu"
        electron/script/add-debug-link.py --target-cpu="$target_cpu" --debug-dir=out/Default/debug
      fi

step-electron-dist-build: &step-electron-dist-build
  run:
    name: Build dist.zip
    command: |
      cd src
      if [ "$SKIP_DIST_ZIP" != "1" ]; then
        ninja -C out/Default electron:electron_dist_zip
        if [ "$CHECK_DIST_MANIFEST" == "1" ]; then
          if [ "`uname`" == "Darwin" ]; then
            target_os=mac
            target_cpu=x64
            if [ x"$MAS_BUILD" == x"true" ]; then
              target_os=mac_mas
            fi
          elif [ "`uname`" == "Linux" ]; then
            target_os=linux
            if [ x"$TARGET_ARCH" == x ]; then
              target_cpu=x64
            elif [ "$TARGET_ARCH" == "ia32" ]; then
              target_cpu=x86
            else
              target_cpu="$TARGET_ARCH"
            fi
          else
            echo "Unknown system: `uname`"
            exit 1
          fi
          electron/script/zip_manifests/check-zip-manifest.py out/Default/dist.zip electron/script/zip_manifests/dist_zip.$target_os.$target_cpu.manifest
        fi
      fi

step-electron-dist-store: &step-electron-dist-store
  store_artifacts:
    path: src/out/Default/dist.zip
    destination: dist.zip

step-electron-chromedriver-build: &step-electron-chromedriver-build
  run:
    name: Build chromedriver.zip
    command: |
      cd src
      ninja -C out/Default chrome/test/chromedriver -j $NUMBER_OF_NINJA_PROCESSES
      electron/script/strip-binaries.py --target-cpu="$TARGET_ARCH" --file $PWD/out/Default/chromedriver
      ninja -C out/Default electron:electron_chromedriver_zip

step-electron-chromedriver-store: &step-electron-chromedriver-store
  store_artifacts:
    path: src/out/Default/chromedriver.zip
    destination: chromedriver.zip

step-nodejs-headers-build: &step-nodejs-headers-build
  run:
    name: Build Node.js headers
    command: |
      cd src
      ninja -C out/Default third_party/electron_node:headers

step-nodejs-headers-store: &step-nodejs-headers-store
  store_artifacts:
    path: src/out/Default/gen/node_headers.tar.gz
    destination: node_headers.tar.gz

step-native-unittests-store: &step-native-unittests-store
  store_artifacts:
    path: src/out/Default/shell_browser_ui_unittests
    destination: shell_browser_ui_unittests

step-electron-publish: &step-electron-publish
  run:
    name: Publish Electron Dist
    command: |
      if [ "`uname`" == "Darwin" ]; then
        rm -rf src/out/Default/obj
      fi
      cd src/electron
      if [ "$UPLOAD_TO_S3" == "1" ]; then
        echo 'Uploading Electron release distribution to S3'
        script/release/uploaders/upload.py --upload_to_s3
      else
        echo 'Uploading Electron release distribution to Github releases'
        script/release/uploaders/upload.py
      fi

step-persist-data-for-tests: &step-persist-data-for-tests
  persist_to_workspace:
    root: .
    paths:
      # Build artifacts
      - src/out/Default/dist.zip
      - src/out/Default/mksnapshot.zip
      - src/out/Default/shell_browser_ui_unittests
      - src/out/Default/gen/node_headers
      - src/out/ffmpeg/ffmpeg.zip
      - src/electron
      - src/third_party/electron_node
      - src/third_party/nan

step-electron-dist-unzip: &step-electron-dist-unzip
  run:
    name: Unzip dist.zip
    command: |
      cd src/out/Default
      # -o  overwrite files WITHOUT prompting
      # TODO(alexeykuzmin): Remove '-o' when it's no longer needed.
      unzip -o dist.zip

step-ffmpeg-unzip: &step-ffmpeg-unzip
  run:
    name: Unzip ffmpeg.zip
    command: |
      cd src/out/ffmpeg
      unzip -o ffmpeg.zip

step-mksnapshot-unzip: &step-mksnapshot-unzip
  run:
    name: Unzip mksnapshot.zip
    command: |
      cd src/out/Default
      unzip -o mksnapshot.zip

step-ffmpeg-gn-gen: &step-ffmpeg-gn-gen
  run:
    name: ffmpeg GN gen
    command: |
      cd src
      gn gen out/ffmpeg --args='import("//electron/build/args/ffmpeg.gn") cc_wrapper="'"$SCCACHE_PATH"'"'" $GN_EXTRA_ARGS"

step-ffmpeg-build: &step-ffmpeg-build
  run:
    name: Non proprietary ffmpeg build
    command: |
      cd src
      ninja -C out/ffmpeg electron:electron_ffmpeg_zip -j $NUMBER_OF_NINJA_PROCESSES

step-verify-ffmpeg: &step-verify-ffmpeg
  run:
    name: Verify ffmpeg
    command: |
      cd src
      python electron/script/verify-ffmpeg.py --source-root "$PWD" --build-dir out/Default --ffmpeg-path out/ffmpeg

step-ffmpeg-store: &step-ffmpeg-store
  store_artifacts:
    path: src/out/ffmpeg/ffmpeg.zip
    destination: ffmpeg.zip

step-verify-mksnapshot: &step-verify-mksnapshot
  run:
    name: Verify mksnapshot
    command: |
      cd src
      python electron/script/verify-mksnapshot.py --source-root "$PWD" --build-dir out/Default

step-setup-linux-for-headless-testing: &step-setup-linux-for-headless-testing
  run:
    name: Setup for headless testing
    command: |
      if [ "`uname`" != "Darwin" ]; then
        sh -e /etc/init.d/xvfb start
      fi

step-show-sccache-stats: &step-show-sccache-stats
  run:
    name: Check sccache stats after build
    command: |
      if [ "$SCCACHE_PATH" != "" ]; then
        $SCCACHE_PATH -s
      fi

step-mksnapshot-build: &step-mksnapshot-build
  run:
    name: mksnapshot build
    command: |
      cd src
      ninja -C out/Default electron:electron_mksnapshot -j $NUMBER_OF_NINJA_PROCESSES
      if [ "`uname`" != "Darwin" ]; then
        if [ "$TARGET_ARCH" == "arm" ]; then
          electron/script/strip-binaries.py --file $PWD/out/Default/clang_x86_v8_arm/mksnapshot
        elif [ "$TARGET_ARCH" == "arm64" ]; then
          electron/script/strip-binaries.py --file $PWD/out/Default/clang_x64_v8_arm64/mksnapshot
        else
          electron/script/strip-binaries.py --file $PWD/out/Default/mksnapshot
          electron/script/strip-binaries.py --file $PWD/out/Default/v8_context_snapshot_generator
        fi
      fi
      if [ "$SKIP_DIST_ZIP" != "1" ]; then
        ninja -C out/Default electron:electron_mksnapshot_zip -j $NUMBER_OF_NINJA_PROCESSES
      fi

step-mksnapshot-store: &step-mksnapshot-store
  store_artifacts:
    path: src/out/Default/mksnapshot.zip
    destination: mksnapshot.zip

step-hunspell-build: &step-hunspell-build
  run:
    name: hunspell build
    command: |
      cd src
      if [ "$SKIP_DIST_ZIP" != "1" ]; then
        ninja -C out/Default electron:hunspell_dictionaries_zip -j $NUMBER_OF_NINJA_PROCESSES
      fi

step-hunspell-store: &step-hunspell-store
  store_artifacts:
    path: src/out/Default/hunspell_dictionaries.zip
    destination: hunspell_dictionaries.zip

step-maybe-generate-breakpad-symbols: &step-maybe-generate-breakpad-symbols
  run:
    name: Generate breakpad symbols
    command: |
      if [ "$GENERATE_SYMBOLS" == "true" ]; then
        cd src
        ninja -C out/Default electron:electron_symbols
      fi

step-maybe-zip-symbols: &step-maybe-zip-symbols
  run:
    name: Zip symbols
    command: |
      cd src
      export BUILD_PATH="$PWD/out/Default"
      ninja -C out/Default electron:licenses
      ninja -C out/Default electron:electron_version
      electron/script/zip-symbols.py -b $BUILD_PATH

step-symbols-store: &step-symbols-store
  store_artifacts:
    path: src/out/Default/symbols.zip
    destination: symbols.zip

step-maybe-cross-arch-snapshot: &step-maybe-cross-arch-snapshot
  run:
    name: Generate cross arch snapshot (arm/arm64)
    command: |
      if [ "$TRIGGER_ARM_TEST" == "true" ] && [ -z "$CIRCLE_PR_NUMBER" ]; then
        cd src
        if [ "$TARGET_ARCH" == "arm" ]; then
          export MKSNAPSHOT_PATH="clang_x86_v8_arm"
        elif [ "$TARGET_ARCH" == "arm64" ]; then
          export MKSNAPSHOT_PATH="clang_x64_v8_arm64"
        fi
        cp "out/Default/$MKSNAPSHOT_PATH/mksnapshot" out/Default
        cp "out/Default/$MKSNAPSHOT_PATH/libffmpeg.so" out/Default
        cp "out/Default/$MKSNAPSHOT_PATH/v8_context_snapshot_generator" out/Default
        python electron/script/verify-mksnapshot.py --source-root "$PWD" --build-dir out/Default --create-snapshot-only
        mkdir cross-arch-snapshots
        cp out/Default-mksnapshot-test/*.bin cross-arch-snapshots
      fi

step-maybe-cross-arch-snapshot-store: &step-maybe-cross-arch-snapshot-store
  store_artifacts:
    path: src/cross-arch-snapshots
    destination: cross-arch-snapshots

step-maybe-trigger-arm-test: &step-maybe-trigger-arm-test
  run:
    name: Trigger an arm test on VSTS if applicable
    command: |
      cd src
      # Only run for non-fork prs
      if [ "$TRIGGER_ARM_TEST" == "true" ] && [ -z "$CIRCLE_PR_NUMBER" ]; then
        #Trigger VSTS job, passing along CircleCI job number and branch to build
        echo "Triggering electron-$TARGET_ARCH-testing build on VSTS"
        node electron/script/release/ci-release-build.js --job=electron-$TARGET_ARCH-testing --ci=VSTS --armTest --circleBuildNum=$CIRCLE_BUILD_NUM $CIRCLE_BRANCH
      fi

step-maybe-generate-typescript-defs: &step-maybe-generate-typescript-defs
  run:
    name: Generate type declarations
    command: |
      if [ "`uname`" == "Darwin" ]; then
        cd src/electron
        node script/yarn create-typescript-definitions
      fi

step-fix-known-hosts-linux: &step-fix-known-hosts-linux
  run:
    name: Fix Known Hosts on Linux
    command: |
      if [ "`uname`" == "Linux" ]; then
        ./src/electron/.circleci/fix-known-hosts.sh
      fi

step-ninja-summary: &step-ninja-summary
  run:
    name: Print ninja summary
    command: |
      python depot_tools/post_build_ninja_summary.py -C src/out/Default

step-ninja-report: &step-ninja-report
  store_artifacts:
    path: src/out/Default/.ninja_log
    destination: ninja_log

# Checkout Steps
step-generate-deps-hash: &step-generate-deps-hash
  run:
    name: Generate DEPS Hash
    command: node src/electron/script/generate-deps-hash.js && cat src/electron/.depshash-target

step-touch-sync-done: &step-touch-sync-done
  run:
    name: Touch Sync Done
    command: touch src/electron/.circle-sync-done

# Restore exact src cache based on the hash of DEPS and patches/*
# If no cache is matched EXACTLY then the .circle-sync-done file is empty
# If a cache is matched EXACTLY then the .circle-sync-done file contains "done"
step-maybe-restore-src-cache: &step-maybe-restore-src-cache
  restore_cache:
    keys:
      - v7-src-cache-{{ checksum "src/electron/.depshash" }}
    name: Restoring src cache

# Restore exact or closest git cache based on the hash of DEPS and .circle-sync-done
# If the src cache was restored above then this will match an empty cache
# If the src cache was not restored above then this will match a close git cache
step-maybe-restore-git-cache: &step-maybe-restore-git-cache
  restore_cache:
    paths:
      - ~/.gclient-cache
    keys:
      - v2-gclient-cache-{{ checksum "src/electron/.circle-sync-done" }}-{{ checksum "src/electron/DEPS" }}
      - v2-gclient-cache-{{ checksum "src/electron/.circle-sync-done" }}
    name: Conditionally restoring git cache

step-restore-out-cache: &step-restore-out-cache
  restore_cache:
    paths:
      - ./src/out/Default
    keys:
      - v7-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
    name: Restoring out cache

step-set-git-cache-path: &step-set-git-cache-path
  run:
    name: Set GIT_CACHE_PATH to make gclient to use the cache
    command: |
      # CircleCI does not support interpolation when setting environment variables.
      # https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-shell-command
      echo 'export GIT_CACHE_PATH="$HOME/.gclient-cache"' >> $BASH_ENV

# Persist the git cache based on the hash of DEPS and .circle-sync-done
# If the src cache was restored above then this will persist an empty cache
step-save-git-cache: &step-save-git-cache
  save_cache:
    paths:
      - ~/.gclient-cache
    key: v2-gclient-cache-{{ checksum "src/electron/.circle-sync-done" }}-{{ checksum "src/electron/DEPS" }}
    name: Persisting git cache

step-save-out-cache: &step-save-out-cache
  save_cache:
    paths:
      - ./src/out/Default
    key: v7-out-cache-{{ checksum "src/electron/.depshash" }}-{{ checksum "src/electron/.depshash-target" }}
    name: Persisting out cache

step-run-electron-only-hooks: &step-run-electron-only-hooks
  run:
    name: Run Electron Only Hooks
    command: gclient runhooks --spec="solutions=[{'name':'src/electron','url':None,'deps_file':'DEPS','custom_vars':{'process_deps':False},'managed':False}]"

step-generate-deps-hash-cleanly: &step-generate-deps-hash-cleanly
  run:
    name: Generate DEPS Hash
    command: (cd src/electron && git checkout .) && node src/electron/script/generate-deps-hash.js && cat src/electron/.depshash-target

# Mark the sync as done for future cache saving
step-mark-sync-done: &step-mark-sync-done
  run:
    name: Mark Sync Done
    command: echo DONE > src/electron/.circle-sync-done

# Minimize the size of the cache
step-minimize-workspace-size-from-checkout: &step-minimize-workspace-size-from-checkout
  run:
    name: Remove some unused data to avoid storing it in the workspace/cache
    command: |
      rm -rf src/android_webview
      rm -rf src/ios
      rm -rf src/third_party/blink/web_tests
      rm -rf src/third_party/blink/perf_tests
      rm -rf src/third_party/WebKit/LayoutTests

# Save the src cache based on the deps hash
step-save-src-cache: &step-save-src-cache
  save_cache:
    paths:
      - /portal
    key: v7-src-cache-{{ checksum "/portal/src/electron/.depshash" }}
    name: Persisting src cache

# Check for doc only change
step-check-for-doc-only-change: &step-check-for-doc-only-change
  run:
    name: Check if commit is doc only change
    command: |
      cd src/electron
      node script/yarn install --frozen-lockfile
      if node script/doc-only-change.js --prNumber=$CIRCLE_PR_NUMBER --prURL=$CIRCLE_PULL_REQUEST; then
        #PR is doc only change; save file with value true to indicate doc only change
        echo "true" > .skip-ci-build
      else
        #PR is not a doc only change; create empty file to indicate check has been done
        touch .skip-ci-build
      fi

step-persist-doc-only-change: &step-persist-doc-only-change
  persist_to_workspace:
    root: .
    paths:
      - src/electron/.skip-ci-build

step-maybe-early-exit-doc-only-change: &step-maybe-early-exit-doc-only-change
  run:
    name: Shortcircuit build if doc only change
    command: |
      if [ -s src/electron/.skip-ci-build ]; then
        circleci-agent step halt
      fi

step-maybe-early-exit-no-doc-change: &step-maybe-early-exit-no-doc-change
  run:
    name: Shortcircuit job if change is not doc only
    command: |
      if [ ! -s src/electron/.skip-ci-build ]; then
        circleci-agent step halt
      fi

step-ts-compile: &step-ts-compile
  run:
    name: Run TS/JS compile on doc only change
    command: |
      cd src
      ninja -C out/Default electron:default_app_js -j $NUMBER_OF_NINJA_PROCESSES
      ninja -C out/Default electron:atom_js2c -j $NUMBER_OF_NINJA_PROCESSES

# Lists of steps.
steps-lint: &steps-lint
  steps:
    - *step-checkout-electron
    - run:
        name: Setup third_party Depot Tools
        command: |
          # "depot_tools" has to be checkout into "//third_party/depot_tools" so pylint.py can a "pylintrc" file.
          git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git src/third_party/depot_tools
          echo 'export PATH="$PATH:'"$PWD"'/src/third_party/depot_tools"' >> $BASH_ENV
    - run:
        name: Download GN Binary
        command: |
          chromium_revision="$(grep -A1 chromium_version src/electron/DEPS | tr -d '\n' | cut -d\' -f4)"
          gn_version="$(curl -sL "https://chromium.googlesource.com/chromium/src/+/${chromium_revision}/DEPS?format=TEXT" | base64 -d | grep gn_version | head -n1 | cut -d\' -f4)"

          cipd ensure -ensure-file - -root . \<<-CIPD
          \$ServiceURL https://chrome-infra-packages.appspot.com/
          @Subdir src/buildtools/linux64
          gn/gn/linux-amd64 $gn_version
          CIPD

          echo 'export CHROMIUM_BUILDTOOLS_PATH="'"$PWD"'/src/buildtools"' >> $BASH_ENV
    - run:
        name: Download clang-format Binary
        command: |
          chromium_revision="$(grep -A1 chromium_version src/electron/DEPS | tr -d '\n' | cut -d\' -f4)"

          sha1_path='buildtools/linux64/clang-format.sha1'
          curl -sL "https://chromium.googlesource.com/chromium/src/+/${chromium_revision}/${sha1_path}?format=TEXT" | base64 -d > "src/${sha1_path}"

          download_from_google_storage.py --no_resume --no_auth --bucket chromium-clang-format -s "src/${sha1_path}"
    - run:
        name: Run Lint
        command: |
          # gn.py tries to find a gclient root folder starting from the current dir.
          # When it fails and returns "None" path, the whole script fails. Let's "fix" it.
          touch .gclient
          # Another option would be to checkout "buildtools" inside the Electron checkout,
          # but then we would lint its contents (at least gn format), and it doesn't pass it.

          cd src/electron
          node script/yarn install --frozen-lockfile
          node script/yarn lint

steps-checkout-and-save-cache: &steps-checkout-and-save-cache
  steps:
    - *step-checkout-electron
    - *step-check-for-doc-only-change
    - *step-persist-doc-only-change
    - *step-maybe-early-exit-doc-only-change
    - *step-depot-tools-get
    - *step-depot-tools-add-to-path
    - *step-restore-brew-cache
    - *step-get-more-space-on-mac
    - *step-install-gnutar-on-mac

    - *step-generate-deps-hash
    - *step-touch-sync-done
    - maybe-restore-portaled-src-cache
    - *step-maybe-restore-git-cache
    - *step-set-git-cache-path
    # This sync call only runs if .circle-sync-done is an EMPTY file
    - *step-gclient-sync
    - *step-save-git-cache
    # These next few steps reset Electron to the correct commit regardless of which cache was restored
    - run:
        name: Wipe Electron
        command: rm -rf src/electron
    - *step-checkout-electron
    - *step-run-electron-only-hooks
    - *step-generate-deps-hash-cleanly
    - *step-mark-sync-done
    - *step-minimize-workspace-size-from-checkout
    - *step-delete-git-directories
    - run:
        name: Move src folder to the cross-OS portal
        command: |
          sudo mkdir -p /portal
          sudo chown -R $(id -u):$(id -g) /portal
          mv ./src /portal
    - *step-save-src-cache
    - *step-save-brew-cache

steps-electron-gn-check: &steps-electron-gn-check
  steps:
    - attach_workspace:
        at: .
    - *step-maybe-early-exit-doc-only-change
    - *step-depot-tools-add-to-path
    - *step-setup-env-for-build
    - *step-gn-gen-default
    - *step-gn-check

steps-electron-build: &steps-electron-build
  steps:
    - attach_workspace:
        at: .
    - *step-maybe-early-exit-doc-only-change
    - *step-depot-tools-add-to-path
    - *step-setup-env-for-build
    - *step-restore-brew-cache
    - *step-get-more-space-on-mac
    - *step-install-npm-deps-on-mac
    - *step-fix-sync-on-mac
    - *step-delete-git-directories
    - *step-gn-gen-default

    # Electron app
    - *step-electron-build
    - *step-maybe-electron-dist-strip
    - *step-electron-dist-build
    - *step-electron-dist-store
    - *step-ninja-summary

    # Native test targets
    - *step-native-unittests-build
    - *step-native-unittests-store

    # Node.js headers
    - *step-nodejs-headers-build
    - *step-nodejs-headers-store

    - *step-show-sccache-stats

    # mksnapshot
    - *step-mksnapshot-build
    - *step-mksnapshot-store
    - *step-maybe-cross-arch-snapshot
    - *step-maybe-cross-arch-snapshot-store

    # ffmpeg
    - *step-ffmpeg-gn-gen
    - *step-ffmpeg-build
    - *step-ffmpeg-store

    # hunspell
    - *step-hunspell-build
    - *step-hunspell-store

    # Save all data needed for a further tests run.
    - *step-persist-data-for-tests

    - *step-maybe-generate-breakpad-symbols
    - *step-maybe-zip-symbols
    - *step-symbols-store

    # Trigger tests on arm hardware if needed
    - *step-maybe-trigger-arm-test

    - *step-maybe-notify-slack-failure

steps-electron-ts-compile-for-doc-change: &steps-electron-ts-compile-for-doc-change
  steps:
    # Checkout - Copied ffrom steps-checkout
    - *step-checkout-electron
    - *step-check-for-doc-only-change
    - *step-maybe-early-exit-no-doc-change
    - *step-depot-tools-get
    - *step-depot-tools-add-to-path
    - *step-restore-brew-cache
    - *step-get-more-space-on-mac
    - *step-install-gnutar-on-mac
    - *step-generate-deps-hash
    - *step-touch-sync-done
    - maybe-restore-portaled-src-cache
    - *step-maybe-restore-git-cache
    - *step-set-git-cache-path
    # This sync call only runs if .circle-sync-done is an EMPTY file
    - *step-gclient-sync
    # These next few steps reset Electron to the correct commit regardless of which cache was restored
    - run:
        name: Wipe Electron
        command: rm -rf src/electron
    - *step-checkout-electron
    - *step-run-electron-only-hooks
    - *step-generate-deps-hash-cleanly
    - *step-mark-sync-done
    - *step-minimize-workspace-size-from-checkout

    - *step-depot-tools-add-to-path
    - *step-setup-env-for-build
    - *step-restore-brew-cache
    - *step-get-more-space-on-mac
    - *step-install-npm-deps-on-mac
    - *step-fix-sync-on-mac
    - *step-gn-gen-default

    #Compile ts/js to verify doc change didn't break anything
    - *step-ts-compile

steps-electron-build-for-publish: &steps-electron-build-for-publish
  steps:
    - *step-checkout-electron
    - *step-depot-tools-get
    - *step-depot-tools-add-to-path
    - *step-restore-brew-cache
    - *step-get-more-space-on-mac
    - *step-gclient-sync
    - *step-setup-env-for-build
    - *step-delete-git-directories
    - *step-minimize-workspace-size-from-checkout
    - *step-gn-gen-default

    # Electron app
    - *step-electron-build
    - *step-maybe-generate-breakpad-symbols
    - *step-maybe-electron-dist-strip
    - *step-electron-dist-build
    - *step-electron-dist-store
    - *step-maybe-zip-symbols
    - *step-symbols-store

    # mksnapshot
    - *step-mksnapshot-build
    - *step-mksnapshot-store

    # chromedriver
    - *step-electron-chromedriver-build
    - *step-electron-chromedriver-store

    # Node.js headers
    - *step-nodejs-headers-build
    - *step-nodejs-headers-store

    # ffmpeg
    - *step-ffmpeg-gn-gen
    - *step-ffmpeg-build
    - *step-ffmpeg-store

    # hunspell
    - *step-hunspell-build
    - *step-hunspell-store

    # typescript defs
    - *step-maybe-generate-typescript-defs

    # Publish
    - *step-electron-publish

steps-chromedriver-build: &steps-chromedriver-build
  steps:
    - attach_workspace:
        at: .
    - *step-depot-tools-add-to-path
    - *step-setup-env-for-build
    - *step-fix-sync-on-mac
    - *step-gn-gen-default

    - *step-electron-chromedriver-build
    - *step-electron-chromedriver-store

    - *step-maybe-notify-slack-failure

steps-native-tests: &steps-native-tests
  steps:
    - attach_workspace:
        at: .
    - *step-depot-tools-add-to-path
    - *step-setup-env-for-build
    - *step-gn-gen-default

    - run:
        name: Build tests
        command: |
          cd src
          ninja -C out/Default $BUILD_TARGET
    - *step-show-sccache-stats

    - *step-setup-linux-for-headless-testing
    - run:
        name: Run tests
        command: |
          mkdir test_results
          python src/electron/script/native-tests.py run \
            --config $TESTS_CONFIG \
            --tests-dir src/out/Default \
            --output-dir test_results  \
            $TESTS_ARGS

    - store_artifacts:
        path: test_results
        destination: test_results  # Put it in the root folder.
    - store_test_results:
        path: test_results

steps-verify-ffmpeg: &steps-verify-ffmpeg
  steps:
    - attach_workspace:
        at: .
    - *step-depot-tools-add-to-path
    - *step-electron-dist-unzip
    - *step-ffmpeg-unzip
    - *step-setup-linux-for-headless-testing

    - *step-verify-ffmpeg
    - *step-maybe-notify-slack-failure

steps-verify-mksnapshot: &steps-verify-mksnapshot
  steps:
    - attach_workspace:
        at: .
    - *step-depot-tools-add-to-path
    - *step-electron-dist-unzip
    - *step-mksnapshot-unzip
    - *step-setup-linux-for-headless-testing

    - *step-verify-mksnapshot
    - *step-maybe-notify-slack-failure

steps-tests: &steps-tests
  steps:
    - attach_workspace:
        at: .
    - *step-maybe-early-exit-doc-only-change
    - *step-depot-tools-add-to-path
    - *step-electron-dist-unzip
    - *step-mksnapshot-unzip
    - *step-setup-linux-for-headless-testing
    - *step-restore-brew-cache
    - *step-fix-known-hosts-linux
    - *step-install-signing-cert-on-mac

    - run:
        name: Run Electron tests
        environment:
          MOCHA_REPORTER: mocha-multi-reporters
          ELECTRON_TEST_RESULTS_DIR: junit
          MOCHA_MULTI_REPORTERS: mocha-junit-reporter, tap
          ELECTRON_DISABLE_SECURITY_WARNINGS: 1
        command: |
          cd src
          export ELECTRON_OUT_DIR=Default
          (cd electron && node script/yarn test --runners=main --enable-logging --files $(circleci tests glob spec-main/*-spec.ts | circleci tests split))
          (cd electron && node script/yarn test --runners=remote --enable-logging --files $(circleci tests glob spec/*-spec.js | circleci tests split))
    - run:
        name: Check test results existence
        command: |
          cd src

          # Check if test results exist and are not empty.
          if [ ! -s "junit/test-results-remote.xml" ]; then
            exit 1
          fi
          if [ ! -s "junit/test-results-main.xml" ]; then
            exit 1
          fi
    - store_test_results:
        path: src/junit

    - *step-verify-mksnapshot

    - *step-maybe-notify-slack-failure

steps-test-nan: &steps-test-nan
  steps:
    - attach_workspace:
          at: .
    - *step-maybe-early-exit-doc-only-change
    - *step-depot-tools-add-to-path
    - *step-electron-dist-unzip
    - *step-setup-linux-for-headless-testing
    - *step-fix-known-hosts-linux
    - run:
        name: Run Nan Tests
        command: |
          cd src
          export ELECTRON_OUT_DIR=Default
          node electron/script/nan-spec-runner.js

steps-test-node: &steps-test-node
  steps:
    - attach_workspace:
          at: .
    - *step-maybe-early-exit-doc-only-change
    - *step-depot-tools-add-to-path
    - *step-electron-dist-unzip
    - *step-setup-linux-for-headless-testing
    - *step-fix-known-hosts-linux
    - run:
        name: Run Node Tests
        command: |
          cd src
          export ELECTRON_OUT_DIR=Default
          node electron/script/node-spec-runner.js junit
    - store_test_results:
        path: src/junit

chromium-upgrade-branches: &chromium-upgrade-branches
  /chromium\-upgrade\/[0-9]+/

# Command Aliases
commands:
  maybe-restore-portaled-src-cache:
    steps:
      - run:
          name: Prepare for cross-OS sync restore
          command: |
            sudo mkdir -p /portal
            sudo chown -R $(id -u):$(id -g) /portal
      - *step-maybe-restore-src-cache
      - run:
          name: Fix the src cache restore point on macOS
          command: |
            if [ -d "/portal/src" ]; then
              echo Relocating Cache
              rm -rf src
              mv /portal/src ./
            fi
  checkout-from-cache:
    steps:
      - *step-checkout-electron
      - *step-maybe-early-exit-doc-only-change
      - *step-depot-tools-get
      - *step-depot-tools-add-to-path
      - *step-generate-deps-hash
      - maybe-restore-portaled-src-cache
      - run:
          name: Ensure src checkout worked
          command: |
            if [ ! -d "src/third_party/blink" ]; then
              echo src cache was not restored for some reason, idk what happened here...
              exit 1
            fi
      - run:
          name: Wipe Electron
          command: rm -rf src/electron
      - *step-checkout-electron
      - *step-run-electron-only-hooks
      - *step-generate-deps-hash-cleanly
  electron-build:
    parameters:
      attach:
        type: boolean
        default: false
      persist:
        type: boolean
        default: true
      persist-checkout:
        type: boolean
        default: false
      checkout:
        type: boolean
        default: true
      checkout-and-assume-cache:
        type: boolean
        default: false
      build:
        type: boolean
        default: true
    steps:
      - when:
          condition: << parameters.attach >>
          steps:
            - attach_workspace:
                at: .
      - *step-restore-brew-cache
      - *step-install-gnutar-on-mac
      - when:
          condition: << parameters.checkout-and-assume-cache >>
          steps:
            - checkout-from-cache
      - when:
          condition: << parameters.checkout >>
          steps:
            # Checkout - Copied ffrom steps-checkout
            - *step-checkout-electron
            - *step-check-for-doc-only-change
            - *step-persist-doc-only-change
            - *step-maybe-early-exit-doc-only-change
            - *step-depot-tools-get
            - *step-depot-tools-add-to-path
            - *step-get-more-space-on-mac
            - *step-generate-deps-hash
            - *step-touch-sync-done
            - maybe-restore-portaled-src-cache
            - *step-maybe-restore-git-cache
            - *step-set-git-cache-path
            # This sync call only runs if .circle-sync-done is an EMPTY file
            - *step-gclient-sync
            # These next few steps reset Electron to the correct commit regardless of which cache was restored
            - run:
                name: Wipe Electron
                command: rm -rf src/electron
            - *step-checkout-electron
            - *step-run-electron-only-hooks
            - *step-generate-deps-hash-cleanly
            - *step-mark-sync-done
            - *step-minimize-workspace-size-from-checkout
            - when:
                condition: << parameters.persist-checkout >>
                steps:
                  - persist_to_workspace:
                      root: .
                      paths:
                        - depot_tools
                        - src

      - when:
          condition: << parameters.build >>
          steps:
            - *step-depot-tools-add-to-path
            - *step-setup-env-for-build
            - *step-get-more-space-on-mac
            - *step-fix-sync-on-mac
            - *step-delete-git-directories
            - *step-gn-gen-default

            # Electron app
            - *step-restore-out-cache
            - *step-gn-gen-default
            - *step-electron-build
            - *step-ninja-summary
            - *step-ninja-report
            - *step-maybe-electron-dist-strip
            - *step-electron-dist-build
            - *step-electron-dist-store

            # Native test targets
            - *step-native-unittests-build
            - *step-native-unittests-store

            # Node.js headers
            - *step-nodejs-headers-build
            - *step-nodejs-headers-store

            - *step-show-sccache-stats

            # mksnapshot
            - *step-mksnapshot-build
            - *step-mksnapshot-store
            - *step-maybe-cross-arch-snapshot
            - *step-maybe-cross-arch-snapshot-store

            # ffmpeg
            - *step-ffmpeg-gn-gen
            - *step-ffmpeg-build
            - *step-ffmpeg-store

            # hunspell
            - *step-hunspell-build
            - *step-hunspell-store

      # Save all data needed for a further tests run.
      - when:
          condition: << parameters.persist >>
          steps:
            - *step-persist-data-for-tests

      - when:
          condition: << parameters.build >>
          steps:
            - *step-maybe-generate-breakpad-symbols
            - *step-maybe-zip-symbols
            - *step-symbols-store

      - when:
          condition: << parameters.build >>
          steps:
            - run:
                name: Remove the big things on macOS, this seems to be better on average
                command: |
                  if [ "`uname`" == "Darwin" ]; then
                    mkdir -p src/out/Default
                    cd src/out/Default
                    find . -type f -size +50M -delete
                    mkdir -p gen/electron
                    cd gen/electron
                    # These files do not seem to like being in a cache, let us remove them
                    find . -type f -name '*_pkg_info' -delete
                  fi
            - *step-save-out-cache

      # Trigger tests on arm hardware if needed
      - *step-maybe-trigger-arm-test

      - *step-maybe-notify-slack-failure

# List of all jobs.
jobs:
  # Layer 0: Lint. Standalone.
  lint:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
    <<: *steps-lint

  ts-compile-doc-change:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-testing-build
    <<: *steps-electron-ts-compile-for-doc-change

  # Layer 1: Checkout.
  linux-checkout-fast:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    steps:
      - electron-build:
          persist: false
          build: false
          checkout: true
          persist-checkout: true

  linux-checkout-and-save-cache:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    <<: *steps-checkout-and-save-cache

  linux-checkout-for-native-tests:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_pyyaml=True'
    steps:
      - electron-build:
          persist: false
          build: false
          checkout: true
          persist-checkout: true

  linux-checkout-for-native-tests-with-no-patches:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      GCLIENT_EXTRA_ARGS: '--custom-var=apply_patches=False --custom-var=checkout_pyyaml=True'
    steps:
      - electron-build:
          persist: false
          build: false
          checkout: true
          persist-checkout: true

  mac-checkout-fast:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-testing-build
      <<: *env-macos-build
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_mac=True --custom-var=host_os=mac'
    steps:
      - electron-build:
          persist: false
          build: false
          checkout: true
          persist-checkout: true

  mac-checkout-and-save-cache:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-testing-build
      <<: *env-macos-build
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_mac=True --custom-var=host_os=mac'
    <<: *steps-checkout-and-save-cache

  # Layer 2: Builds.
  linux-x64-testing:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    steps:
      - electron-build:
          persist: true
          checkout: true

  linux-x64-testing-no-run-as-node:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      <<: *env-disable-run-as-node
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    steps:
      - electron-build:
          persist: false
          checkout: true

  linux-x64-testing-gn-check:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-testing-build
    <<: *steps-electron-gn-check

  linux-x64-chromedriver:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
    <<: *steps-chromedriver-build

  linux-x64-release:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
      <<: *env-ninja-status
    <<: *steps-electron-build

  linux-x64-publish:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
      <<: *env-release-build
      <<: *env-enable-sccache
      UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
    <<: *steps-electron-build-for-publish

  linux-ia32-testing:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-ia32
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    steps:
      - electron-build:
          persist: true
          checkout: true

  linux-ia32-chromedriver:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
    <<: *steps-chromedriver-build

  linux-ia32-release:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      <<: *env-ia32
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
      <<: *env-ninja-status
    <<: *steps-electron-build

  linux-ia32-publish:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
      <<: *env-ia32
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-32bit-release
      UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
    <<: *steps-electron-build-for-publish

  linux-arm-testing:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-arm
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      TRIGGER_ARM_TEST: true
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    steps:
      - electron-build:
          persist: false
          checkout: true

  linux-arm-chromedriver:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-arm
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
    <<: *steps-chromedriver-build

  linux-arm-release:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      <<: *env-arm
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
      <<: *env-ninja-status
    <<: *steps-electron-build

  linux-arm-publish:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      <<: *env-arm
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-32bit-release
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_boto=True --custom-var=checkout_requests=True'
      UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
    <<: *steps-electron-build-for-publish

  linux-arm64-testing:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-arm64
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      TRIGGER_ARM_TEST: true
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm=True --custom-var=checkout_arm64=True'
    steps:
      - electron-build:
          persist: false
          checkout: true

  linux-arm64-testing-gn-check:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-arm64
      <<: *env-testing-build
    <<: *steps-electron-gn-check

  linux-arm64-chromedriver:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-arm64
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
    <<: *steps-chromedriver-build

  linux-arm64-release:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      <<: *env-arm64
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
      <<: *env-ninja-status
    <<: *steps-electron-build

  linux-arm64-publish:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge-release
      <<: *env-arm64
      <<: *env-release-build
      <<: *env-enable-sccache
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_arm64=True --custom-var=checkout_boto=True --custom-var=checkout_requests=True'
      UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
    <<: *steps-electron-build-for-publish

  osx-testing:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      <<: *env-macos-build
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_mac=True --custom-var=host_os=mac'
    steps:
      - electron-build:
          persist: true
          checkout: false
          checkout-and-assume-cache: true
          attach: false

  osx-testing-gn-check:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-testing-build
    <<: *steps-electron-gn-check

  osx-chromedriver:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
    <<: *steps-chromedriver-build

  osx-release:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
    <<: *steps-electron-build

  osx-publish:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large-release
      <<: *env-release-build
      <<: *env-enable-sccache
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
      UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
    <<: *steps-electron-build-for-publish

  mas-testing:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-mas
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
      <<: *env-macos-build
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_mac=True --custom-var=host_os=mac'
    steps:
      - electron-build:
          persist: true
          checkout: false
          checkout-and-assume-cache: true
          attach: false

  mas-testing-gn-check:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-mas
      <<: *env-testing-build
    <<: *steps-electron-gn-check

  mas-chromedriver:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-send-slack-notifications
    <<: *steps-chromedriver-build

  mas-release:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-mas
      <<: *env-release-build
      <<: *env-enable-sccache
      <<: *env-ninja-status
    <<: *steps-electron-build

  mas-publish:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large-release
      <<: *env-mas
      <<: *env-release-build
      <<: *env-enable-sccache
      GCLIENT_EXTRA_ARGS: '--custom-var=checkout_boto=True --custom-var=checkout_requests=True'
      UPLOAD_TO_S3: << pipeline.parameters.upload-to-s3 >>
    <<: *steps-electron-build-for-publish

  # Layer 3: Tests.
  linux-x64-unittests:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-unittests
      <<: *env-enable-sccache
      <<: *env-headless-testing
    <<: *steps-native-tests

  linux-x64-disabled-unittests:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-unittests
      <<: *env-enable-sccache
      <<: *env-headless-testing
      TESTS_ARGS: '--only-disabled-tests'
    <<: *steps-native-tests

  linux-x64-chromium-unittests:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-unittests
      <<: *env-enable-sccache
      <<: *env-headless-testing
      TESTS_ARGS: '--include-disabled-tests'
    <<: *steps-native-tests

  linux-x64-browsertests:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-2xlarge
      <<: *env-browsertests
      <<: *env-testing-build
      <<: *env-enable-sccache
      <<: *env-headless-testing
    <<: *steps-native-tests

  linux-x64-testing-tests:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-headless-testing
      <<: *env-stack-dumping
    parallelism: 3
    <<: *steps-tests

  linux-x64-testing-nan:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-headless-testing
      <<: *env-stack-dumping
    <<: *steps-test-nan

  linux-x64-testing-node:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-medium
      <<: *env-headless-testing
      <<: *env-stack-dumping
    <<: *steps-test-node

  linux-x64-release-tests:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-headless-testing
      <<: *env-send-slack-notifications
    <<: *steps-tests

  linux-x64-verify-ffmpeg:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-headless-testing
      <<: *env-send-slack-notifications
    <<: *steps-verify-ffmpeg

  linux-x64-verify-mksnapshot:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-headless-testing
      <<: *env-send-slack-notifications
    <<: *steps-verify-mksnapshot

  linux-ia32-testing-tests:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-headless-testing
      <<: *env-stack-dumping
    parallelism: 3
    <<: *steps-tests

  linux-ia32-testing-nan:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-headless-testing
      <<: *env-stack-dumping
    <<: *steps-test-nan

  linux-ia32-testing-node:
    <<: *machine-linux-2xlarge
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-headless-testing
      <<: *env-stack-dumping
    <<: *steps-test-node

  linux-ia32-release-tests:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-headless-testing
      <<: *env-send-slack-notifications
    <<: *steps-tests

  linux-ia32-verify-ffmpeg:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-headless-testing
      <<: *env-send-slack-notifications
    <<: *steps-verify-ffmpeg

  linux-ia32-verify-mksnapshot:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-ia32
      <<: *env-headless-testing
      <<: *env-send-slack-notifications
    <<: *steps-verify-mksnapshot

  osx-testing-tests:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-stack-dumping
    parallelism: 2
    <<: *steps-tests

  osx-release-tests:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-stack-dumping
      <<: *env-send-slack-notifications
    <<: *steps-tests

  osx-verify-ffmpeg:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-send-slack-notifications
    <<: *steps-verify-ffmpeg

  osx-verify-mksnapshot:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-send-slack-notifications
    <<: *steps-verify-mksnapshot

  mas-testing-tests:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-stack-dumping
    parallelism: 2
    <<: *steps-tests

  mas-release-tests:
    <<: *machine-mac-large
    environment:
      <<: *env-mac-large
      <<: *env-stack-dumping
      <<: *env-send-slack-notifications
    <<: *steps-tests

  mas-verify-ffmpeg:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-send-slack-notifications
    <<: *steps-verify-ffmpeg

  mas-verify-mksnapshot:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-send-slack-notifications
    <<: *steps-verify-mksnapshot

  # Layer 4: Summary.
  linux-x64-release-summary:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-send-slack-notifications
    steps:
      - *step-maybe-notify-slack-success

  linux-ia32-release-summary:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-send-slack-notifications
    steps:
      - *step-maybe-notify-slack-success

  linux-arm-release-summary:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-send-slack-notifications
    steps:
      - *step-maybe-notify-slack-success

  linux-arm64-release-summary:
    <<: *machine-linux-medium
    environment:
      <<: *env-linux-medium
      <<: *env-send-slack-notifications
    steps:
      - *step-maybe-notify-slack-success

  mas-release-summary:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-send-slack-notifications
    steps:
      - *step-maybe-notify-slack-success

  osx-release-summary:
    <<: *machine-mac
    environment:
      <<: *env-machine-mac
      <<: *env-send-slack-notifications
    steps:
      - *step-maybe-notify-slack-success

workflows:
  version: 2.1

  # The publish workflows below each contain one job so that they are
  # compatible with how sudowoodo works today.  If these workflows are
  # changed to have multiple jobs, then scripts/release/ci-release-build.js
  # will need to be updated and there will most likely need to be changes to
  # sudowoodo

  publish-x64-linux:
    when: << pipeline.parameters.run-linux-x64-publish >>
    jobs:
    - linux-x64-publish:
        context: release-env

  publish-ia32-linux:
    when: << pipeline.parameters.run-linux-ia32-publish >>
    jobs:
    - linux-ia32-publish:
        context: release-env

  publish-arm-linux:
    when: << pipeline.parameters.run-linux-arm-publish >>
    jobs:
    - linux-arm-publish:
        context: release-env

  publish-arm64-linux:
    when: << pipeline.parameters.run-linux-arm64-publish >>
    jobs:
    - linux-arm64-publish:
        context: release-env

  publish-osx:
    when: << pipeline.parameters.run-osx-publish >>
    jobs:
    - osx-publish:
        context: release-env

  publish-mas:
    when: << pipeline.parameters.run-mas-publish >>
    jobs:
    - mas-publish:
        context: release-env

  lint:
    when: << pipeline.parameters.run-lint >>
    jobs:
      - lint

  build-linux:
    when: << pipeline.parameters.run-build-linux >>
    jobs:
      - linux-checkout-fast
      - linux-checkout-and-save-cache

      - linux-x64-testing
      - linux-x64-testing-no-run-as-node
      - linux-x64-testing-gn-check:
          requires:
            - linux-checkout-fast
      - linux-x64-testing-tests:
          requires:
            - linux-x64-testing
      - linux-x64-testing-nan:
          requires:
            - linux-x64-testing
      - linux-x64-testing-node:
          requires:
            - linux-x64-testing

      - linux-ia32-testing
      - linux-ia32-testing-tests:
          requires:
            - linux-ia32-testing
      - linux-ia32-testing-nan:
          requires:
            - linux-ia32-testing
      - linux-ia32-testing-node:
          requires:
            - linux-ia32-testing

      - linux-arm-testing

      - linux-arm64-testing
      - linux-arm64-testing-gn-check:
          requires:
            - linux-checkout-fast
      - ts-compile-doc-change

  build-mac:
    when: << pipeline.parameters.run-build-mac >>
    jobs:
      - mac-checkout-fast
      - mac-checkout-and-save-cache

      - osx-testing:
          requires:
            - mac-checkout-and-save-cache

      - osx-testing-gn-check:
          requires:
            - mac-checkout-fast

      - osx-testing-tests:
          requires:
            - osx-testing

      - mas-testing:
          requires:
            - mac-checkout-and-save-cache

      - mas-testing-gn-check:
          requires:
            - mac-checkout-fast

      - mas-testing-tests:
          requires:
            - mas-testing

  nightly-linux-release-test:
    triggers:
      - schedule:
          cron: "0 0 * * *"
          filters:
            branches:
              only:
                - master
                - *chromium-upgrade-branches
    jobs:
      - linux-checkout-fast

      - linux-x64-release:
          requires:
            - linux-checkout-fast
      - linux-x64-release-tests:
          requires:
            - linux-x64-release
      - linux-x64-verify-ffmpeg:
          requires:
            - linux-x64-release
      - linux-x64-verify-mksnapshot:
          requires:
            - linux-x64-release
      - linux-x64-chromedriver:
          requires:
            - linux-checkout-fast
      - linux-x64-release-summary:
          requires:
            - linux-x64-release
            - linux-x64-release-tests
            - linux-x64-verify-ffmpeg
            - linux-x64-chromedriver

      - linux-ia32-release:
          requires:
            - linux-checkout-fast
      - linux-ia32-release-tests:
          requires:
            - linux-ia32-release
      - linux-ia32-verify-ffmpeg:
          requires:
            - linux-ia32-release
      - linux-ia32-verify-mksnapshot:
          requires:
            - linux-ia32-release
      - linux-ia32-chromedriver:
          requires:
            - linux-checkout-fast
      - linux-ia32-release-summary:
          requires:
            - linux-ia32-release
            - linux-ia32-release-tests
            - linux-ia32-verify-ffmpeg
            - linux-ia32-chromedriver

      - linux-arm-release:
          requires:
            - linux-checkout-fast
      - linux-arm-chromedriver:
          requires:
            - linux-checkout-fast
      - linux-arm-release-summary:
          requires:
            - linux-arm-release
            - linux-arm-chromedriver


      - linux-arm64-release:
          requires:
            - linux-checkout-fast
      - linux-arm64-chromedriver:
          requires:
            - linux-checkout-fast
      - linux-arm64-release-summary:
          requires:
            - linux-arm64-release
            - linux-arm64-chromedriver

  nightly-mac-release-test:
    triggers:
      - schedule:
          cron: "0 0 * * *"
          filters:
            branches:
              only:
                - master
                - *chromium-upgrade-branches
    jobs:
      - mac-checkout-fast

      - osx-release:
          requires:
            - mac-checkout-fast
      - osx-release-tests:
          requires:
            - osx-release
      - osx-verify-ffmpeg:
          requires:
            - osx-release
      - osx-verify-mksnapshot:
          requires:
            - osx-release
      - osx-chromedriver:
          requires:
            - mac-checkout-fast
      - osx-release-summary:
          requires:
          - osx-release
          - osx-release-tests
          - osx-verify-ffmpeg
          - osx-chromedriver

      - mas-release:
          requires:
            - mac-checkout-fast
      - mas-release-tests:
          requires:
            - mas-release
      - mas-verify-ffmpeg:
          requires:
            - mas-release
      - mas-verify-mksnapshot:
          requires:
            - mas-release
      - mas-chromedriver:
          requires:
            - mac-checkout-fast
      - mas-release-summary:
          requires:
          - mas-release
          - mas-release-tests
          - mas-verify-ffmpeg
          - mas-chromedriver

  # Various slow and non-essential checks we run only nightly.
  # Sanitizer jobs should be added here.
  linux-checks-nightly:
    triggers:
      - schedule:
          cron: "0 0 * * *"
          filters:
            branches:
              only:
                - master
                - *chromium-upgrade-branches
    jobs:
      - linux-checkout-for-native-tests

      # TODO(alexeykuzmin): Enable it back.
      # Tons of crashes right now, see
      # https://circleci.com/gh/electron/electron/67463
#      - linux-x64-browsertests:
#          requires:
#            - linux-checkout-for-native-tests

      - linux-x64-unittests:
          requires:
            - linux-checkout-for-native-tests

      - linux-x64-disabled-unittests:
          requires:
            - linux-checkout-for-native-tests

      - linux-checkout-for-native-tests-with-no-patches

      - linux-x64-chromium-unittests:
          requires:
            - linux-checkout-for-native-tests-with-no-patches
