@adobe/spacecat-shared-data-access 2.5.0 → 2.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.7.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.6.0...@adobe/spacecat-shared-data-access-v2.7.0) (2025-02-18)
+
+
+### Features
+
+* Implement dependency check for handlers ([#608](https://github.com/adobe/spacecat-shared/issues/608)) ([0ada515](https://github.com/adobe/spacecat-shared/commit/0ada5157a3cf50bf67129e296e719a14ee2c451c)), closes [/github.com/adobe/spacecat-shared/blob/main/packages/spacecat-shared-data-access/src/models/configuration/configuration.schema.js#L35-L39](https://github.com//github.com/adobe/spacecat-shared/blob/main/packages/spacecat-shared-data-access/src/models/configuration/configuration.schema.js/issues/L35-L39)
+
+# [@adobe/spacecat-shared-data-access-v2.6.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.5.0...@adobe/spacecat-shared-data-access-v2.6.0) (2025-02-18)
+
+
+### Features
+
+* **latest-metrics:** add latest metrics handling to config ([#607](https://github.com/adobe/spacecat-shared/issues/607)) ([0233958](https://github.com/adobe/spacecat-shared/commit/0233958f782e1cef24cc3df3c7445520697c1efa))
+
 # [@adobe/spacecat-shared-data-access-v2.5.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.4.0...@adobe/spacecat-shared-data-access-v2.5.0) (2025-02-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/models/configuration/configuration.model.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { isNonEmptyObject, isNonEmptyArray } from '@adobe/spacecat-shared-utils';
 
 import { sanitizeIdAndAuditFields } from '../../util/util.js';
 import BaseModel from '../base/base.model.js';
@@ -146,12 +146,58 @@ class Configuration extends BaseModel {
     const siteId = site.getId();
     if (this.isHandlerEnabledForSite(type, site)) return;
 
+    const deps = this.isHandlerDependencyMetForSite(type, site);
+    if (deps !== true) {
+      throw new Error(`Cannot enable handler ${type} for site ${siteId} because of missing dependencies: ${deps}`);
+    }
+
     this.updateHandlerSites(type, siteId, true);
   }
 
+  /**
+   * Check if all dependencies for a handler of given type are met for the given org.
+   *
+   * @param {string} type handler type
+   * @param {object} org org object
+   * @returns true if all dependencies are met, array with missing dependencies otherwise
+   */
+  isHandlerDependencyMetForOrg(type, org) {
+    const handler = this.getHandler(type);
+
+    if (!handler || !isNonEmptyArray(handler?.dependencies)) return true;
+
+    const unmetDependencies = handler.dependencies
+      .filter(({ handler: depHandler }) => !this.isHandlerEnabledForOrg(depHandler, org))
+      .map(({ handler: depHandler }) => depHandler);
+
+    return isNonEmptyArray(unmetDependencies) ? unmetDependencies : true;
+  }
+
+  /**
+   * Check if all dependencies for a handler of given type are met for the given site.
+   *
+   * @param {string} type handler type
+   * @param {object} site site object
+   * @returns true if all dependencies are met, array with missing dependencies otherwise
+   */
+  isHandlerDependencyMetForSite(type, site) {
+    const handler = this.getHandler(type);
+    if (!handler || !isNonEmptyArray(handler?.dependencies)) return true;
+
+    const unmetDependencies = handler.dependencies
+      .filter(({ handler: depHandler }) => !this.isHandlerEnabledForSite(depHandler, site))
+      .map(({ handler: depHandler }) => depHandler);
+
+    return isNonEmptyArray(unmetDependencies) ? unmetDependencies : true;
+  }
+
   enableHandlerForOrg(type, org) {
     const orgId = org.getId();
     if (this.isHandlerEnabledForOrg(type, org)) return;
+    const deps = this.isHandlerDependencyMetForOrg(type, org);
+    if (deps !== true) {
+      throw new Error(`Cannot enable handler ${type} for org ${orgId} because of missing dependencies: ${deps}`);
+    }
 
     this.updateHandlerOrgs(type, orgId, true);
   }

package/src/models/site/config.js

@@ -38,6 +38,11 @@ export const configSchema = Joi.object({
       name: Joi.string(),
       pattern: Joi.string(),
     })).optional(),
+    latestMetrics: Joi.object({
+      pageViewsChange: Joi.number(),
+      ctrChange: Joi.number(),
+      projectedTrafficValue: Joi.number(),
+    }),
   }).unknown(true)).unknown(true),
 }).unknown(true);
 
@@ -73,6 +78,7 @@ export const Config = (data = {}) => {
   self.getFixedURLs = (type) => state?.handlers?.[type]?.fixedURLs;
   self.getIncludedURLs = (type) => state?.handlers?.[type]?.includedURLs;
   self.getGroupedURLs = (type) => state?.handlers?.[type]?.groupedURLs;
+  self.getLatestMetrics = (type) => state?.handlers?.[type]?.latestMetrics;
   self.getFetchConfig = () => state?.fetchConfig;
 
   self.updateSlackConfig = (channel, workspace, invitedUserCount) => {
@@ -120,6 +126,12 @@ export const Config = (data = {}) => {
     validateConfiguration(state);
   };
 
+  self.updateLatestMetrics = (type, latestMetrics) => {
+    state.handlers = state.handlers || {};
+    state.handlers[type] = state.handlers[type] || {};
+    state.handlers[type].latestMetrics = latestMetrics;
+  };
+
   self.updateFetchConfig = (fetchConfig) => {
     state.fetchConfig = fetchConfig;
   };