Skip to content

Improve Logging #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coltenkrauter merged 1 commit into from
Apr 25, 2025
Merged

Improve Logging #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 39 additions & 15 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80770,7 +80770,7 @@ const { /* homepage */ "TB": homepage, /* name */ "UU": name, /* version */ "rE"
*/
async function main() {
try {
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)('Starting main...');
console.log(`Starting GitHub Notifier version [${version}]...`);
const { githubConfig, repositoryFilter, slackConfig, withArchived, withDrafts, withPublic, withTestData, withUserMentions, } = (0,_input_parser_js__WEBPACK_IMPORTED_MODULE_10__/* .parseInputs */ .T)();
const slack = new _utils_slack_client_js__WEBPACK_IMPORTED_MODULE_8__/* .SlackClient */ .Q(slackConfig);
const results = await githubConfig.tokens.reduce(async (accPromise, token) => {
Expand All @@ -80789,7 +80789,7 @@ async function main() {
});
const org = await client.getOrg();
const pulls = await client.getPulls({ repositories, state: _utils_github_structures_js__WEBPACK_IMPORTED_MODULE_6__/* .PullState */ .lT.Open, withDrafts });
console.log(`Found [${pulls.length}] pulls for [${org.name}]`);
console.log(`Found [${pulls.length}] ${(0,_krauters_utils__WEBPACK_IMPORTED_MODULE_2__.plural)('pull', pulls.length)} for [${org.name}]`);
return [...acc, { client, org: org.name, pulls }];
}
catch (error) {
Expand All @@ -80808,6 +80808,7 @@ async function main() {
const dedupedPulls = [...new Map(pulls.map((pull) => [`${pull.org}/${pull.repo}/${pull.number}`, pull]))].map(
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-unused-vars
([_, pull]) => pull);
console.log(`After deduplication, there are [${dedupedPulls.length}] unique pulls`);
let blocks = [];
for (const pull of dedupedPulls) {
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Building Slack blocks from pull request [${pull.number}]`);
Expand Down Expand Up @@ -80842,7 +80843,9 @@ async function main() {
`/${_actions_github__WEBPACK_IMPORTED_MODULE_0__.context.payload.repository?.name}> (<${_constants_js__WEBPACK_IMPORTED_MODULE_4__/* .workflowLogsUrl */ .GM}|logs>) using <${homepage}|${name}>@<${homepage}/releases/tag/${version}|${version}>`,
].join('')),
];
console.log(`Posting [${blocks.length}] Slack blocks to [${slack.channels.length}] ${(0,_krauters_utils__WEBPACK_IMPORTED_MODULE_2__.plural)('channel', slack.channels.length)}`);
await slack.postMessage(header, blocks);
console.log('Successfully posted notification to Slack');
}
catch (error) {
console.error(`Fatal error [${error}]`);
Expand Down Expand Up @@ -81022,7 +81025,7 @@ class GitHubClient {
*/
async getOrg() {
if (!this.cacheOrganization) {
console.log(`Getting organization associated with current token...`);
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Getting organization associated with current token...`);
const { data } = await this.client.rest.orgs.listMembershipsForAuthenticatedUser();
if (data.length > 1) {
console.error(data);
Expand Down Expand Up @@ -81092,22 +81095,25 @@ class GitHubClient {
* @param props Configuration for retrieving pull requests.
*/
async getPulls({ oldest = (0,_krauters_utils__WEBPACK_IMPORTED_MODULE_2__.snapDate)(new Date(), { months: -36, snap: _krauters_utils__WEBPACK_IMPORTED_MODULE_2__.SnapType.Month }), onlyGhReviews = false, repositories, state = _structures_js__WEBPACK_IMPORTED_MODULE_0__/* .PullState */ .lT.All, withCommits = true, withDrafts, withFilesAndChanges = true, withUser = true, }) {
const startTime = Date.now();
const org = await this.getOrgName();
console.log('\n');
if (state === _structures_js__WEBPACK_IMPORTED_MODULE_0__/* .PullState */ .lT.Open) {
console.log(`Getting [${state}] pulls in org [${org}]...`);
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Getting [${state}] ${(0,_krauters_utils__WEBPACK_IMPORTED_MODULE_2__.plural)('pull', 2)} in org [${org}]...`);
}
else {
console.log(`Getting [${state}] pulls in org [${org}] that are newer than [${oldest}...`);
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Getting [${state}] ${(0,_krauters_utils__WEBPACK_IMPORTED_MODULE_2__.plural)('pull', 2)} in org [${org}] that are newer than [${oldest}]...`);
}
const pullRequests = [];
let apiRequestCount = 0;
for (const repo of repositories) {
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Getting [${state}] pulls in repository [${repo.name}]...`);
const repoStartTime = Date.now();
const pulls = await this.client.paginate(this.client.rest.pulls.list, {
owner: org,
repo: repo.name,
state,
}, (response, done) => {
apiRequestCount++;
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Paginated response for repository [${repo.name}], status [${response.status}], items [${response.data.length}]`);
const found = response.data.find((pull) => new Date(pull.created_at) < oldest);
if (found && state !== _structures_js__WEBPACK_IMPORTED_MODULE_0__/* .PullState */ .lT.Open) {
Expand All @@ -81116,7 +81122,8 @@ class GitHubClient {
}
return response.data.filter((pull) => new Date(pull.created_at) > oldest);
});
console.log(`Found [${pulls.length}] pull in repository [${repo.name}]`);
const repoDuration = (Date.now() - repoStartTime) / 1000;
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Found [${pulls.length}] pull in repository [${repo.name}] in [${repoDuration.toFixed(2)}] seconds`);
for (const pull of pulls) {
const { base, closed_at, created_at, draft, html_url, merged_at, number, title, user } = pull;
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Processing pull [${number}]...`);
Expand Down Expand Up @@ -81155,6 +81162,8 @@ class GitHubClient {
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Added pull [${number}] to response`);
}
}
const totalDuration = (Date.now() - startTime) / 1000;
console.log(`Completed processing [${pullRequests.length}] pull requests in [${totalDuration.toFixed(2)}] seconds with [${apiRequestCount}] API calls`);
return pullRequests;
}
/**
Expand All @@ -81164,7 +81173,7 @@ class GitHubClient {
*/
async getRepositories({ repositoryFilter = [], type = _structures_js__WEBPACK_IMPORTED_MODULE_0__/* .RepositoryType */ .vJ.All, withArchived, withPublic, }) {
const org = await this.getOrgName();
console.log(`Getting all repositories in org [${org}]...`);
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Getting all repositories in org [${org}]...`);
const response = await this.client.paginate(this.client.rest.repos.listForOrg, {
org,
per_page: 100,
Expand All @@ -81180,7 +81189,7 @@ class GitHubClient {
if (!withPublic) {
filteredRepos = filteredRepos.filter((repo) => repo.visibility !== _structures_js__WEBPACK_IMPORTED_MODULE_0__/* .RepositoryType */ .vJ.Public);
}
console.log(`Found [${filteredRepos.length}] repositories`);
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(`Found [${filteredRepos.length}] repositories in org [${org}]`);
(0,_actions_core__WEBPACK_IMPORTED_MODULE_1__.debug)(JSON.stringify(filteredRepos.map((repo) => repo.name), null, 2));
return filteredRepos;
}
Expand Down Expand Up @@ -81707,6 +81716,7 @@ var SlackAppUrl;

;// CONCATENATED MODULE: ./src/utils/slack/user-matchers.ts


function customMappingMatcher(githubUsername, slackUsername) {
return {
check: (user) => user.name === slackUsername ||
Expand Down Expand Up @@ -81791,7 +81801,7 @@ const createUserMatchers = ({ email, userId, userMappings = [], username }) => {
return matchers;
};
const logFailedMatches = ({ email, userId, userMappings = [], username }, usersCount) => {
console.log(`No user match found after checking against [${usersCount}] users`);
console.log(`No user match found for [${username}] after checking against [${usersCount}] Slack ${(0,src.plural)('user', usersCount)}`);
// Log mapping failures
if (username && userMappings.length > 0) {
const matchingMappings = userMappings.filter((mapping) => mapping.githubUsername === username);
Expand Down Expand Up @@ -81832,6 +81842,7 @@ class SlackClient {
this.client = new dist.WebClient(token);
this.channels = channels;
this.userMappings = userMappings;
console.log(`Slack client initialized with [${channels.length}] ${(0,src.plural)('channel', channels.length)} and [${userMappings.length}] user ${(0,src.plural)('mapping', userMappings.length)}`);
}
/**
* Ensure app name pattern.
Expand All @@ -81848,6 +81859,7 @@ class SlackClient {
throw new Error(`Current app name [${name}] does not match the desired pattern [${pattern}]. Please update Slack app "Basic Information" > "Display Information" > "App name" to have the suffix "GitHub Notifier". Slack app url [${SlackAppUrl.Prefix}/${info?.bot?.app_id}/${SlackAppUrl.SuffixDisplayInfo}].`);
}
this.bot = info.bot;
console.log(`Verified Slack app name: [${name}]`);
}
/**
* Get all Slack users.
Expand All @@ -81856,6 +81868,7 @@ class SlackClient {
this.users = [];
let cursor;
console.log('Getting all Slack users...');
const startTime = Date.now();
try {
// Keep paginating until no more cursor is returned
do {
Expand All @@ -81866,7 +81879,8 @@ class SlackClient {
cursor = result.response_metadata?.next_cursor;
(0,core.debug)(`Got [${result.members?.length}] users from Slack`);
} while (cursor);
console.log(`Got a total of [${this.users.length}] active users from Slack`);
const duration = (Date.now() - startTime) / 1000;
console.log(`Got a total of [${this.users.length}] active ${(0,src.plural)('user', this.users.length)} from Slack in [${duration.toFixed(2)}] seconds`);
return this.users;
}
catch (error) {
Expand All @@ -81879,6 +81893,7 @@ class SlackClient {
*/
async getBotInfo() {
try {
console.log('Getting Slack bot information...');
const authResponse = await this.client.auth.test({});
const response = await this.client.bots.info({ bot: authResponse.bot_id });
if (!response.ok) {
Expand Down Expand Up @@ -81928,10 +81943,16 @@ class SlackClient {
* @param [channels=this.channels] Channels to post to.
*/
async postMessage(text, blocks, channels = this.channels) {
const startTime = Date.now();
const totalBlocks = blocks.length;
const batches = (0,src.getBatches)(blocks);
(0,core.debug)(`Preparing to post [${totalBlocks}] blocks to [${channels.length}] channels`);
for (const channel of channels) {
let batchNumber = 0;
for (const batch of (0,src.getBatches)(blocks)) {
console.log(`Posting batch [${batchNumber++}] to Slack channel [${channel}]...`);
for (const batch of batches) {
batchNumber++;
const batchStartTime = Date.now();
(0,core.debug)(`Posting batch [${batchNumber}] to Slack channel [${channel}]...`);
const payload = {
blocks: batch.items,
channel,
Expand All @@ -81945,9 +81966,12 @@ class SlackClient {
(0,core.debug)(JSON.stringify(payload, null, 2));
const response = await this.client.chat.postMessage(payload);
(0,core.debug)(JSON.stringify(response, null, 2));
console.log(`Posted batch [${batchNumber++}] to Slack channel [${channel}] with success [${response.ok}]`);
const batchDuration = (Date.now() - batchStartTime) / 1000;
console.log(`Posted batch [${batchNumber}] to Slack channel [${channel}] with success [${response.ok}] in [${batchDuration.toFixed(2)}] seconds`);
}
}
const totalDuration = (Date.now() - startTime) / 1000;
console.log(`Completed posting all messages to Slack in [${totalDuration.toFixed(2)}] seconds`);
}
}

Expand Down Expand Up @@ -90605,7 +90629,7 @@ module.exports = {"version":"3.17.0"};
/***/ 8330:
/***/ ((module) => {

module.exports = /*#__PURE__*/JSON.parse('{"UU":"@krauters/github-notifier","rE":"1.3.0","TB":"https://buymeacoffee.com/coltenkrauter"}');
module.exports = /*#__PURE__*/JSON.parse('{"UU":"@krauters/github-notifier","rE":"1.3.1","TB":"https://buymeacoffee.com/coltenkrauter"}');

/***/ })

Expand Down
2 changes: 1 addition & 1 deletion dist/index.js.map
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@krauters/github-notifier",
"description": "GitHub Notifier by Krauters – Post Open Pull Requests to Slack",
"version": "1.3.0",
"version": "1.3.1",
"author": "Colten Krauter <coltenkrauter>",
"type": "module",
"homepage": "https://buymeacoffee.com/coltenkrauter",
Expand Down Expand Up @@ -47,7 +47,7 @@
"devDependencies": {
"@krauters/eslint-config": "^1.8.0",
"@types/jest": "^29.5.14",
"@types/node": "^22.14.1",
"@types/node": "^22.15.0",
"@vercel/ncc": "^0.38.3",
"husky": "9.1.7",
"jest": "^29.7.0",
Expand Down
10 changes: 8 additions & 2 deletions src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ const { homepage, name, version } = pkg
*/
async function main(): Promise<void> {
try {
debug('Starting main...')
console.log(`Starting GitHub Notifier version [${version}]...`)

const {
githubConfig,
repositoryFilter,
Expand Down Expand Up @@ -55,7 +56,7 @@ async function main(): Promise<void> {

const org = await client.getOrg()
const pulls = await client.getPulls({ repositories, state: PullState.Open, withDrafts })
console.log(`Found [${pulls.length}] pulls for [${org.name}]`)
console.log(`Found [${pulls.length}] ${plural('pull', pulls.length)} for [${org.name}]`)

return [...acc, { client, org: org.name, pulls }]
} catch (error: unknown) {
Expand Down Expand Up @@ -85,6 +86,7 @@ async function main(): Promise<void> {
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-unused-vars
([_, pull]) => pull,
)
console.log(`After deduplication, there are [${dedupedPulls.length}] unique pulls`)

let blocks: KnownBlock[] = []
for (const pull of dedupedPulls) {
Expand Down Expand Up @@ -130,7 +132,11 @@ async function main(): Promise<void> {
),
]

console.log(
`Posting [${blocks.length}] Slack blocks to [${slack.channels.length}] ${plural('channel', slack.channels.length)}`,
)
await slack.postMessage(header, blocks)
console.log('Successfully posted notification to Slack')
} catch (error) {
console.error(`Fatal error [${error}]`)
process.exit(1)
Expand Down
25 changes: 17 additions & 8 deletions src/utils/github/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import {
reviewText,
} from './structures.js'
import { debug } from '@actions/core'
import { average, getHoursAgo, minutesBetweenDates, snapDate, SnapType } from '@krauters/utils'
import { average, getHoursAgo, minutesBetweenDates, plural, snapDate, SnapType } from '@krauters/utils'
import { ignoreFilenamesForChanges } from '../../constants.js'
import { getRelativeHumanReadableAge } from '../misc.js'

Expand Down Expand Up @@ -101,7 +101,7 @@ export class GitHubClient {
*/
async getOrg(): Promise<Organization> {
if (!this.cacheOrganization) {
console.log(`Getting organization associated with current token...`)
debug(`Getting organization associated with current token...`)
const { data } = await this.client.rest.orgs.listMembershipsForAuthenticatedUser()

if (data.length > 1) {
Expand Down Expand Up @@ -205,17 +205,19 @@ export class GitHubClient {
withFilesAndChanges = true,
withUser = true,
}: GetPullsProps): Promise<Pull[]> {
const startTime = Date.now()
const org = await this.getOrgName()
console.log('\n')
if (state === PullState.Open) {
console.log(`Getting [${state}] pulls in org [${org}]...`)
debug(`Getting [${state}] ${plural('pull', 2)} in org [${org}]...`)
} else {
console.log(`Getting [${state}] pulls in org [${org}] that are newer than [${oldest}...`)
debug(`Getting [${state}] ${plural('pull', 2)} in org [${org}] that are newer than [${oldest}]...`)
}

const pullRequests = []
let apiRequestCount = 0
for (const repo of repositories) {
debug(`Getting [${state}] pulls in repository [${repo.name}]...`)
const repoStartTime = Date.now()
const pulls = await this.client.paginate(
this.client.rest.pulls.list,
{
Expand All @@ -224,6 +226,7 @@ export class GitHubClient {
state,
},
(response, done) => {
apiRequestCount++
debug(
`Paginated response for repository [${repo.name}], status [${response.status}], items [${response.data.length}]`,
)
Expand All @@ -237,7 +240,8 @@ export class GitHubClient {
},
)

console.log(`Found [${pulls.length}] pull in repository [${repo.name}]`)
const repoDuration = (Date.now() - repoStartTime) / 1000
debug(`Found [${pulls.length}] pull in repository [${repo.name}] in [${repoDuration.toFixed(2)}] seconds`)
for (const pull of pulls) {
const { base, closed_at, created_at, draft, html_url, merged_at, number, title, user } = pull
debug(`Processing pull [${number}]...`)
Expand Down Expand Up @@ -286,6 +290,11 @@ export class GitHubClient {
}
}

const totalDuration = (Date.now() - startTime) / 1000
console.log(
`Completed processing [${pullRequests.length}] pull requests in [${totalDuration.toFixed(2)}] seconds with [${apiRequestCount}] API calls`,
)

return pullRequests
}

Expand All @@ -301,7 +310,7 @@ export class GitHubClient {
withPublic,
}: GetRepositoriesProps): Promise<GitHubRepositories> {
const org = await this.getOrgName()
console.log(`Getting all repositories in org [${org}]...`)
debug(`Getting all repositories in org [${org}]...`)
const response = await this.client.paginate(this.client.rest.repos.listForOrg, {
org,
per_page: 100,
Expand All @@ -317,7 +326,7 @@ export class GitHubClient {
if (!withPublic) {
filteredRepos = filteredRepos.filter((repo: GitHubRepository) => repo.visibility !== RepositoryType.Public)
}
console.log(`Found [${filteredRepos.length}] repositories`)
debug(`Found [${filteredRepos.length}] repositories in org [${org}]`)
debug(
JSON.stringify(
filteredRepos.map((repo) => repo.name),
Expand Down
Loading
Loading