From dcc199bcce4aa2d5621f6fab80f1b49d8b143418 Mon Sep 17 00:00:00 2001
From: Conner Turnbull <133619638+cturnbull-bitwarden@users.noreply.github.com>
Date: Wed, 21 Aug 2024 15:20:53 -0400
Subject: [PATCH] [AC-2950] Added logs when validating an existing sponsorship
 (#4592)

* Added logs when validating an existing sponsorship

* Removed early return in CancelSponsorshipAsync when validating a sponsorship

* Added missing logging messages
---
 .../Cloud/ValidateSponsorshipCommand.cs       | 83 +++++++++++++++++--
 1 file changed, 77 insertions(+), 6 deletions(-)

diff --git a/src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/ValidateSponsorshipCommand.cs b/src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/ValidateSponsorshipCommand.cs
index 9c3f66c436..2325724d1c 100644
--- a/src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/ValidateSponsorshipCommand.cs
+++ b/src/Core/OrganizationFeatures/OrganizationSponsorships/FamiliesForEnterprise/Cloud/ValidateSponsorshipCommand.cs
@@ -28,8 +28,10 @@ public class ValidateSponsorshipCommand : CancelSponsorshipCommand, IValidateSpo
     public async Task<bool> ValidateSponsorshipAsync(Guid sponsoredOrganizationId)
     {
         var sponsoredOrganization = await _organizationRepository.GetByIdAsync(sponsoredOrganizationId);
+
         if (sponsoredOrganization == null)
         {
+            _logger.LogWarning("Sponsored Organization {OrganizationId} does not exist", sponsoredOrganizationId);
             return false;
         }
 
@@ -38,39 +40,108 @@ public class ValidateSponsorshipCommand : CancelSponsorshipCommand, IValidateSpo
 
         if (existingSponsorship == null)
         {
+            _logger.LogWarning("Existing sponsorship for sponsored Organization {SponsoredOrganizationId} does not exist", sponsoredOrganizationId);
+
             await CancelSponsorshipAsync(sponsoredOrganization, null);
             return false;
         }
 
-        if (existingSponsorship.SponsoringOrganizationId == null || existingSponsorship.SponsoringOrganizationUserId == default || existingSponsorship.PlanSponsorshipType == null)
+        if (existingSponsorship.SponsoringOrganizationId == null)
         {
+            _logger.LogWarning("Sponsoring OrganizationId is null for sponsored Organization {SponsoredOrganizationId}", sponsoredOrganizationId);
+
             await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
             return false;
         }
+
+        if (existingSponsorship.SponsoringOrganizationUserId == default)
+        {
+            _logger.LogWarning("Sponsoring OrganizationUserId is null for sponsored Organization {SponsoredOrganizationId}", sponsoredOrganizationId);
+
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+            return false;
+        }
+
+        if (existingSponsorship.PlanSponsorshipType == null)
+        {
+            _logger.LogWarning("PlanSponsorshipType is null for sponsored Organization {SponsoredOrganizationId}", sponsoredOrganizationId);
+
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+            return false;
+        }
+
+        if (existingSponsorship.SponsoringOrganizationId == null)
+        {
+            _logger.LogWarning("Sponsoring OrganizationId is null for sponsored Organization {SponsoredOrganizationId}", sponsoredOrganizationId);
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+            return false;
+        }
+
+        if (existingSponsorship.SponsoringOrganizationUserId == default)
+        {
+            _logger.LogWarning("Sponsoring OrganizationUserId is null for sponsored Organization {SponsoredOrganizationId}", sponsoredOrganizationId);
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+            return false;
+        }
+
+        if (existingSponsorship.PlanSponsorshipType == null)
+        {
+            _logger.LogWarning("PlanSponsorshipType is null for sponsored Organization {SponsoredOrganizationId}", sponsoredOrganizationId);
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+            return false;
+        }
+
         var sponsoredPlan = Utilities.StaticStore.GetSponsoredPlan(existingSponsorship.PlanSponsorshipType.Value);
 
         var sponsoringOrganization = await _organizationRepository
             .GetByIdAsync(existingSponsorship.SponsoringOrganizationId.Value);
+
         if (sponsoringOrganization == null)
         {
+            _logger.LogWarning("Sponsoring Organization {SponsoringOrganizationId} does not exist", existingSponsorship.SponsoringOrganizationId);
             await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
             return false;
         }
 
         var sponsoringOrgPlan = Utilities.StaticStore.GetPlan(sponsoringOrganization.PlanType);
-        if (OrgDisabledForMoreThanGracePeriod(sponsoringOrganization) ||
-            sponsoredPlan.SponsoringProductTierType != sponsoringOrgPlan.ProductTier ||
-            existingSponsorship.ToDelete ||
-            SponsorshipIsSelfHostedOutOfSync(existingSponsorship))
+
+        if (OrgDisabledForMoreThanGracePeriod(sponsoringOrganization))
         {
+            _logger.LogWarning("Sponsoring Organization {SponsoringOrganizationId} is disabled for more than 3 months.", sponsoringOrganization.Id);
             await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+
             return false;
         }
 
+        if (sponsoredPlan.SponsoringProductTierType != sponsoringOrgPlan.ProductTier)
+        {
+            _logger.LogWarning("Sponsoring Organization {SponsoringOrganizationId} is not on the required product type.", sponsoringOrganization.Id);
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+
+            return false;
+        }
+
+        if (existingSponsorship.ToDelete)
+        {
+            _logger.LogWarning("Sponsorship for sponsored Organization {SponsoredOrganizationId} is marked for deletion", sponsoredOrganizationId);
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+
+            return false;
+        }
+
+        if (SponsorshipIsSelfHostedOutOfSync(existingSponsorship))
+        {
+            _logger.LogWarning("Sponsorship for sponsored Organization {SponsoredOrganizationId} is out of sync with self-hosted instance.", sponsoredOrganizationId);
+            await CancelSponsorshipAsync(sponsoredOrganization, existingSponsorship);
+
+            return false;
+        }
+
+        _logger.LogInformation("Sponsorship for sponsored Organization {SponsoredOrganizationId} is valid", sponsoredOrganizationId);
         return true;
     }
 
-    protected async Task CancelSponsorshipAsync(Organization sponsoredOrganization, OrganizationSponsorship sponsorship = null)
+    private async Task CancelSponsorshipAsync(Organization sponsoredOrganization, OrganizationSponsorship sponsorship = null)
     {
         if (sponsoredOrganization != null)
         {