Merge pull request #45 from sourceallies/use-slack-channel-id

Update Slack integration to use `channelId` instead of `channelName`

Author: spacecostsmoney

.github/workflows/deploy.yml

@@ -69,4 +69,4 @@ jobs:
       # sam build
       - run: sam build --use-container
       # sam deploy
-      - run: sam deploy --no-confirm-changeset --no-fail-on-empty-changeset --parameter-overrides SlackTokenSecret=${{ secrets.SLACKTOKEN }} SmallImprovementsTokenSecret=${{ secrets.SITOKEN }} SlackChannel=goals ScheduleEnabled=true
+      - run: sam deploy --no-confirm-changeset --no-fail-on-empty-changeset --parameter-overrides SlackTokenSecret=${{ secrets.SLACKTOKEN }} SmallImprovementsTokenSecret=${{ secrets.SITOKEN }} SlackChannelId=CF4U95FN0 ScheduleEnabled=true

README.md

@@ -29,16 +29,16 @@ An Event that is triggered by a rule deployed and updated automatically by [SAM]
 Serves as the main hub of this stack, deployed and updated automatically by [SAM](#sam). 
 
 - Triggered by a CloudWatch Event, which is passed into its main function.
-- Assigns its Slack Channel name via Environment variables passed in by SAM.
+- Assigns its Slack Channel ID via Environment variables passed in by SAM.
 - Uses the SecretsManager to get both the Slack and Small Improvements tokens.
 - Gets all objectives using the Small Improvements API token.
 - Filters the objectives such that only those of a specific type, status, visibility, and time are left.
 - Log the number of objectives found.
-- For each of those objectives,the database is checked to see if it has an object with the same ID (returns a promise).
+- For each of those objectives, the database is checked to see if it has an object with the same ID (returns a promise).
   - If the objective was in the database, return undefined, there is nothing left to do for this objective.
   - If the objective was not in the database, it will try to post to Slack, which requires the following:
     - Try to get SlackID via the email address in the Small Improvements Objective.
-    - Format the slack message using the objective, its status, and the SlackID.
+    - Format the Slack message using the objective, its status, and the SlackID.
     - Try to send the message (if successful, resolves to the body of the HTTP response).
     - Try to insert the record of the objective into the database.
 - Finally, after all of the promises created from those objectives resolve, the data on number of successful and unsuccessful posts is logged and returned.

src/index.js

@@ -17,7 +17,7 @@ async function main(event, context) {
         Post message to Slack
         Put record in dynamodb
   */
-  const slackChannel = process.env.SlackChannel;
+  const slackChannelId = process.env.SlackChannelId;
   const secrets = await secretsClient.getSecret();
   const objectiveActivities = await smallImprovementsClient.GetObjectives(secrets.SIToken);
   const { completed, created } = filter.filterActivities(objectiveActivities, new Date(event.time));
@@ -29,7 +29,7 @@ async function main(event, context) {
         const SIEmail = await smallImprovementsClient.GetEmail(activity.content.objective.owner.id, secrets.SIToken);
         await slackService.PostCompletedObjective(
           secrets.SlackToken,
-          slackChannel,
+          slackChannelId,
           activity.content,
           activity.change.newStatus.description,
           SIEmail
@@ -47,7 +47,7 @@ async function main(event, context) {
         const SIEmail = await smallImprovementsClient.GetEmail(activity.content.objective.owner.id, secrets.SIToken);
         await slackService.PostCreatedObjective(
           secrets.SlackToken,
-          slackChannel,
+          slackChannelId,
           activity.content,
           SIEmail
         );

src/slack-service.js

@@ -1,15 +1,15 @@
 const slackClient = require('./slack');
 
 // Get Slack ID, Format Message, Post
-async function PostCompletedObjective(token, channelName, content, newStatus, email) {
+async function PostCompletedObjective(token, channelId, content, newStatus, email) {
   const slackID = await slackClient.getSlackID(email, token);
   const formattedMessage = await slackClient.formatSlackMessageForCompleted(content.objective, newStatus, slackID, content.cycle.id);
-  return await slackClient.slackPost(token, channelName, formattedMessage);
+  return await slackClient.slackPost(token, channelId, formattedMessage);
 }
-async function PostCreatedObjective(token, channelName, content, email) {
+async function PostCreatedObjective(token, channelId, content, email) {
   const slackID = await slackClient.getSlackID(email, token);
   const formattedMessage = await slackClient.formatSlackMessageForCreated(content.objective, slackID, content.cycle.id);
-  return await slackClient.slackPost(token, channelName, formattedMessage);
+  return await slackClient.slackPost(token, channelId, formattedMessage);
 }
 
 exports.PostCompletedObjective = PostCompletedObjective;

src/slack.js

@@ -4,8 +4,8 @@ const messageVariables = {
 };
 
 // Post a message to a channel your app is in using ID and message text
-async function slackPost(authToken, channelName, formattedMessage) { // postData should be JSON, e.g. { channel:"#channel", text:'message' }
-  formattedMessage.channel = '' + channelName;
+async function slackPost(authToken, channelId, formattedMessage) { // postData should be JSON, e.g. { channel:"#channel", text:'message' }
+  formattedMessage.channel = '' + channelId;
 
   const options = {
     hostname: 'sourceallies.slack.com',

template.yaml

@@ -10,10 +10,10 @@ Parameters:
     Type: String
     Description: The slack token
     NoEcho: true
-  SlackChannel:
+  SlackChannelId:
     Type: String
-    Description: The name of the slack channel to post messages to
-    Default: si-sandbox
+    Description: The id of the slack channel to post messages to
+    Default: C03HVBJ7WKC
   ScheduleEnabled:
     Type: String
     Description: Whether the lambda scheduled trigger is enabled or not
@@ -37,7 +37,7 @@ Resources:
       Timeout: 300
       Environment:
         Variables:
-          SlackChannel: !Ref SlackChannel
+          SlackChannelId: !Ref SlackChannelId
       Policies:
         - DynamoDBCrudPolicy:
             TableName: !Ref DynamoTable

test/index.test.js

@@ -17,16 +17,16 @@ describe('index', () => {
     activities,
     dynamoRecords,
     objectiveId,
-    slackChannel,
+    slackChannelId,
     mockEmail;
 
   afterEach(() => {
     jest.resetAllMocks();
   });
 
   beforeEach(() => {
-    slackChannel = 'si-sandbox';
-    process.env.SlackChannel = slackChannel;
+    slackChannelId = 'si-sandbox';
+    process.env.SlackChannelId = slackChannelId;
 
     eventDateString = '2022-06-02T00:00:00Z';
     event = {
@@ -112,7 +112,7 @@ describe('index', () => {
     expect(dynamodbClient.insertRecord).toHaveBeenCalledWith(activities.items[0].items[0].activities[1], 'CREATED');
     expect(slackClient.PostCompletedObjective).toHaveBeenCalledWith(
       secrets.SlackToken,
-      slackChannel,
+      slackChannelId,
       activities.items[0].items[0].activities[0].content,
       activities.items[0].items[0].activities[0].change.newStatus.description,
       mockEmail
@@ -147,14 +147,14 @@ describe('index', () => {
     expect(dynamodbClient.insertRecord).toHaveBeenCalledWith(activities.items[0].items[0].activities[1], 'CREATED');
     expect(slackClient.PostCompletedObjective).toHaveBeenCalledWith(
       secrets.SlackToken,
-      slackChannel,
+      slackChannelId,
       activities.items[0].items[0].activities[2].content,
       activities.items[0].items[0].activities[2].change.newStatus.description,
       mockEmail
     );
     expect(slackClient.PostCreatedObjective).toHaveBeenCalledWith(
       secrets.SlackToken,
-      slackChannel,
+      slackChannelId,
       activities.items[0].items[0].activities[1].content,
       mockEmail
     );