@adobe/spacecat-shared-data-access 1.15.6 → 1.17.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.17.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.16.0...@adobe/spacecat-shared-data-access-v1.17.0) (2024-02-14)
+
+
+### Features
+
+* get organization by IMS org ID ([#153](https://github.com/adobe/spacecat-shared/issues/153)) ([541e7e7](https://github.com/adobe/spacecat-shared/commit/541e7e721cb21e977b59b19cf53dfb7ba460905f))
+
+# [@adobe/spacecat-shared-data-access-v1.16.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.15.6...@adobe/spacecat-shared-data-access-v1.16.0) (2024-02-14)
+
+
+### Features
+
+* add configurations data access ([65bdc25](https://github.com/adobe/spacecat-shared/commit/65bdc2581e150cb32eb51d4d2bf03c8172ec2247))
+
 # [@adobe/spacecat-shared-data-access-v1.15.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.15.5...@adobe/spacecat-shared-data-access-v1.15.6) (2024-02-12)
 
 

package/package.json

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

package/src/dto/configuration.js

@@ -0,0 +1,33 @@
+/*
+ * 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 { createConfiguration } from '../models/configuration.js';
+
+/**
+ * Data transfer object for Configuration.
+ */
+export const ConfigurationDto = {
+  /**
+     * Converts a DynamoDB item into a Configuration object.
+     * @param {object } dynamoItem - DynamoDB item.
+     * @returns {Readonly<Configuration>} Configuration object.
+     */
+  fromDynamoItem: (dynamoItem) => {
+    const configurationData = {
+      version: dynamoItem.version,
+      queues: dynamoItem.queues,
+      jobs: dynamoItem.jobs,
+    };
+
+    return createConfiguration(configurationData);
+  },
+};

package/src/index.d.ts

@@ -315,6 +315,27 @@ export interface Organization {
   getConfig: () => Config;
 }
 
+export interface Configuration {
+  /**
+   * Retrieves the configuration version.
+   * @returns {string} The configuration version.
+   */
+  getVersion: () => string;
+
+  /**
+   * Retrieves the queues configuration.
+   * @returns {object} The queues configuration.
+   */
+  getQueues: () => object;
+
+  /**
+   * Retrieves the jobs configuration.
+   * @returns {Array} The jobs configurations.
+   */
+  getJobs: () => Array<object>;
+
+}
+
 export interface DataAccess {
   getAuditForSite: (
     sitedId: string,
@@ -392,6 +413,9 @@ export interface DataAccess {
   getOrganizationByID: (
       organizationID: string,
   ) => Promise<Organization | null>;
+  getOrganizationByImsOrgID: (
+      imsOrgID: string,
+  ) => Promise<Organization | null>;
   addOrganization: (
       organizationData: object,
   ) => Promise<Organization>;
@@ -407,6 +431,10 @@ export interface DataAccess {
   upsertSiteCandidate: (siteCandidateDate: object) => Promise<SiteCandidate>;
   siteCandidateExists: (baseURL: string) => Promise<boolean>;
   updateSiteCandidate: (siteCandidate: SiteCandidate) => Promise<SiteCandidate>;
+
+  // configuration functions
+  getConfiguration: () => Promise<Configuration>
+  getConfigurationByVersion: (version: string) => Promise<Configuration>
 }
 
 interface DataAccessConfig {
@@ -415,14 +443,17 @@ interface DataAccessConfig {
   tableNameOrganizations: string,
   tableNameSites: string;
   tableNameSiteCandidates: string;
+  tableNameConfigurations: string;
   indexNameAllSites: string;
   indexNameAllSitesOrganizations: string,
   indexNameAllSitesByDeliveryType: string;
   indexNameAllLatestAuditScores: string;
   indexNameAllOrganizations: string,
+  indexNameAllOrganizationsByImsOrgId: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
   pkAllOrganizations: string;
+  pkAllConfigurations: string;
 }
 
 export function createDataAccess(

package/src/index.js

@@ -17,14 +17,17 @@ const TABLE_NAME_LATEST_AUDITS = 'spacecat-services-latest-audits-dev';
 const TABLE_NAME_SITES = 'spacecat-services-sites-dev';
 const TABLE_NAME_SITE_CANDIDATES = 'spacecat-services-site-candidates-dev';
 const TABLE_NAME_ORGANIZATIONS = 'spacecat-services-organizations-dev';
+const TABLE_NAME_CONFIGURATIONS = 'spacecat-services-configurations-dev';
 
 const INDEX_NAME_ALL_SITES = 'spacecat-services-all-sites-dev';
 const INDEX_NAME_ALL_ORGANIZATIONS = 'spacecat-services-all-organizations-dev';
+const INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID = 'spacecat-services-all-organizations-by-ims-org-id-dev';
 const INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE = 'spacecat-services-all-sites-by-delivery-type-dev';
 const INDEX_NAME_ALL_LATEST_AUDIT_SCORES = 'spacecat-services-all-latest-audit-scores-dev';
 const INDEX_NAME_ALL_SITES_ORGANIZATIONS = 'spacecat-services-all-sites-organizations-dev';
 
 const PK_ALL_SITES = 'ALL_SITES';
+const PK_ALL_CONFIGURATIONS = 'ALL_CONFIGURATIONS';
 const PK_ALL_ORGANIZATIONS = 'ALL_ORGANIZATIONS';
 const PK_ALL_LATEST_AUDITS = 'ALL_LATEST_AUDITS';
 
@@ -39,10 +42,13 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_TABLE_NAME_SITES = TABLE_NAME_SITES,
         DYNAMO_TABLE_NAME_SITE_CANDIDATES = TABLE_NAME_SITE_CANDIDATES,
         DYNAMO_TABLE_NAME_ORGANIZATIONS = TABLE_NAME_ORGANIZATIONS,
+        DYNAMO_TABLE_NAME_CONFIGURATIONS = TABLE_NAME_CONFIGURATIONS,
         DYNAMO_INDEX_NAME_ALL_SITES = INDEX_NAME_ALL_SITES,
         DYNAMO_INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE = INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE,
         DYNAMO_INDEX_NAME_ALL_LATEST_AUDIT_SCORES = INDEX_NAME_ALL_LATEST_AUDIT_SCORES,
         DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS = INDEX_NAME_ALL_ORGANIZATIONS,
+        // eslint-disable-next-line max-len
+        DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID = INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID,
         DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS = INDEX_NAME_ALL_SITES_ORGANIZATIONS,
       } = context.env;
 
@@ -52,14 +58,17 @@ export default function dataAccessWrapper(fn) {
         tableNameOrganizations: DYNAMO_TABLE_NAME_ORGANIZATIONS,
         tableNameSites: DYNAMO_TABLE_NAME_SITES,
         tableNameSiteCandidates: DYNAMO_TABLE_NAME_SITE_CANDIDATES,
+        tableNameConfigurations: DYNAMO_TABLE_NAME_CONFIGURATIONS,
         indexNameAllSites: DYNAMO_INDEX_NAME_ALL_SITES,
         indexNameAllOrganizations: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS,
+        indexNameAllOrganizationsByImsOrgId: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS_BY_IMS_ORG_ID,
         indexNameAllSitesByDeliveryType: DYNAMO_INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE,
         indexNameAllLatestAuditScores: DYNAMO_INDEX_NAME_ALL_LATEST_AUDIT_SCORES,
         indexNameAllSitesOrganizations: DYNAMO_INDEX_NAME_ALL_SITES_ORGANIZATIONS,
         pkAllSites: PK_ALL_SITES,
         pkAllOrganizations: PK_ALL_ORGANIZATIONS,
         pkAllLatestAudits: PK_ALL_LATEST_AUDITS,
+        pkAllConfigurations: PK_ALL_CONFIGURATIONS,
       }, log);
     }
 

package/src/models/configuration.js

@@ -0,0 +1,49 @@
+/*
+ * 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 Joi from 'joi';
+
+const Configuration = (data = {}) => {
+  const self = { ...data };
+  self.getJobs = () => self.jobs;
+  self.getVersion = () => self.version;
+  self.getQueues = () => self.queues;
+
+  return Object.freeze(self);
+};
+
+export const checkConfiguration = (configuration) => {
+  const schema = Joi.object({
+    version: Joi.string().required(),
+    queues: Joi.object().required(),
+    jobs: Joi.array().required(),
+  }).unknown(true);
+  const { error, value } = schema.validate(configuration);
+
+  if (error) {
+    throw new Error(`Configuration validation error: ${error.message}`);
+  }
+
+  return value; // Validated and sanitized configuration
+};
+
+/**
+ * Creates a new Configuration.
+ *
+ * @param {object} data - configuration data
+ * @returns {Readonly<Configuration>} configuration - new configuration
+ */
+export const createConfiguration = (data) => {
+  const value = checkConfiguration(data);
+  const newState = { ...value };
+  return Configuration(newState);
+};

package/src/models/organization.js

@@ -92,10 +92,15 @@ export const createOrganization = (data) => {
   if (!isObject(newState.config)) {
     newState.config = { ...DEFAULT_CONFIG };
   }
+
   if (!hasText(newState.name)) {
     throw new Error('Org name must be provided');
   }
 
+  if (!hasText(newState.imsOrgId)) {
+    newState.imsOrgId = DEFAULT_ORGANIZATION_ID;
+  }
+
   newState.config = Config(newState.config);
 
   return Organization(newState);

package/src/service/configurations/accessPatterns.js

@@ -0,0 +1,63 @@
+/*
+ * 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 { ConfigurationDto } from '../../dto/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 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;
+};

package/src/service/configurations/index.js

@@ -0,0 +1,24 @@
+/*
+ * 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 } from './accessPatterns.js';
+
+export const configurationFunctions = (dynamoClient, config) => ({
+  getConfiguration: () => getConfiguration(
+    dynamoClient,
+    config,
+  ),
+  getConfigurationByVersion: (version) => getConfigurationByVersion(
+    dynamoClient,
+    config,
+    version,
+  ),
+});

package/src/service/index.js

@@ -15,6 +15,7 @@ import { auditFunctions } from './audits/index.js';
 import { siteFunctions } from './sites/index.js';
 import { siteCandidateFunctions } from './site-candidates/index.js';
 import { organizationFunctions } from './organizations/index.js';
+import { configurationFunctions } from './configurations/index.js';
 
 /**
  * Creates a data access object.
@@ -22,7 +23,8 @@ import { organizationFunctions } from './organizations/index.js';
  * @param {{pkAllSites: string, pkAllLatestAudits: string, indexNameAllLatestAuditScores: string,
  * tableNameAudits: string,tableNameLatestAudits: string, indexNameAllSitesOrganizations: string,
  * tableNameSites: string, tableNameOrganizations: string, indexNameAllSites: string,
- * indexNameAllOrganizations: string, pkAllOrganizations: string}} config configuration
+ * indexNameAllOrganizations: string, indexNameAllOrganizationsByImsOrgId: string,
+ * pkAllOrganizations: string}} config configuration
  * @param {Logger} log logger
  * @returns {object} data access object
  */
@@ -33,11 +35,13 @@ export const createDataAccess = (config, log = console) => {
   const siteFuncs = siteFunctions(dynamoClient, config, log);
   const siteCandidateFuncs = siteCandidateFunctions(dynamoClient, config, log);
   const organizationFuncs = organizationFunctions(dynamoClient, config, log);
+  const configurationFuncs = configurationFunctions(dynamoClient, config);
 
   return {
     ...auditFuncs,
     ...siteFuncs,
     ...siteCandidateFuncs,
     ...organizationFuncs,
+    ...configurationFuncs,
   };
 };

package/src/service/organizations/accessPatterns.js

@@ -50,6 +50,32 @@ export const getOrganizationByID = async (
   return isObject(dynamoItem) ? OrganizationDto.fromDynamoItem(dynamoItem) : null;
 };
 
+/**
+ * Retrieves an organization by its IMS org ID.
+ *
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @param {string} imsOrgId - Organization identifier on IMS, in the format of {id}@AdobeOrg
+ * @returns {Promise<Readonly<Organization>>} A promise that resolves to an organization, if found.
+ */
+export const getOrganizationByImsOrgID = async (
+  dynamoClient,
+  config,
+  imsOrgId,
+) => {
+  const dynamoItems = await dynamoClient.query({
+    TableName: config.tableNameOrganizations,
+    IndexName: config.indexNameAllOrganizationsByImsOrgId,
+    KeyConditionExpression: 'imsOrgId = :imsOrgId',
+    ExpressionAttributeValues: {
+      ':imsOrgId': imsOrgId,
+    },
+    Limit: 1,
+  });
+
+  return dynamoItems.length > 0 ? OrganizationDto.fromDynamoItem(dynamoItems[0]) : null;
+};
+
 /**
  * Adds an organization.
  *

package/src/service/organizations/index.js

@@ -15,6 +15,7 @@ import {
   addOrganization,
   updateOrganization,
   removeOrganization,
+  getOrganizationByImsOrgID,
 } from './accessPatterns.js';
 
 export const organizationFunctions = (dynamoClient, config, log) => ({
@@ -24,6 +25,11 @@ export const organizationFunctions = (dynamoClient, config, log) => ({
     config,
     organizationId,
   ),
+  getOrganizationByImsOrgID: (imsOrgId) => getOrganizationByImsOrgID(
+    dynamoClient,
+    config,
+    imsOrgId,
+  ),
   addOrganization: (organizationData) => addOrganization(
     dynamoClient,
     config,