change: Update Target Frameworks and Dependancies (#390)

* chore: Bump supported .NET versions to `net462` and `net6.0`+ (#377) * Add net6.0 to targeted frameworks * Add net6.0 to CI * fix: update target frameworks for integration tests ans snippets * Refactor build process and test multiple frameworks * Refactor build process and test multiple frameworks * fix script call * Refactor and update nightly and release workflows * Trigger Integration Tests * fix running unit tests in release stage * fix build before running integration tests * fix: revert to expected build name * try only 3.1 * try no specific version * fix set `Microsoft.NET.Test.Sdk` to 15.0.0 * Add Microsoft.TestPlatform.ObjectModel package for net462 * fix: Update xunit Packages and remove Microsoft.TestPlatform.ObjectModel package for net462 * Fix: tests * fix: added preprocessor directives to handle differences in tests between .net versions * Add netcoreapp3.1, net7.0 and net8.0 * fix: Add conditional package references and tests for netcoreapp3.1 * fix conditional test * Update workflows * fix: build before running integration tests * Removed netcoreap3.1 and redundant net7 and net8 * (chore): Upgrade Dependancies (#385) * [chore] Update Github action workflows to fix node version and `set-output` deprecation warnings (#376) * Add `README.md` to Nuget and update `CONTRIBUTING.md` (#389) * Trigger Integration tests * fix: correct target framework from merge. * fix: remove previous deprecation note
firebase · Apr 11, 2024 · 0664b5c · 0664b5c
1 parent bef3b4c
commit 0664b5c
Show file tree

Hide file tree

Showing 32 changed files with 198 additions and 165 deletions.
diff --git a/.github/scripts/publish_preflight_check.sh b/.github/scripts/publish_preflight_check.sh
@@ -70,7 +70,7 @@ if [[ ! "${RELEASE_VERSION}" =~ ^([0-9]*)\.([0-9]*)\.([0-9]*)$ ]]; then
 fi
 
 echo_info "Extracted release version: ${RELEASE_VERSION}"
-echo "::set-output name=version::v${RELEASE_VERSION}"
+echo "version=v${RELEASE_VERSION}" >> $GITHUB_OUTPUT
 
 
 echo_info ""
@@ -155,12 +155,13 @@ readonly CHANGELOG=`${CURRENT_DIR}/generate_changelog.sh`
 echo "$CHANGELOG"
 
 # Parse and preformat the text to handle multi-line output.
-# See https://github.community/t5/GitHub-Actions/set-output-Truncates-Multiline-Strings/td-p/37870
+# See https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#example-of-a-multiline-string
+# and https://github.com/github/docs/issues/21529#issue-1418590935
 FILTERED_CHANGELOG=`echo "$CHANGELOG" | grep -v "\\[INFO\\]"` || true
-FILTERED_CHANGELOG="${FILTERED_CHANGELOG//'%'/'%25'}"
-FILTERED_CHANGELOG="${FILTERED_CHANGELOG//$'\n'/'%0A'}"
-FILTERED_CHANGELOG="${FILTERED_CHANGELOG//$'\r'/'%0D'}"
-echo "::set-output name=changelog::${FILTERED_CHANGELOG}"
+FILTERED_CHANGELOG="${FILTERED_CHANGELOG//$'\''/'"'}"
+echo "changelog<<CHANGELOGEOF" >> $GITHUB_OUTPUT
+echo -e "$FILTERED_CHANGELOG" >> $GITHUB_OUTPUT
+echo "CHANGELOGEOF" >> $GITHUB_OUTPUT
 
 
 echo ""

diff --git a/.github/scripts/run_integration_tests.sh b/.github/scripts/run_integration_tests.sh
@@ -25,4 +25,5 @@ gpg --quiet --batch --yes --decrypt --passphrase="${FIREBASE_SERVICE_ACCT_KEY}"
 
 echo "${FIREBASE_API_KEY}" > FirebaseAdmin/FirebaseAdmin.IntegrationTests/resources/integration_apikey.txt
 
-dotnet test FirebaseAdmin/FirebaseAdmin.IntegrationTests
+dotnet test FirebaseAdmin/FirebaseAdmin.IntegrationTests --configuration Release --framework net462
+dotnet test FirebaseAdmin/FirebaseAdmin.IntegrationTests --configuration Release --framework net6.0
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,6 +7,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
+        framework-version: [net462, net6.0]
 
     env:
       DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
@@ -17,21 +18,20 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v1
+      uses: actions/checkout@v4
 
-    - name: Setup .NET Core 2.1
-      uses: actions/setup-dotnet@v1
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 2.1.x
+        dotnet-version: 6.0.x
 
     - name: Install dependencies
-      run: dotnet msbuild /t:restore FirebaseAdmin
+      run: dotnet restore FirebaseAdmin/FirebaseAdmin.sln
 
     - name: Build with dotnet
-      run: |
-        dotnet msbuild FirebaseAdmin/FirebaseAdmin
-        dotnet msbuild FirebaseAdmin/FirebaseAdmin.Snippets
-        dotnet msbuild FirebaseAdmin/FirebaseAdmin.IntegrationTests
+      run: dotnet build FirebaseAdmin/FirebaseAdmin.sln --configuration Release --no-restore
 
     - name: Run unit tests
-      run: dotnet test FirebaseAdmin/FirebaseAdmin.Tests
+      run: |
+        dotnet test FirebaseAdmin/FirebaseAdmin.Tests --configuration Release --no-restore --no-build --framework ${{ matrix.framework-version }}
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -28,29 +28,30 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
-      DOTNET_CLI_TELEMETRY_OPTOUT: 1
-      DOTNET_NOLOGO: 1
+      DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+      DOTNET_CLI_TELEMETRY_OPTOUT: true
+      DOTNET_NOLOGO: true
 
     steps:
     - name: Checkout source for staging
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.client_payload.ref || github.ref }}
 
-    - name: Setup .NET Core 2.1
-      uses: actions/setup-dotnet@v1
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 2.1.x
+        dotnet-version: 6.0.x
 
     - name: Install dependencies
-      run: dotnet msbuild /t:restore FirebaseAdmin
+      run: dotnet restore FirebaseAdmin/FirebaseAdmin.sln
 
     - name: Build with dotnet
-      run: dotnet msbuild FirebaseAdmin/FirebaseAdmin
+      run: dotnet build FirebaseAdmin/FirebaseAdmin.sln --configuration Release --no-restore
 
     - name: Run unit tests
-      run: dotnet test FirebaseAdmin/FirebaseAdmin.Tests
+      run: dotnet test FirebaseAdmin/FirebaseAdmin.Tests --configuration Release --no-restore --no-build
 
     - name: Run integration tests
       run: ./.github/scripts/run_integration_tests.sh
@@ -59,7 +60,8 @@ jobs:
         FIREBASE_API_KEY: ${{ secrets.FIREBASE_API_KEY }}
 
     - name: Package release artifacts
-      run: dotnet pack -c Release FirebaseAdmin/FirebaseAdmin
+      run: dotnet pack FirebaseAdmin/FirebaseAdmin.sln --configuration Release --no-restore --no-build
+
 
     # Attach the packaged artifacts to the workflow output. These can be manually
     # downloaded for later inspection if necessary.

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -46,23 +46,24 @@ jobs:
     # via the 'ref' client parameter.
     steps:
     - name: Checkout source for staging
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.client_payload.ref || github.ref }}
 
-    - name: Setup .NET Core 2.1
-      uses: actions/setup-dotnet@v1
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 2.1.x
+        dotnet-version: 6.0.x
 
     - name: Install dependencies
-      run: dotnet msbuild /t:restore FirebaseAdmin
+      run: dotnet restore FirebaseAdmin/FirebaseAdmin.sln
 
     - name: Build with dotnet
-      run: dotnet msbuild FirebaseAdmin/FirebaseAdmin
+      run: dotnet build FirebaseAdmin/FirebaseAdmin.sln --configuration Release --no-restore
 
     - name: Run unit tests
-      run: dotnet test FirebaseAdmin/FirebaseAdmin.Tests
+      run: dotnet test FirebaseAdmin/FirebaseAdmin.Tests --configuration Release --no-restore --no-build
 
     - name: Run integration tests
       run: ./.github/scripts/run_integration_tests.sh
@@ -71,7 +72,7 @@ jobs:
         FIREBASE_API_KEY: ${{ secrets.FIREBASE_API_KEY }}
 
     - name: Package release artifacts
-      run: dotnet pack -c Release FirebaseAdmin/FirebaseAdmin
+      run: dotnet pack FirebaseAdmin/FirebaseAdmin.sln --configuration Release --no-restore --no-build
 
     # Attach the packaged artifacts to the workflow output. These can be manually
     # downloaded for later inspection if necessary.
@@ -100,36 +101,31 @@ jobs:
 
     steps:
     - name: Checkout source for publish
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Download the artifacts created by the stage_release job.
     - name: Download release candidates
       uses: actions/download-artifact@v1
       with:
         name: Release
 
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 2.2.108
+        dotnet-version: 6.0.x
 
     - name: Publish preflight check
       id: preflight
       run: ./.github/scripts/publish_preflight_check.sh
 
-    # We pull this action from a custom fork of a contributor until
-    # https://github.com/actions/create-release/pull/32 is merged. Also note that v1 of
-    # this action does not support the "body" parameter.
+    # See: https://cli.github.com/manual/gh_release_create
     - name: Create release tag
-      uses: fleskesvor/create-release@1a72e235c178bf2ae6c51a8ae36febc24568c5fe
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        tag_name: ${{ steps.preflight.outputs.version }}
-        release_name: Firebase Admin .NET SDK ${{ steps.preflight.outputs.version }}
-        body: ${{ steps.preflight.outputs.changelog }}
-        draft: false
-        prerelease: false
+      run: gh release create ${{ steps.preflight.outputs.version }}
+            --title "Firebase Admin .NET SDK ${{ steps.preflight.outputs.version }}"
+            --notes '${{ steps.preflight.outputs.changelog }}'
 
     - name: Publish to Nuget
       run: ./.github/scripts/publish_package.sh

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -92,8 +92,9 @@ This section explains how to set up a development environment on Linux or Mac. W
 should be able to import the solution file (`FirebaseAdmin/FirebaseAdmin.sln`) into Visual
 Studio.
 
-Start by installing [.NET Core](https://www.microsoft.com/net/download) 2.1 or higher. This
-installs the `dotnet` command-line utility into the system.
+Start by installing [.NET](https://dotnet.microsoft.com/en-us/download) 6 or higher or
+[.NET Framework](https://dotnet.microsoft.com/en-us/download/dotnet-framework) 4.6.2 or
+higher. This installs the `dotnet` command-line utility into the system.
 
 Run the following commands from the command line to get your local environmentset up:
 

diff --git a/FirebaseAdmin/FirebaseAdmin.IntegrationTests/Auth/AbstractFirebaseAuthTest.cs b/FirebaseAdmin/FirebaseAdmin.IntegrationTests/Auth/AbstractFirebaseAuthTest.cs
@@ -17,10 +17,10 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
-using System.Web;
 using FirebaseAdmin.Auth;
 using FirebaseAdmin.Auth.Hash;
 using Google.Apis.Auth.OAuth2;
+using Microsoft.AspNetCore.WebUtilities;
 using Xunit;
 
 namespace FirebaseAdmin.IntegrationTests.Auth
@@ -93,7 +93,8 @@ public async Task CreateCustomTokenWithoutServiceAccount()
                     Credential = GoogleCredential.FromAccessToken(token),
                     ServiceAccountId = serviceAcct.Id,
                     ProjectId = serviceAcct.ProjectId,
-                }, "IAMSignApp");
+                },
+                "IAMSignApp");
 
             try
             {
@@ -603,7 +604,7 @@ public async Task EmailVerificationLink()
                 user.Email, EmailLinkSettings);
 
             var uri = new Uri(link);
-            var query = HttpUtility.ParseQueryString(uri.Query);
+            var query = QueryHelpers.ParseQuery(uri.Query);
             Assert.Equal(ContinueUrl, query["continueUrl"]);
             Assert.Equal("verifyEmail", query["mode"]);
         }
@@ -617,7 +618,7 @@ public async Task PasswordResetLink()
                 user.Email, EmailLinkSettings);
 
             var uri = new Uri(link);
-            var query = HttpUtility.ParseQueryString(uri.Query);
+            var query = QueryHelpers.ParseQuery(uri.Query);
             Assert.Equal(ContinueUrl, query["continueUrl"]);
 
             var request = new ResetPasswordRequest()
@@ -645,7 +646,7 @@ public async Task SignInWithEmailLink()
                 user.Email, EmailLinkSettings);
 
             var uri = new Uri(link);
-            var query = HttpUtility.ParseQueryString(uri.Query);
+            var query = QueryHelpers.ParseQuery(uri.Query);
             Assert.Equal(ContinueUrl, query["continueUrl"]);
 
             var idToken = await AuthIntegrationUtils.SignInWithEmailLinkAsync(

diff --git a/FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseAdmin.IntegrationTests.csproj b/FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseAdmin.IntegrationTests.csproj
@@ -1,26 +1,27 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp2.1</TargetFramework>
+    <TargetFrameworks>net462;net6.0</TargetFrameworks>
     <LangVersion>latest</LangVersion>
     <IsPackable>false</IsPackable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <CodeAnalysisRuleSet>../../stylecop_test.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
+    <PackageReference Include="Microsoft.AspNetCore.WebUtilities" Version="2.2.0" /> 
+    <PackageReference Include="System.Text.Json" Version="8.0.3" /> 
+    <PackageReference Include="xunit" Version="2.7.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.7">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.1-beta.61">
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
   </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\FirebaseAdmin\FirebaseAdmin.csproj" />
   </ItemGroup>

diff --git a/FirebaseAdmin/FirebaseAdmin.IntegrationTests/IntegrationTestUtils.cs b/FirebaseAdmin/FirebaseAdmin.IntegrationTests/IntegrationTestUtils.cs
@@ -30,7 +30,8 @@ internal static class IntegrationTestUtils
                     Credential = GoogleCredential.FromFile(ServiceAccountFile),
                 };
                 return FirebaseApp.Create(options);
-            }, true);
+            },
+            true);
 
         public static FirebaseApp EnsureDefaultApp()
         {

diff --git a/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAdmin.Snippets.csproj b/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAdmin.Snippets.csproj
@@ -1,21 +1,26 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp2.1</TargetFramework>
+    <TargetFrameworks>net462;net6.0</TargetFrameworks>
     <IsPackable>false</IsPackable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <CodeAnalysisRuleSet>../../stylecop_test.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Google.Apis.Auth" Version="1.49.0" />
+    <PackageReference Include="Google.Apis.Auth" Version="1.67.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
     <PackageReference Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="2.2.0" />
+    <PackageReference Include="System.Text.Json" Version="8.0.3" /> 
+    <PackageReference Include=" System.Security.Cryptography.Xml" Version="8.0.0" />
+    <PackageReference Include="System.Net.Http" Version="4.3.4" />
+    <PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\FirebaseAdmin\FirebaseAdmin.csproj" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.1-beta.61">
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
   </ItemGroup>

diff --git a/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs b/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs
@@ -14,6 +14,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 using FirebaseAdmin.Auth;
@@ -582,9 +583,10 @@ internal static async Task SetCustomUserClaimsIncrementalAsync()
             object isAdmin;
             if (user.CustomClaims.TryGetValue("admin", out isAdmin) && (bool)isAdmin)
             {
-                var claims = new Dictionary<string, object>(user.CustomClaims);
+                var claims = user.CustomClaims.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
                 // Add level.
-                claims["level"] = 10;
+                var level = 10;
+                claims["level"] = level;
                 // Add custom claims for additional privileges.
                 await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
             }