get tenant id from imsClient if organization does not have tenantId

Author: tkotthakota-adobe

package.json

@@ -69,6 +69,7 @@
     "@adobe/spacecat-shared-http-utils": "1.15.2",
     "@adobe/spacecat-shared-slack-client": "^1.3.12",
     "@adobe/spacecat-shared-utils": "1.44.1",
+    "@adobe/spacecat-shared-ims-client": "1.8.6",
     "@aws-sdk/client-lambda": "3.851.0",
     "@aws-sdk/client-sqs": "3.854.0",
     "@aws-sdk/credential-provider-node": "3.848.0",

src/index.js

@@ -15,6 +15,7 @@ import secrets from '@adobe/helix-shared-secrets';
 import dataAccess from '@adobe/spacecat-shared-data-access';
 import { sqsEventAdapter } from '@adobe/spacecat-shared-utils';
 import { internalServerError, notFound, ok } from '@adobe/spacecat-shared-http-utils';
+import { imsClientWrapper } from '@adobe/spacecat-shared-ims-client';
 
 import { runOpportunityStatusProcessor as opportunityStatusProcessor } from './tasks/opportunity-status-processor/handler.js';
 import { runDisableImportAuditProcessor as disableImportAuditProcessor } from './tasks/disable-import-audit-processor/handler.js';
@@ -76,5 +77,6 @@ async function run(message, context) {
 export const main = wrap(run)
   .with(dataAccess)
   .with(sqsEventAdapter)
+  .with(imsClientWrapper)
   .with(secrets, { name: getSecretName })
   .with(helixStatus);

src/tasks/demo-url-processor/handler.js

@@ -26,21 +26,26 @@ const TASK_TYPE = 'demo-url-processor';
  * @returns {string} The IMS tenant ID
  */
 async function getImsTenantId(imsOrgId, organization, context, log, env, slackContext) {
+  // Get tenantId from organization
   const { name, tenantId } = organization;
-
-  // If tenantId is there, return it
   if (tenantId) {
     return tenantId;
+  } else {
+    // Get tenantId from IMS org details if tenantId is not there in organization
+    let imsOrgDetails;
+    try {
+      imsOrgDetails = await context.imsClient.getImsOrganizationDetails(imsOrgId);
+      return imsOrgDetails.tenantId;
+    } catch (error) {
+      log.error(`Error retrieving IMS Org details: ${error.message}`);
+    }
   }
-
-  // If tenantId isn't there, use name to generate (backward compatible for existing orgs)
+  // As a fallback option, use name to generate tenant id (backward compatible for existing orgs)
   if (name) {
     return name.toLowerCase().replace(/\s+/g, '');
   }
-
-  // If name is also not there, log an error and return DEFAULT_TENANT_ID
-  log.error('Organization name and tenantId are missing, using default tenant ID');
-  await say(env, log, slackContext, ':x: Organization name and tenantId are missing, using default tenant ID');
+  log.error('Using default tenant ID');
+  await say(env, log, slackContext, ':x: Using default tenant ID');
   return context.env.DEFAULT_TENANT_ID;
 }
 

test/index.test.js

@@ -45,6 +45,20 @@ describe('Index Tests', () => {
         warn: sandbox.stub(),
         debug: sandbox.stub(),
       },
+      env: {
+        imsHost: 'https://ims-na1.adobelogin.com',
+        clientId: 'test-client-id',
+        clientCode: 'test-client-code',
+        clientSecret: 'test-client-secret',
+        DEFAULT_TENANT_ID: 'default-tenant',
+      },
+      imsHost: 'https://ims-na1.adobelogin.com',
+      clientId: 'test-client-id',
+      clientCode: 'test-client-code',
+      clientSecret: 'test-client-secret',
+      imsClient: {
+        getImsOrganizationDetails: sandbox.stub(),
+      },
       runtime: {
         region: 'us-east-1',
       },

test/tasks/demo-url-processor/demo-url-processor.test.js

@@ -122,8 +122,8 @@ describe('Demo URL Processor', () => {
 
       await runDemoUrlProcessor(message, context);
 
-      // Should log error about missing name and tenantId and use fallback
-      expect(context.log.error.calledWith('Organization name and tenantId are missing, using default tenant ID')).to.be.true;
+      // Should log error about using default tenant ID
+      expect(context.log.error.calledWith('Using default tenant ID')).to.be.true;
       const expectedDemoUrl = 'https://example.com?organizationId=test-org-id#/@default-tenant/sites-optimizer/sites/test-site-id/home';
       expect(context.log.info.calledWith(`Setup complete! Access your demo environment here: ${expectedDemoUrl}`)).to.be.true;
     });
@@ -194,12 +194,116 @@ describe('Demo URL Processor', () => {
         organizationId: 'test-org-id',
       })).to.be.true;
 
-      // Should log error about missing name and tenantId
-      expect(context.log.error.calledWith('Organization name and tenantId are missing, using default tenant ID')).to.be.true;
+      // Should log error about using default tenant ID
+      expect(context.log.error.calledWith('Using default tenant ID')).to.be.true;
 
       // Should log the completion message with default tenant
       const expectedDemoUrl = 'https://example.com?organizationId=test-org-id#/@default-tenant/sites-optimizer/sites/test-site-id/home';
       expect(context.log.info.calledWith(`Setup complete! Access your demo environment here: ${expectedDemoUrl}`)).to.be.true;
     });
+
+    it('should get tenantId from imsClient when not available in organization', async () => {
+      // Mock Organization.findById to return organization without tenantId
+      context.dataAccess.Organization.findById.resolves({
+        name: 'Adobe Sites Engineering',
+        imsOrgId: '8C6043F15F43B6390A49401A@AdobeOrg',
+        // tenantId property is missing
+      });
+
+      // Mock imsClient to return tenantId
+      context.imsClient = {
+        getImsOrganizationDetails: sinon.stub().resolves({
+          tenantId: 'ims-tenant-id-from-client',
+        }),
+      };
+
+      await runDemoUrlProcessor(message, context);
+
+      // Should call imsClient.getImsOrganizationDetails
+      expect(context.imsClient.getImsOrganizationDetails.calledWith('8C6043F15F43B6390A49401A@AdobeOrg')).to.be.true;
+
+      // Should use the tenantId from imsClient
+      const expectedDemoUrl = 'https://example.com?organizationId=test-org-id#/@ims-tenant-id-from-client/sites-optimizer/sites/test-site-id/home';
+      expect(context.log.info.calledWith(`Setup complete! Access your demo environment here: ${expectedDemoUrl}`)).to.be.true;
+    });
+
+    it('should fallback to name when imsClient fails and tenantId is missing', async () => {
+      // Mock Organization.findById to return organization without tenantId
+      context.dataAccess.Organization.findById.resolves({
+        name: 'Adobe Sites Engineering',
+        imsOrgId: '8C6043F15F43B6390A49401A@AdobeOrg',
+        // tenantId property is missing
+      });
+
+      // Mock imsClient to throw an error
+      context.imsClient = {
+        getImsOrganizationDetails: sinon.stub().rejects(new Error('IMS API error')),
+      };
+
+      await runDemoUrlProcessor(message, context);
+
+      // Should call imsClient.getImsOrganizationDetails
+      expect(context.imsClient.getImsOrganizationDetails.calledWith('8C6043F15F43B6390A49401A@AdobeOrg')).to.be.true;
+
+      // Should log error about IMS API failure
+      expect(context.log.error.calledWith('Error retrieving IMS Org details: IMS API error')).to.be.true;
+
+      // Should fallback to name-based tenant
+      const expectedDemoUrl = 'https://example.com?organizationId=test-org-id#/@adobesitesengineering/sites-optimizer/sites/test-site-id/home';
+      expect(context.log.info.calledWith(`Setup complete! Access your demo environment here: ${expectedDemoUrl}`)).to.be.true;
+    });
+
+    it('should fallback to DEFAULT_TENANT_ID when imsClient fails and name is missing', async () => {
+      // Mock Organization.findById to return organization without tenantId and name
+      context.dataAccess.Organization.findById.resolves({
+        imsOrgId: '8C6043F15F43B6390A49401A@AdobeOrg',
+        // tenantId and name properties are missing
+      });
+
+      // Mock imsClient to throw an error
+      context.imsClient = {
+        getImsOrganizationDetails: sinon.stub().rejects(new Error('IMS API error')),
+      };
+
+      // Set default tenant ID
+      context.env.DEFAULT_TENANT_ID = 'default-tenant';
+
+      await runDemoUrlProcessor(message, context);
+
+      // Should call imsClient.getImsOrganizationDetails
+      expect(context.imsClient.getImsOrganizationDetails.calledWith('8C6043F15F43B6390A49401A@AdobeOrg')).to.be.true;
+
+      // Should log error about IMS API failure
+      expect(context.log.error.calledWith('Error retrieving IMS Org details: IMS API error')).to.be.true;
+
+      // Should log error about using default tenant ID
+      expect(context.log.error.calledWith('Using default tenant ID')).to.be.true;
+
+      // Should use DEFAULT_TENANT_ID as final fallback
+      const expectedDemoUrl = 'https://example.com?organizationId=test-org-id#/@default-tenant/sites-optimizer/sites/test-site-id/home';
+      expect(context.log.info.calledWith(`Setup complete! Access your demo environment here: ${expectedDemoUrl}`)).to.be.true;
+    });
+
+    it('should send Slack message when using default tenant ID', async () => {
+      // Mock Organization.findById to return organization without tenantId and name
+      context.dataAccess.Organization.findById.resolves({
+        imsOrgId: '8C6043F15F43B6390A49401A@AdobeOrg',
+        // tenantId and name properties are missing
+      });
+
+      // Mock imsClient to throw an error
+      context.imsClient = {
+        getImsOrganizationDetails: sinon.stub().rejects(new Error('IMS API error')),
+      };
+
+      // Set default tenant ID
+      context.env.DEFAULT_TENANT_ID = 'default-tenant';
+
+      await runDemoUrlProcessor(message, context);
+
+      // Should send Slack message about using default tenant ID
+      // Note: We can't directly test the say function call, but we can verify the log message
+      expect(context.log.error.calledWith('Using default tenant ID')).to.be.true;
+    });
   });
 });