@adobe/spacecat-shared-data-access 1.61.18 → 2.0.0

package/src/service/experiments/accessPatterns.js

@@ -1,98 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { isObject } from '@adobe/spacecat-shared-utils';
-import { createExperiment } from '../../models/experiment.js';
-import { ExperimentDto } from '../../dto/experiment.js';
-
-/**
- * Returns the experiment if exists in experiments table using siteId, experimentId and url
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {string} siteId - siteId of the experiment.
- * @param {string} id - id of the experiment.
- * @return the experiment if exists, null otherwise
- */
-export const getExperiment = async (dynamoClient, config, siteId, experimentId, url) => {
-  const queryParams = {
-    TableName: config.tableNameExperiments,
-    KeyConditionExpression: 'siteId = :siteId AND SK = :SK',
-    ExpressionAttributeValues: {
-      ':siteId': siteId,
-      ':SK': `${experimentId}#${url}`,
-    },
-    ScanIndexForward: false,
-  };
-  const dynamoItems = await dynamoClient.query(queryParams);
-  if (dynamoItems != null && dynamoItems.length > 0 && isObject(dynamoItems[0])) {
-    return ExperimentDto.fromDynamoItem(dynamoItems[0]);
-  }
-
-  return null;
-};
-
-/**
- * Retrieves all experiments for a given siteId.
- * @param {*} dynamoClient - The DynamoDB client.
- * @param {*} config - The data access config.
- * @param {*} log  - the log object
- * @param {*} siteId - siteId of the experiment.
- * @param {*} experimentId - experiment id.
- * @returns {Promise<ReadonlyArray<SiteCandidate>>} A promise that resolves to
- * an array of experiments
- */
-export const getExperiments = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  experimentId,
-) => {
-  const queryParams = {
-    TableName: config.tableNameExperiments,
-    KeyConditionExpression: 'siteId = :siteId',
-    ExpressionAttributeValues: { ':siteId': siteId },
-    ScanIndexForward: false,
-  };
-  if (experimentId) {
-    queryParams.KeyConditionExpression += ' AND begins_with(SK, :experimentId)';
-    queryParams.ExpressionAttributeValues[':experimentId'] = experimentId;
-  }
-  const dynamoItems = await dynamoClient.query(queryParams);
-
-  return dynamoItems.map((item) => ExperimentDto.fromDynamoItem(item));
-};
-
-/**
- * Upserts an experiment.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {object} log - the log object
- * @param {object} experimentData - The experiment data.
- * @returns {Promise<Readonly<SiteCandidate>>} A promise that resolves to newly created/updated
- * experiment
- */
-export const upsertExperiment = async (
-  dynamoClient,
-  config,
-  log,
-  experimentData,
-) => {
-  const experiment = createExperiment(experimentData);
-  await dynamoClient.putItem(
-    config.tableNameExperiments,
-    ExperimentDto.toDynamoItem(experiment),
-  );
-
-  return experiment;
-};

package/src/service/experiments/index.js

@@ -1,40 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {
-  getExperiments,
-  upsertExperiment,
-  getExperiment,
-} from './accessPatterns.js';
-
-export const experimentFunctions = (dynamoClient, config, log) => ({
-  getExperiments: (siteId, experimentId) => getExperiments(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-    experimentId,
-  ),
-  upsertExperiment: (experimentData) => upsertExperiment(
-    dynamoClient,
-    config,
-    log,
-    experimentData,
-  ),
-  getExperiment: (siteId, experimentId, url) => getExperiment(
-    dynamoClient,
-    config,
-    siteId,
-    experimentId,
-    url,
-  ),
-});

package/src/service/import-job/accessPatterns.js

@@ -1,134 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { isObject } from '@adobe/spacecat-shared-utils';
-import { ImportJobDto } from '../../dto/import-job.js';
-import { createImportJob } from '../../models/importer/import-job.js';
-import { removeUrlsForImportJob } from '../import-url/accessPatterns.js';
-
-/**
- * Get all Import Jobs within a specific date range
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {string} startDate
- * @param {string} endDate
- */
-export const getImportJobsByDateRange = async (dynamoClient, config, log, startDate, endDate) => {
-  const items = await dynamoClient.query({
-    TableName: config.tableNameImportJobs,
-    IndexName: config.indexNameAllImportJobsByDateRange,
-    KeyConditionExpression: 'GSI1PK = :gsi1pk AND #startTime BETWEEN :startDate AND :endDate',
-    ExpressionAttributeNames: {
-      '#startTime': 'startTime',
-    },
-    ExpressionAttributeValues: {
-      ':gsi1pk': config.pkAllImportJobs,
-      ':startDate': startDate,
-      ':endDate': endDate,
-    },
-  });
-  return items.map((item) => ImportJobDto.fromDynamoItem(item));
-};
-
-/**
- * Get Import Job by ID.
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {string} id
- * @returns {Promise<ImportJobDto> | null}
- */
-export const getImportJobByID = async (dynamoClient, config, log, id) => {
-  const item = await dynamoClient.getItem(
-    config.tableNameImportJobs,
-    { id },
-  );
-
-  return item ? ImportJobDto.fromDynamoItem(item) : null;
-};
-
-/**
- * Get Import jobs by status
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {string} status
- * @returns {Promise<ImportJobDto[]>}
- */
-export const getImportJobsByStatus = async (dynamoClient, config, log, status) => {
-  const items = await dynamoClient.query({
-    TableName: config.tableNameImportJobs,
-    IndexName: config.indexNameAllImportJobsByStatus,
-    KeyConditionExpression: 'GSI1PK = :gsi1pk AND #status = :status',
-    ExpressionAttributeNames: {
-      '#status': 'status',
-    },
-    ExpressionAttributeValues: {
-      ':gsi1pk': config.pkAllImportJobs,
-      ':status': status,
-    },
-  });
-  return items.map((item) => ImportJobDto.fromDynamoItem(item));
-};
-
-/**
- * Creates a new Import Job
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {Object} importJobData
- * @returns {Promise<ImportJobDto>}
- */
-export const createNewImportJob = async (dynamoClient, config, log, importJobData) => {
-  const importJob = createImportJob(importJobData);
-  await dynamoClient.putItem(config.tableNameImportJobs, ImportJobDto.toDynamoItem(importJob));
-  return importJob;
-};
-
-/**
- * Updates an Import Job
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {ImportJobDto} importJob
- */
-export const updateImportJob = async (dynamoClient, config, log, importJob) => {
-  const existingImportJob = await getImportJobByID(dynamoClient, config, log, importJob.getId());
-
-  if (!isObject(existingImportJob)) {
-    throw new Error(`Import Job with id: ${importJob.getId()} does not exist`);
-  }
-
-  await dynamoClient.putItem(config.tableNameImportJobs, ImportJobDto.toDynamoItem(importJob));
-
-  return importJob;
-};
-
-/**
- * Removes an Import Job and all associated URLs.
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {ImportJob} importJob - The import job to remove.
- * @return {Promise<void>} A promise that resolves when the import job has been removed.
- */
-export const removeImportJob = async (dynamoClient, config, log, importJob) => {
-  try {
-    await removeUrlsForImportJob(dynamoClient, config, log, importJob.getId());
-
-    await dynamoClient.removeItem(config.tableNameImportJobs, { id: importJob.getId() });
-  } catch (error) {
-    log.error(`Error removing import job: ${error.message}`);
-    throw error;
-  }
-};

package/src/service/import-job/index.js

@@ -1,60 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {
-  createNewImportJob,
-  getImportJobByID,
-  getImportJobsByStatus,
-  updateImportJob,
-  getImportJobsByDateRange,
-  removeImportJob,
-} from './accessPatterns.js';
-
-export const importJobFunctions = (dynamoClient, config, log) => ({
-  getImportJobsByDateRange: (startDate, endDate) => getImportJobsByDateRange(
-    dynamoClient,
-    config,
-    log,
-    startDate,
-    endDate,
-  ),
-  getImportJobByID: (id) => getImportJobByID(
-    dynamoClient,
-    config,
-    log,
-    id,
-  ),
-  getImportJobsByStatus: (status) => getImportJobsByStatus(
-    dynamoClient,
-    config,
-    log,
-    status,
-  ),
-  createNewImportJob: (importJobData) => createNewImportJob(
-    dynamoClient,
-    config,
-    log,
-    importJobData,
-  ),
-  updateImportJob: (importJob) => updateImportJob(
-    dynamoClient,
-    config,
-    log,
-    importJob,
-  ),
-  removeImportJob: (importJob) => removeImportJob(
-    dynamoClient,
-    config,
-    log,
-    importJob,
-  ),
-});

package/src/service/import-url/accessPatterns.js

@@ -1,153 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { isObject } from '@adobe/spacecat-shared-utils';
-import { ImportUrlDto } from '../../dto/import-url.js';
-import { createImportUrl } from '../../models/importer/import-url.js';
-
-/**
- * Get import url by ID
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {string} id
- * @returns {Promise<ImportUrlDto> | null}
- */
-export const getImportUrlById = async (dynamoClient, config, log, id) => {
-  const item = await dynamoClient.getItem(
-    config.tableNameImportUrls,
-    { id },
-  );
-  return item ? ImportUrlDto.fromDynamoItem(item) : null;
-};
-
-/**
- * Create a new Import Url
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {Object} importUrlData
- * @returns {Promise<ImportUrlDto>}
- */
-export const createNewImportUrl = async (dynamoClient, config, log, importUrlData) => {
-  const importUrl = createImportUrl(importUrlData);
-  await dynamoClient.putItem(
-    config.tableNameImportUrls,
-    ImportUrlDto.toDynamoItem(importUrl),
-  );
-  return importUrl;
-};
-
-/**
- * Update an existing Import Url
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {Object} importUrl
- * @returns {ImportUrlDto}
- */
-export const updateImportUrl = async (dynamoClient, config, log, importUrl) => {
-  const existingImportUrl = await getImportUrlById(
-    dynamoClient,
-    config,
-    log,
-    importUrl.getId(),
-  );
-
-  if (!isObject(existingImportUrl)) {
-    throw new Error(`Import Url with ID: ${importUrl.getId()} does not exist`);
-  }
-
-  await dynamoClient.putItem(config.tableNameImportUrls, ImportUrlDto.toDynamoItem(importUrl));
-
-  return importUrl;
-};
-
-/**
- * Get Import Urls by Job ID and Status
- * @param {DynamoClient} dynamoClient
- * @param {Object} config
- * @param {Logger} log
- * @param {string} jobId
- * @param {string} status
- * @returns {Promise<ImportUrl[]>}
- */
-export const getImportUrlsByJobIdAndStatus = async (dynamoClient, config, log, jobId, status) => {
-  const items = await dynamoClient.query({
-    TableName: config.tableNameImportUrls,
-    IndexName: config.indexNameImportUrlsByJobIdAndStatus,
-    KeyConditionExpression: 'jobId = :jobId AND #status = :status',
-    ExpressionAttributeNames: {
-      '#status': 'status',
-    },
-    ExpressionAttributeValues: {
-      ':jobId': jobId,
-      ':status': status,
-    },
-  });
-  return items.map((item) => ImportUrlDto.fromDynamoItem(item));
-};
-
-/**
- * Get Import Urls by Job ID, if no urls exist an empty array is returned.
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {string} jobId - The ID of the import job.
- * @returns {Promise<ImportUrl[]>}
- */
-export const getImportUrlsByJobId = async (dynamoClient, config, log, jobId) => {
-  const items = await dynamoClient.query({
-    TableName: config.tableNameImportUrls,
-    IndexName: config.indexNameImportUrlsByJobIdAndStatus,
-    KeyConditionExpression: 'jobId = :jobId',
-    ExpressionAttributeValues: {
-      ':jobId': jobId,
-    },
-  });
-
-  return items ? items.map((item) => ImportUrlDto.fromDynamoItem(item)) : [];
-};
-
-/**
- * Remove all given import URLs.
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {ImportUrl[]} urls - The import URLs to remove.
- * @return {Promise<void>} A promise that resolves when all URLs have been removed.
- */
-async function removeUrls(dynamoClient, config, urls) {
-  const removeUrlPromises = urls.map((url) => dynamoClient.removeItem(
-    config.tableNameImportUrls,
-    { id: url.getId() },
-  ));
-
-  await Promise.all(removeUrlPromises);
-}
-
-/**
- * Remove all URLs associated with an import job.
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {string} jobId - The ID of the import job.
- * @return {Promise<void>} A promise that resolves when all URLs have been removed.
- */
-export const removeUrlsForImportJob = async (dynamoClient, config, log, jobId) => {
-  try {
-    const urls = await getImportUrlsByJobId(dynamoClient, config, log, jobId);
-    await removeUrls(dynamoClient, config, urls);
-  } catch (error) {
-    log.error(`Error removing urls for import jobId: ${jobId} : ${error.message}`);
-    throw error;
-  }
-};

package/src/service/import-url/index.js

@@ -1,53 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {
-  getImportUrlById,
-  createNewImportUrl,
-  updateImportUrl,
-  getImportUrlsByJobIdAndStatus,
-  getImportUrlsByJobId,
-} from './accessPatterns.js';
-
-export const importUrlFunctions = (dynamoClient, config, log) => ({
-  getImportUrlById: (id) => getImportUrlById(
-    dynamoClient,
-    config,
-    log,
-    id,
-  ),
-  createNewImportUrl: (importUrlData) => createNewImportUrl(
-    dynamoClient,
-    config,
-    log,
-    importUrlData,
-  ),
-  updateImportUrl: (importUrl) => updateImportUrl(
-    dynamoClient,
-    config,
-    log,
-    importUrl,
-  ),
-  getImportUrlsByJobIdAndStatus: (jobId, status) => getImportUrlsByJobIdAndStatus(
-    dynamoClient,
-    config,
-    log,
-    jobId,
-    status,
-  ),
-  getImportUrlsByJobId: (jobId) => getImportUrlsByJobId(
-    dynamoClient,
-    config,
-    log,
-    jobId,
-  ),
-});

package/src/service/key-events/accessPatterns.js

@@ -1,92 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { createKeyEvent } from '../../models/key-event.js';
-import { KeyEventDto } from '../../dto/key-event.js';
-
-/**
- * Adds a new key event for a site.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {object} log - the log object
- * @param {object} keyEventData - The key event data.
- * @returns {Promise<Readonly<KeyEvent>>} newly created key event
- */
-export const addKeyEvent = async (
-  dynamoClient,
-  config,
-  log,
-  keyEventData,
-) => {
-  const keyEvent = createKeyEvent(keyEventData);
-
-  await dynamoClient.putItem(
-    config.tableNameKeyEvents,
-    KeyEventDto.toDynamoItem(keyEvent),
-  );
-
-  return keyEvent;
-};
-
-/**
- * Retrieves key events for a specified site.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {string} siteId - The ID of the site for which key events are being retrieved.
- * @param {boolean} ascending - Determines if the key events should be sorted ascending
- * or descending by createdAt.
- * @returns {Promise<Readonly<KeyEvent>[]>} A promise that resolves to an array of key events
- * for the specified site.
- */
-export const getKeyEventsForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  ascending = false,
-) => {
-  const dynamoItems = await dynamoClient.query({
-    TableName: config.tableNameKeyEvents,
-    IndexName: config.indexNameAllKeyEventsBySiteId,
-    KeyConditionExpression: 'siteId = :siteId',
-    ExpressionAttributeValues: { ':siteId': siteId },
-    ScanIndexForward: ascending, // Sorts ascending if true, descending if false
-  });
-
-  return dynamoItems.map((item) => KeyEventDto.fromDynamoItem(item));
-};
-
-/**
- * Removes a key event.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {string} keyEventId - The ID of the key event to remove.
- * @returns {Promise<void>}
- */
-export const removeKeyEvent = async (
-  dynamoClient,
-  config,
-  log,
-  keyEventId,
-) => {
-  try {
-    await dynamoClient.removeItem(config.tableNameKeyEvents, { id: keyEventId });
-  } catch (error) {
-    log.error(`Error removing key event: ${error.message}`);
-    throw error;
-  }
-};

package/src/service/key-events/index.js

@@ -1,38 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {
-  addKeyEvent,
-  getKeyEventsForSite,
-  removeKeyEvent,
-} from './accessPatterns.js';
-
-export const keyEventFunctions = (dynamoClient, config, log) => ({
-  createKeyEvent: (keyEventData) => addKeyEvent(
-    dynamoClient,
-    config,
-    log,
-    keyEventData,
-  ),
-  getKeyEventsForSite: (siteId) => getKeyEventsForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-  ),
-  removeKeyEvent: (keyEventId) => removeKeyEvent(
-    dynamoClient,
-    config,
-    log,
-    keyEventId,
-  ),
-});