Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"start": "nodemon",
"test": "c8 mocha -i -g 'Post-Deploy' --spec=test/**/*.test.js",
"test-postdeploy": "mocha -g 'Post-Deploy' --spec=test/**/*.test.js",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"lint": "node --max-old-space-size=10240 ./node_modules/.bin/eslint .",
"lint:fix": "node --max-old-space-size=10240 ./node_modules/.bin/eslint . --fix",
"logs": "aws logs tail /aws/lambda/spacecat-services--audit-worker",
"semantic-release": "semantic-release",
"semantic-release-dry": "semantic-release --dry-run --no-ci --branches $CI_BRANCH",
Expand Down
2 changes: 1 addition & 1 deletion src/cwv/handler.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export async function opportunityAndSuggestions(auditUrl, auditData, context, si

// Send SQS message for Mystique auto-suggest if enabled and opportunity needs suggestions
if (await needsAutoSuggest(context, opportunity, site)) {
await sendSQSMessageForAutoSuggest(context, opportunity, site);
await sendSQSMessageForAutoSuggest(context, opportunity, site, auditData.auditResult.cwv);
}
}

Expand Down
58 changes: 42 additions & 16 deletions src/cwv/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,10 @@ export async function needsAutoSuggest(context, opportunity, site) {
* @param {Object} context - Context object containing log, sqs, env
* @param {Object} opportunity - Opportunity object with siteId, auditId, opportunityId, and data
* @param {Object} site - Site object with getBaseURL() and getDeliveryType() methods
* @param {Array} cwvEntries - Array of CWV data entries from audit result
* @throws {Error} When SQS message sending fails
*/
export async function sendSQSMessageForAutoSuggest(context, opportunity, site) {
export async function sendSQSMessageForAutoSuggest(context, opportunity, site, cwvEntries = []) {
const {
log, sqs, env,
} = context;
Expand All @@ -93,21 +94,46 @@ export async function sendSQSMessageForAutoSuggest(context, opportunity, site) {

log.info(`Received CWV opportunity for auto-suggest - siteId: ${siteId}, opportunityId: ${opportunityId}`);

const sqsMessage = {
type: CWV_AUTO_SUGGEST_MESSAGE_TYPE,
siteId: opptyData.siteId,
auditId: opptyData.auditId,
deliveryType: site ? site.getDeliveryType() : 'aem_cs',
time: new Date().toISOString(),
data: {
page: site ? site.getBaseURL() : '',
opportunityId,
},
};

// eslint-disable-next-line no-await-in-loop
await sqs.sendMessage(env.QUEUE_SPACECAT_TO_MYSTIQUE, sqsMessage);
log.info(`CWV opportunity sent to Mystique for auto-suggest - siteId: ${siteId}, opportunityId: ${opportunityId}`);
// Filter for URL-type entries only (skip groups) and ensure suggestions exist for them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can move part of the logic into needsAutoSuggest, which decides whether to send an SQS message to auto-guidance.

const suggestions = await opportunity.getSuggestions();
const urlEntries = cwvEntries.filter((entry) => entry.type === 'url');

if (urlEntries.length === 0) {
log.info('No new URL entries to send for CWV auto-suggest');
return;
}

log.info(`Sending ${urlEntries.length} URL(s) to Mystique for CWV analysis`);

// Send one message per URL
for (const entry of urlEntries) {
// Find the corresponding suggestion for the current URL entry to check its status.
// This prevents re-sending analysis requests for suggestions that already have guidance
// or are not in a 'NEW' state.
const suggestion = suggestions.find((s) => s.getData().url === entry.url);
const suggestionData = suggestion?.getData();
const issues = suggestionData?.issues || [];
const hasGuidance = issues.some((issue) => issue.value && issue.value.trim());

if (suggestion?.getStatus() === 'NEW' && !hasGuidance) {
const sqsMessage = {
type: CWV_AUTO_SUGGEST_MESSAGE_TYPE,
siteId: opptyData.siteId,
auditId: opptyData.auditId,
deliveryType: site ? site.getDeliveryType() : 'aem_cs',
time: new Date().toISOString(),
data: {
page: entry.url,
opportunity_id: opportunityId,
},
};
// eslint-disable-next-line no-await-in-loop
await sqs.sendMessage(env.QUEUE_SPACECAT_TO_MYSTIQUE, sqsMessage);
log.info(`Sent URL to Mystique: ${entry.url}`);
}
}

log.info(`CWV opportunity sent to Mystique for auto-suggest - siteId: ${siteId}, opportunityId: ${opportunityId}, URLs: ${urlEntries.length}`);
}
} catch (error) {
const siteId = opportunity?.siteId || 'unknown';
Expand Down
122 changes: 65 additions & 57 deletions test/audits/cwv.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ use(chaiAsPromised);

const sandbox = sinon.createSandbox();

const baseURL = 'https://spacecat.com';
const baseURL = 'http://spacecat.com';
const auditUrl = 'www.spacecat.com';
const DOMAIN_REQUEST_DEFAULT_PARAMS = {
domain: auditUrl,
Expand All @@ -49,6 +49,7 @@ describe('CWVRunner Tests', () => {
getBaseURL: sandbox.stub().returns(baseURL),
getConfig: () => siteConfig,
getDeliveryType: sandbox.stub().returns('aem_cs'),
isAutoSuggestEnabled: sandbox.stub().returns(true),
hasProductEntitlement: sandbox.stub().resolves(true),
};

Expand All @@ -69,11 +70,31 @@ describe('CWVRunner Tests', () => {
isHandlerEnabledForSite: () => true,
}),
},
Opportunity: {
allBySiteIdAndStatus: sandbox.stub(),
create: sandbox.stub(),
find: sandbox.stub().resolves([]),
update: sandbox.stub().resolves({}),
},
Suggestion: {
bulkUpdateStatus: sandbox.stub(),
},
Markdown: {
fromS3: sandbox.stub(),
},
getAuditForSite: sandbox.stub(),
},
sqs: {
sendMessage: sandbox.stub().resolves(),
},
env: {
QUEUE_SPACECAT_TO_MYSTIQUE: 'test-queue',
},
env: {},
log: {
debug: sinon.stub(),
info: sinon.stub(),
error: sinon.stub(),
warn: sinon.stub(),
},
};

Expand Down Expand Up @@ -124,6 +145,8 @@ describe('CWVRunner Tests', () => {
context.dataAccess.Opportunity = {
allBySiteIdAndStatus: sandbox.stub(),
create: sandbox.stub(),
find: sandbox.stub().resolves([]),
update: sandbox.stub().resolves({}),
};

context.dataAccess.Suggestion = {
Expand Down Expand Up @@ -163,6 +186,7 @@ describe('CWVRunner Tests', () => {
siteId: 'site-id',
auditId: 'audit-id',
opportunityId: 'oppty-id',
syncSuggestions: sandbox.stub().resolves(),
};

auditData = {
Expand Down Expand Up @@ -291,90 +315,74 @@ describe('CWVRunner Tests', () => {
});

it('calls sendSQSMessageForAutoSuggest when suggestions have no guidance', async () => {
// Mock suggestions without guidance (empty issues array)
const mockSuggestions = [
{ getData: () => ({ type: 'url', url: 'test1', issues: [] }), getStatus: () => 'NEW' },
{ getData: () => ({ type: 'url', url: 'test2', issues: [] }), getStatus: () => 'NEW' }
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/developer/block-collection', issues: [] }), getStatus: () => 'NEW', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/docs/', issues: [] }), getStatus: () => 'NEW', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/tools/rum/explorer.html', issues: [] }), getStatus: () => 'NEW', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
];

// Setup opportunity with mock suggestions before the function call
oppty.getSuggestions = sandbox.stub().resolves(mockSuggestions);

context.dataAccess.Opportunity.allBySiteIdAndStatus.resolves([]);
oppty.getSuggestions.resolves(mockSuggestions);
context.dataAccess.Opportunity.allBySiteIdAndStatus.resolves([oppty]);
context.dataAccess.Opportunity.create.resolves(oppty);
sinon.stub(GoogleClient, 'createFrom').resolves({});

await opportunityAndSuggestions(auditUrl, auditData, context, site);

// Verify that SQS sendMessage was called
expect(context.sqs.sendMessage).to.have.been.calledOnce;
const message = context.sqs.sendMessage.firstCall.args[1];
expect(message.type).to.equal('guidance:cwv-analysis');
expect(message.siteId).to.equal('site-id');
const urlEntries = auditData.auditResult.cwv.filter((entry) => entry.type === 'url');
expect(context.sqs.sendMessage.callCount).to.equal(urlEntries.length);
});

it('does not call sendSQSMessageForAutoSuggest when all suggestions have guidance', async () => {
// Mock suggestions with existing guidance
const mockSuggestions = [
{
getData: () => ({
type: 'url',
url: 'test1',
issues: [
{ type: 'lcp', value: '# LCP Optimization\n\nYour LCP is too slow...' }
]
}),
getStatus: () => 'NEW'
}
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/developer/block-collection', issues: ['issue1'] }), getStatus: () => 'EXISTING', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/docs/', issues: ['issue2'] }), getStatus: () => 'EXISTING', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/tools/rum/explorer.html', issues: ['issue3'] }), getStatus: () => 'EXISTING', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
];

// Setup opportunity with mock suggestions before the function call
oppty.getSuggestions = sandbox.stub().resolves(mockSuggestions);

context.dataAccess.Opportunity.allBySiteIdAndStatus.resolves([]);
oppty.getSuggestions.resolves(mockSuggestions);
context.dataAccess.Opportunity.allBySiteIdAndStatus.resolves([oppty]);

context.dataAccess.Opportunity.create.resolves(oppty);
sinon.stub(GoogleClient, 'createFrom').resolves({});

await opportunityAndSuggestions(auditUrl, auditData, context, site);

// Verify that SQS sendMessage was NOT called
expect(context.sqs.sendMessage).to.not.have.been.called;
});

it('calls sendSQSMessageForAutoSuggest when some suggestions have guidance and some do not', async () => {
// Mock mixed suggestions - some with guidance, some without

const mockSuggestions = [
{
getData: () => ({
type: 'url',
url: 'test1',
issues: [
{ type: 'lcp', value: '# LCP Optimization...' }
]
}),
getStatus: () => 'NEW'
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/developer/block-collection', issues: ['issue1'] }), getStatus: () => 'NEW', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/docs/', issues: [] }), getStatus: () => 'NEW', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({ type: 'url', url: 'https://www.aem.live/tools/rum/explorer.html', issues: [] }), getStatus: () => 'NEW', setData: sandbox.stub(), setStatus: sandbox.stub(), setUpdatedBy: sandbox.stub(), save: sandbox.stub(),
},
{
getData: () => ({
type: 'url',
url: 'test2',
issues: [] // No guidance (empty issues array)
}),
getStatus: () => 'NEW'
}
];

// Setup opportunity with mock suggestions before the function call
oppty.getSuggestions = sandbox.stub().resolves(mockSuggestions);

context.dataAccess.Opportunity.allBySiteIdAndStatus.resolves([]);
oppty.getSuggestions.resolves(mockSuggestions);
context.dataAccess.Opportunity.allBySiteIdAndStatus.resolves([oppty]);

context.dataAccess.Opportunity.create.resolves(oppty);
sinon.stub(GoogleClient, 'createFrom').resolves({});

await opportunityAndSuggestions(auditUrl, auditData, context, site);

// Verify that SQS sendMessage was called (because at least one suggestion needs guidance)
expect(context.sqs.sendMessage).to.have.been.calledOnce;
const urlEntries = auditData.auditResult.cwv.filter((entry) => entry.type === 'url');
expect(context.sqs.sendMessage.callCount).to.equal(urlEntries.length);
});
});
});
Loading