Skip to content

Commit

Permalink
notifications: Split notification message construction from ircclient
Browse files Browse the repository at this point in the history
  • Loading branch information
@OatmealDome
OatmealDome committed Dec 24, 2024
1 parent 2f35129 commit dc1aae7
Show file tree
Hide file tree
Showing 4 changed files with 360 additions and 294 deletions.
13 changes: 12 additions & 1 deletion central/__main__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
git,
github,
ircclient,
notifications,
redmine,
webserver,
wiki,
Expand Down Expand Up @@ -106,7 +107,17 @@ def main():
logging.info("Configuration loaded, starting modules initialization.")

# Start the modules.
for mod in [admin, buildbot, git, github, ircclient, redmine, webserver, wiki]:
for mod in [
admin,
buildbot,
git,
github,
ircclient,
notifications,
redmine,
webserver,
wiki,
]:
mod.start()

logging.info("Modules started, waiting for events.")
Expand Down
5 changes: 5 additions & 0 deletions central/events.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ def ConfigReload():
return {}


@event("notification")
def Notification(msg: str):
return {"msg": msg}


@event("irc_message")
def IRCMessage(who: str, where: str, what: str, modes: str, direct: bool):
return {"who": who, "where": where, "what": what, "modes": modes, "direct": direct}
Expand Down
296 changes: 3 additions & 293 deletions central/ircclient.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,318 +44,28 @@ def on_channel_message(self, who, channel, msg):
events.dispatcher.dispatch("ircclient", evt)


class EventSettler(utils.DaemonThread):
SETTLE_TIMEOUT_SECS = 30.0

def __init__(self, handler):
super(EventSettler, self).__init__()
self.handler = handler
self.queue = queue.Queue()
self.start()

def push(self, item):
self.queue.put(item)

def run_daemonized(self):
l = []
while True:
l = [self.queue.get()]
try:
while True:
l.append(self.queue.get(timeout=self.SETTLE_TIMEOUT_SECS))
except queue.Empty:
self.handler(l)


class EventTarget(events.EventTarget):
def __init__(self, bot):
self.bot = bot
self.build_status_settler = EventSettler(self.handle_build_status_settled)
self.queue = queue.Queue()

def push_event(self, evt):
self.queue.put(evt)

def accept_event(self, evt):
accepted_types = [
events.Issue.TYPE,
events.GHPush.TYPE,
events.GHPullRequest.TYPE,
events.GHPullRequestReview.TYPE,
events.GHPullRequestComment.TYPE,
events.GHIssueComment.TYPE,
events.GHCommitComment.TYPE,
events.BuildStatus.TYPE,
events.Notification.TYPE,
]
return evt.type in accepted_types

def run(self):
while True:
evt = self.queue.get()
if evt.type == events.Issue.TYPE:
self.handle_issue(evt)
elif evt.type == events.GHPush.TYPE:
self.handle_gh_push(evt)
elif evt.type == events.GHPullRequest.TYPE:
self.handle_gh_pull_request(evt)
elif evt.type == events.GHPullRequestReview.TYPE:
self.handle_gh_pull_request_review(evt)
elif evt.type == events.GHPullRequestComment.TYPE:
self.handle_gh_pull_request_comment(evt)
elif evt.type == events.GHIssueComment.TYPE:
self.handle_gh_issue_comment(evt)
elif evt.type == events.GHCommitComment.TYPE:
self.handle_gh_commit_comment(evt)
elif evt.type == events.BuildStatus.TYPE:
self.handle_build_status(evt)
if evt.type == events.Notification.TYPE:
self.bot.say(evt.msg)
else:
logging.error("Got unknown event for irc: %r" % evt.type)

def format_nickname(self, nickname, avoid_hl=True):
# Add a unicode zero-width space in the nickname to avoid highlights.
if avoid_hl and nickname:
nickname = nickname[0] + "\ufeff" + nickname[1:]
return Tags.Green(nickname)

def handle_issue(self, evt):
"""Sends an IRC message notifying of a new issue update."""
author = self.format_nickname(evt.author)
if evt.new:
short_url = "https://dolp.in/i%d" % evt.issue
url = Tags.UnderlineBlue(short_url)
msg = 'Issue %d created: "%s" by %s - %s'
msg = msg % (evt.issue, evt.title, author, url)
else:
short_url = "https://dolp.in/i%d/%d" % (evt.issue, evt.update)
url = Tags.UnderlineBlue(short_url)
msg = 'Update %d to issue %d ("%s") by %s - %s'
msg = msg % (evt.update, evt.issue, evt.title, author, url)
self.bot.say(msg)

def handle_gh_push(self, evt):
fmt_url = Tags.UnderlineBlue
fmt_repo_name = Tags.UnderlinePink
fmt_ref = Tags.Purple
fmt_hash = lambda h: Tags.Grey(h[:6])

commits = [utils.ObjectLike(c) for c in evt.commits]
distinct_commits = [c for c in commits if c.distinct and c.message.strip()]
num_commits = len(distinct_commits)

parts = []
parts.append("[" + fmt_repo_name(evt.repo) + "]")
parts.append(self.format_nickname(evt.pusher))

if evt.created:
if evt.ref_type == "tags":
parts.append("tagged " + fmt_ref(evt.ref_name) + " at")
parts.append(
fmt_ref(evt.base_ref_name)
if evt.base_ref_name
else fmt_hash(evt.after_sha)
)
else:
parts.append("created " + fmt_ref(evt.ref_name))
if evt.base_ref_name:
parts.append("from " + fmt_ref(evt.base_ref_name))
elif not distinct_commits:
parts.append("at " + fmt_hash(evt.after_sha))

if distinct_commits:
parts.append("+" + Tags.Bold(str(num_commits)))
parts.append("new commit" + ("s" if num_commits > 1 else ""))
elif evt.deleted:
parts.append(Tags.Red("deleted ") + fmt_ref(evt.ref_name))
parts.append("at " + fmt_hash(evt.before_sha))
elif evt.forced:
parts.append(Tags.Red("force-pushed ") + fmt_ref(evt.ref_name))
parts.append(
"from " + fmt_hash(evt.before_sha) + " to " + fmt_hash(evt.after_sha)
)
elif commits and not distinct_commits:
if evt.base_ref_name:
parts.append(
"merged "
+ fmt_ref(evt.base_ref_name)
+ " into "
+ fmt_ref(evt.ref_name)
)
else:
parts.append("fast-forwarded " + fmt_ref(evt.ref_name))
parts.append(
"from "
+ fmt_hash(evt.before_sha)
+ " to "
+ fmt_hash(evt.after_sha)
)
else:
parts.append("pushed " + Tags.Bold(str(num_commits)))
parts.append("new commit" + ("s" if num_commits > 1 else ""))
parts.append("to " + fmt_ref(evt.ref_name))

self.bot.say(" ".join(str(p) for p in parts))

for commit in distinct_commits[:4]:
firstline = commit.message.split("\n")[0]
author = self.format_nickname(commit.author.name)
added = Tags.LtGreen(str(len(commit.added)))
modified = Tags.LtGreen(str(len(commit.modified)))
removed = Tags.Red(str(len(commit.removed)))
url = Tags.UnderlineBlue(utils.shorten_url(commit.url))
self.bot.say(
"%s by %s [%s|%s|%s] %s %s"
% (commit.hash[:6], author, added, modified, removed, url, firstline)
)

if len(distinct_commits) > 4:
self.bot.say("... and %d more commits" % (len(distinct_commits) - 4))

def handle_gh_pull_request(self, evt):
action = evt.action
if action == "synchronize":
action = "synchronized"
elif action == "review_requested":
action = "requested a review from %s for" % ", ".join(
[user["login"] for user in evt.requested_reviewers]
)
elif action == "review_request_removed":
action = "dismissed a review request on"
elif action == "ready_for_review":
action = "marked ready for review"
elif action == "converted_to_draft":
action = "converted to draft"
elif action == "closed" and evt.merged:
action = "merged"
self.bot.say(
"[%s] %s %s pull request #%d: %s (%s...%s): %s"
% (
Tags.UnderlinePink(evt.repo),
self.format_nickname(evt.author),
action,
evt.id,
evt.title,
Tags.Purple(evt.base_ref_name),
Tags.Purple(evt.head_ref_name),
Tags.UnderlineBlue(utils.shorten_url(evt.url)),
)
)

def handle_gh_pull_request_review(self, evt):
# GitHub sends a review event in addition to a review comment event
# when someone replies to an earlier comment or adds a single comment,
# even when they didn't really submit a pull request review.
# To prevent useless notifications, we skip any "review" which only has
# one comment, since there is already a comment notification for those.
if (
len(evt.comments) == 1
and evt.comments[0].created_at == evt.comments[0].updated_at
):
return

if evt.state == "pending" or evt.action == "edited":
return

if evt.action == "submitted" and evt.state == "approved":
action = "approved"
if len(evt.comments) != 0:
action += " and commented on"
elif evt.action == "submitted" and evt.state == "commented":
action = "reviewed and commented on"
# GitHub sends a review event when someone replies to a review comment.
# Omit 'reviewed and' in this case.
for comment in evt.comments:
if "in_reply_to_id" in comment:
action = "commented on"
break
elif evt.action == "submitted" and evt.state == "changes_requested":
action = "requested changes to"
elif evt.action == "dismissed":
action = "dismissed their review on"
else:
action = "%s their review on" % evt.action
self.bot.say(
"[%s] %s %s pull request #%s (%s): %s"
% (
Tags.UnderlinePink(evt.repo),
self.format_nickname(evt.author),
action,
evt.pr_id,
evt.pr_title,
Tags.UnderlineBlue(utils.shorten_url(evt.url)),
)
)

def handle_gh_pull_request_comment(self, evt):
if evt.is_part_of_review or evt.action != "created":
return
self.bot.say(
"[%s] %s commented on #%s %s: %s"
% (
Tags.UnderlinePink(evt.repo),
self.format_nickname(evt.author),
evt.id,
evt.hash[:6],
Tags.UnderlineBlue(utils.shorten_url(evt.url)),
)
)

def handle_gh_issue_comment(self, evt):
if evt.author == cfg.github.app.username:
return
if evt.action == "created":
action = "commented on"
else:
action = "%s a comment on" % evt.action
self.bot.say(
"[%s] %s %s #%s (%s): %s"
% (
Tags.UnderlinePink(evt.repo),
self.format_nickname(evt.author),
action,
evt.id,
evt.title,
Tags.UnderlineBlue(utils.shorten_url(evt.url)),
)
)

def handle_gh_commit_comment(self, evt):
self.bot.say(
"[%s] %s commented on commit %s: %s"
% (
Tags.UnderlinePink(evt.repo),
self.format_nickname(evt.author),
evt.commit,
Tags.UnderlineBlue(utils.shorten_url(evt.url)),
)
)

def handle_build_status(self, evt):
if evt.success or evt.pending:
return
self.build_status_settler.push(evt)

def handle_build_status_settled(self, evts):
per_shortrev = {}
for evt in evts:
per_shortrev.setdefault(evt.shortrev, []).append(evt)
for shortrev, evts in per_shortrev.items():
builders = [evt.service for evt in evts]
builders.sort()

evt = evts[0]
if evt.pr is not None:
shortrev = "#%s" % evt.pr
self.bot.say(
"[%s] build for %s %s on builders [%s]: %s"
% (
Tags.UnderlinePink(evt.repo),
shortrev,
Tags.Red("failed"),
", ".join(builders),
Tags.UnderlineBlue(utils.shorten_url(evt.url)),
)
)


def start():
"""Starts the IRC client."""
Expand Down
Loading

0 comments on commit dc1aae7

Please sign in to comment.