@adobe/spacecat-shared-data-access 1.61.19 → 2.0.1

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

@@ -1,37 +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 {
-  createNewApiKey,
-  getApiKeyByHashedApiKey,
-  getApiKeyById,
-  getApiKeysByImsUserIdAndImsOrgId,
-  updateApiKey,
-} from './accessPatterns.js';
-
-export const apiKeyFunctions = (dynamoClient, config, log) => ({
-  getApiKeyByHashedApiKey: (hashedApiKey) => getApiKeyByHashedApiKey(
-    hashedApiKey,
-    dynamoClient,
-    log,
-    config,
-  ),
-  createNewApiKey: (apiKey) => createNewApiKey(apiKey, dynamoClient, config, log),
-  getApiKeysByImsUserIdAndImsOrgId: (imsUserId, imsOrgId) => getApiKeysByImsUserIdAndImsOrgId(
-    imsUserId,
-    imsOrgId,
-    dynamoClient,
-    config,
-  ),
-  getApiKeyById: (id) => getApiKeyById(id, dynamoClient, config),
-  updateApiKey: (apiKey) => updateApiKey(apiKey, dynamoClient, config),
-});

package/src/service/audits/accessPatterns.js

@@ -1,284 +0,0 @@
-/*
- * Copyright 2023 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 { hasText, isObject } from '@adobe/spacecat-shared-utils';
-
-import { AuditDto } from '../../dto/audit.js';
-import { createAudit } from '../../models/audit.js';
-
-/**
- * Retrieves audits for a specified site. If an audit type is provided,
- * it returns only audits of that type.
- *
- * @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 audits are being retrieved.
- * @param {string} [auditType] - Optional. The type of audits to retrieve.
- * @param {boolean} [ascending] - Optional. Determines if the audits should be sorted
- * ascending. Default is true.
- * @returns {Promise<Readonly<Audit>[]>} A promise that resolves to an array of audits
- * for the specified site.
- */
-export const getAuditsForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  auditType,
-  ascending = true,
-) => {
-  const queryParams = {
-    TableName: config.tableNameAudits,
-    KeyConditionExpression: 'siteId = :siteId',
-    ExpressionAttributeValues: {
-      ':siteId': siteId,
-    },
-    ScanIndexForward: ascending, // Sorts ascending if true, descending if false
-  };
-
-  if (hasText(auditType)) {
-    queryParams.KeyConditionExpression += ' AND begins_with(SK, :auditType)';
-    queryParams.ExpressionAttributeValues[':auditType'] = `${auditType}#`;
-  }
-
-  const dynamoItems = await dynamoClient.query(queryParams);
-
-  return dynamoItems.map((item) => AuditDto.fromDynamoItem(item));
-};
-
-/**
- * Retrieves a specific audit 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 to retrieve the audit.
- * @param {string} auditType - The type of audit to retrieve.
- * @param auditedAt - The ISO 8601 timestamp of the audit.
- * @returns {Promise<Readonly<Audit>|null>}
- */
-export const getAuditForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  auditType,
-  auditedAt,
-) => {
-  const audit = await dynamoClient.getItem(config.tableNameAudits, {
-    siteId,
-    SK: `${auditType}#${auditedAt}`,
-  });
-
-  return audit ? AuditDto.fromDynamoItem(audit) : null;
-};
-
-/**
- * Retrieves the latest audits of a specific type across all sites.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {string} auditType - The type of audits to retrieve.
- * @param {boolean} ascending - Determines if the audits should be sorted ascending
- * or descending by scores.
- * @returns {Promise<Readonly<Audit>[]>} A promise that resolves to an array of the latest
- * audits of the specified type.
- */
-export const getLatestAudits = async (
-  dynamoClient,
-  config,
-  log,
-  auditType,
-  ascending = true,
-) => {
-  const dynamoItems = await dynamoClient.query({
-    TableName: config.tableNameLatestAudits,
-    IndexName: config.indexNameAllLatestAuditScores,
-    KeyConditionExpression: 'GSI1PK = :gsi1pk AND begins_with(GSI1SK, :auditType)',
-    ExpressionAttributeValues: {
-      ':gsi1pk': config.pkAllLatestAudits,
-      ':auditType': `${auditType}#`,
-    },
-    ScanIndexForward: ascending, // Sorts ascending if true, descending if false
-  });
-
-  return dynamoItems.map((item) => AuditDto.fromDynamoItem(item));
-};
-
-/**
- * Retrieves latest audits 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 audits are being retrieved.
- * @returns {Promise<Readonly<Audit>[]>} A promise that resolves to an array of latest audits
- * for the specified site.
- */
-export const getLatestAuditsForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-) => {
-  const queryParams = {
-    TableName: config.tableNameLatestAudits,
-    KeyConditionExpression: 'siteId = :siteId',
-    ExpressionAttributeValues: { ':siteId': siteId },
-  };
-
-  const dynamoItems = await dynamoClient.query(queryParams);
-
-  return dynamoItems.map((item) => AuditDto.fromDynamoItem(item));
-};
-
-/**
- * Retrieves the latest audit for a specified site and audit type.
- *
- * @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 the latest audit is being retrieved.
- * @param {string} auditType - The type of audit to retrieve the latest instance of.
- * @returns {Promise<Audit|null>} A promise that resolves to the latest audit of the
- * specified type for the site, or null if none is found.
- */
-export const getLatestAuditForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-  auditType,
-) => {
-  const latestAudit = await dynamoClient.getItem(config.tableNameLatestAudits, {
-    siteId,
-    auditType,
-  });
-
-  return latestAudit ? AuditDto.fromDynamoItem(latestAudit) : null;
-};
-
-/**
- * Adds an audit.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The log.
- * @param {object} auditData - The audit data.
- * @returns {Promise<Readonly<Audit>>}
- */
-export const addAudit = async (
-  dynamoClient,
-  config,
-  log,
-  auditData,
-) => {
-  const newAudit = createAudit(auditData);
-  const existingAudit = await getAuditForSite(
-    dynamoClient,
-    config,
-    log,
-    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(),
-      auditedAt: latestAudit.getAuditedAt(),
-      fullAuditRef: latestAudit.getFullAuditRef(),
-    });
-  }
-
-  // TODO: Add transaction support
-  await dynamoClient.putItem(config.tableNameAudits, AuditDto.toDynamoItem(newAudit));
-  await dynamoClient.putItem(
-    config.tableNameLatestAudits,
-    AuditDto.toDynamoItem(newAudit, true),
-  );
-
-  return newAudit;
-};
-
-/**
- * Removes audits from the database.
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param audits
- * @param latest
- * @returns {Promise<void>}
- */
-async function removeAudits(
-  dynamoClient,
-  config,
-  audits,
-  latest = false,
-) {
-  const tableName = latest ? config.tableNameLatestAudits : config.tableNameAudits;
-  // TODO: use batch-remove (needs dynamo client update)
-  const removeAuditPromises = audits.map((audit) => {
-    const sortKey = latest
-      ? { auditType: `${audit.getAuditType()}` }
-      : { SK: `${audit.getAuditType()}#${audit.getAuditedAt()}` };
-    return dynamoClient.removeItem(
-      tableName,
-      {
-        siteId: audit.getSiteId(),
-        ...sortKey,
-      },
-    );
-  });
-
-  await Promise.all(removeAuditPromises);
-}
-
-/**
- * Removes all audits for a specified site and the latest audit entry.
- *
- * @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 audits are being removed.
- * @returns {Promise<void>}
- */
-export const removeAuditsForSite = async (
-  dynamoClient,
-  config,
-  log,
-  siteId,
-) => {
-  try {
-    const audits = await getAuditsForSite(dynamoClient, config, log, siteId);
-    const latestAudits = await getLatestAuditsForSite(dynamoClient, config, log, siteId);
-
-    await removeAudits(dynamoClient, config, audits);
-    await removeAudits(dynamoClient, config, latestAudits, true);
-  } catch (error) {
-    log.error(`Error removing audits for site ${siteId}: ${error.message}`);
-    throw error;
-  }
-};

package/src/service/audits/index.js

@@ -1,72 +0,0 @@
-/*
- * Copyright 2023 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 {
-  addAudit,
-  getAuditForSite,
-  getAuditsForSite,
-  getLatestAuditForSite,
-  getLatestAudits,
-  getLatestAuditsForSite,
-  removeAuditsForSite,
-} from './accessPatterns.js';
-
-export const auditFunctions = (dynamoClient, config, log) => ({
-  getAuditForSite: (siteId, auditType, auditedAt) => getAuditForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-    auditType,
-    auditedAt,
-  ),
-  getAuditsForSite: (siteId, auditType, ascending) => getAuditsForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-    auditType,
-    ascending,
-  ),
-  getLatestAudits: (auditType, ascending) => getLatestAudits(
-    dynamoClient,
-    config,
-    log,
-    auditType,
-    ascending,
-  ),
-  getLatestAuditForSite: (siteId, auditType) => getLatestAuditForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-    auditType,
-  ),
-  getLatestAuditsForSite: (siteId) => getLatestAuditsForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-  ),
-  addAudit: (auditData) => addAudit(
-    dynamoClient,
-    config,
-    log,
-    auditData,
-  ),
-  removeAuditsForSite: (siteId) => removeAuditsForSite(
-    dynamoClient,
-    config,
-    log,
-    siteId,
-  ),
-});

package/src/service/configurations/accessPatterns.js

@@ -1,123 +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 {
-  isInteger,
-  isObject,
-} from '@adobe/spacecat-shared-utils';
-
-import { ConfigurationDto } from '../../dto/configuration.js';
-import { createConfiguration } from '../../models/configuration.js';
-
-/**
- * Retrieves configuration with latest version.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @returns {Promise<Readonly<Configuration>>} A promise that resolves to the configuration
- * object if found, otherwise null.
- */
-export const getConfiguration = async (
-  dynamoClient,
-  config,
-) => {
-  const dynamoItems = await dynamoClient.query({
-    TableName: config.tableNameConfigurations,
-    KeyConditionExpression: 'PK = :pk',
-    ExpressionAttributeValues: {
-      ':pk': config.pkAllConfigurations,
-    },
-    Limit: 1,
-    ScanIndexForward: false, // Sorts ascending if true, descending if false
-  });
-
-  if (dynamoItems.length === 0) return null;
-  return ConfigurationDto.fromDynamoItem(dynamoItems[0]);
-};
-
-/**
- * Retrieves all configurations.
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @return {Promise<Readonly<Configuration>[]>} A promise that resolves to the configurations.
- */
-export const getConfigurations = async (
-  dynamoClient,
-  config,
-) => {
-  const dynamoItems = await dynamoClient.query({
-    TableName: config.tableNameConfigurations,
-    KeyConditionExpression: 'PK = :pk',
-    ExpressionAttributeValues: {
-      ':pk': config.pkAllConfigurations,
-    },
-  });
-
-  return dynamoItems.map(ConfigurationDto.fromDynamoItem);
-};
-
-/**
- * Retrieves a site by its version.
- *
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
- * @param {string} version - The version of the configuration to retrieve.
- * @returns {Promise<Readonly<Configuration>|null>} A promise that resolves to the configuration
- * object if found, otherwise null.
- */
-export const getConfigurationByVersion = async (
-  dynamoClient,
-  config,
-  version,
-) => {
-  const dynamoItem = await dynamoClient.getItem(config.tableNameConfigurations, {
-    PK: config.pkAllConfigurations,
-    version,
-  });
-
-  return isObject(dynamoItem) ? ConfigurationDto.fromDynamoItem(dynamoItem) : null;
-};
-
-function incrementVersion(version) {
-  if (!isInteger(version)) return 1;
-
-  const versionNumber = parseInt(version, 10);
-  return versionNumber + 1;
-}
-
-/**
- * Updates the configuration. Updating the configuration will create a new version of the
- * configuration. The version is a string of the format "v<version-number>", for example "v1".
- * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
- * @param {DataAccessConfig} config - The data access config.
-  * @param {Configuration} configurationData - The configuration data.
- * @return {Promise<void>} A promise that resolves when the configuration is updated.
- */
-export const updateConfiguration = async (
-  dynamoClient,
-  config,
-  configurationData,
-) => {
-  const newConfigurationData = { ...configurationData };
-  const latestConfiguration = await getConfiguration(dynamoClient, config);
-
-  newConfigurationData.version = incrementVersion(latestConfiguration?.getVersion());
-
-  const newConfiguration = createConfiguration(newConfigurationData);
-
-  await dynamoClient.putItem(
-    config.tableNameConfigurations,
-    ConfigurationDto.toDynamoItem(newConfiguration),
-  );
-
-  return newConfiguration;
-};

package/src/service/configurations/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 {
-  getConfiguration,
-  getConfigurationByVersion,
-  getConfigurations,
-  updateConfiguration,
-} from './accessPatterns.js';
-
-export const configurationFunctions = (dynamoClient, config) => ({
-  getConfiguration: () => getConfiguration(
-    dynamoClient,
-    config,
-  ),
-  getConfigurations: () => getConfigurations(
-    dynamoClient,
-    config,
-  ),
-  getConfigurationByVersion: (version) => getConfigurationByVersion(
-    dynamoClient,
-    config,
-    version,
-  ),
-  updateConfiguration: (configurationData) => updateConfiguration(
-    dynamoClient,
-    config,
-    configurationData,
-  ),
-});

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,
-  ),
-});