Add platform-specific helpers package

.github/templates/build-packages.yml

@@ -1,5 +1,5 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "fetchWrapperBinaries", "msBuildMultiple", "readVersionFromPackage", "uploadArtifacts", "actionCache", "nugetPackages", "setupDotnet")
+#@ load("common.lib.yml", "checkoutCode", "fetchWrapperBinaries", "msBuildMultiple", "readVersionFromPackage", "uploadArtifacts", "actionCache", "nugetPackages", "setupDotnet", "setupWorkloads", "setupAndroid")
 
 #@ def buildDocs():
   - name: Check Docfx cache
@@ -66,6 +66,8 @@ jobs:
     timeout-minutes: 30
     steps:
       - #@ template.replace(checkoutCode())
+      - #@ template.replace(setupAndroid())
+      - #@ setupWorkloads('tvos ios maccatalyst android')
       - name: Set version suffix
         id: set-version-suffix
         #! Build suffix is pr-1234.5 for pr builds or alpha.123 for branch builds.

.github/templates/build-unity.yml

@@ -1,6 +1,5 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "uploadArtifacts", "nugetPackages", "actionDownloadArtifact")
-#@ load("test.lib.yml", "fetchPackageArtifacts")
+#@ load("common.lib.yml", "checkoutCode", "uploadArtifacts", "nugetPackages", "actionDownloadArtifact", "fetchPackageArtifacts")
 
 #@ unityPkgName = "io.realm.unity-${{ inputs.version }}.tgz"
 

.github/templates/codeql.yml

@@ -1,5 +1,5 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "configuration", "nugetPackages", "checkoutCode", "actionCodeQLInit", "actionCodeQLAnalyze", "actionSetupMSBuild")
+#@ load("common.lib.yml", "configuration", "nugetPackages", "checkoutCode", "actionCodeQLInit", "actionCodeQLAnalyze", "actionSetupMSBuild", "setupAndroid", "setupWorkloads")
 
 #@ def runCodeQL(language, buildSteps = []):
   - name: Initialize CodeQL
@@ -20,6 +20,8 @@
 #@ end
 
 #@ def buildPackages():
+  - #@ template.replace(setupAndroid())
+  - #@ setupWorkloads('tvos ios maccatalyst android')
   - name: Add msbuild to PATH
     uses: #@ actionSetupMSBuild
 #@ for pkgName in nugetPackages:
@@ -45,6 +47,9 @@ name: "CodeQL"
       - '.github/workflows/codeql.yml'
 env:
   REALM_DISABLE_ANALYTICS: true
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 jobs:
   analyze-csharp:
     name: Analyze C#

.github/templates/common.lib.yml

@@ -1,7 +1,8 @@
 #@ load("@ytt:template", "template")
 
 #@ configuration = "Release"
-#@ nugetPackages = [ 'Realm', 'Realm.UnityUtils', 'Realm.UnityWeaver' ]
+#@ publishedPackages = [ 'Realm.PlatformHelpers', 'Realm' ]
+#@ nugetPackages = publishedPackages + [ 'Realm.UnityUtils', 'Realm.UnityWeaver' ]
 #@ actionCheckout = "actions/checkout@v3"
 #@ actionCache = "nirinchev/cache@29e8e4dd9148ea81f9e188480132072cb6cc92d8"
 #@ actionUploadArtifact = "actions/upload-artifact@v3"
@@ -15,6 +16,7 @@
 #@ actionAWSConfigureCredentials = "aws-actions/configure-aws-credentials@v1-node16"
 #@ actionReleaseToSlack = "realm/ci-actions/release-to-slack@729a80d203351eab7df4eca564daa275e76ec52f"
 #@ actionSetupXcode = "maxim-lobanov/setup-xcode@9a697e2b393340c3cacd97468baa318e4c883d98"
+#@ actionSetupAndroid = "android-actions/setup-android@7c5672355aaa8fde5f97a91aa9a99616d1ace6bc"
 
 #@ androidABIs = [ 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64' ]
 #@ windowsArchs = [ 'Win32', 'x64', 'ARM64' ]
@@ -132,7 +134,7 @@ with:
   - name: Install sleet
     run: dotnet tool install -g sleet
   - #@ template.replace(configureAWSCredentials("NUGET_S3_ACCESS_KEY", "NUGET_S3_SECRET_KEY"))
-#@ for pkg in [ "Realm" ]:
+#@ for pkg in publishedPackages:
 #@ pkg = pkg + ".${{ " + versionExpression + " }}"
 #@ pkgPath = "" if expectShortPath else pkg + "/"
   - name: #@ "NuGet Publish " + pkg
@@ -215,4 +217,32 @@ with:
     run: #@ "npm publish ${{ github.workspace }}/Realm/packages/" + pkgPath + package + " --tag " + tag
     env:
       NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-#@ end
+#@ end
+---
+#@ def fetchPackageArtifacts(versionExpression = "inputs.version", packages = publishedPackages):
+#@ for pkg in packages:
+  - name: #@ "Fetch " + pkg
+    uses: #@ actionDownloadArtifact
+    with:
+      name: #@ pkg + ".${{ " + versionExpression + " }}"
+      path: ${{ github.workspace }}/Realm/packages/
+#@ end
+#@ end
+---
+#@ def setupWorkloads(workloads = 'maui'):
+name: Setup workloads
+run: #@ "dotnet workload install " + workloads
+#@ end
+---
+#@ def restoreWorkloads(workingDirectory = 'Realm/Realm.PlatformHelpers'):
+name: Restore workloads
+run: dotnet workload restore
+working-directory: #@ "${{ github.workspace }}/" + workingDirectory
+#@ end
+---
+#@ def setupAndroid():
+  - name: Setup Android
+    uses: #@ actionSetupAndroid
+  - name: Install SDK platform 21
+    run: sdkmanager --install "platforms;android-21"
+#@ end

.github/templates/main.yml

@@ -1,17 +1,8 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "uploadArtifacts", "uploadPackagesToSleet", "cleanupWorkspace", "dotnetPublish", "actionDownloadArtifact")
+#@ load("common.lib.yml", "checkoutCode", "uploadArtifacts", "uploadPackagesToSleet", "cleanupWorkspace", "dotnetPublish", "actionDownloadArtifact", "fetchPackageArtifacts")
 #@ load("test.lib.yml", "dotnetBuildTests")
 #@ load("build.lib.yml", "deployBaas", "cleanupBaas", "runTests", "runNetCoreTests", "ignoreSkippedJobsCondition", "buildUnity")
 
-#@ def fetchPackageArtifacts():
-#@ for pkg in [ "Realm" ]:
-  - name: #@ "Fetch " + pkg
-    uses: #@ actionDownloadArtifact
-    with:
-      name: #@ pkg + ".${{ needs.build-packages.outputs.package_version }}"
-      path: ${{ github.workspace }}/Realm/packages/
-#@ end
-#@ end
 ---
 name: main
 "on":
@@ -49,7 +40,7 @@ jobs:
     if: #@ ignoreSkippedJobsCondition + " && (github.event_name == 'push' || github.event.inputs.publish-prerelease)"
     steps:
     - #@ template.replace(checkoutCode(False, False))
-    - #@ template.replace(fetchPackageArtifacts())
+    - #@ template.replace(fetchPackageArtifacts("needs.build-packages.outputs.package_version"))
     - #@ template.replace(uploadPackagesToSleet("needs.build-packages.outputs.package_version", True))
   _: #@ template.replace(buildUnity())
   _: #@ template.replace(runTests(".NET Framework"))
@@ -68,7 +59,7 @@ jobs:
     if: #@ ignoreSkippedJobsCondition
     steps:
       - #@ template.replace(checkoutCode())
-      - #@ template.replace(fetchPackageArtifacts())
+      - #@ template.replace(fetchPackageArtifacts("needs.build-packages.outputs.package_version"))
       - #@ template.replace(dotnetPublish("Tests/Tests.XUnit", "net6.0", "win-x64", { "RestoreConfigFile": "Tests/Test.NuGet.Config", "UseRealmNupkgsWithVersion": "${{ needs.build-packages.outputs.package_version }}" }))
       - name: Run Tests
         run: dotnet test ${{ steps.dotnet-publish.outputs.executable-path }}/Tests.XUnit.dll --logger GitHubActions
@@ -85,7 +76,7 @@ jobs:
     steps:
       - #@ template.replace(cleanupWorkspace())
       - #@ template.replace(checkoutCode())
-      - #@ template.replace(fetchPackageArtifacts())
+      - #@ template.replace(fetchPackageArtifacts("needs.build-packages.outputs.package_version"))
       - #@ template.replace(dotnetBuildTests("Tests/Benchmarks/PerformanceTests", "net6.0", "linux-x64", "needs.build-packages.outputs.package_version"))
       - name: Run the tests
         run: #@ "${{ steps.dotnet-publish.outputs.executable-path }}/PerformanceTests -f \"*\" --join"

.github/templates/publish-release.yml

@@ -94,6 +94,7 @@ jobs:
     - #@ template.replace(downloadAllArtifacts())
     - #@ template.replace(readVersionFromPackage())
     - #@ template.replace(uploadDocsToS3())
+    - #@ template.replace(uploadToNuget("Realm.PlatformHelpers"))
     - #@ template.replace(uploadToNuget("Realm"))
     - #@ template.replace(uploadToNpm())
     - #@ template.replace(mergeReleasePR())

.github/templates/test-android.yml

@@ -1,6 +1,6 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "configureAWSCredentials")
-#@ load("test.lib.yml", "fetchPackageArtifacts", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
+#@ load("common.lib.yml", "checkoutCode", "configureAWSCredentials", "fetchPackageArtifacts", "setupWorkloads")
+#@ load("test.lib.yml", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
 
 ---
 name: test-android
@@ -32,9 +32,7 @@ jobs:
     steps:
       - #@ template.replace(checkoutCode())
       - #@ template.replace(fetchPackageArtifacts())
-      - name: Setup workloads
-        run: |
-          dotnet workload install maui
+      - #@ setupWorkloads()
       - name: Build the tests
         run: #@ "dotnet publish Tests/Tests.Maui -c Release -f net6.0-android -p:RestoreConfigFile=Tests/Test.NuGet.Config -p:UseRealmNupkgsWithVersion=${{ inputs.version }}"
       - #@ template.replace(configureAWSCredentials("AWS_DEVICEFARM_ACCESS_KEY_ID", "AWS_DEVICEFARM_SECRET_ACCESS_KEY", "us-west-2"))

.github/templates/test-ios.yml

@@ -1,6 +1,6 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "configuration", "actionRuniOSSimulator")
-#@ load("test.lib.yml", "fetchPackageArtifacts", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
+#@ load("common.lib.yml", "checkoutCode", "configuration", "actionRuniOSSimulator", "fetchPackageArtifacts", "setupWorkloads")
+#@ load("test.lib.yml", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
 
 ---
 name: test-ios
@@ -34,9 +34,7 @@ jobs:
         run: |
           sudo xcode-select -s "/Applications/Xcode_14.3.app"
           echo "MD_APPLE_SDK_ROOT=/Applications/Xcode_14.3.app" >> $GITHUB_ENV
-      - name: Setup workloads
-        run: |
-          dotnet workload install maui
+      - #@ setupWorkloads()
       - name: Build the tests
         run: #@ "dotnet build Tests/Tests.Maui -c " + configuration + " -f net6.0-ios -p:RestoreConfigFile=Tests/Test.NuGet.Config -p:UseRealmNupkgsWithVersion=${{ inputs.version }}"
       - name: Run the tests

.github/templates/test-macos.yml

@@ -1,6 +1,6 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "configuration")
-#@ load("test.lib.yml", "fetchPackageArtifacts", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
+#@ load("common.lib.yml", "checkoutCode", "configuration", "fetchPackageArtifacts", "setupWorkloads")
+#@ load("test.lib.yml", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
 
 ---
 name: test-macos
@@ -23,9 +23,7 @@ jobs:
     steps:
       - #@ template.replace(checkoutCode())
       - #@ template.replace(fetchPackageArtifacts())
-      - name: Setup workloads
-        run: |
-          dotnet workload install maui
+      - #@ setupWorkloads()
       - name: Build the tests
         run: #@ "dotnet build Tests/Tests.Maui -c " + configuration + " -f net6.0-maccatalyst -p:RestoreConfigFile=Tests/Test.NuGet.Config -p:UseRealmNupkgsWithVersion=${{ inputs.version }}"
       - name: Run the tests

.github/templates/test-source-generation.yml

@@ -1,5 +1,5 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode", "dotnetPublish")
+#@ load("common.lib.yml", "checkoutCode", "dotnetPublish", "setupWorkloads")
 #@ load("test.lib.yml", "publishTestsResults")
 
 ---
@@ -13,6 +13,7 @@ jobs:
     timeout-minutes: 45
     steps:
       - #@ template.replace(checkoutCode())
+      - #@ setupWorkloads('tvos ios maccatalyst android')
       - #@ template.replace(dotnetPublish("Tests/SourceGenerators/Realm.SourceGenerator.Tests", "net6.0", "win-x64"))
       - name: Run the tests
         run: #@ "${{ steps.dotnet-publish.outputs.executable-path }}/Realm.SourceGenerator.Tests --result=TestResults.SourceGeneration.xml"

.github/templates/test-tvos.yml

@@ -1,6 +1,6 @@
 #@ load("@ytt:template", "template")
 #@ load("common.lib.yml", "checkoutCode", "configuration", "actionRuniOSSimulator")
-#@ load("test.lib.yml", "fetchPackageArtifacts", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
+#@ load("test.lib.yml", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "prepareTest")
 
 ---
 name: test-tvos

.github/templates/test-woven-classes.yml

@@ -1,6 +1,6 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "checkoutCode")
-#@ load("test.lib.yml", "fetchPackageArtifacts", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "wovenClassesBuildTests")
+#@ load("common.lib.yml", "checkoutCode", "fetchPackageArtifacts")
+#@ load("test.lib.yml", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "wovenClassesBuildTests")
 
 ---
 name: test-woven-classes

.github/templates/test.lib.yml

@@ -1,15 +1,5 @@
 #@ load("@ytt:template", "template")
-#@ load("common.lib.yml", "actionDownloadArtifact", "msbuild", "dotnetPublish", "fetchWrapperBinaries", "checkoutCode")
-
-#@ def fetchPackageArtifacts(versionExpression = "inputs.version", packages = [ "Realm" ]):
-#@ for pkg in packages:
-  - name: #@ "Fetch " + pkg
-    uses: #@ actionDownloadArtifact
-    with:
-      name: #@ pkg + ".${{ " + versionExpression + " }}"
-      path: ${{ github.workspace }}/Realm/packages/
-#@ end
-#@ end
+#@ load("common.lib.yml", "actionDownloadArtifact", "msbuild", "dotnetPublish", "fetchWrapperBinaries", "checkoutCode", "fetchPackageArtifacts")
 
 #@ def baasTestArgs(differentiator):
 #@   return " --baasurl=${{ inputs.realmUrl }} --baascluster=${{ inputs.clusterName }} --baasapikey=${{ secrets.AtlasPublicKey}} --baasprivateapikey=${{ secrets.AtlasPrivateKey}} --baasprojectid=${{ secrets.AtlasProjectId }} --baasdifferentiator=" + differentiator

.github/workflows/build-packages.yml

@@ -29,6 +29,12 @@ jobs:
       run: echo "::add-matcher::.github/problem-matchers/csc.json"
     - name: Register msvc problem matcher
       run: echo "::add-matcher::.github/problem-matchers/msvc.json"
+    - name: Setup Android
+      uses: android-actions/setup-android@7c5672355aaa8fde5f97a91aa9a99616d1ace6bc
+    - name: Install SDK platform 21
+      run: sdkmanager --install "platforms;android-21"
+    - name: Setup workloads
+      run: dotnet workload install tvos ios maccatalyst android
     - name: Set version suffix
       id: set-version-suffix
       run: |
@@ -148,6 +154,8 @@ jobs:
     - name: Add msbuild to PATH
       uses: microsoft/setup-msbuild@0b44c6745b7e81956596964100aadb92d667c497
       if: ${{ runner.os == 'Windows' }}
+    - name: Build Realm/Realm.PlatformHelpers
+      run: msbuild Realm/Realm.PlatformHelpers -t:Pack -p:Configuration=Release -restore -p:PackageOutputPath=${{ github.workspace }}/Realm/packages -p:VersionSuffix=${{ steps.set-version-suffix.outputs.build_suffix }}
     - name: Build Realm/Realm
       run: msbuild Realm/Realm -t:Pack -p:Configuration=Release -restore -p:PackageOutputPath=${{ github.workspace }}/Realm/packages -p:VersionSuffix=${{ steps.set-version-suffix.outputs.build_suffix }}
     - name: Build Realm/Realm.UnityUtils
@@ -161,6 +169,13 @@ jobs:
         pkgVersion=$(find . -type f -regex ".*Realm.[1-9].*.nupkg" -exec basename {} \; | sed -n 's/Realm\.\(.*\)\.nupkg$/\1/p')
         echo "version=$pkgVersion" >> $GITHUB_OUTPUT
       shell: bash
+    - name: Store artifacts for Realm.PlatformHelpers.${{ steps.get-version.outputs.version }}
+      uses: actions/upload-artifact@v3
+      with:
+        name: Realm.PlatformHelpers.${{ steps.get-version.outputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/Realm.PlatformHelpers.${{ steps.get-version.outputs.version }}.*nupkg
+        retention-days: ${{ github.event_name != 'pull_request' && 30 || 1 }}
+        if-no-files-found: error
     - name: Store artifacts for Realm.${{ steps.get-version.outputs.version }}
       uses: actions/upload-artifact@v3
       with:

.github/workflows/build-unity.yml

@@ -23,6 +23,11 @@ jobs:
       run: echo "::add-matcher::.github/problem-matchers/csc.json"
     - name: Register msvc problem matcher
       run: echo "::add-matcher::.github/problem-matchers/msvc.json"
+    - name: Fetch Realm.PlatformHelpers
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.PlatformHelpers.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Fetch Realm
       uses: actions/download-artifact@v3
       with:

.github/workflows/codeql.yml

@@ -14,6 +14,9 @@ name: CodeQL
     - .github/workflows/codeql.yml
 env:
   REALM_DISABLE_ANALYTICS: true
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 jobs:
   analyze-csharp:
     name: Analyze C#
@@ -38,8 +41,16 @@ jobs:
           query-filters:
             - exclude: cs/call-to-unmanaged-code
             - exclude: cs/unmanaged-code
+    - name: Setup Android
+      uses: android-actions/setup-android@7c5672355aaa8fde5f97a91aa9a99616d1ace6bc
+    - name: Install SDK platform 21
+      run: sdkmanager --install "platforms;android-21"
+    - name: Setup workloads
+      run: dotnet workload install tvos ios maccatalyst android
     - name: Add msbuild to PATH
       uses: microsoft/setup-msbuild@0b44c6745b7e81956596964100aadb92d667c497
+    - name: Build Realm.PlatformHelpers
+      run: msbuild Realm/Realm.PlatformHelpers -p:UseSharedCompilation=false -restore -p:Configuration=Release
     - name: Build Realm
       run: msbuild Realm/Realm -p:UseSharedCompilation=false -restore -p:Configuration=Release
     - name: Build Realm.UnityUtils

.github/workflows/main.yml

@@ -47,6 +47,11 @@ jobs:
       with:
         submodules: false
         ref: ${{ github.event.pull_request.head.sha }}
+    - name: Fetch Realm.PlatformHelpers
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.PlatformHelpers.${{ needs.build-packages.outputs.package_version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Fetch Realm
       uses: actions/download-artifact@v3
       with:
@@ -64,6 +69,8 @@ jobs:
         aws-access-key-id: ${{ secrets.NUGET_S3_ACCESS_KEY }}
         aws-secret-access-key: ${{ secrets.NUGET_S3_SECRET_KEY }}
         aws-region: us-east-1
+    - name: NuGet Publish Realm.PlatformHelpers.${{ needs.build-packages.outputs.package_version }}
+      run: sleet push ${{ github.workspace }}/Realm/packages/Realm.PlatformHelpers.${{ needs.build-packages.outputs.package_version }}.nupkg --config ${{ github.workspace }}/.github/sleet.json --source NugetSource
     - name: NuGet Publish Realm.${{ needs.build-packages.outputs.package_version }}
       run: sleet push ${{ github.workspace }}/Realm/packages/Realm.${{ needs.build-packages.outputs.package_version }}.nupkg --config ${{ github.workspace }}/.github/sleet.json --source NugetSource
   build-unity:
@@ -195,6 +202,11 @@ jobs:
       run: echo "::add-matcher::.github/problem-matchers/csc.json"
     - name: Register msvc problem matcher
       run: echo "::add-matcher::.github/problem-matchers/msvc.json"
+    - name: Fetch Realm.PlatformHelpers
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.PlatformHelpers.${{ needs.build-packages.outputs.package_version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Fetch Realm
       uses: actions/download-artifact@v3
       with:
@@ -245,6 +257,11 @@ jobs:
       run: echo "::add-matcher::.github/problem-matchers/csc.json"
     - name: Register msvc problem matcher
       run: echo "::add-matcher::.github/problem-matchers/msvc.json"
+    - name: Fetch Realm.PlatformHelpers
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.PlatformHelpers.${{ needs.build-packages.outputs.package_version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Fetch Realm
       uses: actions/download-artifact@v3
       with: