feat: context.octokit is set for all events, but unauthenticated fo…

…r `"token.deleted"` and `"authorization.deleted"` (#149)

BREAKING CHANGE: Before this release, `context.octokit` was not set for `"token.deleted"` and `"authorization.deleted"` events

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Test
 "on":
  push:
  branches:
- - dependabot/npm_and_yarn/**
+ - master
  pull_request:
  types:
  - opened
@@ -15,7 +15,7 @@ jobs:
  node_version:
  - "10"
  - "12"
- - "13"
+ - "14"
  steps:
  - uses: actions/checkout@v2
  - name: "Use Node.js ${{ matrix.node_version }}"

README.md

@@ -271,7 +271,7 @@ All event handlers are awaited before continuing.
 
 Authenticated instance using the `Octokit` option passed to the constructor.
 
-Not set for `"token.deleted"` and `"authorization.deleted"` events.
+For `"token.deleted"` and `"authorization.deleted"` events the `octokit` instance is unauthenticated.
 
 </td></tr>
  <tr>

package.json

@@ -20,6 +20,7 @@
  "license": "MIT",
  "dependencies": {
  "@octokit/auth-oauth-app": "^3.0.0",
+ "@octokit/auth-unauthenticated": "^2.0.0",
  "@octokit/core": "^3.0.0",
  "@octokit/oauth-authorization-url": "^4.1.0",
  "@types/btoa-lite": "^1.0.0",

src/methods/delete-authorization.ts

@@ -1,4 +1,5 @@
 import { createOAuthAppAuth } from "@octokit/auth-oauth-app";
+import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
 import { request as defaultRequest } from "@octokit/request";
 
 import { emitEvent } from "../emit-event";
@@ -77,12 +78,28 @@ export async function deleteAuthorizationWithState(
  name: "token",
  action: "deleted",
  token: options.token,
+ get octokit() {
+ return new state.Octokit({
+ authStrategy: createUnauthenticatedAuth,
+ auth: {
+ reason: `Handling "token.deleted" event. The access for the token has been revoked.`,
+ },
+ });
+ },
  });
 
  await emitEvent(state, {
  name: "authorization",
  action: "deleted",
  token: options.token,
+ get octokit() {
+ return new state.Octokit({
+ authStrategy: createUnauthenticatedAuth,
+ auth: {
+ reason: `Handling "authorization.deleted" event. The access for the app has been revoked.`,
+ },
+ });
+ },
  });
 
  return result;

src/methods/delete-token.ts

@@ -1,4 +1,5 @@
 import { request as defaultRequest } from "@octokit/request";
+import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
 import btoa from "btoa-lite";
 
 import { emitEvent } from "../emit-event";
@@ -67,6 +68,14 @@ export async function deleteTokenWithState(
  name: "token",
  action: "deleted",
  token: options.token,
+ get octokit() {
+ return new state.Octokit({
+ authStrategy: createUnauthenticatedAuth,
+ auth: {
+ reason: `Handling "token.deleted" event. The access for the token has been revoked.`,
+ },
+ });
+ },
  });
 
  return result;

src/types.ts

@@ -46,7 +46,7 @@ export type EventHandlerContext = {
  action: ActionName;
  token: Token;
  scopes?: Scope[];
- octokit?: InstanceType<typeof OAuthAppOctokit>;
+ octokit: InstanceType<typeof OAuthAppOctokit>;
 };
 export type EventHandler = (context: EventHandlerContext) => void;
 export type AddEventHandler = (

test/app.test.ts

@@ -216,11 +216,12 @@ describe("app", () => {
  });
  expect(context_before_deleted.octokit).toBeInstanceOf(Mocktokit);
 
- expect(context_deleted).toStrictEqual({
+ expect(context_deleted).toMatchObject({
  name: "token",
  action: "deleted",
  token: "token123",
  });
+ expect(context_deleted.octokit).toBeInstanceOf(Mocktokit);
  });
 
  it("app.deleteAuthorization(options)", async () => {
@@ -281,16 +282,19 @@ describe("app", () => {
  });
  expect(context_token_before_deleted.octokit).toBeInstanceOf(Mocktokit);
 
- expect(context_token_deleted).toStrictEqual({
+ expect(context_token_deleted).toMatchObject({
  name: "token",
  action: "deleted",
  token: "token123",
  });
- expect(context_authorization_deleted).toStrictEqual({
+ expect(context_token_deleted.octokit).toBeInstanceOf(Mocktokit);
+
+ expect(context_authorization_deleted).toMatchObject({
  name: "authorization",
  action: "deleted",
  token: "token123",
  });
+ expect(context_authorization_deleted.octokit).toBeInstanceOf(Mocktokit);
  });
 
  it("app.on multiple events", async () => {