-
Notifications
You must be signed in to change notification settings - Fork 770
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.
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
Add codepath alerts #4141
Merged
Merged
Add codepath alerts #4141
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Notify Code Path Changes | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize] | ||
paths: | ||
- '**' | ||
|
||
env: | ||
OAUTH2_CLIENT_ID: ${{ secrets.OAUTH2_CLIENT_ID }} | ||
OAUTH2_CLIENT_SECRET: ${{ secrets.OAUTH2_CLIENT_SECRET }} | ||
OAUTH2_REFRESH_TOKEN: ${{ secrets.OAUTH2_REFRESH_TOKEN }} | ||
GITHUB_REPOSITORY: ${{ github.repository }} | ||
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }} | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
jobs: | ||
notify: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: '18' | ||
|
||
- name: Install dependencies | ||
run: npm install axios nodemailer | ||
|
||
- name: Run Notification Script | ||
run: | | ||
node .github/workflows/scripts/send-notification-on-change.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# when a changed file paths matches the regex, send an alert email | ||
# structure of the file is: | ||
# | ||
# javascriptRegex : email address | ||
# | ||
# For example, in PBS Go, there are many paths that can belong to bid adapter: | ||
# | ||
# /adapters/BIDDERCODE | ||
# /openrtb_ext/imp_BIDDERCODE.go | ||
# /static/bidder-params/BIDDERCODE.json | ||
# /static/bidder-info/BIDDERCODE.yaml | ||
# | ||
# The aim is to find a minimal set of regex patterns that matches any file in these paths | ||
|
||
rubicon: [email protected] |
139 changes: 139 additions & 0 deletions
139
.github/workflows/scripts/send-notification-on-change.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
// send-notification-on-change.js | ||
// | ||
// called by the code-path-changes.yml workflow, this script queries github for | ||
// the changes in the current PR, checks the config file for whether any of those | ||
// file paths are set to alert an email address, and sends email to multiple | ||
// parties if needed | ||
|
||
const fs = require('fs'); | ||
const path = require('path'); | ||
const axios = require('axios'); | ||
const nodemailer = require('nodemailer'); | ||
|
||
async function getAccessToken(clientId, clientSecret, refreshToken) { | ||
try { | ||
const response = await axios.post('https://oauth2.googleapis.com/token', { | ||
client_id: clientId, | ||
client_secret: clientSecret, | ||
refresh_token: refreshToken, | ||
grant_type: 'refresh_token', | ||
}); | ||
return response.data.access_token; | ||
} catch (error) { | ||
console.error('Failed to fetch access token:', error.response?.data || error.message); | ||
process.exit(1); | ||
} | ||
} | ||
|
||
(async () => { | ||
const configFilePath = path.join(__dirname, 'codepath-notification'); | ||
const repo = process.env.GITHUB_REPOSITORY; | ||
const prNumber = process.env.GITHUB_PR_NUMBER; | ||
const token = process.env.GITHUB_TOKEN; | ||
|
||
// Generate OAuth2 access token | ||
const clientId = process.env.OAUTH2_CLIENT_ID; | ||
const clientSecret = process.env.OAUTH2_CLIENT_SECRET; | ||
const refreshToken = process.env.OAUTH2_REFRESH_TOKEN; | ||
|
||
// validate params | ||
if (!repo || !prNumber || !token || !clientId || !clientSecret || !refreshToken) { | ||
console.error('Missing required environment variables.'); | ||
process.exit(1); | ||
} | ||
|
||
// the whole process is in a big try/catch. e.g. if the config file doesn't exist, github is down, etc. | ||
try { | ||
// Read and process the configuration file | ||
const configFileContent = fs.readFileSync(configFilePath, 'utf-8'); | ||
const configRules = configFileContent | ||
.split('\n') | ||
.filter(line => line.trim() !== '' && !line.trim().startsWith('#')) // Ignore empty lines and comments | ||
.map(line => { | ||
const [regex, email] = line.split(':').map(part => part.trim()); | ||
return { regex: new RegExp(regex), email }; | ||
}); | ||
|
||
// Fetch changed files from github | ||
const [owner, repoName] = repo.split('/'); | ||
const apiUrl = `https://api.github.com/repos/${owner}/${repoName}/pulls/${prNumber}/files`; | ||
const response = await axios.get(apiUrl, { | ||
headers: { | ||
Authorization: `Bearer ${token}`, | ||
Accept: 'application/vnd.github.v3+json', | ||
}, | ||
}); | ||
|
||
const changedFiles = response.data.map(file => file.filename); | ||
console.log('Changed files:', changedFiles); | ||
|
||
// match file pathnames that are in the config and group them by email address | ||
const matchesByEmail = {}; | ||
changedFiles.forEach(file => { | ||
configRules.forEach(rule => { | ||
if (rule.regex.test(file)) { | ||
if (!matchesByEmail[rule.email]) { | ||
matchesByEmail[rule.email] = []; | ||
} | ||
matchesByEmail[rule.email].push(file); | ||
} | ||
}); | ||
}); | ||
|
||
// Exit successfully if no matches were found | ||
if (Object.keys(matchesByEmail).length === 0) { | ||
console.log('No matches found. Exiting successfully.'); | ||
process.exit(0); | ||
} | ||
|
||
console.log('Grouped matches by email:', matchesByEmail); | ||
|
||
// get ready to email the changes | ||
const accessToken = await getAccessToken(clientId, clientSecret, refreshToken); | ||
|
||
// Configure Nodemailer with OAuth2 | ||
// service: 'Gmail', | ||
const transporter = nodemailer.createTransport({ | ||
host: "smtp.gmail.com", | ||
port: 465, | ||
secure: true, | ||
auth: { | ||
type: 'OAuth2', | ||
user: '[email protected]', | ||
clientId: clientId, | ||
clientSecret: clientSecret, | ||
refreshToken: refreshToken, | ||
accessToken: accessToken | ||
}, | ||
}); | ||
|
||
// Send one email per recipient | ||
for (const [email, files] of Object.entries(matchesByEmail)) { | ||
const emailBody = ` | ||
${email}, | ||
<p> | ||
Files owned by you have been changed in open source ${repo}. The <a href="https://github.com/${repo}/pull/${prNumber}">pull request is #${prNumber}</a>. These are the files you own that have been modified: | ||
<ul> | ||
${files.map(file => `<li>${file}</li>`).join('')} | ||
</ul> | ||
`; | ||
|
||
try { | ||
await transporter.sendMail({ | ||
from: `"Prebid Info" <[email protected]>`, | ||
to: email, | ||
subject: `Files have been changed in open source ${repo}`, | ||
html: emailBody, | ||
}); | ||
|
||
console.log(`Email sent successfully to ${email}`); | ||
console.log(`${emailBody}`); | ||
} catch (error) { | ||
console.error(`Failed to send email to ${email}:`, error.message); | ||
} | ||
} | ||
} catch (error) { | ||
console.error('Error:', error.message); | ||
process.exit(1); | ||
} | ||
})(); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fs
andpath
are also listed as dependencies in.github/workflows/scripts/send-notification-on-change.js
, do they need to get installed here? My javascript is a little rusty.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does seem to be needed as it does work over in the Java repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does not seem to be needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'fs' and 'path' do not need to be listed in the npm install for this to work.