Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: default value for disabled property of audit config #114

Merged
merged 4 commits into from
Jan 29, 2024
Merged

feat: default value for disabled property of audit config #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54db4bb
feat: default value for disabled property of audit config
iuliag Jan 26, 2024
2a28022
test: adjust tests
iuliag Jan 26, 2024
1697008
test: adjust tests
iuliag Jan 26, 2024
e60ccc0
test: adjust tests
iuliag Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion packages/spacecat-shared-data-access/src/models/site/audit-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,27 @@
*/

import AuditConfigType from './audit-config-type.js';
import { AUDIT_TYPE_BROKEN_BACKLINKS } from '../audit.js';

const AUDIT_TYPE_DISABLED_DEFAULTS = {
[AUDIT_TYPE_BROKEN_BACKLINKS]: true,
};

function getAuditTypeConfigs(auditTypeConfigs, auditsDisabled) {
if (!auditTypeConfigs || Object.keys(auditTypeConfigs).length === 0) {
return {
[AUDIT_TYPE_BROKEN_BACKLINKS]: AuditConfigType({ disabled: true }),
};
}
return Object.entries(auditTypeConfigs || {}).reduce((acc, [key, value]) => {
acc[key] = AuditConfigType(value, auditsDisabled);
const disabled = value.disabled !== undefined
? value.disabled : (AUDIT_TYPE_DISABLED_DEFAULTS[key] || auditsDisabled || false);
acc[key] = AuditConfigType(
{
...value,
disabled,
},
);
return acc;
}, {});
}
Expand Down
4 changes: 2 additions & 2 deletions packages/spacecat-shared-data-access/test/unit/models/site.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ describe('Site Model Tests', () => {
expect(auditConfig).to.be.an('object');
expect(auditConfig.auditsDisabled()).to.be.true;
expect(auditConfig.getAuditTypeConfig('type1')).to.be.an('object');
expect(auditConfig.getAuditTypeConfig('type1').disabled()).to.be.false;
expect(auditConfig.getAuditTypeConfig('type1').disabled()).to.be.true;
expect(auditConfig.getAuditTypeConfig('type2')).to.be.an('object');
expect(auditConfig.getAuditTypeConfig('type2').disabled()).to.be.false;
expect(auditConfig.getAuditTypeConfig('type2').disabled()).to.be.true;
});
});

Expand Down
18 changes: 6 additions & 12 deletions packages/spacecat-shared-data-access/test/unit/models/site/audit-config.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,30 @@
import { expect } from 'chai';

import AuditConfig from '../../../../src/models/site/audit-config.js';
import { AUDIT_TYPE_BROKEN_BACKLINKS } from '../../../../src/models/audit.js';

describe('AuditConfig Tests', () => {
describe('AuditConfig Creation', () => {
it('creates an AuditConfig with defaults when no data is provided', () => {
const auditConfig = AuditConfig();
expect(auditConfig.auditsDisabled()).to.be.false;
expect(auditConfig.getAuditTypeConfigs()).to.be.empty;
const auditTypeConfigs = auditConfig.getAuditTypeConfigs();
expect(auditTypeConfigs[AUDIT_TYPE_BROKEN_BACKLINKS]).to.be.an('object');
expect(auditTypeConfigs[AUDIT_TYPE_BROKEN_BACKLINKS].disabled()).to.be.true;
});

it('creates an AuditConfig with provided data', () => {
const data = {
auditsDisabled: true,
auditTypeConfigs: {
type1: { disabled: true },
type2: { disabled: false },
[AUDIT_TYPE_BROKEN_BACKLINKS]: { disabled: false },
},
};
const auditConfig = AuditConfig(data);
expect(auditConfig.auditsDisabled()).to.be.true;
expect(auditConfig.getAuditTypeConfig('type1').disabled()).to.be.true;
expect(auditConfig.getAuditTypeConfig('type2').disabled()).to.be.false;
expect(auditConfig.getAuditTypeConfig(AUDIT_TYPE_BROKEN_BACKLINKS).disabled()).to.be.false;
});
});

Expand Down Expand Up @@ -75,15 +78,6 @@ describe('AuditConfig Tests', () => {
const typeConfigs = auditConfig.getAuditTypeConfigs();
expect(typeConfigs).to.have.keys(['type1', 'type2']);
});

it('returns no audit type configurations', () => {
const data = {
auditTypeConfigs: {},
};
const auditConfig = AuditConfig(data);
const typeConfigs = auditConfig.getAuditTypeConfigs();
expect(typeConfigs).to.be.an('object').that.is.empty;
});
});

describe('updateAuditsDisabled Method', () => {
Expand Down
Loading