Support pull_request_target workflow event (#201)

.nvmrc

@@ -1 +1 @@
-14.15.0
+12

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "octokit",
+        "repos",
+        "tinify"
+    ]
+}

README.md

@@ -30,6 +30,12 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+The following [workflow events](https://docs.github.com/en/actions/reference/events-that-trigger-workflows) are supported:
+
+* `pull_request`
+* `pull_request_target`
+* `push`
+
 ## Inputs
 
 | input | description |

package.json

@@ -43,7 +43,7 @@
     "@types/jest": "^26.0.20",
     "@types/mime": "^2.0.3",
     "@types/nock": "^11.1.0",
-    "@types/node": "^14.14.31",
+    "@types/node": "^12.20.6",
     "@typescript-eslint/parser": "^3.10.1",
     "eslint": "^7.21.0",
     "eslint-plugin-github": "^4.1.1",

__tests__/image-utils.test.ts → src/__tests__/image-utils.test.ts

@@ -3,7 +3,7 @@ import {
   getResizeOptions,
   isResizable,
   ResizeMethod
-} from '../src/image-utils'
+} from '../image-utils'
 
 test('getCompressionSummary', () => {
   expect(getCompressionSummary([20000, 9876])).toEqual('-9.89KB (-50%)')

__tests__/image.test.ts → src/__tests__/image.test.ts

@@ -1,4 +1,4 @@
-import Image from '../src/image'
+import Image from '../image'
 
 let image: Image
 

__tests__/git-utils.test.ts → src/git/__tests__/functions.test.ts

@@ -1,6 +1,6 @@
-import {getCommitMessage} from '../src/git-utils'
-import {Commit} from '../src/git'
-import Image from '../src/image'
+import Image from '../../image'
+import {getCommitMessage} from '../functions'
+import {Commit} from '../types'
 
 describe('getCommitMessage', () => {
   test('defined message', () => {

__tests__/git.test.ts → src/git/__tests__/index.test.ts

@@ -1,6 +1,6 @@
-import Git, {ContextEventName} from '../src/git'
-import nock, {Scope} from 'nock'
 import {Context} from '@actions/github/lib/context'
+import nock, {Scope} from 'nock'
+import Git from '..'
 
 describe('Git', () => {
   let target: Git
@@ -40,7 +40,7 @@ describe('Git', () => {
 
       test('should fetch files', async () => {
         const files = await target.getFiles(({
-          eventName: ContextEventName.Push,
+          eventName: 'push',
           payload: {
             commits: [{id: 'C1'}, {id: 'C2'}]
           },
@@ -65,49 +65,51 @@ describe('Git', () => {
       })
     })
 
-    describe('pull request', () => {
-      beforeEach(() => {
-        scope.get('/repos/OWNER/REPO/pulls/1/files').reply(200, [
-          {
-            id: 1,
-            status: 'added'
-          },
-          {
-            id: 2,
-            status: 'removed'
-          },
-          {
-            id: 3,
-            status: 'modified'
-          }
-        ])
-      })
+    for (const eventName of ['pull_request', 'pull_request_target']) {
+      describe(eventName, () => {
+        beforeEach(() => {
+          scope.get('/repos/OWNER/REPO/pulls/1/files').reply(200, [
+            {
+              id: 1,
+              status: 'added'
+            },
+            {
+              id: 2,
+              status: 'removed'
+            },
+            {
+              id: 3,
+              status: 'modified'
+            }
+          ])
+        })
 
-      test('should fetch files', async () => {
-        const files = await target.getFiles(({
-          eventName: ContextEventName.PullRequest,
-          payload: {
-            number: 1
-          },
-          repo: {
-            owner: 'OWNER',
-            repo: 'REPO'
-          }
-        } as unknown) as Context)
+        test('should fetch files', async () => {
+          const files = await target.getFiles(({
+            eventName,
+            payload: {
+              number: 1
+            },
+            repo: {
+              owner: 'OWNER',
+              repo: 'REPO'
+            }
+          } as unknown) as Context)
 
-        expect(files).toEqual([
-          {
-            id: 1,
-            status: 'added'
-          },
-          {
-            id: 3,
-            status: 'modified'
-          }
-        ])
+          expect(files).toEqual([
+            {
+              id: 1,
+              status: 'added'
+            },
+            {
+              id: 3,
+              status: 'modified'
+            }
+          ])
 
-        expect(scope.isDone()).toBe(true)
+          expect(scope.isDone()).toBe(true)
+        })
       })
-    })
+    }
   })
 })

src/git/functions.ts

@@ -0,0 +1,26 @@
+import {Context} from '@actions/github/lib/context'
+import {Commit, supportedEvents} from './types'
+
+export function getCommitMessage(commit: Commit): string {
+  let message = commit.message
+
+  if (message) {
+    return message
+  }
+
+  message = 'Compress image'
+
+  if (commit.files.length > 1) {
+    message += 's'
+  }
+
+  return message
+}
+
+export function assertUnsupportedEvent(context: Context): never {
+  throw new Error(
+    `Unsupported event ${
+      context.eventName
+    } (currently supported events include ${supportedEvents.join(', ')})`
+  )
+}

src/git.ts → src/git/index.ts

@@ -1,28 +1,11 @@
 import {info} from '@actions/core'
 import {exec} from '@actions/exec'
 import * as github from '@actions/github'
+import {Context} from '@actions/github/lib/context'
 import {GitHub} from '@actions/github/lib/utils'
-import Image from './image'
-import {getCommitMessage} from './git-utils'
 import {Endpoints} from '@octokit/types'
-import {Context} from '@actions/github/lib/context'
-
-export enum ContextEventName {
-  Push = 'push',
-  PullRequest = 'pull_request'
-}
-
-export interface File {
-  filename: string
-  status: string
-}
-
-export interface Commit {
-  files: Image[]
-  userName: string
-  userEmail: string
-  message: string
-}
+import {assertUnsupportedEvent, getCommitMessage} from './functions'
+import {Commit, File, SupportedEvent} from './types'
 
 export default class Git {
   private octokit: InstanceType<typeof GitHub>
@@ -33,13 +16,14 @@ export default class Git {
 
   async getFiles(context: Context): Promise<File[]> {
     const filesPromises: Promise<File[]>[] = []
+    const eventName = context.eventName as SupportedEvent
 
-    switch (context.eventName) {
-      case ContextEventName.Push:
+    switch (eventName) {
+      case 'push':
         for (const commit of context.payload.commits) {
           const ref = commit.id
 
-          info(`[${context.eventName}] Fetching files for commit ${ref}`)
+          info(`[${eventName}] Fetching files for commit ${ref}`)
 
           filesPromises.push(
             this.getCommitFiles({
@@ -49,9 +33,10 @@ export default class Git {
           )
         }
         break
-      case ContextEventName.PullRequest:
+      case 'pull_request':
+      case 'pull_request_target':
         info(
-          `[${context.eventName}] Fetching files for pull request ${context.payload.number}`
+          `[${eventName}] Fetching files for pull request ${context.payload.number}`
         )
 
         filesPromises.push(
@@ -65,7 +50,7 @@ export default class Git {
         )
         break
       default:
-        return assertUnsupportedEvent(context)
+        assertUnsupportedEvent(eventName)
     }
 
     const files = await Promise.all(filesPromises)
@@ -115,13 +100,3 @@ export default class Git {
     return response.data.files
   }
 }
-
-function assertUnsupportedEvent(context: Context): never {
-  throw new Error(
-    `Unsupported event ${
-      context.eventName
-    } (currently supported events include ${Object.values(
-      ContextEventName
-    ).join(', ')})`
-  )
-}

src/git/types.ts

@@ -0,0 +1,21 @@
+import Image from '../image'
+
+export const supportedEvents = [
+  'push',
+  'pull_request',
+  'pull_request_target'
+] as const
+
+export type SupportedEvent = typeof supportedEvents[number]
+
+export interface File {
+  filename: string
+  status: string
+}
+
+export interface Commit {
+  files: Image[]
+  userName: string
+  userEmail: string
+  message: string
+}