feat(audit-configs): ess audits disabled by default

adobe · Jun 20, 2024 · e55af1c · e55af1c
1 parent c84df02
commit e55af1c
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/packages/spacecat-shared-data-access/src/models/audit.js b/packages/spacecat-shared-data-access/src/models/audit.js
@@ -22,6 +22,8 @@ export const AUDIT_TYPE_ORGANIC_TRAFFIC = 'organic-traffic';
 export const AUDIT_TYPE_CWV = 'cwv';
 export const AUDIT_TYPE_LHS_DESKTOP = 'lhs-desktop';
 export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
+export const AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY = 'experimentation-ess-monthly';
+export const AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY = 'experimentation-ess-daily';
 
 const EXPIRES_IN_DAYS = 30;
 

diff --git a/packages/spacecat-shared-data-access/src/models/site/audit-config.js b/packages/spacecat-shared-data-access/src/models/site/audit-config.js
@@ -13,12 +13,16 @@
 import AuditConfigType from './audit-config-type.js';
 import {
   AUDIT_TYPE_BROKEN_BACKLINKS,
+  AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY,
+  AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY,
   AUDIT_TYPE_ORGANIC_KEYWORDS,
   AUDIT_TYPE_ORGANIC_TRAFFIC,
 } from '../audit.js';
 
 const AUDIT_TYPE_DISABLED_DEFAULTS = {
   [AUDIT_TYPE_BROKEN_BACKLINKS]: true,
+  [AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY]: true,
+  [AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY]: true,
   [AUDIT_TYPE_ORGANIC_KEYWORDS]: true,
   [AUDIT_TYPE_ORGANIC_TRAFFIC]: true,
 };
@@ -27,6 +31,8 @@ function getAuditTypeConfigs(auditTypeConfigs, auditsDisabled) {
   if (!auditTypeConfigs || Object.keys(auditTypeConfigs).length === 0) {
     return {
       [AUDIT_TYPE_BROKEN_BACKLINKS]: AuditConfigType({ disabled: true }),
+      [AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY]: AuditConfigType({ disabled: true }),
+      [AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY]: AuditConfigType({ disabled: true }),
       [AUDIT_TYPE_ORGANIC_KEYWORDS]: AuditConfigType({ disabled: true }),
       [AUDIT_TYPE_ORGANIC_TRAFFIC]: AuditConfigType({ disabled: true }),
     };

diff --git a/packages/spacecat-shared-data-access/test/unit/models/site/audit-config.test.js b/packages/spacecat-shared-data-access/test/unit/models/site/audit-config.test.js
@@ -16,7 +16,11 @@ import { expect } from 'chai';
 
 import AuditConfig from '../../../../src/models/site/audit-config.js';
 import {
-  AUDIT_TYPE_BROKEN_BACKLINKS, AUDIT_TYPE_ORGANIC_KEYWORDS, AUDIT_TYPE_ORGANIC_TRAFFIC,
+  AUDIT_TYPE_BROKEN_BACKLINKS,
+  AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY,
+  AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY,
+  AUDIT_TYPE_ORGANIC_KEYWORDS,
+  AUDIT_TYPE_ORGANIC_TRAFFIC,
 } from '../../../../src/models/audit.js';
 
 describe('AuditConfig Tests', () => {
@@ -27,6 +31,10 @@ describe('AuditConfig Tests', () => {
       const auditTypeConfigs = auditConfig.getAuditTypeConfigs();
       expect(auditTypeConfigs[AUDIT_TYPE_BROKEN_BACKLINKS]).to.be.an('object');
       expect(auditTypeConfigs[AUDIT_TYPE_BROKEN_BACKLINKS].disabled()).to.be.true;
+      expect(auditTypeConfigs[AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY]).to.be.an('object');
+      expect(auditTypeConfigs[AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY].disabled()).to.be.true;
+      expect(auditTypeConfigs[AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY]).to.be.an('object');
+      expect(auditTypeConfigs[AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY].disabled()).to.be.true;
       expect(auditTypeConfigs[AUDIT_TYPE_ORGANIC_KEYWORDS]).to.be.an('object');
       expect(auditTypeConfigs[AUDIT_TYPE_ORGANIC_KEYWORDS].disabled()).to.be.true;
       expect(auditTypeConfigs[AUDIT_TYPE_ORGANIC_TRAFFIC]).to.be.an('object');

diff --git a/packages/spacecat-shared-utils/test/helpers.test.js b/packages/spacecat-shared-utils/test/helpers.test.js
@@ -15,7 +15,11 @@
 import { expect } from 'chai';
 import { createSite } from '@adobe/spacecat-shared-data-access/src/models/site.js';
 import { createOrganization } from '@adobe/spacecat-shared-data-access/src/models/organization.js';
-import { AUDIT_TYPE_BROKEN_BACKLINKS } from '@adobe/spacecat-shared-data-access/src/models/audit.js';
+import {
+  AUDIT_TYPE_BROKEN_BACKLINKS,
+  AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY,
+  AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY,
+} from '@adobe/spacecat-shared-data-access/src/models/audit.js';
 
 import {
   generateCSVFile,
@@ -234,6 +238,8 @@ describe('isAuditsDisabled', () => {
     });
 
     expect(isAuditsDisabled(site, org, AUDIT_TYPE_BROKEN_BACKLINKS)).to.be.true;
+    expect(isAuditsDisabled(site, org, AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY)).to.be.true;
+    expect(isAuditsDisabled(site, org, AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY)).to.be.true;
   });
 });