fix: add fixed status to suggestions

src/backlinks/handler.js

@@ -10,40 +10,22 @@
  * governing permissions and limitations under the License.
  */
 
-import { composeAuditURL, getPrompt, tracingFetch as fetch } from '@adobe/spacecat-shared-utils';
+import { composeAuditURL, getPrompt } from '@adobe/spacecat-shared-utils';
 import AhrefsAPIClient from '@adobe/spacecat-shared-ahrefs-client';
-import { AbortController, AbortError } from '@adobe/fetch';
 import { FirefallClient } from '@adobe/spacecat-shared-gpt-client';
 import { syncSuggestions } from '../utils/data-access.js';
 import { AuditBuilder } from '../common/audit-builder.js';
-import { getScrapedDataForSiteId, sleep } from '../support/utils.js';
-
-const TIMEOUT = 3000;
+import {
+  getScrapedDataForSiteId,
+  isFixedURL,
+  sleep,
+  fetchWithTimeout, TIMEOUT,
+} from '../support/utils.js';
 
 async function filterOutValidBacklinks(backlinks, log) {
-  const fetchWithTimeout = async (url, timeout) => {
-    const controller = new AbortController();
-    const { signal } = controller;
-    const id = setTimeout(() => controller.abort(), timeout);
-
-    try {
-      const response = await fetch(url, { signal });
-      clearTimeout(id);
-      return response;
-    } catch (error) {
-      if (error instanceof AbortError) {
-        log.warn(`Request to ${url} timed out after ${timeout}ms`);
-        return { ok: false, status: 408 };
-      }
-    } finally {
-      clearTimeout(id);
-    }
-    return null;
-  };
-
   const isStillBrokenBacklink = async (backlink) => {
     try {
-      const response = await fetchWithTimeout(backlink.url_to, TIMEOUT);
+      const response = await fetchWithTimeout(backlink.url_to, TIMEOUT, log);
       if (!response.ok && response.status !== 404
         && response.status >= 400 && response.status < 500) {
         log.warn(`Backlink ${backlink.url_to} returned status ${response.status}`);
@@ -272,6 +254,7 @@ export const convertToOpportunity = async (auditUrl, auditData, context) => {
     opportunity,
     newData: auditData.auditResult.brokenBacklinks,
     buildKey,
+    isFixed: isFixedURL,
     mapNewSuggestion: (backlink) => ({
       opportunityId: opportunity.getId(),
       type: 'REDIRECT_UPDATE',

src/cwv/handler.js

@@ -112,6 +112,7 @@ export async function convertToOppty(auditUrl, auditData, context, site) {
     opportunity,
     newData: auditData.auditResult.cwv,
     buildKey,
+    isFixed: () => false,
     mapNewSuggestion: (entry) => ({
       opportunityId: opportunity.getId(),
       type: 'CODE_CHANGE',

src/internal-links/handler.js

@@ -12,7 +12,7 @@
 
 import RUMAPIClient from '@adobe/spacecat-shared-rum-api-client';
 import { internalServerError } from '@adobe/spacecat-shared-http-utils';
-import { getRUMDomainkey, getRUMUrl } from '../support/utils.js';
+import { getRUMDomainkey, getRUMUrl, isFixedURL } from '../support/utils.js';
 import { AuditBuilder } from '../common/audit-builder.js';
 import { noopUrlResolver } from '../common/audit.js';
 import { syncSuggestions } from '../utils/data-access.js';
@@ -151,6 +151,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
     opportunity,
     newData: auditData?.auditResult?.brokenInternalLinks,
     buildKey,
+    isFixed: isFixedURL,
     mapNewSuggestion: (entry) => ({
       opportunityId: opportunity.getId(),
       type: 'CONTENT_UPDATE',

src/sitemap/handler.js

@@ -17,7 +17,7 @@ import {
   extractDomainAndProtocol,
   getBaseUrlPagesFromSitemapContents,
   getSitemapUrlsFromSitemapIndex,
-  getUrlWithoutPath,
+  getUrlWithoutPath, isFixedURL,
   toggleWWW,
 } from '../support/utils.js';
 import { AuditBuilder } from '../common/audit-builder.js';
@@ -574,6 +574,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
     opportunity,
     newData: auditData.suggestions,
     buildKey,
+    isFixed: isFixedURL,
     mapNewSuggestion: (issue) => ({
       opportunityId: opportunity.getId(),
       type: 'REDIRECT_UPDATE',

src/structured-data/handler.js

@@ -144,6 +144,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
     opportunity,
     newData: filteredAuditResult,
     buildKey,
+    isFixed: () => true,
     mapNewSuggestion: (data) => {
       const errors = data.richResults.detectedIssues.flatMap((issue) => issue.items.flatMap((item) => item.issues.map((i) => `${i.issueMessage}`))).sort();
       return {

src/support/utils.js

@@ -22,10 +22,11 @@ import URI from 'urijs';
 import { JSDOM } from 'jsdom';
 import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import { ListObjectsV2Command } from '@aws-sdk/client-s3';
+import { AbortController, AbortError } from '@adobe/fetch';
 import { getObjectFromKey } from '../utils/s3-utils.js';
 
 URI.preventInvalidHostname = true;
-
+export const TIMEOUT = 3000;
 // weekly pageview threshold to eliminate urls with lack of samples
 
 export async function getRUMUrl(url) {
@@ -298,6 +299,36 @@ export const getScrapedDataForSiteId = async (site, context) => {
   };
 };
 
+export const fetchWithTimeout = async (url, timeout, log = console) => {
+  const controller = new AbortController();
+  const { signal } = controller;
+  const id = setTimeout(() => controller.abort(), timeout);
+
+  try {
+    const response = await fetch(url, { signal });
+    clearTimeout(id);
+    return response;
+  } catch (error) {
+    if (error instanceof AbortError) {
+      log.warn(`Request to ${url} timed out after ${timeout}ms`);
+      return { ok: false, status: 408 };
+    }
+  } finally {
+    clearTimeout(id);
+  }
+  return null;
+};
+
+export const isFixedURL = async (backlink) => {
+  try {
+    const response = await fetchWithTimeout(backlink.url_to, TIMEOUT);
+    return response.ok;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  } catch (e) {
+    return false;
+  }
+};
+
 export async function sleep(ms) {
   return new Promise((resolve) => {
     setTimeout(resolve, ms);

src/utils/data-access.js

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { isObject } from '@adobe/spacecat-shared-utils';
+import { Suggestion } from '@adobe/spacecat-shared-data-access';
 
 /**
  * Fetches site data based on the given base URL. If no site is found for the given
@@ -53,16 +54,23 @@ export async function syncSuggestions({
   opportunity,
   newData,
   buildKey,
+  isFixed,
   mapNewSuggestion,
   log,
 }) {
   const newDataKeys = new Set(newData.map(buildKey));
   const existingSuggestions = await opportunity.getSuggestions();
-  // Remove outdated suggestions
   await Promise.all(
     existingSuggestions
       .filter((existing) => !newDataKeys.has(buildKey(existing.getData())))
-      .map((suggestion) => suggestion.remove()),
+      .map(async (suggestion) => {
+        const isSuggestionFixed = await isFixed(suggestion);
+        if (isSuggestionFixed) {
+          suggestion.setStatus(Suggestion.STATUSES.FiXED);
+          return suggestion.save();
+        }
+        return suggestion.remove();
+      }),
   );
 
   // Update existing suggestions

test/utils/data-access.test.js

@@ -99,15 +99,26 @@ describe('data-access', () => {
       };
     });
 
-    it('should remove outdated suggestions and add new ones', async () => {
+    it('should remove unfix outdated suggestions keep fixed ones and add the  new ones', async () => {
       const suggestionsData = [{ key: '1' }, { key: '2' }];
       const existingSuggestions = [
         {
-          id: '1', data: suggestionsData[0], remove: sinon.stub(), getData: sinon.stub().returns(suggestionsData[0]),
+          id: '1',
+          data: suggestionsData[0],
+          remove: sinon.stub(),
+          getData: sinon.stub().returns(suggestionsData[0]),
+          setStatus: (status) => sinon.stub().returns({ ...suggestionsData[0], status }),
+          save: sinon.stub(),
         },
         {
-          id: '2', data: suggestionsData[1], remove: sinon.stub(), getData: sinon.stub().returns(suggestionsData[1]),
+          id: '2',
+          data: suggestionsData[1],
+          remove: sinon.stub(),
+          getData: sinon.stub().returns(suggestionsData[1]),
+          setStatus: (status) => sinon.stub().returns({ ...suggestionsData[0], status }),
+          save: sinon.stub(),
         }];
+      const isFixed = (suggestion) => suggestion.id === '1';
       const newData = [{ key: '3' }, { key: '4' }];
 
       mockOpportunity.getSuggestions.resolves(existingSuggestions);
@@ -117,6 +128,7 @@ describe('data-access', () => {
         opportunity: mockOpportunity,
         newData,
         buildKey,
+        isFixed,
         mapNewSuggestion,
         log: mockLogger,
       });
@@ -137,6 +149,8 @@ describe('data-access', () => {
           key: '4',
         },
       }]);
+      expect(existingSuggestions[0].save).to.have.been.called;
+      expect(existingSuggestions[1].remove).to.have.been.calledOnce;
       expect(mockLogger.error).to.not.have.been.called;
     });
 
@@ -166,6 +180,7 @@ describe('data-access', () => {
         opportunity: mockOpportunity,
         newData,
         buildKey,
+        isFixed: () => false,
         mapNewSuggestion,
         log: mockLogger,
       });
@@ -193,6 +208,7 @@ describe('data-access', () => {
         await syncSuggestions({
           opportunity: mockOpportunity,
           newData,
+          isFixed: () => false,
           buildKey,
           mapNewSuggestion,
           log: mockLogger,
@@ -222,6 +238,7 @@ describe('data-access', () => {
       await expect(syncSuggestions({
         opportunity: mockOpportunity,
         newData,
+        isFixed: () => false,
         buildKey,
         mapNewSuggestion,
         log: mockLogger,