@adobe/spacecat-shared-data-access 1.4.3 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.5.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.4.4...@adobe/spacecat-shared-data-access-v1.5.0) (2023-12-26)
+
+
+### Features
+
+* store previous latest audit result ([#74](https://github.com/adobe-rnd/spacecat-shared/issues/74)) ([4663c43](https://github.com/adobe-rnd/spacecat-shared/commit/4663c4344e260f85c4e64691e0685260d36629e5))
+
+# [@adobe/spacecat-shared-data-access-v1.4.4](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.4.3...@adobe/spacecat-shared-data-access-v1.4.4) (2023-12-25)
+
+
+### Bug Fixes
+
+* add missing pattern to interface ([#72](https://github.com/adobe-rnd/spacecat-shared/issues/72)) ([0eacbff](https://github.com/adobe-rnd/spacecat-shared/commit/0eacbff39dbc12d604e40ae94285533f7804ca0a))
+
 # [@adobe/spacecat-shared-data-access-v1.4.3](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.4.2...@adobe/spacecat-shared-data-access-v1.4.3) (2023-12-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",

package/src/dto/audit.js

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { isObject } from '@adobe/spacecat-shared-utils';
+
 import { createAudit } from '../models/audit.js';
 
 function parseEpochToDate(epochInSeconds) {
@@ -28,10 +30,10 @@ export const AuditDto = {
   /**
    * Converts an Audit object into a DynamoDB item.
    * @param {Readonly<Audit>} audit - Audit object.
-   * @param {boolean} latestAudit - If true, returns the latest audit flavor.
+   * @param {boolean} isLatestAudit - If true, returns the latest audit flavor.
    * @returns {{siteId, auditedAt, auditResult, auditType, expiresAt, fullAuditRef, SK: string}}
    */
-  toDynamoItem: (audit, latestAudit = false) => {
+  toDynamoItem: (audit, isLatestAudit = false) => {
     const GSI1PK = 'ALL_LATEST_AUDITS';
     let GSI1SK;
 
@@ -41,7 +43,12 @@ export const AuditDto = {
       GSI1SK = `${audit.getAuditType()}#${Object.values(audit.getScores()).join('#')}`;
     }
 
-    const latestAuditProps = latestAudit ? { GSI1PK, GSI1SK } : {};
+    const latestAuditProps = isLatestAudit ? {
+      GSI1PK,
+      GSI1SK,
+      ...(isObject(audit.getPreviousAuditResult())
+          && { previousAuditResult: audit.getPreviousAuditResult() }),
+    } : {};
 
     return {
       siteId: audit.getSiteId(),
@@ -70,6 +77,8 @@ export const AuditDto = {
       expiresAt: parseEpochToDate(dynamoItem.expiresAt),
       fullAuditRef: dynamoItem.fullAuditRef,
       isLive: dynamoItem.isLive,
+      ...(isObject(dynamoItem.previousAuditResult)
+          && { previousAuditResult: dynamoItem.previousAuditResult }),
     };
 
     return createAudit(auditData);

package/src/index.d.ts

@@ -34,6 +34,19 @@ export interface Audit {
    */
   getAuditResult: () => object;
 
+  /**
+   * Retrieves the result of the previous audit.
+   * This serves for comparison purposes.
+   * @returns {object|null} The parsed audit result.
+   */
+  getPreviousAuditResult: () => object | null;
+
+/**
+ * Sets the result of the previous audit.
+ * @param {object} result The parsed audit result.
+ */
+  setPreviousAuditResult: (result: object) => void;
+
   /**
    * Retrieves the type of the audit.
    * @returns {object} The audit type.
@@ -195,6 +208,11 @@ export interface Site {
 }
 
 export interface DataAccess {
+  getAuditForSite: (
+    sitedId: string,
+    auditType: string,
+    auditedAt: string,
+  ) => Promise<Audit | null>;
   getAuditsForSite: (
     siteId: string,
     auditType?: string,

package/src/models/audit.js

@@ -36,6 +36,10 @@ const validateScores = (auditResult, auditType) => {
     return true;
   }
 
+  if (!isObject(auditResult.scores)) {
+    throw new Error(`Missing scores property for audit type '${auditType}'`);
+  }
+
   const expectedProperties = AUDIT_TYPE_PROPERTIES[auditType];
   if (!expectedProperties) {
     throw new Error(`Unknown audit type: ${auditType}`);
@@ -66,6 +70,11 @@ const Audit = (data = {}) => {
   self.getFullAuditRef = () => self.state.fullAuditRef;
   self.isLive = () => self.state.isLive;
   self.isError = () => hasText(self.getAuditResult().runtimeError?.code);
+  self.getPreviousAuditResult = () => self.state.previousAuditResult;
+  self.setPreviousAuditResult = (previousAuditResult) => {
+    validateScores(previousAuditResult, self.getAuditType());
+    self.state.previousAuditResult = previousAuditResult;
+  };
   self.getScores = () => self.getAuditResult().scores;
 
   return Object.freeze(self);
@@ -98,6 +107,14 @@ export const createAudit = (data) => {
 
   validateScores(data.auditResult, data.auditType);
 
+  if (data.previousAuditResult && !isObject(data.previousAuditResult)) {
+    throw new Error('Previous audit result must be an object');
+  }
+
+  if (data.previousAuditResult) {
+    validateScores(data.previousAuditResult, data.auditType);
+  }
+
   if (!hasText(newState.fullAuditRef)) {
     throw new Error('Full audit ref must be provided');
   }

package/src/service/audits/accessPatterns.js

@@ -184,25 +184,40 @@ export const addAudit = async (
   log,
   auditData,
 ) => {
-  const audit = createAudit(auditData);
+  const newAudit = createAudit(auditData);
   const existingAudit = await getAuditForSite(
     dynamoClient,
     config,
     log,
-    audit.getSiteId(),
-    audit.getAuditType(),
-    audit.getAuditedAt(),
+    newAudit.getSiteId(),
+    newAudit.getAuditType(),
+    newAudit.getAuditedAt(),
   );
 
   if (isObject(existingAudit)) {
     throw new Error('Audit already exists');
   }
 
+  const latestAudit = await getLatestAuditForSite(
+    dynamoClient,
+    config,
+    log,
+    newAudit.getSiteId(),
+    newAudit.getAuditType(),
+  );
+
+  if (isObject(latestAudit)) {
+    newAudit.setPreviousAuditResult(latestAudit.getAuditResult());
+  }
+
   // TODO: Add transaction support
-  await dynamoClient.putItem(config.tableNameAudits, AuditDto.toDynamoItem(audit));
-  await dynamoClient.putItem(config.tableNameLatestAudits, AuditDto.toDynamoItem(audit, true));
+  await dynamoClient.putItem(config.tableNameAudits, AuditDto.toDynamoItem(newAudit));
+  await dynamoClient.putItem(
+    config.tableNameLatestAudits,
+    AuditDto.toDynamoItem(newAudit, true),
+  );
 
-  return audit;
+  return newAudit;
 };
 
 /**