feat: add http proxy to slack plugin

intuit · May 11, 2020 · a56eae3 · a56eae3
1 parent 6259987
commit a56eae3
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 0 deletions.
diff --git a/plugins/slack/__tests__/__snapshots__/slack.test.ts.snap b/plugins/slack/__tests__/__snapshots__/slack.test.ts.snap
@@ -4,6 +4,10 @@ exports[`postToSlack should call slack api 1`] = `"{\\"text\\":\\"@channel: New
 
 exports[`postToSlack should call slack api in env var 1`] = `"{\\"text\\":\\"@channel: New release *<https://git.hub/some/project/releases/v1.0.0|v1.0.0>*\\\\n* My Notes*\\\\n• PR <google.com|some link>\\",\\"link_names\\":1}"`;
 
+exports[`postToSlack should call slack api through http proxy 1`] = `"{\\"text\\":\\"@channel: New release *<https://git.hub/some/project/releases/v1.0.0|v1.0.0>*\\\\n* My Notes*\\\\n• PR <google.com|some link>\\",\\"link_names\\":1}"`;
+
+exports[`postToSlack should call slack api through https proxy 1`] = `"{\\"text\\":\\"@channel: New release *<https://git.hub/some/project/releases/v1.0.0|v1.0.0>*\\\\n* My Notes*\\\\n• PR <google.com|some link>\\",\\"link_names\\":1}"`;
+
 exports[`postToSlack should call slack api with custom atTarget 1`] = `"{\\"text\\":\\"@here: New release *<https://git.hub/some/project/releases/v1.0.0|v1.0.0>*\\\\n* My Notes*\\\\n• PR <google.com|some link>\\",\\"link_names\\":1}"`;
 
 exports[`postToSlack should call slack api with minimal config 1`] = `"{\\"text\\":\\"@channel: New release *<https://git.hub/some/project/releases/v1.0.0|v1.0.0>*\\\\n* My Notes*\\\\n• PR <google.com|some link>\\",\\"link_names\\":1}"`;
diff --git a/plugins/slack/__tests__/slack.test.ts b/plugins/slack/__tests__/slack.test.ts
@@ -231,6 +231,48 @@ describe("postToSlack", () => {
     expect(fetchSpy.mock.calls[0][0]).toBe(
       "https://custom-slack-url?token=MY_TOKEN"
     );
+    expect(fetchSpy.mock.calls[0][1].agent).toBeUndefined()
+    expect(fetchSpy.mock.calls[0][1].body).toMatchSnapshot();
+  });
+
+  test("should call slack api through http proxy", async () => {
+    const plugin = new SlackPlugin("https://custom-slack-url");
+    process.env.SLACK_TOKEN = "MY_TOKEN";
+    process.env.http_proxy = "http-proxy"
+
+    await plugin.postToSlack(
+      mockAuto,
+      "1.0.0",
+      "# My Notes\n- PR [some link](google.com)",
+      // @ts-ignore
+      mockResponse
+    );
+
+    expect(fetchSpy).toHaveBeenCalled();
+    expect(fetchSpy.mock.calls[0][0]).toBe(
+      "https://custom-slack-url?token=MY_TOKEN"
+    );
+    expect(fetchSpy.mock.calls[0][1].agent).not.toBeUndefined()
+    expect(fetchSpy.mock.calls[0][1].body).toMatchSnapshot();
+  });
+  test("should call slack api through https proxy", async () => {
+    const plugin = new SlackPlugin("https://custom-slack-url");
+    process.env.SLACK_TOKEN = "MY_TOKEN";
+    process.env.https_proxy = "https-proxy"
+
+    await plugin.postToSlack(
+      mockAuto,
+      "1.0.0",
+      "# My Notes\n- PR [some link](google.com)",
+      // @ts-ignore
+      mockResponse
+    );
+
+    expect(fetchSpy).toHaveBeenCalled();
+    expect(fetchSpy.mock.calls[0][0]).toBe(
+      "https://custom-slack-url?token=MY_TOKEN"
+    );
+    expect(fetchSpy.mock.calls[0][1].agent).not.toBeUndefined()
     expect(fetchSpy.mock.calls[0][1].body).toMatchSnapshot();
   });
 

diff --git a/plugins/slack/package.json b/plugins/slack/package.json
@@ -41,6 +41,7 @@
     "@auto-it/core": "link:../../packages/core",
     "@octokit/rest": "16.43.1",
     "fp-ts": "^2.5.3",
+    "https-proxy-agent": "^5.0.0",
     "io-ts": "^2.1.2",
     "node-fetch": "2.6.0",
     "tslib": "1.11.1"

diff --git a/plugins/slack/src/index.ts b/plugins/slack/src/index.ts
@@ -1,5 +1,6 @@
 import { githubToSlack } from "@atomist/slack-messages";
 import { Octokit } from "@octokit/rest";
+import createHttpsProxyAgent from "https-proxy-agent";
 
 import {
   Auto,
@@ -144,6 +145,7 @@ export default class SlackPlugin implements IPlugin {
 
     const body = sanitizeMarkdown(releaseNotes);
     const token = process.env.SLACK_TOKEN;
+    const proxyUrl = process.env.https_proxy || process.env.http_proxy;
     const atTarget = this.options.atTarget;
     const urls = releases.map(
       (release) => `*<${release.data.html_url}|${release.data.name}>*`
@@ -161,6 +163,7 @@ export default class SlackPlugin implements IPlugin {
         link_names: 1,
       }),
       headers: { "Content-Type": "application/json" },
+      agent: proxyUrl ? createHttpsProxyAgent(proxyUrl) : undefined
     });
 
     auto.logger.verbose.info("Posted release notes to slack.");