.github/workflows/codeql-analysis.yml

@@ -23,23 +23,18 @@ jobs:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.
         fetch-depth: 2
-
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
-
+
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@3f62b754e23e0dd60f91b744033e1dc1654c0ec6 # tag=v2
+      uses: github/codeql-action/init@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2
       # Override language selection by uncommenting this and choosing your languages
       # with:
       #   languages: go, javascript, csharp, python, cpp, java
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@3f62b754e23e0dd60f91b744033e1dc1654c0ec6 # tag=v2
+      uses: github/codeql-action/autobuild@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -53,4 +48,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@3f62b754e23e0dd60f91b744033e1dc1654c0ec6 # tag=v2
+      uses: github/codeql-action/analyze@3e7e3b32d0fb8283594bb0a76cc60a00918b0969 # tag=v2

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
-      - uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # tag=v3
+      - uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3
         with:
           node-version: 16
           cache: npm

.github/workflows/test.yml

@@ -9,7 +9,7 @@ name: Test
       - opened
       - synchronize
 jobs:
-  test:
+  test_matrix:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -20,11 +20,18 @@ jobs:
     steps:
       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
       - name: "Use Node.js ${{ matrix.node_version }}"
-        uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # tag=v3
+        uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3
         with:
           node-version: "${{ matrix.node_version }}"
           cache: npm
       - name: Install
         run: npm ci
       - name: Test
-        run: npm test
+        run: npm test --ignore-scripts # run lint only once
+  test:
+    runs-on: ubuntu-latest
+    needs: test_matrix
+    steps:
+      - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
+      - run: npm ci
+      - run: npm run lint

.github/workflows/update-prettier.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
-      - uses: actions/setup-node@eeb10cff27034e7acf239c5d29f62154018672fd # tag=v3
+      - uses: actions/setup-node@2fddd8803e2f5c9604345a0b591c3020ee971a93 # tag=v3
         with:
           node-version: 16
           cache: npm

README.md

@@ -11,7 +11,7 @@ to interact with [GitHub’s REST API](https://developer.github.com/v3/) and
 
 It uses [`@octokit/endpoint`](https://github.com/octokit/endpoint.js) to parse
 the passed options and sends the request using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
-([node-fetch](https://github.com/bitinn/node-fetch) in Node).
+([node-fetch](https://github.com/bitinn/node-fetch) when the runtime has no native `fetch` API).
 
 <!-- update table of contents by running `npx markdown-toc README.md -i` -->
 
@@ -419,6 +419,8 @@ If an error occurs, the promise is rejected with an `error` object containing 3
 - `error.request` The request options such as `method`, `url` and `data`
 - `error.response` The http response object with `url`, `headers`, and `data`
 
+If the error is due to an `AbortSignal` being used, the resulting `AbortError` is bubbled up to the caller.
+
 ## `request.defaults()`
 
 Override or set default options. Example:

package.json

@@ -23,15 +23,15 @@
   "license": "MIT",
   "dependencies": {
     "@octokit/endpoint": "^7.0.0",
-    "@octokit/request-error": "^2.1.0",
-    "@octokit/types": "^6.16.1",
+    "@octokit/request-error": "^3.0.0",
+    "@octokit/types": "^7.0.0",
     "is-plain-object": "^5.0.0",
     "node-fetch": "^2.6.7",
     "universal-user-agent": "^6.0.0"
   },
   "devDependencies": {
     "@octokit/auth-app": "^4.0.0",
-    "@pika/pack": "^0.5.0",
+    "@pika/pack": "^0.3.7",
     "@pika/plugin-build-node": "^0.9.0",
     "@pika/plugin-build-web": "^0.9.0",
     "@pika/plugin-ts-standard-pkg": "^0.9.0",

src/fetch-wrapper.ts

@@ -27,7 +27,9 @@ export default function fetchWrapper(
   let url: string;
 
   const fetch: typeof nodeFetch =
-    (requestOptions.request && requestOptions.request.fetch) || nodeFetch;
+    (requestOptions.request && requestOptions.request.fetch) ||
+    globalThis.fetch ||
+    /* istanbul ignore next */ nodeFetch;
 
   return fetch(
     requestOptions.url,
@@ -115,7 +117,6 @@ export default function fetchWrapper(
 
       return getResponseData(response);
     })
-
     .then((data) => {
       return {
         status,
@@ -124,9 +125,9 @@ export default function fetchWrapper(
         data,
       };
     })
-
     .catch((error) => {
       if (error instanceof RequestError) throw error;
+      else if (error.name === "AbortError") throw error;
 
       throw new RequestError(error.message, 500, {
         request: requestOptions,

test/request.test.ts

@@ -578,6 +578,8 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
   it("options.request.signal is passed as option to fetch", function () {
     return request("/", {
       request: {
+        // We pass a value that is not an `AbortSignal`, and expect `fetch` to
+        // throw an exception complaining about the value
         signal: "funk",
       },
     })
@@ -586,8 +588,13 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       })
 
       .catch((error) => {
-        expect(error.message).toMatch(/\bsignal\b/i);
-        expect(error.message).toMatch(/\bAbortSignal\b/i);
+        // We can't match on the entire string because the message differs between
+        // Node versions.
+        //
+        // In v14 and v16, the message just mentions "signal" and has `instanceof`
+        // as one word, whereas in v18 it contains the stringified signal and uses
+        // proper English ("instance of").
+        expect(error.message).toMatch(/to be an instance ?of AbortSignal/);
       });
   });
 
@@ -1011,4 +1018,51 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       expect(mock.done()).toBe(true);
     });
   });
+
+  it("bubbles up AbortError if the request is aborted", () => {
+    // AbortSignal and AbortController do not exist on
+    // Node < 15. The main parts of their API have been
+    // reproduced in the mocks below.
+    class AbortSignal {
+      abort = () => {
+        const e = new Error("");
+        e.name = "AbortError";
+        throw e;
+      };
+
+      addEventListener = () => {};
+    }
+
+    class AbortController {
+      abort = () => {
+        this.signal.abort();
+      };
+      signal = new AbortSignal();
+    }
+    const abortController = new AbortController();
+    const mock = fetchMock.sandbox().post(
+      "https://api.github.com/repos/octokit-fixture-org/release-assets/releases/tags/v1.0.0",
+      new Promise(() => {
+        abortController.abort();
+      })
+    );
+
+    return request("POST /repos/{owner}/{repo}/releases/tags/{tag}", {
+      owner: "octokit-fixture-org",
+      repo: "release-assets",
+      tag: "v1.0.0",
+      request: {
+        fetch: mock,
+        signal: abortController.signal,
+      },
+      headers: {
+        "content-type": "text/plain",
+      },
+      data: stringToArrayBuffer("Hello, world!\n"),
+      name: "test-upload.txt",
+      label: "test",
+    }).catch((error) => {
+      expect(error.name).toEqual("AbortError");
+    });
+  });
 });