feat: Track number of users invited to Slack #195 (#196)

Add `invitedUserCount` to Slack config.
adobe · Mar 25, 2024 · e808a42 · e808a42
1 parent 6e58ac9
commit e808a42
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/packages/spacecat-shared-data-access/src/models/site/config.js b/packages/spacecat-shared-data-access/src/models/site/config.js
@@ -17,6 +17,7 @@ export const configSchema = Joi.object({
   slack: Joi.object({
     workspace: Joi.string(),
     channel: Joi.string(),
+    invitedUserCount: Joi.number().integer().min(0),
   }),
   alerts: Joi.array().items(Joi.object({
     type: Joi.string().required(),

diff --git a/packages/spacecat-shared-data-access/test/unit/models/site/config.test.js b/packages/spacecat-shared-data-access/test/unit/models/site/config.test.js
@@ -34,6 +34,7 @@ describe('Config Tests', () => {
         slack: {
           channel: 'channel1',
           workspace: 'workspace1',
+          invitedUserCount: 3,
         },
         alerts: [{
           type: '404',
@@ -55,6 +56,7 @@ describe('Config Tests', () => {
       const config = Config(data);
       expect(config.slack.channel).to.equal('channel1');
       expect(config.slack.workspace).to.equal('workspace1');
+      expect(config.slack.invitedUserCount).to.equal(3);
       expect(config.alerts[0].mentions[0].slack[0]).to.equal('id1');
       expect(config.alerts[0].byOrg).to.be.true;
       expect(config.audits.auditsDisabled()).to.be.false;
@@ -67,6 +69,7 @@ describe('Config Tests', () => {
         slack: {
           channel: 'channel1',
           workspace: 'workspace1',
+          invitedUserCount: 19,
         },
         alerts: [{
           type: '404',
@@ -78,6 +81,7 @@ describe('Config Tests', () => {
       const config = Config(data);
       expect(config.slack.channel).to.equal('channel1');
       expect(config.slack.workspace).to.equal('workspace1');
+      expect(config.slack.invitedUserCount).to.equal(19);
       expect(config.alerts[0].mentions[0].slack[0]).to.equal('id1');
       expect(config.alerts[0].byOrg).to.be.true;
       expect(config.audits.auditsDisabled()).to.be.false;
@@ -97,6 +101,17 @@ describe('Config Tests', () => {
       };
       expect(() => Config(data)).to.throw('Configuration validation error: "alerts[0].type" must be a string');
     });
+
+    it('throws an error when invitedUserCount is invalid', () => {
+      const data = {
+        slack: {
+          channel: 'channel1',
+          workspace: 'workspace1',
+          invitedUserCount: -12,
+        },
+      };
+      expect(() => Config(data)).to.throw('Configuration validation error: "slack.invitedUserCount" must be greater than or equal to 0');
+    });
   });
 
   describe('fromDynamoItem Static Method', () => {