fix: add tokowaka auto-deploy api (#1357)

Author: dipratap

package-lock.json

@@ -72,9 +72,10 @@
     "@adobe/helix-status": "10.1.5",
     "@adobe/helix-universal-logger": "3.0.28",
     "@adobe/spacecat-helix-content-sdk": "1.4.25",
+    "@adobe/spacecat-shared-tokowaka-client": "1.0.0",
     "@adobe/spacecat-shared-athena-client": "1.3.7",
     "@adobe/spacecat-shared-brand-client": "1.1.26",
-    "@adobe/spacecat-shared-data-access": "2.75.0",
+    "@adobe/spacecat-shared-data-access": "2.76.0",
     "@adobe/spacecat-shared-gpt-client": "1.6.7",
     "@adobe/spacecat-shared-http-utils": "1.17.9",
     "@adobe/spacecat-shared-ims-client": "1.9.1",
@@ -156,4 +157,4 @@
     ],
     "ext": ".js, .cjs, .ejs, .css"
   }
-}
+}

package.json

@@ -27,6 +27,7 @@ import {
 } from '@adobe/spacecat-shared-utils';
 
 import { ValidationError, Suggestion as SuggestionModel, Site as SiteModel } from '@adobe/spacecat-shared-data-access';
+import TokowakaClient from '@adobe/spacecat-shared-tokowaka-client';
 import { SuggestionDto } from '../dto/suggestion.js';
 import { FixDto } from '../dto/fix.js';
 import { sendAutofixMessage, getCSPromiseToken, ErrorWithStatusCode } from '../support/utils.js';
@@ -778,9 +779,158 @@ function SuggestionsController(ctx, sqs, env) {
     }
   };
 
+  /**
+   * Deploys suggestions through Tokowaka edge delivery
+   * @param {Object} context of the request
+   * @returns {Promise<Response>} Deployment response
+   */
+  const deploySuggestionToEdge = async (context) => {
+    const siteId = context.params?.siteId;
+    const opportunityId = context.params?.opportunityId;
+
+    if (!isValidUUID(siteId)) {
+      return badRequest('Site ID required');
+    }
+
+    if (!isValidUUID(opportunityId)) {
+      return badRequest('Opportunity ID required');
+    }
+
+    // validate request body
+    if (!isNonEmptyObject(context.data)) {
+      return badRequest('No data provided');
+    }
+    const { suggestionIds } = context.data;
+    if (!isArray(suggestionIds) || suggestionIds.length === 0) {
+      return badRequest('Request body must contain a non-empty array of suggestionIds');
+    }
+
+    const site = await Site.findById(siteId);
+    if (!site) {
+      return notFound('Site not found');
+    }
+
+    if (!await accessControlUtil.hasAccess(site)) {
+      return forbidden('User does not belong to the organization');
+    }
+
+    const opportunity = await Opportunity.findById(opportunityId);
+    if (!opportunity || opportunity.getSiteId() !== siteId) {
+      return notFound('Opportunity not found');
+    }
+
+    // Fetch all suggestions for this opportunity
+    const allSuggestions = await Suggestion.allByOpportunityId(opportunityId);
+
+    // Track valid, failed, and missing suggestions
+    const validSuggestions = [];
+    const failedSuggestions = [];
+
+    // Check each requested suggestion (basic validation only)
+    suggestionIds.forEach((suggestionId, index) => {
+      const suggestion = allSuggestions.find((s) => s.getId() === suggestionId);
+
+      if (!suggestion) {
+        failedSuggestions.push({
+          uuid: suggestionId,
+          index,
+          message: 'Suggestion not found',
+          statusCode: 404,
+        });
+      } else if (suggestion.getStatus() !== SuggestionModel.STATUSES.NEW) {
+        failedSuggestions.push({
+          uuid: suggestionId,
+          index,
+          message: 'Suggestion is not in NEW status',
+          statusCode: 400,
+        });
+      } else {
+        validSuggestions.push(suggestion);
+      }
+    });
+
+    let succeededSuggestions = [];
+
+    // Only attempt deployment if we have valid suggestions
+    if (isNonEmptyArray(validSuggestions)) {
+      try {
+        const tokowakaClient = TokowakaClient.createFrom(context);
+        const deploymentResult = await tokowakaClient.deploySuggestions(
+          site,
+          opportunity,
+          validSuggestions,
+        );
+
+        // Process deployment results
+        const {
+          succeededSuggestions: deployedSuggestions,
+          failedSuggestions: ineligibleSuggestions,
+        } = deploymentResult;
+
+        // Update successfully deployed suggestions with deployment timestamp
+        const deploymentTimestamp = Date.now();
+        succeededSuggestions = await Promise.all(
+          deployedSuggestions.map(async (suggestion) => {
+            const currentData = suggestion.getData();
+            suggestion.setData({
+              ...currentData,
+              tokowakaDeployed: deploymentTimestamp,
+            });
+            suggestion.setUpdatedBy('tokowaka-deployment');
+            return suggestion.save();
+          }),
+        );
+
+        // Add ineligible suggestions to failed list
+        ineligibleSuggestions.forEach((item) => {
+          failedSuggestions.push({
+            uuid: item.suggestion.getId(),
+            index: suggestionIds.indexOf(item.suggestion.getId()),
+            message: item.reason,
+            statusCode: 400,
+          });
+        });
+
+        context.log.info(`Successfully deployed ${succeededSuggestions.length} suggestions to Edge`);
+      } catch (error) {
+        context.log.error(`Error deploying to Tokowaka: ${error.message}`, error);
+        // If deployment fails, mark all valid suggestions as failed
+        validSuggestions.forEach((suggestion) => {
+          failedSuggestions.push({
+            uuid: suggestion.getId(),
+            index: suggestionIds.indexOf(suggestion.getId()),
+            message: 'Deployment failed: Internal server error',
+            statusCode: 500,
+          });
+        });
+      }
+    }
+
+    const response = {
+      suggestions: [
+        ...succeededSuggestions.map((suggestion) => ({
+          uuid: suggestion.getId(),
+          index: suggestionIds.indexOf(suggestion.getId()),
+          statusCode: 200,
+          suggestion: SuggestionDto.toJSON(suggestion),
+        })),
+        ...failedSuggestions,
+      ],
+      metadata: {
+        total: suggestionIds.length,
+        success: succeededSuggestions.length,
+        failed: failedSuggestions.length,
+      },
+    };
+    response.suggestions.sort((a, b) => a.index - b.index);
+
+    return createResponse(response, 207);
+  };
+
   return {
     autofixSuggestions,
     createSuggestions,
+    deploySuggestionToEdge,
     getAllForOpportunity,
     getPagedForOpportunity,
     getByID,

src/controllers/suggestions.js

@@ -184,6 +184,7 @@ export default function getRouteHandlers(
     'GET /sites/:siteId/opportunities/:opportunityId/suggestions': suggestionsController.getAllForOpportunity,
     'GET /sites/:siteId/opportunities/:opportunityId/suggestions/paged/:pageNum/:pageSize': suggestionsController.getPagedForOpportunity,
     'PATCH /sites/:siteId/opportunities/:opportunityId/suggestions/auto-fix': suggestionsController.autofixSuggestions,
+    'POST /sites/:siteId/opportunities/:opportunityId/suggestions/edge-deploy': suggestionsController.deploySuggestionToEdge,
     'GET /sites/:siteId/opportunities/:opportunityId/suggestions/by-status/:status': suggestionsController.getByStatus,
     'GET /sites/:siteId/opportunities/:opportunityId/suggestions/:suggestionId': suggestionsController.getByID,
     'GET /sites/:siteId/opportunities/:opportunityId/suggestions/:suggestionId/fixes': suggestionsController.getSuggestionFixes,

src/routes/index.js

@@ -631,6 +631,7 @@ describe('Audits Controller', () => {
         getBrandConfig: () => ({ brandId: 'test-brand' }),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -668,6 +669,7 @@ describe('Audits Controller', () => {
         getBrandConfig: () => ({ brandId: 'test-brand' }),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -706,6 +708,7 @@ describe('Audits Controller', () => {
         getBrandConfig: () => ({ brandId: 'test-brand' }),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -747,6 +750,7 @@ describe('Audits Controller', () => {
         getBrandConfig: () => ({ brandId: 'test-brand' }),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -828,6 +832,7 @@ describe('Audits Controller', () => {
         getBrandConfig: () => ({ brandId: 'test-brand' }),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -870,6 +875,7 @@ describe('Audits Controller', () => {
         getBrandConfig: () => ({ brandId: 'test-brand' }),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -910,6 +916,7 @@ describe('Audits Controller', () => {
         getImports: () => [],
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -949,6 +956,7 @@ describe('Audits Controller', () => {
         getImports: () => [],
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -987,6 +995,7 @@ describe('Audits Controller', () => {
         getHandlers: () => (({ [auditType]: {} })),
         getCdnLogsConfig: () => ({}),
         getLlmoConfig: () => ({}),
+        getTokowakaConfig: () => ({}),
       });
 
       const result = await auditsController.patchAuditForSite(context);
@@ -1051,6 +1060,7 @@ describe('Audits Controller', () => {
           getBrandConfig: () => ({ brandId: 'test-brand' }),
           getCdnLogsConfig: () => ({}),
           getLlmoConfig: () => ({}),
+          getTokowakaConfig: () => ({}),
         };
 
         site.getConfig = () => siteConfig;