chore: CircleCI performance improvements on PRs

[olerichter00]

Description

This PR aims to improve CircleCI performance by running only relevant Jest tests on PR commits.

With this change, CircleCI only runs a subset of relevant Jest tests when:

• the branch does not include release, build-me, or hotfix
• the PR does not update any global ts(x) files outside of src/app/Scenes/,
• the PR does not include a build-me tag.

If a PR only updates ts(x) within a scene, CircleCI will from now on only run a subset of relevant tests (within the same scene or with a similar name).

To Do

• Add a label condition to trigger a full test run by adding a label to the pull request.
• Add beta- branches to ignored branches
• yarn.lock and package.json updates need to trigger test suite

Github Action idea to trigger when adding a tag

# Because we don't run all tests on every PR, adding the label "build-me" to a PR will trigger all tests to run on CircleCI. name: Run all js tests on "build-me" label on: pull_request: types: - labeled

jobs:
trigger:
permissions:
contents: none
runs-on: ubuntu-latest
steps:
- name: Trigger all js tests
run: |
curl
-X POST
--header "Content-Type: application/json"
-d "{"branch": "$GITHUB_HEAD_REF"}"
https://circleci.com/api/v1.1/project/github/artsy/eigen/build?circle-token=${{ secrets.CircleToken }}

Tests

• package.json update
• Scene ts file update
• Global ts file update

---

Ideas

git diff --name-only origin/main...$CIRCLE_SHA1 | xargs -n 1 basename | grep -E '^.+\.(ts|tsx)$' | sed 's/\.[^.]*$//'

# Run all tests related to file names

yarn jest $(git diff --name-only origin/main...$CIRCLE_SHA1 | xargs -n 1 basename | grep -E '^.+\.(ts|tsx)$' | sed 's/\.tests//g' | sed 's/\.[^.]*$//')



# Get all updated ts* files

 git diff --name-only origin/main...$CIRCLE_SHA1 | xargs -n 1 basename | grep -E '^.+\.(ts|tsx)$'


# Get all updated scenes

git diff --name-only origin/main...$CIRCLE_SHA1 | grep -E '^.+\.(ts|tsx)$' | sed -n 's#^src/app/Scenes/\([^/]*\)/.*#src/app/Scenes/\1#p' | sort | uniq


# test all updated scenes and files

yarn jest $(git diff --name-only origin/main...$CIRCLE_SHA1 | xargs -n 1 basename | grep -E '^.+\.(ts|tsx)$') $(git diff --name-only origin/main...$CIRCLE_SHA1 | grep -E '^.+\.(ts|tsx)$' | sed -n 's#^src/app/Scenes/\([^/]*\)/.*#src/app/Scenes/\1#p' | uniq)



git diff --dirstat=files,0 HEAD main -- src/app/Scenes/ | grep -E '^[0-9.]+\s+src/app/Scenes/([^/]+)/$' -o | sed 's/src\/app\/Scenes\///'

PR Checklist

• I have tested my changes on iOS and Android.
• I hid my changes behind a feature flag, or they don't need one.
• I have included screenshots or videos, or I have not changed the UI.
• I have added tests, or my changes don't require any.
• I added an app state migration, or my changes do not require one.
• I have documented any follow-up work that this PR will require, or it does not require any.
• I have added a changelog entry below, or my changes do not require one.

To the reviewers 👀

• I would like at least one of the reviewers to run this PR on the simulator or device.

Changelog updates

Changelog updates

Cross-platform user-facing changes

iOS user-facing changes

Android user-facing changes

Dev changes

• CircleCI test performance improvements for PR commits - ole

Need help with something? Have a look at our docs, or get in touch with us.

[ArtsyOpenSource]

This PR contains the following changes:

• Dev changes (CircleCI test performance improvements for PR commits - ole)

Generated by 🚫 dangerJS against 61d21cd

[MounirDhahri]

Nice addition! I think this can have a big impact on how fast our tests run.

Something came to my mind when reviewing this, if a user updates a method within a file that is not under /Scenes, we can run all tests. Ideally, we would run tests only in files that are importing that method but that might not be trivial. What do you think about it?

[olerichter00]

Ideally, we would run tests only in files that are importing that method but that might not be trivial. What do you think about it?

Yes, that would be ideal. There might even be tools that calculate an import tree to run all tests that import files (importing files) which import the updated file. I remember reading an article about someone doing this for Ruby projects. This could be a next step to avoid running non-related tests and, at the same time, to make sure all tests that could potentially fail run in CircleCI.

[brainbicycle]

thought, non-blocking: Always running all tests for main, release and hot fixes makes a lot of sense, for build-me I wonder if forcing a run based on something like a label would be better than having to rename the branch: https://github.com/marketplace/actions/run-circle-ci-on-label

[olerichter00]

That's a great idea! 👍 It might be good to keep both because this is how to force all tests to run in Gravity. I'll try to make this version with the label work as well and then add it here and to Gravity's CircleCI config.

[gkartalis]

Let's also add the beta-ios and beta-android branches here ❤️

[brainbicycle]

🙌

[brainbicycle]

great addition! minor comment about how we force a build

[olerichter00]

This should trigger all tests when adding the label build-me to the PR.

[olerichter00]

@brainbicycle well, this does not work as expected.... Do you have an idea how this could work? I've tried a bit but couldn't find out how to correctly trigger the tests when adding the build-me label with GitHub actions.

[brainbicycle]

it def doesn't have to block anything, I might mess with it one of these future fridays

[brainbicycle]

awesome!

[MrSltun]

Looks great!! ⚡