Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Group structured data issues before generating suggestions #760

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+363 −42
Open

fix: Group structured data issues before generating suggestions #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c44f21
Group issues before generating suggestions
herzog31 Mar 7, 2025
e2b634f
Update unit tests
herzog31 Mar 7, 2025
8f52586
Merge branch 'main' into SITES-29354
herzog31 Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 85 additions & 33 deletions src/structured-data/handler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
/* eslint-disable no-continue, no-await-in-loop */
import GoogleClient from '@adobe/spacecat-shared-google-client';
import {
getPrompt, isNonEmptyArray, isNonEmptyObject, isObject,
getPrompt, isNonEmptyArray, isNonEmptyObject, isObject, deepEqual,
} from '@adobe/spacecat-shared-utils';
import { FirefallClient } from '@adobe/spacecat-shared-gpt-client';
import { Audit } from '@adobe/spacecat-shared-data-access';
Expand All @@ -28,6 +28,9 @@ import { generatePlainHtml, getScrapeForPath } from '../support/utils.js';
const auditType = Audit.AUDIT_TYPES.STRUCTURED_DATA;
const auditAutoSuggestType = Audit.AUDIT_TYPES.STRUCTURED_DATA_AUTO_SUGGEST;

// Limit to avoid excessive Firefall requests. Can be increased if needed.
const FIREFALL_REQUEST_LIMIT = 50;

/**
* Processes an audit of a set of pages from a site using Google's URL inspection tool.
*
Expand Down Expand Up @@ -122,6 +125,29 @@ export async function processStructuredData(baseURL, context, pages) {
// Filter out the results where GSC inspection failed
.filter((result) => !result.error);

// Deduplicate items for in detectedIssues
filteredResults.forEach((result) => {
result.richResults?.detectedIssues?.forEach((detectedIssue) => {
// eslint-disable-next-line no-param-reassign
detectedIssue.items = detectedIssue.items.reduce((acc, item) => {
const existingItem = acc.find((accItem) => accItem.name === item.name);
if (!existingItem) {
acc.push(item);
} else {
item.issues.forEach((issue) => {
// If issue doesn't already exist, add it
const exists = existingItem.issues
.find((existingIssue) => existingIssue.issueMessage === issue.issueMessage);
if (!exists) {
existingItem.issues.push(issue);
}
});
}
return acc;
}, []);
});
});

return filteredResults;
}

Expand Down Expand Up @@ -237,6 +263,7 @@ export async function structuredDataHandler(baseURL, context, site) {
auditResult,
};
} catch (e) {
log.error(`Structured data audit failed for ${baseURL}`, e);
return {
fullAuditRef: baseURL,
auditResult: {
Expand Down Expand Up @@ -271,40 +298,30 @@ export async function generateSuggestionsData(auditUrl, auditData, context, site
responseFormat: 'json_object',
};

let firefallRequests = 0;

// Cache suggestions so that we only generate one suggestion for each issue
const existingSuggestions = new Map();

// Only take results which have actual issues
const results = auditData.auditResult
.filter((result) => result.richResults?.detectedIssues?.length > 0);

// Go through audit results, one for each URL
for (const auditResult of results) {
log.info(`Create suggestion for URL ${auditResult.inspectionUrl}`);

// Get scraped version of website from S3 if available.
let scrapeResult;
const { pathname } = new URL(auditResult.inspectionUrl);
try {
scrapeResult = await getScrapeForPath(pathname, context, site);
} catch (e) {
log.error(`Could not find scrape for ${pathname}. Make sure that scrape-top-pages did run.`, e);
continue;
}

// Get extracted LD-JSON from scrape
const structuredData = scrapeResult?.scrapeResult?.structuredData;
if (!isNonEmptyArray(structuredData)) {
// If structured data is loaded late on the page, e.g. in delayed phase,
// the scraper might not pick it up. You would need to fine tune wait for
// check of the scraper for this site.
log.error(`No structured data found in scrape result for URL ${auditResult.inspectionUrl}`);
continue;
// Abort early if too many Firefall requests are used.
if (firefallRequests >= FIREFALL_REQUEST_LIMIT) {
log.error(`Aborting suggestion generation as more than ${FIREFALL_REQUEST_LIMIT} Firefall requests have been used.`);
break;
}
log.debug('Found ld+json in scrape:', JSON.stringify(structuredData));

// Use cheerio to generate a plain version of the scraped HTML
const parsed = cheerioLoad(scrapeResult?.scrapeResult?.rawBody);
const plainPage = generatePlainHtml(parsed);
log.info(`Create suggestion for URL ${auditResult.inspectionUrl}`);
// Cache scrape of page, if needed
let scrapeResult;
let structuredData;
let plainPage;

// Need a mapping between GSC rich result types and schema.org entities as they differ.
// Mapping between GSC rich result types and schema.org entities
const entityMapping = {
Breadcrumbs: 'BreadcrumbList',
'Product snippets': 'Product',
Expand All @@ -316,14 +333,47 @@ export async function generateSuggestionsData(auditUrl, auditData, context, site

// Go through every issue on page
for (const issue of auditResult.richResults.detectedIssues) {
log.debug(`Handle rich result issue of type ${issue.richResultType}`);
log.debug(`Handle rich result issue of type ${issue.richResultType} for URL ${auditResult.inspectionUrl}`);

const entity = entityMapping[issue.richResultType];
if (!entity) {
log.error(`Could not find entity mapping for issue of type ${issue.richResultType}`);
log.error(`Could not find entity mapping for issue of type ${issue.richResultType} for URL ${auditResult.inspectionUrl}`);
continue;
}

// Check if a suggestion for the error is already in the suggestion Map
const existingSuggestionKey = existingSuggestions.keys().find((key) => deepEqual(issue, key));
if (existingSuggestionKey) {
log.info(`Re-use existing suggestion for type ${issue.richResultType} and URL ${auditResult.inspectionUrl}`);
issue.suggestion = existingSuggestions.get(existingSuggestionKey);
continue;
}

// Once sure we need it, load scraped version of page from S3
if (!structuredData) {
const { pathname } = new URL(auditResult.inspectionUrl);
try {
scrapeResult = await getScrapeForPath(pathname, context, site);
} catch (e) {
log.error(`Could not find scrape for ${pathname}. Make sure that scrape-top-pages did run.`, e);
break;
}

// Get extracted LD-JSON from scrape
structuredData = scrapeResult?.scrapeResult?.structuredData;
if (!isNonEmptyArray(structuredData)) {
// If structured data is loaded late on the page, e.g. in delayed phase,
// the scraper might not pick it up. You would need to fine tune wait for
// check of the scraper for this site.
log.error(`No structured data found in scrape result for URL ${auditResult.inspectionUrl}`);
break;
}

// Use cheerio to generate a plain version of the scraped HTML
const parsed = cheerioLoad(scrapeResult?.scrapeResult?.rawBody);
plainPage = generatePlainHtml(parsed);
}

// Filter structured data relevant to this issue
let wrongLdJson = structuredData.find((data) => entity === data['@type']);

Expand All @@ -338,7 +388,7 @@ export async function generateSuggestionsData(auditUrl, auditData, context, site
}
}
if (!isNonEmptyObject(wrongLdJson)) {
log.error(`Could not find structured data for issue of type ${entity}`);
log.error(`Could not find structured data for issue of type ${entity} for URL ${auditResult.inspectionUrl}`);
continue;
}
log.debug('Filtered structured data:', JSON.stringify(wrongLdJson));
Expand All @@ -350,40 +400,42 @@ export async function generateSuggestionsData(auditUrl, auditData, context, site
wrong_ld_json: JSON.stringify(wrongLdJson, null, 4),
website_markup: plainPage,
};
log.debug('Firefall inputs:', JSON.stringify(firefallInputs));

// Get suggestions from Firefall
let response;
try {
const requestBody = await getPrompt(firefallInputs, 'structured-data-suggest', log);
response = await firefallClient.fetchChatCompletion(requestBody, firefallOptions);
firefallRequests += 1;

if (response.choices?.length === 0 || response.choices[0].finish_reason !== 'stop') {
throw new Error('No suggestions found');
}
} catch (e) {
log.error(`Could not create suggestion because Firefall did not return any suggestions for issue of type ${issue.richResultType}`, e);
log.error(`Could not create suggestion because Firefall did not return any suggestions for issue of type ${issue.richResultType} for URL ${auditResult.inspectionUrl}`, e);
continue;
}

let suggestion;
try {
suggestion = JSON.parse(response.choices[0].message.content);
} catch (e) {
log.error(`Could not parse Firefall response for issue of type ${issue.richResultType}`, e);
log.error(`Could not parse Firefall response for issue of type ${issue.richResultType} for URL ${auditResult.inspectionUrl}`, e);
continue;
}

// Reject suggestion if confidence score is too low
if (suggestion?.confidenceScore < 0.6) {
log.error(`Confidence score too low, skip suggestion of type ${issue.richResultType}`);
log.error(`Confidence score too low, skip suggestion of type ${issue.richResultType} for URL ${auditResult.inspectionUrl}`);
continue;
}

existingSuggestions.set(structuredClone(issue), structuredClone(suggestion));
issue.suggestion = suggestion;
}
}

log.debug(`Used ${firefallRequests} Firefall requests in total for site ${auditUrl}`);
log.debug('Generated suggestions data', JSON.stringify(auditData));

return { ...auditData };
Expand Down
9 changes: 5 additions & 4 deletions static/prompts/structured-data-suggest.prompt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ You are tasked to correct the LD+JSON structured data object for the provided we

### Rules:
1. If data required to fix the wrong LD-JSON object cannot be retrieved from the makeup, please return an empty JSON object `{}`.
2. Focus on correcting mistakes in the LD-JSON object.
3. The completed LD-JSON object needs to be valid according to schema.org specifications.
4. For breadcrumbs, try avoiding duplicate entries.
5. Provide a explanation of the provided errors and a rationale of how you fixed those errors.
2. If the provided entity does not contain the errors mentioned, return an empty JSON object `{}`.
3. Focus on correcting mistakes in the LD-JSON object.
4. The completed LD-JSON object needs to be valid according to schema.org specifications.
5. For breadcrumbs, try avoiding duplicate entries.
6. Provide a explanation of the provided errors and a rationale of how you fixed those errors.

### Response Format:
Your response must be a valid JSON object with the following structure:
Expand Down
Loading