-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
Bug/59374 regression missing commit message comments in work packages after upgrade to 1501 #17594
Open
jjabari-op
wants to merge
4
commits into
dev
Choose a base branch
from
bug/59374-regression-missing-commit-message-comments-in-work-packages-after-upgrade-to-1501
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
app/components/work_packages/activities_tab/journals/revision_component.html.erb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
<%= | ||
component_wrapper(class: "work-packages-activities-tab-journals-item-component") do | ||
flex_layout(data: { | ||
test_selector: "op-wp-revision-entry-#{changeset.id}" | ||
}) do |revision_container| | ||
revision_container.with_row do | ||
render(border_box_container( | ||
id: "activity-anchor-r#{changeset.revision}", | ||
padding: :condensed, | ||
"aria-label": I18n.t("activities.work_packages.activity_tab.commented") | ||
)) do |border_box_component| | ||
border_box_component.with_header(px: 2, py: 1, data: { test_selector: "op-revision-header" }) do | ||
flex_layout(align_items: :center, justify_content: :space_between, classes: "work-packages-activities-tab-revision-component--header") do |header_container| | ||
header_container.with_column(flex_layout: true, | ||
classes: "work-packages-activities-tab-journals-item-component--header-start-container ellipsis") do |header_start_container| | ||
header_start_container.with_column(mr: 2) do | ||
if changeset.user | ||
render(Users::AvatarComponent.new(user: changeset.user, show_name: false, size: :mini)) | ||
end | ||
end | ||
header_start_container.with_column(mr: 1, flex_layout: true, | ||
classes: "work-packages-activities-tab-journals-item-component--user-name-container hidden-for-desktop") do |user_name_container| | ||
user_name_container.with_row(classes: "work-packages-activities-tab-journals-item-component--user-name ellipsis") do | ||
render_user_name | ||
end | ||
user_name_container.with_row do | ||
render(Primer::Beta::Text.new(font_size: :small, color: :subtle, mr: 1)) do | ||
committed_text = render(Primer::Beta::Link.new( | ||
href: revision_url, | ||
scheme: :secondary, | ||
underline: false, | ||
font_size: :small, | ||
target: "_blank" | ||
)) do | ||
I18n.t("js.label_committed_link", revision_identifier: short_revision) | ||
end | ||
I18n.t("js.label_committed_at", | ||
committed_revision_link: committed_text.html_safe, | ||
date: format_time(changeset.committed_on)).html_safe | ||
end | ||
end | ||
end | ||
header_start_container.with_column(mr: 1, | ||
classes: "work-packages-activities-tab-journals-item-component--user-name ellipsis hidden-for-mobile") do | ||
render_user_name | ||
end | ||
header_start_container.with_column(mr: 1, classes: "hidden-for-mobile") do | ||
render(Primer::Beta::Text.new(font_size: :small, color: :subtle, mr: 1)) do | ||
committed_text = render(Primer::Beta::Link.new( | ||
href: revision_url, | ||
scheme: :secondary, | ||
underline: false, | ||
font_size: :small, | ||
target: "_blank" | ||
)) do | ||
I18n.t("js.label_committed_link", revision_identifier: short_revision) | ||
end | ||
I18n.t("js.label_committed_at", | ||
committed_revision_link: committed_text.html_safe, | ||
date: format_time(changeset.committed_on)).html_safe | ||
end | ||
end | ||
end | ||
end | ||
end | ||
border_box_component.with_body( | ||
classes: "work-packages-activities-tab-journals-item-component--journal-notes-body", | ||
data: { test_selector: "op-revision-notes-body" } | ||
) do | ||
render(Primer::Box.new(mt: 1, classes: "op-uc-container")) do | ||
format_text(changeset, :comments) | ||
end | ||
end | ||
end | ||
end | ||
revision_container.with_row(flex_layout: true, classes: "work-packages-activities-tab-revision-component--stem-line-container") do |stem_line_container| | ||
stem_line_container.with_column(border: :left, classes: "work-packages-activities-tab-revision-component--stem-line") | ||
end | ||
end | ||
end | ||
%> |
84 changes: 84 additions & 0 deletions
84
app/components/work_packages/activities_tab/journals/revision_component.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
module WorkPackages | ||
Check notice on line 1 in app/components/work_packages/activities_tab/journals/revision_component.rb GitHub Actions / rubocop[rubocop] app/components/work_packages/activities_tab/journals/revision_component.rb#L1 <Style/FrozenStringLiteralComment>
Raw output
|
||
module ActivitiesTab | ||
module Journals | ||
class RevisionComponent < ApplicationComponent | ||
include ApplicationHelper | ||
include OpPrimer::ComponentHelpers | ||
include OpTurbo::Streamable | ||
|
||
def initialize(changeset:, filter:) | ||
super | ||
|
||
@changeset = changeset | ||
@filter = filter | ||
end | ||
|
||
private | ||
|
||
attr_reader :changeset, :filter | ||
|
||
def render? | ||
filter != :only_comments | ||
end | ||
|
||
def user_name | ||
if changeset.user | ||
changeset.user.name | ||
else | ||
# Extract name from committer string (format: "name <email>") | ||
changeset.committer.split("<").first.strip | ||
end | ||
end | ||
|
||
def revision_url | ||
repository = changeset.repository | ||
project = repository.project | ||
|
||
show_revision_project_repository_path(project_id: project.id, rev: changeset.revision) | ||
end | ||
|
||
def short_revision | ||
changeset.revision[0..7] | ||
end | ||
|
||
def copy_url_action_item(menu) | ||
menu.with_item(label: t("button_copy_link_to_clipboard"), | ||
tag: :button, | ||
content_arguments: { | ||
data: { | ||
action: "click->work-packages--activities-tab--item#copyActivityUrlToClipboard" | ||
} | ||
}) do |item| | ||
item.with_leading_visual_icon(icon: :copy) | ||
end | ||
end | ||
|
||
def render_user_name | ||
if changeset.user | ||
render_user_link(changeset.user) | ||
else | ||
render_committer_name(changeset.committer) | ||
end | ||
end | ||
|
||
def render_user_link(user) | ||
render(Primer::Beta::Link.new( | ||
href: user_url(user), | ||
target: "_blank", | ||
scheme: :primary, | ||
underline: false, | ||
font_weight: :bold | ||
)) do | ||
changeset.user.name | ||
end | ||
end | ||
|
||
def render_committer_name(committer) | ||
render(Primer::Beta::Text.new(font_weight: :bold, mr: 1)) do | ||
committer.gsub(%r{<.+@.+>}, "").strip | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
7 changes: 7 additions & 0 deletions
7
app/components/work_packages/activities_tab/journals/revision_component.sass
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.work-packages-activities-tab-revision-component | ||
&--header | ||
min-height: 32px | ||
&--stem-line-container | ||
min-height: 20px | ||
&--stem-line | ||
margin-left: 19px |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check failure
Code scanning / CodeQL
Incomplete multi-character sanitization High
Copilot Autofix AI 5 days ago
To fix the problem, we should ensure that all potentially dangerous HTML tags are removed from the committer string. The best way to achieve this is to use a well-tested sanitization library, such as the
sanitize
gem, which is designed to handle various edge cases and ensure effective sanitization.sanitize
gem if it is not already included in the project.render_committer_name
method to use thesanitize
gem to remove any potentially dangerous HTML tags from the committer string.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jjabari-op - this looks sensible, wdyt?