feat: migrate to v2 data access (#654)

Co-authored-by: Damian Zehnder <[email protected]>
adobe · Jan 3, 2025 · 5e369a0 · 5e369a0
1 parent ba76aa1
commit 5e369a0
Show file tree

Hide file tree

Showing 69 changed files with 1,733 additions and 1,404 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,4 +1,4 @@
-name: CI
+name: Build
 
 permissions:
   id-token: write
@@ -24,6 +24,9 @@ jobs:
         with:
           node-version: 22.12
 
+      - name: Update NPM
+        run: npm install -g [email protected]
+
       - name: Install dependencies
         run: npm ci
 
@@ -58,6 +61,9 @@ jobs:
         with:
           node-version: 22.12
 
+      - name: Update NPM
+        run: npm install -g [email protected]
+
       - name: Install dependencies
         run: npm ci
 
@@ -100,6 +106,9 @@ jobs:
         with:
           node-version: 22.12
 
+      - name: Update NPM
+        run: npm install -g [email protected]
+
       - name: Install dependencies
         run: npm ci
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,8 +5,8 @@
   "main": "src/index.js",
   "type": "module",
   "engines": {
-    "node": ">=20.0.0 <23.0.0",
-    "npm": ">=10.0.0 <12.0.0"
+    "node": ">=22.0.0 <23.0.0",
+    "npm": ">=10.9.0 <12.0.0"
   },
   "scripts": {
     "start": "nodemon",

diff --git a/src/controllers/api-key.js b/src/controllers/api-key.js
@@ -40,6 +40,7 @@ function ApiKeyController(context) {
   const {
     dataAccess, log, env, attributes, imsClient,
   } = context;
+  const { ApiKey } = dataAccess;
 
   let apiKeyConfiguration = {};
   try {
@@ -159,7 +160,7 @@ function ApiKeyController(context) {
 
       // Check whether the user has already created the maximum number of
       // active API keys for the given imsOrgId.
-      const apiKeys = await dataAccess.getApiKeysByImsUserIdAndImsOrgId(imsUserId, imsOrgId);
+      const apiKeys = await ApiKey.allByImsOrgIdAndImsUserId(imsOrgId, imsUserId);
 
       const validApiKeys = apiKeys.filter(
         (apiKey) => apiKey.isValid(),
@@ -200,8 +201,7 @@ function ApiKeyController(context) {
       const expiresAt = new Date();
       expiresAt.setMonth(expiresAt.getMonth() + 6);
 
-      const apiKeyEntity = await dataAccess.createNewApiKey({
-        id: crypto.randomUUID(),
+      const apiKeyEntity = await ApiKey.create({
         name: data.name,
         scopes,
         createdAt: new Date().toISOString(),
@@ -230,7 +230,7 @@ function ApiKeyController(context) {
     try {
       const imsUserToken = getImsUserToken(headers);
       await validateImsOrgId(imsOrgId, imsUserToken);
-      const apiKeyEntity = await dataAccess.getApiKeyById(id);
+      const apiKeyEntity = await ApiKey.findById(id);
       const { authInfo: { profile } } = attributes;
 
       const imsUserId = getImsUserIdFromProfile(profile);
@@ -239,9 +239,9 @@ function ApiKeyController(context) {
         throw new ErrorWithStatusCode('Invalid request: API key not found', STATUS_NOT_FOUND);
       }
 
-      apiKeyEntity.updateDeletedAt(new Date().toISOString());
+      apiKeyEntity.setDeletedAt(new Date().toISOString());
 
-      await dataAccess.updateApiKey(apiKeyEntity);
+      await apiKeyEntity.save();
       return createResponse({}, STATUS_NO_CONTENT);
     } catch (error) {
       log.error(`Failed to delete the api key with id: ${id} - ${error.message}`);
@@ -264,7 +264,7 @@ function ApiKeyController(context) {
       const { authInfo: { profile } } = attributes;
 
       const imsUserId = getImsUserIdFromProfile(profile);
-      const apiKeys = await dataAccess.getApiKeysByImsUserIdAndImsOrgId(imsUserId, imsOrgId);
+      const apiKeys = await ApiKey.allByImsOrgIdAndImsUserId(imsOrgId, imsUserId);
       return ok(apiKeys.map((apiKey) => ApiKeyDto.toJSON(apiKey)));
     } catch (error) {
       log.error(`Failed to retrieve the api keys - ${error.message}`);

diff --git a/src/controllers/audits.js b/src/controllers/audits.js
@@ -31,6 +31,10 @@ function AuditsController(dataAccess) {
     throw new Error('Data access required');
   }
 
+  const {
+    Audit, Configuration, LatestAudit, Site,
+  } = dataAccess;
+
   /**
    * Gets all audits for a given site and audit type. If no audit type is specified,
    * all audits are returned.
@@ -40,14 +44,16 @@ function AuditsController(dataAccess) {
   const getAllForSite = async (context) => {
     const siteId = context.params?.siteId;
     const auditType = context.params?.auditType || undefined;
-    const ascending = context.data?.ascending === 'true' || false;
+    const order = context.data?.ascending === 'true' ? 'asc' : 'desc';
 
     if (!hasText(siteId)) {
       return badRequest('Site ID required');
     }
 
-    const audits = (await dataAccess.getAuditsForSite(siteId, auditType, ascending))
-      .map((audit) => AuditDto.toAbbreviatedJSON(audit));
+    const method = auditType
+      ? Audit.allBySiteIdAndAuditType(siteId, auditType, { order })
+      : Audit.allBySiteId(siteId, { order });
+    const audits = ((await method).map((audit) => AuditDto.toAbbreviatedJSON(audit)));
 
     return ok(audits);
   };
@@ -60,13 +66,13 @@ function AuditsController(dataAccess) {
    */
   const getAllLatest = async (context) => {
     const auditType = context.params?.auditType;
-    const ascending = context.data?.ascending === 'true' || false;
+    const order = context.data?.ascending === 'true' ? 'asc' : 'desc';
 
     if (!hasText(auditType)) {
       return badRequest('Audit type required');
     }
 
-    const audits = (await dataAccess.getLatestAudits(auditType, ascending))
+    const audits = (await LatestAudit.allByAuditType(auditType, { order }))
       .map((audit) => AuditDto.toAbbreviatedJSON(audit));
 
     return ok(audits);
@@ -83,7 +89,7 @@ function AuditsController(dataAccess) {
       return badRequest('Site ID required');
     }
 
-    const audits = (await dataAccess.getLatestAuditsForSite(siteId))
+    const audits = (await LatestAudit.allBySiteId(siteId))
       .map((audit) => AuditDto.toJSON(audit));
 
     return ok(audits);
@@ -105,7 +111,7 @@ function AuditsController(dataAccess) {
       return badRequest('Audit type required');
     }
 
-    const audit = await dataAccess.getLatestAuditForSite(siteId, auditType);
+    const audit = await LatestAudit.allBySiteIdAndAuditType(siteId, auditType);
     if (!audit) {
       return notFound('Audit not found');
     }
@@ -150,12 +156,12 @@ function AuditsController(dataAccess) {
     const { excludedURLs, manualOverwrites, groupedURLs } = context.data;
     let hasUpdates = false;
 
-    const site = await dataAccess.getSiteByID(siteId);
+    const site = await Site.findById(siteId);
     if (!site) {
       return notFound('Site not found');
     }
 
-    const configuration = await dataAccess.getConfiguration();
+    const configuration = await Configuration.findLatest();
     const registeredAudits = configuration.getHandlers();
     if (!registeredAudits[auditType]) {
       return notFound(`The "${auditType}" is not present in the configuration. List of allowed audits:`
@@ -231,8 +237,8 @@ function AuditsController(dataAccess) {
 
     if (hasUpdates) {
       const configObj = Config.toDynamoItem(siteConfig);
-      site.updateConfig(configObj);
-      await dataAccess.updateSite(site);
+      site.setConfig(configObj);
+      await site.save();
       const auditConfig = siteConfig.getHandlerConfig(auditType);
       return ok(auditConfig);
     }

diff --git a/src/controllers/configuration.js b/src/controllers/configuration.js
@@ -27,12 +27,14 @@ function ConfigurationController(dataAccess) {
     throw new Error('Data access required');
   }
 
+  const { Configuration } = dataAccess;
+
   /**
    * Retrieves all configurations (all versions).
    * @return {Promise<Response>} Array of configurations.
    */
   const getAll = async () => {
-    const configurations = (await dataAccess.getConfigurations())
+    const configurations = (await Configuration.all())
       .map((configuration) => ConfigurationDto.toJSON(configuration));
     return ok(configurations);
   };
@@ -49,7 +51,7 @@ function ConfigurationController(dataAccess) {
       return badRequest('Configuration version required to be an integer');
     }
 
-    const configuration = await dataAccess.getConfigurationByVersion(configurationVersion);
+    const configuration = await Configuration.findByVersion(configurationVersion);
     if (!configuration) {
       return notFound('Configuration not found');
     }
@@ -62,7 +64,7 @@ function ConfigurationController(dataAccess) {
    * @return {Promise<Response>} Configuration response.
    */
   const getLatest = async () => {
-    const configuration = await dataAccess.getConfiguration();
+    const configuration = await Configuration.findLatest();
     if (!configuration) {
       return notFound('Configuration not found');
     }

diff --git a/src/controllers/experiments.js b/src/controllers/experiments.js
@@ -30,6 +30,8 @@ function ExperimentsController(dataAccess) {
     throw new Error('Data access required');
   }
 
+  const { Experiment } = dataAccess;
+
   /**
    * Gets all experiments for a given site
    *
@@ -42,7 +44,7 @@ function ExperimentsController(dataAccess) {
       return badRequest('Site ID required');
     }
 
-    const experiments = (await dataAccess.getExperiments(siteId))
+    const experiments = (await Experiment.allBySiteId(siteId))
       .map((experiment) => ExperimentDto.toJSON(experiment));
 
     return ok(experiments);

diff --git a/src/controllers/hooks.js b/src/controllers/hooks.js
@@ -331,6 +331,7 @@ const getConfigFromContext = (lambdaContext) => {
  */
 function HooksController(lambdaContext) {
   const { dataAccess } = lambdaContext;
+  const { Site, SiteCandidate } = dataAccess;
   const config = getConfigFromContext(lambdaContext);
 
   async function processSiteCandidate(domain, source, log, hlxConfig = {}) {
@@ -345,7 +346,7 @@ function HooksController(lambdaContext) {
       hlxConfig,
     };
 
-    const site = await dataAccess.getSiteByBaseURL(siteCandidate.baseURL);
+    const site = await Site.findByBaseURL(siteCandidate.baseURL);
 
     // discard the site candidate if the site exists in sites db with deliveryType=aem_edge
     if (site && site.getDeliveryType() === DELIVERY_TYPES.AEM_EDGE) {
@@ -358,8 +359,8 @@ function HooksController(lambdaContext) {
         const hlxConfigChanged = !deepEqual(siteHlxConfig, candidateHlxConfig);
 
         if (hlxConfigChanged) {
-          site.updateHlxConfig(siteCandidate.hlxConfig);
-          await dataAccess.updateSite(site);
+          site.setHlxConfig(siteCandidate.hlxConfig);
+          await site.save();
 
           const action = siteHasHlxConfig && hlxConfigChanged ? 'updated' : 'added';
           log.info(`HLX config ${action} for existing site: *<${baseURL}|${baseURL}>*${getHlxConfigMessagePart(hlxConfig)}`);
@@ -369,12 +370,12 @@ function HooksController(lambdaContext) {
     }
 
     // discard the site candidate if previously evaluated
-    const isPreviouslyEvaluated = await dataAccess.siteCandidateExists(siteCandidate.baseURL);
-    if (isPreviouslyEvaluated) {
+    const isPreviouslyEvaluated = await SiteCandidate.findByBaseURL(siteCandidate.baseURL);
+    if (isPreviouslyEvaluated !== null) {
       throw new InvalidSiteCandidate('Site candidate previously evaluated', baseURL);
     }
 
-    await dataAccess.upsertSiteCandidate(siteCandidate);
+    await SiteCandidate.create(siteCandidate);
 
     return baseURL;
   }