Skip to content

Fix main CI sanitizer integration #3219

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
SamMorrowDrums merged 1 commit into from
Sep 3, 2026
Merged

Fix main CI sanitizer integration #3219

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
2 changes: 1 addition & 1 deletion pkg/github/issues.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2013,7 +2013,7 @@ func sanitizeSubIssueTitleAndBody(issue *github.SubIssue) {
return
}
if issue.Title != nil {
issue.Title = github.Ptr(sanitize.Sanitize(*issue.Title))
issue.Title = github.Ptr(sanitize.PlainText(*issue.Title))
}
if issue.Body != nil {
issue.Body = github.Ptr(sanitize.Content(*issue.Body))
Expand Down
32 changes: 16 additions & 16 deletions pkg/github/issues_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5774,8 +5774,8 @@ func Test_AddSubIssue(t *testing.T) {
// Setup mock issue for success case (matches GitHub API response format)
mockIssue := &github.Issue{
Number: github.Ptr(42),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("This is **Markdown**\u200B"),
Title: github.Ptr("<script>alert(1)</script>can't \"quote\" AT&T\u200B"),
Body: github.Ptr("<script>alert(1)</script>This is **Markdown**\u200B"),
State: github.Ptr("open"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/42"),
User: &github.User{
Expand Down Expand Up @@ -5970,8 +5970,8 @@ func Test_AddSubIssue(t *testing.T) {
err = json.Unmarshal([]byte(textContent.Text), &returnedIssue)
require.NoError(t, err)
assert.Equal(t, *tc.expectedIssue.Number, *returnedIssue.Number)
assert.Empty(t, *returnedIssue.Title)
assert.Equal(t, "This is **Markdown**", *returnedIssue.Body)
assert.Equal(t, "can't \"quote\" AT&T", *returnedIssue.Title)
assert.Equal(t, "<script>alert(1)</script>This is **Markdown**", *returnedIssue.Body)
assert.Equal(t, *tc.expectedIssue.State, *returnedIssue.State)
assert.Equal(t, *tc.expectedIssue.HTMLURL, *returnedIssue.HTMLURL)
assert.Equal(t, *tc.expectedIssue.User.Login, *returnedIssue.User.Login)
Expand Down Expand Up @@ -5999,8 +5999,8 @@ func Test_GetSubIssues(t *testing.T) {
mockSubIssues := []*github.Issue{
{
Number: github.Ptr(123),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("This is **Markdown**\u200B"),
Title: github.Ptr("<script>alert(1)</script>can't \"quote\" AT&T\u200B"),
Body: github.Ptr("<script>alert(1)</script>This is **Markdown**\u200B"),
State: github.Ptr("open"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/123"),
User: &github.User{
Expand Down Expand Up @@ -6200,8 +6200,8 @@ func Test_GetSubIssues(t *testing.T) {
if i < len(tc.expectedSubIssues) {
assert.Equal(t, *tc.expectedSubIssues[i].Number, *subIssue.Number)
if i == 0 {
assert.Empty(t, *subIssue.Title)
assert.Equal(t, "This is **Markdown**", *subIssue.Body)
assert.Equal(t, "can't \"quote\" AT&T", *subIssue.Title)
assert.Equal(t, "<script>alert(1)</script>This is **Markdown**", *subIssue.Body)
} else {
assert.Equal(t, *tc.expectedSubIssues[i].Title, *subIssue.Title)
}
Expand Down Expand Up @@ -6657,8 +6657,8 @@ func Test_RemoveSubIssue(t *testing.T) {
// Setup mock issue for success case (matches GitHub API response format - the updated parent issue)
mockIssue := &github.Issue{
Number: github.Ptr(42),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("This is **Markdown**\u200B"),
Title: github.Ptr("<script>alert(1)</script>can't \"quote\" AT&T\u200B"),
Body: github.Ptr("<script>alert(1)</script>This is **Markdown**\u200B"),
State: github.Ptr("open"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/42"),
User: &github.User{
Expand Down Expand Up @@ -6836,8 +6836,8 @@ func Test_RemoveSubIssue(t *testing.T) {
err = json.Unmarshal([]byte(textContent.Text), &returnedIssue)
require.NoError(t, err)
assert.Equal(t, *tc.expectedIssue.Number, *returnedIssue.Number)
assert.Empty(t, *returnedIssue.Title)
assert.Equal(t, "This is **Markdown**", *returnedIssue.Body)
assert.Equal(t, "can't \"quote\" AT&T", *returnedIssue.Title)
assert.Equal(t, "<script>alert(1)</script>This is **Markdown**", *returnedIssue.Body)
assert.Equal(t, *tc.expectedIssue.State, *returnedIssue.State)
assert.Equal(t, *tc.expectedIssue.HTMLURL, *returnedIssue.HTMLURL)
assert.Equal(t, *tc.expectedIssue.User.Login, *returnedIssue.User.Login)
Expand Down Expand Up @@ -6865,8 +6865,8 @@ func Test_ReprioritizeSubIssue(t *testing.T) {
// Setup mock issue for success case (matches GitHub API response format - the updated parent issue)
mockIssue := &github.Issue{
Number: github.Ptr(42),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("This is **Markdown**\u200B"),
Title: github.Ptr("<script>alert(1)</script>can't \"quote\" AT&T\u200B"),
Body: github.Ptr("<script>alert(1)</script>This is **Markdown**\u200B"),
State: github.Ptr("open"),
HTMLURL: github.Ptr("https://github.com/owner/repo/issues/42"),
User: &github.User{
Expand Down Expand Up @@ -7096,8 +7096,8 @@ func Test_ReprioritizeSubIssue(t *testing.T) {
err = json.Unmarshal([]byte(textContent.Text), &returnedIssue)
require.NoError(t, err)
assert.Equal(t, *tc.expectedIssue.Number, *returnedIssue.Number)
assert.Empty(t, *returnedIssue.Title)
assert.Equal(t, "This is **Markdown**", *returnedIssue.Body)
assert.Equal(t, "can't \"quote\" AT&T", *returnedIssue.Title)
assert.Equal(t, "<script>alert(1)</script>This is **Markdown**", *returnedIssue.Body)
assert.Equal(t, *tc.expectedIssue.State, *returnedIssue.State)
assert.Equal(t, *tc.expectedIssue.HTMLURL, *returnedIssue.HTMLURL)
assert.Equal(t, *tc.expectedIssue.User.Login, *returnedIssue.User.Login)
Expand Down
14 changes: 7 additions & 7 deletions pkg/github/minimal_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ type MinimalDiscussionComment struct {
func newMinimalDiscussionComment(id string, body string, isAnswer bool) MinimalDiscussionComment {
return MinimalDiscussionComment{
ID: id,
Body: sanitize.Sanitize(body),
Body: sanitize.Content(body),
IsAnswer: isAnswer,
}
}
Expand Down Expand Up @@ -1015,7 +1015,7 @@ func convertToMinimalIssuesResponseWithoutFieldValues(fragment issueQueryFragmen
func convertToMinimalIssueComment(comment *github.IssueComment) MinimalIssueComment {
m := MinimalIssueComment{
ID: comment.GetID(),
Body: sanitize.Sanitize(comment.GetBody()),
Body: sanitize.Content(comment.GetBody()),
HTMLURL: comment.GetHTMLURL(),
User: convertToMinimalUser(comment.GetUser()),
AuthorAssociation: comment.GetAuthorAssociation(),
Expand Down Expand Up @@ -1064,7 +1064,7 @@ func convertToMinimalFileContentResponse(resp *github.RepositoryContentResponse)

m.Commit = &MinimalFileCommit{
SHA: resp.Commit.GetSHA(),
Message: sanitize.Sanitize(resp.Commit.GetMessage()),
Message: sanitize.Content(resp.Commit.GetMessage()),
HTMLURL: resp.Commit.GetHTMLURL(),
}

Expand Down Expand Up @@ -1794,7 +1794,7 @@ func newMinimalCommitFromCore(sha, htmlURL string, commit *github.Commit, author

if commit != nil {
minimalCommit.Commit = &MinimalCommitInfo{
Message: sanitize.Sanitize(commit.GetMessage()),
Message: sanitize.Content(commit.GetMessage()),
}

if commit.Author != nil {
Expand Down Expand Up @@ -2000,7 +2000,7 @@ func convertToMinimalPullRequestCommits(commits []*github.RepositoryCommit) []Mi
}

if commit.Commit != nil {
minimalCommit.Message = sanitize.Sanitize(commit.Commit.GetMessage())
minimalCommit.Message = sanitize.Content(commit.Commit.GetMessage())
minimalCommit.Author = convertToMinimalCommitAuthor(commit.Commit.Author)
}

Expand Down Expand Up @@ -2095,7 +2095,7 @@ func convertToMinimalWorkflowRun(workflowRun *github.WorkflowRun) MinimalWorkflo

if headCommit := workflowRun.GetHeadCommit(); headCommit != nil && headCommit.GetMessage() != "" {
minimalRun.HeadCommit = &MinimalWorkflowRunHeadCommit{
Message: sanitize.Sanitize(headCommit.GetMessage()),
Message: sanitize.Content(headCommit.GetMessage()),
}
}

Expand Down Expand Up @@ -2280,7 +2280,7 @@ func convertToMinimalReviewThread(thread reviewThreadNode) MinimalReviewThread {

func convertToMinimalReviewComment(c reviewCommentNode) MinimalReviewComment {
m := MinimalReviewComment{
Body: sanitize.Sanitize(string(c.Body)),
Body: sanitize.Content(string(c.Body)),
Path: string(c.Path),
Author: string(c.Author.Login),
HTMLURL: c.URL.String(),
Expand Down
16 changes: 15 additions & 1 deletion pkg/github/repositories.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2233,6 +2233,7 @@ func GetLatestRelease(t translations.TranslationHelperFunc) inventory.ServerTool
return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to get latest release", resp, body), nil, nil
}

sanitizeReleaseNameAndBody(release)
r, err := json.Marshal(release)
if err != nil {
return nil, nil, fmt.Errorf("failed to marshal response: %w", err)
Expand Down Expand Up @@ -2319,6 +2320,7 @@ func GetReleaseByTag(t translations.TranslationHelperFunc) inventory.ServerTool
return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to get release by tag", resp, body), nil, nil
}

sanitizeReleaseNameAndBody(release)
r, err := json.Marshal(release)
if err != nil {
return nil, nil, fmt.Errorf("failed to marshal response: %w", err)
Expand All @@ -2338,6 +2340,18 @@ func GetReleaseByTag(t translations.TranslationHelperFunc) inventory.ServerTool
)
}

func sanitizeReleaseNameAndBody(release *github.RepositoryRelease) {
if release == nil {
return
}
if release.Name != nil {
release.Name = github.Ptr(sanitize.PlainText(*release.Name))
}
if release.Body != nil {
release.Body = github.Ptr(sanitize.Content(*release.Body))
}
}

// ListStarredRepositories creates a tool to list starred repositories for the authenticated user or a specified user.
func ListStarredRepositories(t translations.TranslationHelperFunc) inventory.ServerTool {
return NewTool(
Expand Down Expand Up @@ -2981,7 +2995,7 @@ func GetFileBlame(t translations.TranslationHelperFunc) inventory.ServerTool {
SHA: sha,
// Sanitized after truncation so the headline is cut at the author's real
// first line break rather than one introduced by sanitization.
MessageHeadline: sanitize.Content(headline),
MessageHeadline: sanitize.PlainText(headline),
CommittedDate: r.Commit.CommittedDate.Format("2006-01-02T15:04:05Z"),
Author: BlameAuthor{
Name: string(r.Commit.Author.Name),
Expand Down
18 changes: 9 additions & 9 deletions pkg/github/repositories_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4854,8 +4854,8 @@ func Test_GetLatestRelease(t *testing.T) {
mockRelease := &github.RepositoryRelease{
ID: 1,
TagName: "v1.0.0",
Name: github.Ptr("First Release"),
Body: github.Ptr("<details>Notes</details>\u200B"),
Name: github.Ptr("<script>alert(1)</script>can't \"quote\" AT&T\u200B"),
Body: github.Ptr("<script>alert(1)</script><details>Notes</details>\u200B"),
}

tests := []struct {
Expand Down Expand Up @@ -4923,8 +4923,8 @@ func Test_GetLatestRelease(t *testing.T) {
err = json.Unmarshal([]byte(textContent.Text), &returnedRelease)
require.NoError(t, err)
assert.Equal(t, tc.expectedResult.TagName, returnedRelease.TagName)
assert.Equal(t, "First Release", *returnedRelease.Name)
assert.Equal(t, "<details>Notes</details>", *returnedRelease.Body)
assert.Equal(t, "can't \"quote\" AT&T", *returnedRelease.Name)
assert.Equal(t, "<script>alert(1)</script><details>Notes</details>", *returnedRelease.Body)
})
}
}
Expand All @@ -4947,8 +4947,8 @@ func Test_GetReleaseByTag(t *testing.T) {
mockRelease := &github.RepositoryRelease{
ID: 1,
TagName: "v1.0.0",
Name: github.Ptr("Release v1.0.0"),
Body: github.Ptr("<details>Notes</details>\u200B"),
Name: github.Ptr("<script>alert(1)</script>can't \"quote\" AT&T\u200B"),
Body: github.Ptr("<script>alert(1)</script><details>Notes</details>\u200B"),
Assets: []*github.ReleaseAsset{
{
ID: github.Ptr(int64(1)),
Expand Down Expand Up @@ -5088,9 +5088,9 @@ func Test_GetReleaseByTag(t *testing.T) {

assert.Equal(t, tc.expectedResult.ID, returnedRelease.ID)
assert.Equal(t, tc.expectedResult.TagName, returnedRelease.TagName)
assert.Equal(t, *tc.expectedResult.Name, *returnedRelease.Name)
assert.Equal(t, "can't \"quote\" AT&T", *returnedRelease.Name)
if tc.expectedResult.Body != nil {
assert.Equal(t, "<details>Notes</details>", *returnedRelease.Body)
assert.Equal(t, "<script>alert(1)</script><details>Notes</details>", *returnedRelease.Body)
}
if len(tc.expectedResult.Assets) > 0 {
require.Len(t, returnedRelease.Assets, len(tc.expectedResult.Assets))
Expand Down Expand Up @@ -6203,7 +6203,7 @@ func Test_GetFileBlame(t *testing.T) {
var br BlameResult
require.NoError(t, json.Unmarshal([]byte(result), &br))
require.Contains(t, br.Commits, "badc0ffee0000")
assert.Equal(t, sanitizedContentText, br.Commits["badc0ffee0000"].MessageHeadline)
assert.Equal(t, sanitizedText, br.Commits["badc0ffee0000"].MessageHeadline)
assert.NotContains(t, result, "<script>")
assert.NotContains(t, result, "Long body that should not appear")
},
Expand Down
Loading