feat: silence slack messages during quiet period (#17)

electron · Dec 5, 2023 · 1ccd5db · 1ccd5db
1 parent b9c2f64
commit 1ccd5db
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 11 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,7 @@
 import { Probot } from 'probot';
 import { EventPayloads } from '@octokit/webhooks';
 import { WebClient } from '@slack/web-api';
+import { isQuietPeriod } from './util';
 
 const API_REVIEW_REQUESTED_LABEL_ID = 1603621692; // api-review/requested
 const { SLACK_BOT_TOKEN, NODE_ENV } = process.env;
@@ -21,11 +22,12 @@ async function postToSlack(pr: EventPayloads.WebhookPayloadPullRequestPullReques
     /[&<>]/g,
     (x) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;' })[x]!,
   );
+  const name = isQuietPeriod() ? 'API WG' : '<!subteam^SNSJW1BA9>';
   await slack.chat.postMessage({
     channel: '#wg-api',
     unfurl_links: false,
     text:
-      `Hey <!subteam^SNSJW1BA9>! Just letting you know that the following PR needs API review:\n` +
+      `Hey ${name}! Just letting you know that the following PR needs API review:\n` +
       `*<${pr._links.html.href}|${escapedTitle} (#${pr.number})>*`,
   });
 }

diff --git a/src/remind.ts b/src/remind.ts
@@ -1,5 +1,6 @@
 import { ProbotOctokit } from 'probot';
 import { WebClient } from '@slack/web-api';
+import { isQuietPeriod } from './util';
 const { SLACK_BOT_TOKEN, NODE_ENV } = process.env;
 
 if (!SLACK_BOT_TOKEN && NODE_ENV !== 'test') {
@@ -18,7 +19,9 @@ async function main() {
     q: `repo:electron/electron ${q}`,
     sort: 'created',
   });
-  if (items.length) {
+
+  // silence during quiet period
+  if (items.length && !isQuietPeriod()) {
     const text =
       `:blob-wave: *Reminder:* the <${searchUrl}|following PRs> are awaiting API review.\n` +
       items

diff --git a/src/util.ts b/src/util.ts
@@ -0,0 +1,6 @@
+/**
+ * If the current date on runtime matches Electron's quiet period
+ */
+export function isQuietPeriod() {
+  return new Date().getMonth() === 11;
+}
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -29,17 +29,39 @@ describe('New PR Slack Notifications', () => {
     probot.load(zoilist);
   });
 
-  it('posts to slack when the api-review/requested label is added', async () => {
-    const payload = require('./fixtures/pull_request.labeled.semver_minor.json');
+  afterEach(() => {
+    jest.useRealTimers();
+  });
 
-    await probot.receive({ name: 'pull_request', payload, id: 'abc123' });
+  describe('when the `api-review/requested` label is added', () => {
+    it('posts to slack', async () => {
+      jest.useFakeTimers('modern').setSystemTime(new Date('2023-11-11'));
+      const payload = require('./fixtures/pull_request.labeled.semver_minor.json');
+
+      await probot.receive({ name: 'pull_request', payload, id: 'abc123' });
+
+      expect(client.chat.postMessage).toHaveBeenCalledWith({
+        channel: '#wg-api',
+        unfurl_links: false,
+        text:
+          `Hey <!subteam^SNSJW1BA9>! Just letting you know that the following PR needs API review:\n` +
+          '*<https://github.com/electron/electron/pull/38982|feat: add `BrowserWindow.isOccluded()` (#38982)>*',
+      });
+    });
+
+    it('does not @mention anyone in the month of December', async () => {
+      jest.useFakeTimers('modern').setSystemTime(new Date('2023-12-25'));
+      const payload = require('./fixtures/pull_request.labeled.semver_minor.json');
+
+      await probot.receive({ name: 'pull_request', payload, id: 'abc123' });
 
-    expect(client.chat.postMessage).toHaveBeenCalledWith({
-      channel: '#wg-api',
-      unfurl_links: false,
-      text:
-        `Hey <!subteam^SNSJW1BA9>! Just letting you know that the following PR needs API review:\n` +
-        '*<https://github.com/electron/electron/pull/38982|feat: add `BrowserWindow.isOccluded()` (#38982)>*',
+      expect(client.chat.postMessage).toHaveBeenCalledWith({
+        channel: '#wg-api',
+        unfurl_links: false,
+        text:
+          `Hey API WG! Just letting you know that the following PR needs API review:\n` +
+          '*<https://github.com/electron/electron/pull/38982|feat: add `BrowserWindow.isOccluded()` (#38982)>*',
+      });
     });
   });