feat: init db wrapper

.gitignore

@@ -9,3 +9,4 @@ logs
 test-results.xml
 .env
 .idea/
+.npmrc

package.json

@@ -50,7 +50,8 @@
     "require": "test/setup-env.js",
     "recursive": "true",
     "reporter": "mocha-multi-reporters",
-    "reporter-options": "configFile=.mocha-multi.json"
+    "reporter-options": "configFile=.mocha-multi.json",
+    "loader": "esmock"
   },
   "dependencies": {
     "@adobe/fetch": "^4.1.0",

src/util.js → src/db-wrapper.js

@@ -9,25 +9,17 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const log = (level, message, ...args) => {
-  const timestamp = new Date().toISOString();
 
-  switch (level) {
-    case 'info':
-      console.info(`[${timestamp}] INFO: ${message}`, ...args);
-      break;
-    case 'error':
-      console.error(`[${timestamp}] ERROR: ${message}`, ...args);
-      break;
-    case 'warn':
-      console.warn(`[${timestamp}] WARN: ${message}`, ...args);
-      break;
-    default:
-      console.log(`[${timestamp}] ${message}`, ...args);
-      break;
-  }
-};
+'use strict';
 
-export {
-  log,
-};
+import DB from './db.js';
+
+export default function dynamoDBWrapper(func) {
+  return async (request, context) => {
+    if (!context.db) {
+      context.db = new DB(context);
+    }
+
+    return func(request, context);
+  };
+}

src/db.js

@@ -10,48 +10,52 @@
  * governing permissions and limitations under the License.
  */
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { DynamoDBDocumentClient, GetItemCommand, PutCommand } from '@aws-sdk/lib-dynamodb';
-import { log } from './util.js';
+import { DynamoDBDocumentClient, GetCommand, PutCommand } from '@aws-sdk/lib-dynamodb';
 
 const TABLE_SITES = 'spacecat-site';
 const TABLE_AUDITS = 'spacecat-audit-index';
 
-function DB(config) {
-  const client = new DynamoDBClient({ region: config.region });
-  const docClient = DynamoDBDocumentClient.from(client);
+export default class DB {
+  constructor(context) {
+    this.client = new DynamoDBClient({ region: context.runtime.region });
+    this.log = context.log;
+    this.docClient = DynamoDBDocumentClient.from(this.client);
+  }
 
   /**
    * Save a record to the DynamoDB.
    * @param {object} record - The new record to save.
    * @param tableName - The name of the table to save the record to.
    */
-  async function saveRecord(record, tableName) {
+  async saveRecord(record, tableName) {
     try {
       const command = new PutCommand({
         TableName: tableName,
         Item: record,
       });
-      await docClient.send(command);
+      await this.docClient.send(command);
     } catch (error) {
-      log('error', 'Error saving record: ', error);
+      this.log.error(`Error saving record:  ${error}`);
     }
   }
+
   /**
-     * Saves an audit to the DynamoDB.
-     * @param {object} site - Site object containing details of the audited site.
-     * @param {object} audit - Audit object containing the type and result of the audit.
-     * @returns {Promise<void>} Resolves once audit is saved.
-     */
-  async function saveAuditIndex(site, audit) {
+   * Saves an audit to the DynamoDB.
+   * @param {object} site - Site object containing details of the audited site.
+   * @param {object} audit - Audit object containing the type and result of the audit.
+   * @returns {Promise<void>} Resolves once audit is saved.
+   */
+  async saveAuditIndex(site, audit) {
     const now = new Date().toISOString();
-    const uuid = Date.now().toString();
+    const uuid = Date.now()
+      .toString();
 
     const newAudit = {
       id: uuid,
-      siteId: site.id,
+      siteId: `${site.domain}/${site.path}`,
       audit_date: now,
       type: 'psi',
-      is_live: site.isLive,
+      is_live: false,
       content_publication_date: '',
       git_hashes: [],
       tag_manager: '',
@@ -77,34 +81,35 @@ function DB(config) {
         },
       ],
     };
-    log('info', `Audit for domain ${site.domain} saved successfully at ${now}`);
-    await saveRecord(newAudit, TABLE_AUDITS);
-    return newAudit;
+    await this.saveRecord(newAudit, TABLE_AUDITS);
+    this.log.info(`Audit for domain ${site.domain} saved successfully`);
+    return Promise.resolve(newAudit);
   }
 
   /**
-     * Save an error that occurred during a Lighthouse audit to the DynamoDB.
-     * @param {object} site - site audited.
-     * @param {Error} error - The error that occurred during the audit.
-     */
-  async function saveAuditError(site, error) {
+   * Save an error that occurred during a Lighthouse audit to the DynamoDB.
+   * @param {object} site - site audited.
+   * @param {Error} error - The error that occurred during the audit.
+   */
+  async saveAuditError(site, error) {
     const now = new Date().toISOString();
     const newAudit = {
-      siteId: site.id,
+      siteId: `${site.domain}/${site.path}`,
       auditDate: now,
-      isLive: site.isLive,
       error: error.message,
       scores: {},
     };
-    await saveRecord(newAudit, TABLE_AUDITS);
+    await this.saveRecord(newAudit, TABLE_AUDITS);
   }
+
   /**
-     * Fetches a site by its ID and gets its latest audit.
-     * @param {string} siteId - The ID of the site to fetch.
-     * @returns {Promise<object>} Site document with its latest audit.
-     */
-  async function getSite(domain, path) {
-    const params = {
+   * Fetches a site by its ID and gets its latest audit.
+   * @param {string} domain - The domain of the site to fetch.
+   * @param {string} path - The path of the site to fetch.
+   * @returns {Promise<object>} Site document with its latest audit.
+   */
+  async getSite(domain, path) {
+    const commandParams = {
       TableName: TABLE_SITES, // Replace with your table name
       Key: {
         Domain: { S: domain }, // Partition key
@@ -113,26 +118,19 @@ function DB(config) {
     };
 
     try {
-      const command = new GetItemCommand(params);
-      const response = await client.send(command);
+      const command = new GetCommand(commandParams);
+      const response = await this.docClient.send(command);
       const item = response.Item;
       if (item) {
-        log('info', `Item retrieved successfully: ${item}`);
+        this.log.info(`Item retrieved successfully: ${item}`);
         return item;
       } else {
-        log('info', 'Item not found.');
+        this.log.info('Item not found.');
         return null;
       }
     } catch (error) {
-      log('error', `Error ${error}`);
+      this.log.error(`Error ${error}`);
       throw error;
     }
   }
-  return {
-    getSite,
-    saveAuditIndex,
-    saveAuditError,
-  };
 }
-
-export default DB;