Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/discussions.go
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ func GetDiscussion(t translations.TranslationHelperFunc) inventory.ServerTool {
response := map[string]any{
"number": int(d.Number),
"title": sanitize.Sanitize(string(d.Title)),
"body": sanitize.Sanitize(string(d.Body)),
"body": sanitize.Content(string(d.Body)),
"url": string(d.URL),
"closed": bool(d.Closed),
"isAnswered": bool(d.IsAnswered),
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/discussions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ func Test_GetDiscussion(t *testing.T) {
expected: map[string]any{
"number": float64(1),
"title": sanitizedText,
"body": sanitizedText,
"body": sanitizedContentText,
"url": "https://github.com/owner/repo/discussions/1",
"closed": false,
"isAnswered": false,
Expand Down
1 change: 0 additions & 1 deletion pkg/github/find_duplicate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,6 @@ func Test_FindDuplicate_SanitizesIssueTitle(t *testing.T) {
require.NoError(t, json.Unmarshal([]byte(text.Text), &candidates))
require.Len(t, candidates, 1)
assert.Equal(t, sanitizedText, candidates[0].Issue.Title)
assert.NotContains(t, text.Text, "<script>")
}

func Test_FindDuplicate_OmitsUnsetParams(t *testing.T) {
Expand Down
20 changes: 19 additions & 1 deletion pkg/github/issues.go
Original file line number Diff line number Diff line change
Expand Up @@ -1118,6 +1118,9 @@ func GetSubIssues(ctx context.Context, client *github.Client, deps ToolDependenc
subIssues = filteredSubIssues
}

for _, subIssue := range subIssues {
sanitizeSubIssueTitleAndBody(subIssue)
}
r, err := json.Marshal(subIssues)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
Expand Down Expand Up @@ -1708,6 +1711,7 @@ func AddSubIssue(ctx context.Context, client *github.Client, owner string, repo
return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to add sub-issue", resp, body), nil
}

sanitizeSubIssueTitleAndBody(subIssue)
r, err := json.Marshal(subIssue)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
Expand Down Expand Up @@ -1739,6 +1743,7 @@ func RemoveSubIssue(ctx context.Context, client *github.Client, owner string, re
return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to remove sub-issue", resp, body), nil
}

sanitizeSubIssueTitleAndBody(subIssue)
r, err := json.Marshal(subIssue)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
Expand Down Expand Up @@ -1788,6 +1793,7 @@ func ReprioritizeSubIssue(ctx context.Context, client *github.Client, owner stri
return ghErrors.NewGitHubAPIStatusErrorResponse(ctx, "failed to reprioritize sub-issue", resp, body), nil
}

sanitizeSubIssueTitleAndBody(subIssue)
r, err := json.Marshal(subIssue)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
Expand Down Expand Up @@ -1998,7 +2004,19 @@ func sanitizeIssueTitleAndBody(issue *github.Issue) {
issue.Title = github.Ptr(sanitize.Sanitize(*issue.Title))
}
if issue.Body != nil {
issue.Body = github.Ptr(sanitize.Sanitize(*issue.Body))
issue.Body = github.Ptr(sanitize.Content(*issue.Body))
}
}

func sanitizeSubIssueTitleAndBody(issue *github.SubIssue) {
if issue == nil {
return
}
if issue.Title != nil {
issue.Title = github.Ptr(sanitize.Sanitize(*issue.Title))
}
if issue.Body != nil {
issue.Body = github.Ptr(sanitize.Content(*issue.Body))
}
}

Expand Down
37 changes: 21 additions & 16 deletions pkg/github/issues_test.go
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("Parent Issue"),
Body: github.Ptr("This is the parent issue with a sub-issue"),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("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.Equal(t, *tc.expectedIssue.Title, *returnedIssue.Title)
assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
assert.Empty(t, *returnedIssue.Title)
assert.Equal(t, "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("Sub-issue 1"),
Body: github.Ptr("This is the first sub-issue"),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("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 @@ -6199,12 +6199,17 @@ func Test_GetSubIssues(t *testing.T) {
for i, subIssue := range returnedSubIssues {
if i < len(tc.expectedSubIssues) {
assert.Equal(t, *tc.expectedSubIssues[i].Number, *subIssue.Number)
assert.Equal(t, *tc.expectedSubIssues[i].Title, *subIssue.Title)
if i == 0 {
assert.Empty(t, *subIssue.Title)
assert.Equal(t, "This is **Markdown**", *subIssue.Body)
} else {
assert.Equal(t, *tc.expectedSubIssues[i].Title, *subIssue.Title)
}
assert.Equal(t, *tc.expectedSubIssues[i].State, *subIssue.State)
assert.Equal(t, *tc.expectedSubIssues[i].HTMLURL, *subIssue.HTMLURL)
assert.Equal(t, *tc.expectedSubIssues[i].User.Login, *subIssue.User.Login)

if tc.expectedSubIssues[i].Body != nil {
if i != 0 && tc.expectedSubIssues[i].Body != nil {
assert.Equal(t, *tc.expectedSubIssues[i].Body, *subIssue.Body)
}
}
Expand Down Expand Up @@ -6652,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("Parent Issue"),
Body: github.Ptr("This is the parent issue after sub-issue removal"),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("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 @@ -6831,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.Equal(t, *tc.expectedIssue.Title, *returnedIssue.Title)
assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
assert.Empty(t, *returnedIssue.Title)
assert.Equal(t, "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 @@ -6860,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("Parent Issue"),
Body: github.Ptr("This is the parent issue with reprioritized sub-issues"),
Title: github.Ptr("<int>\u200B"),
Body: github.Ptr("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 @@ -7091,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.Equal(t, *tc.expectedIssue.Title, *returnedIssue.Title)
assert.Equal(t, *tc.expectedIssue.Body, *returnedIssue.Body)
assert.Empty(t, *returnedIssue.Title)
assert.Equal(t, "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
24 changes: 12 additions & 12 deletions pkg/github/minimal_types.go
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 @@ -797,7 +797,7 @@ func convertToMinimalPullRequestReview(review *github.PullRequestReview) Minimal
m := MinimalPullRequestReview{
ID: review.GetID(),
State: review.GetState(),
Body: sanitize.Sanitize(review.GetBody()),
Body: sanitize.Content(review.GetBody()),
HTMLURL: review.GetHTMLURL(),
User: convertToMinimalUser(review.GetUser()),
CommitID: review.GetCommitID(),
Expand All @@ -815,7 +815,7 @@ func convertToMinimalIssue(issue *github.Issue) MinimalIssue {
m := MinimalIssue{
Number: issue.GetNumber(),
Title: sanitize.Sanitize(issue.GetTitle()),
Body: sanitize.Sanitize(issue.GetBody()),
Body: sanitize.Content(issue.GetBody()),
State: issue.GetState(),
StateReason: issue.GetStateReason(),
Draft: issue.GetDraft(),
Expand Down Expand Up @@ -926,7 +926,7 @@ func fragmentWithoutFieldValuesToMinimalIssue(fragment issueFragmentWithoutField
m := MinimalIssue{
Number: int(fragment.Number),
Title: sanitize.Sanitize(string(fragment.Title)),
Body: sanitize.Sanitize(string(fragment.Body)),
Body: sanitize.Content(string(fragment.Body)),
State: string(fragment.State),
Comments: int(fragment.Comments.TotalCount),
CreatedAt: fragment.CreatedAt.Format(time.RFC3339),
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 All @@ -1085,7 +1085,7 @@ func convertToMinimalPullRequest(pr *github.PullRequest) MinimalPullRequest {
m := MinimalPullRequest{
Number: pr.GetNumber(),
Title: sanitize.Sanitize(pr.GetTitle()),
Body: sanitize.Sanitize(pr.GetBody()),
Body: sanitize.Content(pr.GetBody()),
State: pr.GetState(),
Draft: pr.GetDraft(),
Merged: pr.GetMerged(),
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 @@ -2039,7 +2039,7 @@ func convertToMinimalRelease(release *github.RepositoryRelease) MinimalRelease {
ID: release.GetID(),
TagName: release.GetTagName(),
Name: sanitize.Sanitize(release.GetName()),
Body: sanitize.Sanitize(release.GetBody()),
Body: sanitize.Content(release.GetBody()),
HTMLURL: release.GetHTMLURL(),
Prerelease: release.GetPrerelease(),
Draft: release.GetDraft(),
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
2 changes: 1 addition & 1 deletion pkg/github/projects.go
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ func convertToMinimalStatusUpdate(node statusUpdateNode) MinimalProjectStatusUpd

return MinimalProjectStatusUpdate{
ID: fmt.Sprintf("%v", node.ID),
Body: sanitize.Sanitize(derefString(node.Body)),
Body: sanitize.Content(derefString(node.Body)),
Status: derefString(node.Status),
CreatedAt: node.CreatedAt.Time.Format(time.RFC3339),
StartDate: derefString(node.StartDate),
Expand Down
16 changes: 15 additions & 1 deletion pkg/github/repositories.go
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.Sanitize(*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.Sanitize(headline),
MessageHeadline: sanitize.Content(headline),
CommittedDate: r.Commit.CommittedDate.Format("2006-01-02T15:04:05Z"),
Author: BlameAuthor{
Name: string(r.Commit.Author.Name),
Expand Down
9 changes: 6 additions & 3 deletions pkg/github/repositories_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4855,6 +4855,7 @@ func Test_GetLatestRelease(t *testing.T) {
ID: 1,
TagName: "v1.0.0",
Name: github.Ptr("First Release"),
Body: github.Ptr("<details>Notes</details>\u200B"),
}

tests := []struct {
Expand Down Expand Up @@ -4922,6 +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)
})
}
}
Expand All @@ -4945,7 +4948,7 @@ func Test_GetReleaseByTag(t *testing.T) {
ID: 1,
TagName: "v1.0.0",
Name: github.Ptr("Release v1.0.0"),
Body: github.Ptr("This is the first stable release."),
Body: github.Ptr("<details>Notes</details>\u200B"),
Assets: []*github.ReleaseAsset{
{
ID: github.Ptr(int64(1)),
Expand Down Expand Up @@ -5087,7 +5090,7 @@ func Test_GetReleaseByTag(t *testing.T) {
assert.Equal(t, tc.expectedResult.TagName, returnedRelease.TagName)
assert.Equal(t, *tc.expectedResult.Name, *returnedRelease.Name)
if tc.expectedResult.Body != nil {
assert.Equal(t, *tc.expectedResult.Body, *returnedRelease.Body)
assert.Equal(t, "<details>Notes</details>", *returnedRelease.Body)
}
if len(tc.expectedResult.Assets) > 0 {
require.Len(t, returnedRelease.Assets, len(tc.expectedResult.Assets))
Expand Down Expand Up @@ -6200,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, sanitizedText, br.Commits["badc0ffee0000"].MessageHeadline)
assert.Equal(t, sanitizedContentText, br.Commits["badc0ffee0000"].MessageHeadline)
assert.NotContains(t, result, "<script>")
Comment on lines +6206 to 6207
assert.NotContains(t, result, "Long body that should not appear")
},
Expand Down
Loading
Loading