fix: throttleOption defaults and REDIS_URL configuration (probot#1313)

.codesandbox/ci.json

@@ -0,0 +1,3 @@
+{
+  "sandboxes": ["new", "vanilla"]
+}

package.json

@@ -107,7 +107,7 @@
     "rimraf": "^3.0.2",
     "semantic-release": "^17.0.0",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
-    "smee-client": "^1.0.1",
+    "smee-client": "^1.2.2",
     "supertest": "^4.0.2",
     "ts-jest": "^26.1.1",
     "typedoc": "^0.17.0",

src/octokit/probot-octokit.ts

@@ -10,14 +10,7 @@ import { throttling } from "@octokit/plugin-throttling";
 import { probotRequestLogging } from "./octokit-plugin-probot-request-logging";
 import { VERSION } from "../version";
 
-export const ProbotOctokit = Octokit.plugin(
-  throttling,
-  retry,
-  paginateRest,
-  restEndpointMethods,
-  enterpriseCompatibility,
-  probotRequestLogging
-).defaults({
+const defaultOptions = {
   throttle: {
     onAbuseLimit: (
       retryAfter: number,
@@ -41,4 +34,22 @@ export const ProbotOctokit = Octokit.plugin(
     },
   },
   userAgent: `probot/${VERSION}`,
+};
+
+export const ProbotOctokit = Octokit.plugin(
+  throttling,
+  retry,
+  paginateRest,
+  restEndpointMethods,
+  enterpriseCompatibility,
+  probotRequestLogging
+).defaults((instanceOptions: any) => {
+  // merge throttle options deeply
+  const options = Object.assign({}, defaultOptions, instanceOptions, {
+    throttle: instanceOptions.throttle
+      ? Object.assign({}, defaultOptions.throttle, instanceOptions.throttle)
+      : defaultOptions.throttle,
+  });
+
+  return options;
 });

test/__snapshots__/index.test.ts.snap

@@ -7,7 +7,7 @@ exports[`Probot ghe support with http throws if the GHE host includes a protocol
 exports[`Probot run runs with a function as argument 1`] = `
 Object {
   "id": 1,
-  "port": 3003,
+  "port": 3000,
   "privateKey": "-----BEGIN RSA PRIVATE KEY-----
 MIIJKAIBAAKCAgEAu0E+tR6wfOAJZ4lASzRUmvorCgbI5nQyvZl3WLu6ko2pcEnq
 1t1/W/Yaovt9W8eMFVfoFXKhsHOAM5dFlktxOlcaUQiRYSO7fBbZYVNYoawnCRqD
@@ -69,7 +69,7 @@ wB98bfAGtcuCZWzgjgL67CS0pcNxadFA/TFo/NnynLBC4qRXSfFslKVE+Og=
 exports[`Probot run runs with an array of strings 1`] = `
 Object {
   "id": "1",
-  "port": "3003",
+  "port": 3000,
   "privateKey": "-----BEGIN RSA PRIVATE KEY-----
 MIIJKAIBAAKCAgEAu0E+tR6wfOAJZ4lASzRUmvorCgbI5nQyvZl3WLu6ko2pcEnq
 1t1/W/Yaovt9W8eMFVfoFXKhsHOAM5dFlktxOlcaUQiRYSO7fBbZYVNYoawnCRqD

test/index.test.ts

@@ -65,32 +65,56 @@ describe("Probot", () => {
       process.env = env;
     });
 
-    it("runs with a function as argument", async () => {
-      process.env.PORT = "3003";
+    it("runs with a function as argument", () => {
       let initialized = false;
-      probot = await Probot.run((app) => {
-        initialized = true;
+
+      return new Promise(async (resolve) => {
+        probot = await Probot.run((app) => {
+          initialized = true;
+        });
+        expect(probot.options).toMatchSnapshot();
+        expect(initialized).toBeTruthy();
+        probot.stop();
+
+        resolve();
+      });
+    });
+
+    it("runs with an array of strings", () => {
+      return new Promise(async (resolve) => {
+        probot = await Probot.run(["run", "file.js"]);
+        expect(probot.options).toMatchSnapshot();
+        probot.stop();
+        resolve();
       });
-      expect(probot.options).toMatchSnapshot();
-      expect(initialized).toBeTruthy();
-      probot.stop();
     });
 
-    it("runs with an array of strings", async () => {
-      probot = await Probot.run(["run", "file.js"]);
-      expect(probot.options).toMatchSnapshot();
-      probot.stop();
+    it("works with REDIS_URL configuration", () => {
+      process.env.REDIS_URL = "redis://test:test@localhost:6379";
+
+      return new Promise(async (resolve, reject) => {
+        const probot = await Probot.run((app) => {
+          app.auth(1).then(resolve, reject);
+        });
+        probot.stop();
+      });
     });
 
     it("runs without config and loads the setup app", async () => {
       let initialized = false;
       delete process.env.PRIVATE_KEY_PATH;
-      probot = await Probot.run((app) => {
-        initialized = true;
+      process.env.PORT = "3003";
+
+      return new Promise(async (resolve) => {
+        probot = await Probot.run((app) => {
+          initialized = true;
+        });
+        expect(probot.options).toMatchSnapshot();
+        expect(initialized).toBeFalsy();
+        probot.stop();
+
+        resolve();
       });
-      expect(probot.options).toMatchSnapshot();
-      expect(initialized).toBeFalsy();
-      probot.stop();
     });
   });