test: initial version

Author: gr2m

test/index.test.ts

@@ -0,0 +1,220 @@
+import { request } from "@octokit/request";
+import fetchMock, { MockMatcherFunction } from "fetch-mock";
+
+import { createUnauthenticatedAuth } from "../src/index";
+
+test("README example", async () => {
+  const auth = createUnauthenticatedAuth({
+    reason:
+      "Handling an installation.deleted event (The app's access has been revoked)",
+  });
+  const authentication = await auth();
+
+  expect(authentication).toEqual({
+    type: "unauthenticated",
+    reason:
+      "Handling an installation.deleted event (The app's access has been revoked)",
+  });
+});
+
+test("no reason", async () => {
+  try {
+    // @ts-ignore
+    const auth = createUnauthenticatedAuth();
+    throw new Error("Should not resolve");
+  } catch (error) {
+    expect(error.message).toMatch(
+      /No reason passed to createUnauthenticatedAuth/i
+    );
+  }
+});
+
+test('auth.hook(request, "GET /repos/octocat/hello-world")', async () => {
+  const expectedRequestHeaders = {
+    accept: "application/vnd.github.v3+json",
+    "user-agent": "test",
+  };
+
+  const matchGetUser: MockMatcherFunction = (url, { body, headers }) => {
+    expect(url).toEqual("https://api.github.com/repos/octocat/hello-world");
+    expect(headers).toStrictEqual(expectedRequestHeaders);
+    return true;
+  };
+
+  const requestMock = request.defaults({
+    headers: {
+      "user-agent": "test",
+    },
+    request: {
+      fetch: fetchMock.sandbox().getOnce(matchGetUser, { id: 123 }),
+    },
+  });
+
+  const { hook } = createUnauthenticatedAuth({ reason: "test" });
+  const { data } = await hook(requestMock, "GET /repos/octocat/hello-world");
+
+  expect(data).toStrictEqual({ id: 123 });
+});
+
+test('auth.hook(request, "GET /repos/octocat/hello-world") returns 404', async () => {
+  const expectedRequestHeaders = {
+    accept: "application/vnd.github.v3+json",
+    "user-agent": "test",
+  };
+
+  const matchGetUser: MockMatcherFunction = (url, { body, headers }) => {
+    expect(url).toEqual("https://api.github.com/repos/octocat/hello-world");
+    expect(headers).toStrictEqual(expectedRequestHeaders);
+    return true;
+  };
+
+  const requestMock = request.defaults({
+    headers: {
+      "user-agent": "test",
+    },
+    request: {
+      fetch: fetchMock.sandbox().getOnce(matchGetUser, {
+        status: 404,
+        body: {
+          message: "Not Found",
+        },
+      }),
+    },
+  });
+
+  const { hook } = createUnauthenticatedAuth({ reason: "test" });
+
+  try {
+    await hook(requestMock, "GET /repos/octocat/hello-world");
+    throw new Error("should not resolve");
+  } catch (error) {
+    expect(error.message).toBe(
+      "Not found. May be due to lack of authentication. Reason: test"
+    );
+  }
+});
+
+test('auth.hook(request, "GET /repos/octocat/hello-world") returns rate limit response', async () => {
+  const expectedRequestHeaders = {
+    accept: "application/vnd.github.v3+json",
+    "user-agent": "test",
+  };
+
+  const matchGetUser: MockMatcherFunction = (url, { body, headers }) => {
+    expect(url).toEqual("https://api.github.com/repos/octocat/hello-world");
+    expect(headers).toStrictEqual(expectedRequestHeaders);
+    return true;
+  };
+
+  const requestMock = request.defaults({
+    headers: {
+      "user-agent": "test",
+    },
+    request: {
+      fetch: fetchMock.sandbox().getOnce(matchGetUser, {
+        status: 403,
+        headers: {
+          "x-ratelimit-remaining": 0,
+        },
+        body: {
+          message:
+            "API rate limit exceeded for xxx.xxx.xxx.xxx. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)",
+        },
+      }),
+    },
+  });
+
+  const { hook } = createUnauthenticatedAuth({ reason: "test" });
+
+  try {
+    await hook(requestMock, "GET /repos/octocat/hello-world");
+    throw new Error("should not resolve");
+  } catch (error) {
+    expect(error.message).toBe(
+      "API rate limit exceeded. This maybe caused by the lack of authentication. Reason: test"
+    );
+  }
+});
+
+test('auth.hook(request, "GET /repos/octocat/hello-world") returns rate limit response', async () => {
+  const expectedRequestHeaders = {
+    accept: "application/vnd.github.v3+json",
+    "user-agent": "test",
+  };
+
+  const matchGetUser: MockMatcherFunction = (url, { body, headers }) => {
+    expect(url).toEqual("https://api.github.com/repos/octocat/hello-world");
+    expect(headers).toStrictEqual(expectedRequestHeaders);
+    return true;
+  };
+
+  const requestMock = request.defaults({
+    headers: {
+      "user-agent": "test",
+    },
+    request: {
+      fetch: fetchMock.sandbox().getOnce(matchGetUser, {
+        status: 403,
+        body: {
+          message:
+            "You have triggered an abuse detection mechanism and have been temporarily blocked from content creation. Please retry your request again later.",
+        },
+      }),
+    },
+  });
+
+  const { hook } = createUnauthenticatedAuth({ reason: "test" });
+
+  try {
+    await hook(requestMock, "GET /repos/octocat/hello-world");
+    throw new Error("should not resolve");
+  } catch (error) {
+    expect(error.message).toBe(
+      "You have triggered an abuse detection mechanism. This maybe caused by the lack of authentication. Reason: test"
+    );
+  }
+});
+
+test('auth.hook(request, "PATCH /repos/octocat/hello-world") fails without sending request', async () => {
+  const requestMock = request.defaults({
+    headers: {
+      "user-agent": "test",
+    },
+    request: {
+      fetch: fetchMock.sandbox(),
+    },
+  });
+
+  const { hook } = createUnauthenticatedAuth({ reason: "test" });
+
+  try {
+    await hook(requestMock, "PATCH /repos/octocat/hello-world");
+    throw new Error("should not resolve");
+  } catch (error) {
+    expect(error.message).toBe(
+      '"PATCH /repos/octocat/hello-world" is not permitted due to lack authentication. Reason: test'
+    );
+  }
+});
+
+test('auth.hook(request, "GET /repos/octocat/hello-world") does not swallow non-request related errors', async () => {
+  const requestMock = request.defaults({
+    headers: {
+      "user-agent": "test",
+    },
+    request: {
+      fetch() {
+        throw new Error("unrelated");
+      },
+    },
+  });
+
+  const { hook } = createUnauthenticatedAuth({ reason: "test" });
+
+  try {
+    await hook(requestMock, "GET /repos/octocat/hello-world");
+    throw new Error("should not resolve");
+  } catch (error) {
+    expect(error.message).toBe("unrelated");
+  }
+});