@adobe/spacecat-shared-tier-client 1.3.9 → 1.3.11

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-tier-client-v1.3.11](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.3.10...@adobe/spacecat-shared-tier-client-v1.3.11) (2026-02-06)
+
+
+### Bug Fixes
+
+* adds additional check for dangling enrollments ([#1296](https://github.com/adobe/spacecat-shared/issues/1296)) ([e5a0de3](https://github.com/adobe/spacecat-shared/commit/e5a0de32112dbf81e3da37d7b90a747d993497da))
+
+# [@adobe/spacecat-shared-tier-client-v1.3.10](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.3.9...@adobe/spacecat-shared-tier-client-v1.3.10) (2025-12-05)
+
+
+### Bug Fixes
+
+* no override paid tier ([#1221](https://github.com/adobe/spacecat-shared/issues/1221)) ([a528e1e](https://github.com/adobe/spacecat-shared/commit/a528e1e345cce2c542b32dc43c221b49e3f86464))
+
 # [@adobe/spacecat-shared-tier-client-v1.3.9](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.3.8...@adobe/spacecat-shared-tier-client-v1.3.9) (2025-11-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tier-client",
-  "version": "1.3.9",
+  "version": "1.3.11",
   "description": "Shared modules of the Spacecat Services - Tier Client",
   "type": "module",
   "engines": {

package/src/tier-client.js

@@ -148,8 +148,8 @@ class TierClient {
       if (existing.entitlement) {
         const currentTier = existing.entitlement.getTier();
 
-        // If tier doesn't match, update it
-        if (currentTier !== tier) {
+        // If currentTier doesn't match with given tier and is not PAID, update it
+        if (currentTier !== tier && currentTier !== EntitlementModel.TIERS.PAID) {
           existing.entitlement.setTier(tier);
           await existing.entitlement.save();
         }
@@ -220,6 +220,7 @@ class TierClient {
    * Gets all enrollments based on context, filtered by productCode.
    * - If site is provided: returns site enrollment for the entitlement matching productCode
    * - If org-only: returns all site enrollments for the entitlement matching productCode
+   * - Filters out enrollments where the site's orgId doesn't match the entitlement's orgId
    * @returns {Promise<object>} Object with entitlement and enrollments array.
    */
   async getAllEnrollment() {
@@ -234,16 +235,41 @@ class TierClient {
 
       const allEnrollments = await this.SiteEnrollment.allByEntitlementId(entitlement.getId());
 
+      if (allEnrollments.length === 0) {
+        return { entitlement, enrollments: [] };
+      }
+
+      // Fetch all sites using batchGetByKeys
+      const siteKeys = allEnrollments.map((enrollment) => ({ siteId: enrollment.getSiteId() }));
+      const sitesResult = await this.Site.batchGetByKeys(siteKeys);
+      const sitesMap = new Map(sitesResult.data.map((site) => [site.getId(), site]));
+
+      // Filter enrollments where site's orgId matches the entitlement's orgId
+      const validEnrollments = [];
+
+      for (const enrollment of allEnrollments) {
+        const site = sitesMap.get(enrollment.getSiteId());
+        if (!site) {
+          // Site not found, log warning and skip
+          this.log.warn(`Site not found for enrollment ${enrollment.getId()} with siteId ${enrollment.getSiteId()}`);
+        } else {
+          const siteOrgId = site.getOrganizationId();
+          if (siteOrgId === orgId) {
+            validEnrollments.push(enrollment);
+          }
+        }
+      }
+
       if (this.site) {
         // Return site enrollments matching the entitlement and site
         const siteId = this.site.getId();
-        const matchingEnrollments = allEnrollments.filter(
+        const matchingEnrollments = validEnrollments.filter(
           (se) => se.getSiteId() === siteId,
         );
         return { entitlement, enrollments: matchingEnrollments };
       } else {
-        // Return all enrollments for the entitlement
-        return { entitlement, enrollments: allEnrollments };
+        // Return all valid enrollments for the entitlement
+        return { entitlement, enrollments: validEnrollments };
       }
     } catch (error) {
       this.log.error(`Error getting all enrollments: ${error.message}`);

package/test/tier-client.test.js

@@ -80,6 +80,7 @@ describe('TierClient', () => {
     },
     Site: {
       findById: sandbox.stub(),
+      batchGetByKeys: sandbox.stub(),
     },
   };
 
@@ -417,7 +418,7 @@ describe('TierClient', () => {
     it('should update tier when entitlement exists with different tier', async () => {
       const mockEntitlementWithDifferentTier = {
         ...mockEntitlement,
-        getTier: () => 'PAID',
+        getTier: () => 'FREE_TRIAL', // current non-PAID
         setTier: sandbox.stub().returnsThis(),
         save: sandbox.stub().resolves(),
       };
@@ -426,9 +427,9 @@ describe('TierClient', () => {
         .findByOrganizationIdAndProductCode.resolves(mockEntitlementWithDifferentTier);
       mockDataAccess.SiteEnrollment.allBySiteId.resolves([mockSiteEnrollment]);
 
-      const result = await tierClient.createEntitlement('FREE_TRIAL');
+      const result = await tierClient.createEntitlement('PAID');
 
-      expect(mockEntitlementWithDifferentTier.setTier).to.have.been.calledWith('FREE_TRIAL');
+      expect(mockEntitlementWithDifferentTier.setTier).to.have.been.calledWith('PAID');
       expect(mockEntitlementWithDifferentTier.save).to.have.been.called;
       expect(result).to.deep.equal({
         entitlement: mockEntitlementWithDifferentTier,
@@ -437,6 +438,28 @@ describe('TierClient', () => {
       expect(mockDataAccess.Entitlement.create).to.not.have.been.called;
     });
 
+    it('should not update tier when entitlement exists with same tier', async () => {
+      const mockEntitlementWithSameTier = {
+        ...mockEntitlement,
+        getTier: () => 'FREE_TRIAL',
+        setTier: sandbox.stub().returnsThis(),
+        save: sandbox.stub().resolves(),
+      };
+
+      mockDataAccess.Entitlement
+        .findByOrganizationIdAndProductCode.resolves(mockEntitlementWithSameTier);
+      mockDataAccess.SiteEnrollment.allBySiteId.resolves([mockSiteEnrollment]);
+
+      const result = await tierClient.createEntitlement('FREE_TRIAL');
+
+      expect(mockEntitlementWithSameTier.setTier).to.not.have.been.called;
+      expect(mockEntitlementWithSameTier.save).to.not.have.been.called;
+      expect(result).to.deep.equal({
+        entitlement: mockEntitlementWithSameTier,
+        siteEnrollment: mockSiteEnrollment,
+      });
+    });
+
     it('should throw error when organization not found', async () => {
       mockDataAccess.Organization.findById.resolves(null);
 
@@ -704,11 +727,25 @@ describe('TierClient', () => {
         getEntitlementId: () => 'entitlement-123',
       };
 
+      const mockSiteForEnrollment1 = {
+        getId: () => siteId,
+        getOrganizationId: () => orgId,
+      };
+
+      const mockSiteForEnrollment2 = {
+        getId: () => '789-site-id',
+        getOrganizationId: () => orgId,
+      };
+
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([
         mockSiteEnrollment,
         mockEnrollment2,
       ]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteForEnrollment1, mockSiteForEnrollment2],
+        unprocessed: [],
+      });
 
       const result = await tierClientWithoutSite.getAllEnrollment();
 
@@ -720,6 +757,10 @@ describe('TierClient', () => {
         .to.have.been.calledWith(orgId, productCode);
       expect(mockDataAccess.SiteEnrollment.allByEntitlementId)
         .to.have.been.calledWith('entitlement-123');
+      expect(mockDataAccess.Site.batchGetByKeys).to.have.been.calledWith([
+        { siteId },
+        { siteId: '789-site-id' },
+      ]);
     });
 
     it('should return filtered enrollments when site is provided', async () => {
@@ -729,11 +770,25 @@ describe('TierClient', () => {
         getEntitlementId: () => 'entitlement-123',
       };
 
+      const mockSiteForEnrollment1 = {
+        getId: () => siteId,
+        getOrganizationId: () => orgId,
+      };
+
+      const mockSiteForEnrollment2 = {
+        getId: () => 'other-site-id',
+        getOrganizationId: () => orgId,
+      };
+
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([
         mockSiteEnrollment,
         mockEnrollment2,
       ]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteForEnrollment1, mockSiteForEnrollment2],
+        unprocessed: [],
+      });
 
       const result = await tierClient.getAllEnrollment();
 
@@ -789,18 +844,96 @@ describe('TierClient', () => {
         getEntitlementId: () => 'entitlement-123',
       };
 
+      const mockSiteForEnrollment1 = {
+        getId: () => siteId,
+        getOrganizationId: () => orgId,
+      };
+
+      const mockSiteForEnrollment2 = {
+        getId: () => 'different-site-id',
+        getOrganizationId: () => orgId,
+      };
+
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([
         mockSiteEnrollment,
         mockEnrollment2,
         mockEnrollment3,
       ]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteForEnrollment1, mockSiteForEnrollment2, mockSiteForEnrollment1],
+        unprocessed: [],
+      });
 
       const result = await tierClient.getAllEnrollment();
 
       expect(result.enrollments).to.have.lengthOf(2);
       expect(result.enrollments).to.deep.equal([mockSiteEnrollment, mockEnrollment3]);
     });
+
+    it('should filter out enrollments with mismatching orgId', async () => {
+      const tierClientWithoutSite = new TierClient(
+        mockContext,
+        organizationInstance,
+        null,
+        productCode,
+      );
+
+      const mismatchingOrgId = 'different-org-id';
+      const mockEnrollment2 = {
+        getId: () => 'enrollment-456',
+        getSiteId: () => 'site-with-wrong-org',
+        getEntitlementId: () => 'entitlement-123',
+      };
+
+      const mockSiteForEnrollment1 = {
+        getId: () => siteId,
+        getOrganizationId: () => orgId,
+      };
+
+      const mockSiteForEnrollment2 = {
+        getId: () => 'site-with-wrong-org',
+        getOrganizationId: () => mismatchingOrgId,
+      };
+
+      mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
+      mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([
+        mockSiteEnrollment,
+        mockEnrollment2,
+      ]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteForEnrollment1, mockSiteForEnrollment2],
+        unprocessed: [],
+      });
+
+      const result = await tierClientWithoutSite.getAllEnrollment();
+
+      expect(result.enrollments).to.have.lengthOf(1);
+      expect(result.enrollments[0].getId()).to.equal('enrollment-123');
+    });
+
+    it('should log warning when site not found for enrollment', async () => {
+      const tierClientWithoutSite = new TierClient(
+        mockContext,
+        organizationInstance,
+        null,
+        productCode,
+      );
+
+      mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
+      mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([mockSiteEnrollment]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [],
+        unprocessed: [],
+      });
+
+      const result = await tierClientWithoutSite.getAllEnrollment();
+
+      expect(result.enrollments).to.have.lengthOf(0);
+      expect(mockContext.log.warn).to.have.been.calledWith(
+        `Site not found for enrollment ${mockSiteEnrollment.getId()} with siteId ${siteId}`,
+      );
+    });
   });
 
   describe('getFirstEnrollment', () => {
@@ -812,10 +945,15 @@ describe('TierClient', () => {
       const mockSiteObject = {
         getId: () => siteId,
         getName: () => 'Test Site',
+        getOrganizationId: () => orgId,
       };
 
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([mockSiteEnrollment]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteObject],
+        unprocessed: [],
+      });
       mockDataAccess.Site.findById.resolves(mockSiteObject);
 
       const tierClientWithoutSite = new TierClient(
@@ -839,6 +977,13 @@ describe('TierClient', () => {
       const mockSiteObject = {
         getId: () => siteId,
         getName: () => 'Test Site',
+        getOrganizationId: () => orgId,
+      };
+
+      const mockSiteObject2 = {
+        getId: () => 'other-site-id',
+        getName: () => 'Other Site',
+        getOrganizationId: () => orgId,
       };
 
       const mockEnrollment2 = {
@@ -852,6 +997,10 @@ describe('TierClient', () => {
         mockSiteEnrollment,
         mockEnrollment2,
       ]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteObject, mockSiteObject2],
+        unprocessed: [],
+      });
       mockDataAccess.Site.findById.resolves(mockSiteObject);
 
       const tierClientWithoutSite = new TierClient(
@@ -895,8 +1044,18 @@ describe('TierClient', () => {
     });
 
     it('should return null site when site not found in database', async () => {
+      const mockSiteObject = {
+        getId: () => siteId,
+        getName: () => 'Test Site',
+        getOrganizationId: () => orgId,
+      };
+
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([mockSiteEnrollment]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteObject],
+        unprocessed: [],
+      });
       mockDataAccess.Site.findById.resolves(null);
 
       const tierClientWithoutSite = new TierClient(
@@ -929,10 +1088,15 @@ describe('TierClient', () => {
       const mockSiteObject = {
         getId: () => siteId,
         getName: () => 'Test Site',
+        getOrganizationId: () => orgId,
       };
 
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([mockSiteEnrollment]);
+      mockDataAccess.Site.batchGetByKeys.resolves({
+        data: [mockSiteObject],
+        unprocessed: [],
+      });
       mockDataAccess.Site.findById.resolves(mockSiteObject);
 
       const result = await tierClient.getFirstEnrollment();
@@ -944,10 +1108,10 @@ describe('TierClient', () => {
       });
     });
 
-    it('should handle error when fetching site', async () => {
+    it('should handle error when fetching site via batchGetByKeys', async () => {
       mockDataAccess.Entitlement.findByOrganizationIdAndProductCode.resolves(mockEntitlement);
       mockDataAccess.SiteEnrollment.allByEntitlementId.resolves([mockSiteEnrollment]);
-      mockDataAccess.Site.findById.rejects(new Error('Site fetch error'));
+      mockDataAccess.Site.batchGetByKeys.rejects(new Error('Site fetch error'));
 
       await expect(tierClient.getFirstEnrollment()).to.be.rejectedWith('Site fetch error');
     });