feat: v6 (#592)

BREAKING CHANGE: Drop support for NodeJS v14, v16
BREAKING CHANGE: remove deprecated `options.throttle.minimalSecondaryRateRetryAfter`
BREAKING CHANGE: remove deprecated `options.throttle.onAbuseLimit`

Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>

Author: wolfy1339

.github/workflows/test.yml

@@ -13,9 +13,8 @@ jobs:
     strategy:
       matrix:
         node_version:
-          - 14
-          - 16
           - 18
+          - 20
     steps:
       - uses: actions/checkout@v3
       - name: Test with Node.js ${{ matrix.node_version }}

package-lock.json

@@ -64,7 +64,7 @@
       [
         "@pika/plugin-build-node",
         {
-          "minNodeVersion": "14"
+          "minNodeVersion": 18
         }
       ],
       [
@@ -105,6 +105,6 @@
     ]
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 18"
   }
 }

package.json

@@ -59,29 +59,6 @@ export function throttling(octokit: Octokit, octokitOptions: OctokitOptions) {
     createGroups(Bottleneck, common);
   }
 
-  if (
-    octokitOptions.throttle &&
-    octokitOptions.throttle.minimalSecondaryRateRetryAfter
-  ) {
-    octokit.log.warn(
-      "[@octokit/plugin-throttling] `options.throttle.minimalSecondaryRateRetryAfter` is deprecated, please use `options.throttle.fallbackSecondaryRateRetryAfter` instead"
-    );
-    octokitOptions.throttle.fallbackSecondaryRateRetryAfter =
-      octokitOptions.throttle.minimalSecondaryRateRetryAfter;
-    delete octokitOptions.throttle.minimalSecondaryRateRetryAfter;
-  }
-
-  if (octokitOptions.throttle && octokitOptions.throttle.onAbuseLimit) {
-    octokit.log.warn(
-      "[@octokit/plugin-throttling] `onAbuseLimit()` is deprecated and will be removed in a future release of `@octokit/plugin-throttling`, please use the `onSecondaryRateLimit` handler instead"
-    );
-    // @ts-ignore types don't allow for both properties to be set
-    octokitOptions.throttle.onSecondaryRateLimit =
-      octokitOptions.throttle.onAbuseLimit;
-    // @ts-ignore
-    delete octokitOptions.throttle.onAbuseLimit;
-  }
-
   const state = Object.assign(
     {
       clustering: connection != null,

src/index.ts

@@ -8,19 +8,7 @@ type LimitHandler = (
   retryCount: number
 ) => void;
 
-export type AbuseLimitHandler = {
-  /**
-   * @deprecated "[@octokit/plugin-throttling] `onAbuseLimit()` is deprecated and will be removed in a future release of `@octokit/plugin-throttling`, please use the `onSecondaryRateLimit` handler instead"
-   */
-  onAbuseLimit: LimitHandler;
-  onSecondaryRateLimit?: never;
-};
-
 export type SecondaryLimitHandler = {
-  /**
-   * @deprecated "[@octokit/plugin-throttling] `onAbuseLimit()` is deprecated and will be removed in a future release of `@octokit/plugin-throttling`, please use the `onSecondaryRateLimit` handler instead"
-   */
-  onAbuseLimit?: never;
   onSecondaryRateLimit: LimitHandler;
 };
 
@@ -43,10 +31,10 @@ export type ThrottlingOptionsBase = {
 };
 
 export type ThrottlingOptions =
-  | (ThrottlingOptionsBase & (AbuseLimitHandler | SecondaryLimitHandler))
-  | (Partial<
-      ThrottlingOptionsBase & (AbuseLimitHandler | SecondaryLimitHandler)
-    > & { enabled: false });
+  | (ThrottlingOptionsBase & SecondaryLimitHandler)
+  | (Partial<ThrottlingOptionsBase & SecondaryLimitHandler> & {
+      enabled: false;
+    });
 
 export type Groups = {
   global?: Bottleneck.Group;

src/types.ts

@@ -3,44 +3,6 @@ import { throttling } from "../src";
 
 const TestOctokit = Octokit.plugin(throttling);
 
-describe("deprecations", () => {
-  it("throttle.minimalSecondaryRateRetryAfter option", () => {
-    const log = {
-      warn: jest.fn(),
-    };
-    new TestOctokit({
-      // @ts-expect-error
-      log,
-      throttle: {
-        minimalSecondaryRateRetryAfter: 1,
-        onSecondaryRateLimit: () => 1,
-        onRateLimit: () => 1,
-      },
-    });
-
-    expect(log.warn).toHaveBeenCalledWith(
-      "[@octokit/plugin-throttling] `options.throttle.minimalSecondaryRateRetryAfter` is deprecated, please use `options.throttle.fallbackSecondaryRateRetryAfter` instead"
-    );
-  });
-
-  describe("throttle.onAbuseLimit", function () {
-    it("Should detect SecondaryRate limit and broadcast event", async function () {
-      const log = {
-        warn: jest.fn(),
-      };
-
-      new TestOctokit({
-        // @ts-expect-error
-        log,
-        throttle: {
-          onAbuseLimit: () => 1,
-          onRateLimit: () => 1,
-        },
-      });
-
-      expect(log.warn).toHaveBeenCalledWith(
-        "[@octokit/plugin-throttling] `onAbuseLimit()` is deprecated and will be removed in a future release of `@octokit/plugin-throttling`, please use the `onSecondaryRateLimit` handler instead"
-      );
-    });
-  });
+describe.skip("deprecations", () => {
+  it("No deprecations", () => {});
 });

test/deprecations.test.ts

@@ -121,53 +121,6 @@ describe("Events", function () {
           expect(error.status).toEqual(403);
         }
 
-        expect(eventCount).toEqual(1);
-      });
-    });
-    describe("with 'onSecondaryRateLimit'", function () {
-      it("Should detect SecondaryRate limit and broadcast event", async function () {
-        let eventCount = 0;
-
-        const octokit = new TestOctokit({
-          throttle: {
-            onSecondaryRateLimit: (retryAfter, options, octokitFromOptions) => {
-              expect(octokit).toBe(octokitFromOptions);
-              expect(retryAfter).toEqual(60);
-              expect(options).toMatchObject({
-                method: "GET",
-                url: "/route2",
-                request: { retryCount: 0 },
-              });
-              eventCount++;
-            },
-            onRateLimit: () => 1,
-          },
-        });
-
-        await octokit.request("GET /route1", {
-          request: {
-            responses: [{ status: 201, headers: {}, data: {} }],
-          },
-        });
-        try {
-          await octokit.request("GET /route2", {
-            request: {
-              responses: [
-                {
-                  status: 403,
-                  headers: { "retry-after": "60" },
-                  data: {
-                    message: "You have exceeded a secondary rate limit",
-                  },
-                },
-              ],
-            },
-          });
-          throw new Error("Should not reach this point");
-        } catch (error: any) {
-          expect(error.status).toEqual(403);
-        }
-
         expect(eventCount).toEqual(1);
       });
     });

test/events.test.ts

@@ -6,12 +6,6 @@ import { throttling } from "../src/index";
 
 const octokit = new Octokit();
 
-// will be deprecated soon
-// onAbuseLimit()
-throttling(octokit, {
-  throttle: { enabled: true, onRateLimit: () => {}, onAbuseLimit: () => {} },
-});
-
 // onSecondaryLimit()
 throttling(octokit, {
   throttle: {
@@ -21,22 +15,10 @@ throttling(octokit, {
   },
 });
 
-// onSecondaryLimit() and onAbuseLimit() should be a TS Error
-throttling(octokit, {
-  // @ts-expect-error
-  throttle: {
-    enabled: true,
-    onRateLimit: () => {},
-    onSecondaryRateLimit: () => {},
-    onAbuseLimit: () => {},
-  },
-});
-
 // onRateLimit() missing should be a TS Error
 throttling(octokit, {
   // @ts-expect-error
   throttle: {
-    enabled: true,
     onSecondaryRateLimit: () => {},
   },
 });
@@ -45,7 +27,6 @@ throttling(octokit, {
 throttling(octokit, {
   // @ts-expect-error
   throttle: {
-    enabled: true,
     onRateLimit: () => {},
   },
 });