Skip to content

cringe-213: fix GitHub PR page content extraction #70

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
biancadanforth merged 2 commits into from
Mar 17, 2026
Merged

cringe-213: fix GitHub PR page content extraction #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9391a37
cringe-213: fix GitHub PR page content extraction
biancadanforth Mar 17, 2026
5078edb
Merge branch 'main' into cringe-213
biancadanforth Mar 17, 2026
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.DS_Store
*.zip
*~
node_modules
web-ext-artifacts/
108 changes: 99 additions & 9 deletions content.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,110 @@ const {
getAttachLinks,
getBugIdsFromPRTitle,
MERGE_CONTAINER_ID,
PR_STATE_CLOSED,
PR_STATE_MERGED,
PR_STATE_OPEN,
PR_STATE_UNKNOWN,
TAB_CONVERSATION,
TAB_OTHER,
getPRNum,
getPRTitle,
getPRState,
getSelectedTab,
} = require("./github-bugzilla-content");

// Minimal GitHub PR page header HTML matching the current (post-2024) structure,
// derived from mozilla-services/socorro pull requests.
const PR_HEADER_HTML = (title, num, status, selectedTab) => `
<div>
<h1 data-component="PH_Title">
<span class="markdown-title">${title}</span><span><span>#${num}</span></span>
</h1>
<div data-component="PH_Actions"></div>
<div>
<span data-status="${status}">Merged</span>
</div>
<div data-component="PH_Navigation">
<nav aria-label="Pull request navigation tabs">
<div role="tablist">
<a role="tab" aria-selected="${selectedTab === "Conversation"}" href="#">Conversation</a>
<a role="tab" aria-selected="${selectedTab === "Commits"}" href="#">Commits</a>
<a role="tab" aria-selected="${selectedTab === "Files changed"}" href="#">Files changed</a>
</div>
</nav>
</div>
</div>
`;

describe("Content script", () => {
afterEach(() => {
// restore spies created with spyOn
jest.restoreAllMocks();
});

describe("getPRNum", () => {
it("returns the PR number from the page", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1746636: move PROCESS_TYPES to socorro directory", "7170", "pullMerged", "Conversation");
expect(getPRNum()).toBe("7170");
});

it("returns undefined when PH_Title is not present", () => {
document.body.innerHTML = "<div></div>";
expect(getPRNum()).toBeUndefined();
});
});

describe("getPRTitle", () => {
it("returns the PR title from the page", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1746636: move PROCESS_TYPES to socorro directory", "7170", "pullMerged", "Conversation");
expect(getPRTitle()).toBe("bug-1746636: move PROCESS_TYPES to socorro directory");
});

it("returns undefined when PH_Title is not present", () => {
document.body.innerHTML = "<div></div>";
expect(getPRTitle()).toBeUndefined();
});
});

describe("getPRState", () => {
it("returns PR_STATE_MERGED when the PR is merged", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1: fix things", "99", "pullMerged", "Conversation");
expect(getPRState()).toBe(PR_STATE_MERGED);
});

it("returns PR_STATE_OPEN when the PR is open", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1: fix things", "99", "pullOpened", "Conversation");
expect(getPRState()).toBe(PR_STATE_OPEN);
});

it("returns PR_STATE_CLOSED when the PR is closed", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1: fix things", "99", "pullClosed", "Conversation");
expect(getPRState()).toBe(PR_STATE_CLOSED);
});

it("returns PR_STATE_UNKNOWN when the PR is closed", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1: fix things", "99", "randomValue", "Conversation");
expect(getPRState()).toBe(PR_STATE_UNKNOWN);
});
});

describe("getSelectedTab", () => {
it("returns TAB_CONVERSATION when the Conversation tab is selected", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1: fix things", "99", "pullMerged", "Conversation");
expect(getSelectedTab()).toBe(TAB_CONVERSATION);
});

it("returns TAB_OTHER when a non-Conversation tab is selected", () => {
document.body.innerHTML = PR_HEADER_HTML("bug-1: fix things", "99", "pullMerged", "Commits");
expect(getSelectedTab()).toBe(TAB_OTHER);
});

it("returns TAB_OTHER when no tab is selected", () => {
document.body.innerHTML = "<div></div>";
expect(getSelectedTab()).toBe(TAB_OTHER);
});
});

describe("getAttachLinks", () => {
const bugIds = [1];
const repoInfo = '';
Expand Down Expand Up @@ -89,10 +185,7 @@ describe("Content script", () => {

// Mock the HTML structure
document.body.innerHTML = `
<div class="gh-header-show">
<div id="${MERGE_CONTAINER_ID}">
</div>
</div>
${PR_HEADER_HTML(prTitle, prNum, "pullMerged", "Conversation")}
<div class="TimelineItem">
<div class="TimelineItem-body">
<a class="author" href="/${author}">${author}</a> merged commit <a href="/mozilla-services/socorro/commit/${fullCommitSha}">${commitSha}</a>into main
Expand All @@ -108,13 +201,10 @@ describe("Content script", () => {

it("sends a message to the background script when the merge link is clicked when a PR is merged via a merge queue", () => {
const sendMessage = jest.spyOn(browser.runtime, "sendMessage").mockResolvedValue({});

// Mock the HTML structure
document.body.innerHTML = `
<div class="gh-header-show">
<div id="${MERGE_CONTAINER_ID}">
</div>
</div>
${PR_HEADER_HTML(prTitle, prNum, "pullMerged", "Conversation")}
<div class="TimelineItem">
<div class="TimelineItem-body">
<a class="author" href="/${author}">${author}</a>
Expand Down
54 changes: 32 additions & 22 deletions github-bugzilla-content.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,21 @@ const ATTACH_CONTAINER_ID = "robBugsonAttachLinks";
const MERGE_CONTAINER_ID = "robBugsonMergeLinks";
const LIST_CONTAINER_ID = "robBugsonListLinks";

const PR_STATE_CLOSED = "Closed";
const PR_STATE_MERGED = "Merged";
const PR_STATE_OPEN = "Open";
const PR_STATE_UNKNOWN = "Unknown";

const TAB_UNKNOWN = "Unknown";
const TAB_CONVERSATION = "Conversation";
const TAB_OTHER = "Other";


/**
* Retrieve the PR number from the pull request page.
*/
function getPRNum() {
// Get the PR number which is like "#4099"
let elem = document.querySelector("h1.gh-header-title span");
let elem = document.querySelectorAll('[data-component="PH_Title"] span')[1];
if (!elem) {
return;
}
Expand All @@ -47,7 +49,7 @@ function getPRNum() {
* Retrieve the PR title from the pull request page.
*/
function getPRTitle() {
let elem = document.querySelector("bdi.js-issue-title");
let elem = document.querySelector('[data-component="PH_Title"] span.markdown-title');
if (!elem) {
return;
}
Expand Down Expand Up @@ -85,32 +87,32 @@ function getRepoInfo() {
* Retrieve PR state.
*/
function getPRState() {
// See if there"s been a merge
let state = document.querySelector(".State.State--merged");
let state = document.querySelector('[data-status]');
if (state === null) {
return PR_STATE_UNKNOWN;
}
state = state.textContent.trim();
if (state == "Merged") {
return PR_STATE_MERGED;
switch (state.getAttribute('data-status')) {
case 'pullMerged': return PR_STATE_MERGED;
case 'pullOpened': return PR_STATE_OPEN;
case 'pullClosed': return PR_STATE_CLOSED;
default: return PR_STATE_UNKNOWN;
}
return PR_STATE_UNKNOWN;
}


/**
* For PRs, get the selected tab.
*/
function getSelectedTab() {
let tab = document.querySelector("a.tabnav-tab.selected");
let tab = document.querySelector('[role="tab"][aria-selected="true"]');
if (!tab) {
return TAB_UNKNOWN;
return TAB_OTHER;
}
let tabText = tab.textContent.trim();
if (tabText.startsWith("Conversation")) {
return TAB_CONVERSATION;
}
return TAB_UNKNOWN;
return TAB_OTHER;
}


Expand Down Expand Up @@ -233,7 +235,7 @@ function addAttachLinksToPage(pageKind, repoInfo, prNum, prTitle, prUrl, bugIds)
// If there"s no link container, then we create a new one
linkContainer = document.createElement("p");
linkContainer.id = ATTACH_CONTAINER_ID;
linkContainer.className = "subtext";
linkContainer.style.cssText = "font-size: 16px;";
}

// Remove everything from the link container so we don't end up with
Expand All @@ -242,8 +244,6 @@ function addAttachLinksToPage(pageKind, repoInfo, prNum, prTitle, prUrl, bugIds)
linkContainer.removeChild(linkContainer.firstChild);
}

let headerShow = document.querySelector("div.gh-header-show");

// If there are no bug ids, just return
if (bugIds.length == 0) {
return;
Expand All @@ -258,7 +258,8 @@ function addAttachLinksToPage(pageKind, repoInfo, prNum, prTitle, prUrl, bugIds)
linkContainer.appendChild(bugLink);
});

headerShow.appendChild(linkContainer);
let headerShow = document.querySelector('[data-component="PH_Navigation"]').parentElement;
headerShow.insertAdjacentElement('beforebegin',linkContainer);
}


Expand All @@ -267,7 +268,7 @@ function createBugsList(bugIds){
if (bugsListContainer == null) {
bugsListContainer = document.createElement("p");
bugsListContainer.id = LIST_CONTAINER_ID;
bugsListContainer.className = "subtext";
bugsListContainer.style.cssText = "font-size: 16px;";
}

// Remove everything from container so we don't have duplicates
Expand Down Expand Up @@ -310,8 +311,8 @@ function addBugListToPage(pageKind, bugIds) {
parentElement.insertBefore(createBugsList(bugIds), insertBeforeEl);

} else if (pageKind == "pr") {
parentElement = document.querySelector('div.gh-header-show');
parentElement.appendChild(createBugsList(bugIds));
parentElement = document.querySelector('[data-component="PH_Navigation"]').parentElement;
parentElement.insertAdjacentElement('beforebegin', createBugsList(bugIds));
}
}

Expand All @@ -331,7 +332,7 @@ function addMergeLinks(pageKind, repoInfo, prNum, prTitle, prUrl, prState, bugId
// If there"s no link container, then we create a new one
linkContainer = document.createElement("p");
linkContainer.id = MERGE_CONTAINER_ID;
linkContainer.className = "subtext";
linkContainer.style.cssText = "font-size: 16px;";
}

// Removes everything from the link container so we don't end up
Expand Down Expand Up @@ -380,7 +381,7 @@ function addMergeLinks(pageKind, repoInfo, prNum, prTitle, prUrl, prState, bugId
}
});

let headerShow = document.querySelector("div.gh-header-show");
let headerShow = document.querySelector('[data-component="PH_Navigation"]').parentElement;
let separator = document.createTextNode(", ");

if (author && prNum && commitSha && commitUrl) {
Expand Down Expand Up @@ -419,7 +420,7 @@ function addMergeLinks(pageKind, repoInfo, prNum, prTitle, prUrl, prState, bugId
});
}

headerShow.appendChild(linkContainer);
headerShow.insertAdjacentElement('beforebegin',linkContainer);
}


Expand Down Expand Up @@ -511,6 +512,15 @@ module.exports = {
BUG_BASE_URL,
getAttachLinks,
getBugIdsFromPRTitle,
getPRNum,
getPRState,
getPRTitle,
getSelectedTab,
MERGE_CONTAINER_ID,
PR_STATE_CLOSED,
PR_STATE_MERGED,
PR_STATE_OPEN,
PR_STATE_UNKNOWN,
TAB_CONVERSATION,
TAB_OTHER,
}
Loading