feat(slack/onboard-llmo): acknowledge and process asynchronously

Author: cwjwisse

src/support/slack/actions/onboard-llmo-modal.js

@@ -602,7 +602,7 @@ export async function onboardSite(input, lambdaCtx, slackCtx) {
       await sqs.sendMessage(configuration.getQueues().audits, sqsTriggerMesasage);
 
       const message = `:white_check_mark: *LLMO onboarding completed successfully!*
-        
+
 :link: *Site:* ${baseURL}
 :identification_card: *Site ID:* ${siteId}
 :file_folder: *Data Folder:* ${dataFolder}
@@ -615,10 +615,14 @@ The LLMO Customer Analysis handler has been triggered. It will take a few minute
     } catch (error) {
       log.error(`Error saving LLMO config for site ${siteId}: ${error.message}`);
       await say(`:x: Failed to save LLMO configuration: ${error.message}`);
+      // Re-throw the error so it can be caught by the outer error handler
+      throw new Error(`Failed to save LLMO configuration: ${error.message}`);
     }
   } catch (error) {
     log.error('Error in LLMO onboarding:', error);
     await postErrorMessage(say, error);
+    // Re-throw the error so it can be caught by the modal handler
+    throw error;
   }
 }
 
@@ -627,6 +631,8 @@ export function onboardLLMOModal(lambdaContext) {
   const { log } = lambdaContext;
 
   return async ({ ack, body, client }) => {
+    let hasAcknowledged = false;
+
     try {
       log.debug('Starting onboarding process...');
       const { view, user } = body;
@@ -650,6 +656,7 @@ export function onboardLLMOModal(lambdaContext) {
       const imsOrgId = values.ims_org_input.ims_org_id.value;
       const deliveryType = values.delivery_type_input?.delivery_type?.selected_option?.value;
 
+      // Validate required fields before proceeding
       if (!brandName || !imsOrgId) {
         await ack({
           response_action: 'errors',
@@ -658,6 +665,7 @@ export function onboardLLMOModal(lambdaContext) {
             ims_org_input: !imsOrgId ? 'IMS Org ID is required' : undefined,
           },
         });
+        hasAcknowledged = true;
         return;
       }
 
@@ -670,9 +678,9 @@ export function onboardLLMOModal(lambdaContext) {
         originalThreadTs,
       });
 
-      // eslint-disable-next-line max-statements-per-line
-      await new Promise((resolve) => { setTimeout(resolve, 500); });
+      // Acknowledge the modal immediately to close it and provide good UX
       await ack();
+      hasAcknowledged = true;
 
       // Create a slack context for the onboarding process
       // Use original channel/thread if available, otherwise fall back to DM
@@ -692,19 +700,32 @@ export function onboardLLMOModal(lambdaContext) {
         threadTs: responseThreadTs,
       };
 
+      // Post immediate status message to let user know processing has started
+      await slackContext.say(`:hourglass_flowing_sand: Starting LLMO onboarding for *${brandName}* (${brandURL})...`);
+
+      // Perform the onboarding operation asynchronously
+      // Any errors will be posted to the Slack channel via the slackContext
       await onboardSite({
         brandName, baseURL: brandURL, imsOrgId, deliveryType,
       }, lambdaContext, slackContext);
 
-      log.debug(`Onboard LLMO modal processed for user ${user.id}, site ${brandURL}`);
+      log.debug(`Onboard LLMO modal processed successfully for user ${user.id}, site ${brandURL}`);
     } catch (e) {
       log.error('Error handling onboard site modal:', e);
-      await ack({
-        response_action: 'errors',
-        errors: {
-          brand_name_input: 'There was an error processing the onboarding request.',
-        },
-      });
+
+      // Only try to acknowledge with errors if we haven't already acknowledged
+      if (!hasAcknowledged) {
+        await ack({
+          response_action: 'errors',
+          errors: {
+            brand_name_input: 'There was an error processing the onboarding request. Please try again.',
+          },
+        });
+      } else {
+        // If we already acknowledged, we can't show modal errors anymore
+        // The error should have been handled by onboardSite's error handling via Slack messages
+        log.error('Error occurred after modal was acknowledged - error was posted to Slack channel');
+      }
     }
   };
 }

test/support/slack/actions/onboard-llmo-modal.test.js

@@ -709,8 +709,9 @@ describe('onboard-llmo-modal', () => {
       // Make SQS sendMessage throw an error
       lambdaCtx.sqs.sendMessage.rejects(new Error('SQS service unavailable'));
 
-      // Execute the function
-      await onboardSite(input, lambdaCtx, slackCtx);
+      // Execute the function and expect it to throw
+      await expect(onboardSite(input, lambdaCtx, slackCtx))
+        .to.be.rejectedWith('Failed to save LLMO configuration: SQS service unavailable');
 
       // Verify that SQS sendMessage was called but failed
       expect(lambdaCtx.sqs.sendMessage).to.have.been.called;
@@ -1184,8 +1185,15 @@ example-com:
         originalChannel: 'C1234567890',
         originalThreadTs: '1234567890.123456',
       });
-      expect(lambdaCtx.log.debug).to.have.been.calledWith('Onboard LLMO modal processed for user U1234567890, site https://example.com');
+      expect(lambdaCtx.log.debug).to.have.been.calledWith('Onboard LLMO modal processed successfully for user U1234567890, site https://example.com');
       expect(mockAck).to.have.been.calledOnce;
+
+      // Verify that the status message was posted
+      expect(mockClient.chat.postMessage).to.have.been.calledWith({
+        channel: 'C1234567890',
+        text: ':hourglass_flowing_sand: Starting LLMO onboarding for *Test Brand* (https://example.com)...',
+        thread_ts: '1234567890.123456',
+      });
     });
 
     it('should print error message if onboarding throws an error', async () => {
@@ -1225,11 +1233,17 @@ example-com:
       await handler({ ack: mockAck, body: mockBody, client: mockClient });
 
       expect(lambdaCtx.log.error).to.have.been.calledWith('Error handling onboard site modal:', sinon.match.instanceOf(Error));
-      expect(mockAck).to.have.been.calledWith({
-        response_action: 'errors',
-        errors: {
-          brand_name_input: 'There was an error processing the onboarding request.',
-        },
+      expect(lambdaCtx.log.error).to.have.been.calledWith('Error occurred after modal was acknowledged - error was posted to Slack channel');
+
+      // Modal should be acknowledged immediately (closed)
+      expect(mockAck).to.have.been.calledOnce;
+      expect(mockAck).to.not.have.been.calledWith(sinon.match.object);
+
+      // Status message should be posted
+      expect(mockClient.chat.postMessage).to.have.been.calledWith({
+        channel: 'C1234567890',
+        text: ':hourglass_flowing_sand: Starting LLMO onboarding for *Test Brand* (this is not a valid URL)...',
+        thread_ts: '1234567890.123456',
       });
     });