feat: make slack support channel configurable (#20)

Co-authored-by: Grégoire Paris <[email protected]>

.env.test

@@ -12,4 +12,6 @@ POSTGRES_PORT=54320
 POSTGRES_USER=root
 SLACK_BOT_USER_O_AUTH_ACCESS_TOKEN=SLACK_BOT_USER_O_AUTH_ACCESS_TOKEN
 SLACK_SIGNING_SECRET=SLACK_SIGNING_SECRET
+SLACK_SUPPORT_CHANNEL_ID=C0XXXXXXXXX
+SLACK_SUPPORT_CHANNEL_NAME=support-homer
 TICKET_MANAGEMENT_URL_PATTERN=https://my-ticket-management.com/view/{ticketId}

README.md

@@ -224,6 +224,14 @@ Create a `.env` file containing the following variables:
   The ticket management URL pattern for your organization, this is used to generate a link to the ticket in the changelog.
   It must contain the `{ticketId}` matcher to be replaced by the ticket ID, for instance `https://my-ticket-management.com/view/{ticketId}`.
 
+- `SLACK_SUPPORT_CHANNEL_ID`
+
+  This slack channel id is used to build a link displayed when a user enters the help command. People having trouble with Homer can be helped on this support channel.
+
+- `SLACK_SUPPORT_CHANNEL_NAME`
+
+  This slack channel name is displayed when a user enters the help command. People having trouble with Homer can be helped on this support channel.
+
 If you want Homer to connect to an **external PostgreSQL database**, you can set
 the following variables:
 

__tests__/review/displayHelpMessage.test.ts

@@ -0,0 +1,30 @@
+import { HTTP_STATUS_OK } from '@/constants';
+import { fetch } from '../utils/fetch';
+import { getSlackHeaders } from '../utils/getSlackHeaders';
+
+describe('help', () => {
+  it('help message should be displayed', async () => {
+    // Given
+    const channelId = 'channelId';
+    const userId = 'userId';
+    const body = {
+      channel_id: channelId,
+      text: 'help',
+      user_id: userId,
+    };
+
+    // When
+    const response = await fetch('/api/v1/homer/command', {
+      body,
+      headers: getSlackHeaders(body),
+    });
+    const slackMessage = await response.json();
+
+    // Then
+    expect(response.status).toEqual(HTTP_STATUS_OK);
+    expect(slackMessage.text).toContain('Here are the available commands:');
+    expect(slackMessage.text).toContain(
+      "Don't hesitate to join me on #support-homer to take a beer!"
+    );
+  });
+});

config/homer/projectReleaseConfigs.ts

@@ -1,14 +1,14 @@
-import { MOES_TAVERN_CHANNEL_ID } from '@/constants';
+import { SLACK_SUPPORT_CHANNEL_ID } from '@/constants';
 import { defaultReleaseManager } from '@/release/commands/create/managers/defaultReleaseManager';
 import { stableDateReleaseTagManager } from '@/release/commands/create/managers/stableDateReleaseTagManager';
 import type { ProjectReleaseConfig } from '@/release/typings/ProjectReleaseConfig';
 
 export const projectReleaseConfigs: ProjectReleaseConfig[] = [
   // tools/homer
   {
-    notificationChannelIds: [MOES_TAVERN_CHANNEL_ID],
+    notificationChannelIds: [SLACK_SUPPORT_CHANNEL_ID],
     projectId: 1148,
-    releaseChannelId: MOES_TAVERN_CHANNEL_ID,
+    releaseChannelId: SLACK_SUPPORT_CHANNEL_ID,
     releaseManager: defaultReleaseManager,
     releaseTagManager: stableDateReleaseTagManager,
   },

src/constants.ts

@@ -1,4 +1,5 @@
 import type { GitlabMergeRequestState } from '@/core/typings/GitlabMergeRequest';
+import { getEnvVariable } from '@/core/utils/getEnvVariable';
 
 export const CHANNEL_NOT_FOUND_SLACK_ERROR = 'channel_not_found';
 export const EXPIRED_TRIGGER_ID_ERROR_MESSAGE =
@@ -18,7 +19,12 @@ export const MERGE_REQUEST_OPEN_STATES: GitlabMergeRequestState[] = [
   'opened',
   'reopened',
 ];
-export const MOES_TAVERN_CHANNEL_ID = 'C01FCCQGP3M';
+export const SLACK_SUPPORT_CHANNEL_ID = getEnvVariable(
+  'SLACK_SUPPORT_CHANNEL_ID'
+);
+export const SLACK_SUPPORT_CHANNEL_NAME = getEnvVariable(
+  'SLACK_SUPPORT_CHANNEL_NAME'
+);
 export const PRIVATE_CHANNEL_ERROR_MESSAGE =
   'D’oh! It looks like you tried to use me on a private channel I’m not in. Please invite me using `/invite @homer` so I can publish messages :homer-donut:';
 export const REQUEST_BODY_SIZE_LIMIT = '500kb';

src/core/viewBuilders/buildHelpMessage.ts

@@ -1,5 +1,8 @@
 import type { ChatPostMessageArguments } from '@slack/web-api';
-import { MOES_TAVERN_CHANNEL_ID } from '@/constants';
+import {
+  SLACK_SUPPORT_CHANNEL_ID,
+  SLACK_SUPPORT_CHANNEL_NAME,
+} from '@/constants';
 
 export function buildHelpMessage(channelId: string): ChatPostMessageArguments {
   return {
@@ -14,7 +17,7 @@ Here are the available commands:
 - /homer review <search> - Share a merge request on a channel. Searches in title and description by default. Accepts merge request URLs and merge request IDs prefixed with "!".
 - /homer review list - List ongoing reviews shared in a channel.
 
-Don't hesitate to join me on #moes-tavern-homer to take a beer!`,
+Don't hesitate to join me on #${SLACK_SUPPORT_CHANNEL_NAME} to take a beer!`,
     blocks: [
       {
         type: 'section',
@@ -30,7 +33,7 @@ Here are the available commands:
 •   \`/homer review <search>\` Share a merge request on a channel. Searches in title and description by default. Accepts merge request URLs and merge request IDs prefixed with "!".
 •   \`/homer review list\` List ongoing reviews shared in a channel.
 
-Don't hesitate to join me on <#${MOES_TAVERN_CHANNEL_ID}> to take a :beer:!`,
+Don't hesitate to join me on <#${SLACK_SUPPORT_CHANNEL_ID}> to take a :beer:!`,
         },
       },
     ],

src/home/buildAppHomeView.ts

@@ -1,5 +1,5 @@
 import type { View } from '@slack/web-api';
-import { HOMER_GIT_URL, MOES_TAVERN_CHANNEL_ID } from '@/constants';
+import { HOMER_GIT_URL, SLACK_SUPPORT_CHANNEL_ID } from '@/constants';
 import type { SlackUser } from '@/core/typings/SlackUser';
 
 export async function buildAppHomeView(user: SlackUser): Promise<View> {
@@ -15,7 +15,7 @@ export async function buildAppHomeView(user: SlackUser): Promise<View> {
           text: `\
 Hello *${firstName}*, I'm *Homer*, the Slack Gitlab master!
 
-If you want to take a :beer: with me, don't hesitate to join <#${MOES_TAVERN_CHANNEL_ID}>.
+If you want to take a :beer: with me, don't hesitate to join <#${SLACK_SUPPORT_CHANNEL_ID}>.
 
 If you want to better know me, here are some useful links: