feat: set error.response (#64)

Author: gr2m

HOW_IT_WORKS.md

@@ -127,7 +127,7 @@ octokit.hook.after("request", async (response, options) => {
 });
 octokit.hook.error("request", async (error, options) => {
   if (error.status === 304) {
-    return findInCache(error.headers.etag);
+    return findInCache(error.response.headers.etag);
   }
 
   throw error;

docs/src/pages/api/06_hooks.md

@@ -13,7 +13,7 @@ octokit.hook.after("request", async (response, options) => {
 });
 octokit.hook.error("request", async (error, options) => {
   if (error.status === 304) {
-    return findInCache(error.headers.etag);
+    return findInCache(error.response.headers.etag);
   }
 
   throw error;

package-lock.json

@@ -32,7 +32,7 @@
   ],
   "repository": "github:octokit/rest.js",
   "dependencies": {
-    "@octokit/core": "^3.2.3",
+    "@octokit/core": "^3.5.0",
     "@octokit/plugin-paginate-rest": "^2.6.2",
     "@octokit/plugin-request-log": "^1.0.2",
     "@octokit/plugin-rest-endpoint-methods": "5.3.1"

package.json

@@ -422,7 +422,7 @@ describe("deprecations", () => {
           "2FA required, but options.on2fa is not a function. See https://github.com/octokit/rest.js#authentication"
         );
         expect(error.status).to.equal(401);
-        expect(!!error.headers).to.equal(true);
+        expect(!!error.response.headers).to.equal(true);
         expect(!!error.request).to.equal(true);
       });
   });
@@ -977,7 +977,7 @@ describe("deprecations", () => {
           "2FA required, but options.on2fa is not a function. See https://github.com/octokit/rest.js#authentication"
         );
         expect(error.status).to.equal(401);
-        expect(!!error.headers).to.equal(true);
+        expect(!!error.response.headers).to.equal(true);
         expect(!!error.request).to.equal(true);
       });
   });

test/integration/deprecations-test.js

@@ -103,7 +103,7 @@ describe("request errors", () => {
       .catch((error) => {
         expect(error.name).to.equal("HttpError");
         expect(error.status).to.equal(401);
-        expect(error.headers).to.deep.equal({
+        expect(error.response.headers).to.deep.equal({
           "content-type": "application/json",
           "x-foo": "bar",
         });

test/integration/request-errors-test.js

@@ -24,14 +24,14 @@ describe("api.github.com", () => {
         expect(error.message).toEqual(
           `Validation Failed: {"resource":"Label","code":"invalid","field":"color"}`
         );
-        expect(error.errors).toStrictEqual([
+        expect(error.response.data.errors).toStrictEqual([
           {
             resource: "Label",
             code: "invalid",
             field: "color",
           },
         ]);
-        expect(error.documentation_url).toMatch(
+        expect(error.response.data.documentation_url).toMatch(
           new RegExp("rest/reference/issues#create-a-label")
         );
       });

test/scenarios/errors.test.ts

@@ -100,7 +100,7 @@ export default async function () {
   // @ts-expect-error TODO: .error hook should accept a return of a valid response
   octokit.hook.error("request", async (error, options) => {
     if ("status" in error && error.status === 304) {
-      return findInCache(error.headers.etag);
+      return findInCache(error.response.headers.etag);
     }
 
     throw error;