|
3 | 3 | import type { KnownBlock } from '@slack/web-api' |
4 | 4 |
|
5 | 5 | import { context } from '@actions/github' |
6 | | -import { formatStringList, plural, snapDate, SnapType } from '@krauters/utils' |
7 | | - |
8 | | -import type { RunProps } from './structures.js' |
| 6 | +import { debug, error as logError } from '@actions/core' |
| 7 | +import { formatStringList, plural } from '@krauters/utils' |
9 | 8 |
|
10 | 9 | import pkg from '../package.json' with { type: 'json' } |
11 | | -import { workflowLogsUrl, workflowUrl } from './defaults.js' |
| 10 | +import { workflowLogsUrl, workflowUrl } from './constants.js' |
12 | 11 | import { GitHubClient } from './utils/github/github-client.js' |
| 12 | +import type { Pull } from './utils/github/structures.js' |
13 | 13 | import { PullState, RepositoryType } from './utils/github/structures.js' |
14 | 14 | import { getFirstBlocks, getLastBlocks, getPullBlocks } from './utils/slack/blocks.js' |
15 | 15 | import { SlackClient } from './utils/slack/slack-client.js' |
16 | 16 | import { getApprovedPullRequest } from './utils/test-data.js' |
| 17 | +import { parseInputs as getInputs } from './input-parser.js' |
17 | 18 |
|
18 | 19 | const { homepage, name, version } = pkg |
19 | 20 |
|
20 | 21 | /** |
21 | | - * Runs the GitHub Notifier to query GitHub for open pull requests and then post messages to Slack channels. |
22 | | - * |
23 | | - * @param props Configurable properties of the GitHub Notifier. |
| 22 | + * The main function that gets executed when the action is run. |
24 | 23 | */ |
25 | | -export async function run({ |
26 | | - githubProps, |
27 | | - repositoryFilter, |
28 | | - slackProps, |
29 | | - withArchived, |
30 | | - withDrafts, |
31 | | - withPublic, |
32 | | - withPullReport, |
33 | | - withTestData, |
34 | | - withUserMentions, |
35 | | -}: RunProps): Promise<void> { |
36 | | - const slack = new SlackClient(slackProps) |
37 | | - const gh = new GitHubClient(githubProps) |
38 | | - |
39 | | - await slack.enforceAppNamePattern(/.*github[\s-_]?notifier$/i) |
40 | | - |
41 | | - const repositories = await gh.getRepositories({ |
42 | | - repositoryFilter, |
43 | | - type: RepositoryType.All, |
44 | | - withArchived, |
45 | | - withPublic, |
46 | | - }) |
47 | | - const openPulls = await gh.getPulls({ repositories, state: PullState.Open, withDrafts }) |
48 | | - let blocks: KnownBlock[] = [] |
49 | | - for (const openPull of openPulls) { |
50 | | - console.log(`Building Slack blocks from pull request [${openPull.number}]`) |
51 | | - |
52 | | - blocks = [...blocks, ...(await getPullBlocks(openPull, slack, withUserMentions))] |
53 | | - } |
| 24 | +async function main(): Promise<void> { |
| 25 | + try { |
| 26 | + debug('Starting main...') |
| 27 | + const { |
| 28 | + githubConfig, |
| 29 | + repositoryFilter, |
| 30 | + slackConfig, |
| 31 | + withArchived, |
| 32 | + withDrafts, |
| 33 | + withPublic, |
| 34 | + withTestData, |
| 35 | + withUserMentions, |
| 36 | + } = getInputs() |
| 37 | + |
| 38 | + const slack = new SlackClient(slackConfig) |
| 39 | + const results = await githubConfig.tokens.reduce( |
| 40 | + async (accPromise, token) => { |
| 41 | + const acc = await accPromise |
| 42 | + try { |
| 43 | + // TODO - Consider making this thread safe so requests can be made in parallel |
| 44 | + const client = new GitHubClient({ |
| 45 | + options: githubConfig.options, |
| 46 | + token, |
| 47 | + }) |
| 48 | + |
| 49 | + const repositories = await client.getRepositories({ |
| 50 | + repositoryFilter, |
| 51 | + type: RepositoryType.All, |
| 52 | + withArchived, |
| 53 | + withPublic, |
| 54 | + }) |
| 55 | + |
| 56 | + const pulls = await client.getPulls({ repositories, state: PullState.Open, withDrafts }) |
| 57 | + const org = await client.getOrg() |
| 58 | + |
| 59 | + return [...acc, { client, org: org.name, pulls }] |
| 60 | + } catch (error: unknown) { |
| 61 | + logError( |
| 62 | + `Failed to call to GitHub [${githubConfig.options?.baseUrl}] with last 4 chars of token [${token.slice(-4)}] with error [${error}]. Skipping this requests with this token.`, |
| 63 | + ) |
| 64 | + |
| 65 | + return acc |
| 66 | + } |
| 67 | + }, |
| 68 | + Promise.resolve([] as { client: GitHubClient; org: string; pulls: Pull[] }[]), |
| 69 | + ) |
| 70 | + |
| 71 | + if (results.length === 0) { |
| 72 | + throw new Error('All GitHub tokens failed to process') |
| 73 | + } |
| 74 | + |
| 75 | + console.log(`Successfully processed ${results.length} out of ${githubConfig.tokens.length} tokens`) |
| 76 | + |
| 77 | + await slack.enforceAppNamePattern(/.*github[\s-_]?notifier$/i) |
| 78 | + |
| 79 | + const pulls: Pull[] = results.flatMap((result) => result.pulls) |
| 80 | + |
| 81 | + // Multiple tokens may have overlapping repository access, deduplicate PRs by org/repo/number |
| 82 | + const dedupedPulls = [...new Map(pulls.map((pull) => [`${pull.org}/${pull.repo}/${pull.number}`, pull]))].map( |
| 83 | + // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-unused-vars |
| 84 | + ([_, pull]) => pull, |
| 85 | + ) |
| 86 | + |
| 87 | + let blocks: KnownBlock[] = [] |
| 88 | + for (const pull of dedupedPulls) { |
| 89 | + console.log(`Building Slack blocks from pull request [${pull.number}]`) |
54 | 90 |
|
55 | | - if (withTestData) { |
56 | | - console.log(`With test data: [${withTestData}]`) |
57 | | - const testDataPullRequest = getApprovedPullRequest() |
58 | | - for (let i = 1; i <= 2; i++) { |
59 | | - blocks = [ |
60 | | - ...blocks, |
61 | | - ...(await getPullBlocks({ ...testDataPullRequest, number: i }, slack, withUserMentions)), |
62 | | - ] |
| 91 | + blocks = [...blocks, ...(await getPullBlocks(pull, slack, withUserMentions))] |
63 | 92 | } |
64 | | - } |
65 | 93 |
|
66 | | - const total = openPulls.length |
67 | | - let header = `You've got ${total} open pull ${plural('request', total)}.` |
68 | | - if (total === 0) { |
69 | | - header = 'There are no open pull requests! :tada:' |
70 | | - } |
| 94 | + if (withTestData) { |
| 95 | + console.log(`With test data: [${withTestData}]`) |
| 96 | + const testDataPullRequest = getApprovedPullRequest() |
| 97 | + for (let i = 1; i <= 2; i++) { |
| 98 | + blocks = [ |
| 99 | + ...blocks, |
| 100 | + ...(await getPullBlocks({ ...testDataPullRequest, number: i }, slack, withUserMentions)), |
| 101 | + ] |
| 102 | + } |
| 103 | + } |
71 | 104 |
|
72 | | - let text |
73 | | - if (repositoryFilter.length > 0) { |
74 | | - text = `_<${workflowUrl}|Repository filter>: ${formatStringList(repositoryFilter)}_` |
75 | | - } |
| 105 | + const total = dedupedPulls.length |
| 106 | + let header = `You've got ${total} open pull ${plural('request', total)}.` |
| 107 | + if (total === 0) { |
| 108 | + header = 'There are no open pull requests! :tada:' |
| 109 | + } |
| 110 | + |
| 111 | + let text |
| 112 | + if (repositoryFilter.length > 0) { |
| 113 | + text = `_<${workflowUrl}|Repository filter>: ${formatStringList(repositoryFilter)}_` |
| 114 | + } |
76 | 115 |
|
77 | | - blocks = [...getFirstBlocks(gh.cacheOrganization.name, header, text), ...blocks] |
78 | | - |
79 | | - blocks = [ |
80 | | - ...blocks, |
81 | | - ...getLastBlocks( |
82 | | - [ |
83 | | - `Run from <${workflowUrl}|${context.repo.owner}`, |
84 | | - `/${context.payload.repository?.name}> (<${workflowLogsUrl}|logs>) using <${homepage}|${name}>@<${homepage}/releases/tag/${version}|${version}>`, |
85 | | - ].join(''), |
86 | | - ), |
87 | | - ] |
88 | | - |
89 | | - await slack.postMessage(header, blocks) |
90 | | - |
91 | | - if (withPullReport) { |
92 | | - const pulls = await gh.getPulls({ |
93 | | - oldest: snapDate(new Date(), { months: -12, snap: SnapType.Month }), |
94 | | - onlyGhReviews: true, |
95 | | - repositories, |
96 | | - state: PullState.All, |
97 | | - withCommits: false, |
98 | | - withDrafts: false, |
99 | | - withFilesAndChanges: false, |
100 | | - withUser: false, |
101 | | - }) |
102 | | - console.log(gh.getPullReport(pulls).reportString) |
| 116 | + const orgs = [...new Set(dedupedPulls.map((pull) => pull.org))] |
| 117 | + blocks = [...getFirstBlocks(orgs, header, text), ...blocks] |
| 118 | + |
| 119 | + blocks = [ |
| 120 | + ...blocks, |
| 121 | + ...getLastBlocks( |
| 122 | + [ |
| 123 | + `Run from <${workflowUrl}|${context.repo.owner}`, |
| 124 | + `/${context.payload.repository?.name}> (<${workflowLogsUrl}|logs>) using <${homepage}|${name}>@<${homepage}/releases/tag/${version}|${version}>`, |
| 125 | + ].join(''), |
| 126 | + ), |
| 127 | + ] |
| 128 | + |
| 129 | + await slack.postMessage(header, blocks) |
| 130 | + } catch (err) { |
| 131 | + console.error('Fatal error:', err) |
| 132 | + process.exit(1) |
103 | 133 | } |
104 | 134 | } |
| 135 | + |
| 136 | +// This is required for the GitHub Action to execute main() when it invokes app.ts as specified in action.yaml |
| 137 | +await main() |
0 commit comments