feat!: Prompt Request Result

Author: Soap-141

.editorconfig

@@ -0,0 +1,210 @@
+root = true
+
+#############################
+# Core EditorConfig Options #
+#############################
+
+[*]
+indent_style = tab
+end_of_line = crlf
+charset = utf-8-bom
+trim_trailing_whitespace = true
+
+# Code files
+[*.{cs,tt,xaml,xml,md,ps1}]
+indent_size = 4
+insert_final_newline = true
+
+# XML project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
+indent_size = 2
+
+# XML config files
+[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
+indent_size = 2
+
+# YML configuration files
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+# JSON files
+[*.json]
+indent_size = 2
+
+###########################
+# .NET Coding Conventions #
+###########################
+
+[*.cs]
+# Organize usings
+dotnet_sort_system_directives_first = true
+dotnet_separate_import_directive_groups = false
+
+# Avoid the this. keyword
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+
+# Use language keywords instead of framework type names for type references
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+# Suggest more modern language features when available
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
+dotnet_style_prefer_conditional_expression_over_return = true:suggestion
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:suggestion
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:suggestion
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
+dotnet_style_readonly_field = true:suggestion
+
+######################
+# Naming Conventions #
+######################
+
+# Style Definitions
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+# Constant fields are PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds = field
+dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+
+# Non-private readonly fields are PascalCase
+dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields
+dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = non_private_readonly_field_style
+dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
+dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected
+dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly
+dotnet_naming_style.non_private_readonly_field_style.capitalization = pascal_case
+
+# Non-private static fields are PascalCase
+dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
+dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
+dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
+dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected
+dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
+dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
+
+# Private static fields are camelCase
+dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion
+dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields
+dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style
+dotnet_naming_symbols.static_fields.applicable_kinds = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_style.static_field_style.capitalization = camel_case
+dotnet_naming_style.static_field_style.required_prefix = _
+
+# Instance fields are camelCase and start with _
+dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion
+dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
+dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style
+dotnet_naming_symbols.instance_fields.applicable_kinds = field
+dotnet_naming_style.instance_field_style.capitalization = camel_case
+dotnet_naming_style.instance_field_style.required_prefix = _
+
+# Locals and parameters are camelCase
+dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion
+dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
+dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style
+dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
+dotnet_naming_style.camel_case_style.capitalization = camel_case
+
+# Local functions are PascalCase
+dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
+dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style
+dotnet_naming_symbols.local_functions.applicable_kinds = local_function
+dotnet_naming_style.local_function_style.capitalization = pascal_case
+
+# By default, name items with PascalCase
+dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members
+dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style
+dotnet_naming_symbols.all_members.applicable_kinds = *
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+#######################
+# C# Code Style Rules #
+#######################
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = flush_left
+
+# Prefer "var" everywhere
+csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_when_type_is_apparent = true:suggestion
+csharp_style_var_elsewhere = true:suggestion
+
+# Prefer property-like constructs to have an expression-body
+csharp_style_expression_bodied_properties = true:suggestion
+csharp_style_expression_bodied_indexers = true:suggestion
+csharp_style_expression_bodied_accessors = true:suggestion
+csharp_style_expression_bodied_methods = false:none
+csharp_style_expression_bodied_constructors = false:none
+csharp_style_expression_bodied_operators = false:none
+
+# Newline preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+# Suggest more modern language features when available
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+
+# Blocks are allowed
+csharp_prefer_braces = true:suggestion
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+# CS1591: Missing XML comment for publicly visible type or member
+dotnet_diagnostic.CS1591.severity = suggestion

BREAKING_CHANGES.md

@@ -1,14 +1,17 @@
-# Breaking Changes
+# Breaking Changes
 
-<!-- Add a header (##) with the version and list the breaking changes.
+<!--
+Add a header (##) with the version and list the breaking changes.
 
 Example:
 
 ## 1.0.0
   - `Something` was removed.
   - `This` was renamed to `That`.
-     
 -->
 
+## 3.0.0
+  - The 'IReviewService.TryRequestReview' now returns a result.
+
 ## 2.0.0
   - Update .NET Target From 6 To 8.

README.md

@@ -1,4 +1,4 @@
-# Review Service
+# Review Service
 
 This repository introduces abstractions around native review capabilities to ease code sharing and testability.
 It also introduces business logic to quickly configure conditions and state tracking to prompt for reviews at the right moment.
@@ -55,7 +55,16 @@ Before getting started, please read the [Android](https://developer.android.com/
           // Do Meaningful Task.
 
           // Check if all conditions are satisfied and prompt for review if they are.
-          await _reviewService.TryRequestReview(ct);
+          var result = await _reviewService.TryRequestReview(ct);
+    
+          if (result.IsSuccessful)
+          {
+              // Review prompt was successfully shown
+          }
+          else
+          {
+              Console.WriteLine( $ "Review request status: {result.Status}.");
+          }
       }
       ```
 
@@ -154,7 +163,11 @@ var host = new HostBuilder()
 > 
 > 		public Task<bool> GetAreConditionsSatisfied(CancellationToken ct) => _reviewService.GetAreConditionsSatisfied(ct);
 > 
-> 		public Task TryRequestReview(CancellationToken ct) => _reviewService.TryRequestReview(ct);
+> 		public async Task<ReviewRequestResult> TryRequestReview(CancellationToken ct)
+> 		{
+> 			var status = await _reviewService.TryRequestReview(ct);
+> 			return new ReviewRequestResult(status);
+> 		} 
 > 
 > 		public Task UpdateReviewSettings(CancellationToken ct, Func<ReviewSettings, ReviewSettings> updateFunction) => _reviewService.UpdateReviewSettings(ct, updateFunction);
 > 	}
@@ -344,4 +357,4 @@ This project is licensed under the Apache 2.0 license - see the
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for
 contributing to this project.
 
-Be mindful of our [Code of Conduct](CODE_OF_CONDUCT.md).
+Be mindful of our [Code of Conduct](CODE_OF_CONDUCT.md).

src/ReviewService.Abstractions/IReviewPrompter.cs

@@ -18,6 +18,6 @@ public interface IReviewPrompter
 	/// <summary>
 	/// Prompts the user to rate the current application using the platform's default application store.
 	/// </summary>
-	/// <returns><see cref="Task"/>.</returns>
-	Task TryPrompt();
+	/// <returns>The review prompt status.</returns>
+	Task<ReviewPromptStatus> TryPrompt();
 }

src/ReviewService.Abstractions/IReviewService.cs

@@ -16,8 +16,8 @@ public interface IReviewService<TReviewSettings>
 	/// Checks if all review prompt conditions are satisfied and then prompt user to review the current application.
 	/// </summary>
 	/// <param name="ct"><see cref="CancellationToken"/>.</param>
-	/// <returns><see cref="Task"/>.</returns>
-	Task TryRequestReview(CancellationToken ct);
+	/// <returns>A <see cref="ReviewRequestResult"/> containing the status and success information.</returns>
+	Task<ReviewRequestResult> TryRequestReview(CancellationToken ct);
 
 	/// <summary>
 	/// Gets if all conditions are satisfied which means that we can prompt user to review the current application.
@@ -31,6 +31,5 @@ public interface IReviewService<TReviewSettings>
 	/// </summary>
 	/// <param name="ct"><see cref="CancellationToken"/>.</param>
 	/// <param name="updateFunction">Function that returns updated <typeparamref name="TReviewSettings"/>.</param>
-	/// <returns><see cref="Task"/>.</returns>
 	Task UpdateReviewSettings(CancellationToken ct, Func<TReviewSettings, TReviewSettings> updateFunction);
 }

src/ReviewService.Abstractions/ReviewPromptStatus.cs

@@ -0,0 +1,32 @@
+namespace ReviewService;
+
+/// <summary>
+/// The status of a review prompt attempt.
+/// </summary>
+public enum ReviewPromptStatus
+{
+	/// <summary>
+	/// The review prompt was successfully shown to the user, and the user has completed the review process.
+	/// </summary>
+	Success,
+
+	/// <summary>
+	/// The review prompt was shown to the user, but the user did not complete the review process.
+	/// </summary>
+	Canceled,
+
+	/// <summary>
+	/// The review prompt was attempted but failed, typically due to an exception or an error in the prompting process.
+	/// </summary>
+	Failed,
+
+	/// <summary>
+	/// The review prompt was not attempted because the conditions were not satisfied.
+	/// </summary>
+	NotAttempted,
+
+	/// <summary>
+	/// The review prompt status is unknown, typically used when the platform does not support prompting or the implementation is not available.
+	/// </summary>
+	Unknown,
+}

src/ReviewService.Abstractions/ReviewRequestResult.cs

@@ -0,0 +1,26 @@
+namespace ReviewService;
+
+/// <summary>
+/// Represents the result of a review request operation.
+/// </summary>
+public sealed class ReviewRequestResult
+{
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ReviewRequestResult"/> class.
+	/// </summary>
+	/// <param name="status">The status of the review request.</param>
+	public ReviewRequestResult(ReviewPromptStatus status)
+	{
+		Status = status;
+	}
+
+	/// <summary>
+	/// Gets the status of the review request.
+	/// </summary>
+	public ReviewPromptStatus Status { get; }
+
+	/// <summary>
+	/// Gets a value indicating whether the review request was successful.
+	/// </summary>
+	public bool IsSuccessful => Status is ReviewPromptStatus.Success;
+}

src/ReviewService.Abstractions/ReviewService.Abstractions.csproj

@@ -33,6 +33,6 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
 	</ItemGroup>
 </Project>

src/ReviewService.NativePrompters/ReviewPrompter.Android.cs

@@ -26,21 +26,21 @@ public ReviewPrompter(ILogger<ReviewPrompter>? logger)
 	}
 
 	/// <inheritdoc/>
-	public Task TryPrompt()
+	public Task<ReviewPromptStatus> TryPrompt()
 	{
-		var tcs = new TaskCompletionSource();
+		var tcs = new TaskCompletionSource<ReviewPromptStatus>();
 
 		_handler.Post(async () =>
 		{
 			try
 			{
 				_logger.LogDebug("Trying to prompt the user for a review.");
 
-				await CrossStoreReview.Current.RequestReview(false);
+				var reviewStatus = await CrossStoreReview.Current.RequestReview(false);
 
 				_logger.LogInformation("Prompted the user for a review.");
 
-				tcs.SetResult();
+				tcs.SetResult(reviewStatus.ToReviewPromptStatus());
 			}
 			catch (Exception e)
 			{