Integrate Tracks Gradle plugin

[wzieba]

Closes: #5212

Description

This PR integrates Tracks-Gradle plugin.

Please note that accepting this PR is also accepting change to secrets gradle.properties with same values as in gradle.properties-example in this PR.

Testing instructions

Before starting tests, please set debug mode for easier testing:

tracks {
    (...)
    debug.set(true)
}

• TC1 Fresh clone

1. Clone repository on this branch to a temporary directory
2. Remember about setting debug flag to tracks
3. Prepare project: cp gradle.properties-example gradle.properties
4. Run some task: ./gradlew tasks
5. Assert the event has been sent with: "username":null in payload

• TC2 Current environment

1. Checkout this branch on your casual environment
2. Remember about setting debug flag to tracks
3. Add tracksUsername = test to gradle.properties
4. Run some task: ./gradlew tasks
5. Assert the event has been sent with: "username":"test" in payload

• TC3 Disabling tracking

1. Checkout this branch on your casual environment
2. Add tracksEnabled = false to gradle.properties
3. Run some task: ./gradlew tasks
4. Assert that event has not been sent

Images/gif

• I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

[peril-woocommerce]

You can test the changes on this Pull Request by downloading the APK here.

[malinajirka]

Thanks so much for this great improvement @wzieba! I've tested all the scenarios and it works as expected. I'm not merging to give @oguzkocer a chance to review it.

[oguzkocer]

The code changes look good, I left a comment about the tracksEnabled flag in the gradle.properties-example file.

I didn't test this extensively (following the instructions) as I assume @malinajirka already did. However, I did play with it a bit - especially the state where the tracking is not enabled in gradle.properties - and I found that we print out the below message for ./gradlew -q command:

✅ Build time report of 0m 0s has been received by Tracks.

There are 2 things that are a bit bothersome for me:

1. When the tracking is off, the plugin shouldn't do anything and should be completely disabled. The messaging here suggests that the build time was tracked. (it shouldn't be tracked nor should it print anything)
2. This is not as important, but it looks like this is printed with a println statement in the plugin, instead of using the logger. In my opinion, these logs shouldn't show up when we are running the commands with the -q command. I don't think it's a blocker for this PR (I think the 1st point is) but it'd be great to handle it sooner rather than later.

I think it's also worth pinging the rest of @woocommerce/owl-team in case anyone else from the team would like to check it out before it's merged into develop.

[oguzkocer]

I think we should comment this out by default as well. Our instructions for contributors copies this file as is, and unless we specifically tell them about the tracking in the instructions, it feels wrong to track their build times.

[malinajirka]

especially the state where the tracking is not enabled in gradle.properties - and I found that we print out the below message for ./gradlew -q command:

Good catch! It works as expected, when tracksEnabled = false is explicitly set. But it defaults to true when the flag is not present at all.

[wzieba]

Thanks @oguzkocer @malinajirka ! Answering your concernes:

When the tracking is off, the plugin shouldn't do anything and should be completely disabled. The messaging here suggests that the build time was tracked. (it shouldn't be tracked nor should it print anything)
(...)
Our instructions for contributors copies this file as is, and unless we specifically tell them about the tracking in the instructions, it feels wrong to track their build times.

I wanted to make tracking as opt-out because by default I thought it's good idea to track all of the builds and don't make developers to remember about setting a flag to true after they clone repository.

I agree that it feel wrong for doing this for external contributors though.

So I'll make this opt-in for external contributors, but for our developers gradle.properties I'll set tracksEnabled = true - does it sound good?

---

(...) it looks like this is printed with a println statement in the plugin, instead of using the logger.

I agree with you and that's one of the feedbacks you gave lately, in pair with not collecting build times if they are not meant to be sent. I've just created issues to fix both of them.

---

As those improvements to the Gradle plugin are quite small, I'll mark this PR as draft for now, fix the plugin and this PR and re-request your reviews @oguzkocer @malinajirka

• Make build measurements disabled by default for external contributors
• Make build measurements enabled by default for A12s
  Update secret gradle.properties for tracks-gradle configuration options #5324
• Use Gradle logger instead of println Automattic/measure-builds-gradle-plugin#8
• Do not collect build times if they are not meant to be sent Automattic/measure-builds-gradle-plugin#9

[wzieba]

It's findProperty and not getProperty because I didn't want to cause build crash for developers that won't update gradle.properties immediately after this PR. Does it sound good or should we rather enforce gradle.properties update?

[oguzkocer]

I think that's the right decision since these properties are optional.

[wzieba]

I've applied improvements in tracks-gradle plugin (please see attached issues for details).

If it looks good to you, please don't merge this PR yet as just after this PR will be merged, I'll update internal gradle.properties with

# Measuring build times
tracksEnabled = true
#tracksUsername = <optional username>

which will make measuring enabled by default for our developers. Does it sound good to you?

[oguzkocer]

@wzieba Thank you for the improvements. I've tested the tracksEnabled = false and there were no extra logs as expected. The scan also showed only 0.008s of setup time for the plugin which is great!

[malinajirka]

Sorry, I was afk. Thanks for the review @oguzkocer and thanks for the improvements @wzieba ! 👏