diff --git a/openedx_webhooks/__init__.py b/openedx_webhooks/__init__.py
index 99bb4e5b..e1a0bbf6 100644
--- a/openedx_webhooks/__init__.py
+++ b/openedx_webhooks/__init__.py
@@ -51,8 +51,6 @@ def create_app(config=None):
# attach our blueprints
from .github_views import github_bp
app.register_blueprint(github_bp, url_prefix="/github")
- from .jira_views import jira_bp
- app.register_blueprint(jira_bp, url_prefix="/jira")
from .ui import ui as ui_blueprint
app.register_blueprint(ui_blueprint)
from .tasks import tasks as tasks_blueprint
diff --git a/openedx_webhooks/github_views.py b/openedx_webhooks/github_views.py
index 9e07e83f..d23a33a2 100644
--- a/openedx_webhooks/github_views.py
+++ b/openedx_webhooks/github_views.py
@@ -112,14 +112,13 @@ def handle_pull_request_event(event):
def handle_comment_event(event):
"""Handle a webhook event about a comment."""
- # When the bot comments on a pull request, it causes an event, which gets
- # sent to webhooks, including us. We don't have to do anything for our
- # own comment events.
- who = event.get("sender", {}).get("login", "someone")
- if who == get_bot_username():
- return "No thanks", 202
-
match event:
+ case {"sender": {"login": who}} if who == get_bot_username():
+ # When the bot comments on a pull request, it causes an event, which
+ # gets sent to webhooks, including us. We don't have to do anything
+ # for our own comment events.
+ pass
+
case {"issue": {"pull_request": _}}:
# The comment is on a pull request. Re-shape the data to conform to
# a pull request reported by a pull request event, and fire
@@ -133,7 +132,6 @@ def handle_comment_event(event):
case _:
pass
- # Soon to come: handling comments.
return "No thanks", 202
diff --git a/openedx_webhooks/jira_views.py b/openedx_webhooks/jira_views.py
deleted file mode 100644
index 5a9bb067..00000000
--- a/openedx_webhooks/jira_views.py
+++ /dev/null
@@ -1,370 +0,0 @@
-"""
-These are the views that process webhook events coming from JIRA.
-"""
-
-import json
-import logging
-
-from flask import (
- Blueprint, make_response, render_template, request,
-)
-from urlobject import URLObject
-
-from openedx_webhooks.auth import get_github_session, get_jira_session
-from openedx_webhooks.tasks.github_work import get_repo_labels
-from openedx_webhooks.utils import (
- jira_get, jira_paginated_get, sentry_extra_context,
- github_pr_num, github_pr_url, github_pr_repo,
- requires_auth,
-)
-
-jira_bp = Blueprint('jira_views', __name__)
-logger = logging.getLogger(__name__)
-
-
-@jira_bp.route("/issue/rescan", methods=("GET",))
-@requires_auth
-def rescan_issues_get():
- """
- Display a friendly HTML form for re-scanning JIRA issues.
- """
- return render_template("jira_rescan_issues.html")
-
-
-@jira_bp.route("/issue/rescan", methods=("POST",))
-@requires_auth
-def rescan_issues():
- """
- Re-scan all JIRA issues that are in the "Needs Triage" state. If any were
- created by edX employees, they will be automatically transitioned to an
- "Open" state.
-
- Normally, issues are processed automatically. However, sometimes an issue
- is skipped accidentally, either due to a network hiccup, a bug in JIRA,
- or this bot going offline. This endpoint is used to clean up after these
- kind of problems.
- """
- jql = request.form.get("jql") or 'status = "Needs Triage" ORDER BY key'
- sentry_extra_context({"jql": jql})
- issues = jira_paginated_get(
- "/rest/api/2/search", jql=jql, obj_name="issues", session=get_jira_session(),
- )
- results = {}
-
- for issue in issues:
- issue_key = issue["key"]
- results[issue_key] = issue_opened(issue)
-
- resp = make_response(json.dumps(results), 200)
- resp.headers["Content-Type"] = "application/json"
- return resp
-
-
-@jira_bp.route("/issue/created", methods=("POST",))
-def issue_created():
- """
- Received an "issue created" event from JIRA. See `JIRA's webhook docs`_.
-
- .. _JIRA's webhook docs: https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview
- """
- try:
- event = request.get_json()
- except ValueError:
- raise ValueError("Invalid JSON from JIRA: {data}".format(data=request.data))
- sentry_extra_context({"event": event})
-
- logger.info("Jira issue created: {}".format(event["issue"]["key"]))
- # Temporary verbose logging.
- logger.info("/jira/issue/created data: {}".format(json.dumps(event)))
-
- return "Doing nothing"
-
- if "issue" not in event:
- # It's rare, but we occasionally see junk data from JIRA. For example,
- # here's a real API request we've received on this handler:
- # {"baseUrl": "https://openedx.atlassian.net",
- # "key": "jira:1fec1026-b232-438f-adab-13b301059297",
- # "newVersion": 64005, "oldVersion": 64003}
- # If we don't have an "issue" key, it's junk.
- return "What is this shit!?", 400
-
- return issue_opened(event["issue"])
-
-
-def should_transition(issue):
- """
- Return a boolean indicating if the given issue should be transitioned
- automatically from "Needs Triage" to an open status.
- """
- issue_key = issue["key"]
- issue_status = issue["fields"]["status"]["name"]
- project_key = issue["fields"]["project"]["key"]
- if issue_status != "Needs Triage":
- logger.info(f"{issue_key} has status {issue_status}, does not need to be processed.")
- return False
-
- # Open source pull requests do not skip Needs Triage.
- # However, if someone creates a subtask on an OSPR issue, that subtasks
- # might skip Needs Triage (it just follows the rest of the logic in this
- # function.)
- is_subtask = issue["fields"]["issuetype"]["subtask"]
- if project_key == "OSPR" and not is_subtask:
- logger.info(f"{issue_key} is an open source pull request, and does not need to be processed.")
- return False
-
- user_url = URLObject(issue["fields"]["creator"]["self"])
- user_url = user_url.set_query_param("expand", "groups")
-
- user_resp = jira_get(user_url)
- user_resp.raise_for_status()
-
- user = user_resp.json()
- user_group_map = {g["name"]: g["self"] for g in user["groups"]["items"]}
- user_groups = set(user_group_map)
-
- exempt_groups = {
- # group name: set of projects that they can create non-triage issues
- "edx-employees": {"ALL"},
- "opencraft": {"SOL"},
- }
- for user_group in user_groups:
- if user_group not in exempt_groups:
- continue
- exempt_projects = exempt_groups[user_group]
- if "ALL" in exempt_projects:
- return True
- if project_key in exempt_projects:
- return True
-
- return False
-
-
-def issue_opened(issue):
- sentry_extra_context({"issue": issue})
-
- issue_key = issue["key"]
- issue_url = URLObject(issue["self"])
-
- action = "ignored"
- do_it = should_transition(issue)
- if do_it:
- # In JIRA, a "transition" is how an issue changes from one status
- # to another, like going from "Open" to "In Progress". The workflow
- # defines what transitions are allowed, and this API will tell us
- # what transitions are currently allowed by the workflow.
- # Ref: https://docs.atlassian.com/jira/REST/ondemand/#d2e4954
- transitions_url = issue_url.with_path(issue_url.path + "/transitions")
- transitions_resp = jira_get(transitions_url)
- if transitions_resp.status_code == 404:
- # Issue was deleted.
- do_it = False
- action = "Issue is gone, ignored"
- else:
- transitions_resp.raise_for_status()
-
- if do_it:
- # This transforms the API response into a simple mapping from the
- # name of the transition (like "In Progress") to the ID of the transition.
- # Note that a transition may not have the same name as the state that it
- # goes to, so a transition to go from "Open" to "In Progress" may be
- # named something like "Start Work".
- transitions = {t["name"]: t["id"] for t in transitions_resp.json()["transitions"]}
-
- # We attempt to transition the issue into the "Open" state for the given project
- # (some projects use a different name), so look for a transition with the right name
- new_status = None
- for state_name in ["Open", "Design Backlog", "To Do"]:
- if state_name in transitions:
- new_status = state_name
- action = "Transitioned to '{}'".format(state_name)
-
- if not new_status:
- # If it's an OSPR subtask (used by teams to manage reviews), transition to team backlog
- if issue["fields"]["project"]["key"] == "OSPR" and issue["fields"]["issuetype"]["subtask"]:
- new_status = "To Backlog"
- action = "Transitioned to 'To Backlog'"
- else:
- raise ValueError("No valid transition! Possibilities are {}".format(transitions.keys()))
-
- # This creates a new API request to tell JIRA to move the issue from
- # one status to another using the specified transition. We have to
- # tell JIRA the transition ID, so we use that mapping we set up earlier.
- body = {
- "transition": {
- "id": transitions[new_status],
- }
- }
- transition_resp = get_jira_session().post(transitions_url, json=body)
- transition_resp.raise_for_status()
-
- logger.info(
- "{key} created by {name} ({account}), {action}".format(
- key=issue_key,
- name=issue["fields"]["creator"]["displayName"],
- account=issue["fields"]["creator"]["accountId"],
- action=action,
- )
- )
- return action
-
-
-def log_return(msg):
- logger.info(f"Returning: {msg}")
- return msg
-
-
-@jira_bp.route("/issue/updated", methods=("POST",))
-def issue_updated():
- """
- Received an "issue updated" event from JIRA. See `JIRA's webhook docs`_.
-
- .. _JIRA's webhook docs: https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview
- """
- try:
- event = request.get_json()
- except ValueError:
- raise ValueError("Invalid JSON from JIRA: {data}".format(data=request.data))
- sentry_extra_context({"event": event})
-
- logger.info("Jira issue updated: {}".format(event["issue"]["key"]))
- # Temporary verbose logging.
- logger.info("/jira/issue/updated data: {}".format(json.dumps(event)))
-
- return "Doing nothing"
-
- if "issue" not in event:
- # It's rare, but we occasionally see junk data from JIRA. For example,
- # here's a real API request we've received on this handler:
- # {"baseUrl": "https://openedx.atlassian.net",
- # "key": "jira:1fec1026-b232-438f-adab-13b301059297",
- # "newVersion": 64005, "oldVersion": 64003}
- # If we don't have an "issue" key, it's junk.
- return log_return("What is this shit!?"), 400
-
- # is this a comment?
- comment = event.get("comment")
- if comment:
- return log_return("Ignoring new-comment events")
-
- # we don't care about OSPR subtasks
- if event["issue"]["fields"]["issuetype"]["subtask"]:
- return log_return("ignoring subtasks")
-
- # don't care about feature proposals
- if event["issue"]["fields"]["issuetype"]["name"] == "Feature Proposal":
- return log_return("ignoring feature propsals")
-
- # is there a changelog?
- changelog = event.get("changelog")
- if not changelog:
- # it was just someone adding a comment
- return log_return("I don't care, just someone adding a comment")
-
- # did the issue change status?
- status_changelog_items = [item for item in changelog["items"] if item["field"] == "status"]
- if len(status_changelog_items) == 0:
- return log_return("I don't care, not changing status")
-
- pr_repo = github_pr_repo(event["issue"])
- if not pr_repo:
- issue_key = event["issue"]["key"]
- fail_msg = '{key} is missing "Repo" field'.format(key=issue_key)
- fail_msg += ' {0}'.format(event["issue"]["fields"]["issuetype"])
- raise Exception(fail_msg)
-
- repo_labels = get_repo_labels(repo=pr_repo)
- repo_labels_lower = {name.lower() for name in repo_labels}
-
- new_status = status_changelog_items[0]["toString"]
-
- changes = []
- if new_status == "Rejected":
- change = jira_issue_rejected(event["issue"])
- changes.append(change)
-
- if new_status.lower() in repo_labels_lower:
- change = jira_issue_status_changed(event["issue"], event["changelog"])
- changes.append(change)
-
- if changes:
- return log_return("\n".join(changes))
- else:
- return log_return("no change necessary")
-
-
-def jira_issue_rejected(issue):
- issue_key = issue["key"]
-
- pr_num = github_pr_num(issue)
- pr_url = github_pr_url(issue)
- issue_url = pr_url.replace("pulls", "issues")
-
- github = get_github_session()
- gh_issue_resp = github.get(issue_url)
- gh_issue_resp.raise_for_status()
- gh_issue = gh_issue_resp.json()
- sentry_extra_context({"github_issue": gh_issue})
- if gh_issue["state"] == "closed":
- # nothing to do
- msg = f"{issue_key} was rejected, but PR #{pr_num} was already closed"
- logger.info(msg)
- return msg
-
- # Comment on the PR to explain to look at JIRA
- username = gh_issue["user"]["login"]
- comment = {"body": (
- "Hello @{username}: We are unable to continue with "
- "review of your submission at this time. Please see the "
- "associated JIRA ticket for more explanation.".format(username=username)
- )}
- comment_resp = github.post(issue_url + "/comments", json=comment)
- comment_resp.raise_for_status()
-
- # close the pull request on Github
- close_resp = github.patch(pr_url, json={"state": "closed"})
- close_resp.raise_for_status()
-
- return "Closed PR #{num}".format(num=pr_num)
-
-
-def jira_issue_status_changed(issue, changelog):
- pr_num = github_pr_num(issue)
- pr_repo = github_pr_repo(issue)
- pr_url = github_pr_url(issue)
- issue_url = pr_url.replace("pulls", "issues")
-
- status_changelog = [item for item in changelog["items"] if item["field"] == "status"][0]
- old_status = status_changelog["fromString"]
- new_status = status_changelog["toString"]
-
- # get github issue
- github = get_github_session()
- gh_issue_resp = github.get(issue_url)
- gh_issue_resp.raise_for_status()
- gh_issue = gh_issue_resp.json()
-
- repo_labels = get_repo_labels(repo=pr_repo)
- repo_labels_lower = {name.lower(): name for name in repo_labels}
- logger.debug(f"repo_labels_lower: {repo_labels_lower!r}")
-
- # Get all the existing labels on this PR
- pr_labels = [label["name"] for label in gh_issue["labels"]]
- logger.debug(f"old labels: {pr_labels!r}")
-
- # remove old status label
- old_status_label = repo_labels_lower.get(old_status.lower(), old_status)
- logger.debug(f"old status label: {old_status_label!r}")
- if old_status_label in pr_labels:
- pr_labels.remove(old_status_label)
- # add new status label
- new_status_label = repo_labels_lower[new_status.lower()]
- logger.debug(f"new status label: {new_status_label!r}")
- if new_status_label not in pr_labels:
- pr_labels.append(new_status_label)
-
- logger.debug(f"new labels: {pr_labels!r}")
-
- # Update labels on github
- update_label_resp = github.patch(issue_url, json={"labels": pr_labels})
- update_label_resp.raise_for_status()
- return "Changed labels of PR #{num} to {labels}".format(num=pr_num, labels=pr_labels)
diff --git a/openedx_webhooks/tasks/__init__.py b/openedx_webhooks/tasks/__init__.py
index d49c3c95..02c05487 100644
--- a/openedx_webhooks/tasks/__init__.py
+++ b/openedx_webhooks/tasks/__init__.py
@@ -2,14 +2,10 @@
Helpers for Celery tasks.
"""
-import os
-
from celery.utils.log import get_task_logger
from flask import Blueprint, jsonify
-import logging_tree
from openedx_webhooks import celery, log_level
-from openedx_webhooks.debug import print_long
from openedx_webhooks.utils import requires_auth
@@ -18,7 +14,9 @@
logger.setLevel(log_level)
# Use this to show the logging configuration if you need to debug it.
-# print_long("logging_tree output", logging_tree.format.build_description())
+# import logging_tree
+# from openedx_webhooks.debug import print_long
+# print_long("logging_tree output", logging_tree.format.build_description())
# create a Flask blueprint for getting task status info
tasks = Blueprint('tasks', __name__)
diff --git a/openedx_webhooks/templates/jira_rescan_issues.html b/openedx_webhooks/templates/jira_rescan_issues.html
deleted file mode 100644
index 51cf973c..00000000
--- a/openedx_webhooks/templates/jira_rescan_issues.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-
-
-
-
- Rescan JIRA Issues
-{% with messages = get_flashed_messages() %}
- {% if messages %}
-
- {% for message in messages %}
- - {{ message }}
- {% endfor %}
-
- {% endif %}
-{% endwith %}
-
-
-
diff --git a/openedx_webhooks/templates/main.html b/openedx_webhooks/templates/main.html
index 2d54130e..26669909 100644
--- a/openedx_webhooks/templates/main.html
+++ b/openedx_webhooks/templates/main.html
@@ -38,7 +38,6 @@ JIRA
Not authenticated.
{% endif %}
- Rescan Issues