Metric overhaul #1504

rorbech · 2023-09-06T15:27:41Z

This PR reworks analytics collection to track individual platform builds and aligns submitted data with other SDKs.

This also introduces introduces the ability to print the collected information to the Gradle log (with warning loglevel) by setting the enviroment variable

REALM_PRINT_ANALYTICS=true

There is strictly no need to run this as a service anymore as we don't really gather metrics across tasks anymore. But felt more appropriate to keep it around if we should extent the responsibilities at some point.

TODOs

Model and API feature tracking - Will be done in a separate PR

Closes #127
Closes #1390
Closes #1492

nhachicha

LGTM 👍 minor stuff!

packages/gradle-plugin/build.gradle.kts

packages/plugin-compiler/src/main/kotlin/io/realm/kotlin/compiler/RealmCommandLineProcessor.kt

packages/gradle-plugin/src/main/kotlin/io/realm/kotlin/gradle/analytics/AnalyticsService.kt

packages/gradle-plugin/src/main/kotlin/io/realm/kotlin/gradle/RealmCompilerSubplugin.kt

Co-authored-by: Nabil Hachicha <nabil.hachicha@mongodb.com>

…rics-overhaul

cmelchior · 2023-09-19T08:44:03Z

packages/gradle-plugin/build.gradle.kts

+// Task to fetch core version from dependency.list from core submodule
+tasks.create("coreVersion", Exec::class.java) {
+    workingDir = project.file(listOf("..", "external", "core").joinToString(File.separator))
+    commandLine = listOf("grep", "^VERSION", "dependencies.list")


I'm not sure if grep is available on Windows? It would probably be safer to use the Kotlin API to read the file content and find it that way?

Damn it. You and your windows machine 😅

I updated it to read the file through Kotlin API on top of Gradles file content provider API so now it should be fully platform agnostic and appropriately regenerate if external/core/dependencies.list is updated.

packages/gradle-plugin/src/main/kotlin/io/realm/kotlin/gradle/analytics/AnalyticsService.kt

packages/plugin-compiler/src/main/kotlin/io/realm/kotlin/compiler/RealmCommandLineProcessor.kt

rorbech · 2023-09-22T14:23:16Z

Analytics is now printed if the print option is enabled (with REALM_PRINT_ANALYTICS=true), and submitted to the endpoint unless disabled (with REALM_DISABLED_ANALYTICS=true).

The analytics information is only gathered if neither needed for printing nor submission.

This enable us to test collection in CI enviroments by enable printing but keeping it disabled.

cmelchior

Looking really good. Mostly minor comments and then we should probably also retest this on Windows 😅

cmelchior · 2023-10-13T11:07:02Z

integration-tests/gradle/gradle6-test/build.gradle.kts

-    dependencies {
-        classpath("io.realm.kotlin:gradle-plugin:${Realm.version}")
-    }
+        extra["realmVersion"] = file("${rootProject.rootDir.absolutePath}/../../../buildSrc/src/main/kotlin/Config.kt")


I assume this is because you want to decouple the tests completely?

Yes. It we use buildSrc to gain access to Config.kt it is problematic to use Kotlin and AGP versions that are different from the ones in Config.kt because buildSrc applies a number of plugins and that will fix the versions.

integration-tests/gradle/gradle6-test/single-platform/build.gradle.kts

cmelchior · 2023-10-13T11:27:42Z

packages/gradle-plugin/build.gradle.kts

@@ -106,8 +115,10 @@ tasks.create("pluginVersion") {
            // Generated file. Do not edit!
            package io.realm.kotlin.gradle
            internal const val PLUGIN_VERSION = "${project.version}"
+            internal const val CORE_VERSION = "${coreVersion}"


Given that we often point to commits that are not tagged releases, this might not be 100% accurate. But I assume that appending the submodule commit sha might be a bit tricky, so maybe this fine?

It is not tricky ... on the client side. But it will probably clutter the remote view. I guess we should rather just strive to use tagged core-releases 😉 For discussion see https://mongodb.slack.com/archives/C04M17MCY0H/p1693920525143069

packages/gradle-plugin/src/main/kotlin/io/realm/kotlin/gradle/RealmCompilerSubplugin.kt

rorbech · 2023-10-30T13:24:23Z

This just requires manual verification on Windows - @cmelchior let me know when tested.

cmelchior

Testing this on Windows with Java 17, I got the following failure on the Gradle 6 integration test:

-----------
* What went wrong:
Execution failed for task ':single-platform:compileReleaseJavaWithJavac'.
> java.lang.IllegalAccessError: class org.gradle.internal.compiler.java.ClassNameCollector (in unnamed module @0x6592fe6e) cannot access class com.sun.tools.javac.code.Symbol$TypeSymbol (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.code to unnamed module @0x6592fe6e

Using

gw :single-platform:assemble --configuration-cache

The Gradle 8 test worked fine using the same command.

rorbech · 2023-11-13T13:28:35Z

Testing this on Windows with Java 17, I got the following failure on the Gradle 6 integration test:

-----------
* What went wrong:
Execution failed for task ':single-platform:compileReleaseJavaWithJavac'.
> java.lang.IllegalAccessError: class org.gradle.internal.compiler.java.ClassNameCollector (in unnamed module @0x6592fe6e) cannot access class com.sun.tools.javac.code.Symbol$TypeSymbol (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.code to unnamed module @0x6592fe6e

Using

gw :single-platform:assemble --configuration-cache

The Gradle 8 test worked fine using the same command.

I don't expect this to be an issue with PR nor our plugin. I can provoke something similar on a Mac:

Caused by: java.lang.reflect.InaccessibleObjectException: Unable to make field private final java.lang.String java.io.File.path accessible: module java.base does not "opens java.io" to unnamed module @251de3f8

from our current main's example/min-android-sample and try to build it with Java 17. I also get the same error if
I strip applying our plugin and dependencies.

Does it work assembling the min-android-sample from main on Windows with Java 17?

cmelchior · 2023-11-14T15:12:33Z

After testing, you are correct, this is also happening on main, so is unrelated to this PR.

cmelchior

Metric overhaul

64d23c6

cla-bot bot added the cla: yes label Sep 6, 2023

github-actions bot assigned rorbech Sep 6, 2023

Support gradle configuration caching

902e8f7

rorbech added the no-changelog label Sep 8, 2023

rorbech marked this pull request as ready for review September 8, 2023 13:57

rorbech requested review from cmelchior and nhachicha September 8, 2023 14:16

nhachicha approved these changes Sep 11, 2023

View reviewed changes

rorbech and others added 4 commits September 11, 2023 14:11

Apply suggestions from code review

8f869f4

Co-authored-by: Nabil Hachicha <nabil.hachicha@mongodb.com>

Updates according to review comments

544a3c4

Fix json formatting

50a79be

Merge remote-tracking branch 'origin/cr/metrics-overhaul' into cr/met…

da915cc

…rics-overhaul

rorbech requested a review from nhachicha September 12, 2023 09:07

Merge branch 'main' into cr/metrics-overhaul

4b7ee93

cmelchior reviewed Sep 19, 2023

View reviewed changes

rorbech added 2 commits September 19, 2023 14:43

Read core version through platform agnostic APIs

410bbd4

Update documentation of dumping options

2c861cf

rorbech requested a review from cmelchior September 19, 2023 14:55

cmelchior and others added 4 commits September 21, 2023 12:43

Fix windows build.

73501df

Enable collection of metrics in CI builds

7dcf74c

Update builder id string when failing

ddad510

Fix cocoapods reference in collected metrics

27da2a0

rorbech added 2 commits September 27, 2023 13:39

Bump minimum supported Gradle version

0cb3003

Change info message prefix

cb866a6

nhachicha approved these changes Oct 6, 2023

View reviewed changes

rorbech added 3 commits October 9, 2023 16:08

Gradle version differentiation and error handling

5351adb

Add gradle version test projects

18aaa89

Clean up gradle compatibility tests

cb61636

rorbech added 5 commits October 11, 2023 10:31

Run Gradle8 tests with JDK 17

6b51f79

Fix gradle8 build issue

471a9bb

Fix jenkins environment for gradle 8 build

cd59445

Merge branch 'main' into cr/metrics-overhaul

34f2882

Upgrade minimum supported Kotlin version

01e10a1

cmelchior reviewed Oct 13, 2023

View reviewed changes

Add gradle integration project with current version

9f9a301

rorbech requested a review from cmelchior October 17, 2023 12:40

rorbech added 2 commits October 17, 2023 14:43

Revert minimum supported Gradle version

d4b65d6

Revert project settings

aff72ae

cmelchior approved these changes Oct 19, 2023

View reviewed changes

cmelchior suggested changes Nov 13, 2023

View reviewed changes

rorbech requested a review from cmelchior November 14, 2023 08:11

cmelchior approved these changes Nov 14, 2023

View reviewed changes

rorbech added 2 commits November 14, 2023 16:17

Merge branch 'main' into cr/metrics-overhaul

a22da77

Bump Kotlin version in integration tests to fit new minimum version

a3598de

rorbech merged commit 140dc21 into main Nov 15, 2023
2 checks passed

rorbech deleted the cr/metrics-overhaul branch November 15, 2023 12:57

github-actions bot locked as resolved and limited conversation to collaborators Mar 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Metric overhaul #1504

Metric overhaul #1504

rorbech commented Sep 6, 2023 •

edited

Loading

nhachicha left a comment

cmelchior Sep 19, 2023

rorbech Sep 19, 2023

rorbech Sep 19, 2023 •

edited

Loading

rorbech commented Sep 22, 2023

cmelchior left a comment

cmelchior Oct 13, 2023

rorbech Oct 16, 2023

cmelchior Oct 13, 2023

rorbech Oct 16, 2023

rorbech commented Oct 30, 2023

cmelchior left a comment

rorbech commented Nov 13, 2023

cmelchior commented Nov 14, 2023

cmelchior left a comment

Metric overhaul #1504

Metric overhaul #1504

Conversation

rorbech commented Sep 6, 2023 • edited Loading

nhachicha left a comment

Choose a reason for hiding this comment

cmelchior Sep 19, 2023

Choose a reason for hiding this comment

rorbech Sep 19, 2023

Choose a reason for hiding this comment

rorbech Sep 19, 2023 • edited Loading

Choose a reason for hiding this comment

rorbech commented Sep 22, 2023

cmelchior left a comment

Choose a reason for hiding this comment

cmelchior Oct 13, 2023

Choose a reason for hiding this comment

rorbech Oct 16, 2023

Choose a reason for hiding this comment

cmelchior Oct 13, 2023

Choose a reason for hiding this comment

rorbech Oct 16, 2023

Choose a reason for hiding this comment

rorbech commented Oct 30, 2023

cmelchior left a comment

Choose a reason for hiding this comment

rorbech commented Nov 13, 2023

cmelchior commented Nov 14, 2023

cmelchior left a comment

Choose a reason for hiding this comment

rorbech commented Sep 6, 2023 •

edited

Loading

rorbech Sep 19, 2023 •

edited

Loading