Merge pull request #300 from hassanhabib/users/glhays/documentation-s…

…upportbrokers-abstraction DOCUMENTATION: Support Brokers Abstraction v2.10.3
hassanhabib · Aug 9, 2024 · beccd6b · beccd6b
2 parents 37bcf27 + 25fa5bd
commit beccd6b
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 12 deletions.
diff --git a/1. Brokers/1. Brokers.md b/1. Brokers/1. Brokers.md
@@ -286,7 +286,7 @@ namespace OtripleS.Web.Api.Brokers.Storages
 }
 ```
 
-###### For IStorageBroker.Students.cs:
+#### For IStorageBroker.Students.cs:
 ```csharp
 using system;
 using system.Linq;
@@ -297,16 +297,16 @@ namespace OtripleS.Web.Api.Brokers.Storages
 {
     public partial interface IStorageBroker
     {
-        public ValueTask<Student> InsertStudentAsync(Student student);
-        public ValueTask<IQueryable<Student>> SelectAllStudentsAsync();
-        public ValueTask<Student> SelectStudentByIdAsync(Guid studentId);
-        public ValueTask<Student> UpdateStudentAsync(Student student);
-        public ValueTask<Student> DeleteStudentAsync(Student student);
+        ValueTask<Student> InsertStudentAsync(Student student);
+        ValueTask<IQueryable<Student>> SelectAllStudentsAsync();
+        ValueTask<Student> SelectStudentByIdAsync(Guid studentId);
+        ValueTask<Student> UpdateStudentAsync(Student student);
+        ValueTask<Student> DeleteStudentAsync(Student student);
     }
 }
 ``` 
 
-###### For StorageBroker.Students.cs:
+#### For StorageBroker.Students.cs:
 ```csharp
 using System;
 using System.Linq;
@@ -338,6 +338,67 @@ namespace OtripleS.Web.Api.Brokers.Storages
 }
 ```
 
+### Support Brokers:
+
+#### For IDateTimeBroker.cs:
+```csharp
+public interface IDateTimeBroker
+	{
+		ValueTask<DateTimeOffset> GetCurrentDateTimeOffsetAsync();
+	}
+```
+
+#### For DateTimeBroker.cs:
+```csharp
+public class DateTimeBroker : IDateTimeBroker
+    {
+        public async ValueTask<DateTimeOffset> GetCurrentDateTimeOffsetAsync() =>
+            DateTimeOffset.UtcNow;
+    }
+```
+
+#### For ILoggingBroker.cs:
+```csharp
+public interface ILoggingBroker
+	{
+		ValueTask LogInformationAsync(string message);
+        ValueTask LogTraceAsync(string message);
+        ValueTask LogDebugAsync(string message);
+        ValueTask LogWarningAsync(string message);
+        ValueTask LogErrorAsync(Exception exception);
+		ValueTask LogCriticalAsync(Exception exception);
+	}
+```
+
+#### For LoggingBroker.cs:
+```csharp
+public class LoggingBroker : ILoggingBroker
+	{
+		private readonly ILogger<LoggingBroker> logger;
+
+		public LoggingBroker(ILogger<LoggingBroker> logger) =>
+			this.logger = logger;
+
+		public async ValueTask LogInformationAsync(string message) =>
+            this.logger.LogInformation(message);
+
+		public async ValueTask LogTraceAsync(string message) =>
+			this.logger.LogTrace(message);
+
+		public async ValueTask LogDebugAsync(string message) =>
+			this.logger.LogDebug(message);
+
+		public async ValueTask LogWarningAsync(string message) =>
+			this.logger.LogWarning(message);
+
+		public async ValueTask LogErrorAsync(Exception exception) =>
+			this.logger.LogError(exception.Message, exception);
+
+		public async ValueTask LogCriticalAsync(Exception exception) =>
+			this.logger.LogCritical(exception, exception.Message);
+	}
+```
+
 ## 1.6 Summary
 Brokers are the first layer of abstraction between your business logic and the outside world. But they are not the only layer of abstraction because a few native models will still leak through your brokers to your broker-neighboring services. It is natural to avoid doing any mappings outside the realm of logic, in our case, the foundation services.
 

diff --git a/2. Services/2.1 Foundations/2.1 Foundations.md b/2. Services/2.1 Foundations/2.1 Foundations.md
@@ -601,7 +601,7 @@ private StudentValidationException CreateAndLogValidationException(Xeption excep
         message: "Student validation error occurred, please check your input and try again.",
         innerException: exception);
 
-    this.loggingBroker.LogError(studentValidationException);
+    this.loggingBroker.LogErrorAsync(studentValidationException);
 
     return studentValidationException;
 }
@@ -700,7 +700,7 @@ private StudentValidationException CreateAndLogValidationException(Xeption excep
         message: "Student validation error occurred, please check your input and try again.",
         innerException: exception);
 
-    this.loggingBroker.LogError(studentValidationException);
+    this.loggingBroker.LogErrorAsync(studentValidationException);
 
     return studentValidationException;
 }
@@ -963,7 +963,7 @@ private StudentValidationException CreateAndLogValidationException(Xeption excep
         message: "Invalid input, contact support.",
         innerException: exception);
 
-    this.loggingBroker.LogError(studentValidationException);
+    this.loggingBroker.LogErrorAsync(studentValidationException);
 
     return studentValidationException;
 }
@@ -1142,7 +1142,7 @@ private StudentDependencyValidationException CreateAndLogDependencyValidationExc
             message: "Student dependency validation error occurred, please try again.",
             innerException: exception);
 
-    this.loggingBroker.LogError(studentDependencyValidationException);
+    this.loggingBroker.LogErrorAsync(studentDependencyValidationException);
 
     return studentDependencyValidationException;
 }

diff --git a/2. Services/2.3 Orchestrations/2.3 Orchestrations.md b/2. Services/2.3 Orchestrations/2.3 Orchestrations.md
@@ -743,7 +743,7 @@ public partial class StudentOrchestrationService
                 message: "Student dependency validation error occurred, fix errors and try again",
                 exception.innerException as Xeption);
 
-        this.loggingBroker.LogError(studentOrchestrationDependencyValidationException);
+        this.loggingBroker.LogErrorAsync(studentOrchestrationDependencyValidationException);
 
         return studentOrchestrationDependencyValidationException;
     }