feat: migrate to v2 data access

src/backlinks/handler.js

@@ -63,6 +63,9 @@ export async function filterOutValidBacklinks(backlinks, log) {
 export default async function auditBrokenBacklinks(message, context) {
   const { type, auditContext = {} } = message;
   const { dataAccess, log, sqs } = context;
+  const {
+    Audit, Configuration, Opportunity, SiteTopPage,
+  } = dataAccess;
   const {
     AUDIT_RESULTS_QUEUE_URL: queueUrl,
   } = context.env;
@@ -73,11 +76,11 @@ export default async function auditBrokenBacklinks(message, context) {
     if (!site) {
       return notFound('Site not found');
     }
-    if (!site.isLive()) {
+    if (!site.getIsLive()) {
       log.info(`Site ${siteId} is not live`);
       return ok();
     }
-    const configuration = await dataAccess.getConfiguration();
+    const configuration = await Configuration.findLatest();
     if (!configuration.isHandlerEnabledForSite(type, site)) {
       log.info(`Audit type ${type} disabled for site ${siteId}`);
       return ok();
@@ -104,10 +107,10 @@ export default async function auditBrokenBacklinks(message, context) {
 
       if (configuration.isHandlerEnabledForSite(`${type}-auto-suggest`, site)) {
         try {
-          const topPages = await dataAccess.getTopPagesForSite(siteId, 'ahrefs', 'global');
+          const topPages = await SiteTopPage.allBySiteIdAndSourceAndGeo(siteId, 'ahrefs', 'global');
           const keywords = topPages.map(
             (page) => ({
-              url: page.getURL(),
+              url: page.getUrl(),
               keyword: page.getTopKeyword(),
               traffic: page.getTraffic(),
             }),
@@ -132,14 +135,14 @@ export default async function auditBrokenBacklinks(message, context) {
     }
     const auditData = {
       siteId: site.getId(),
-      isLive: site.isLive(),
+      isLive: site.getIsLive(),
       auditedAt: new Date().toISOString(),
       auditType: type,
       fullAuditRef: auditResult?.fullAuditRef,
       auditResult,
     };
 
-    const audit = await dataAccess.addAudit(auditData);
+    const audit = await Audit.create(auditData);
     const result = {
       type,
       url: site.getBaseURL(),
@@ -150,7 +153,7 @@ export default async function auditBrokenBacklinks(message, context) {
     let brokenBacklinksOppty;
 
     try {
-      const opportunities = await dataAccess.Opportunity.allBySiteIdAndStatus(siteId, 'NEW');
+      const opportunities = await Opportunity.allBySiteIdAndStatus(siteId, 'NEW');
       brokenBacklinksOppty = opportunities.find((oppty) => oppty.getType() === 'broken-backlinks');
     } catch (e) {
       log.error(`Fetching opportunities for siteId ${siteId} failed with error: ${e.message}`);
@@ -179,7 +182,7 @@ export default async function auditBrokenBacklinks(message, context) {
           tags: ['Traffic acquisition'],
         };
 
-        brokenBacklinksOppty = await dataAccess.Opportunity.create(opportunityData);
+        brokenBacklinksOppty = await Opportunity.create(opportunityData);
       } else {
         brokenBacklinksOppty.setAuditId(audit.getId());
         await brokenBacklinksOppty.save();

src/canonical/handler.js

@@ -102,7 +102,8 @@ export const CANONICAL_CHECKS = Object.freeze({
  */
 export async function getTopPagesForSiteId(dataAccess, siteId, context, log) {
   try {
-    const result = await dataAccess.getTopPagesForSite(siteId, 'ahrefs', 'global');
+    const { SiteTopPage } = dataAccess;
+    const result = await SiteTopPage.allBySiteIdAndSourceAndGeo(siteId, 'ahrefs', 'global');
     log.info('Received top pages response:', JSON.stringify(result, null, 2));
 
     const topPages = result || [];

src/common/audit.js

@@ -13,20 +13,20 @@
 import { composeAuditURL, hasText } from '@adobe/spacecat-shared-utils';
 import { ok } from '@adobe/spacecat-shared-http-utils';
 import URI from 'urijs';
-import { createAudit } from '@adobe/spacecat-shared-data-access/src/models/audit.js';
 import { retrieveSiteBySiteId } from '../utils/data-access.js';
 
 // eslint-disable-next-line no-empty-function
 export async function defaultMessageSender() {}
 
 export async function defaultPersister(auditData, context) {
   const { dataAccess } = context;
-  const audit = await dataAccess.addAudit(auditData);
-  return audit;
+  const { Audit } = dataAccess;
+
+  return Audit.create(auditData);
 }
 
 export async function noopPersister(auditData) {
-  return createAudit(auditData);
+  return { getId: () => auditData.id || 'noop' };
 }
 
 export async function defaultSiteProvider(siteId, context) {
@@ -42,8 +42,9 @@ export async function defaultSiteProvider(siteId, context) {
 
 export async function defaultOrgProvider(orgId, context) {
   const { dataAccess } = context;
+  const { Organization } = dataAccess;
 
-  const org = await dataAccess.getOrganizationByID(orgId);
+  const org = await Organization.findById(orgId);
   if (!org) {
     throw new Error(`Org with id ${orgId} not found`);
   }
@@ -88,6 +89,7 @@ export class Audit {
 
   async run(message, context) {
     const { log, dataAccess } = context;
+    const { Configuration } = dataAccess;
     const {
       type,
       auditContext = {},
@@ -96,7 +98,7 @@ export class Audit {
 
     try {
       const site = await this.siteProvider(siteId, context);
-      const configuration = await dataAccess.getConfiguration();
+      const configuration = await Configuration.findLatest();
       if (!configuration.isHandlerEnabledForSite(type, site)) {
         log.warn(`${type} audits disabled for site ${siteId}, skipping...`);
         return ok();
@@ -110,7 +112,7 @@ export class Audit {
       } = await this.runner(finalUrl, context, site);
       const auditData = {
         siteId: site.getId(),
-        isLive: site.isLive(),
+        isLive: site.getIsLive(),
         auditedAt: new Date().toISOString(),
         auditType: type,
         auditResult,

src/cwv/handler.js

@@ -51,12 +51,13 @@ export async function convertToOppty(auditUrl, auditData, context, site) {
     dataAccess,
     log,
   } = context;
+  const { Opportunity } = dataAccess;
   const groupedURLs = site.getConfig().getGroupedURLs(AUDIT_TYPE);
 
   log.info(`auditUrl: ${auditUrl}`);
   log.info(`auditData: ${JSON.stringify(auditData)}`);
 
-  const opportunities = await dataAccess.Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
+  const opportunities = await Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
   log.info(`opportunities: ${JSON.stringify(opportunities)}`);
 
   let opportunity = opportunities.find((oppty) => oppty.getType() === AUDIT_TYPE);
@@ -89,7 +90,7 @@ export async function convertToOppty(auditUrl, auditData, context, site) {
       },
     };
     try {
-      opportunity = await dataAccess.Opportunity.create(opportunityData);
+      opportunity = await Opportunity.create(opportunityData);
     } catch (e) {
       log.error(`Failed to create new opportunity for siteId ${auditData.siteId} and auditId ${auditData.id}: ${e.message}`);
       throw e;

src/experimentation-ess/all.js

@@ -23,7 +23,8 @@ async function persistOnlyMetadata(auditData, context) {
   // persists only the audit metadata, as the
   // whole audit result will be bigger than the allowed size in dynamo
   const { dataAccess } = context;
-  await dataAccess.addAudit({
+  const { Audit } = dataAccess;
+  await Audit.create({
     ...auditData,
     auditResult: [], // deliberately overrides the result
   });
@@ -32,12 +33,13 @@ async function persistOnlyMetadata(auditData, context) {
 export async function essExperimentationAllAuditRunner(auditUrl, context, site) {
   log = context.log;
   const { dataAccess } = context;
+  const { Experiment, LatestAudit } = dataAccess;
   const siteId = site.getId();
   log.info(`Received ESS Experimentation All audit request for ${auditUrl}`);
   const startTime = process.hrtime();
 
-  const latestAudit = await dataAccess.getLatestAuditForSite(siteId, 'experimentation-ess-all');
-  const experiments = await dataAccess.getExperiments(siteId);
+  const latestAudit = await LatestAudit.findBySiteIdAndAuditType(siteId, 'experimentation-ess-all');
+  const experiments = await Experiment.allBySiteId(siteId);
   const activeExperiments = experiments.filter((experiment) => (
     experiment.getStatus() && experiment.getStatus().toLowerCase() === 'active' && experiment.getStartDate() !== null));
   let days;

src/experimentation-ess/common.js

@@ -666,12 +666,13 @@ export async function processAudit(auditURL, context, site, days) {
 
 export async function postProcessor(auditUrl, auditData, context) {
   const { dataAccess } = context;
+  const { Experiment } = dataAccess;
   log = context.log;
   // iterate array auditData.auditResult
   for (const experiment of auditData.auditResult) {
     const experimentData = {
       siteId: auditData.siteId,
-      experimentId: experiment.id,
+      expId: experiment.id,
       name: experiment.label,
       url: experiment.url,
       startDate: experiment.startDate,
@@ -683,7 +684,10 @@ export async function postProcessor(auditUrl, auditData, context) {
       conversionEventValue: experiment.conversionEventValue,
     };
     // eslint-disable-next-line no-await-in-loop
-    const existingExperiments = await dataAccess.getExperiments(auditData.siteId, experiment.id);
+    const existingExperiments = await Experiment.allBySiteIdAndExpId(
+      auditData.siteId,
+      experiment.id,
+    );
     let existingExperiment;
     if (existingExperiments) {
       if (existingExperiments.length === 1) {
@@ -720,7 +724,7 @@ export async function postProcessor(auditUrl, auditData, context) {
       }
     }
     // eslint-disable-next-line no-await-in-loop
-    await dataAccess.upsertExperiment(experimentData);
+    await Experiment.create(experimentData);
   }
   log.info(`Experiments data for site ${auditData.siteId} has been upserted`);
 }

src/experimentation-opportunities/experimentation-opportunities.js

@@ -323,9 +323,10 @@ function convertToOpportunityEntity(oppty, auditData) {
 export async function postProcessor(auditUrl, auditData, context) {
   const { log } = context;
   const { dataAccess } = context;
+  const { Opportunity } = dataAccess;
   let updatedEntities = 0;
   log.info(`Experimentation Opportunities post processing started for ${auditUrl} from audit ${auditData.id}`);
-  const existingOpportunities = await dataAccess.Opportunity.allBySiteId(auditData.siteId);
+  const existingOpportunities = await Opportunity.allBySiteId(auditData.siteId);
 
   // Get opportunities with recommendations
   const opportunities = auditData.auditResult.experimentationOpportunities

src/internal-links/handler.js

@@ -101,10 +101,11 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
     dataAccess,
     log,
   } = context;
+  const { Opportunity } = dataAccess;
 
   let opportunity;
   try {
-    const opportunities = await dataAccess.Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
+    const opportunities = await Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
     opportunity = opportunities.find((oppty) => oppty.getType() === AUDIT_TYPE);
   } catch (e) {
     log.error(`Fetching opportunities for siteId ${auditData.siteId} failed with error: ${e.message}`);
@@ -133,7 +134,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
           'Engagement',
         ],
       };
-      opportunity = await dataAccess.Opportunity.create(opportunityData);
+      opportunity = await Opportunity.create(opportunityData);
     } else {
       opportunity.setAuditId(auditData.id);
       await opportunity.save();

src/metatags/handler.js

@@ -41,18 +41,19 @@ export default async function auditMetaTags(message, context) {
   const {
     dataAccess, log, s3Client,
   } = context;
+  const { Audit, Configuration } = dataAccess;
 
   try {
     log.info(`Received ${type} audit request for siteId: ${siteId}`);
     const site = await retrieveSiteBySiteId(dataAccess, siteId, log);
     if (!site) {
       return notFound('Site not found');
     }
-    if (!site.isLive()) {
+    if (!site.getIsLive()) {
       log.info(`Site ${siteId} is not live`);
       return ok();
     }
-    const configuration = await dataAccess.getConfiguration();
+    const configuration = await Configuration.findLatest();
     if (!configuration.isHandlerEnabledForSite(type, site)) {
       log.info(`Audit type ${type} disabled for site ${siteId}`);
       return ok();
@@ -98,14 +99,14 @@ export default async function auditMetaTags(message, context) {
     };
     const auditData = {
       siteId: site.getId(),
-      isLive: site.isLive(),
+      isLive: site.getIsLive(),
       auditedAt: new Date().toISOString(),
       auditType: type,
       fullAuditRef: auditResult?.fullAuditRef,
       auditResult,
     };
     // Persist Audit result
-    const audit = await dataAccess.addAudit(auditData);
+    const audit = await Audit.create(auditData);
     log.info(`Successfully audited ${siteId} for ${type} type audit`);
     await syncOpportunityAndSuggestions(
       siteId,

src/metatags/opportunityHandler.js

@@ -155,11 +155,12 @@ export default async function syncOpportunityAndSuggestions(
   dataAccess,
   log,
 ) {
+  const { Opportunity } = dataAccess;
   log.info(`Syncing opportunity and suggestions for ${siteId}`);
   let metatagsOppty;
   try {
     // Get all opportunities by site-id and new status
-    const opportunities = await dataAccess.Opportunity.allBySiteIdAndStatus(siteId, 'NEW');
+    const opportunities = await Opportunity.allBySiteIdAndStatus(siteId, 'NEW');
     // Find existing opportunity for meta-tags
     metatagsOppty = opportunities.find((oppty) => oppty.getType() === 'meta-tags');
   } catch (e) {
@@ -188,7 +189,7 @@ export default async function syncOpportunityAndSuggestions(
         },
         tags: ['Traffic acquisition'],
       };
-      metatagsOppty = await dataAccess.Opportunity.create(opportunityData);
+      metatagsOppty = await Opportunity.create(opportunityData);
       log.debug('Meta-tags Opportunity created');
     } else {
       metatagsOppty.setAuditId(auditId);

src/site-detection/handler.js

@@ -161,6 +161,7 @@ export async function siteDetectionRunner(_, context) {
     env,
     log,
   } = context;
+  const { Site, SiteCandidate } = dataAccess;
   const {
     CORALOGIX_API_KEY: authorization,
     SITE_DETECTION_WEBHOOK: siteDetectionWebHook,
@@ -173,8 +174,8 @@ export async function siteDetectionRunner(_, context) {
     ignoredSubdomains,
   };
 
-  const sites = await dataAccess.getSites();
-  const siteCandidates = await dataAccess.getSiteCandidates();
+  const sites = await Site.all();
+  const siteCandidates = await SiteCandidate.all();
 
   const knownHosts = new Set([...sites, ...siteCandidates]
     .map((s) => s.getBaseURL())

src/sitemap/handler.js

@@ -472,6 +472,7 @@ export function classifySuggestions(auditUrl, auditData, log) {
 
 export async function convertToOpportunity(auditUrl, auditData, context) {
   const { dataAccess, log } = context;
+  const { Opportunity } = dataAccess;
 
   log.info('Converting SITEMAP audit to opportunity...');
 
@@ -481,7 +482,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
     return;
   }
 
-  const opportunities = await dataAccess.Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
+  const opportunities = await Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
   log.info(`opportunities: ${JSON.stringify(opportunities)}`);
 
   let opportunity = opportunities.find((oppty) => oppty.getType() === AUDIT_TYPE);
@@ -504,7 +505,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
       tags: ['Traffic Acquisition'],
     };
     try {
-      opportunity = await dataAccess.Opportunity.create(opportunityData);
+      opportunity = await Opportunity.create(opportunityData);
     } catch (e) {
       log.error(`Failed to create new opportunity for siteId ${auditData.siteId} and auditId ${auditData.id}: ${e.message}`, e);
       throw e;

src/structured-data/handler.js

@@ -105,8 +105,9 @@ export async function processStructuredData(baseURL, context, pages) {
 
 export async function convertToOpportunity(auditUrl, auditData, context) {
   const { dataAccess, log } = context;
+  const { Opportunity } = dataAccess;
 
-  const opportunities = await dataAccess.Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
+  const opportunities = await Opportunity.allBySiteIdAndStatus(auditData.siteId, 'NEW');
   let opportunity = opportunities.find((oppty) => oppty.getType() === 'structured-data');
 
   if (!opportunity) {
@@ -124,7 +125,7 @@ export async function convertToOpportunity(auditUrl, auditData, context) {
       tags: ['Traffic acquisition'],
     };
     try {
-      opportunity = await dataAccess.Opportunity.create(opportunityData);
+      opportunity = await Opportunity.create(opportunityData);
     } catch (e) {
       log.error(`Failed to create new opportunity for siteId ${auditData.siteId} and auditId ${auditData.id}: ${e.message}`);
       throw e;