Add support to make AndroidForegroundService optional to MediaElement

.github/workflows/dotnet-build.yml

@@ -37,11 +37,13 @@ env:
     PathToCommunityToolkitCameraAnalyzersCsproj: 'src/CommunityToolkit.Maui.Camera.Analyzers/CommunityToolkit.Maui.Camera.Analyzers.csproj'
     PathToCommunityToolkitMediaElementAnalyzersCsproj: 'src/CommunityToolkit.Maui.MediaElement.Analyzers/CommunityToolkit.Maui.MediaElement.Analyzers.csproj'
     PathToCommunityToolkitSourceGeneratorsCsproj: 'src/CommunityToolkit.Maui.SourceGenerators/CommunityToolkit.Maui.SourceGenerators.csproj'
+    PathToCommunityToolkitMediaElementSourceGeneratorsCsproj: 'src/CommunityToolkit.Maui.MediaElement.SourceGenerators/CommunityToolkit.Maui.MediaElement.SourceGenerators.csproj'
     PathToCommunityToolkitAnalyzersCodeFixCsproj: 'src/CommunityToolkit.Maui.Analyzers.CodeFixes/CommunityToolkit.Maui.Analyzers.CodeFixes.csproj'
     PathToCommunityToolkitCameraAnalyzersCodeFixCsproj: 'src/CommunityToolkit.Maui.Camera.Analyzers.CodeFixes/CommunityToolkit.Maui.Camera.Analyzers.CodeFixes.csproj'
     PathToCommunityToolkitMediaElementAnalyzersCodeFixCsproj: 'src/CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes/CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes.csproj'
     PathToCommunityToolkitAnalyzersUnitTestProjectDirectory: 'src/CommunityToolkit.Maui.Analyzers.UnitTests'
     PathToCommunityToolkitSourceGeneratorsUnitTestDirectory: 'src/CommunityToolkit.Maui.SourceGenerators.UnitTests'
+    PathToCommunityToolkitMediaElementSourceGeneratorsUnitTestDirectory: 'src/CommunityToolkit.Maui.MediaElement.SourceGenerators.UnitTests'
     PathToCommunityToolkitSourceGeneratorsUnitTestCsproj: 'src/CommunityToolkit.Maui.SourceGenerators.UnitTests/CommunityToolkit.Maui.SourceGenerators.UnitTests.csproj'
     PathToCommunityToolkitAnalyzersBenchmarkCsproj: 'src/CommunityToolkit.Maui.Analyzers.Benchmarks/CommunityToolkit.Maui.Analyzers.Benchmarks.csproj'
     CommunityToolkitLibrary_Xcode_Version: '26.1'
@@ -189,6 +191,9 @@ jobs:
             -   name: 'Build CommunityToolkit.Maui.SourceGenerators'
                 run: dotnet build ${{ env.PathToCommunityToolkitSourceGeneratorsCsproj }} -c Release
 
+            -   name: 'Build CommunityToolkit.Maui.MediaElement.SourceGenerators'
+                run: dotnet build ${{ env.PathToCommunityToolkitMediaElementSourceGeneratorsCsproj }} -c Release
+
             -   name: 'Build CommunityToolkit.Maui.Camera'
                 run: dotnet build ${{ env.PathToCommunityToolkitCameraCsproj }} -c Release -p:PackageVersion=${{ env.NugetPackageVersionCamera }} -p:Version=${{ env.NugetPackageVersionCamera }}
 
@@ -215,6 +220,12 @@ jobs:
                     cd ${{ env.PathToCommunityToolkitSourceGeneratorsUnitTestDirectory }}
                     dotnet run -c Release --results-directory "${{ runner.temp }}" --coverage --coverage-output "${{ runner.temp }}/ut-sourcegenerators.cobertura.xml" --coverage-output-format cobertura --report-xunit
 
+            -   name: Run CommunityToolkit MediaElement Source Generators UnitTests
+                if: runner.os == 'Windows'
+                run: |
+                    cd ${{ env.PathToCommunityToolkitMediaElementSourceGeneratorsUnitTestDirectory }}
+                    dotnet run -c Release --results-directory "${{ runner.temp }}" --coverage --coverage-output "${{ runner.temp }}/ut-mediaelement-sourcegenerators.cobertura.xml" --coverage-output-format cobertura --report-xunit
+
             -   name: Run CommunityToolkit UnitTests
                 run: |
                     cd ${{ env.PathToCommunityToolkitUnitTestProjectDirectory }}

Directory.Build.props

@@ -241,6 +241,7 @@ https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitati
     <SupportedPlatform Include="Tizen" />
     <InternalsVisibleTo Include="CommunityToolkit.Maui.UnitTests"/>
     <InternalsVisibleTo Include="CommunityToolkit.Maui.Analyzers.UnitTests"/>
+    <InternalsVisibleTo Include="CommunityToolkit.Maui.MediaElement.SourceGenerators.UnitTests"/>
   </ItemGroup>
 
   <PropertyGroup Condition="('$(TF_BUILD)' == 'true' OR '$(GITHUB_ACTIONS)' == 'true') and $([MSBuild]::IsOSPlatform('windows')) == 'true'">

samples/CommunityToolkit.Maui.Sample.slnx

@@ -6,6 +6,7 @@
     <Project Path="../src/CommunityToolkit.Maui.Camera.Analyzers/CommunityToolkit.Maui.Camera.Analyzers.csproj" />
     <Project Path="../src/CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes/CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes.csproj" />
     <Project Path="../src/CommunityToolkit.Maui.MediaElement.Analyzers/CommunityToolkit.Maui.MediaElement.Analyzers.csproj" />
+    <Project Path="../src/CommunityToolkit.Maui.MediaElement.SourceGenerators/CommunityToolkit.Maui.MediaElement.SourceGenerators.csproj" />
     <Project Path="../src/CommunityToolkit.Maui.SourceGenerators/CommunityToolkit.Maui.SourceGenerators.csproj" />
   </Folder>
   <Folder Name="/Benchmarks/">
@@ -27,6 +28,7 @@
   </Folder>
   <Folder Name="/Tests/">
     <Project Path="../src/CommunityToolkit.Maui.Analyzers.UnitTests/CommunityToolkit.Maui.Analyzers.UnitTests.csproj" />
+    <Project Path="../src/CommunityToolkit.Maui.MediaElement.SourceGenerators.UnitTests/CommunityToolkit.Maui.MediaElement.SourceGenerators.UnitTests.csproj" />
     <Project Path="../src/CommunityToolkit.Maui.SourceGenerators.UnitTests/CommunityToolkit.Maui.SourceGenerators.UnitTests.csproj" />
     <Project Path="../src/CommunityToolkit.Maui.UnitTests/CommunityToolkit.Maui.UnitTests.csproj">
       <Deploy />

samples/CommunityToolkit.Maui.Sample/CommunityToolkit.Maui.Sample.csproj

@@ -73,9 +73,12 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\CommunityToolkit.Maui.MediaElement.SourceGenerators\CommunityToolkit.Maui.MediaElement.SourceGenerators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui.SourceGenerators\CommunityToolkit.Maui.SourceGenerators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui.Analyzers\CommunityToolkit.Maui.Analyzers.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui.Analyzers.CodeFixes\CommunityToolkit.Maui.Analyzers.CodeFixes.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+    <ProjectReference Include="..\..\src\CommunityToolkit.Maui.MediaElement.Analyzers\CommunityToolkit.Maui.MediaElement.Analyzers.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+    <ProjectReference Include="..\..\src\CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes\CommunityToolkit.Maui.MediaElement.Analyzers.CodeFixes.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui.MediaElement\CommunityToolkit.Maui.MediaElement.csproj" />
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui.Camera\CommunityToolkit.Maui.Camera.csproj" />
     <ProjectReference Include="..\..\src\CommunityToolkit.Maui\CommunityToolkit.Maui.csproj" />

samples/CommunityToolkit.Maui.Sample/MauiProgram.cs

@@ -68,7 +68,7 @@ public static MauiApp CreateMauiApp()
 #endif
 								.UseMauiCommunityToolkitMarkup()
 								.UseMauiCommunityToolkitCamera()
-								.UseMauiCommunityToolkitMediaElement(static options =>
+								.UseMauiCommunityToolkitMediaElement(isAndroidForegroundServiceEnabled: true, static options =>
 								{
 									options.SetDefaultAndroidViewType(AndroidViewType.TextureView);
 								})

samples/CommunityToolkit.Maui.Sample/Platforms/Android/AndroidManifest.xml

@@ -1,25 +1,25 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
     <application android:allowBackup="true" android:icon="@mipmap/appicon" android:enableOnBackInvokedCallback="true" android:hardwareAccelerated="true"
-                 android:supportsRtl="true">
-
-      <meta-data android:name="com.google.android.geo.API_KEY" android:value="PASTE-YOUR-API-KEY-HERE" />
-    </application>
-
-    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
-    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
-    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+               android:supportsRtl="true">
 
-    <!-- Samsung -->
-    <uses-permission android:name="com.sec.android.provider.badge.permission.READ"/>
-    <uses-permission android:name="com.sec.android.provider.badge.permission.WRITE"/>
-    <!-- /Samsung -->
+    <meta-data android:name="com.google.android.geo.API_KEY" android:value="PASTE-YOUR-API-KEY-HERE" />
+  </application>
+
+  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+
+  <!-- Samsung -->
+  <uses-permission android:name="com.sec.android.provider.badge.permission.READ"/>
+  <uses-permission android:name="com.sec.android.provider.badge.permission.WRITE"/>
+  <!-- /Samsung -->
 
-    <uses-permission android:name="android.permission.RECORD_AUDIO"/>
-    <uses-permission android:name="android.permission.CAMERA"/>
-    <queries>
-        <intent>
-            <action android:name="android.intent.action.TTS_SERVICE"/>
-        </intent>
-    </queries>
+  <uses-permission android:name="android.permission.RECORD_AUDIO"/>
+  <uses-permission android:name="android.permission.CAMERA"/>
+  <queries>
+    <intent>
+      <action android:name="android.intent.action.TTS_SERVICE"/>
+    </intent>
+  </queries>
 </manifest>

samples/CommunityToolkit.Maui.Sample/Platforms/Android/SamsungBadgeProvider.cs

@@ -13,7 +13,7 @@ class SamsungBadgeProvider : IBadgeProvider
 
 	public void SetCount(uint count)
 	{
-		var contentUri = Android.Net.Uri.Parse(contentStringUri);
+		var contentUri = global::Android.Net.Uri.Parse(contentStringUri);
 		if (contentUri is null)
 		{
 			return;

src/CommunityToolkit.Maui.Analyzers.Benchmarks/AndroidMediaElementServiceConfigurationAnalyzerBenchmarks.cs

@@ -0,0 +1,27 @@
+using BenchmarkDotNet.Attributes;
+using CommunityToolkit.Maui.MediaElement.SourceGenerators.UnitTests.AndroidMediaElementServiceConfigurationAnalyzerTests;
+
+namespace CommunityToolkit.Maui.Analyzers.Benchmarks;
+
+public class AndroidMediaElementServiceConfigurationAnalyzerBenchmarks
+{
+	static readonly AndroidMediaElementServiceConfigurationAnalyzer_CommonUsageTests androidMediaElementServiceConfigurationAnalyzer_CommonUsageTests = new();
+
+	[Benchmark]
+	public Task WhenNoMediaElementOptions_ReportsNoDiagnostic()
+	{
+		return androidMediaElementServiceConfigurationAnalyzer_CommonUsageTests.Analyzer_WhenNoMediaElementOptions_ReportsNoDiagnostic();
+	}
+
+	[Benchmark]
+	public Task WhenMethodInvokedWithTrue_ReportsDiagnostic()
+	{
+		return androidMediaElementServiceConfigurationAnalyzer_CommonUsageTests.Analyzer_WhenMethodInvokedWithTrue_ReportsDiagnostic();
+	}
+
+	[Benchmark]
+	public Task WhenMultiplePropertiesSetToTrue_ReportsSingleDiagnostic()
+	{
+		return androidMediaElementServiceConfigurationAnalyzer_CommonUsageTests.Analyzer_WhenMultiplePropertiesSetToTrue_ReportsSingleDiagnostic();
+	}
+}

src/CommunityToolkit.Maui.Analyzers.Benchmarks/Program.cs

@@ -11,5 +11,6 @@ public static void Main(string[] args)
 		BenchmarkRunner.Run<UseMauiCommunityToolkitAnalyzerBenchmarks>(config, args);
 		BenchmarkRunner.Run<UseMauiCommunityToolkitCameraAnalyzerBenchmarks>(config, args);
 		BenchmarkRunner.Run<UseMauiCommunityToolkitMediaElementInitializationAnalyzerBenchmarks>(config, args);
+		BenchmarkRunner.Run<AndroidMediaElementServiceConfigurationAnalyzerBenchmarks>(config, args);
 	}
 }

src/CommunityToolkit.Maui.Analyzers.UnitTests/AndroidMediaElementServiceConfigurationAnalyzerTests/AndroidMediaElementServiceConfigurationAnalyzer_CommonUsageTests.cs

@@ -0,0 +1,217 @@
+using CommunityToolkit.Maui.MediaElement.Analyzers;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.Testing;
+using Xunit;
+
+namespace CommunityToolkit.Maui.MediaElement.SourceGenerators.UnitTests.AndroidMediaElementServiceConfigurationAnalyzerTests;
+
+public class AndroidMediaElementServiceConfigurationAnalyzer_CommonUsageTests : BaseAndroidMediaElementServiceConfigurationAnalyzerTest
+{
+	[Fact]
+	public async Task Analyzer_WhenPropertySetToTrue_ReportsDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool {|#0:IsAndroidForegroundServiceEnabled|} { get; private set; } = true;
+			}
+			""";
+
+		var expectedDiagnostic = new DiagnosticResult(AndroidMediaElementServiceConfigurationAnalyzer.Rule)
+			.WithLocation(0)
+			.WithSeverity(DiagnosticSeverity.Error);
+
+		await VerifyAnalyzerAsync(source, expectedDiagnostic);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenMethodInvokedWithTrue_ReportsDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool IsAndroidForegroundServiceEnabled { get; private set; } = false;
+
+				public void SetIsAndroidForegroundServiceEnabled(bool isEnabled)
+				{
+					IsAndroidForegroundServiceEnabled = isEnabled;
+				}
+			}
+
+			public class TestConfiguration
+			{
+				public void Configure()
+				{
+					var options = new MediaElementOptions();
+					options.SetIsAndroidForegroundServiceEnabled({|#0:true|});
+				}
+			}
+			""";
+
+		var expectedDiagnostic = new DiagnosticResult(AndroidMediaElementServiceConfigurationAnalyzer.Rule)
+			.WithLocation(0)
+			.WithSeverity(DiagnosticSeverity.Error);
+
+		await VerifyAnalyzerAsync(source, expectedDiagnostic);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenPropertySetToFalse_ReportsNoDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool IsAndroidForegroundServiceEnabled { get; private set; } = false;
+			}
+			""";
+
+		await VerifyAnalyzerAsync(source);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenMethodInvokedWithFalse_ReportsNoDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool IsAndroidForegroundServiceEnabled { get; private set; } = false;
+
+				public void SetIsAndroidForegroundServiceEnabled(bool isEnabled)
+				{
+					IsAndroidForegroundServiceEnabled = isEnabled;
+				}
+			}
+
+			public class TestConfiguration
+			{
+				public void Configure()
+				{
+					var options = new MediaElementOptions();
+					options.SetIsAndroidForegroundServiceEnabled(false);
+				}
+			}
+			""";
+
+		await VerifyAnalyzerAsync(source);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenNoMediaElementOptions_ReportsNoDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using Microsoft.Maui.Controls;
+
+			namespace {{defaultTestNamespace}};
+
+			public class {{defaultTestClassName}} : View
+			{
+				public string Text { get; set; } = "";
+			}
+			""";
+
+		await VerifyAnalyzerAsync(source);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenPropertyHasNoInitializer_ReportsNoDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool IsAndroidForegroundServiceEnabled { get; private set; }
+			}
+			""";
+
+		await VerifyAnalyzerAsync(source);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenMethodInvokedWithVariable_ReportsNoDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool IsAndroidForegroundServiceEnabled { get; private set; } = false;
+
+				public void SetIsAndroidForegroundServiceEnabled(bool isEnabled)
+				{
+					IsAndroidForegroundServiceEnabled = isEnabled;
+				}
+			}
+
+			public class TestConfiguration
+			{
+				public void Configure()
+				{
+					var options = new MediaElementOptions();
+					bool enableService = true;
+					options.SetIsAndroidForegroundServiceEnabled(enableService);
+				}
+			}
+			""";
+
+		await VerifyAnalyzerAsync(source);
+	}
+
+	[Fact]
+	public async Task Analyzer_WhenMultiplePropertiesSetToTrue_ReportsSingleDiagnostic()
+	{
+		const string source =
+			/* language=C#-test */
+			$$"""
+			using CommunityToolkit.Maui.Core;
+
+			namespace {{defaultTestNamespace}};
+
+			public class MediaElementOptions
+			{
+				internal static bool {|#0:IsAndroidForegroundServiceEnabled|} { get; private set; } = true;
+				internal static bool AnotherProperty { get; private set; } = true;
+			}
+			""";
+
+		var expectedDiagnostic = new DiagnosticResult(AndroidMediaElementServiceConfigurationAnalyzer.Rule)
+			.WithLocation(0)
+			.WithSeverity(DiagnosticSeverity.Error);
+
+		await VerifyAnalyzerAsync(source, expectedDiagnostic);
+	}
+}