Overhaul metrics [feature branch]

.github/templates/test-weaver.yml

@@ -11,12 +11,21 @@ env:
   DOTNET_NOLOGO: true
 jobs:
   run-tests-weaver:
-    runs-on: windows-latest
+    strategy:
+      matrix:
+        os:
+        - runner: windows-latest
+          runtime: win-x64
+        - runner: ubuntu-latest
+          runtime: linux-x64
+        - runner: macos-latest
+          runtime: osx-x64
+    runs-on: ${{ matrix.os.runner }}
     name: Weaver
     timeout-minutes: 15
     steps:
       - #@ template.replace(checkoutCode())
-      - #@ template.replace(dotnetPublish("Tests/Weaver/Realm.Fody.Tests", "netcoreapp3.1", "win-x64"))
+      - #@ template.replace(dotnetPublish("Tests/Weaver/Realm.Fody.Tests", "net6.0", "${{ matrix.os.runtime }}"))
       - name: Run Tests
         run: ${{ steps.dotnet-publish.outputs.executable-path }}/Realm.Fody.Tests --result=TestResults.Weaver.xml --labels=After
       - #@ publishTestsResults("TestResults.Weaver.xml", "Weaver")

.github/workflows/prepare-release.yml

@@ -14,6 +14,21 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Read Core version
+        id: get-core-version
+        run: |
+          cd wrappers/realm-core
+          pkgVersion=$(grep "\bVERSION=" dependencies.list | cut -d= -f2)
+          echo "core-version=$pkgVersion" >> $GITHUB_OUTPUT
+        shell: bash
+      - name: Update Analytics.cs
+        uses: jacobtomlinson/gha-find-replace@0dfd0777cc234ef6947ec1f20873c632114c4167 #! 0.1.4
+        with:
+          find: '_coreVersion = "\w*"'
+          replace: '_coreVersion = "${{ steps.get-core-version.outputs.core-version }}"'
+          include: Realm/Realm.Weaver/Analytics/Analytics.cs
       - name: Update Changelog
         id: update-changelog
         uses: realm/ci-actions/update-changelog@187889c026eb16673dba3152906a46ed87406e30

.github/workflows/test-weaver.yml

@@ -6,7 +6,16 @@ env:
   DOTNET_NOLOGO: true
 jobs:
   run-tests-weaver:
-    runs-on: windows-latest
+    strategy:
+      matrix:
+        os:
+        - runner: windows-latest
+          runtime: win-x64
+        - runner: ubuntu-latest
+          runtime: linux-x64
+        - runner: macos-latest
+          runtime: osx-x64
+    runs-on: ${{ matrix.os.runner }}
     name: Weaver
     timeout-minutes: 15
     steps:
@@ -20,10 +29,10 @@ jobs:
     - name: Register msvc problem matcher
       run: echo "::add-matcher::.github/problem-matchers/msvc.json"
     - name: Publish Tests/Weaver/Realm.Fody.Tests
-      run: dotnet publish Tests/Weaver/Realm.Fody.Tests -c Release -f netcoreapp3.1 -r win-x64 --no-self-contained
+      run: dotnet publish Tests/Weaver/Realm.Fody.Tests -c Release -f net6.0 -r ${{ matrix.os.runtime }} --no-self-contained
     - name: Output executable path
       id: dotnet-publish
-      run: echo 'executable-path=./Tests/Weaver/Realm.Fody.Tests/bin/Release/netcoreapp3.1/win-x64' >> $GITHUB_OUTPUT
+      run: echo 'executable-path=./Tests/Weaver/Realm.Fody.Tests/bin/Release/net6.0/${{ matrix.os.runtime }}' >> $GITHUB_OUTPUT
       shell: bash
     - name: Run Tests
       run: ${{ steps.dotnet-publish.outputs.executable-path }}/Realm.Fody.Tests --result=TestResults.Weaver.xml --labels=After

CHANGELOG.md

@@ -93,6 +93,8 @@
 * Realm Studio: 13.0.0 or later.
 
 ### Internal
+* Using Core 13.2.0.
+* Overhauled and extended the metrics collection of the SDK to better drive future development effort. (PR [#3080](https://github.com/realm/realm-dotnet/pull/3080))
 * Using Core 13.4.0.
 * Updated `DynamicRealmObjectHelper.TryGetPrimaryKeyValue` not to use reflection. (Issue [#3166](https://github.com/realm/realm-dotnet/issues/3166))
 * Fixed UWP tests workflow when running a debug build. (Issue [#3030](https://github.com/realm/realm-dotnet/issues/3030))

Realm/Realm.Fody/GlobalSuppressions.cs

@@ -13,3 +13,4 @@
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Nicer organization that way.", Scope = "type", Target = "~T:RealmWeaver.WeaveTypeResult")]
 [assembly: SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Nicer organization that way", Scope = "type", Target = "~T:RealmWeaver.WeavePropertyResult")]
 [assembly: SuppressMessage("Naming", "CA1716:Identifiers should not match keywords", Justification = "It doesn't really conflict with anything.", Scope = "member", Target = "~M:RealmWeaver.ILogger.Error(System.String,Mono.Cecil.Cil.SequencePoint)")]
+[assembly: SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1000:Keywords should be spaced correctly", Justification = "In C# 9.0 we can use new() to instantiate objects and we don't need a space there", Scope = "module")]

Realm/Realm.Fody/ModuleWeaver.cs

@@ -22,6 +22,7 @@
 using System.Runtime.Versioning;
 using Mono.Cecil.Cil;
 using RealmWeaver;
+using static RealmWeaver.Analytics;
 
 public partial class ModuleWeaver : Fody.BaseModuleWeaver, ILogger
 {
@@ -55,66 +56,41 @@ public override IEnumerable<string> GetAssembliesForScanning()
         yield return "System.Threading";
     }
 
-    private Analytics.Config GetAnalyticsConfig(FrameworkName frameworkName)
+    private Config GetAnalyticsConfig(FrameworkName frameworkName)
     {
-        var disableAnalytics = bool.TryParse(Config.Attribute("DisableAnalytics")?.Value, out var result) && result;
-
-        var config = new Analytics.Config
+        AnalyticsCollection analyticsCollection;
+        if (Enum.TryParse<AnalyticsCollection>(Config.Attribute("AnalyticsCollection")?.Value, out var collection))
         {
-            Framework = "xamarin", // This is for backwards compatibility
-            RunAnalytics = !disableAnalytics,
-        };
-
-        config.FrameworkVersion = frameworkName.Version.ToString();
-        config.TargetOSName = GetTargetOSName(frameworkName);
-
-        // For backward compatibility
-        config.TargetOSVersion = frameworkName.Version.ToString();
-
-        return config;
-    }
-
-    private static string GetTargetOSName(FrameworkName frameworkName)
-    {
-        try
+            analyticsCollection = collection;
+        }
+        else if (bool.TryParse(Config.Attribute("DisableAnalytics")?.Value, out var disableAnalytics))
         {
-            // Legacy reporting used ios, osx, and android
-            switch (frameworkName.Identifier)
-            {
-                case "Xamarin.iOS":
-                    return "ios";
-                case "Xamarin.Mac":
-                    return "osx";
-                case "MonoAndroid":
-                case "Mono.Android":
-                    return "android";
-            }
-
-            if (frameworkName.Identifier.EndsWith("-android", StringComparison.OrdinalIgnoreCase))
-            {
-                return "android";
-            }
-
-            if (frameworkName.Identifier.EndsWith("-ios", StringComparison.OrdinalIgnoreCase))
-            {
-                return "ios";
-            }
-
-            if (frameworkName.Identifier.EndsWith("-maccatalyst", StringComparison.OrdinalIgnoreCase))
-            {
-                return "osx";
-            }
+            analyticsCollection = disableAnalytics ? AnalyticsCollection.Disabled : AnalyticsCollection.Full;
+        }
+        else if (Environment.GetEnvironmentVariable("REALM_DISABLE_ANALYTICS") != null || Environment.GetEnvironmentVariable("CI") != null)
+        {
+            analyticsCollection = AnalyticsCollection.Disabled;
         }
-        catch
+        else
         {
 #if DEBUG
-            // Make sure we get build failures and address the problem in debug,
-            // but don't fail users' builds because of that.
-            throw;
+            analyticsCollection = AnalyticsCollection.DryRun;
+#else
+            analyticsCollection = AnalyticsCollection.Full;
 #endif
         }
 
-        return "windows";
+        var config = new Config
+        {
+            AnalyticsCollection = analyticsCollection,
+            AnalyticsLogPath = Config.Attribute("AnalyticsLogPath")?.Value,
+            InstallationMethod = "Nuget",
+        };
+
+        config.NetFrameworkTarget = frameworkName.Identifier;
+        config.NetFrameworkTargetVersion = frameworkName.Version.ToString();
+        config.TargetOSName = AnalyticsUtils.GetTargetOsName(frameworkName);
+        return config;
     }
 
     void ILogger.Debug(string message)

Realm/Realm.Fody/Realm.Fody.csproj

@@ -11,7 +11,7 @@
     <CodeAnalysisRuleSet>$(ProjectDir)..\..\global.ruleset</CodeAnalysisRuleSet>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <NoWarn>$(NoWarn),1591, NU5100, NU5128</NoWarn>
-    <LangVersion>8.0</LangVersion>
+    <LangVersion>9.0</LangVersion>
     <IncludeSymbols>False</IncludeSymbols>
   </PropertyGroup>
   <ItemGroup Label="References">

Realm/Realm.UnityWeaver/Realm.UnityWeaver.csproj

@@ -6,9 +6,9 @@
     <Title>Realm.UnityWeaver</Title>
     <ReleaseNotes>https://docs.mongodb.com/realm-sdks/dotnet/latest/CHANGELOG.html</ReleaseNotes>
     <CodeAnalysisRuleSet>$(ProjectDir)..\..\global.ruleset</CodeAnalysisRuleSet>
+    <LangVersion>9.0</LangVersion>
     <AssemblyName>Realm.UnityWeaver</AssemblyName>
     <NoWarn>1701;1702;NU1701</NoWarn>
-    <LangVersion>8.0</LangVersion>
   </PropertyGroup>
 
   <ItemGroup>