Company Communicator v4.1.2 (#445)

* handling null case for user type. * adding fallback incase userType is null * handling user type null and adding existing guest user count to messages * adding UTs * Fix warnings * moving to extension * localized strings * adding comment for usage of GetUserType * handle 502 status code from graph. * handle 502 bad gateway graph response Co-authored-by: Priyank Saxena <priyank.saxena@microsoft.com>
OfficeDev · Jun 25, 2021 · 207013d · 207013d
1 parent 3869bdc
commit 207013d
Show file tree

Hide file tree

Showing 38 changed files with 552 additions and 248 deletions.
diff --git a/Source/CompanyCommunicator.Common/Extensions/SendQueueMessageContentExtension.cs b/Source/CompanyCommunicator.Common/Extensions/SendQueueMessageContentExtension.cs
@@ -7,6 +7,7 @@ namespace Microsoft.Teams.Apps.CompanyCommunicator.Common.Extensions
 {
     using System;
     using Microsoft.Teams.Apps.CompanyCommunicator.Common.Services.MessageQueues.SendQueue;
+    using Microsoft.Teams.Apps.CompanyCommunicator.Common.Services.MicrosoftGraph;
 
     /// <summary>
     /// Extension class for <see cref="SendQueueMessageContent"/>.
@@ -44,5 +45,28 @@ public static string GetConversationId(this SendQueueMessageContent message)
                 _ => throw new ArgumentException("Invalid recipient type"),
             };
         }
+
+        /// <summary>
+        /// Check if recipient guest user.
+        /// </summary>
+        /// <param name="message">Send Queue message.</param>
+        /// <returns>Boolean indicating if it is a guest user.</returns>
+        public static bool IsRecipientGuestUser(this SendQueueMessageContent message)
+        {
+            var recipient = message.RecipientData;
+            if (recipient.RecipientType == RecipientDataType.User)
+            {
+                if (string.IsNullOrEmpty(recipient.UserData.UserType))
+                {
+                    throw new ArgumentNullException(nameof(recipient.UserData.UserType));
+                }
+                else if (recipient.UserData.UserType.Equals(UserType.Guest, StringComparison.OrdinalIgnoreCase))
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
     }
 }
diff --git a/Source/CompanyCommunicator.Common/Extensions/UserExtensions.cs b/Source/CompanyCommunicator.Common/Extensions/UserExtensions.cs
@@ -7,6 +7,7 @@ namespace Microsoft.Teams.Apps.CompanyCommunicator.Common.Extensions
 {
     using System;
     using System.Collections.Generic;
+    using Microsoft.Graph;
     using Microsoft.Teams.Apps.CompanyCommunicator.Common.Repositories.UserData;
     using Microsoft.Teams.Apps.CompanyCommunicator.Common.Services.MicrosoftGraph;
 
@@ -45,7 +46,7 @@ public static IEnumerable<IEnumerable<string>> AsGroups(this IList<string> userI
         }
 
         /// <summary>
-        /// Get the user type for a user.
+        /// Get the userType for a user.
         /// </summary>
         /// <param name="userPrincipalName">the user principal name.</param>
         /// <returns>the user type such as Member or Guest.</returns>
@@ -58,5 +59,25 @@ public static string GetUserType(this string userPrincipalName)
 
             return userPrincipalName.ToLower().Contains("#ext#") ? UserType.Guest : UserType.Member;
         }
+
+        /// <summary>
+        /// Get the userType for a user.
+        /// </summary>
+        /// <param name="user">the microsoft graph user.</param>
+        /// <returns>the user type such as Member or Guest.</returns>
+        public static string GetUserType(this User user)
+        {
+            if (user == null)
+            {
+                throw new ArgumentNullException(nameof(user));
+            }
+
+            if (!string.IsNullOrEmpty(user.UserType))
+            {
+                return user.UserType;
+            }
+
+            return user.UserPrincipalName.GetUserType();
+        }
     }
 }
diff --git a/Source/CompanyCommunicator.Common/Policies/PollyPolicy.cs b/Source/CompanyCommunicator.Common/Policies/PollyPolicy.cs
@@ -0,0 +1,37 @@
+// <copyright file="PollyPolicy.cs" company="Microsoft">
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+// </copyright>
+
+namespace Microsoft.Teams.Apps.CompanyCommunicator.Common.Policies
+{
+    using System;
+    using System.Net;
+    using Microsoft.Graph;
+    using Polly;
+    using Polly.Contrib.WaitAndRetry;
+    using Polly.Retry;
+
+    /// <summary>
+    /// Polly policies.
+    /// </summary>
+    public class PollyPolicy
+    {
+        /// <summary>
+        /// Get the graph retry policy.
+        /// </summary>
+        /// <param name="maxAttempts">the number of max attempts.</param>
+        /// <returns>A retry policy that can be applied to async delegates.</returns>
+        public static AsyncRetryPolicy GetGraphRetryPolicy(int maxAttempts)
+        {
+            var delay = Backoff.DecorrelatedJitterBackoffV2(medianFirstRetryDelay: TimeSpan.FromSeconds(1), retryCount: maxAttempts);
+
+            // Only Handling 502 Bad Gateway Exception
+            // Other exception such as 429, 503, 504 is handled by default by Graph SDK.
+            return Policy
+                .Handle<ServiceException>(e =>
+                e.StatusCode == HttpStatusCode.BadGateway)
+                .WaitAndRetryAsync(delay);
+        }
+    }
+}
diff --git a/...ompanyCommunicator.Common/Repositories/SentNotificationData/SentNotificationDataEntity.cs b/...ompanyCommunicator.Common/Repositories/SentNotificationData/SentNotificationDataEntity.cs
@@ -40,6 +40,12 @@ public class SentNotificationDataEntity : TableEntity
         /// </summary>
         public static readonly int FinalFaultedStatusCode = -2;
 
+        /// <summary>
+        /// This value indicates that operation is not supported by Azure Function and will
+        /// not be processed further.
+        /// </summary>
+        public static readonly int NotSupportedStatusCode = -3;
+
         /// <summary>
         /// String indicating the recipient type for the given notification was a user.
         /// </summary>
@@ -169,6 +175,11 @@ public class SentNotificationDataEntity : TableEntity
         /// </summary>
         public string TenantId { get; set; }
 
+        /// <summary>
+        /// Gets or sets the user type for the recipient.
+        /// </summary>
+        public string UserType { get; set; }
+
         /// <summary>
         /// Gets or sets the user id for the recipient.
         /// </summary>

diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.Designer.cs b/Source/CompanyCommunicator.Common/Resources/Strings.Designer.cs
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.ar-SA.resx b/Source/CompanyCommunicator.Common/Resources/Strings.ar-SA.resx
@@ -248,12 +248,15 @@
     <value>مقيّد</value>
   </data>
   <data name="ColumnName_UserType" xml:space="preserve">
-    <value>User Type</value>
+    <value>نوع المستخدم</value>
   </data>
   <data name="Guest" xml:space="preserve">
-    <value>Guest</value>
+    <value>الضيف</value>
   </data>
   <data name="Member" xml:space="preserve">
-    <value>Member</value>
+    <value>العضو</value>
+  </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>المستخدم الضيف غير مدعم</value>
   </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.de-DE.resx b/Source/CompanyCommunicator.Common/Resources/Strings.de-DE.resx
@@ -160,7 +160,7 @@
     <value>{0} (kopieren)</value>
   </data>
   <data name="ExportFailureText" xml:space="preserve">
-    <value>Da hat etwas nicht geklappt. Versuchen Sie noch Mal, die Ergebnisse zu exportieren.</value>
+    <value>Etwas ist schief gegangen. Versuchen Sie noch Mal, die Ergebnisse zu exportieren.</value>
   </data>
   <data name="Failed" xml:space="preserve">
     <value>Fehlgeschlagen</value>
@@ -221,7 +221,7 @@
     <value>Ihre Datei kann jetzt herunter geladen werden. Eine Kopie ist auch auf OneDrive verfügbar.</value>
   </data>
   <data name="FileUploadErrorText" xml:space="preserve">
-    <value>Da hat etwas nicht geklappt. Versuchen Sie noch Mal, die Ergebnisse zu exportieren.</value>
+    <value>Etwas ist schief gegangen. Versuchen Sie noch Mal, die Ergebnisse zu exportieren.</value>
   </data>
   <data name="NumberOfGroupsExceededLimitWarningFormat" xml:space="preserve">
     <value>Die Benachrichtigung hat {0} Gruppen als Ihre Empfänger. Sie sollte {1} Gruppen nicht über schreiten.</value>
@@ -256,4 +256,7 @@
   <data name="Member" xml:space="preserve">
     <value>Mitglied</value>
   </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>Gastbenutzer nicht unterstützt</value>
+  </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.es-ES.resx b/Source/CompanyCommunicator.Common/Resources/Strings.es-ES.resx
@@ -248,12 +248,15 @@
     <value>Limitado</value>
   </data>
   <data name="ColumnName_UserType" xml:space="preserve">
-    <value>User Type</value>
+    <value>Tipo de usuario</value>
   </data>
   <data name="Guest" xml:space="preserve">
-    <value>Guest</value>
+    <value>Invitado</value>
   </data>
   <data name="Member" xml:space="preserve">
-    <value>Member</value>
+    <value>Miembro</value>
+  </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>No se admite el usuario invitado</value>
   </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.fr-FR.resx b/Source/CompanyCommunicator.Common/Resources/Strings.fr-FR.resx
@@ -256,4 +256,7 @@
   <data name="Member" xml:space="preserve">
     <value>Membre</value>
   </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>Utilisateur invité non pris en charge</value>
+  </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.he-IL.resx b/Source/CompanyCommunicator.Common/Resources/Strings.he-IL.resx
@@ -256,4 +256,7 @@
   <data name="Member" xml:space="preserve">
     <value>חבר</value>
   </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>משתמש אורח אינו נתמך</value>
+  </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.ja-JP.resx b/Source/CompanyCommunicator.Common/Resources/Strings.ja-JP.resx
@@ -256,4 +256,7 @@
   <data name="Member" xml:space="preserve">
     <value>メンバー</value>
   </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>ゲスト ユーザーはサポートされていません</value>
+  </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.ko-KR.resx b/Source/CompanyCommunicator.Common/Resources/Strings.ko-KR.resx
@@ -256,4 +256,7 @@
   <data name="Member" xml:space="preserve">
     <value>구성원</value>
   </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>게스트 사용자가 지원되지 않음</value>
+  </data>
 </root>
diff --git a/Source/CompanyCommunicator.Common/Resources/Strings.pt-BR.resx b/Source/CompanyCommunicator.Common/Resources/Strings.pt-BR.resx
@@ -248,12 +248,15 @@
     <value>Limitado</value>
   </data>
   <data name="ColumnName_UserType" xml:space="preserve">
-    <value>User Type</value>
+    <value>Tipo de Usuário</value>
   </data>
   <data name="Guest" xml:space="preserve">
-    <value>Guest</value>
+    <value>Convidado</value>
   </data>
   <data name="Member" xml:space="preserve">
-    <value>Member</value>
+    <value>Membro</value>
+  </data>
+  <data name="GuestUserNotSupported" xml:space="preserve">
+    <value>Não há suporte para o Usuário Convidado</value>
   </data>
 </root>